Files
breez-sdk-liquid/lib/core
Ross Savage c141d8e0a4 Change short_channel_id to string (#484)
* Change short_channel_id to string

* Bump sdk-common
2024-09-11 12:54:39 +02:00
..
2024-05-21 12:31:59 +02:00
2024-07-08 15:40:33 +02:00

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).