Orchard

Your sovereign bank in cyberspace

---

Implementation support

Protocol	Implementation	Version
Bitcoin	core (knots compatible)	(^Satoshi:28.0.0)
Lightning	lnd, cln	(^v0.19.0-beta), (^v25.02)
Cashu Mint	cdk, nutshell	(^v0.14.1), (^0.18.2)
Taproot Assets	tapd	(^v0.6.1-alpha)
AI	ollama	(^0.13.1)

Setup

Prerequisites

• Install [Node.js] which includes [Node Package Manager][npm]
  • Recommended version (v22)

Environment Variables

mv .env.example .env
# edit .env file
nano .env

Configuration Options

	Orchard	Bitcoin	Lightning	Taproot Assets	Cashu Mint	AI
Required	✅
Optional		✅	✅	✅	✅	✅

Production Setup

Run the application (standard)

npm install
npm run build
npm run start

Updating

git pull
npm install
npm run build
npm run start

Run the application (docker)

Note: The nutshell mint rpc can be run in insecure mode, omitting the need for certs.
To allow this in a docker container set MINT_RPC_MTLS=false in .env

Docker images from source

Sqlite Cashu Mint

# Additional env vars
MINT_DATANAME=mint.sqlite3
MINT_DATADIR=/path/to/data/directory

docker compose build orchard
docker compose -f docker-compose.yml -f docker-compose.sqlite.yml up -d

Postgres Cashu Mint

docker compose build orchard
docker compose up -d

Docker images from registery

Note: When using registry images, you can specify a version using the VERSION environment variable. If not specified, it defaults to latest which may not be compatible with older versions of the codebase.

Sqlite Cashu Mint

# Additional env vars
MINT_DATANAME=mint.sqlite3
MINT_DATADIR=/path/to/data/directory

VERSION=latest FLAVOR=sqlite \
docker compose -f docker-compose.yml -f docker-compose.sqlite.yml -f compose.image.yml up -d

Postgres Cashu Mint

VERSION=latest FLAVOR=postgres \
docker compose -f docker-compose.yml -f compose.image.yml up -d

Development Setup

Run the application

Package Management

npm install

Client

npm run start:client

Server

npm run start:server

Tests

npm run format
npm run lint
npm run test