From 5f73890749f4971f036ed4a84bd32e0c0638007a Mon Sep 17 00:00:00 2001 From: Ross Savage Date: Sat, 7 Oct 2023 14:07:14 +0200 Subject: [PATCH 1/2] Fix python examples --- src/guide/lnurl_auth.md | 2 +- src/guide/lnurl_withdraw.md | 2 +- src/guide/receive_onchain.md | 11 +++++------ src/guide/send_onchain.md | 17 +++++++---------- 4 files changed, 14 insertions(+), 18 deletions(-) diff --git a/src/guide/lnurl_auth.md b/src/guide/lnurl_auth.md index 7856919..1077b36 100644 --- a/src/guide/lnurl_auth.md +++ b/src/guide/lnurl_auth.md @@ -127,7 +127,7 @@ try { ```python # Endpoint can also be of the form: # keyauth://domain.com/auth?key=val -lnurlAuthUrl = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttvdankjm3lw3skw0tvdankjm3xdvcn6vtp8q6n2dfsx5mrjwtrxdjnqvtzv56rzcnyv3jrxv3sxqmkyenrvv6kve3exv6nqdtyv43nqcmzvdsnvdrzx33rsenxx5unqc3cxgeqgntfgu" +lnurl_auth_url = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttvdankjm3lw3skw0tvdankjm3xdvcn6vtp8q6n2dfsx5mrjwtrxdjnqvtzv56rzcnyv3jrxv3sxqmkyenrvv6kve3exv6nqdtyv43nqcmzvdsnvdrzx33rsenxx5unqc3cxgeqgntfgu" try: parsed_input = breez_sdk.parse_input(lnurl_auth_url) diff --git a/src/guide/lnurl_withdraw.md b/src/guide/lnurl_withdraw.md index e26605e..24dbe19 100644 --- a/src/guide/lnurl_withdraw.md +++ b/src/guide/lnurl_withdraw.md @@ -117,7 +117,7 @@ try { lnurl_withdraw_url = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4exctthd96xserjv9mn7um9wdekjmmw843xxwpexdnxzen9vgunsvfexq6rvdecx93rgdmyxcuxverrvcursenpxvukzv3c8qunsdecx33nzwpnvg6ryc3hv93nzvecxgcxgwp3h33lxk" try: - parsed_input = parse_input(lnurl_withdraw_url) + parsed_input = breez_sdk.parse_input(lnurl_withdraw_url) if isinstance(parsed_input, breez_sdk.InputType.LN_URL_WITHDRAW): amount_sats = parsed_input.data.min_withdrawable result = sdk_services.withdraw_lnurl(parsed_input.data, amount_sats, "comment") diff --git a/src/guide/receive_onchain.md b/src/guide/receive_onchain.md index 86cc187..833265c 100644 --- a/src/guide/receive_onchain.md +++ b/src/guide/receive_onchain.md @@ -88,7 +88,7 @@ try: swap_info = sdk_services.receive_onchain(breez_sdk.ReceiveOnchainRequest()) # Send your funds to the below bitcoin address - address = sdk_services.swap_info.bitcoin_address + address = swap_info.bitcoin_address except Exception as error: # Handle error ``` @@ -405,13 +405,12 @@ try { ```python destination_address = "..." -sat_per_vbyte = +sat_per_vbyte = 5 try: - result = sdk_services.refund( - swap_address=refundable.bitcoin_address, - to_address=to_address, - sat_per_vbyte=sat_per_vbyte) + result = sdk_services.refund(swap_address=refundable.bitcoin_address, + to_address=destination_address, + sat_per_vbyte=sat_per_vbyte) except Exception as error: # Handle error ``` diff --git a/src/guide/send_onchain.md b/src/guide/send_onchain.md index 944063f..581dedb 100644 --- a/src/guide/send_onchain.md +++ b/src/guide/send_onchain.md @@ -86,7 +86,7 @@ try { try: current_fees = sdk_services.fetch_reverse_swap_fees( breez_sdk.ReverseSwapFeesRequest(send_amount_sat=50000)) - print("Total estimated fees for reverseswap:", current_fees.total_estimated_fees) + print("Total estimated fees for reverseswap: ", current_fees.total_estimated_fees) except Exception as error: # Handle error ``` @@ -294,16 +294,13 @@ try { ```python destination_address = "bc1.." -amount_sat = current_fees.min -fee_hash = current_fees.fee_hash -sat_per_vbyte = - +amount_sat = 50000 +sat_per_vbyte = 5 try: - sdk_services.send_onchain( - amount_sat=amount_msats, - onchain_recipient_address="...", - pair_hash=current_fees.fee_hash, - sat_per_vbyte=sat_per_vbyte) + sdk_services.send_onchain(amount_sat=amount_sat, + onchain_recipient_address=destination_address, + pair_hash=current_fees.fee_hash, + sat_per_vbyte=sat_per_vbyte) except Exception as error: # Handle erorr ``` From 66d0b90fe0f62b9c82a39f4763ef4f03329a8a1d Mon Sep 17 00:00:00 2001 From: Ross Savage Date: Sat, 7 Oct 2023 14:08:31 +0200 Subject: [PATCH 2/2] Fix consistency in getting started examples --- src/guide/getting_started.md | 51 ++++++++++++++++++++---------------- 1 file changed, 28 insertions(+), 23 deletions(-) diff --git a/src/guide/getting_started.md b/src/guide/getting_started.md index dacf66e..687126f 100644 --- a/src/guide/getting_started.md +++ b/src/guide/getting_started.md @@ -40,12 +40,13 @@ Now your SDK is ready to be used. ```rust,ignore let mnemonic = Mnemonic::generate_in(Language::English, 12)?; let seed = mnemonic.to_seed(""); -let invite_code = Some("...".into()); +let invite_code = Some("".into()); +let api_key = "".into() // Create the default config let mut config = BreezServices::default_config( EnvironmentType::Production, - "your API key".into(), + api_key, breez_sdk_core::NodeConfig::Greenlight { config: GreenlightNodeConfig { partner_credentials: None, @@ -80,11 +81,12 @@ class SDKListener: EventListener { } // Create the default config -let seed = try mnemonicToSeed(phrase: "") -let inviteCode = "your invite code" -let config = breez_sdk.defaultConfig(envType: EnvironmentType.production, apiKey: "", +let seed = try mnemonicToSeed(phrase: "") +let inviteCode = "" +let apiKey = "" +let config = breez_sdk.defaultConfig(envType: EnvironmentType.production, apiKey: apiKey, nodeConfig: NodeConfig.greenlight( - config: GreenlightNodeConfig(partnerCredentials: nil,inviteCode: inviteCode))); + config: GreenlightNodeConfig(partnerCredentials: nil, inviteCode: inviteCode))); // Customize the config object according to your needs config.workingDir = "path to an existing directory" @@ -111,14 +113,14 @@ class SDKListener : EventListener { } // Select your seed, invite code and eviroment -val seed = mnemonicToSeed("") -val inviteCode = "your invite code" -val environmentType = EnvironmentType.PRODUCTION +val seed = mnemonicToSeed("") +val inviteCode = "" +val apiKey = "" // Create the default config val greenlightNodeConfig = GreenlightNodeConfig(null, inviteCode) val nodeConfig = NodeConfig.Greenlight(greenlightNodeConfig) -val config = defaultConfig(environmentType, inviteCode, nodeConfig) +val config = defaultConfig(EnvironmentType.PRODUCTION, apiKey, nodeConfig) // Customize the config object according to your needs config.workingDir = "path to an existing directory" @@ -143,15 +145,16 @@ const onBreezEvent = (event: BreezEvent) => { }) // Create the default config -const seed = await mnemonicToSeed("") -const inviteCode = "" +const seed = await mnemonicToSeed("") +const inviteCode = "" +const apiKey = "" const nodeConfig : NodeConfig = { type: NodeConfigVariant.GREENLIGHT, config: { - inviteCode: "your invite code" + inviteCode: inviteCode } } -let config = await defaultConfig(EnvironmentType.PRODUCTION, "api key", nodeConfig) +let config = await defaultConfig(EnvironmentType.PRODUCTION, apiKey, nodeConfig) // Customize the config object according to your needs config.workingDir = "path to an existing directory" @@ -182,9 +185,10 @@ breezLogStream().listen((log) { // Create the default config Uint8List seed = await mnemonicToSeed(phrase: ""); -String inviteCode = ""; +String inviteCode = ""; +String apiKey = "" NodeConfg nodeConfig = NodeConfig.greenlight(config: GreenlightNodeConfig(partnerCredentials: null, inviteCode: inviteCode)); -Config config = await defaultConfig(configType: EnvironmentType.Production, apiKey: "", nodeConfig: nodeConfig); +Config config = await defaultConfig(configType: EnvironmentType.Production, apiKey: apiKey, nodeConfig: nodeConfig); // Customize the config object according to your needs config.workingDir = "path to an existing directory"; @@ -208,9 +212,10 @@ class SDKListener(breez_sdk.EventListener): print(event) # Create the default config -seed = mnemonic_to_seed("") -invite_code = "" -config = breez_sdk.default_config(breez_sdk.EnvironmentType.PRODUCTION, "api key", +seed = mnemonic_to_seed("") +invite_code = "" +api_key = "" +config = breez_sdk.default_config(breez_sdk.EnvironmentType.PRODUCTION, apiKey, breez_sdk.NodeConfig.GREENLIGHT(breez_sdk.GreenlightNodeConfig(None, invite_code))) # Customize the config object according to your needs @@ -236,13 +241,13 @@ func (BreezListener) OnEvent(e breez_sdk.BreezEvent) { } // Create the default config -seed, err := breez_sdk.MnemonicToSeed("") +seed, err := breez_sdk.MnemonicToSeed("") if err != nil { log.Fatalf("MnemonicToSeed failed: %#v", err) } -apiKey := "" -inviteCode := "" +inviteCode := "" +apiKey := "" nodeConfig := breez_sdk.NodeConfigGreenlight{ Config: breez_sdk.GreenlightNodeConfig{ PartnerCredentials: nil, @@ -273,7 +278,7 @@ if err != nil { using Breez.Sdk; // Create the default config -var seed = BreezSdkMethods.MnemonicToSeed(""); +var seed = BreezSdkMethods.MnemonicToSeed(""); var inviteCode = ""; var apiKey = ""; var nodeConfig = new NodeConfig.Greenlight(