aljaz/breez-sdk-liquid
1
0
Fork 0
mirror of https://github.com/aljazceru/breez-sdk-liquid.git synced 2026-01-16 20:44:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

regtest: improve README.md (#811)

Browse Source
This commit is contained in:
Daniel Granhão
2025-03-26 00:30:41 +00:00
committed by GitHub
parent c798fd882f
commit b6af36780c
1 changed files with 53 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
regtest/README.md
View File

@@ -2,16 +2,17 @@
Based on [Boltz Regtest](https://github.com/BoltzExchange/regtest) (included as a submodule in `./boltz`)
## Setup
## Prerequisites
To use the regtest environment, git submodules have to be initialized.
```bash
git submodule update --init
```
* Git submodules
* `git submodule update --init`
* [Docker](https://docs.docker.com/engine/install/) or [Orbstack](https://orbstack.dev/) for Apple Silicon based Macs.
When using OrbStack on macOS, set `export DOCKER_DEFAULT_PLATFORM=linux/amd64` before starting.
## Usage
Starting and stopping the regtest setup. On start up, look out for unhealthy containers, which may happen occasionally.
```bash
./start.sh
```
@@ -20,4 +21,49 @@ git submodule update --init
./stop.sh
```
See [Boltz Regtest README](https://github.com/BoltzExchange/regtest/blob/master/README.md) for more info.
To control the regtest nodes, some useful aliases are provided.
```bash
source boltz/aliases.sh
```
After setting up the aliases, you can access the following commands:
```bash
# 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:
```bash
# 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](https://github.com/BoltzExchange/regtest/blob/master/README.md) for more info.