Skip to content

Commit 2f4e4c5

Browse files
Finish adding links for core structs
1 parent 3013e1c commit 2f4e4c5

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/build_node.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ final chain_monitor = ChainMonitor.constructor_new(null, tx_broadcaster, logger,
9696
- [ ] Initialize the keys manager
9797
* What it's used for: providing keys for signing lightning transactions
9898
* Dependencies: random bytes, the current bitcoin network
99+
* References: [Rust docs](https://docs.rs/lightning/0.0.12/lightning/chain/keysinterface/struct.KeysManager.html), [Java bindings](https://github.com/lightningdevkit/ldk-garbagecollected/blob/main/src/main/java/org/ldk/structs/KeysManager.java)
99100
* Example:
100101
```java
101102
byte[] key_seed = new byte[32];
@@ -113,6 +114,7 @@ See the Key Management guide for more information.
113114
- [ ] Initialize the channel manager
114115
* What it's used for: managing channel state
115116
* Dependencies: keys manager, fee estimator, chain monitor, transaction broadcaster, logger, channel configuration info, and the set of channel monitors we read from disk in the previous step
117+
* References: [Rust `ChannelManager` docs](https://docs.rs/lightning/0.0.12/lightning/ln/channelmanager/struct.ChannelManager.html), [Java `ChannelManager` bindings](https://github.com/lightningdevkit/ldk-garbagecollected/blob/main/src/main/java/org/ldk/structs/ChannelManager.java)
116118

117119
Example of initializing a channel manager on a fresh node:
118120
```java
@@ -182,7 +184,9 @@ final router = NetGraphMsgHandler.constructor_new(new byte[32], null, logger);
182184
- [ ] Initialize the peer manager using LDK's `PeerManager` struct combined with LDK's supplied `NioPeerHandler` networking battery
183185
* What it's used for: connecting to peers, facilitating peer data to and from LDK
184186
* Dependencies: channel manager, router (optional), keys manager, random bytes, logger
185-
* Example:
187+
* References: [Rust docs](https://docs.rs/lightning/0.0.12/lightning/ln/peer_handler/struct.PeerManager.html), [Java `PeerManager` bindings](https://github.com/lightningdevkit/ldk-garbagecollected/blob/main/src/main/java/org/ldk/structs/PeerManager.java), [Java `NioPeerHandler`](https://github.com/lightningdevkit/ldk-garbagecollected/blob/main/src/main/java/org/ldk/batteries/NioPeerHandler.java)
188+
189+
Example:
186190
```java
187191
byte[] random_data = new byte[32];
188192
<insert code to fill in `random_data` with random bytes>

0 commit comments

Comments
 (0)