mirror of
https://github.com/aljazceru/breez-sdk-liquid.git
synced 2026-01-17 04:54:20 +01:00
6782e8beef
* feat(rt-sync): add persistency layer (#555) * feat(rt-sync): add pull and merge (#556) * feat(rt-sync): add push logic and run method (#568) * feat(rt-sync): integrate rt-sync with the sdk fix: add formatting command to build feat: add secondary trigger to sync deps: add tonic tls-webpki-roots feat: prevent double claiming on status stream handlers fix: add tx commit to chain swap update (#588) fix: ensure we pull records before prepare_send fix: fmt and tests * fix: set initial pulled state to `Recoverable` * feat(rt-sync): add `last_derivation_index` to sync service * Single chain source * Handle Recoverable state * fix(rt-sync): chain recovery integration (#590) Co-authored-by: yse <hydra_yse@proton.me> * feat(rt-sync): add `pair_fees_json` * fix(rt-sync): clean already persisted incoming records * feat: cache wallet info (#591) * log: add status-stream logging for non-local swaps * Sync improvements (#598) * Full sync on new Bitcoin block * Track the last unconfirmed refund tx * Trigger synced event on partial sync * fix: remove `REPLACE` clause from swap insert/update * fix(rt-sync): update chain swap payer/receiver amount (#604) * Fix syncing last derivation index * fix: update bindings and lockfile * remove logs * fix(rt-sync): avoid reuse of derivation index update logic (#608) * Add 5 index buffer to full scan * Fix storing claim_address (#609) * Filter incoming MRH txs by swap timestamp * fix liquid panding timestamp * persist tx data timestamp * Update unconfirmed transactions * feat: add API key (#618) * Use configured lazy connect channel in sync service * fix: set lower-case header (#624) * fix error message * Store & Sync LNURL info (#617) * Persist and decrypt LNURL info * Update Notification Plugin * Sync payment details * Update list payments to include chain swaps with only user lockup (#620) * Update payments query to include chain swaps without txs * Allow emitting a payment event without tx_id * fix: bindings --------- Co-authored-by: Ross Savage <hello@satimoto.com> Co-authored-by: Ross Savage <551697+dangeross@users.noreply.github.com> Co-authored-by: Roei Erez <roeierez@gmail.com>
Breez SDK - Liquid CLI
A simple cli tool that sends commands to the sdk. It is intended to demonstrate the usage and investigate issues that are hard to debug on mobile platforms.
Run
Start the CLI with
cargo run
To set a specific network, use one of
cargo run -- --network mainnet
cargo run -- --network testnet
To specify a custom data directory, use
cargo run -- --data-dir temp-dir
Using testnet
You'll need a Testnet LN node to test the sending and receiving operations. A simple solution is using Alby's testnet nodes. Read more about Alby's test setup here.
Commands
To get a full list of commands run -h or <command> -h to get more information about a command.
- send-payment - Send a payment directly or via a swap
- fetch-lightning-limits - Fetch the current limits for Send and Receive payments
- fetch-onchain-limits - Fetch the current limits for Onchain Send and Receive payments
- send-onchain-payment - Send to a Bitcoin onchain address via a swap
- receive-payment - Receive a payment directly or via a swap
- buy-bitcoin - Generates an URL to buy bitcoin from a 3rd party provider
- list-payments - List incoming and outgoing payments
- get-payment - Retrieve a payment
- list-refundables - List refundable chain swaps
- prepare-refund - Prepare a refund transaction for an incomplete swap
- refund - Broadcast a refund transaction for an incomplete swap
- rescan-onchain-swaps - Rescan onchain swaps
- get-info - Get the balance and general info of the current instance
- sign-message - Sign a message using the wallet private key
- check-message - Verify a message with a public key
- sync - Sync local data with mempool and onchain data
- recommended-fees - Get the recommended Bitcoin fees based on the configured mempool.space instance
- empty-cache - Empties the encrypted transaction cache
- backup - Backs up the current pending swaps
- restore - Retrieve a list of backups
- disconnect - Shuts down all background threads of this SDK instance
- parse - Parse a generic string to get its type and relevant metadata
- lnurl-pay - Pay using LNURL
- lnurl-withdraw - Withdraw using LNURL
- lnurl-auth - Auth using LNURL
- register-webhook - Register a webhook URL
- unregister-webhook - Unregister the webhook URL
- list-fiat - List fiat currencies
- fetch-fiat-rates - Fetch available fiat rates