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

   1 # ldk-sample
   2 Sample node implementation using LDK.
   3
   4 ## Installation
   5 ```
   6 git clone git@github.com:lightningdevkit/ldk-sample.git
   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]
  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 ## License
  21
  22 Licensed under either:
  23
  24  * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
  25  * MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
  26
  27 at your option.