Middleware wraps Bitcoin Core's RPC and LND's gRPC, and exposes them via a RESTful API.
It is part of Citadel's effort to create an open source, easy to use, and secure Bitcoin full node, and also build a free libre open source backend for Umbrel.
Middleware will soon be part of the full Citadel project. For now, you can install it on your own machine manually.
Make sure a bitcoind and lnd instance is running and available on the same machine.
yarnSet the following environment variables directly or by placing them in .env file of project's root.
| Variable | Description | Default |
|---|---|---|
PORT |
Port where middleware should listen for requests | 3005 |
DEVICE_HOSTS |
Comma separated list of IPs or domain names to whitelist for CORS | http://citadel.local |
BITCOIN_HOST |
IP or domain where bitcoind RPC is listening |
127.0.0.1 |
RPC_USER |
bitcoind RPC username |
|
RPC_PASSWORD |
bitcoind RPC password |
|
LND_HOST |
IP or domain where lnd RPC is listening |
127.0.0.1 |
TLS_FILE |
Path to lnd's TLS certificate |
/lnd/tls.cert |
LND_PORT |
Port where lnd RPC is listening |
10009 |
LND_NETWORK |
The chain bitcoind is running on (mainnet, testnet, regtest, simnet) |
mainnet |
MACAROON_DIR |
Path to lnd's macaroon directory |
/lnd/data/chain/bitcoin/mainnet/ |
JWT_PUBLIC_KEY_FILE |
Path to the JWT public key created by manager |
/jwt-public-key/jwt.pem |
yarn startYou can browse through the available API endpoints here.
Citadel is still in an early stage and things are expected to break every now and then. We DO NOT recommend running it on the mainnet with real money just yet, unless you want to be really #reckless.
We welcome and appreciate new contributions!
If you're a developer looking to help but not sure where to begin, check out these issues that have specifically been marked as being friendly to new contributors.
If you're looking for a bigger challenge, before opening a pull request please create an issue or join our chat to get feedback, discuss the best way to tackle the challenge, and to ensure that there's no duplication of work.
Middleware is inspired by and built upon the work done by Umbrel on its open-source API.
The original code we forked is licensed under
Copyright (c) 2018-2019 Casa, Inc. https://keys.casa/
Copyright (c) 2020 Umbrel. https://getumbrel.com/
