Crate cdk_cln

Crate cdk_cln 

Source
Expand description

CDK lightning backend for CLN

§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:

VariableDescriptionRequired
CDK_MINTD_LN_BACKENDSet to clnYes
CDK_MINTD_CLN_RPC_PATHPath to CLN RPC socketYes
CDK_MINTD_CLN_BOLT12Enable BOLT12 support (default: true)No
CDK_MINTD_CLN_FEE_PERCENTFee percentage (default: 0.02)No
CDK_MINTD_CLN_RESERVE_FEE_MINMinimum 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.

Modules§

error
CLN Errors

Structs§

Cln
CLN mint backend