joinmarket-clientserver/docs/INSTALL.md

Notes on upgrading, binaries and compatibility

(You can ignore this whole section if starting from scratch).

Upgrading to new segwit version (0.3.0+ of this repo)

See here.

Notes on upgrading versions generally:

If you just want the latest version in a new directory, go to the releases page. Binary executables are not currently being built; that may change in the future.

Otherwise: if you are upgrading from an older version, just update using git: git pull origin master, or git fetch; git checkout tags/<tagname> for a specific tagged release, then rerun the installation process as described below. This will only work if the latest commit, or the tag, is actually newer in version number, than what was there already.

Installation on Linux

To install everything (client and server), install these packages:

sudo apt-get install python-dev python-pip git build-essential automake pkg-config libtool libffi-dev libssl-dev libgmp-dev

(+ libsodium-dev if you can find it, else build after)

(to build libsodium after):

git clone git://github.com/jedisct1/libsodium.git
cd libsodium
git checkout tags/1.0.4
./autogen.sh
./configure
make check
sudo make install
cd ..

Then install this repo:

git clone https://github.com/AdamISZ/joinmarket-clientserver
cd joinmarket-clientserver

Then:

sudo pip install virtualenv
virtualenv jmvenv
source jmvenv/bin/activate

At this point you should see (jmvenv) at the beginning of your command prompt.

Installing packages to run everything in-one:

NOTE: It is very important to have activated virtualenv before running this step. Otherwise, setupall.py will fail, you may be tempted to re-run it with sudo setupall.py which will cause problems in the future.

python setupall.py --daemon
python setupall.py --client-bitcoin

If you have installed this "full" version of the client, you can use it with the command line scripts as explained in the scripts README.

Installation on macOS

1. Install Apple Command Line Tools

   xcode-select --install
   

2. Install Homebrew

   /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
   

3. Install python3 and libsodium

   brew install python libsodium
   

4. Create virtualenv "jmvenv"

   pip3 install virtualenv
   virtualenv jmvenv
   source jmvenv/bin/activate
   

   At this point you should see (jmvenv) at the beginning of your command prompt.

5. Clone the joinmarket-clientserver repo.

   git clone https://github.com/Joinmarket-Org/joinmarket-clientserver
   cd joinmarket-clientserver
   

6. Setup joinmarket-qt

   pip install PySide2
   pip install https://github.com/sunu/qt5reactor/archive/58410aaead2185e9917ae9cac9c50fe7b70e4a60.zip
   python setupall.py --all
   

7. Start joinmarket-qt

   cd scripts
   python joinmarket-qt.py
   

Installation on Windows

note: Installing JoinMarket on Windows using the following method requires Windows 10 version 1607 or later.

Enable Windows Subsystem for Linux

note: a more detailed guide can be found here.

1. Open the Control Panel and navigate to Programs, Programs and Features, Turn Windows features on or off.
2. Select Windows Subsystem for Linux and click OK.
3. When asked, choose to restart.

Install Ubuntu from the Windows Store

1. Open the Windows Store, search for Ubuntu 18.04 LTS and click Get.

note: other distributions are available, but this is the only one tested

2. When finished downloading click Launch.
3. A window should pop up, telling your Installing, this may take a few minutes...
4. After installation is done, you'll be asked to provide a UNIX username and UNIX password. This will be the administrator account for the Ubuntu installation.
5. Finish the installation with updating the software within Ubuntu by typing the command sudo apt update && sudo apt upgrade -y. When asked, type the password provided earlier.

Installing JoinMarket

At this point you have an (almost) fully featured Linux installation on Windows and you can install JoinMarket using the instructions in the readme file or Installation on Linux section of this file.

Installing Bitcoin Core

If you haven't done so yet, install Bitcoin Core as described here. After starting it for the first time, it will start the Initial Block Download. JoinMarket cannot be used until this is finished. More information on that can be found here.

Configuring Bitcoin Core

Bitcoin Core needs to be configured to allow JoinMarket to connect to it. From the Settings menu choose Options and click Open Configuration File. Add server=1, save and close the file. After that restart Bitcoin Core.

Configuring JoinMarket

Lastly we must configure JoinMarket to allow it to connect to Bitcoin Core. Refer to the this section in the usage guide.

Edit your joinmarket.cfg file (in Ubuntu) and replace the following lines in the section [BLOCKCHAIN]

rpc_user = bitcoin
rpc_password = password

with

#rpc_user = bitcoin
#rpc_password = password
rpc_cookie_file = <path to the Bitcoin Core data directory>/.cookie

The location of the data directory was chosen when Bitcoin Core was first run. The default is C:\Users\<your username>\AppData\Roaming\Bitcoin. In Ubuntu this would be /mnt/c/Users/<your username>/AppData/Roaming/Bitcoin. Assuming your username is Alice the full line would be

rpc_cookie_file = /mnt/c/Users/Alice/AppData/Roaming/Bitcoin/.cookie

Running JoinMarket-Qt

note: you need to have installed JoinMarket with Qt support (see this section in the readme file)

1. In Ubuntu, install additional dependencies sudo apt install libgl1-mesa-glx.
2. Download and install MobaXterm. This program needs to be running before you can start JoinMarket-Qt. It requires no additional configuration.
3. Again in Ubuntu, type DISPLAY=localhost:0.0 or add it to your .bashrc file so you don't need to type it every time you want to start JoinMarket-Qt.
4. You can now start JoinMarket-Qt as described here. If you find that the program crashes with qt.qpa.plugin: Could not load the Qt platform plugin, you can add Qt5 dependencies with sudo apt install qtbase5-dev and try again.

Alternative/custom installation:

Installing the daemon separately

Just do

python setupall.py --daemon

Then, you can run the daemon on its own with

cd scripts; python joinmarketd.py <port number>

The reason for doing this may be either (1) to run command-line scripts provided here, but in a separate process from the daemon; or, (2) to run a separate (e.g. wallet plugin) codebase to do the bitcoin operations.

In the former case you will need still to install the local packages:

python setupall.py --client-bitcoin

and then edit your joinmarket.cfg section DAEMON, setting no_daemon = 0.

The latter case applies to the Electrum plugin (not currently operational), see here.

There, you need to install the client code (without Joinmarket's bitcoin):

python setupall.py --client-only

Development (or making other changes to the code)

If you are a developer or you plan on modifying the code (for example to add customizations), do not run the python setupall.py commands above. Instead run:

python setupall.py --develop

The normal installation (--daemon or --client-bitcoin) would install the JoinMarket packages to the virtualenv's site-packages directory. This would mean any changes you make to the local code would not have effect until the packages are reinstalled.

Using --develop causes a .egg-link file to be added to site-packages for each package. The .egg-link file acts like a symlink pointing to the local code. This means any changes you make to the code will have effect immediately.