diff --git a/Production/nginx.tmpl b/Production/nginx.tmpl index e8ce48e..af5f239 100644 --- a/Production/nginx.tmpl +++ b/Production/nginx.tmpl @@ -39,6 +39,13 @@ proxy_pass http://bitcoin_rtl:3000/rtl/; } {{ end }} + + {{ if (eq $serviceName "joinmarket") }} + location /obwatch/ { + proxy_pass http://joinmarket:62601/; + } + {{ end }} + {{ if (eq $serviceName "bitcoin_thub") }} location /thub { proxy_pass http://bitcoin_thub:3000/thub; diff --git a/docker-compose-generator/docker-fragments/opt-add-joinmarket.yml b/docker-compose-generator/docker-fragments/opt-add-joinmarket.yml index df46fbf..c7b9080 100644 --- a/docker-compose-generator/docker-fragments/opt-add-joinmarket.yml +++ b/docker-compose-generator/docker-fragments/opt-add-joinmarket.yml @@ -24,6 +24,8 @@ services: - "joinmarket_datadir:/root/.joinmarket" - "nbxplorer_datadir:/root/.nbxplorer" - "tor_datadir:/home/tor/.tor" + expose: + - 62601 links: - bitcoind diff --git a/docs/joinmarket.md b/docs/joinmarket.md index 0799b40..2db909c 100644 --- a/docs/joinmarket.md +++ b/docs/joinmarket.md @@ -1,7 +1,5 @@ # Joinmarket support -EXPERIMENTAL JOINMARKET SUPPORT IS SUBJECT TO CHANGE - JoinMarket is software to create a special kind of bitcoin transaction called a CoinJoin transaction. Its aim is to improve the confidentiality and privacy of bitcoin transactions. You will be able to use your bitcoin to help other protect their privacy, while earning a yield for this service. @@ -19,7 +17,7 @@ BTCPAYGEN_ADDITIONAL_FRAGMENTS="$BTCPAYGEN_ADDITIONAL_FRAGMENTS;opt-add-joinmark . btcpay-setup.sh -i ``` -Then you need to setup your joinmarket wallet: +Then you need to setup your default joinmarket wallet: ```bash jm.sh wallet-tool-generate @@ -32,46 +30,31 @@ Once done, you will need to send some money to the joinmarket wallet: jm.sh wallet-tool ``` -## How to fine tune? +## How to change joinmarket configuration? -Follow the [How can I customize the generated docker-compose file?](https://github.com/btcpayserver/btcpayserver-docker/blob/master/README.md#how-can-i-customize-the-generated-docker-compose-file) instructions. -Then pass as environment variable the attribute you want to modify, prefixed by `jm_`. +Connect to your container, and edit your configuration: -Our system is using the default configuration of joinmarket, then replace the values your specify like this. - -Example: - -```yml -services: - joinmarket: - environment: - jm_gaplimit: 3000 - jm_txfee: 300 - jm_cjfee_a: 500 +```bash +jm.sh bash +vim $CONFIG ``` ## Managing your wallet By running `jm.sh` without parameter, you will get a bunch of command that you can run such as: -For example: - ``` Usage: ------ Tooling to setup your joinmarket yield generator - exec: Run the specified joinmarket script wallet-tool: Run wallet-tools.py on the wallet wallet-tool-generate: Generate a new wallet set-wallet: Set the wallet that the yield generator need to use - logs: See logs of the yield generator (add -f to follow the logs) bash: Open an interactive bash session in the joinmarket container receive-payjoin: Receive a payjoin payment (this will stop the yield generator until the payment is received) sendpayment: Send a payjoin through coinjoin (password needed, this will stop the yield generator until the payment is received) - start: Start the yield generator (started by default) - stop: Stop the yield generator Example: * jm.sh wallet-tool-generate @@ -80,18 +63,10 @@ Example: * jm.sh receive-payjoin * jm.sh sendpayment
* jm.sh wallet-tool history - * jm.sh logs -f * jm.sh bash - * jm.sh start - * jm.sh stop ``` -Note `jm.sh` commands are wrapper around joinmarket scripts. Those wrapper makes your life easier by: - -1. Avoiding, when it can, that you enter wallet file name/ wallet password -2. Stop and Start the yield generator for the duration of the operation - -In some cases you might want to get access to the raw scripts of joinmarket, in which case, you need to get the command prompt into the container. +Note `jm.sh` commands are wrapper around joinmarket scripts. Those are just convenience command, you can always directly connect to the container via `jm.sh bash` and achieve the same result with the joinmarket python scripts. ## Getting command prompt into the container @@ -102,19 +77,76 @@ jm.sh bash sendpayment.py wallet.jmdat ... ``` -However, you might get the following error: +## Managing the services such as yield generators + +First connect to the container's bash + +```bash +jm.sh bash +``` +You can list available services to run: + +```bash +supervisorctl status +``` + +Which might show you + +```bash +root> supervisorctl status +ob-watcher STOPPED Not started +yg-privacyenhanced STOPPED Not started +yield-generator-basic STOPPED Not started +``` + +You can start a yield generator with: + +```bash +supervisorctl start yg-privacyenhanced +``` + +*** Note that services will NOT be restarted automatically if the container restart. *** + +## OB-Watcher + +The `ob-watcher` service allows you to [see an order book](https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/orderbook.md). + +You can activate it: + +```bash +supervisorctl start ob-watcher +``` + +Then you can browse it by browsing `https://.com/obwatch/` + +## Troubleshooting + +### Error: Failed to load wallet, you need to remove the lock file + +You might sometimes get the following error when running a python script for joinmarket: ``` Failed to load wallet, error message: RetryableStorageError('File is currently in use (locked by pid 12822). If this is a leftover from a crashed instance you need to remove the lock file `/root/.joinmarket/wallets/.wallet.jmdat.lock` manually.') ``` -This is because the yield generator is running. +This is because a service using the wallet is running, so you need to shut it down before running the command. -You can stop and start the yield generator with the helper scripts in the container `stop.sh` and `start.sh`. +Check which service is running: +```bash +supervisorctl status +``` -## Troubleshooting +And stop it -Run `jm.sh logs` to get the logs of the yield generator. +```bash +supervisorctl stop yg-privacyenhanced +``` -A common issue is that a lock file is present, preventing it to restart. -In which case, connect directly into the container with `jm.sh bash` and delete the problematic file. +### Read the logs of services + +You can use the `supervisorctl tail` command: +```bash +supervisorctl tail yg-privacyenhanced +``` + +You can also check the logs in the `$DATADIR/logs` folder. diff --git a/jm.sh b/jm.sh index 8fa4e5e..def2703 100755 --- a/jm.sh +++ b/jm.sh @@ -71,16 +71,6 @@ while (( "$#" )); do shift 1 break; ;; - start) - CMD="$1" - shift 1 - break; - ;; - stop) - CMD="$1" - shift 1 - break; - ;; wallet-tool-generate) CMD="$1" shift 1 @@ -106,26 +96,18 @@ if ! [[ "$CMD" ]]; then display_help else if [[ "$CMD" == "wallet-tool" ]]; then - docker exec joinmarket wallet-tool.sh "$@" + docker exec joinmarket exec-wrapper.sh unlockwallet wallet-tool.py "$@" elif [[ "$CMD" == "wallet-tool-generate" ]]; then docker exec -ti joinmarket exec-wrapper.sh wallet-tool.py generate "$@" elif [[ "$CMD" == "sendpayment" ]]; then - docker exec -ti joinmarket exec-wrapper.sh sendpayment.sh "$@" + docker exec -ti joinmarket exec-wrapper.sh unlockwallet nopass sendpayment.py "$@" elif [[ "$CMD" == "receive-payjoin" ]]; then - docker exec -ti joinmarket exec-wrapper.sh receive-payjoin.sh "$@" + docker exec -ti joinmarket exec-wrapper.sh unlockwallet receive-payjoin.py "$@" elif [[ "$CMD" == "set-wallet" ]]; then docker exec joinmarket set-wallet.sh "$@" docker restart joinmarket - elif [[ "$CMD" == "exec" ]]; then - docker exec joinmarket exec-wrapper.sh "$@" - elif [[ "$CMD" == "logs" ]]; then - docker logs "$@" joinmarket elif [[ "$CMD" == "bash" ]]; then docker exec -ti joinmarket exec-wrapper.sh bash "$@" - elif [[ "$CMD" == "stop" ]]; then - docker exec joinmarket exec-wrapper.sh stop.sh - elif [[ "$CMD" == "start" ]]; then - docker exec joinmarket exec-wrapper.sh start.sh else display_help fi