Merge branch 'main' into ok300-snippets-rust

# Conflicts: # src/guide/lnurl_pay.md # src/guide/lnurl_withdraw.md # src/guide/receive_payment.md # src/guide/send_spontaneous_payment.md
2025-12-17 22:04:21 +01:00 · 2023-10-25 20:36:17 +02:00
parent ec4955c488 0854cd0caf
commit 078cf7a5da
4 changed files with 74 additions and 40 deletions
--- a/src/guide/lnurl_pay.md
+++ b/src/guide/lnurl_pay.md
@@ -20,11 +20,14 @@
 // lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf
 let lnurlPayUrl = "lightning@address.com";
 do {
-  let inputType = try parseInput(s: lnurlPayUrl)
+    let inputType = try parseInput(s: lnurlPayUrl)
    if case .lnUrlPay(let data) = inputType {
-    let amountSats = data.minSendable;
-    try sdk.payLnurl(reqData: data, amountSats: amountSats, comment: "comment")
-  }
+        let amountMsat = data.minSendable;
+        try sdk.payLnurl(req: LnUrlPayRequest(
+            data: data, 
+            amountMsat: amountMsat, 
+            comment: "comment"))
+    }
 } catch {
    // handle error
 }
@@ -43,9 +46,8 @@ try {
    val inputType = parseInput(lnurlPayUrl)
    if (inputType is InputType.LnUrlPay) {
        val requestData = inputType.data
-        val amountSats = requestData.minSendable
-        val comment = "Any comment"
-        sdk.payLnurl(requestData, amountSats, comment)
+        val amountMsat = requestData.minSendable
+        sdk.payLnurl(LnUrlPayRequest(requestData, amountMsat, "comment"))
    }
 } catch (e: Exception) {
    // handle error
@@ -79,10 +81,14 @@ try {
 lnurl_pay_url = "lightning@address.com"

 try: 
-  parsed_input = breez_sdk.parse_input(lnurl_pay_url)
-  if isinstance(parsed_input, breez_sdk.InputType.LN_URL_PAY):
-    amount_sats = parsed_input.data.min_sendable
-    result = sdk_service.pay_lnurl(parsed_input.data, amount_sats, "comment")
+    parsed_input = breez_sdk.parse_input(lnurl_pay_url)
+    if isinstance(parsed_input, breez_sdk.InputType.LN_URL_PAY):
+        amount_msat = parsed_input.data.min_sendable
+        result = sdk_service.pay_lnurl(
+            breez_sdk.LnUrlPayRequest(
+                data=parsed_input.data, 
+                amount_msat=amount_msat, 
+                comment="comment"))
 except Exception as error:
      # Handle error
 ```
@@ -100,9 +106,14 @@ lnurlPayUrl := "lightning@address.com"
 if input, err := breez_sdk.ParseInput(lnurlPayUrl); err != nil {
    switch inputType := input.(type) {
    case breez_sdk.InputTypeLnUrlPay:
-        amountsSats := inputType.Data.MinSendable
+        amountMsat := inputType.Data.MinSendable
        comment := "comment"
-        if result, err := sdk.PayLnurl(inputType.Data, amountsSats, &comment); err != nil {
+        lnUrlPayRequest := breez_sdk.LnUrlPayRequest{
+            Data:       inputType.Data,
+            AmountMsat: amountMsat,
+            Comment:    &comment,
+        }
+        if result, err := sdk.PayLnurl(lnUrlPayRequest); err != nil {
            switch result.(type) {
            case breez_sdk.LnUrlPayResultEndpointSuccess:
                log.Printf("Successfully paid")
@@ -128,8 +139,8 @@ try
 {
    var input = BreezSdkMethods.ParseInput(lnurlPayUrl);
    if (input is InputType.LnUrlPay lnurlp) {
-        var amountSats = lnurlp.data.minSendable;
-        var result = sdk.PayLnurl(lnurlp.data, amountSats, "comment");
+        var amountMsat = lnurlp.data.minSendable;
+        var result = sdk.PayLnurl(new LnUrlPayRequest(lnurlp.data, amountMsat, "comment"));
    }
 } 
 catch (Exception) 
--- a/src/guide/lnurl_withdraw.md
+++ b/src/guide/lnurl_withdraw.md
@@ -23,12 +23,16 @@ let lnurlWithdrawUrl = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4exctthd96xserjv9
 do {
  let inputType = try parseInput(s: lnurlWithdrawUrl)
  if case .lnUrlWithdraw(let data) = inputType {
-    let amountSat = data.minWithdrawable
+    let amountMsat = data.minWithdrawable
    let description = "Test withdraw"
-    try sdk.withdrawLnurl(reqData: data, amountSats: amountSat, description: "comment")
+    req: ListPaymentsRequest(filter: PaymentTypeFilter.all)
+    try sdk.withdrawLnurl(req: LnUrlWithdrawRequest(
+        data: data,
+        amountMsat: amountMsat,
+        description: "comment"))
  }
 } catch {
-    // handle error
+  // handle error
 }
 ```
 </section>
@@ -45,9 +49,9 @@ try {
    val inputType = parseInput(lnurlPayUrl)
    if (inputType is InputType.LnUrlWithdraw) {
        val requestData = inputType.data
-        val amountSats = requestData.minWithdrawable
+        val amountMsat = requestData.minWithdrawable
        val comment = "Any comment"
-        sdk.withdrawLnurl(requestData, amountSats, comment)
+        sdk.withdrawLnurl(LnUrlWithdrawRequest(requestData, amountMsat, comment)
    }
 } catch (e: Exception) {
    // handle error
@@ -82,8 +86,8 @@ lnurl_withdraw_url = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4exctthd96xserjv9mn
 try:
  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")
+    amount_msat = parsed_input.data.min_withdrawable
+    result = sdk_services.withdraw_lnurl(breez_sdk.LnUrlWithdrawRequest(data=parsed_input.data, amount_msat=amount_msat, description="comment"))
 except Exception as error:
      # Handle error
 ```
@@ -100,9 +104,13 @@ lnurlWithdrawUrl := "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4exctthd96xserjv9mn7
 if input, err := breez_sdk.ParseInput(lnurlWithdrawUrl); err != nil {
    switch inputType := input.(type) {
    case breez_sdk.InputTypeLnUrlWithdraw:
-        amountsSats := inputType.Data.MinWithdrawable
+        amountMsat := inputType.Data.MinWithdrawable
        description := "comment"
-        if result, err := sdk.WithdrawLnurl(inputType.Data, amountsSats, &description); err != nil {
+        if result, err := sdk.WithdrawLnurl(breez_sdk.LnUrlWithdrawRequest{
+            Data: inputType.Data, 
+            AmountMsat: amountMsat, 
+            Description: &description,
+        }); err != nil {
            switch result.(type) {
            case breez_sdk.LnUrlCallbackStatusOk:
                log.Printf("Successfully withdrawn")
@@ -128,8 +136,12 @@ try
    var input = BreezSdkMethods.ParseInput(lnurlWithdrawUrl);
    if (input is InputType.LnUrlWithdraw lnurlw) 
    {
-        var amountSats = lnurlw.data.minWithdrawable;
-        var result = sdk.WithdrawLnurl(lnurlw.data, amountSats, "comment");
+        var amountMsat = lnurlw.data.minWithdrawable;
+        var result = sdk.WithdrawLnurl(
+            new LnUrlWithdrawRequest(
+                lnurlw.data, 
+                amountMsat, 
+                "comment"));
    }
 } 
 catch (Exception) 
--- a/src/guide/receive_payment.md
+++ b/src/guide/receive_payment.md
@@ -18,8 +18,8 @@ The Breez SDK automatically connects your node to the LSP peer and you can now r
 ```swift
 do {
  let invoice = try sdk.receivePayment(
-    reqData: ReceivePaymentRequest(
-        amountSats: 3000, 
+    req: ReceivePaymentRequest(
+        amountMsat: 3_000_000, 
        description: "Invoice for 3000 sats"))
 } catch {
    // handle error
@@ -33,7 +33,7 @@ do {
 ```kotlin,ignore
 try {
    val invoice = sdk.receivePayment(ReceivePaymentRequest(
-        3000L.toULong(),
+        3_000_000L.toULong(),
        "Invoice for 3000 sats",
    ))
 } catch (e: Exception) {
@@ -65,7 +65,7 @@ try {
 try:
  receive_payment_response = sdk_services.receive_payment(
    breez_sdk.ReceivePaymentRequest(
-        amount_sats=3000,
+        amount_msat=3_000_000,
        description="Invoice for 3000 sats"))
 except Exception as error:
  # Handle error
@@ -77,7 +77,7 @@ except Exception as error:

 ```go
 receivePaymentRequest := breez_sdk.ReceivePaymentRequest{
-    AmountSats:  3000,
+    AmountMsat:  3_000_000,
    Description: "Invoice for 3000 sats",
 }
 if receivePaymentResponse, err := sdk.ReceivePayment(receivePaymentRequest); err == nil {
@@ -93,7 +93,7 @@ if receivePaymentResponse, err := sdk.ReceivePayment(receivePaymentRequest); err
 try 
 {
    var invoice = sdk.ReceivePayment(
-        new ReceivePaymentRequest(3000, "Invoice for 3000 sats"));
+        new ReceivePaymentRequest(3_000_000, "Invoice for 3000 sats"));
 } 
 catch (Exception) 
 {
--- a/src/guide/send_spontaneous_payment.md
+++ b/src/guide/send_spontaneous_payment.md
@@ -17,7 +17,10 @@ They can even be spontaneous payments to a node without a bolt11 invoice.
 ```swift
 let nodeId = "...";
 do {
-  let payment = try sdk.sendSpontaneousPayment(nodeId: nodeId, amountSats: 3000)
+    let response = try sdk.sendSpontaneousPayment(
+        req: SendSpontaneousPaymentRequest(
+            nodeId: "...",
+            amountMsat: 3000000))
 } catch {
    // handle error
 }
@@ -29,8 +32,10 @@ do {

 ```kotlin,ignore
 val nodeId = "..."
+val amountMsat = 3000000L.toULong()
 try {
-    val payment = sdk.sendSpontaneousPayment(nodeId, 3000L.toULong())
+    val response = sdk.sendSpontaneousPayment(
+        SendSpontaneousPaymentRequest(nodeId, amountMsat))
 } catch (e: Exception) {
    // handle error
 }
@@ -57,9 +62,11 @@ try {
 <section>

 ```python
-node_id = "..."
 try:
-  sdk_services.send_spontaneous_payment(node_id=node_id, amount_sats=3000)
+    sdk_services.send_spontaneous_payment(
+        breez_sdk.SendSpontaneousPaymentRequest(
+            node_id="...", 
+            amount_msat=3000000))
 except Exception as error:
  # Handle error
 ```
@@ -69,9 +76,12 @@ except Exception as error:
 <section>

 ```go
-nodeId := "node id"
-if payment, err := sdk.SendSpontaneousPayment(nodeId, 3000); err == nil {
-    log.Printf("%#v", payment)
+sendSpontaneousPaymentRequest := breez_sdk.SendSpontaneousPaymentRequest{
+    NodeId:     "...",
+    AmountMsat: uint64(3000000),
+}
+if response, err := sdk.SendSpontaneousPayment(sendSpontaneousPaymentRequest); err == nil {
+    log.Printf("%#v", response)
 }
 ```
 </section>
@@ -81,9 +91,10 @@ if payment, err := sdk.SendSpontaneousPayment(nodeId, 3000); err == nil {

 ```cs
 var nodeId = "...";
+var amountMsat = 3000000;
 try 
 {
-    var payment = sdk.SendSpontaneousPayment(nodeId, 3000);
+    var response = sdk.SendSpontaneousPayment(new SendSpontaneousPaymentRequest(nodeId, amountMsat));
 } 
 catch (Exception) 
 {