diff --git a/src/guide/getting_started.md b/src/guide/getting_started.md
index a99569f..7d2a3dc 100644
--- a/src/guide/getting_started.md
+++ b/src/guide/getting_started.md
@@ -9,7 +9,7 @@ The Breez SDK provides the following services:
* Fetching node status (e.g. balance, max allow to pay, max allow to receive, on-chain balance, etc.)
* Connecting to a new or existing node.
-Connecting to a node requires a seed (your master key) and credentials. The seed is a bip39 mnemonic and the credentials are retrieved by registering a new node or recovering an existing one.
+Connecting to a node requires a seed (your master key). The seed is a bip39 mnemonic.
## Installing
@@ -19,44 +19,30 @@ Breez SDK is available in several platforms. Follow the [Installing](install.md)
Rust
-The first step is to register a new node. In order to do that a seed is needed.
-## Registering a new node
-```rust,no_run
-let seed = ;
-let invite_code = ;
-
-// register_node takes either greenlight credentials (certifate & key) or invite code.
-// At this example we are using the invite code option.
-let credentials = BreezServices::register_node(Network::Bitcoin, seed, None, Some(invite_code)).await?;
-```
-
-## Recovering an existing node
-```rust,no_run
-let seed = ;
-let credentials = BreezServices::recover_node(Network::Bitcoin, seed).await?;
-```
-
-Once the credentials are retrieved they should be saved in a secured storage.
-The next step is to initialize the SDK and start the node:
-
-## Initializing the SDK
+## Connecting
```rust,no_run
// Create the default config
-let mut config = BreezServices::default_config(EnvironmentType::Production);
+let config = BreezServices::default_config(
+ EnvironmentType::Production,
+ "your API key".into(),
+ breez_sdk_core::NodeConfig::Greenlight {
+ config: GreenlightNodeConfig {
+ partner_credentials: None,
+ invite_code: None,
+ },
+ },
+);
// Customize the config object according to your needs
-config.api_key = Some("your API key".into());
config.working_dir = "path to an existing directory".into();
-let sdk = BreezServices::init_services(
+// Connect to the Breez SDK make it ready for use
+let sdk = BreezServices::connect(
config,
- seed.to_vec(),
- credentials.clone(),
+ seed.to_vec(),
Box::new(AppEventListener {}),
)
.await?;
-
-BreezServices::start(rt(), &sdk).await?;
```
At any point we can fetch our balance from the Greenlight node:
@@ -71,35 +57,7 @@ if let Some(node_state) = sdk.node_info()? {
Swift
-The first step is to register a new node. In order to do that a seed is needed.
-## Registering a new node
-```swift
-do {
- let seed = try mnemonicToSeed(phrase: "")
- let inviteCode = ""
-
- // register_node takes either greenlight credentials (certifate & key) or invite code.
- // At this example we are using the invite code option.
- let credentials = try registerNode(network: Network.bitcoin, seed: seed, registerCredentials: nil, inviteCode: inviteCode)
-} catch {
- // handle error
-}
-```
-
-## Recovering an existing node
-```swift
-do {
- let seed = try mnemonicToSeed(phrase: "")
- let credentials = try recoverNode(network: Network.bitcoin, seed: seed)
-} catch {
- // handle error
-}
-```
-
-Once the credentials are retrieved they should be saved in a secured storage.
-The next step is to initialize the SDK and start the node:
-
-## Initializing the SDK
+## Connecting
```swift
// SDK events listener
@@ -110,15 +68,18 @@ class SDKListener: EventListener {
}
// Create the default config
-var config = defaultConfig(envType: EnvironmentType.production)
+let seed = try mnemonicToSeed(phrase: "")
+let inviteCode = "your invite code"
+let config = breez_sdk.defaultConfig(envType: EnvironmentType.production, apiKey: "",
+ nodeConfig: NodeConfig.greenlight(
+ config: GreenlightNodeConfig(partnerCredentials: nil,inviteCode: inviteCode)));
// Customize the config object according to your needs
-config.apiKey = "your API key"
config.workingDir = "path to an existing directory"
-do {
- let sdk = try initServices(config: config, seed: seed, creds: credentials, listener: SDKListener());
- try sdk.start();
+do {
+ // Connect to the Breez SDK make it ready for use
+ let sdk = try connect(config: config, seed: seed, listener: SDKListener());
} catch{
// handle error
}
@@ -140,30 +101,6 @@ do {
React Native
-The first step is to register a new node. In order to do that a seed is needed.
-## Registering a new node
-```typescript
-try {
- const seed = await mnemonicToSeed("");
- const inviteCode = "";
-
- // register_node takes either greenlight credentials (certifate & key) or invite code.
- // At this example we are using the invite code option.
- const credentials = await registerNode(Network.BITCOIN, seed, null, inviteCode);
-} catch (error) {
- console.log(error)
-}
-```
-
-## Recovering an existing node
-```typescript
- const seed = await mnemonicToSeed("");
- const credentials = await recoverNode(Network.BITCOIN, seed);
-```
-
-Once the credentials are retrieved they should be saved in a secured storage.
-The next step is to initialize the SDK and start the node:
-
## Initializing the SDK
```typescript
@@ -173,15 +110,25 @@ addEventListener((type, data) => {
})
// Create the default config
-let config = defaultConfig(EnvironmentType.PRODUCTION)
+const seed = await mnemonicToSeed("");
+const inviteCode = "";
+const nodeConfig : NodeConfig = {
+ type: "greenlight",
+ config: {
+ partnerCredentials: {
+ deviceKey: null,
+ deviceCert: null
+ }
+ }
+};
+let config = defaultConfig(EnvironmentType.PRODUCTION, "api key", nodeConfig);
// Customize the config object according to your needs
-config.apiKey = "your API key";
config.workingDir = "path to an existing directory";
try {
- const sdkServices = await initServices(config, credentials.deviceKey, credentials.deviceCert, seed);
- await start();
+ // Connect to the Breez SDK make it ready for use
+ const sdkServices = await connect(config seed);
} catch (error) {
console.log(error);
}
@@ -202,31 +149,7 @@ try {
Dart
-The first step is to register a new node. In order to do that a seed is needed.
-## Registering a new node
-```dart
-try {
- Config config = await defaultConfig(configType: EnvironmentType.Production);
- Uint8List seed = await mnemonicToSeed(phrase: "");
- String inviteCode = "";
-
- // registerNode takes either greenlight credentials (certifate & key) or invite code.
- // At this example we are using the invite code option.
- GreenlightCredentials credentials = await registerNode(network: Network.Bitcoin, seed: seed, config: config, inviteCode: inviteCode);
-} catch (error) {
- // handle error
-}
-```
-
-## Recovering an existing node
-```dart
- Config config = await defaultConfig(configType: EnvironmentType.Production);
- Uint8List seed = await mnemonicToSeed("");
- GreenlightCredentials credentials = await recoverNode(network: Network.Bitcoin, seed: seed, config: config);
-```
-Once the credentials are retrieved they should be saved in a secured storage.
-The next step is to initialize the SDK and start the node:
-## Initializing the SDK
+## Connecting
```dart
// SDK events listener
breezEventsStream().listen((event) {
@@ -239,15 +162,17 @@ breezLogStream().listen((log) {
}
// Create the default config
-Config config = await defaultConfig(configType: EnvironmentType.Production);
+Uint8List seed = await mnemonicToSeed(phrase: "");
+String inviteCode = "";
+NodeConfg nodeConfig = NodeConfig.Greenlight(config: GreenlightNodeConfig(partnerCredentials: null, inviteCode: inviteCode));
+Config config = await defaultConfig(configType: EnvironmentType.Production, apiKey: "", nodeConfig: nodeConfig);
// Customize the config object according to your needs
-config.apiKey = "your API key";
config.workingDir = "path to an existing directory";
try {
- await initServices(config: config, seed: seed, creds: creds);
- await startNode();
+ // Connect to the Breez SDK make it ready for use
+ await connect(config: config, seed: seed);
} catch (error) {
// handle error
}
@@ -267,31 +192,7 @@ try {
Python
-The first step is to register a new node. In order to do that a seed is needed.
-
-## Registering a new node
-```python
-try :
- seed = mnemonic_to_seed("")
- invite_code = ""
-
- # register_node takes either greenlight credentials (certifate & key) or invite code.
- # At this example we are using the invite code option.
- credentials = register_node(Network.BITCOIN, seed, inviteCode)
-except Exception as error:
- # Handle error
-```
-
-## Recovering an existing node
-```python
-seed = mnemonic_to_seed("")
-credentials = recover_node(Network.BITCOIN, seed)
-```
-
-Once the credentials are retrieved they should be saved in a secured storage.
-The next step is to initialize the SDK and start the node:
-
-## Initializing the SDK
+## Connecting
```python
# SDK events listener
class SDKListener(breez_sdk.EventListener):
@@ -299,15 +200,17 @@ class SDKListener(breez_sdk.EventListener):
print(event)
# Create the default config
-config = default_config(EnvironmentType.PRODUCTION)
+seed = mnemonic_to_seed("")
+invite_code = ""
+config = breez_sdk.default_config(breez_sdk.EnvironmentType.PRODUCTION, "code",
+ breez_sdk.NodeConfig.GREENLIGHT(breez_sdk.GreenlightNodeConfig(None, invite_code)))
# Customize the config object according to your needs
-config.api_key = "your API key"
config.working_dir = "path to an existing directory"
try:
- sdk_services = init_services(config,seed,creds,SDKListener())
- sdk_services.start()
+ # Connect to the Breez SDK make it ready for use
+ sdk_services = breez_sdk.connect(config, seed, SDKListener())
except Exception as error:
# Handle error
```