|
| 1 | +# Lightning Dev Kit |
| 2 | + |
| 3 | +> A complete Lightning implementation packaged as an SDK. |
| 4 | + |
| 5 | +Important notes: |
| 6 | + |
| 7 | +- Lightning Development Kit (LDK) is a full and completely standalone Lightning implementation with supporting modules enabling greater flexibility. |
| 8 | + |
| 9 | +## Docs |
| 10 | + |
| 11 | +- [Building a node with LDK](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/blob/main/docs/building-a-node-with-ldk/introduction.md): |
| 12 | +The following tutorials will show you how to build the simplest lightning node using LDK |
| 13 | +- [Installation](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/installation.md): |
| 14 | +Learn how to install the Lightning Development Kit (LDK) and set up your environment. |
| 15 | +- [Setting up a ChannelManager](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/setting-up-a-channel-manager.md): |
| 16 | +The ChannelManager is responsible for several tasks related to managing channel state. This includes keeping track of many channels, sending messages to appropriate channels, creating channels and more. |
| 17 | +- [Handling Events](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/handling-events.md): |
| 18 | +LDK requires that you handle many different events throughout your app's life cycle. |
| 19 | +- [Setting up a PeerManager](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/setting-up-a-peer-manager.md): |
| 20 | +The PeerManager is responsible for managing a set of peer connections and data associated with those peers. |
| 21 | +- [Connect to Peers](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/connect-to-peers.md) |
| 22 | +- [Opening a Channel](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/opening-a-channel.md) |
| 23 | +- [Sending Payments](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/sending-payments.md) |
| 24 | +- [Receiving Payments](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/receiving-payments.md) |
| 25 | +- [Closing a Channel](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/closing-a-channel.md) |
| 26 | + |
| 27 | +## Examples |
| 28 | + |
| 29 | +- [Rust Sample Node](https://raw.githubusercontent.com/lightningdevkit/ldk-sample/refs/heads/main/src/main.rs) |
| 30 | + |
| 31 | +## LDK Node |
| 32 | + |
| 33 | +- [LDK Node](https://github.com/lightningdevkit/ldk-node/edit/main/README.md): A ready-to-go Lightning node library built using LDK and BDK. |
0 commit comments