Bump to 0.7.0-rc4 and update get_payment docs (#80)

* Bump to 0.7.0-rc4 and update get_payment docs * Fix typo Co-authored-by: Ross Savage <[email protected]> * Add swap id hash identifier * Fix sdk version in CI * Fix go formatting --------- Co-authored-by: Ross Savage <[email protected]>
breez · Feb 6, 2025 · e4d2b9c · e4d2b9c
1 parent d68f037
commit e4d2b9c
Show file tree

Hide file tree

Showing 23 changed files with 457 additions and 449 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -11,10 +11,10 @@ on:
   workflow_dispatch:
     inputs:
       sdk-ref:
-        description: 'sdk commit/tag/branch reference. Defaults to 0.7.0-rc1'
+        description: 'sdk commit/tag/branch reference. Defaults to 0.7.0-rc4'
         required: false
         type: string
-        default: 0.7.0-rc1
+        default: 0.7.0-rc4
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -26,9 +26,9 @@ jobs:
     runs-on: ubuntu-latest
     outputs:
       # Used only for Rust snippets
-      sdk-ref: ${{ inputs.sdk-ref || '0.7.0-rc1' }}
+      sdk-ref: ${{ inputs.sdk-ref || '0.7.0-rc4' }}
       # Used for RN and Flutter snippets
-      package-version: '0.7.0-rc1'
+      package-version: '0.7.0-rc4'
     steps:
       - run: echo "set pre-setup output variables"
 

diff --git a/snippets/csharp/ListPayments.cs b/snippets/csharp/ListPayments.cs
@@ -8,8 +8,13 @@ public void GetPayment(BindingLiquidSdk sdk)
         try
         {
             var paymentHash = "<payment hash>";
-            var payment = sdk.GetPayment(
-                new GetPaymentRequest.Lightning(paymentHash)
+            var paymentByHash = sdk.GetPayment(
+                new GetPaymentRequest.PaymentHash(paymentHash)
+            );
+
+            var swapId = "<swap id>";
+            var paymentBySwapId = sdk.GetPayment(
+                new GetPaymentRequest.SwapId(swapId)
             );
         }
         catch (Exception)

diff --git a/snippets/csharp/Snippets.csproj b/snippets/csharp/Snippets.csproj
@@ -10,4 +10,4 @@
     <PackageReference Include="Breez.Sdk.Liquid" Version="*" />
   </ItemGroup>
 
-</Project>
+</Project>
diff --git a/snippets/dart_snippets/lib/list_payments.dart b/snippets/dart_snippets/lib/list_payments.dart
@@ -1,13 +1,17 @@
 import 'package:dart_snippets/sdk_instance.dart';
 import 'package:flutter_breez_liquid/flutter_breez_liquid.dart';
 
-Future<Payment?> getPayment() async {
+Future<(Payment?, Payment?)> getPayment() async {
   // ANCHOR: get-payment
   String paymentHash = "<payment hash>";
-  GetPaymentRequest req = GetPaymentRequest.lightning(paymentHash: paymentHash);
-  Payment? payment = await breezSDKLiquid.instance!.getPayment(req: req);
+  GetPaymentRequest reqByHash = GetPaymentRequest.paymentHash(paymentHash: paymentHash);
+  Payment? paymentByHash = await breezSDKLiquid.instance!.getPayment(req: reqByHash);
+
+  String swapId = "<swap id>";
+  GetPaymentRequest reqBySwapId = GetPaymentRequest.swapId(swapId: swapId);
+  Payment? paymentBySwapId = await breezSDKLiquid.instance!.getPayment(req: reqBySwapId);
   // ANCHOR_END: get-payment
-  return payment;
+  return (paymentByHash, paymentBySwapId);
 }
 
 Future<List<Payment>> listPayments() async {

diff --git a/snippets/dart_snippets/pubspec.lock b/snippets/dart_snippets/pubspec.lock
@@ -46,10 +46,10 @@ packages:
     description:
       path: "."
       ref: HEAD
-      resolved-ref: "0c419e0703d5f37e13a96113e71618afc5c50fd3"
+      resolved-ref: "0647370f6a2dc26a52f609b942cb3d93f765adae"
       url: "https://github.com/breez/breez-sdk-liquid-dart"
     source: git
-    version: "0.7.0-rc1"
+    version: "0.7.0-rc5"
   build_cli_annotations:
     dependency: transitive
     description:
@@ -140,10 +140,10 @@ packages:
     description:
       path: "."
       ref: HEAD
-      resolved-ref: "751cd4525f325b69c0652513b86170cfce480e40"
+      resolved-ref: "22538ed87b3ad34faeb4c60f0defa10b56235093"
       url: "https://github.com/breez/breez-sdk-liquid-flutter"
     source: git
-    version: "0.7.0-rc1"
+    version: "0.7.0-rc5"
   flutter_rust_bridge:
     dependency: transitive
     description:

diff --git a/snippets/dart_snippets/pubspec.yaml b/snippets/dart_snippets/pubspec.yaml
@@ -10,11 +10,11 @@ dependencies:
   breez_liquid:
     git:
       url: https://github.com/breez/breez-sdk-liquid-dart
-      tag: 0.7.0-rc1
+      tag: 0.7.0-rc4
   flutter_breez_liquid:
     git:
       url: https://github.com/breez/breez-sdk-liquid-flutter
-      tag: 0.7.0-rc1
+      tag: 0.7.0-rc4
   rxdart: ^0.28.0  
 
 dependency_overrides:

diff --git a/snippets/go/go.mod b/snippets/go/go.mod
@@ -2,7 +2,7 @@ module main
 
 go 1.19
 
-require github.com/breez/breez-sdk-liquid-go v0.7.0-rc1
+require github.com/breez/breez-sdk-liquid-go v0.7.0-rc4
 
 // Comment out to use published module
 replace github.com/breez/breez-sdk-liquid-go => ./packages/breez-sdk-liquid-go
diff --git a/snippets/go/list_payments.go b/snippets/go/list_payments.go
@@ -9,10 +9,18 @@ import (
 func GetPayment(sdk *breez_sdk_liquid.BindingLiquidSdk) {
 	// ANCHOR: get-payment
 	paymentHash := "<payment hash>"
-	req := breez_sdk_liquid.GetPaymentRequestLightning{
+	reqByPaymentHash := breez_sdk_liquid.GetPaymentRequestPaymentHash{
 		PaymentHash: paymentHash,
 	}
-	if payment, err := sdk.GetPayment(req); err == nil {
+	if payment, err := sdk.GetPayment(reqByPaymentHash); err == nil {
+		log.Printf("%#v", payment)
+	}
+
+	swapId := "<swap id>"
+	reqBySwapId := breez_sdk_liquid.GetPaymentRequestSwapId{
+		SwapId: swapId,
+	}
+	if payment, err := sdk.GetPayment(reqBySwapId); err == nil {
 		log.Printf("%#v", payment)
 	}
 	// ANCHOR_END: get-payment

diff --git a/snippets/kotlin_mpp_lib/shared/build.gradle.kts b/snippets/kotlin_mpp_lib/shared/build.gradle.kts
@@ -29,7 +29,7 @@ kotlin {
         }
         val commonMain by getting {
             dependencies {
-                implementation("technology.breez.liquid:breez-sdk-liquid-kmp:0.7.0-rc1")
+                implementation("technology.breez.liquid:breez-sdk-liquid-kmp:0.7.0-rc4")
             }
         }
     }

diff --git a/...pets/kotlin_mpp_lib/shared/src/commonMain/kotlin/com/example/kotlinmpplib/ListPayments.kt b/...pets/kotlin_mpp_lib/shared/src/commonMain/kotlin/com/example/kotlinmpplib/ListPayments.kt
@@ -6,7 +6,10 @@ class ListPayments {
         // ANCHOR: get-payment
         try {
             val paymentHash = "<payment hash>";
-            val payment = sdk.getPayment(GetPaymentRequest.Lightning(paymentHash))
+            val paymentByHash = sdk.getPayment(GetPaymentRequest.PaymentHash(paymentHash))
+
+            val swapId = "<swap id>";
+            val paymentBySwapId = sdk.getPayment(GetPaymentRequest.SwapId(swapId))
         } catch (e: Exception) {
             // handle error
         }
@@ -67,4 +70,4 @@ class ListPayments {
         }
         // ANCHOR_END: list-payments-details-destination
     }
-}
+}
diff --git a/snippets/python/src/list_payments.py b/snippets/python/src/list_payments.py
@@ -6,7 +6,10 @@ def get_payment(sdk: BindingLiquidSdk):
     try:
         # ANCHOR: get-payment
         payment_hash = "<payment hash>"
-        sdk.get_payment(GetPaymentRequest.LIGHTNING(payment_hash))
+        sdk.get_payment(GetPaymentRequest.PAYMENT_HASH(payment_hash))
+
+        swap_id = "<swap id>"
+        sdk.get_payment(GetPaymentRequest.SWAP_ID(swap_id))
         # ANCHOR_END: get-payment
     except Exception as error:
         logging.error(error)

diff --git a/snippets/python/src/receive_payment.py b/snippets/python/src/receive_payment.py
@@ -1,5 +1,5 @@
 import logging
-from breez_sdk_liquid import BindingLiquidSdk, PrepareReceiveRequest, PaymentMethod, PrepareReceiveResponse, ReceivePaymentRequest
+from breez_sdk_liquid import BindingLiquidSdk, PrepareReceiveRequest, PaymentMethod, PrepareReceiveResponse, ReceivePaymentRequest, ReceiveAmount
 
 
 def prepare_receive_lightning(sdk: BindingLiquidSdk):

diff --git a/snippets/react-native/list_payments.ts b/snippets/react-native/list_payments.ts
@@ -9,10 +9,16 @@ import {
 const exampleGetPayment = async () => {
   // ANCHOR: get-payment
   const paymentHash = '<payment hash>'
-  const payment = await getPayment({
-    type: GetPaymentRequestVariant.LIGHTNING,
+  const paymentByHash = await getPayment({
+    type: GetPaymentRequestVariant.PAYMENT_HASH,
     paymentHash
   })
+
+  const swapId = '<swap id>'
+  const paymentBySwapId = await getPayment({
+    type: GetPaymentRequestVariant.SWAP_ID,
+    swapId
+  })
   // ANCHOR_END: get-payment
 }
 

diff --git a/snippets/react-native/package.json b/snippets/react-native/package.json
@@ -10,7 +10,7 @@
         "compile": "tsc"
     },
     "dependencies": {
-        "@breeztech/react-native-breez-sdk-liquid": "^0.7.0-rc1",
+        "@breeztech/react-native-breez-sdk-liquid": "^0.7.0-rc4",
         "react": "18.1.0",
         "react-native": "0.70.6"
     },