ldk-sample

Sample node implementation using LDK.

Installation

git clone https://github.com/lightningdevkit/ldk-sample

Usage

cd ldk-sample
cargo run <bitcoind-rpc-username>:<bitcoind-rpc-password>@<bitcoind-rpc-host>:<bitcoind-rpc-port> <ldk_storage_directory_path> [<ldk-peer-listening-port>] [<bitcoin-network>] [<announced-node-name>] [<announced-listen-addr>]

bitcoind's RPC username and password likely can be found through cat ~/.bitcoin/.cookie.

bitcoin-network: defaults to testnet. Options: testnet, regtest, and signet.

ldk-peer-listening-port: defaults to 9735.

announced-listen-addr and announced-node-name: default to nothing, disabling any public announcements of this node. announced-listen-addr can be set to an IPv4 or IPv6 address to announce that as a publicly-connectable address for this node. announced-node-name can be any string up to 32 bytes in length, representing this node's alias.

Probe Config

Targeted probing is disabled unless a config file exists.

cp ./prober_config.json.example <ldk data dir>/prober_config.json

probe_peers pubkey of peers you are probing.

probe_interval_sec how often to probe, in seconds.

max_amount_msats maximum amount to probe, in millisatoshis.

License

Licensed under either:

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.