_ Git - ldk-sample/blob - README.md

   1 # ldk-sample
   2 Sample node implementation using LDK.
   3
   4 ## Installation
   5 ```
   6 git clone https://github.com/lightningdevkit/ldk-sample
   7 ```
   8
   9 ## Usage
  10 ```
  11 cd ldk-sample
  12 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-listen-addr announced-node-name]
  13 ```
  14 `bitcoind`'s RPC username and password likely can be found through `cat ~/.bitcoin/.cookie`.
  15
  16 `bitcoin-network`: defaults to `testnet`. Options: `testnet`, `regtest`.
  17
  18 `ldk-peer-listening-port`: defaults to 9735.
  19
  20 `announced-listen-addr` and `announced-node-name`: default to nothing, disabling any public announcements of this node.
  21 `announced-listen-addr` can be set to an IPv4 or IPv6 address to announce that as a publicly-connectable address for this node.
  22 `announced-node-name` can be any string up to 32 bytes in length, representing this node's alias.
  23
  24 ## License
  25
  26 Licensed under either:
  27
  28  * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
  29  * MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
  30
  31 at your option.