From b6a72d980cb7a06335207694e173e8ba2a8c947f Mon Sep 17 00:00:00 2001
From: ok300 <106775972+ok300@users.noreply.github.com>
Date: Wed, 3 Jul 2024 14:56:56 +0200
Subject: [PATCH] Add dart snippets

---
 .github/workflows/main.yml                    |   2 +-
 snippets/dart_snippets/.gitignore             |   7 +
 snippets/dart_snippets/README.md              |   9 +
 snippets/dart_snippets/analysis_options.yaml  |  30 ++
 snippets/dart_snippets/bin/dart_snippets.dart |   6 +
 snippets/dart_snippets/flake.lock             |  61 +++
 snippets/dart_snippets/flake.nix              |  26 +
 .../dart_snippets/lib/fiat_currencies.dart    |  17 +
 .../dart_snippets/lib/getting_started.dart    |  74 +++
 snippets/dart_snippets/lib/list_payments.dart |  36 ++
 snippets/dart_snippets/lib/lnurl_auth.dart    |  21 +
 snippets/dart_snippets/lib/lnurl_pay.dart     |  26 +
 .../dart_snippets/lib/lnurl_withdraw.dart     |  23 +
 snippets/dart_snippets/lib/pay_onchain.dart   |  53 ++
 .../dart_snippets/lib/receive_onchain.dart    |  69 +++
 .../dart_snippets/lib/receive_payment.dart    |  16 +
 snippets/dart_snippets/lib/sdk_instance.dart  |   3 +
 snippets/dart_snippets/lib/send_payment.dart  |  14 +
 snippets/dart_snippets/pubspec.lock           | 504 ++++++++++++++++++
 snippets/dart_snippets/pubspec.yaml           |  15 +
 20 files changed, 1011 insertions(+), 1 deletion(-)
 create mode 100644 snippets/dart_snippets/.gitignore
 create mode 100644 snippets/dart_snippets/README.md
 create mode 100644 snippets/dart_snippets/analysis_options.yaml
 create mode 100644 snippets/dart_snippets/bin/dart_snippets.dart
 create mode 100644 snippets/dart_snippets/flake.lock
 create mode 100644 snippets/dart_snippets/flake.nix
 create mode 100644 snippets/dart_snippets/lib/fiat_currencies.dart
 create mode 100644 snippets/dart_snippets/lib/getting_started.dart
 create mode 100644 snippets/dart_snippets/lib/list_payments.dart
 create mode 100644 snippets/dart_snippets/lib/lnurl_auth.dart
 create mode 100644 snippets/dart_snippets/lib/lnurl_pay.dart
 create mode 100644 snippets/dart_snippets/lib/lnurl_withdraw.dart
 create mode 100644 snippets/dart_snippets/lib/pay_onchain.dart
 create mode 100644 snippets/dart_snippets/lib/receive_onchain.dart
 create mode 100644 snippets/dart_snippets/lib/receive_payment.dart
 create mode 100644 snippets/dart_snippets/lib/sdk_instance.dart
 create mode 100644 snippets/dart_snippets/lib/send_payment.dart
 create mode 100644 snippets/dart_snippets/pubspec.lock
 create mode 100644 snippets/dart_snippets/pubspec.yaml

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index d27f4005..2cfa1ff4 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -111,7 +111,7 @@ jobs:
       - uses: actions/download-artifact@v3
         with:
           name: breez-sdk-flutter-${{ needs.setup.outputs.package-version }}
-          path: snippets/dart_snippets/packages/breez-sdk-flutter
+          path: snippets/dart_snippets/packages/breez-liquid-sdk-flutter
 
       - name: pub-get
         working-directory: snippets/dart_snippets
diff --git a/snippets/dart_snippets/.gitignore b/snippets/dart_snippets/.gitignore
new file mode 100644
index 00000000..bf02cc3b
--- /dev/null
+++ b/snippets/dart_snippets/.gitignore
@@ -0,0 +1,7 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/
+packages/
+.flutter-version
+.flutter-plugins
+.flutter-plugins-dependencies
\ No newline at end of file
diff --git a/snippets/dart_snippets/README.md b/snippets/dart_snippets/README.md
new file mode 100644
index 00000000..26e925ad
--- /dev/null
+++ b/snippets/dart_snippets/README.md
@@ -0,0 +1,9 @@
+## Steps to compile the snippets locally
+1. Build a flutter package
+  - By running the publish-all-platforms CI in the breez-liquid-sdk repository (use dummy binaries)
+  - or by cloning https://github.com/breez/breez-liquid-sdk-flutter
+2. Place the files in the folder `snippets/dart-snippets/packages/breez-liquid-sdk-flutter`
+3. Happy coding
+
+## Nix
+Use the command `nix develop`
\ No newline at end of file
diff --git a/snippets/dart_snippets/analysis_options.yaml b/snippets/dart_snippets/analysis_options.yaml
new file mode 100644
index 00000000..6dd972f3
--- /dev/null
+++ b/snippets/dart_snippets/analysis_options.yaml
@@ -0,0 +1,30 @@
+# This file configures the static analysis results for your project (errors,
+# warnings, and lints).
+#
+# This enables the 'recommended' set of lints from `package:lints`.
+# This set helps identify many issues that may lead to problems when running
+# or consuming Dart code, and enforces writing Dart using a single, idiomatic
+# style and format.
+#
+# If you want a smaller set of lints you can change this to specify
+# 'package:lints/core.yaml'. These are just the most critical lints
+# (the recommended set includes the core lints).
+# The core lints are also what is used by pub.dev for scoring packages.
+
+include: package:lints/recommended.yaml
+
+# Uncomment the following section to specify additional rules.
+
+# linter:
+#   rules:
+#     - camel_case_types
+
+analyzer:
+  exclude:
+    - packages/**
+
+# For more information about the core and recommended set of lints, see
+# https://dart.dev/go/core-lints
+
+# For additional information about configuring this file, see
+# https://dart.dev/guides/language/analysis-options
diff --git a/snippets/dart_snippets/bin/dart_snippets.dart b/snippets/dart_snippets/bin/dart_snippets.dart
new file mode 100644
index 00000000..1aaf2ace
--- /dev/null
+++ b/snippets/dart_snippets/bin/dart_snippets.dart
@@ -0,0 +1,6 @@
+import 'package:flutter_breez_liquid/breez_liquid.dart' as liquid_sdk;
+
+void main() async {
+    // Initialize library
+    await liquid_sdk.initialize();
+}
\ No newline at end of file
diff --git a/snippets/dart_snippets/flake.lock b/snippets/dart_snippets/flake.lock
new file mode 100644
index 00000000..a068d8e3
--- /dev/null
+++ b/snippets/dart_snippets/flake.lock
@@ -0,0 +1,61 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1710146030,
+        "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1719838683,
+        "narHash": "sha256-Zw9rQjHz1ilNIimEXFeVa1ERNRBF8DoXDhLAZq5B4pE=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "d032c1a6dfad4eedec7e35e91986becc699d7d69",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-24.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}
diff --git a/snippets/dart_snippets/flake.nix b/snippets/dart_snippets/flake.nix
new file mode 100644
index 00000000..3a989cd2
--- /dev/null
+++ b/snippets/dart_snippets/flake.nix
@@ -0,0 +1,26 @@
+{
+  description = "Flutter flake";
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-24.05";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+  outputs =
+    { self
+    , nixpkgs
+    , flake-utils
+    ,
+    }:
+    flake-utils.lib.eachDefaultSystem (system:
+    let
+      pkgs = nixpkgs.legacyPackages.${system};
+    in
+    {
+      devShells.default = pkgs.mkShell {
+        buildInputs = with pkgs; [
+          flutter
+        ];
+      };
+
+      formatter = pkgs.nixpkgs-fmt;
+    });
+}
diff --git a/snippets/dart_snippets/lib/fiat_currencies.dart b/snippets/dart_snippets/lib/fiat_currencies.dart
new file mode 100644
index 00000000..445dc87f
--- /dev/null
+++ b/snippets/dart_snippets/lib/fiat_currencies.dart
@@ -0,0 +1,17 @@
+import 'package:flutter_breez_liquid/bridge_generated.dart';
+
+Future<List<FiatCurrency>> listFiatCurrencies() async {
+  // ANCHOR: list-fiat-currencies
+  List<FiatCurrency> fiatCurrencyList = await breezSDK.listFiatCurrencies();
+  // ANCHOR_END: list-fiat-currencies
+  return fiatCurrencyList;
+}
+
+Future<Map<String, Rate>> fetchFiatRates(String lspId) async {
+  // ANCHOR: fetch-fiat-rates
+  Map<String, Rate> fiatRatesMap = await breezSDK.fetchFiatRates();
+  // print your desired rate
+  print(fiatRatesMap["USD"]?.value);
+  // ANCHOR_END: fetch-fiat-rates
+  return fiatRatesMap;
+}
diff --git a/snippets/dart_snippets/lib/getting_started.dart b/snippets/dart_snippets/lib/getting_started.dart
new file mode 100644
index 00000000..1b5eb755
--- /dev/null
+++ b/snippets/dart_snippets/lib/getting_started.dart
@@ -0,0 +1,74 @@
+import 'dart:typed_data';
+
+import 'package:flutter_breez_liquid/breez_liquid.dart';
+import 'package:flutter_breez_liquid/bridge_generated.dart';
+
+Future<void> initializeSDK() async {
+  // ANCHOR: init-sdk
+
+  // It is recommended to use a single instance of BreezSDK across your Dart/Flutter app.
+  //
+  // All of the snippets assume a BreezSDK object is created on entrypoint of the app as such:
+  //
+  // BreezSDK breezSDK = BreezSDK();
+  //
+  // and is accessible throughout the app. There are various approaches on how to achieve this; creating a Singleton class using factory constructor, using state management libraries such as 'provider', 'GetX', 'Riverpod' and 'Redux' to name a few.
+
+  // Initializes SDK events & log streams.
+  //
+  // Call once on your Dart entrypoint file, e.g.; `lib/main.dart`.
+  breezSDK.initialize();
+
+  // Create the default config
+  Uint8List seed = await breezSDK.mnemonicToSeed("<mnemonic words>");
+  String inviteCode = "<invite code>";
+  String apiKey = "<api key>";
+  NodeConfig nodeConfig = NodeConfig.greenlight(
+    config: GreenlightNodeConfig(
+      partnerCredentials: null,
+      inviteCode: inviteCode,
+    ),
+  );
+  Config config = await breezSDK.defaultConfig(
+    envType: EnvironmentType.Production,
+    apiKey: apiKey,
+    nodeConfig: nodeConfig,
+  );
+
+  // Customize the config object according to your needs
+  config = config.copyWith(workingDir: "path to an existing directory");
+
+  // Connect to the Breez SDK make it ready for use
+  ConnectRequest connectRequest = ConnectRequest(config: config, seed: seed);
+  return await breezSDK.connect(req: connectRequest);
+  // ANCHOR_END: init-sdk
+}
+
+Future<void> connectRestoreOnly(Config config, Uint8List seed) async {
+  // ANCHOR: init-sdk-restore-only
+  ConnectRequest connectRequest = ConnectRequest(config: config, seed: seed, restoreOnly: true);
+  return await breezSDK.connect(req: connectRequest);
+  // ANCHOR_END: init-sdk-restore-only
+}
+
+Future<void> fetchBalance(String lspId) async {
+  // ANCHOR: fetch-balance
+  NodeState? nodeInfo = await breezSDK.nodeInfo();
+  if (nodeInfo != null) {
+    int lnBalance = nodeInfo.channelsBalanceMsat;
+    int onchainBalance = nodeInfo.onchainBalanceMsat;
+    print(lnBalance);
+    print(onchainBalance);
+  }
+  // ANCHOR_END: fetch-balance
+}
+
+// ANCHOR: logging
+void onLogEntry(log) {
+  print("Received log ${log.level}]: ${log.line}");
+}
+
+void logging(BreezSDK breezSDK) {
+  breezSDK.logStream.listen(onLogEntry);
+}
+// ANCHOR_END: logging
diff --git a/snippets/dart_snippets/lib/list_payments.dart b/snippets/dart_snippets/lib/list_payments.dart
new file mode 100644
index 00000000..847f3dce
--- /dev/null
+++ b/snippets/dart_snippets/lib/list_payments.dart
@@ -0,0 +1,36 @@
+import 'package:flutter_breez_liquid/breez_liquid.dart';
+import 'package:flutter_breez_liquid/bridge_generated.dart';
+
+Future<List<Payment>> listPayments() async {
+  // ANCHOR: list-payments
+  ListPaymentsRequest req = ListPaymentsRequest();
+  List<Payment> paymentsList = await breezSDK.listPayments(req: req);
+  print(paymentsList);
+  // ANCHOR_END: list-payments
+  return paymentsList;
+}
+
+Future<List<Payment>> listPaymentsFiltered({
+  int? fromTimestamp,
+  int? toTimestamp,
+  bool? includeFailures,
+  int? offset,
+  int? limit,
+}) async {
+  // ANCHOR: list-payments-filtered
+  /// Get the desired epoch timestamp in seconds
+  int fromTimestamp = DateTime.now().subtract(const Duration(minutes: 30)).millisecondsSinceEpoch ~/ 1000;
+
+  ListPaymentsRequest req = ListPaymentsRequest(
+    filters: [PaymentTypeFilter.Sent],
+    fromTimestamp: fromTimestamp,
+    toTimestamp: toTimestamp,
+    includeFailures: includeFailures,
+    offset: offset,
+    limit: limit,
+  );
+  List<Payment> paymentsList = await breezSDK.listPayments(req: req);
+  print(paymentsList);
+  // ANCHOR_END: list-payments-filtered
+  return paymentsList;
+}
diff --git a/snippets/dart_snippets/lib/lnurl_auth.dart b/snippets/dart_snippets/lib/lnurl_auth.dart
new file mode 100644
index 00000000..1372a2ae
--- /dev/null
+++ b/snippets/dart_snippets/lib/lnurl_auth.dart
@@ -0,0 +1,21 @@
+import 'package:flutter_breez_liquid/breez_liquid.dart';
+import 'package:flutter_breez_liquid/bridge_generated.dart';
+
+Future<void> lnurlAuth() async {
+  // ANCHOR: lnurl-auth
+  /// Endpoint can also be of the form:
+  /// keyauth://domain.com/auth?key=val
+  String lnurlAuthUrl =
+      "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttvdankjm3lw3skw0tvdankjm3xdvcn6vtp8q6n2dfsx5mrjwtrxdjnqvtzv56rzcnyv3jrxv3sxqmkyenrvv6kve3exv6nqdtyv43nqcmzvdsnvdrzx33rsenxx5unqc3cxgeqgntfgu";
+
+  InputType inputType = await breezSDK.parseInput(input: lnurlAuthUrl);
+  if (inputType is InputType_LnUrlAuth) {
+    LnUrlCallbackStatus result = await breezSDK.lnurlAuth(reqData: inputType.data);
+    if (result is LnUrlCallbackStatus_Ok) {
+      print("Successfully authenticated");
+    } else {
+      print("Failed to authenticate");
+    }
+  }
+  // ANCHOR_END: lnurl-auth
+}
diff --git a/snippets/dart_snippets/lib/lnurl_pay.dart b/snippets/dart_snippets/lib/lnurl_pay.dart
new file mode 100644
index 00000000..8d4811c5
--- /dev/null
+++ b/snippets/dart_snippets/lib/lnurl_pay.dart
@@ -0,0 +1,26 @@
+import 'package:flutter_breez_liquid/breez_liquid.dart';
+import 'package:flutter_breez_liquid/bridge_generated.dart';
+
+Future<void> lnurlPay() async {
+  // ANCHOR: lnurl-pay
+  /// Endpoint can also be of the form:
+  /// lnurlp://domain.com/lnurl-pay?key=val
+  /// lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttsv9un7um9wdekjmmw84jxywf5x43rvv35xgmr2enrxanr2cfcvsmnwe3jxcukvde48qukgdec89snwde3vfjxvepjxpjnjvtpxd3kvdnxx5crxwpjvyunsephsz36jf
+  String lnurlPayUrl = "lightning@address.com";
+
+  InputType inputType = await breezSDK.parseInput(input: lnurlPayUrl);
+  if (inputType is InputType_LnUrlPay) {
+    int amountMsat = inputType.data.minSendable;
+    String optionalComment = "<comment>";
+    String optionalPaymentLabel = "<label>";
+    LnUrlPayRequest req = LnUrlPayRequest(
+      data: inputType.data,
+      amountMsat: amountMsat,
+      comment: optionalComment,
+      paymentLabel: optionalPaymentLabel,
+    );
+    LnUrlPayResult result = await breezSDK.lnurlPay(req: req);
+    print(result.data);
+  }
+  // ANCHOR_END: lnurl-pay
+}
diff --git a/snippets/dart_snippets/lib/lnurl_withdraw.dart b/snippets/dart_snippets/lib/lnurl_withdraw.dart
new file mode 100644
index 00000000..18cb4aa1
--- /dev/null
+++ b/snippets/dart_snippets/lib/lnurl_withdraw.dart
@@ -0,0 +1,23 @@
+import 'package:flutter_breez_liquid/breez_liquid.dart';
+import 'package:flutter_breez_liquid/bridge_generated.dart';
+
+Future<void> lnurlWithdraw() async {
+  // ANCHOR: lnurl-withdraw
+  /// Endpoint can also be of the form:
+  /// lnurlw://domain.com/lnurl-withdraw?key=val
+  String lnurlWithdrawUrl =
+      "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4exctthd96xserjv9mn7um9wdekjmmw843xxwpexdnxzen9vgunsvfexq6rvdecx93rgdmyxcuxverrvcursenpxvukzv3c8qunsdecx33nzwpnvg6ryc3hv93nzvecxgcxgwp3h33lxk";
+
+  InputType inputType = await breezSDK.parseInput(input: lnurlWithdrawUrl);
+  if (inputType is InputType_LnUrlWithdraw) {
+    int amountMsat = inputType.data.minWithdrawable;
+    LnUrlWithdrawRequest req = LnUrlWithdrawRequest(
+      data: inputType.data,
+      amountMsat: amountMsat,
+      description: "<description>",
+    );
+    LnUrlWithdrawResult result = await breezSDK.lnurlWithdraw(req: req);
+    print(result.data);
+  }
+  // ANCHOR_END: lnurl-withdraw
+}
diff --git a/snippets/dart_snippets/lib/pay_onchain.dart b/snippets/dart_snippets/lib/pay_onchain.dart
new file mode 100644
index 00000000..309fb2be
--- /dev/null
+++ b/snippets/dart_snippets/lib/pay_onchain.dart
@@ -0,0 +1,53 @@
+import 'package:flutter_breez_liquid/breez_liquid.dart';
+import 'package:flutter_breez_liquid/bridge_generated.dart';
+
+Future<OnchainPaymentLimitsResponse> getCurrentLimits() async {
+  // ANCHOR: get-current-pay-onchain-limits
+  OnchainPaymentLimitsResponse currentLimits = await breezSDK.onchainPaymentLimits();
+  print("Minimum amount, in sats: ${currentLimits.minSat}");
+  print("Maximum amount, in sats: ${currentLimits.maxSat}");
+  // ANCHOR_END: get-current-pay-onchain-limits
+  return currentLimits;
+}
+
+Future<PrepareOnchainPaymentResponse> preparePayOnchain({
+  required int amountSat,
+  required int satPerVbyte,
+}) async {
+  // ANCHOR: prepare-pay-onchain
+  PrepareOnchainPaymentRequest req = PrepareOnchainPaymentRequest(
+    amountSat: amountSat,
+    amountType: SwapAmountType.Send,
+    claimTxFeerate: satPerVbyte,
+  );
+  PrepareOnchainPaymentResponse prepareRes = await breezSDK.prepareOnchainPayment(req: req);
+  print("Sender amount: ${prepareRes.senderAmountSat} sats");
+  print("Recipient amount: ${prepareRes.recipientAmountSat} sats");
+  print("Total fees: ${prepareRes.totalFees} sats");
+  // ANCHOR_END: prepare-pay-onchain
+  return prepareRes;
+}
+
+Future<PayOnchainResponse> startReverseSwap({
+  required String onchainRecipientAddress,
+  required PrepareOnchainPaymentResponse prepareRes,
+}) async {
+  // ANCHOR: start-reverse-swap
+  PayOnchainRequest req = PayOnchainRequest(
+    recipientAddress: onchainRecipientAddress,
+    prepareRes: prepareRes,
+  );
+  PayOnchainResponse res = await breezSDK.payOnchain(req: req);
+  // ANCHOR_END: start-reverse-swap
+  return res;
+}
+
+Future<List<ReverseSwapInfo>> checkReverseSwapStatus() async {
+  // ANCHOR: check-reverse-swaps-status
+  List<ReverseSwapInfo> inProgOnchainPaymentList = await breezSDK.inProgressOnchainPayments();
+  for (var inProgOnchainPayment in inProgOnchainPaymentList) {
+    print("Onchain payment ${inProgOnchainPayment.id} in progress, status is ${inProgOnchainPayment.status.name}");
+  }
+  // ANCHOR_END: check-reverse-swaps-status
+  return inProgOnchainPaymentList;
+}
diff --git a/snippets/dart_snippets/lib/receive_onchain.dart b/snippets/dart_snippets/lib/receive_onchain.dart
new file mode 100644
index 00000000..6f8d7d4a
--- /dev/null
+++ b/snippets/dart_snippets/lib/receive_onchain.dart
@@ -0,0 +1,69 @@
+import 'package:flutter_breez_liquid/breez_liquid.dart';
+import 'package:flutter_breez_liquid/bridge_generated.dart';
+
+Future<SwapInfo> generateReceiveOnchainAddress() async {
+  // ANCHOR: generate-receive-onchain-address
+  ReceiveOnchainRequest req = const ReceiveOnchainRequest();
+  SwapInfo swapInfo = await breezSDK.receiveOnchain(req: req);
+
+  // Send your funds to the below bitcoin address
+  String address = swapInfo.bitcoinAddress;
+  print(address);
+  print("Minimum amount allowed to deposit in sats: ${swapInfo.minAllowedDeposit}");
+  print("Maximum amount allowed to deposit in sats: ${swapInfo.maxAllowedDeposit}");
+  return swapInfo;
+  // ANCHOR_END: generate-receive-onchain-address
+}
+
+Future<SwapInfo?> getInProgressSwap() async {
+  // ANCHOR: in-progress-swap
+  SwapInfo? swapInfo = await breezSDK.inProgressSwap();
+  print(swapInfo);
+  // ANCHOR_END: in-progress-swap
+  return swapInfo;
+}
+
+Future<List<SwapInfo>> listRefundables() async {
+  // ANCHOR: list-refundables
+  List<SwapInfo> refundables = await breezSDK.listRefundables();
+  for (var refundable in refundables) {
+    print(refundable.bitcoinAddress);
+  }
+  // ANCHOR_END: list-refundables
+  return refundables;
+}
+
+Future<RefundResponse> executeRefund({
+  required String swapAddress,
+  required String toAddress,
+  required int satPerVbyte,
+}) async {
+  // ANCHOR: execute-refund
+  RefundRequest req = RefundRequest(
+    swapAddress: swapAddress,
+    toAddress: toAddress,
+    satPerVbyte: satPerVbyte,
+  );
+  RefundResponse resp = await breezSDK.refund(req: req);
+  print(resp.refundTxId);
+  // ANCHOR_END: execute-refund
+  return resp;
+}
+
+Future<OpenChannelFeeResponse> getChannelOpeningFees({
+  required int amountMsat,
+  int? expiry,
+}) async {
+  // ANCHOR: get-channel-opening-fees
+  OpenChannelFeeRequest req = OpenChannelFeeRequest(amountMsat: amountMsat, expiry: expiry);
+  OpenChannelFeeResponse resp = await breezSDK.openChannelFee(req: req);
+  print(resp.feeMsat);
+  // ANCHOR_END: get-channel-opening-fees
+  return resp;
+}
+
+Future rescanSwaps() async {
+  // ANCHOR: rescan-swaps
+  await breezSDK.rescanSwaps();  
+  // ANCHOR_END: rescan-swaps  
+}
diff --git a/snippets/dart_snippets/lib/receive_payment.dart b/snippets/dart_snippets/lib/receive_payment.dart
new file mode 100644
index 00000000..9f833602
--- /dev/null
+++ b/snippets/dart_snippets/lib/receive_payment.dart
@@ -0,0 +1,16 @@
+import 'package:flutter_breez_liquid/breez_liquid.dart';
+import 'package:flutter_breez_liquid/bridge_generated.dart';
+
+Future<ReceivePaymentResponse> receivePayment() async {
+  // ANCHOR: receive-payment
+  ReceivePaymentRequest req = const ReceivePaymentRequest(
+    amountMsat: 3000000,
+    description: "Invoice for 3000 sats",
+  );
+  ReceivePaymentResponse receivePaymentResponse = await breezSDK.receivePayment(req: req);
+
+  print(receivePaymentResponse.lnInvoice);
+  // ANCHOR_END: receive-payment
+
+  return receivePaymentResponse;
+}
diff --git a/snippets/dart_snippets/lib/sdk_instance.dart b/snippets/dart_snippets/lib/sdk_instance.dart
new file mode 100644
index 00000000..9583fbfe
--- /dev/null
+++ b/snippets/dart_snippets/lib/sdk_instance.dart
@@ -0,0 +1,3 @@
+import 'package:flutter_breez_liquid/breez_liquid.dart';
+
+BreezSDK breezSDK = BreezSDK();
diff --git a/snippets/dart_snippets/lib/send_payment.dart b/snippets/dart_snippets/lib/send_payment.dart
new file mode 100644
index 00000000..95ed55fb
--- /dev/null
+++ b/snippets/dart_snippets/lib/send_payment.dart
@@ -0,0 +1,14 @@
+import 'package:flutter_breez_liquid/breez_liquid.dart';
+import 'package:flutter_breez_liquid/bridge_generated.dart';
+
+Future<SendPaymentResponse> sendPayment({required String bolt11}) async {
+  // ANCHOR: send-payment
+  // The `amountMsat` param is optional and should only passed if the bolt11 doesn't specify an amount.
+  // The amountMsat is required in case an amount is not specified in the bolt11 invoice'.
+  int optionalAmountMsat = 3000000;
+  String optionalLabel = "<label>";
+  SendPaymentRequest req = SendPaymentRequest(bolt11: bolt11, amountMsat: optionalAmountMsat, label: optionalLabel);
+  SendPaymentResponse resp = await breezSDK.sendPayment(req: req);
+  // ANCHOR_END: send-payment
+  return resp;
+}
diff --git a/snippets/dart_snippets/pubspec.lock b/snippets/dart_snippets/pubspec.lock
new file mode 100644
index 00000000..fbbcd5cb
--- /dev/null
+++ b/snippets/dart_snippets/pubspec.lock
@@ -0,0 +1,504 @@
+# Generated by pub
+# See https://dart.dev/tools/pub/glossary#lockfile
+packages:
+  _fe_analyzer_shared:
+    dependency: transitive
+    description:
+      name: _fe_analyzer_shared
+      sha256: "0b2f2bd91ba804e53a61d757b986f89f1f9eaed5b11e4b2f5a2468d86d6c9fc7"
+      url: "https://pub.dev"
+    source: hosted
+    version: "67.0.0"
+  analyzer:
+    dependency: transitive
+    description:
+      name: analyzer
+      sha256: "37577842a27e4338429a1cbc32679d508836510b056f1eedf0c8d20e39c1383d"
+      url: "https://pub.dev"
+    source: hosted
+    version: "6.4.1"
+  args:
+    dependency: transitive
+    description:
+      name: args
+      sha256: "7cf60b9f0cc88203c5a190b4cd62a99feea42759a7fa695010eb5de1c0b2252a"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.5.0"
+  async:
+    dependency: transitive
+    description:
+      name: async
+      sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.11.0"
+  boolean_selector:
+    dependency: transitive
+    description:
+      name: boolean_selector
+      sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.1"
+  breez_liquid:
+    dependency: transitive
+    description:
+      path: "."
+      ref: HEAD
+      resolved-ref: "9e8ba1370e9ae4e7f81900d97a93770ba96dcb93"
+      url: "https://github.com/breez/breez-liquid-sdk-dart"
+    source: git
+    version: "0.0.1-dev9"
+  build_cli_annotations:
+    dependency: transitive
+    description:
+      name: build_cli_annotations
+      sha256: b59d2769769efd6c9ff6d4c4cede0be115a566afc591705c2040b707534b1172
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.0"
+  characters:
+    dependency: transitive
+    description:
+      name: characters
+      sha256: "04a925763edad70e8443c99234dc3328f442e811f1d8fd1a72f1c8ad0f69a605"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.3.0"
+  cli_util:
+    dependency: transitive
+    description:
+      name: cli_util
+      sha256: c05b7406fdabc7a49a3929d4af76bcaccbbffcbcdcf185b082e1ae07da323d19
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.4.1"
+  collection:
+    dependency: transitive
+    description:
+      name: collection
+      sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.18.0"
+  convert:
+    dependency: transitive
+    description:
+      name: convert
+      sha256: "0f08b14755d163f6e2134cb58222dd25ea2a2ee8a195e53983d57c075324d592"
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.1.1"
+  coverage:
+    dependency: transitive
+    description:
+      name: coverage
+      sha256: "3945034e86ea203af7a056d98e98e42a5518fff200d6e8e6647e1886b07e936e"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.8.0"
+  crypto:
+    dependency: transitive
+    description:
+      name: crypto
+      sha256: ff625774173754681d66daaf4a448684fb04b78f902da9cb3d308c19cc5e8bab
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.0.3"
+  ffi:
+    dependency: transitive
+    description:
+      name: ffi
+      sha256: "493f37e7df1804778ff3a53bd691d8692ddf69702cf4c1c1096a2e41b4779e21"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.2"
+  ffigen:
+    dependency: transitive
+    description:
+      name: ffigen
+      sha256: dead012f29db2be71ea152458f5eab600de98fbc244e01088ae6bf2616bceca7
+      url: "https://pub.dev"
+    source: hosted
+    version: "11.0.0"
+  file:
+    dependency: transitive
+    description:
+      name: file
+      sha256: "5fc22d7c25582e38ad9a8515372cd9a93834027aacf1801cf01164dac0ffa08c"
+      url: "https://pub.dev"
+    source: hosted
+    version: "7.0.0"
+  flutter:
+    dependency: transitive
+    description: flutter
+    source: sdk
+    version: "0.0.0"
+  flutter_breez_liquid:
+    dependency: "direct main"
+    description:
+      path: "packages/breez-liquid-sdk-flutter"
+      relative: true
+    source: path
+    version: "0.0.1-dev9"
+  flutter_rust_bridge:
+    dependency: transitive
+    description:
+      name: flutter_rust_bridge
+      sha256: f703c4b50e253e53efc604d50281bbaefe82d615856f8ae1e7625518ae252e98
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.0"
+  freezed_annotation:
+    dependency: transitive
+    description:
+      name: freezed_annotation
+      sha256: c3fd9336eb55a38cc1bbd79ab17573113a8deccd0ecbbf926cca3c62803b5c2d
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.4.1"
+  frontend_server_client:
+    dependency: transitive
+    description:
+      name: frontend_server_client
+      sha256: f64a0333a82f30b0cca061bc3d143813a486dc086b574bfb233b7c1372427694
+      url: "https://pub.dev"
+    source: hosted
+    version: "4.0.0"
+  glob:
+    dependency: transitive
+    description:
+      name: glob
+      sha256: "0e7014b3b7d4dac1ca4d6114f82bf1782ee86745b9b42a92c9289c23d8a0ab63"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.2"
+  http_multi_server:
+    dependency: transitive
+    description:
+      name: http_multi_server
+      sha256: "97486f20f9c2f7be8f514851703d0119c3596d14ea63227af6f7a481ef2b2f8b"
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.2.1"
+  http_parser:
+    dependency: transitive
+    description:
+      name: http_parser
+      sha256: "2aa08ce0341cc9b354a498388e30986515406668dbcc4f7c950c3e715496693b"
+      url: "https://pub.dev"
+    source: hosted
+    version: "4.0.2"
+  io:
+    dependency: transitive
+    description:
+      name: io
+      sha256: "2ec25704aba361659e10e3e5f5d672068d332fc8ac516421d483a11e5cbd061e"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.0.4"
+  js:
+    dependency: transitive
+    description:
+      name: js
+      sha256: f2c445dce49627136094980615a031419f7f3eb393237e4ecd97ac15dea343f3
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.6.7"
+  json_annotation:
+    dependency: transitive
+    description:
+      name: json_annotation
+      sha256: "1ce844379ca14835a50d2f019a3099f419082cfdd231cd86a142af94dd5c6bb1"
+      url: "https://pub.dev"
+    source: hosted
+    version: "4.9.0"
+  lints:
+    dependency: "direct dev"
+    description:
+      name: lints
+      sha256: cbf8d4b858bb0134ef3ef87841abdf8d63bfc255c266b7bf6b39daa1085c4290
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.0.0"
+  logging:
+    dependency: transitive
+    description:
+      name: logging
+      sha256: "623a88c9594aa774443aa3eb2d41807a48486b5613e67599fb4c41c0ad47c340"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.2.0"
+  matcher:
+    dependency: transitive
+    description:
+      name: matcher
+      sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.12.16+1"
+  material_color_utilities:
+    dependency: transitive
+    description:
+      name: material_color_utilities
+      sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.8.0"
+  meta:
+    dependency: transitive
+    description:
+      name: meta
+      sha256: "7687075e408b093f36e6bbf6c91878cc0d4cd10f409506f7bc996f68220b9136"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.12.0"
+  mime:
+    dependency: transitive
+    description:
+      name: mime
+      sha256: "2e123074287cc9fd6c09de8336dae606d1ddb88d9ac47358826db698c176a1f2"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.0.5"
+  node_preamble:
+    dependency: transitive
+    description:
+      name: node_preamble
+      sha256: "6e7eac89047ab8a8d26cf16127b5ed26de65209847630400f9aefd7cd5c730db"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.2"
+  package_config:
+    dependency: transitive
+    description:
+      name: package_config
+      sha256: "1c5b77ccc91e4823a5af61ee74e6b972db1ef98c2ff5a18d3161c982a55448bd"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.0"
+  path:
+    dependency: transitive
+    description:
+      name: path
+      sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.9.0"
+  pool:
+    dependency: transitive
+    description:
+      name: pool
+      sha256: "20fe868b6314b322ea036ba325e6fc0711a22948856475e2c2b6306e8ab39c2a"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.5.1"
+  pub_semver:
+    dependency: transitive
+    description:
+      name: pub_semver
+      sha256: "40d3ab1bbd474c4c2328c91e3a7df8c6dd629b79ece4c4bd04bee496a224fb0c"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.4"
+  quiver:
+    dependency: transitive
+    description:
+      name: quiver
+      sha256: b1c1ac5ce6688d77f65f3375a9abb9319b3cb32486bdc7a1e0fdf004d7ba4e47
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.2.1"
+  shelf:
+    dependency: transitive
+    description:
+      name: shelf
+      sha256: ad29c505aee705f41a4d8963641f91ac4cee3c8fad5947e033390a7bd8180fa4
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.4.1"
+  shelf_packages_handler:
+    dependency: transitive
+    description:
+      name: shelf_packages_handler
+      sha256: "89f967eca29607c933ba9571d838be31d67f53f6e4ee15147d5dc2934fee1b1e"
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.0.2"
+  shelf_static:
+    dependency: transitive
+    description:
+      name: shelf_static
+      sha256: a41d3f53c4adf0f57480578c1d61d90342cd617de7fc8077b1304643c2d85c1e
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.1.2"
+  shelf_web_socket:
+    dependency: transitive
+    description:
+      name: shelf_web_socket
+      sha256: "9ca081be41c60190ebcb4766b2486a7d50261db7bd0f5d9615f2d653637a84c1"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.0.4"
+  sky_engine:
+    dependency: transitive
+    description: flutter
+    source: sdk
+    version: "0.0.99"
+  source_map_stack_trace:
+    dependency: transitive
+    description:
+      name: source_map_stack_trace
+      sha256: "84cf769ad83aa6bb61e0aa5a18e53aea683395f196a6f39c4c881fb90ed4f7ae"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.1"
+  source_maps:
+    dependency: transitive
+    description:
+      name: source_maps
+      sha256: "708b3f6b97248e5781f493b765c3337db11c5d2c81c3094f10904bfa8004c703"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.10.12"
+  source_span:
+    dependency: transitive
+    description:
+      name: source_span
+      sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.10.0"
+  stack_trace:
+    dependency: transitive
+    description:
+      name: stack_trace
+      sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.11.1"
+  stream_channel:
+    dependency: transitive
+    description:
+      name: stream_channel
+      sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.2"
+  string_scanner:
+    dependency: transitive
+    description:
+      name: string_scanner
+      sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.2.0"
+  term_glyph:
+    dependency: transitive
+    description:
+      name: term_glyph
+      sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.2.1"
+  test:
+    dependency: "direct dev"
+    description:
+      name: test
+      sha256: "7ee446762c2c50b3bd4ea96fe13ffac69919352bd3b4b17bac3f3465edc58073"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.25.2"
+  test_api:
+    dependency: transitive
+    description:
+      name: test_api
+      sha256: "9955ae474176f7ac8ee4e989dadfb411a58c30415bcfb648fa04b2b8a03afa7f"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.7.0"
+  test_core:
+    dependency: transitive
+    description:
+      name: test_core
+      sha256: "2bc4b4ecddd75309300d8096f781c0e3280ca1ef85beda558d33fcbedc2eead4"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.6.0"
+  typed_data:
+    dependency: transitive
+    description:
+      name: typed_data
+      sha256: facc8d6582f16042dd49f2463ff1bd6e2c9ef9f3d5da3d9b087e244a7b564b3c
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.3.2"
+  vector_math:
+    dependency: transitive
+    description:
+      name: vector_math
+      sha256: "80b3257d1492ce4d091729e3a67a60407d227c27241d6927be0130c98e741803"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.4"
+  vm_service:
+    dependency: transitive
+    description:
+      name: vm_service
+      sha256: "7475cb4dd713d57b6f7464c0e13f06da0d535d8b2067e188962a59bac2cf280b"
+      url: "https://pub.dev"
+    source: hosted
+    version: "14.2.2"
+  watcher:
+    dependency: transitive
+    description:
+      name: watcher
+      sha256: "3d2ad6751b3c16cf07c7fca317a1413b3f26530319181b37e3b9039b84fc01d8"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.1.0"
+  web:
+    dependency: transitive
+    description:
+      name: web
+      sha256: "97da13628db363c635202ad97068d47c5b8aa555808e7a9411963c533b449b27"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.5.1"
+  web_socket_channel:
+    dependency: transitive
+    description:
+      name: web_socket_channel
+      sha256: "58c6666b342a38816b2e7e50ed0f1e261959630becd4c879c4f26bfa14aa5a42"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.4.5"
+  webkit_inspection_protocol:
+    dependency: transitive
+    description:
+      name: webkit_inspection_protocol
+      sha256: "87d3f2333bb240704cd3f1c6b5b7acd8a10e7f0bc28c28dcf14e782014f4a572"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.2.1"
+  yaml:
+    dependency: transitive
+    description:
+      name: yaml
+      sha256: "75769501ea3489fca56601ff33454fe45507ea3bfb014161abc3b43ae25989d5"
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.1.2"
+  yaml_edit:
+    dependency: transitive
+    description:
+      name: yaml_edit
+      sha256: e9c1a3543d2da0db3e90270dbb1e4eebc985ee5e3ffe468d83224472b2194a5f
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.2.1"
+sdks:
+  dart: ">=3.4.0 <4.0.0"
+  flutter: ">=3.10.0"
diff --git a/snippets/dart_snippets/pubspec.yaml b/snippets/dart_snippets/pubspec.yaml
new file mode 100644
index 00000000..06103635
--- /dev/null
+++ b/snippets/dart_snippets/pubspec.yaml
@@ -0,0 +1,15 @@
+name: dart_snippets
+description: A sample command-line application.
+version: 1.0.0
+publish_to: 'none'
+
+environment:
+  sdk: '>=3.0.0 <4.0.0'
+
+dependencies:
+  flutter_breez_liquid:
+    path: ./packages/breez-liquid-sdk-flutter
+
+dev_dependencies:
+  lints: ^3.0.0
+  test: ^1.24.9