Files
breez-sdk-liquid/lib/ls-sdk-core/README.md
ok300 522bdaea5c Rename init() to connect() (#119)
* Rename init() to connect()

* Shorten commit ID for secp256k1-zkp dependency

* Update RN bindings

* Rename the manually coded init function to connect

* Update RN example app

---------

Co-authored-by: Ross Savage <hello@satimoto.com>
Co-authored-by: Ross Savage <551697+dangeross@users.noreply.github.com>
2024-04-29 15:25:48 +00:00

1.0 KiB

breez-sdk-liquid

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