6 LDK Milestones

Antoine Riard edited this page 2021-02-07 15:50:25 -05:00

Unescape Escape

Table of Contents

• Goal
• Specifics
• Dev experience

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Goal

Deliver an SDK that a developer is able to download and use to build a LN wallet without hand-holding by the LDK team. The developer should not need to know, learn, or modify Rust code, and should operate with an API in their native language. The LDK would not need to be production-ready yet; just usable for development purposes.

Specifics

• API in Rust, Swift, JavaScript, and Java
• Well-written, modular, well-documented example node
• LDK website as starting point for documentation and getting started
• Developer documentation should describe the API, the examples, and include diagrams (building off of Arik’s documentation and Jeff’s diagrams)
• Be able to support an LDK workshop
• Each team member should be running their own node
• Minimum 1 external developer using LDK

Dev experience

1. Go to LDK website
2. Download (git clone?) LDK
3. Read docs to understand prerequisites (having bitcoind running?)
4. Type “make” and “run” to have a running node working (in any of Rust, Swift, JavaScript, or Java on MacOS, Linux, iOS, or Android)
5. Developer should be able to read the docs, the example code, and the APIs and reasonably be able to 5.1 Modify the example to use a different module (different block data source, different key store, etc.) 5.2 Integrate into an existing bitcoin wallet (such as Green, Pine, Blue Wallet)