tsk fd6f848120 fix: Enable pure environment variable configuration for Lightning backends (#1299) 1 day ago
..
src 5ee405de89 Store last pay index (#1077) 2 months ago
Cargo.toml 2e424e629f feat: uuid version (#891) 3 months ago
README.md fd6f848120 fix: Enable pure environment variable configuration for Lightning backends (#1299) 1 day ago

README.md

CDK CLN

crates.io Documentation MIT licensed

ALPHA This library is in early development, the API will change and should be used with caution.

Core Lightning (CLN) backend implementation for the Cashu Development Kit (CDK).

Installation

Add this to your Cargo.toml:

[dependencies]
cdk-cln = "*"

Configuration for cdk-mintd

Config File

[ln]
ln_backend = "cln"

[cln]
rpc_path = "/path/to/.lightning/bitcoin/lightning-rpc"
bolt12 = true            # Optional, defaults to true
fee_percent = 0.02       # Optional, defaults to 2%
reserve_fee_min = 2      # Optional, defaults to 2 sats

Environment Variables

All configuration can be set via environment variables:

Variable Description Required
CDK_MINTD_LN_BACKEND Set to cln Yes
CDK_MINTD_CLN_RPC_PATH Path to CLN RPC socket Yes
CDK_MINTD_CLN_BOLT12 Enable BOLT12 support (default: true) No
CDK_MINTD_CLN_FEE_PERCENT Fee percentage (default: 0.02) No
CDK_MINTD_CLN_RESERVE_FEE_MIN Minimum fee in sats (default: 2) No

Example

export CDK_MINTD_LN_BACKEND=cln
export CDK_MINTD_CLN_RPC_PATH=/home/user/.lightning/bitcoin/lightning-rpc
cdk-mintd

License

This project is licensed under the MIT License.