aljaz/breez-sdk-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/breez-sdk-docs.git synced 2025-12-18 22:34:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into typo-fixes

Browse Source 
# Conflicts:
#	src/guide/send_onchain.md
This commit is contained in:
Ross Savage
2023-07-03 20:43:18 +02:00
parent dd1649b46d 8ab0d44ee5
commit adbd386ac9
7 changed files with 86 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
src/guide/getting_started.md
View File

@@ -75,21 +75,25 @@ The first step is to register a new node
## Registering a new node
```swift
do {
let seed = try mnemonicToSeed(phrase: "<mnemonics words>");
let invite_code = <your greenlight invite code>;
let seed = try mnemonicToSeed(phrase: "<mnemonics words>")
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, inviteCode: inviteCode);
} catch SdkError.Error(let message) {
print(message)
// 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
let seed = try mnemonicToSeed(phrase: "<mnemonics words>");
let credentials = try recoverNode(network: Network.bitcoin, seed: seed);
do {
let seed = try mnemonicToSeed(phrase: "<mnemonics words>")
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.
@@ -101,22 +105,22 @@ The next step is to initialize the SDK and start the node:
// SDK events listener
class SDKListener: EventListener {
func onEvent(e: BreezEvent) {
print("received event ", e);
print("received event ", e)
}
}
// Create the default config
let config = breez_sdk.defaultConfig(envType: EnvironmentType.production)
var config = defaultConfig(envType: EnvironmentType.production)
// Customize the config object according to your needs
config.apiKey = "your API key";
config.workingDir = "path to an existing directory";
do {
let sdkServices = try initServices(config: config, seed: seed, creds: credentials, listener: SDKListener());
try sdkServices.start();
} catch SdkError.Error(let message) {
print(message)
do {
let sdk = try initServices(config: config, seed: seed, creds: credentials, listener: SDKListener());
try sdk.start();
} catch{
// handle error
}
```
@@ -124,11 +128,11 @@ At any point we can fetch our balance from the Greenlight node:
```swift
do {
let nodeInfo = try sdkServices.nodeInfo();
let lnBalance = nodeInfo.channelsBalanceMsat;
let onchainBalance = nodeInfo.onchainBalanceMsat;
} catch SdkError.Error(let message) {
print(message)
let nodeInfo = try sdk.nodeInfo()
let lnBalance = nodeInfo?.channelsBalanceMsat
let onchainBalance = nodeInfo?.onchainBalanceMsat
} catch {
// handle error
}
```