mirror of https://github.com/aljazceru/breez-sdk-liquid.git synced 2026-01-17 21:14:22 +01:00

Files

Erdem Yerebasmaz ded8ef16b8 Extract description from metadata_str for LNURL payments (#740 )

* Extract description from LnUrlPayRequestData's metadata on lnurl_pay

* Persist description from lnurlp metadata on payment details description

* Use invoice description if it's available then fallback to description from metadata

for LNURLp payments

2025-02-18 17:25:34 +03:00

src

Extract description from metadata_str for LNURL payments (#740 )

2025-02-18 17:25:34 +03:00

build.rs

fix: remove auto-formatting command from build (#655 )

2025-01-15 11:02:35 +01:00

Cargo.toml

feat: add client_id to rt-sync notifications (#747 )

2025-02-17 16:31:31 +01:00

README.md

Update core README (#370 )

2024-07-08 15:40:33 +02:00

README.md

Breez Liquid SDK

To get started with the Breez Liquid SDK, follow these examples.

Getting Started

let mnemonic = Mnemonic::generate_in(Language::English, 12)?;

// Create the default config
let mut config = LiquidSdk::default_config(LiquidNetwork::Mainnet);

// Customize the config object according to your needs
config.working_dir = "path to an existing directory".into();

let connect_request = ConnectRequest {
    mnemonic: mnemonic.to_string(),
    config,
};
let sdk = LiquidSdk::connect(connect_request).await?;

Tests

In order to run tests, you can execute cargo test -- --nocapture --test-threads 1. This is due to the fact that currently tests require some degree of interaction (e.g. adding the funding invoice) in order to work, and thus should be run with a single thread (sequentially).