GlcoinCore/jam
1
0
Fork 0
mirror of https://github.com/joinmarket-webui/jam.git synced 2026-08-13 12:33:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
jam/docs/developing.md
Thebora Kompanioni 454daa2839
chore(regtest): initial joinmarket-ng backend for regtest environment (#1240) 
* chore(regtest): initial joinmarket-ng backend for regtest environment

Adds jmwalletd, directory servers, makers, and bitcoind to the regtest
docker-compose environment so jam can be developed against the jm-ng
backend end-to-end.

chore(regtest): wire docker compose env and vite dev proxy for jm-ng

Connects the local regtest containers into a single compose network,
adds tor and fund-wallet helpers, and points Vite's dev proxy at the
local jmwalletd instance.

fix(tags): recognize cj-change, used-empty, and flagged UTXO statuses

joinmarket-ng's WalletService emits four statuses jam's JmPlainTagValue
didn't cover: 'cj-change' (deanonymising change from our CJ),
'used-empty' (previously-used address with zero balance), and 'flagged'
(address shared in a CJ that later failed). They fell through to the
generic 'default' badge with no distinguishing styling.

Add them to JmPlainTagValue and the status->variant map. 'used-empty'
maps to the existing 'used' variant, 'flagged' to 'reused' (both signal
a used address the user should avoid reusing). Add a dedicated
'cj-change' badge variant (emerald) next to 'cj-out' so the
deanonymising change output is visually distinct from an equal-amount
CJ output.

fix(send): keep direct send available with maker

Only block collaborative sends while the maker service is running. Direct sends stay enabled and the form explains why the collaborative toggle is unavailable.

Changelog: Allow direct sends while the maker service is running

docs(dev): explain jm-ng backend workflow

fix(auth): only clear auth on invalid_token 401s

Previously every 401 response cleared the session and logged the user out. jm-ng returns 401 for service-state errors (e.g. POST /tumbler/stop when nothing is running), which should never drop the session. Inspect the WWW-Authenticate header and only clear auth when the server signals ``error="invalid_token"``.

Changelog: Non-auth 401 responses no longer log the user out.

fix(dev): proxy /jmws to the jm-ng HTTPS port

jm-ng serves WebSocket on the same port as the HTTPS API. The `jm-ng:dev` script used to override JMWALLETD_WEBSOCKET_PORT to 32283, but the regtest stack exposes that port without a matching listener, so vite proxied WebSocket upgrades into a dead port and the handshake returned empty. Default the env var to JMWALLETD_API_PORT and drop the override.

Changelog: Fix WebSocket proxying in the local jm-ng dev setup.

fix(dev): correct jm-ng websocket port and proxy targets

Update the README and developer docs to reflect that both ports must be
set when overriding for a custom jm-ng setup.

fix(dev): correct jm-ng websocket port (#1237)

chore(dev): distinct server configs for various backends

* chore(regtest): address jm-ng review comments

---------

Co-authored-by: m0wer <m0wer@sgn.space>
Co-authored-by: Parth Bandwal <143504541+parrth20@users.noreply.github.com>
2026-05-05 13:52:41 +02:00

5.8 KiB
Raw Blame History

Developer Docs

A place to collect useful information for developers that doesn't really fit elsewhere.

👉 See CONTRIBUTING.md for how to get started participating in this project.

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.

Running Jam Against JoinMarket-NG

Jam v2 can talk directly to a separately running jmwalletd / orderbook watcher from joinmarket-ng. You do not need to run the Jam regtest compose or the reference implementation for this workflow.

Local dev against the Jam regtest jm-ng services

If you are using Jam's own regtest environment, the initialized jm-ng services are exposed on specific host ports. In that case run:

npm run jm-ng:dev

If your separately running jm-ng services use different ports, you can override them directly:

JAM_BACKEND=joinmarket-ng \
JMWALLETD_API_PORT=28183 \
JMWALLETD_WEBSOCKET_PORT=28283 \
JMOBWATCH_PORT=8080 \
npm run dev

Linting

We use Create React App's default ESLint integration. You'll see linting issues in the console when running the app with npm run dev. Pull request builds will fail if ESLint is not happy with the code.

Code Formatting

We use the Prettier code formatter to keep a consistent code style. Pull request builds will fail if Prettier is not happy with the code. There's a couple of options on how to setup Prettier so that it formats your code automatically:

NPM Script

Running npm run format will format the whole codebase.

Editor Integration

Prettier has great editor integrations which will automatically format all files you touch.

Git Pre-Commit Hook

You can use a pre-commit hook that will automatically format all changes before comitting them to Git. We use husky and lint-staged for that.

By default, the hook will be installed automatically as an NPM postinstall script.

Troubleshooting

If you're having issues with Husky not using the correct $PATH, you may need to setup a ~/.huskyrc which will let you set up your path before the hook is run. See here for more info.

Running the Web UI Locally and Connecting to a Remote JoinMarket Instance

These instructions assume you want to run the web UI locally and connect it to a JoinMarket instance on your RaspiBlitz. The process should be similar for other setups. If you run the Web UI and JoinMarket on the same system, simply skip the SSH tunnel step.

🚨 Prerequisite: JoinMarket

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

1. Install JoinMarket

Install JoininBox on your RaspiBlitz:

Services > j [BTC JoinMarket+JoininBox menu]

Or follow the JoinMarket installation guide if you're on another system.

🚨 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, Install, Jam

In short:

git clone https://github.com/joinmarket-webui/jam.git
cd jam/
npm install && npm run dev

Resources