You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/running-a-sample-ldk-node.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Running a sample LDK node
2
-
Let's run our first LDK node. We'll ensure we have a compatible Rust toolchain installed, setup Polar to create a local lightning network and then start running the node.
2
+
Let's run our first LDK node. We'll ensure we have a compatible Rust toolchain installed, setup Polar to create a local Lightning network and then start running the node.
3
3
4
4
::: tip Not recommended for production use!
5
5
This guide is a quick start to get you up and running with an LDK node. It serves as a playground and a foundation to build upon and is NOT recommended for production environments. LDK doesn't come with a pre-packaged node but gives you the tools to build a node from scratch!
@@ -8,7 +8,7 @@ This guide is a quick start to get you up and running with an LDK node. It serve
8
8
## Installing Rust
9
9
If you already have a working installation of the latest Rust compiler, feel free to skip to the next section.
10
10
11
-
To install the latest version of Rust, we recommend using `rustup`. Install `rustup` by following the instructions on [its website](https://rustup.rs/). Once rustup is installed, ensure the latest toolchain is installed by running the command:
11
+
To install the latest version of Rust, we recommend using `rustup`. Install `rustup` by following the instructions on [its website](https://rustup.rs/). Once `rustup` is installed, ensure the latest toolchain is installed by running the command:
12
12
```
13
13
rustup default stable
14
14
```
@@ -20,11 +20,11 @@ Polar can be [downloaded](https://lightningpolar.com/) for MacOS, Linux, and Win
20
20
21
21
Mac and Windows users will need to install [Docker Desktop](https://www.docker.com/products/docker-desktop) as a dependency before using Polar. Linux users will need to download both [Docker Server](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).
22
22
23
-
After downloading, installing, and running Polar, spin up a new cluster of LND, c-lightning, eclair, and bitcoind nodes. This will create a Docker container within which Polar will operate.
23
+
After downloading, installing, and running Polar, spin up a new cluster of LND, Core Lightning, eclair, and bitcoind nodes. This will create a Docker container within which Polar will operate.
24
24
25
25
Click the orange **Create Network** button and Polar should display a new interface.
26
26
27
-
Press the orange Start button in the top right corner to start your local network. It takes a couple seconds for the nodes to boot up, but the indicator lights will eventually turn green signaling that the process has completed.
27
+
Press the orange **Start** button in the top right corner to start your local network. It takes a couple seconds for the nodes to boot up, but the indicator lights will eventually turn green signaling that the process has completed.
If you have a different setup that doesn't involve Polar you can modify this command so that it contains different credentials.
42
42
```
43
-
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]
43
+
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>]
44
44
```
45
45
`bitcoind`'s RPC username and password likely can be found through `cat ~/.bitcoin/.cookie`.
46
46
@@ -61,6 +61,6 @@ LDK logs are available at <your-supplied-ldk-data-dir-path>/.ldk/logs
61
61
Local Node ID is 02e8788eb41ac1731352d87ced719afce91a1201cf0d6cca12ee79502db1b0e317.
62
62
```
63
63
64
-
If you want to connect to another node you created with Polar select the node there. In the Connect tab you can copy the `P2P External` connection info. Running `connectpeer` with that will get you connected.
64
+
If you want to connect to another node you created with Polar select the node there. In the **Connect** tab you can copy the `P2P External` connection info. Running `connectpeer` with that will get you connected.
65
65
66
66
To check out the complete reference for constructing a Lightning node with LDK check out the [Github repo](https://github.com/lightningdevkit/ldk-sample)
0 commit comments