Skip to content

Commit 964c93a

Browse files
author
Conor Okus
committed
Link to Rust API docs
1 parent 88e1609 commit 964c93a

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,28 @@ For an integrated example of an LDK node in Rust, see the [Sample Node](https://
88

99
The following tutorials will show you how to build the simplest lightning node using LDK, that fufills the following tasks:
1010

11-
1. **Connect to peers**
12-
2. **Open channels**
11+
1. **Connecting to Peers**
12+
2. **Open Channels**
1313
3. **Send Payments**
1414
4. **Receive Payments**
15-
5. **Close channels**
15+
5. **Close Channels**
1616

1717
### Foundational Components
1818

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

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.
21+
1. A [`PeerManager`](https://docs.rs/lightning/*/lightning/ln/peer_handler/struct.PeerManager.html), for establishing TCP/IP connections to other nodes on the lightning network.
22+
2. A [`ChannelManager`](https://docs.rs/lightning/*/lightning/ln/channelmanager/struct.ChannelManager.html), to open and close channels.
2323
3. Payments & Routing, ability to create and pay invoices.
2424

2525
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`
26+
1. A [`FeeEstimator`](https://docs.rs/lightning/*/lightning/chain/chaininterface/trait.FeeEstimator.html)
27+
2. A [`Logger`](https://docs.rs/lightning/*/lightning/util/logger/index.html)
28+
3. A Transaction [`Broadcaster`](https://docs.rs/lightning/*/lightning/chain/chaininterface/trait.BroadcasterInterface.html)
29+
4. A [`NetworkGraph`](https://docs.rs/lightning/*/lightning/routing/gossip/struct.NetworkGraph.html)
30+
5. A [`Persister`](https://docs.rs/lightning/*/lightning/util/persist/trait.Persister.html)
31+
6. An [`EventHandler`](https://docs.rs/lightning/*/lightning/util/events/trait.EventHandler.html)
32+
7. A Transaction [`Filter`](https://docs.rs/lightning/*/lightning/chain/trait.Filter.html)
33+
8. A [`ChainMonitor`](https://docs.rs/lightning/*/lightning/chain/chainmonitor/index.html)
34+
9. A [`KeysManager`](https://docs.rs/lightning/*/lightning/chain/keysinterface/struct.KeysManager.html)
35+
10. A [`Scorer`](https://docs.rs/lightning/*/lightning/routing/scoring/index.html)

0 commit comments

Comments
 (0)