search

JoinMarket-Org / joinmarket-clientserver

Bitcoin CoinJoin implementation with incentive structure to convince people to take part
GNU General Public License v3.0
729 stars 179 forks source link
bitcoin coinjoin joinmarket privacy tumbler

readme

Release workflow status

joinmarket-clientserver

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.

A CoinJoin transaction requires other people to take part. The right resources (coins) have to be in the right place, at the right time, in the right quantity. This isn't a software or tech problem, it's an economic problem. JoinMarket works by creating a new kind of market that would allocate these resources in the best way.

One group of participants (called market makers) will always be available to take part in CoinJoins at any time. Other participants (called market takers) can create a CoinJoin at any time. The takers pay a fee which incentivizes the makers. A form of smart contract is created, meaning the private keys will never be broadcasted outside of your computer, resulting in virtually zero risk of loss (aside from malware or bugs). As a result of free-market forces the fees will eventually be next to nothing.

Widespread use of JoinMarket improves bitcoin's fungibility and privacy. This implementation of JoinMarket also implements PayJoin.

For a quick introduction to Joinmarket you can watch this demonstration of installation and usage given by Adam Gibson during the Understanding Bitcoin conference on April 6 2019.

Wallet features

Quickstart - RECOMMENDED INSTALLATION METHOD (Linux and macOS only)

Download the latest release as tar or zip, and extract it.

Make sure to validate the signature on the tar/zip file provided with the release (or check the signature in git if you install that way using git log --show-signature).

JoinMarket requires Python >=3.8, <3.13 installed.

(macOS users: Make sure that you have Homebrew and Apple's Command Line Tools installed.)

./install.sh

(There are options you can apply to the installation - see ./install.sh -?. But the defaults should work.)

Follow instructions on screen; provide sudo password when prompted, then when finished:

source jmvenv/bin/activate
cd scripts

You can optionally install a Qt GUI application, you will be prompted to choose this during installation.

You should now be able to run the scripts like python wallet-tool.py etc., just as you did in the previous Joinmarket version.

Alternative to this "quickstart": follow the install guide.

More installation guides

Usage

If you are new, follow and read the links in the usage guide.

If you are running Joinmarket-Qt, you can instead use the walkthrough to start.

If you used the old version of Joinmarket, the notes in the scripts readme help to understand what has and hasn't changed about the scripts (warning: this refers to changes from several years ago, so may be slightly outdated).

If you are looking for the available makers, run the orderbook. It's recommended to run your own orderbook locally, but there are also public mirrors:

Useful third-party projects

PayJoin

If you want to use the PayJoin feature to pay/receive money to/from another BIP78-supporting wallet, read this guide.

Joinmarket-Qt

Provides single join and multi-join/tumbler functionality (i.e. "Taker") only, in a GUI.

If binaries are built, they will be gpg signed and announced on the Releases page.

If you haven't chosen the Qt option during installation with install.sh, then to run the script joinmarket-qt.py from the command line you will need to install two more packages. Use these 2 commands while the jmvenv virtual environment is activated:

pip install .[gui]

After this, the command python joinmarket-qt.py from within the scripts subdirectory should work. There is a walkthrough for what to do next.

Architecture notes

See architecture-notes.md.

TESTING

Instructions for developers for testing here. If you want to help improve the project, please have a read of this todo list and the Help Wanted tag on the issue tracker.

Community