mirror of
https://github.com/aljazceru/breez-sdk-liquid.git
synced 2026-01-16 20:44:27 +01:00
5b69c7beb2
* Add BOLT12 receive payment handling * Handle BOLT12 invoice requests via WS * Fix invoice request subscription on stream initialisation * Store the BOLT12 offer used to receive a payment * Address review feedback * Separate into create BOLT12 invoice fn * Update all BOLT12 offers when webhook URL changes * Deprecate Lightning for Bolt11Invoice
Regtest environment for Breez SDK - Nodeless (Liquid Implementation)
Based on Boltz Regtest (included as a submodule in ./boltz)
Prerequisites
- Git submodules
git submodule update --init
- Docker or Orbstack for Apple Silicon based Macs.
When using OrbStack on macOS, set
export DOCKER_DEFAULT_PLATFORM=linux/amd64before starting.
Usage
Starting and stopping the regtest setup. On start up, look out for unhealthy containers, which may happen occasionally.
./start.sh
./stop.sh
To control the regtest nodes, some useful aliases are provided.
source boltz/aliases.sh
After setting up the aliases, you can access the following commands:
# Mine blocks on both Bitcoin and Elements chains
mine-block
# Interact with bitcoind
bitcoin-cli-sim-client getblockchaininfo
# Interact with elements
elements-cli-sim-client getblockchaininfo
# Interact with Lightning nodes
lightning-cli-sim 1 getinfo
lncli-sim 1 getinfo
Useful commands for trying out the SDK:
# Get a bolt11 invoice
lncli-sim 1 addinvoice <amount_sat>
# Pay a bolt11 invoice
lncli-sim 1 payinvoice --force <invoice>
# Get a Bitcoin address
bitcoin-cli-sim-client getnewaddress
# Send bitcoin to a Bitcoin address
bitcoin-cli-sim-client sendtoaddress <address> <amount_btc>
# Get a Liquid address
elements-cli-sim-client getnewaddress
# Send L-BTC to a Liquid address
elements-cli-sim-client sendtoaddress <address> <amount_lbtc>
See Boltz Regtest README for more info.