From da09bfc157c577f5225cb4741eeecaaa6e0024cd Mon Sep 17 00:00:00 2001 From: openoms Date: Tue, 3 Dec 2019 02:27:58 +0000 Subject: [PATCH] joinmarket: clear style --- joinmarket/README.md | 40 +++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/joinmarket/README.md b/joinmarket/README.md index 36870d0..2f11d6e 100644 --- a/joinmarket/README.md +++ b/joinmarket/README.md @@ -5,11 +5,11 @@ ## JoinMarket on the RaspiBlitz A long standing coinjoin implementation with decentralised coordination and incentive structure. -Testing on a RPi4 4GB with RaspiBlitz v1.3 +Tested on: +* RPi4 4GB with RaspiBlitz v1.3 +* Odroid HC1 with RaspiBlitz v1.3 Check the current offers in the order book: https://joinmarket.me/ob/ -Generated by this script when installed: -`$ python ~/joinmarket-clientserver/scripts/obwatch/ob-watcher.py` One can coinjoin any amount within the offer limits by default with 5-7 random participants at a time. The taker fees are maximised, then the offers within the limits are randomly chosen to participate. Most parameters can be easily customized. @@ -17,14 +17,16 @@ See this review thread about the GUI option: https://twitter.com/zndtoshi/status ### Prerequisite -* Need to activate the wallet of bitcoind - - `$ sudo nano /mnt/hdd/bitcoin/bitcoin.conf` +Activate the wallet of bitcoind +* Edit the bitcoin.conf: +`$ sudo nano /mnt/hdd/bitcoin/bitcoin.conf` +* Change the disablewallet option to 0: ``` disablewallet=0 ``` - `$ sudo systemctl restart bitcoind` +* Restart the bitcoind: +`$ sudo systemctl restart bitcoind` ### Installation @@ -37,7 +39,6 @@ See this review thread about the GUI option: https://twitter.com/zndtoshi/status git reset --hard v0.6.0 sudo apt install -y libltdl-dev libssl-dev # needed for Armbian ./install.sh - # (follow instructions on screen; provide sudo password when prompted) # do not install QT-dependencies - running headless on the RPi ``` @@ -49,7 +50,7 @@ This needs to be done at every new login. $ source jmvenv/bin/activate $ cd scripts ``` - `Tips`: the commands can be run as one line if joined by `&&` + **Hint:** the commands can be run as one line if joined by `&&` (meaning continue to run if successful): ```bash @@ -86,11 +87,11 @@ This needs to be done at every new login. and run again after the first time -### Send payments through coinjoins with `sendpayment.py` +### Send payments with a coinjoin with the `sendpayment.py` * Described in: https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/USAGE.md#try-out-a-coinjoin-using-sendpaymentpy -* See the walkthrough for the JoinMarket-Qt GUI to send payments with coinjoin or run multiple coinjoins (tumbler): +* See the walkthrough for the JoinMarket-Qt GUI to send payments with coinjoin or run multiple coinjoins (**tumbler**): * Video demonstration of using the JoinMarket-Qt GUI: @@ -126,14 +127,15 @@ This needs to be done at every new login. * use the wallet tool: `(jmvenv) $ python wallet-tool.py wallet.jmdat history` - add `-v 4` to the end of the commadn for a more detailed list. + add `-v 4` to the end of the command for a more detailed list. * View the log of the transactions of the Yield Generator: `$ cat ~/joinmarket-clientserver/scripts/logs/yigen-statement.csv` - press `q` to exit + * Display as a table in the terminal: `$ column -s, -t < ~/joinmarket-clientserver/scripts/logs/yigen-statement.csv | less -#2 -N -S` + press `q` to exit * Monitor continously with: `$ tail -f -n 100 ~/joinmarket-clientserver/scripts/logs/yigen-statement.csv` @@ -156,9 +158,9 @@ Find a basic introduction at https://www.ocf.berkeley.edu/~ckuehl/tmux/ ### Make JoinMarket communicate on Tor * Activate Tor in the SERVICE menu of the RaspiBlitz if not running already -* Edit the `joinmarket.cfg` +* Edit the joinmarket.cfg: `$ nano joinmarket.cfg` -* Comment out the clearnet communication channels (place a `#` on the front of the line - means it wont be used by the script): +* Comment out the clearnet communication channels (place a `#` on the front of the line - means it won`t be used by the script): ``` [MESSAGING:server1] @@ -169,7 +171,7 @@ Find a basic introduction at https://www.ocf.berkeley.edu/~ckuehl/tmux/ [MESSAGING:server2] #host = irc.darkscience.net ``` -* Uncomment (remove the `#` from front of) the entries related for Tor: +* Uncomment (remove the `#` from front of) the entries related to Tor: ``` #for tor host = epynixtbonxn4odv34z4eqnlamnpuwfz6uwmsamcqd62si7cbix5hqad.onion @@ -189,9 +191,6 @@ Find a basic introduction at https://www.ocf.berkeley.edu/~ckuehl/tmux/ * Installation instructions: -* Tmux will be included in the next release of the RaspiBlitz: - - * Discuss JoinMarket usage on the RaspiBlitz in @@ -200,3 +199,6 @@ https://github.com/6102bitcoin/CoinJoin-Research/blob/master/CoinJoin_Implementa * Check the guide for the RaspiBolt by @kristapsk: https://github.com/kristapsk/raspibolt-extras/blob/master/joinmarket.md + +* Tmux will be included in the next release of the RaspiBlitz: + \ No newline at end of file