Update getting started and include restore only example

Author: dangeross

.github/workflows/main.yml

@@ -25,8 +25,8 @@ jobs:
     name: setup
     runs-on: ubuntu-latest
     outputs:
-      sdk-ref: ${{ inputs.sdk-ref || '0.2.15' }}
-      package-version: '0.2.15'
+      sdk-ref: ${{ inputs.sdk-ref || '0.3.0' }}
+      package-version: '0.3.0'
     steps:
       - run: echo "set pre-setup output variables"
 

snippets/csharp/GettingStarted.cs

@@ -26,7 +26,8 @@ public void GettingStarted()
         try
         {
             // Connect to the Breez SDK make it ready for use
-            sdk = BreezSdkMethods.Connect(config, seed, new SdkListener());
+            var connectRequest = new ConnectRequest(config, seed);
+            sdk = BreezSdkMethods.Connect(connectRequest, new SdkListener());
         }
         catch (Exception)
         {
@@ -44,6 +45,22 @@ public void OnEvent(BreezEvent e)
     }
     // ANCHOR_END: init-sdk
 
+    public void GettingStartedRestoreOnly(Config config, List<byte> seed)
+    {
+        BlockingBreezServices sdk;
+        try
+        {
+            // ANCHOR: init-sdk-restore-only
+            var connectRequest = new ConnectRequest(config, seed, true);
+            sdk = BreezSdkMethods.Connect(connectRequest, new SdkListener());
+            // ANCHOR_END: init-sdk-restore-only
+        }
+        catch (Exception)
+        {
+            // Handle error
+        }
+    }
+
     public void FetchNodeInfo(BlockingBreezServices sdk)
     {
         // ANCHOR: fetch-balance

snippets/dart_snippets/lib/getting_started.dart

@@ -29,10 +29,18 @@ Future<void> initializeSDK() async {
   config = config.copyWith(workingDir: "path to an existing directory");
 
   // Connect to the Breez SDK make it ready for use
-  return await BreezSDK().connect(config: config, seed: seed);
+  ConnectRequest connectRequest = ConnectRequest(config: config, seed: seed)
+  return await BreezSDK().connect(req: connectRequest);
   // ANCHOR_END: init-sdk
 }
 
+Future<void> connectRestoreOnly(Config config, Uint8List seed) async {
+  // ANCHOR: init-sdk-restore-only
+  ConnectRequest connectRequest = ConnectRequest(config: config, seed: seed, restoreOnly: true)
+  return await BreezSDK().connect(req: connectRequest);
+  // ANCHOR_END: init-sdk-restore-only
+}
+
 Future<void> fetchBalance(String lspId) async {
   // ANCHOR: fetch-balance
   NodeState? nodeInfo = await BreezSDK().nodeInfo();

snippets/dart_snippets/pubspec.lock

@@ -55,7 +55,7 @@ packages:
       path: "packages/breez-sdk-flutter"
       relative: true
     source: path
-    version: "0.2.15"
+    version: "0.3.0"
   build:
     dependency: transitive
     description:

snippets/go/getting_started.go

@@ -34,15 +34,32 @@ func GettingStarted() *breez_sdk.BlockingBreezServices {
 	// Customize the config object according to your needs
 	config.WorkingDir = "path to an existing directory"
 
-	sdk, err := breez_sdk.Connect(config, seed, BreezListener{})
+	connectRequest := breez_sdk.ConnectRequest{Config: config, Seed: seed}
+	sdk, err := breez_sdk.Connect(connectRequest, BreezListener{})
 	if err != nil {
 		log.Fatalf("Connect failed: %#v", err)
 	}
 
 	return sdk
 }
-
 // ANCHOR_END: init-sdk
+
+func GettingStartedRestoreOnly(config breez_sdk.Config, seed []uint8) *breez_sdk.BlockingBreezServices {
+	// ANCHOR: init-sdk-restore-only
+	restoreOnly := true
+	connectRequest := breez_sdk.ConnectRequest{
+		Config: config, 
+		Seed: seed, 
+		RestoreOnly: &restoreOnly,
+	}
+	sdk, err := breez_sdk.Connect(connectRequest, BreezListener{})
+	// ANCHOR_END: init-sdk-restore-only
+	if err != nil {
+		log.Fatalf("Connect failed: %#v", err)
+	}
+	return sdk
+}
+
 func FetchBalance() {
 	// ANCHOR: fetch-balance
 	if nodeInfo, err := sdk.NodeInfo(); err != nil {

snippets/go/go.mod

@@ -2,6 +2,6 @@ module main
 
 go 1.19
 
-require github.com/breez/breez-sdk-go v0.2.15
+require github.com/breez/breez-sdk-go v0.3.0
 
 replace github.com/breez/breez-sdk-go => ./packages/breez-sdk-go

snippets/kotlin_mpp_lib/shared/build.gradle.kts

@@ -34,7 +34,7 @@ kotlin {
         }
         val commonMain by getting {
             dependencies {
-                implementation("technology.breez:breez-sdk-kmp:0.2.15")
+                implementation("technology.breez:breez-sdk-kmp:0.3.0")
             }
         }
     }

snippets/kotlin_mpp_lib/shared/src/commonMain/kotlin/com/example/kotlinmpplib/GettingStarted.kt

@@ -26,13 +26,25 @@ class GettingStarted {
 
         try {
             // Connect to the Breez SDK make it ready for use
-            val sdk = connect(config, seed, SDKListener())
+            val connectRequest = ConnectRequest(config, seed)
+            val sdk = connect(connectRequest, SDKListener())
         } catch (e: Exception) {
             // handle error
         }
         // ANCHOR_END: init-sdk
     }
 
+    fun start_restore_only(config: Config, seed: List<UByte>) {
+        try {
+            // ANCHOR: init-sdk-restore-only
+            val connectRequest = ConnectRequest(config, seed, true)
+            val sdk = connect(connectRequest, SDKListener())
+            // ANCHOR_END: init-sdk-restore-only
+        } catch (e: Exception) {
+            // handle error
+        }
+    }
+
     fun fetch_balance(sdk: BlockingBreezServices) {
         // ANCHOR: fetch-balance
         try {

snippets/python/src/getting_started.py

@@ -23,14 +23,26 @@ def getting_started(API_KEY,mnemonic,temp_dir):
 
     try:
         # Connect to the Breez SDK make it ready for use
-        sdk_services = breez_sdk.connect(config, seed, SDKListener())
+        connect_request = breez_sdk.ConnectRequest(config, seed)
+        sdk_services = breez_sdk.connect(connect_request, SDKListener())
 
         return sdk_services
     except Exception as error:
         logging.error(error)
         raise
     # ANCHOR_END: init-sdk
 
+def getting_started_restore_only(config, seed):
+    try:
+        # ANCHOR: init-sdk-restore-only
+        connect_request = breez_sdk.ConnectRequest(config, seed, restore_only=True)
+        sdk_services = breez_sdk.connect(connect_request, SDKListener())
+        # ANCHOR_END: init-sdk-restore-only
+        return sdk_services
+    except Exception as error:
+        logging.error(error)
+        raise
+
 def getting_started_node_info(sdk_services):
 
     try: 

snippets/react-native/getting_started.ts

@@ -1,6 +1,8 @@
 import {
   type BreezEvent,
   connect,
+  type Config,
+  type ConnectRequest,
   defaultConfig,
   EnvironmentType,
   mnemonicToSeed,
@@ -35,13 +37,25 @@ const exampleGettingStarted = async () => {
     )
 
     // Connect to the Breez SDK make it ready for use
-    await connect(config, seed, onBreezEvent)
+    const connectRequest: ConnectRequest = { config, seed }
+    await connect(connectRequest, onBreezEvent)
   } catch (err) {
     console.error(err)
   }
   // ANCHOR_END: init-sdk
 }
 
+const exampleGettingRestoreOnly = async (config: Config, seed: number[]) => {
+  try {
+    // ANCHOR: init-sdk-restore-only
+    const connectRequest: ConnectRequest = { config, seed, restoreOnly: true }
+    await connect(connectRequest, onBreezEvent)
+    // ANCHOR_END: init-sdk-restore-only
+  } catch (err) {
+    console.error(err)
+  }
+}
+
 const exampleFetchNodeInfo = async () => {
   // ANCHOR: fetch-balance
   try {

snippets/react-native/yarn.lock

@@ -714,10 +714,10 @@
     "@babel/helper-validator-identifier" "^7.22.20"
     to-fast-properties "^2.0.0"
 
-"@breeztech/react-native-breez-sdk@0.2.15":
-  version "0.2.15"
-  resolved "https://registry.yarnpkg.com/@breeztech/react-native-breez-sdk/-/react-native-breez-sdk-0.2.15.tgz#0a415747e94b08f0dbbca8aae23f2d4231881db3"
-  integrity sha512-VxT4wdZCyDrhZBe6heHJKUJc1nbVJ4Y0qbOm1B+LJa6JOq0YDooUFnbtHMq1PHQ3xviwuM1pCzAco0orWqnvDA==
+"@breeztech/react-native-breez-sdk@0.3.0":
+  version "0.3.0"
+  resolved "https://registry.yarnpkg.com/@breeztech/react-native-breez-sdk/-/react-native-breez-sdk-0.3.0.tgz#7b4d424bc287b6e52bc42e8170fffd3e0365bfe5"
+  integrity sha512-5okCI4MgUIuwybYFMjh/qIH2KjJTrbA6iRJG2rXGgQRQw1fO1DvOV8Q/o5ER8kLSUfeCOucu5OQmxfSW/Q66pA==
 
 "@esbuild/android-arm64@0.18.20":
   version "0.18.20"