Skip to content

Latest commit

 

History

History

cli

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
.gitignore
.gitignore
 
 
Cargo.lock
Cargo.lock
 
 
Cargo.toml
Cargo.toml
 
 
README.md
README.md
 
 

README.md

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