mirror of https://github.com/aljazceru/breez-sdk-liquid.git synced 2026-01-16 04:24:29 +01:00

Files

Ross Savage 6d72fdce57 WASM: Interface (#757 )

* Define common types

* Define sdk types

* Add SDK methods

* Add LiquidSdkBuilder

* Add callback interfaces

* Update CI for WASM

* Replace async and test macros

* Update sdk-common/macros dependencies

2025-03-11 06:21:46 +01:00

src

WASM: Interface (#757 )

2025-03-11 06:21:46 +01:00

build.rs

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

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

Cargo.toml

WASM: Interface (#757 )

2025-03-11 06:21:46 +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).