Skip to content

Commit ff4eae2

Browse files
author
Conor Okus
committed
Consolidate building a node tutorials
1 parent 9518c61 commit ff4eae2

File tree

3 files changed

+1007
-16
lines changed

3 files changed

+1007
-16
lines changed

docs/.vuepress/config.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,10 @@ const tutorialSidebar = [
9494
title: 'Building a node with LDK',
9595
collapsable: false,
9696
children: [
97-
['/tutorials/building-a-node-with-ldk/introduction', 'Introduction']
97+
['/tutorials/building-a-node-with-ldk/introduction', 'Introduction'],
98+
['/tutorials/building-a-node-with-ldk/setting-up-a-channel-manager', 'Setting up a Channel Manager']
9899
]
99100
},
100-
'/tutorials/build_a_node_in_java',
101-
'/tutorials/build_a_node_in_rust'
102101
],
103102
}
104103
]

docs/tutorials/building-a-node-with-ldk/introduction.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
## Learn how to build a basic LDK node from scratch using LDK
44

5+
::: tip Note
6+
For an integrated example of an LDK node in Rust, see the [Sample Node](https://github.com/lightningdevkit/ldk-sample)
7+
:::
8+
59
The following tutorials will show you how to build the simplest lightning node using LDK, that fufills the following tasks:
610

711
1. **Connect to peers**
@@ -14,18 +18,18 @@ The following tutorials will show you how to build the simplest lightning node u
1418

1519
Let's start by looking at the core components we'll need to make this node work for the tasks we outlined above.
1620

17-
1. A Peer Manager, for establishing TCP/IP connections to other nodes on the lightning network.
18-
2. A Channel Manager, to open and close channels.
21+
1. A `PeerManager`, for establishing TCP/IP connections to other nodes on the lightning network.
22+
2. A `ChannelManager`, to open and close channels.
1923
3. Payments & Routing, ability to create and pay invoices.
2024

21-
To make the above work we also need a series of supporting modules, including:
22-
- A Fee Estimator
23-
- A Logger
24-
- A Transaction Broadcaster
25-
- A Network Graph
26-
- A Persister
27-
- An Event Handler
28-
- A Transaction Filter
29-
- A Chain Monitor
30-
- A Keys Manager
31-
- A Scorer
25+
To make the above work we also need to setup a series of supporting modules, including:
26+
1. A `FeeEstimator`
27+
2. A `Logger`
28+
3. A `TransactionBroadcaster`
29+
4. A `NetworkGraph`
30+
5. A `Persister`
31+
6. An `EventHandler`
32+
7. A `TransactionFilter`
33+
8. A `ChainMonitor`
34+
9. A `KeysManager`
35+
10. A `Scorer`

0 commit comments

Comments
 (0)