aljaz/bitcoin-tutorials
1
1
Fork 0
mirror of https://github.com/openoms/bitcoin-tutorials.git synced 2026-01-07 13:54:21 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
e45c68a0c1d0c5c4a4e65d2a3a44a0166c956349
bitcoin-tutorials/joinmarket
History

README.md

JoinMarket on the RaspiBlitz

A long standing coinjoin implementation with decentralised coordination and incentive structure.

Tested on:

  • RPi4 4GB with RaspiBlitz v1.4
  • Odroid HC1 with RaspiBlitz v1.3

Check the current offers in the order book: https://joinmarket.me/ob/

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.

See this review thread about the GUI option: https://twitter.com/zndtoshi/status/1191799199119134720

Installation

Now you can use the automated install script which will be the part of the RaspiBlitz v1.5 release and can be installed form SERVICES menu.

What the script does:

  • sets up a separate user: joinmarket with sudo access. Uses the PASSWORD_B as the user password
  • the data directory is on the disk at /mnt/hdd/app-data/.joinmarket, symlinked to /home/joinmarket/.joinmarket and will be kept during the SD-card updates
  • if joinmarket was set up already using a previous version of this tutorial the the wallet(s) will be copied to the new data directory automatically
  • will be compatible with GUI being worked on here: https://github.com/openoms/joininbox

To install JoinMarket on RaspiBlitz v1.4 (earlier versions are not supported):

#download:
wget https://raw.githubusercontent.com/openoms/raspiblitz/joinmarket-cli/home.admin/config.scripts/bonus.joinmarket.sh
#run:
sudo bash bonus.joinmarket.sh on

Generate a wallet

  • Using the JoinMarket wallet: https://github.com/JoinMarket-Org/joinmarket/wiki/Using-the-JoinMarket-internal-wallet

    (jmvenv) $ python wallet-tool.py generate

    • JoinMarket uses a hot wallet sitting on your Raspberry Pi. Keep it safe.
    • Backup your seed and store safely. Best to not keep the seed and the passphrase together.
    • The wallet encryption password will be needed every time when there is interaction with the wallet. Store it somewhere accessible, best if encrypted.

  • Display the addresses of the first mixdepth (-m 0) to fund:

    (jmvenv) $ python wallet-tool.py -m 0 wallet.jmdat

    Will display after the first run:

    [INFO]  Detected new wallet, performing initial import
restart Bitcoin Core with -rescan or use `bitcoin-cli rescanblockchain` if you're recovering an existing wallet from backup seed
Otherwise just restart this joinmarket application.

    Run again after the first time to see the addresses (fund the first one):

    (jmvenv) $ python wallet-tool.py -m 0 wallet.jmdat

Send payments with a coinjoin with the sendpayment.py

Run a Yield Generator

  • Read the basics: https://github.com/JoinMarket-Org/joinmarket/wiki/Running-a-Yield-Generator

  • Edit the settings:
    $ nano yg-privacyenhanced.py

    """THESE SETTINGS CAN SIMPLY BE EDITED BY HAND IN THIS FILE:
"""

ordertype = 'swreloffer'  # [string, 'swreloffer' or 'swabsoffer'] / which fee type to actually use
cjfee_a = 500             # [satoshis, any integer] / absolute offer fee you wish to receive for coinjoins (cj)
cjfee_r = '0.00003'       # [percent, any str between 0-1] / relative offer fee you wish to receive based on a cj's amount
cjfee_factor = 0.1        # [percent, 0-1] / variance around the average fee. Ex: 200 fee, 0.2 var = fee is btw 160-240
txfee = 000               # [satoshis, any integer] / the average transaction fee you're adding to coinjoin transactions
txfee_factor = 0.3        # [percent, 0-1] / variance around the average fee. Ex: 1000 fee, 0.2 var = fee is btw 800-1200
minsize = 500000         # [satoshis, any integer] / minimum size of your cj offer. Lower cj amounts will be disregarded
size_factor = 0.1         # [percent, 0-1] / variance around all offer sizes. Ex: 500k minsize, 0.1 var = 450k-550k
gaplimit = 6

# end of settings customization
    • ordertype sets either a relative (swreloffer) or an absolute (swabsoffer) coinjoin fee model
    • cjfee_a is the fixed coinjoin fee to be earned when using swabsoffer
    • cjfee_r is the relative fee when using swreloffer. Specified as the fraction of the used amount.
    • txfee is the maker's contribution to the miner fees (still paid by the taker). To reduce the minimum offer amount for swreloffer set it to 0.
    • minsize specifies the minimum offer size in satoshis (this is the minimum size the UTXO will end up to be after participating in coinjoin)

  • Once set up run:

    (jmvenv) $ python yg-privacyenhanced.py wallet.jmdat

Check the transaction history

  • use the wallet tool:
    (jmvenv) $ python wallet-tool.py wallet.jmdat history

    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

  • 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

Keep the offers running in the background with Tmux

  • Start:
    $ tmux

  • Work in the terminal as described above.
    Find a basic introduction at https://www.ocf.berkeley.edu/~ckuehl/tmux/

  • If the terminal is disconnected the processes in tmux keep running (as it is running on the Blitz) and can be returned to

  • when logged in after a disconnection run:
    $ tmux a
    to pick up where left off

Resources: