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

Files

ok300 8a1508ab07 Rename wallet to SDK or LiquidSdk (#157 )

* Rename global instance in bindings.rs

* Rename wallet to SDK or LiquidSdk

* Rename BindingWallet to BindingLiquidSdk

* Rename wallet to lwk_wollet, signer to lwk_signer

* Rename LsSdkError to LiquidSdkError

* Cargo fmt

* Rename LsSdkError in RN generator

---------

Co-authored-by: Ross Savage <hello@satimoto.com>

2024-05-03 13:53:37 +00:00

src

Rename wallet to SDK or LiquidSdk (#157 )

2024-05-03 13:53:37 +00:00

Cargo.toml

Add suitable crate-types are configured for target devices

2024-05-03 16:05:39 +03:00

README.md

Rename workspace members (subfolders) (#149 )

2024-05-02 18:22:32 +00:00

README.md

breez-liquid-sdk

Prerequisites

Your system must have the sqlite3 development files installed:

# On Debian
sudo apt install libsqlite3-dev

Features

Backup/Restore

The wallet provides the ability to backup and restore ongoing swaps via the corresponding methods:

let mnemonic = "...";
let data_dir = None;
let network = Network::Liquid;
let breez_wallet = Wallet::connect(mnemonic, data_dir, network)?;

breez_wallet.backup()?;  // Backs up the pending swaps under `{data_dir}/backup{-testnet}.sql`. Overwrites previous versions.
let backup_path = None;  // Can also be Some(String), a path pointing to the database. Default is `{data_dir}/backup{-testnet}.sql`
breez_wallet.restore(backup_path)?;   // Restores the specified backup

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