Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reference to LDK architecture #16

Merged
merged 3 commits into from
Feb 20, 2021
Merged

Add reference to LDK architecture #16

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3d04a5
Format references as sections with links
jkczyz Feb 8, 2021
385601d
Add LDK architecture to references
jkczyz Feb 8, 2021
7ebd679
Link to the most recent rust-lightning docs
jkczyz Feb 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions docs/references.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,23 @@ id: references
title: References
---

* Rust documentation: https://docs.rs/lightning/0.0.12/lightning/index.html
### [Rust Documentation](https://docs.rs/lightning)

These provide the most searchable and comprehensive documentation on LDK.
If you're using Java and want more information on any method/struct/etc., searching
the Rust docs for the Rust version of that struct/method is your best bet.

* Rust sample node: https://github.com/TheBlueMatt/rust-lightning-bitcoinrpc
### [Rust Sample Node](https://github.com/TheBlueMatt/rust-lightning-bitcoinrpc)

While this node is a little outdated, it's still a very useful reference for how to construct
a lightning node using LDK.

* Swift LDK documentation: https://github.com/arik-so/SwiftLightning/tree/master/Documentation
### [Swift LDK Documentation](https://github.com/arik-so/SwiftLightning/tree/master/Documentation)

These docs are mainly geared towards how Swift could call LDK C bindings directly, but still may
provide a useful overview of Rust Lightning in the context of language bindings.

### [LDK Architecture](https://docs.google.com/drawings/d/1Ql-q5gyrPnJhi7z_D39jayG0HEEVh6UEY1eULXb03Eg/edit?usp=sharing)

Gives a high-level organization of LDK and how the pieces fit together. Variations of this diagram
are used throughout the site. This is the primary source and is still a work in progress.