Add logging section

snippets/csharp/GettingStarted.cs

@@ -76,4 +76,27 @@ public void FetchNodeInfo(BlockingBreezServices sdk)
         }
         // ANCHOR_END: fetch-balance
     }
+
+    // ANCHOR: logging
+    public void GettingStartedLogging()
+    {
+        try
+        {
+            sdk = BreezSdkMethods.SetLogStream(new SdkLogStream());
+        }
+        catch (Exception)
+        {
+            // Handle error
+        }
+    }
+
+    class SdkLogStream : LogStream
+    {
+        public void Log(LogEntry l)
+        {
+            Console.WriteLine($"Received Log [{l.Level}]: {l.Line}");
+        }
+    }
+    // ANCHOR_END: logging
+
 }

snippets/dart_snippets/lib/getting_started.dart

@@ -52,3 +52,13 @@ Future<void> fetchBalance(String lspId) async {
   }
   // ANCHOR_END: fetch-balance
 }
+
+// ANCHOR: logging
+void onLogEntry(log) {
+  print("Received log ${log.level}]: ${log.line}");
+}
+
+void logging(BreezSDK breezSDK) {
+  breezSDK.logStream.listen(onLogEntry);
+}
+// ANCHOR_END: logging

snippets/go/getting_started.go

@@ -71,3 +71,18 @@ func FetchBalance() {
 	}
 	// ANCHOR_END: fetch-balance
 }
+
+// ANCHOR: logging
+type SdkLogStream struct{}
+
+func (SdkLogStream) Log(l breez_sdk.LogEntry) {
+	log.Printf("Received log [%v]: %v", l.Level, l.Line)
+}
+
+func GettingStartedLogging() {
+	err := breez_sdk.SetLogStream(SdkLogStream{})
+	if err != nil {
+		log.Fatalf("SetLogStream failed: %#v", err)
+	}
+}
+// ANCHOR_END: logging

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

@@ -60,4 +60,20 @@ class GettingStarted {
         }
         // ANCHOR_END: fetch-balance
     }
+
+    fun logging() {
+        // ANCHOR: logging
+        class SDKLogStream : LogStream {
+            override fun log(l: LogEntry) {
+                // Log.v("SDKListener", "Received log [${l.level}]: ${l.line}")
+            }
+        }
+
+        try {
+            setLogStream(SDKLogStream())
+        } catch (e: Exception) {
+            // handle error
+        }
+        // ANCHOR_END: logging
+    }
 }

snippets/python/src/getting_started.py

@@ -56,4 +56,15 @@ def getting_started_node_info(sdk_services):
         logging.error(error)
         raise
 
+# ANCHOR: logging
+class SDKLogStream(breez_sdk.LogStream):
+    def log(self, l):
+        print("Received log [", l.level, "]: ", l.line)
 
+def logging():
+    try:
+        breez_sdk.set_log_stream(SDKLogStream())
+    except Exception as error:
+        print(error)
+        raise
+# ANCHOR_END: logging

snippets/react-native/getting_started.ts

@@ -8,7 +8,9 @@ import {
   mnemonicToSeed,
   type NodeConfig,
   NodeConfigVariant,
-  nodeInfo
+  nodeInfo,
+  LogEntry,
+  setLogStream
 } from '@breeztech/react-native-breez-sdk'
 
 const exampleGettingStarted = async () => {
@@ -78,3 +80,13 @@ const exampleFetchNodeInfo = async () => {
   }
   // ANCHOR_END: fetch-balance
 }
+
+const exampleLogging = async () => {
+  // ANCHOR: logging
+  const onLogEntry = (l: LogEntry) => {
+    console.log(`Received log [${l.level}]: ${l.line}`)
+  }
+
+  const subscription = await setLogStream(onLogEntry)
+  // ANCHOR_END: logging
+}

snippets/react-native/production.ts

@@ -6,7 +6,7 @@ import {
 
 const productionNodeConfig = (): NodeConfig => {
   // ANCHOR: moving-to-production
-  // Read in your Greenlight credentials from the file file
+  // Read in your Greenlight credentials from the file
   // system, environment variable or build config
   const deviceKey: number[] = []
   const deviceCert: number[] = []

snippets/rust/src/getting_started.rs

@@ -1,7 +1,9 @@
+use std::{fs, path::PathBuf};
+use std::sync::Arc;
+
 use anyhow::Result;
 use bip39::{Language, Mnemonic};
 use breez_sdk_core::*;
-use std::sync::Arc;
 
 use crate::AppEventListener;
 
@@ -60,3 +62,14 @@ async fn getting_started_node_info(sdk: Arc<BreezServices>) -> Result<()> {
 
     Ok(())
 }
+
+async fn getting_started_logging(data_dir: String) -> Result<()> {
+    // ANCHOR: logging
+    let data_dir_path = PathBuf::from(&data_dir);
+    fs::create_dir_all(data_dir_path)?;
+
+    BreezServices::init_logging(&data_dir, None)?;
+    // ANCHOR_END: logging
+
+    Ok(())
+}

snippets/swift/BreezSDKExamples/Sources/GettingStarted.swift

@@ -57,3 +57,15 @@ func gettingStartedNodeInfo(sdk: BlockingBreezServices) {
     }
     // ANCHOR_END: fetch-balance
 }
+
+// ANCHOR: logging
+class SDKLogStream: LogStream {
+    func log(l: LogEntry) {
+        print("Received log [", l.level, "]: ", l.line)
+    }
+}
+
+func logging() throws {
+    try? setLogStream(log_stream: SDKLogStream())
+}
+// ANCHOR_END: logging

src/SUMMARY.md

@@ -3,7 +3,10 @@
 # API Overview
 
 - [Getting Started](guide/getting_started.md)
-- [Installing](guide/install.md)
+  - [Installing the Breez SDK](guide/install.md)
+  - [Connecting to a node](guide/connecting.md)
+  - [Getting the node state](guide/node_state.md)
+  - [Adding logging](guide/logging.md)
 - [Paying in Lightning](guide/payments.md)
   - [Receiving payments](guide/receive_payment.md)
   - [Sending payments](guide/send_payment.md)

src/guide/connecting.md

@@ -0,0 +1,157 @@
+# Connecting to a node
+
+The first step is to construct the SDK configuration. In it the environment and Greenlight node configuration is defined, whether you are using an invite code or partner credentials.
+
+The SDK uses the config working directory to store the state of the SDK instance. Once a connection has been established with a node, the working directory can only be used for that node. When handling multiple instances of the SDK, one per node, each needs to have a different working directory defined.
+
+Now you are ready to interact with the SDK.
+
+<custom-tabs category="lang">
+<div slot="title">Rust</div>
+<section>
+
+```rust,ignore
+{{#include ../../snippets/rust/src/getting_started.rs:init-sdk}}
+```
+
+</section>
+
+<div slot="title">Swift</div>
+<section>
+
+```swift,ignore
+{{#include ../../snippets/swift/BreezSDKExamples/Sources/GettingStarted.swift:init-sdk}}
+```
+
+</section>
+
+<div slot="title">Kotlin</div>
+<section>
+
+```kotlin,ignore
+{{#include ../../snippets/kotlin_mpp_lib/shared/src/commonMain/kotlin/com/example/kotlinmpplib/GettingStarted.kt:init-sdk}}
+```
+
+</section>
+
+<div slot="title">React Native</div>
+<section>
+
+```typescript
+{{#include ../../snippets/react-native/getting_started.ts:init-sdk}}
+```
+
+</section>
+
+<div slot="title">Dart</div>
+<section>
+
+```dart,ignore
+{{#include ../../snippets/dart_snippets/lib/getting_started.dart:init-sdk}}
+```
+</section>
+
+<div slot="title">Python</div>
+<section>
+
+```python,ignore
+{{#include ../../snippets/python/src/getting_started.py:init-sdk}}
+```
+</section>
+
+<div slot="title">Go</div>
+<section>
+
+```go,ignore
+{{#include ../../snippets/go/getting_started.go:init-sdk}}
+```
+</section>
+
+<div slot="title">C#</div>
+<section>
+
+```cs,ignore
+{{#include ../../snippets/csharp/GettingStarted.cs:init-sdk}}
+```
+</section>
+</custom-tabs>
+
+<div class="warning">
+<h4>Developer note</h4>
+
+By default the config working directory is set to `./`. Some platforms may require that you use an application specific directory that is writable within the application sandbox. For example applications running on Android or iOS.
+
+</div>
+<br/>
+
+To connect to an already existing node without registering a new one, use the `restore_only` flag in the connect request. If the node does not exist it will result in an error.
+
+<custom-tabs category="lang">
+<div slot="title">Rust</div>
+<section>
+
+```rust,ignore
+{{#include ../../snippets/rust/src/getting_started.rs:init-sdk-restore-only}}
+```
+
+</section>
+
+<div slot="title">Swift</div>
+<section>
+
+```swift,ignore
+{{#include ../../snippets/swift/BreezSDKExamples/Sources/GettingStarted.swift:init-sdk-restore-only}}
+```
+
+</section>
+
+<div slot="title">Kotlin</div>
+<section>
+
+```kotlin,ignore
+{{#include ../../snippets/kotlin_mpp_lib/shared/src/commonMain/kotlin/com/example/kotlinmpplib/GettingStarted.kt:init-sdk-restore-only}}
+```
+
+</section>
+
+<div slot="title">React Native</div>
+<section>
+
+```typescript
+{{#include ../../snippets/react-native/getting_started.ts:init-sdk-restore-only}}
+```
+
+</section>
+
+<div slot="title">Dart</div>
+<section>
+
+```dart,ignore
+{{#include ../../snippets/dart_snippets/lib/getting_started.dart:init-sdk-restore-only}}
+```
+</section>
+
+<div slot="title">Python</div>
+<section>
+
+```python,ignore
+{{#include ../../snippets/python/src/getting_started.py:init-sdk-restore-only}}
+```
+</section>
+
+<div slot="title">Go</div>
+<section>
+
+```go,ignore
+{{#include ../../snippets/go/getting_started.go:init-sdk-restore-only}}
+```
+</section>
+
+<div slot="title">C#</div>
+<section>
+
+```cs,ignore
+{{#include ../../snippets/csharp/GettingStarted.cs:init-sdk-restore-only}}
+```
+</section>
+</custom-tabs>