diff --git a/regtest/README.md b/regtest/README.md index 99a7d9f..5e749c0 100644 --- a/regtest/README.md +++ b/regtest/README.md @@ -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. \ No newline at end of file +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 + +# Pay a bolt11 invoice +lncli-sim 1 payinvoice --force + +# Get a Bitcoin address +bitcoin-cli-sim-client getnewaddress + +# Send bitcoin to a Bitcoin address +bitcoin-cli-sim-client sendtoaddress
+ +# Get a Liquid address +elements-cli-sim-client getnewaddress + +# Send L-BTC to a Liquid address +elements-cli-sim-client sendtoaddress
+``` + +See [Boltz Regtest README](https://github.com/BoltzExchange/regtest/blob/master/README.md) for more info.