Skip to content

Commit 9518c61

Browse files
author
Conor Okus
committed
Adds tutorial introudction page
1 parent b9f17c3 commit 9518c61

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

docs/.vuepress/config.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,13 @@ const tutorialSidebar = [
9090
collapsable: false,
9191
children: [
9292
'/tutorials/getting-started',
93+
{
94+
title: 'Building a node with LDK',
95+
collapsable: false,
96+
children: [
97+
['/tutorials/building-a-node-with-ldk/introduction', 'Introduction']
98+
]
99+
},
93100
'/tutorials/build_a_node_in_java',
94101
'/tutorials/build_a_node_in_rust'
95102
],
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Building a Node with LDK
2+
3+
## Learn how to build a basic LDK node from scratch using LDK
4+
5+
The following tutorials will show you how to build the simplest lightning node using LDK, that fufills the following tasks:
6+
7+
1. **Connect to peers**
8+
2. **Open channels**
9+
3. **Send Payments**
10+
4. **Receive Payments**
11+
5. **Close channels**
12+
13+
### Foundational Components
14+
15+
Let's start by looking at the core components we'll need to make this node work for the tasks we outlined above.
16+
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.
19+
3. Payments & Routing, ability to create and pay invoices.
20+
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

0 commit comments

Comments
 (0)