joinmarket/docs/index.md

Joinmarket documentation

Contents

1. User guide material

   a. Installation guide (BUT use the install script as per README, first)

   b. Main usage guide, covers wallet funding, creation, control, transactions etc.

   c. Running a yield generator general basics

   d. Running JoinmarketQt for coinjoins and wallet control

   e. Important info for takers - how to deal with commitments

   f. Important info for makers - how to create and use fidelity bonds

   g. How to run the tumbler script (or in Qt) for a good privacy effect

   h. How to run the orderbook script locally

   i. How to do payjoins with Joinmarket

   j. How to use SNICKER features (currently not active)

2. More useful for developers, mainly

   a. How to get a test setup working, with regtest

   b. How to use jmwalletd and the RPC-API to the Joinmarket wallet

   c. Some background notes on Joinmarket's architecture (client-daemon etc.)

   d. Some notes about project goals and progress, usually not well updated

3. Older guides on upgrades/changes that are no longer relevant, ignore:

   a. Upgrading to p2wpkh/native segwit (which is now default)

   b. Upgrading the IRC config (changed in 2018)