From 3ab96e126bb88f43a3638249d95583edacca2d1c Mon Sep 17 00:00:00 2001 From: Ross Savage Date: Thu, 21 Sep 2023 13:02:25 +0200 Subject: [PATCH 1/3] Update connect interface --- src/guide/getting_started.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/guide/getting_started.md b/src/guide/getting_started.md index ff6b673..afbc55f 100644 --- a/src/guide/getting_started.md +++ b/src/guide/getting_started.md @@ -132,8 +132,8 @@ try { ```typescript // SDK events listener -addEventListener((type, data) => { - console.log(`received event ${type}`); +const onBreezEvent = (event: BreezEvent) => { + console.log(`received event ${event.type}`) }) // Create the default config @@ -152,7 +152,7 @@ config.workingDir = "path to an existing directory"; try { // Connect to the Breez SDK make it ready for use - const sdkServices = await connect(config, seed); + const sdkServices = await connect(config, seed, onBreezEvent) } catch (error) { console.log(error) } From 890998adcf9f383e2038825d8a9b6288bccff506 Mon Sep 17 00:00:00 2001 From: Ross Savage Date: Thu, 21 Sep 2023 13:03:14 +0200 Subject: [PATCH 2/3] Fix inconsistent use of semicolons --- src/guide/getting_started.md | 8 ++++---- src/guide/lnurl_auth.md | 2 +- src/guide/lnurl_pay.md | 4 ++-- src/guide/lnurl_withdraw.md | 4 ++-- src/guide/payments.md | 4 ++-- src/guide/receive_onchain.md | 2 +- src/guide/send_onchain.md | 12 ++++++------ 7 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/guide/getting_started.md b/src/guide/getting_started.md index afbc55f..482c367 100644 --- a/src/guide/getting_started.md +++ b/src/guide/getting_started.md @@ -137,18 +137,18 @@ const onBreezEvent = (event: BreezEvent) => { }) // Create the default config -const seed = await mnemonicToSeed(""); -const inviteCode = ""; +const seed = await mnemonicToSeed("") +const inviteCode = "" const nodeConfig : NodeConfig = { type: NodeConfigType.GREENLIGHT, config: { inviteCode: "your invite code" } } -let config = await defaultConfig(EnvironmentType.PRODUCTION, "api key", nodeConfig); +let config = await defaultConfig(EnvironmentType.PRODUCTION, "api key", nodeConfig) // Customize the config object according to your needs -config.workingDir = "path to an existing directory"; +config.workingDir = "path to an existing directory" try { // Connect to the Breez SDK make it ready for use diff --git a/src/guide/lnurl_auth.md b/src/guide/lnurl_auth.md index 0e32ed0..bb24e84 100644 --- a/src/guide/lnurl_auth.md +++ b/src/guide/lnurl_auth.md @@ -79,7 +79,7 @@ try { ```typescript // Endpoint can also be of the form: // keyauth://domain.com/auth?key=val -let lnurlAuthUrl = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttvdankjm3lw3skw0tvdankjm3xdvcn6vtp8q6n2dfsx5mrjwtrxdjnqvtzv56rzcnyv3jrxv3sxqmkyenrvv6kve3exv6nqdtyv43nqcmzvdsnvdrzx33rsenxx5unqc3cxgeqgntfgu"; +let lnurlAuthUrl = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttvdankjm3lw3skw0tvdankjm3xdvcn6vtp8q6n2dfsx5mrjwtrxdjnqvtzv56rzcnyv3jrxv3sxqmkyenrvv6kve3exv6nqdtyv43nqcmzvdsnvdrzx33rsenxx5unqc3cxgeqgntfgu" try { const input = await parseInput(lnurlAuthUrl) diff --git a/src/guide/lnurl_pay.md b/src/guide/lnurl_pay.md index df52d31..b172799 100644 --- a/src/guide/lnurl_pay.md +++ b/src/guide/lnurl_pay.md @@ -71,12 +71,12 @@ try { // Endpoint can also be of the form: // lnurlp://domain.com/lnurl-pay?key=val // lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf -let lnurlPayUrl = "lightning@address.com"; +let lnurlPayUrl = "lightning@address.com" try { const input = await parseInput(lnurlPayUrl) if (input.type === InputType.LNURL_PAY) { - const amountSats = input.data.minSendable; + const amountSats = input.data.minSendable const result = await payLnurl(input.data, amountSats, "comment") } } catch (error) { diff --git a/src/guide/lnurl_withdraw.md b/src/guide/lnurl_withdraw.md index 76e305f..f29d2d3 100644 --- a/src/guide/lnurl_withdraw.md +++ b/src/guide/lnurl_withdraw.md @@ -70,12 +70,12 @@ try { ```typescript // Endpoint can also be of the form: // lnurlw://domain.com/lnurl-withdraw?key=val -let lnurlWithdrawUrl = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4exctthd96xserjv9mn7um9wdekjmmw843xxwpexdnxzen9vgunsvfexq6rvdecx93rgdmyxcuxverrvcursenpxvukzv3c8qunsdecx33nzwpnvg6ryc3hv93nzvecxgcxgwp3h33lxk"; +let lnurlWithdrawUrl = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4exctthd96xserjv9mn7um9wdekjmmw843xxwpexdnxzen9vgunsvfexq6rvdecx93rgdmyxcuxverrvcursenpxvukzv3c8qunsdecx33nzwpnvg6ryc3hv93nzvecxgcxgwp3h33lxk" try { const input = await parseInput(lnurlWithdrawUrl) if (input.type === InputType.LNURL_WITHDRAW) { - const amountSats = input.data.minWithdrawable; + const amountSats = input.data.minWithdrawable const result = await withdrawLnurl(input.data, amountSats, "comment") } } catch (error) { diff --git a/src/guide/payments.md b/src/guide/payments.md index e599797..d68a02d 100644 --- a/src/guide/payments.md +++ b/src/guide/payments.md @@ -169,7 +169,7 @@ try {
```typescript -const bolt11 = "..."; +const bolt11 = "..." try { const payment = await sendPayment(bolt11, 3000) } catch (error) { @@ -276,7 +276,7 @@ try {
```typescript -const nodeId = "..."; +const nodeId = "..." try { const payment = await sendSpontaneousPayment(nodeId, 3000) } catch (error) { diff --git a/src/guide/receive_onchain.md b/src/guide/receive_onchain.md index 52ea6a8..0125cbd 100644 --- a/src/guide/receive_onchain.md +++ b/src/guide/receive_onchain.md @@ -56,7 +56,7 @@ try { const swapInfo = await receiveOnchain({}) // Send your funds to the below bitcoin address - const address = swapInfo.bitcoinAddress; + const address = swapInfo.bitcoinAddress } catch (error) { console.log(error) } diff --git a/src/guide/send_onchain.md b/src/guide/send_onchain.md index af93f13..4a3e12e 100644 --- a/src/guide/send_onchain.md +++ b/src/guide/send_onchain.md @@ -54,7 +54,7 @@ try { try { const currentFees = await fetchReverseSwapFees({sendAmountSat: 50000}) - console.log(`Total estimated fees for reverse swap: ${currentFees.totalEstimatedFees}`); + console.log(`Total estimated fees for reverse swap: ${currentFees.totalEstimatedFees}`) } catch (error) { console.log(error) } @@ -162,8 +162,8 @@ Log.v("Breez", "Maximum amount, in sats: ${fees.max}")
```typescript -console.log(`Minimum amount, in sats: ${currentFees.min}`); -console.log(`Maximum amount, in sats: ${currentFees.max}`); +console.log(`Minimum amount, in sats: ${currentFees.min}`) +console.log(`Maximum amount, in sats: ${currentFees.max}`) ```
@@ -257,8 +257,8 @@ try {
```typescript -const destinationAddress = "bc1.."; -const amountSat = currentFees.min; +const destinationAddress = "bc1.." +const amountSat = currentFees.min const satPerVbyte = try { const reverseSwapInfo = await sendOnchain(amountSat, destinationAddress, currentFees.feesHash, satPerVbyte) @@ -384,7 +384,7 @@ for (rs in sdk.inProgressReverseSwaps()) { try { const swaps = await inProgressReverseSwaps() for (const swap in swaps) { - println(`Reverse swap ${swap.id} in progress, status is ${swap.status}`); + println(`Reverse swap ${swap.id} in progress, status is ${swap.status}`) } } catch (error) { console.log(error) From 87e4c62043adf8576ddb2b9ab44086f658024c28 Mon Sep 17 00:00:00 2001 From: Ross Savage Date: Mon, 2 Oct 2023 18:58:08 +0200 Subject: [PATCH 3/3] Fix lnurl handling --- src/guide/lnurl_auth.md | 8 ++++---- src/guide/lnurl_pay.md | 2 +- src/guide/lnurl_withdraw.md | 2 +- src/guide/send_onchain.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/guide/lnurl_auth.md b/src/guide/lnurl_auth.md index bb24e84..966d952 100644 --- a/src/guide/lnurl_auth.md +++ b/src/guide/lnurl_auth.md @@ -83,12 +83,12 @@ let lnurlAuthUrl = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttvdankjm3lw3skw0 try { const input = await parseInput(lnurlAuthUrl) - if (input.type === InputType.LNURL_AUTH) { + if (input.type === InputTypeVariant.LN_URL_AUTH) { const result = await lnurlAuth(input.data) - if (result.status === "ok") { - print("Successfully authenticated") + if (result.type === LnUrlCallbackStatusVariant.OK) { + console.log("Successfully authanticated") } else { - print("Failed to authenticate") + console.log("Failed to authenticate") } } } catch (error) { diff --git a/src/guide/lnurl_pay.md b/src/guide/lnurl_pay.md index b172799..8c7a192 100644 --- a/src/guide/lnurl_pay.md +++ b/src/guide/lnurl_pay.md @@ -75,7 +75,7 @@ let lnurlPayUrl = "lightning@address.com" try { const input = await parseInput(lnurlPayUrl) - if (input.type === InputType.LNURL_PAY) { + if (input.type === InputTypeVariant.LN_URL_PAY) { const amountSats = input.data.minSendable const result = await payLnurl(input.data, amountSats, "comment") } diff --git a/src/guide/lnurl_withdraw.md b/src/guide/lnurl_withdraw.md index f29d2d3..bb24d92 100644 --- a/src/guide/lnurl_withdraw.md +++ b/src/guide/lnurl_withdraw.md @@ -74,7 +74,7 @@ let lnurlWithdrawUrl = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4exctthd96xserjv9 try { const input = await parseInput(lnurlWithdrawUrl) - if (input.type === InputType.LNURL_WITHDRAW) { + if (input.type === InputTypeVariant.LN_URL_WITHDRAW) { const amountSats = input.data.minWithdrawable const result = await withdrawLnurl(input.data, amountSats, "comment") } diff --git a/src/guide/send_onchain.md b/src/guide/send_onchain.md index 4a3e12e..1ce3698 100644 --- a/src/guide/send_onchain.md +++ b/src/guide/send_onchain.md @@ -383,8 +383,8 @@ for (rs in sdk.inProgressReverseSwaps()) { ```typescript try { const swaps = await inProgressReverseSwaps() - for (const swap in swaps) { - println(`Reverse swap ${swap.id} in progress, status is ${swap.status}`) + for (const swap of swaps) { + console.log(`Reverse swap ${swap.id} in progress, status is ${swap.status}`) } } catch (error) { console.log(error)