Allow canonical BIP32 string in FromStr (#354)

* FromStr parsing of DerivationPaths and friends now use 'lenient' parsing - accepting CANONICAL BIP32 string repr. * polish * introduce concept of CAP43 * fix * rename tests * tests and comments * fix Kotlin * Release 1.1.119 [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] Generated by cargo-workspaces --------- Co-authored-by: Matias Bzurovski <[email protected]>
radixdlt · Jan 23, 2025 · 22a4d57 · 22a4d57
1 parent 4653813
commit 22a4d57
Show file tree

Hide file tree

Showing 94 changed files with 514 additions and 371 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/...e/Sources/Sargon/Extensions/Methods/Crypto/Derivation/DerivationPath+Wrap+Functions.swift b/...e/Sources/Sargon/Extensions/Methods/Crypto/Derivation/DerivationPath+Wrap+Functions.swift
@@ -6,10 +6,20 @@ extension DerivationPath {
 		derivationPathToHdPath(path: self)
 	}
 
+	/// Returns a CAP 43 String representation of this `DerivationPath`.
+	/// Useful when we need to log or debug, but should **never** be used when communicating with external APIs.
 	public func toString() -> String {
 		derivationPathToString(path: self)
 	}
 
+	/// Returns a BIP 32 String representation of this `DerivationPath`.
+	/// Needed to communicate with external APIs such as Arculus or Ledger.
+	public func toBip32String() -> String {
+		derivationPathToBip32String(path: self)
+	}
+
+	/// Attempts to build a DerivationPath from a CAP 43 or BIP 32 representation.
+	/// The initializer is lenient, so it will attempt with the latter if the first fails
 	public init(string: String) throws {
 		self = try newDerivationPathFromString(string: string)
 	}

diff --git a/apple/Tests/TestCases/Crypto/DerivationPathTests.swift b/apple/Tests/TestCases/Crypto/DerivationPathTests.swift
@@ -78,4 +78,24 @@ final class DerivationPathTests: HDPathProtocolTest<DerivationPath> {
 			"m/44H/1022H/2H/618H/1460H/42H"
 		)
 	}
+
+	func test_to_bip32() throws {
+		// Build from CAP43 syntax
+		var sut = try SUT(string: "m/44H/1022H/1H/525H/1460H/0S")
+		XCTAssertEqual(sut.toBip32String(), "m/44H/1022H/1H/525H/1460H/1073741824H")
+
+		// Build from BIP32 syntax
+		sut = try SUT(string: "m/44H/1022H/1H/525H/1460H/2H")
+		XCTAssertEqual(sut.toBip32String(), "m/44H/1022H/1H/525H/1460H/2H")
+	}
+
+	func test_to_string() throws {
+		// Build from CAP43 syntax
+		var sut = try SUT(string: "m/44H/1022H/1H/525H/1460H/0S")
+		XCTAssertEqual(sut.toString(), "m/44H/1022H/1H/525H/1460H/0S")
+
+		// Build from BIP32 syntax
+		sut = try SUT(string: "m/44H/1022H/1H/525H/1460H/2H")
+		XCTAssertEqual(sut.toString(), "m/44H/1022H/1H/525H/1460H/2H")
+	}
 }
diff --git a/crates/app/home-cards/Cargo.toml b/crates/app/home-cards/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "home-cards"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/app/key-derivation-traits/Cargo.toml b/crates/app/key-derivation-traits/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "key-derivation-traits"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/app/radix-connect-models/Cargo.toml b/crates/app/radix-connect-models/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "radix-connect-models"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/app/radix-connect/Cargo.toml b/crates/app/radix-connect/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "radix-connect"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 

diff --git a/crates/app/security-center/Cargo.toml b/crates/app/security-center/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "security-center"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/app/signing-traits/Cargo.toml b/crates/app/signing-traits/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "signing-traits"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/app/signing/Cargo.toml b/crates/app/signing/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "signing"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 

diff --git a/crates/common/build-info/Cargo.toml b/crates/common/build-info/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "build-info"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 build = "build.rs"
 

diff --git a/crates/common/bytes/Cargo.toml b/crates/common/bytes/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "bytes"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/common/entity-foundation/Cargo.toml b/crates/common/entity-foundation/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "entity-foundation"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/common/host-info/Cargo.toml b/crates/common/host-info/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "host-info"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/common/identified-vec-of/Cargo.toml b/crates/common/identified-vec-of/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "identified-vec-of"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/common/metadata/Cargo.toml b/crates/common/metadata/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "metadata"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/common/network/Cargo.toml b/crates/common/network/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "network"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/common/numeric/Cargo.toml b/crates/common/numeric/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "numeric"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/common/short-string/Cargo.toml b/crates/common/short-string/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "short-string"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/core/assert-json/Cargo.toml b/crates/core/assert-json/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "assert-json"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/core/collections/Cargo.toml b/crates/core/collections/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "core-collections"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/core/error/Cargo.toml b/crates/core/error/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "error"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/core/has-sample-values/Cargo.toml b/crates/core/has-sample-values/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "has-sample-values"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/core/misc/Cargo.toml b/crates/core/misc/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "core-misc"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/core/prelude/Cargo.toml b/crates/core/prelude/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "prelude"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/core/time-utils/Cargo.toml b/crates/core/time-utils/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "time-utils"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/core/utils/Cargo.toml b/crates/core/utils/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "core-utils"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/crypto/addresses/Cargo.toml b/crates/crypto/addresses/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "addresses"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/crypto/cap26-models/Cargo.toml b/crates/crypto/cap26-models/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "cap26-models"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/crypto/ecc/Cargo.toml b/crates/crypto/ecc/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ecc"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/crypto/encryption/Cargo.toml b/crates/crypto/encryption/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "encryption"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/crypto/hash/Cargo.toml b/crates/crypto/hash/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "hash"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/crypto/hd/Cargo.toml b/crates/crypto/hd/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "hierarchical-deterministic"
-version = "1.1.118"
+version = "1.1.119"
 edition = "2021"
 
 [dependencies]

diff --git a/crates/crypto/hd/src/bip32/hd_path.rs b/crates/crypto/hd/src/bip32/hd_path.rs
@@ -15,8 +15,8 @@ use crate::prelude::*;
     DeserializeFromStr,
     SerializeDisplay,
 )]
-#[display("{}", self.to_bip32_string())]
-#[debug("{}", self.to_bip32_string_debug())]
+#[display("{}", self.to_cap43_string())]
+#[debug("{}", self.to_cap43_string_debug())]
 pub struct HDPath {
     pub components: Vec<HDPathComponent>,
 }
@@ -29,8 +29,8 @@ impl HDPath {
     }
 }
 
-impl FromBIP32Str for HDPath {
-    fn from_bip32_string(s: impl AsRef<str>) -> Result<Self> {
+impl FromCAP43String for HDPath {
+    fn from_cap43_string(s: impl AsRef<str>) -> Result<Self> {
         let s = s.as_ref();
         let mut s = s;
         if s.starts_with(&format!("m{}", Self::SEPARATOR)) {
@@ -45,7 +45,7 @@ impl FromBIP32Str for HDPath {
         let components = s
             .split(Self::SEPARATOR)
             .filter(|s| !s.is_empty())
-            .map(HDPathComponent::from_bip32_string)
+            .map(HDPathComponent::from_cap43_string)
             .collect::<Result<Vec<_>>>()?;
         Ok(Self::new(components))
     }
@@ -66,7 +66,7 @@ impl HDPath {
         path.into_iter().join(Self::SEPARATOR)
     }
 
-    pub fn to_bip32_string_with(
+    pub fn to_cap43_string_with(
         &self,
         include_head: bool,
         canonicalize_entity_index: bool,
@@ -85,38 +85,38 @@ impl HDPath {
         })
     }
 
-    pub fn to_bip32_string_debug_with(&self, include_head: bool) -> String {
+    pub fn to_cap43_string_debug_with(&self, include_head: bool) -> String {
         self.to_string_map_with(include_head, |(_, c)| format!("{:?}", c))
     }
 
-    /// This method returns the canonical bip32 representation of the path.
+    /// String representation of the path using BIP32 notation.
     /// In sargon, paths in the securified space are printed with the `S` notation after the index,
     /// for readability purposes.
     ///
     /// The notation `{i}S` means `{i + 2^30}H`, and since `H` means `+ 2^31` we can
     /// verbosely express `{i}S` as `{i + 2^30 + 2^31} (without the H)
     ///
-    /// Such paths need to be canonicalized in bip32 notation meaning that
+    /// Such paths need to be on BIP32 notation meaning that
     /// an index of `"{i}S"` => `"{i + 2^30}H"` when communication with other external APIs,
     /// e.g. using Ledger hardware wallet or Arculus.
-    pub fn to_canonical_bip32_string(&self) -> String {
-        self.to_bip32_string_with(true, true)
+    pub fn to_bip32_string(&self) -> String {
+        self.to_cap43_string_with(true, true)
     }
 }
-impl ToBIP32Str for HDPath {
-    fn to_bip32_string(&self) -> String {
-        self.to_bip32_string_with(true, false)
+impl ToCAP43String for HDPath {
+    fn to_cap43_string(&self) -> String {
+        self.to_cap43_string_with(true, false)
     }
-    fn to_bip32_string_debug(&self) -> String {
-        self.to_bip32_string_debug_with(true)
+    fn to_cap43_string_debug(&self) -> String {
+        self.to_cap43_string_debug_with(true)
     }
 }
 
 impl FromStr for HDPath {
     type Err = CommonError;
 
     fn from_str(s: &str) -> Result<Self> {
-        Self::from_bip32_string(s)
+        Self::from_cap43_string(s)
     }
 }
 
@@ -235,4 +235,16 @@ mod tests {
         assert_json_value_fails::<HDPath>(json!("m/44X"));
         assert_json_value_fails::<HDPath>(json!("super invalid path"));
     }
+
+    #[test]
+    fn from_bip32_str() {
+        let canonical = "m/44H/1022H/1H/525H/1460H/1073741824H";
+        let sut = SUT::from_str(canonical).unwrap();
+        assert_eq!(
+            DerivationPath::from(AccountPath::try_from(sut.clone()).unwrap())
+                .to_bip32_string(),
+            canonical
+        );
+        assert_eq!(sut.to_cap43_string(), "m/44H/1022H/1H/525H/1460H/0S");
+    }
 }