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

Files

Ross Savage 6b78919df8 Add sign_message and check_message (#443 )

* Add sign and check message methods

* Use lightning message_signing module to verify the message signature

* Use hash engine

2024-08-29 08:42:16 +02:00

src

Add sign_message and check_message (#443 )

2024-08-29 08:42:16 +02:00

build.rs

Build android fixes

2024-05-21 12:31:59 +02:00

Cargo.toml

Add sign_message and check_message (#443 )

2024-08-29 08:42:16 +02: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).