GlcoinCore/jam
1
0
Fork 0
mirror of https://github.com/joinmarket-webui/jam.git synced 2026-08-13 12:33:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: update dev setup readme (#306)

Browse source
This commit is contained in:
Thebora Kompanioni 2022-06-06 11:21:39 +02:00 • committed by GitHub
parent 3b0a772f41
commit 141fb0c2b3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docker/regtest/readme.md
View file

@ -12,12 +12,15 @@ npm run regtest:rebuild
# start the regtest environment
npm run regtest:up
# fund wallets and start maker
./docker/regtest/init-setup.sh
# fund wallets and start maker in secondary container
npm run regtest:init
# mine blocks in regtest periodically
npm run regtest:mine
# start jam in development mode
npm start
[...]
# stop the regtest environment
@ -29,12 +32,15 @@ npm run regtest:clear
## Commands
### Run
### Start
Start the regtest environment with:
```sh
npm run regtest:up
# (optional) fund wallets and start maker in secondary container
npm run regtest:init
```
Once the regtest environment is up and running you can start Jam with:
@ -55,6 +61,14 @@ If you want to start from scratch (removing all volumes):
npm run regtest:clear
```
### Mine
Mine regtest blocks in a fixed interval (current default is every 10 seconds).
This is useful for features that await confirmations or need incoming blocks regularly.
e.g. This is necessary for scheduled transactions to execute successfully.
```sh
npm run regtest:mine
```
## Images
The [Docker setup](dockerfile-deps/joinmarket/latest/Dockerfile) is an adaption of [joinmarket-webui-standalone](https://github.com/joinmarket-webui/joinmarket-webui-docker/tree/master/standalone) with as little adaptations as possible.
@ -95,18 +109,12 @@ docker exec -t jm_regtest_joinmarket git log --oneline -1
Some helper scripts are included to make recurring tasks and interaction with the containers easier.
### `npm run regtest:mine`
Mine regtest blocks in a fixed interval (current default is every 10 seconds).
This is useful for features that await confirmations or need incoming blocks regularly.
e.g. This is necessary for scheduled transactions to execute successfully.
### `init-setup.sh`
This script helps in providing both JoinMarket containers a wallet with spendable coins and starting the Maker Service in the secondary container.
Its main goal is to make CoinJoin transactions possible in the regtest environment.
It should be run immediately after the Docker setup is successfully started so you can start developing right away.
A wallet named `funded.jmdat` with password `test` will be created if it does not exist.
```sh
# fund wallets and start maker service in secondary container
@ -214,5 +222,3 @@ joinmarket_1 | 2009-01-03 00:02:44,907 INFO success: ob-watcher entered RUNNING
- [JoinMarket Server (GitHub)](https://github.com/JoinMarket-Org/joinmarket-clientserver)
- [JoinMarket Server Testing Docs (GitHub)](https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/TESTING.md)
- [BTCPay Server JoinMarket Docker Setup (GitHub)](https://github.com/btcpayserver/dockerfile-deps/tree/master/JoinMarket)
- [BTCPay Server JoinMarket Image (DockerHub)](https://hub.docker.com/r/btcpayserver/joinmarket)