_ 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 `bitcoin-network`: defaults to `testnet`. Options: `testnet`, `regtest`.
  15
  16 `ldk-peer-listening-port`: defaults to 9735.
  17
  18 ## License
  19
  20 Licensed under either of
  21
  22  * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
  23  * MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
  24
  25 at your option.