https://github.com/lightningdevkit/ldk-sample
Sample node implementation using LDK
https://github.com/lightningdevkit/ldk-sample
Last synced: 2 months ago
JSON representation
Sample node implementation using LDK
- Host: GitHub
- URL: https://github.com/lightningdevkit/ldk-sample
- Owner: lightningdevkit
- License: apache-2.0
- Created: 2021-01-30T06:08:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-26T23:19:33.000Z (5 months ago)
- Last Synced: 2025-04-03T11:11:29.301Z (3 months ago)
- Language: Rust
- Homepage:
- Size: 341 KB
- Stars: 179
- Watchers: 17
- Forks: 95
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# ldk-sample
Sample node implementation using LDK.
## Installation
```
git clone https://github.com/lightningdevkit/ldk-sample
```
## Usage
```
cd ldk-sample
cargo run :@: [] [] [] []
```
`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.
## License
Licensed under either:
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.