JoinMarket Web UI

Top-notch privacy for your bitcoin.
⚠️ This is still work in progress. Use with caution. ⚠️

Integrations · Features · Installation · Development

---

A web UI for JoinMarket with a focus on user-friendliness. The UI aims to provide sensible defaults and be easy to use for beginners while still providing the features advanced users expect.

• 💬 Join our Telegram group.
• 📚 Check out the Wiki for resources such as meeting notes, call recordings, ideas, and discussions.

This project builds upon work done by Shobhitaa, Abhishek, and Adam (waxwing) himself: JoinMarket-Org/jm-web-client.

📦 Integrations

We're aiming to make the JoinMarket Web UI available for different node systems. If your node of choice is missing, feel free to integrate it and let us know so we can add it here.

• RaspiBlitz: A beta version of the JoinMarket Web UI will be available in RaspiBlitz v1.7.2. We're aiming for a production ready version to be available with RaspiBlitz v1.8.0.
• Umbrel: Umbrel integration is work in progress.

✨ Features

• Spending from the wallet without Coinjoin
• Simple CoinJoins
• Running the yield generator
• TBD

👩‍🔧 Installation

These instructions assume you want to run the web UI locally and connect it to a JoinMarket instance on your RaspiBlitz. See Development for setting up a regtest development environment.

🚨 Prerequisite: JoinMarket on RaspiBlitz

To run the web UI locally you need to connect it to a running JoinMarket instance.

1. JoininBox

Install JoininBox on your RaspiBlitz:

Services > j [BTC JoinMarket+JoininBox menu]

🚨 Prerequisite: JoinMarket API Service

This app makes use of the JoinMarket RPC API. For this, you will need JoinMarket version 0.9.3 or higher. If needed you can upgrade JoinMarket to the latest commit via the JoininBox menu on your RaspiBlitz: Type jm in the command line and select UPDATE > ADVANCED > JMCOMMIT. This will install the latest development version from JoinMarket's master branch.

2. SSL Certificate

As the joinmarket user on your RaspiBlitz, generate a self-signed certificate for the JoinMarket API Service as described here, and put the certificate and the key in the ~/.joinmarket/ssl/ directory.

Hint: To login as the JoinMarket user, you can ssh into your RaspiBlitz, type jm, and exit the JoininBox menu.

Create the SSL directory:

(jmvenv) joinmarket@raspberrypi:~ $ mkdir ~/.joinmarket/ssl/

Generate the certificate and associated key:

openssl req -newkey rsa:4096 -x509 -sha256 -days 3650 -nodes -out ~/.joinmarket/ssl/cert.pem -keyout ~/.joinmarket/ssl/key.pem

Hint: You don't have to enter anything meaningful, you can just hit the return key a couple of times.

3. API Service

Start the JoinMarket API service:

(jmvenv) joinmarket@raspberrypi:~/joinmarket-clientserver/scripts $ python jmwalletd.py

You should see the following:

2021-11-18 18:16:57,639 [INFO]  Starting jmwalletd on port: 28183
2021-11-18 18:16:57,661 [INFO]  Joinmarket daemon listening on port 27183

4. SSH Tunnel

Create an SSH tunnel for the API service. On the machine where you want to run the web UI, add the following lines to your ~/.ssh/config file:

Host raspiblitz
  HostName 192.168.X.X # (IP address of your RaspiBlitz)
  User admin
  ForwardAgent yes
  LocalForward 28183 localhost:28183

💻 Download and Install the Web UI

In short:

git clone https://github.com/joinmarket-webui/joinmarket-webui.git
cd joinmarket-webui
npm install && npm start

👨‍💻 Development

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.

See the section about running tests for more information.

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes. Your app is ready to be deployed!

See the section about deployment for more information.

JoinMarket Development Environment

For a complete development environment you need a local JoinMarket instance that the web UI can interact with. We provide a regtest environment that should give you everything needed to get started developing with JoinMarket. You can find details here: docker/regtest/readme.md.