optional account number

Author: JssDWt

crates/breez-sdk/core/src/bindings.rs

@@ -32,11 +32,16 @@ impl SdkBuilder {
     /// Arguments:
     /// - `key_set_type`: The key set type which determines the derivation path.
     /// - `use_address_index`: Controls the structure of the BIP derivation path.
-    pub async fn with_key_set(&self, key_set_type: KeySetType, use_address_index: bool) {
+    pub async fn with_key_set(
+        &self,
+        key_set_type: KeySetType,
+        use_address_index: bool,
+        account_number: Option<u32>,
+    ) {
         let mut builder = self.inner.lock().await;
         *builder = builder
             .clone()
-            .with_key_set(key_set_type, use_address_index);
+            .with_key_set(key_set_type, use_address_index, account_number);
     }
 
     /// Sets the chain service to be used by the SDK.

crates/breez-sdk/core/src/sdk_builder.rs

@@ -53,6 +53,7 @@ pub struct SdkBuilder {
     lnurl_server_client: Option<Arc<dyn LnurlServerClient>>,
     key_set_type: KeySetType,
     use_address_index: bool,
+    account_number: Option<u32>,
 }
 
 impl SdkBuilder {
@@ -72,6 +73,7 @@ impl SdkBuilder {
             lnurl_server_client: None,
             key_set_type: KeySetType::Default,
             use_address_index: false,
+            account_number: None,
         }
     }
 
@@ -80,9 +82,15 @@ impl SdkBuilder {
     /// - `key_set_type`: The key set type which determines the derivation path.
     /// - `use_address_index`: Controls the structure of the BIP derivation path.
     #[must_use]
-    pub fn with_key_set(mut self, key_set_type: KeySetType, use_address_index: bool) -> Self {
+    pub fn with_key_set(
+        mut self,
+        key_set_type: KeySetType,
+        use_address_index: bool,
+        account_number: Option<u32>,
+    ) -> Self {
         self.key_set_type = key_set_type;
         self.use_address_index = use_address_index;
+        self.account_number = account_number;
         self
     }
 
@@ -163,6 +171,7 @@ impl SdkBuilder {
             self.config.network.into(),
             self.key_set_type.into(),
             self.use_address_index,
+            self.account_number,
         )
         .map_err(|e| SdkError::Generic(e.to_string()))?;
         let chain_service = if let Some(service) = self.chain_service {

crates/breez-sdk/wasm/src/sdk_builder.rs

@@ -39,10 +39,15 @@ impl SdkBuilder {
     }
 
     #[wasm_bindgen(js_name = "withKeySet")]
-    pub fn with_key_set(mut self, key_set_type: KeySetType, use_address_index: bool) -> Self {
-        self.builder = self
-            .builder
-            .with_key_set(key_set_type.into(), use_address_index);
+    pub fn with_key_set(
+        mut self,
+        key_set_type: KeySetType,
+        use_address_index: bool,
+        account_number: Option<u32>,
+    ) -> Self {
+        self.builder =
+            self.builder
+                .with_key_set(key_set_type.into(), use_address_index, account_number);
         self
     }
 

crates/spark/src/signer/default_signer.rs

@@ -145,8 +145,11 @@ pub struct KeySet {
 }
 
 impl KeySet {
-    fn default_keys(seed: &[u8], network: Network) -> Result<Self, DefaultSignerError> {
-        let account_number = account_number(network);
+    fn default_keys(
+        seed: &[u8],
+        network: Network,
+        account_number: u32,
+    ) -> Result<Self, DefaultSignerError> {
         let derivation_path = format!("m/8797555'/{account_number}'").parse()?;
         let derived_key_set = DerivedKeySet::new(seed, network, derivation_path)?;
         derived_key_set.to_key_set(ChildNumber::from_hardened_idx(0).ok())
@@ -156,8 +159,8 @@ impl KeySet {
         seed: &[u8],
         network: Network,
         use_address_index: bool,
+        account_number: u32,
     ) -> Result<Self, DefaultSignerError> {
-        let account_number = account_number(network);
         let derivation_path = if use_address_index {
             format!("m/86'/0'/0'/0/{account_number}")
         } else {
@@ -190,8 +193,8 @@ impl KeySet {
         seed: &[u8],
         network: Network,
         use_address_index: bool,
+        account_number: u32,
     ) -> Result<Self, DefaultSignerError> {
-        let account_number = account_number(network);
         let derivation_path = if use_address_index {
             format!("m/84'/0'/0'/0/{account_number}")
         } else {
@@ -206,8 +209,8 @@ impl KeySet {
         seed: &[u8],
         network: Network,
         use_address_index: bool,
+        account_number: u32,
     ) -> Result<Self, DefaultSignerError> {
-        let account_number = account_number(network);
         let derivation_path = if use_address_index {
             format!("m/49'/0'/0'/0/{account_number}")
         } else {
@@ -222,8 +225,8 @@ impl KeySet {
         seed: &[u8],
         network: Network,
         use_address_index: bool,
+        account_number: u32,
     ) -> Result<Self, DefaultSignerError> {
-        let account_number = account_number(network);
         let derivation_path = if use_address_index {
             format!("m/44'/0'/0'/0/{account_number}")
         } else {
@@ -264,25 +267,31 @@ impl From<bitcoin::bip32::Error> for DefaultSignerError {
 
 impl DefaultSigner {
     pub fn new(seed: &[u8], network: Network) -> Result<Self, DefaultSignerError> {
-        Self::with_keyset_type(seed, network, KeySetType::Default, false)
+        Self::with_keyset_type(seed, network, KeySetType::Default, false, None)
     }
 
     pub fn with_keyset_type(
         seed: &[u8],
         network: Network,
         key_type: KeySetType,
         use_address_index: bool,
+        account_no: Option<u32>,
     ) -> Result<Self, DefaultSignerError> {
+        let account_number = account_no.unwrap_or_else(|| account_number(network));
         let key_set = match key_type {
-            KeySetType::Default => KeySet::default_keys(seed, network),
-            KeySetType::Taproot => KeySet::taproot_keys(seed, network, use_address_index),
+            KeySetType::Default => KeySet::default_keys(seed, network, account_number),
+            KeySetType::Taproot => {
+                KeySet::taproot_keys(seed, network, use_address_index, account_number)
+            }
             KeySetType::NativeSegwit => {
-                KeySet::native_segwit_keys(seed, network, use_address_index)
+                KeySet::native_segwit_keys(seed, network, use_address_index, account_number)
             }
             KeySetType::WrappedSegwit => {
-                KeySet::wrapped_segwit_keys(seed, network, use_address_index)
+                KeySet::wrapped_segwit_keys(seed, network, use_address_index, account_number)
+            }
+            KeySetType::Legacy => {
+                KeySet::legacy_bitcoin_keys(seed, network, use_address_index, account_number)
             }
-            KeySetType::Legacy => KeySet::legacy_bitcoin_keys(seed, network, use_address_index),
         }?;
         Ok(Self::from_key_set(key_set))
     }

docs/breez-sdk/snippets/flutter/lib/getting_started.dart

@@ -45,7 +45,7 @@ Future<void> initSdkAdvanced() async {
   //     url: "https://custom.chain.service",
   //     credentials: Credentials(
   //         username: "service-username", password: "service-password"));
-  // builder.withKeySet(keySetType: <your key set type>, useAddressIndex: <use address index>);
+  // builder.withKeySet(keySetType: <your key set type>, useAddressIndex: <use address index>, accountNumber: <account number>);
   final sdk = await builder.build();
   // ANCHOR_END: init-sdk-advanced
   print(sdk);

docs/breez-sdk/snippets/go/getting_started.go

@@ -56,7 +56,7 @@ func InitSdkAdvanced() (*breez_sdk_spark.BreezSdk, error) {
 	// You can also pass your custom implementations:
 	// builder.WithChainService(<your chain service implementation>)
 	// builder.WithRestClient(<your rest client implementation>)
-	// builder.WithKeySet(<your key set type>, <use address index>)
+	// builder.WithKeySet(<your key set type>, <use address index>, <account number>)
 	sdk, err := builder.Build()
 
 	return sdk, err

docs/breez-sdk/snippets/kotlin_mpp_lib/shared/src/commonMain/kotlin/com/example/kotlinmpplib/GettingStarted.kt

@@ -43,7 +43,7 @@ class GettingStarted {
             // You can also pass your custom implementations:
             // builder.withChainService(<your chain service implementation>)
             // builder.withRestClient(<your rest client implementation>)
-            // builder.withKeySet(<your key set type>, <use address index>)
+            // builder.withKeySet(<your key set type>, <use address index>, <account number>)
             val sdk = builder.build()
         } catch (e: Exception) {
             // handle error

docs/breez-sdk/snippets/python/src/getting_started.py

@@ -53,7 +53,7 @@ async def init_sdk_advanced():
         # You can also pass your custom implementations:
         # builder.with_chain_service(<your chain service implementation>)
         # builder.with_rest_client(<your rest client implementation>)
-        # builder.with_key_set(<your key set type>, <use address index>)
+        # builder.with_key_set(<your key set type>, <use address index>, <account number>)
         sdk = await builder.build()
         return sdk
     except Exception as error:

docs/breez-sdk/snippets/rust/src/getting_started.rs

@@ -52,7 +52,7 @@ pub(crate) async fn init_sdk_advanced() -> Result<BreezSdk> {
     // You can also pass your custom implementations:
     // let builder = builder.with_chain_service(<your chain service implementation>)
     // let builder = builder.with_rest_client(<your rest client implementation>)
-    // let builder = builder.with_key_set(<your key set type>, <use address index>)
+    // let builder = builder.with_key_set(<your key set type>, <use address index>, <account number>)
     let sdk = builder.build().await?;
 
     // ANCHOR_END: init-sdk-advanced

docs/breez-sdk/snippets/wasm/getting_started.ts

@@ -61,7 +61,7 @@ const exampleGettingStartedAdvanced = async () => {
   // You can also pass your custom implementations:
   // builder = builder.withChainService(<your chain service implementation>)
   // builder = builder.withRestClient(<your rest client implementation>)
-  // builder = builder.withKeySet(<your key set type>, <use address index>)
+  // builder = builder.withKeySet(<your key set type>, <use address index>, <account number>)
   const sdk = await builder.build()
   // ANCHOR_END: init-sdk-advanced
 }