Rename init() to connect()

breez · Apr 29, 2024 · f8f5598 · f8f5598
1 parent 021d28c
commit f8f5598
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 11 deletions.
diff --git a/cli/src/main.rs b/cli/src/main.rs
@@ -71,7 +71,7 @@ fn main() -> Result<()> {
     }
 
     let mnemonic = persistence.get_or_create_mnemonic()?;
-    let wallet = Wallet::init(
+    let wallet = Wallet::connect(
         &mnemonic.to_string(),
         Some(data_dir_str),
         Network::LiquidTestnet,

diff --git a/lib/ls-sdk-bindings/src/lib.rs b/lib/ls-sdk-bindings/src/lib.rs
@@ -19,12 +19,12 @@ impl From<anyhow::Error> for LsSdkError {
     }
 }
 
-pub fn init(
+pub fn connect(
     mnemonic: String,
     data_dir: Option<String>,
     network: Network,
 ) -> Result<Arc<BindingWallet>, LsSdkError> {
-    let ln_sdk = Wallet::init(&mnemonic, data_dir, network)?;
+    let ln_sdk = Wallet::connect(&mnemonic, data_dir, network)?;
     Ok(Arc::from(BindingWallet { ln_sdk }))
 }
 

diff --git a/lib/ls-sdk-bindings/src/ls_sdk.udl b/lib/ls-sdk-bindings/src/ls_sdk.udl
@@ -58,7 +58,7 @@ dictionary ReceivePaymentResponse {
 
 namespace ls_sdk {
     [Throws=LsSdkError]
-    BindingWallet init(string mnemonic, string? data_dir, Network network);
+    BindingWallet connect(string mnemonic, string? data_dir, Network network);
 };
 
 interface BindingWallet {

diff --git a/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.kts b/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.kts
@@ -1,6 +1,6 @@
 try {
     var mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
-    var sdk = ls_sdk.init(mnemonic, null, ls_sdk.Network.LIQUID_TESTNET)
+    var sdk = ls_sdk.connect(mnemonic, null, ls_sdk.Network.LIQUID_TESTNET)
     var nodeInfo = sdk.getInfo(false)
     println("$nodeInfo")
     assert(nodeInfo.pubkey.equals("03d902f35f560e0470c63313c7369168d9d7df2d49bf295fd9fb7cb109ccee0494"))

diff --git a/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.py b/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.py
@@ -2,7 +2,7 @@
 
 def test():
     mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
-    sdk = ls_sdk.init(mnemonic, None, ls_sdk.Network.LIQUID_TESTNET)
+    sdk = ls_sdk.connect(mnemonic, None, ls_sdk.Network.LIQUID_TESTNET)
     node_info = sdk.get_info(False)
     print(node_info)
     assert node_info.pubkey == "03d902f35f560e0470c63313c7369168d9d7df2d49bf295fd9fb7cb109ccee0494"

diff --git a/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.swift b/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.swift
@@ -1,7 +1,7 @@
 import ls_sdk
 
 let mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about";
-let sdk = try ls_sdk.`init`(mnemonic: mnemonic, dataDir: nil, network: .liquidTestnet);
+let sdk = try ls_sdk.connect(mnemonic: mnemonic, dataDir: nil, network: .liquidTestnet);
 let nodeInfo = try sdk.getInfo(withScan: false);
 print(nodeInfo);
 assert(nodeInfo.pubkey == "03d902f35f560e0470c63313c7369168d9d7df2d49bf295fd9fb7cb109ccee0494", "nodeInfo.pubkey");
diff --git a/lib/ls-sdk-core/README.md b/lib/ls-sdk-core/README.md
@@ -16,7 +16,7 @@ The wallet provides the ability to `backup` and `restore` ongoing swaps via the
 let mnemonic = "...";
 let data_dir = None;
 let network = Network::Liquid;
-let breez_wallet = Wallet::init(mnemonic, data_dir, network)?;
+let breez_wallet = Wallet::connect(mnemonic, data_dir, network)?;
 
 breez_wallet.backup()?;  // Backs up the pending swaps under `{data_dir}/backup{-testnet}.sql`. Overwrites previous versions.
 let backup_path = None;  // Can also be Some(String), a path pointing to the database. Default is `{data_dir}/backup{-testnet}.sql`

diff --git a/lib/ls-sdk-core/src/lib.rs b/lib/ls-sdk-core/src/lib.rs
@@ -66,7 +66,8 @@ mod tests {
     #[test]
     fn normal_submarine_swap() -> Result<()> {
         let (_data_dir, data_dir_str) = create_temp_dir()?;
-        let breez_wallet = Wallet::init(TEST_MNEMONIC, Some(data_dir_str), Network::LiquidTestnet)?;
+        let breez_wallet =
+            Wallet::connect(TEST_MNEMONIC, Some(data_dir_str), Network::LiquidTestnet)?;
 
         let invoice = "lntb10u1pnqwkjrpp5j8ucv9mgww0ajk95yfpvuq0gg5825s207clrzl5thvtuzfn68h0sdqqcqzzsxqr23srzjqv8clnrfs9keq3zlg589jvzpw87cqh6rjks0f9g2t9tvuvcqgcl45f6pqqqqqfcqqyqqqqlgqqqqqqgq2qsp5jnuprlxrargr6hgnnahl28nvutj3gkmxmmssu8ztfhmmey3gq2ss9qyyssq9ejvcp6frwklf73xvskzdcuhnnw8dmxag6v44pffwqrxznsly4nqedem3p3zhn6u4ln7k79vk6zv55jjljhnac4gnvr677fyhfgn07qp4x6wrq";
         breez_wallet.prepare_send_payment(&invoice)?;
@@ -78,7 +79,8 @@ mod tests {
     #[test]
     fn reverse_submarine_swap() -> Result<()> {
         let (_data_dir, data_dir_str) = create_temp_dir()?;
-        let breez_wallet = Wallet::init(TEST_MNEMONIC, Some(data_dir_str), Network::LiquidTestnet)?;
+        let breez_wallet =
+            Wallet::connect(TEST_MNEMONIC, Some(data_dir_str), Network::LiquidTestnet)?;
 
         let prepare_response = breez_wallet.prepare_receive_payment(&PrepareReceiveRequest {
             receiver_amount_sat: Some(1000),

diff --git a/lib/ls-sdk-core/src/wallet.rs b/lib/ls-sdk-core/src/wallet.rs
@@ -47,7 +47,11 @@ pub struct Wallet {
 }
 
 impl Wallet {
-    pub fn init(mnemonic: &str, data_dir: Option<String>, network: Network) -> Result<Arc<Wallet>> {
+    pub fn connect(
+        mnemonic: &str,
+        data_dir: Option<String>,
+        network: Network,
+    ) -> Result<Arc<Wallet>> {
         let is_mainnet = network == Network::Liquid;
         let signer = SwSigner::new(mnemonic, is_mainnet)?;
         let descriptor = Wallet::get_descriptor(&signer, network)?;