Tools for running and controlling an RLN node via a local HTTP JSON API.

Most users only need:

• rgbldkd (daemon): runs the node and serves the HTTP API.
• rgbldk (CLI): a terminal client for calling that API.
• TypeScript SDK: for web apps / Node.js services that want to call the API directly.

• Rust CLI (rgbldk): crates/cli
• TypeScript SDK: sdk/

HTTP API DTOs + generated Rust client live in rgb-ldk-api:

• rgbldk_http_dto
• rgbldk_http_client

1. Start a local regtest environment (bitcoind + esplora + two daemons):

RPC_USER=bitcoin RPC_PASSWORD=bitcoin docker compose -f crates/cli/docker-compose.yaml up -d

This exposes:

• node A: http://127.0.0.1:8501
• node B: http://127.0.0.1:8502

2. Build the CLI:

cargo build -p rgbldk-cli --bin rgbldk

3. Call the daemon:

RGBLDK_CONNECT=http://127.0.0.1:8501 ./target/debug/rgbldk node status
RGBLDK_CONNECT=http://127.0.0.1:8501 ./target/debug/rgbldk wallet balance

These commands do not talk to rgbldkd; they help debug issues like No owned allocations resolved from consignment by checking whether an expected seal/outpoint is present in a consignment.

# Parse an RGB invoice URI (pass `-` to read from stdin, or `@file` to read from a file)
./target/debug/rgbldk debug invoice 'contract:...'

# Inspect a consignment file (raw/gzip/zip auto-detected)
./target/debug/rgbldk debug consignment ./transfer.consignment.zip

# Check for a specific outpoint and/or invoice beneficiary in the consignment
./target/debug/rgbldk debug consignment ./transfer.consignment.zip \
  --outpoint cb6525f40318ba6d7a999c429bb2d60f2dab37731db5a14511fa11cd014429b8:0 \
  --invoice 'contract:...'

• TypeScript SDK: sdk/README.md

Dual-licensed under Apache-2.0 and MIT. See LICENSE-APACHE and LICENSE-MIT.