Skip to content

Add initial README and crate-level docs#49

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

Merged
tnull merged 3 commits into from
Mar 22, 2023
Merged

Add initial README and crate-level docs #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cafdda2
Add initial README and crate-level docs
tnull Mar 21, 2023
dc78b09
f Typo
tnull Mar 21, 2023
eb96580
f Address feedback, some formatting
tnull Mar 21, 2023
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
51 changes: 50 additions & 1 deletion README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
# LDK Node
A ready-to-go node implementation built using LDK.
A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and [BDK](https://bitcoindevkit.org/).

LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a small, simple, and straightforward interface that enables users to easily set up and run a Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node aims to be sufficiently modular and configurable to be useful for a variety of use cases.

## Getting Started

The primary abstraction of the library is the `Node`, which can be retrieved by setting up and configuring a `Builder` to your liking and calling `build()`. `Node` can then be controlled via commands such as `start`, `stop`, `connect_open_channel`, `send_payment`, etc.:

```rust
use ldk_node::Builder;
use ldk_node::lightning_invoice::Invoice;
use std::str::FromStr;

fn main() {
let node = Builder::new()
.set_network("testnet")
.set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
.build();

node.start().unwrap();

let _funding_address = node.new_funding_address();

// .. fund address ..

node.sync_wallets().unwrap();

node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();

let invoice = Invoice::from_str("INVOICE_STR").unwrap();
node.send_payment(invoice).unwrap();

node.stop().unwrap();
}
```

## Modularity

LDK Node currently comes with a decidedly opionated set of design choices:

- On-chain data is handled by the integrated BDK wallet
- Chain data is accessed via Esplora (support for Electrum and `bitcoind` RPC will follow)
- Wallet and channel state is persisted to file system (support for SQLite will follow)
- Gossip data is sourced via Lightnings peer-to-peer network (support for [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) will follow)
- Entropy for the Lightning and on-chain wallets may be generated and persisted for or provided by the user (support for [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonics will follow)


## Language Support

LDK Node is written in [Rust](https://www.rust-lang.org/) and may therefore be natively included in any `std` Rust program. Beyond its Rust API it also offers language bindings for Swift, Kotlin, and Python based on [UniFFI](https://github.com/mozilla/uniffi-rs/).
66 changes: 55 additions & 11 deletions src/lib.rs
View file
Open in desktop
Comment thread
tnull marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,14 +9,56 @@

#![crate_name = "ldk_node"]

//! A library providing a simplified API for the Lightning Dev Kit. While LDK itself provides a
//! highly configurable and adaptable interface, this API champions simplicity and ease of use over
//! configurability. To this end, it provides an opionated set of design choices and ready-to-go
//! default modules, while still enabling some configurability when dearly needed by the user:
//! - Chain data is accessed through an Esplora client.
//! - Wallet and channel states are persisted to disk.
//! - Gossip is retrieved over the P2P network.

//! # LDK Node
//! A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and
//! [BDK](https://bitcoindevkit.org/).
//!
//! LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a
//! small, simple, and straightforward interface that enables users to easily set up and run a
//! Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node
//! aims to be sufficiently modular and configurable to be useful for a variety of use cases.
//!
//! ## Getting Started
//!
//! The primary abstraction of the library is the [`Node`], which can be retrieved by setting up
//! and configuring a [`Builder`] to your liking and calling [`build`]. `Node` can then be
//! controlled via commands such as [`start`], [`stop`], [`connect_open_channel`],
//! [`send_payment`], etc.:
//!
//! ```no_run
//! use ldk_node::Builder;
//! use ldk_node::lightning_invoice::Invoice;
//! use std::str::FromStr;
//!
//! fn main() {
//! let node = Builder::new()
//! .set_network("testnet")
//! .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
//! .build();
//!
//! node.start().unwrap();
//!
//! let _funding_address = node.new_funding_address();
//!
//! // .. fund address ..
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
//!
//! node.stop().unwrap();
//! }
//! ```
//!
//! [`build`]: Builder::build
//! [`start`]: Node::start
//! [`stop`]: Node::stop
//! [`connect_open_channel`]: Node::connect_open_channel
//! [`send_payment`]: Node::send_payment
//!
#![deny(missing_docs)]
#![deny(broken_intra_doc_links)]
#![deny(private_intra_doc_links)]
Expand DownExpand Up@@ -273,7 +315,7 @@ impl Builder {
config.network,
database,
)
.expect("Failed to setup on-chain wallet");
.expect("Failed to set up on-chain wallet");

let tx_sync = Arc::new(EsploraSyncClient::new(
config.esplora_server_url.clone(),
Expand DownExpand Up@@ -482,7 +524,7 @@ struct Runtime {
stop_wallet_sync: Arc<AtomicBool>,
}

/// The main interface object of the simplified API, wrapping the necessary LDK and BDK functionalities.
/// The main interface object of LDK Node, wrapping the necessary LDK and BDK functionalities.
Comment thread
tnull marked this conversation as resolved.
///
/// Needs to be initialized and instantiated through [`Builder::build`].
pub struct Node {
Expand DownExpand Up@@ -716,12 +758,14 @@ impl Node {

/// Blocks until the next event is available.
///
/// Note: this will always return the same event until handling is confirmed via [`Node::event_handled`].
/// **Note:** this will always return the same event until handling is confirmed via [`Node::event_handled`].
pub fn next_event(&self) -> Event {
self.event_queue.next_event()
}

/// Confirm the last retrieved event handled.
///
/// **Note:** This **MUST** be called after each event has been handled.
pub fn event_handled(&self) {
self.event_queue.event_handled().unwrap();
}
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add initial README and crate-level docs by tnull · Pull Request #49 · lightningdevkit/ldk-node · GitHub
Skip to content
Add initial README and crate-level docs#49

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

 Merged

tnull
merged 3 commits into

from

Mar 22, 2023
 Merged


Add initial README and crate-level docs
#49
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
cafdda2

Add initial README and crate-level docs


tnull Mar 21, 2023
dc78b09

f Typo


tnull Mar 21, 2023
eb96580

f Address feedback, some formatting


tnull Mar 21, 2023

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


51 changes: 50 additions & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
# LDK Node
A ready-to-go node implementation built using LDK.
A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and [BDK](https://bitcoindevkit.org/).

LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a small, simple, and straightforward interface that enables users to easily set up and run a Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node aims to be sufficiently modular and configurable to be useful for a variety of use cases. 

## Getting Started

The primary abstraction of the library is the `Node`, which can be retrieved by setting up and configuring a `Builder` to your liking and calling `build()`. `Node` can then be controlled via commands such as `start`, `stop`, `connect_open_channel`, `send_payment`, etc.:

```rust
use ldk_node::Builder;
use ldk_node::lightning_invoice::Invoice;
use std::str::FromStr;

fn main() {
	let node = Builder::new()
 .set_network("testnet")
 .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
 .build();

	node.start().unwrap();

	let _funding_address = node.new_funding_address();

	// .. fund address ..

	node.sync_wallets().unwrap();

	node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();

	let invoice = Invoice::from_str("INVOICE_STR").unwrap();
	node.send_payment(invoice).unwrap();

	node.stop().unwrap();
}
```

## Modularity

LDK Node currently comes with a decidedly opionated set of design choices:

- On-chain data is handled by the integrated BDK wallet
- Chain data is accessed via Esplora (support for Electrum and `bitcoind` RPC will follow)
- Wallet and channel state is persisted to file system (support for SQLite will follow)
- Gossip data is sourced via Lightnings peer-to-peer network (support for [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) will follow)
- Entropy for the Lightning and on-chain wallets may be generated and persisted for or provided by the user (support for [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonics will follow)


## Language Support

LDK Node is written in [Rust](https://www.rust-lang.org/) and may therefore be natively included in any `std` Rust program. Beyond its Rust API it also offers language bindings for Swift, Kotlin, and Python based on [UniFFI](https://github.com/mozilla/uniffi-rs/).

66 changes: 55 additions & 11 deletions
src/lib.rs

View file


Open in desktop

Comment thread
tnull marked this conversation as resolved.

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,14 +9,56 @@

#![crate_name = "ldk_node"]

//! A library providing a simplified API for the Lightning Dev Kit. While LDK itself provides a
//! highly configurable and adaptable interface, this API champions simplicity and ease of use over
//! configurability. To this end, it provides an opionated set of design choices and ready-to-go
//! default modules, while still enabling some configurability when dearly needed by the user:
//! - Chain data is accessed through an Esplora client.
//! - Wallet and channel states are persisted to disk.
//! - Gossip is retrieved over the P2P network.

//! # LDK Node
//! A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and
//! [BDK](https://bitcoindevkit.org/).
//!
//! LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a
//! small, simple, and straightforward interface that enables users to easily set up and run a
//! Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node
//! aims to be sufficiently modular and configurable to be useful for a variety of use cases.
//!
//! ## Getting Started
//!
//! The primary abstraction of the library is the [`Node`], which can be retrieved by setting up
//! and configuring a [`Builder`] to your liking and calling [`build`]. `Node` can then be
//! controlled via commands such as [`start`], [`stop`], [`connect_open_channel`],
//! [`send_payment`], etc.:
//!
//! ```no_run
//! use ldk_node::Builder;
//! use ldk_node::lightning_invoice::Invoice;
//! use std::str::FromStr;
//!
//! fn main() {
//! let node = Builder::new()
//! .set_network("testnet")
//! .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
//! .build();
//!
//! node.start().unwrap();
//!
//! let _funding_address = node.new_funding_address();
//!
//! // .. fund address ..
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
//!
//! node.stop().unwrap();
//! }
//! ```
//!
//! [`build`]: Builder::build
//! [`start`]: Node::start
//! [`stop`]: Node::stop
//! [`connect_open_channel`]: Node::connect_open_channel
//! [`send_payment`]: Node::send_payment
//!
#![deny(missing_docs)]
#![deny(broken_intra_doc_links)]
#![deny(private_intra_doc_links)]
Expand DownExpand Up@@ -273,7 +315,7 @@ impl Builder {
 config.network,
 database,
 )
 .expect("Failed to setup on-chain wallet");
 .expect("Failed to set up on-chain wallet");

 let tx_sync = Arc::new(EsploraSyncClient::new(
 config.esplora_server_url.clone(),
Expand DownExpand Up@@ -482,7 +524,7 @@ struct Runtime {
	stop_wallet_sync: Arc<AtomicBool>,
}

/// The main interface object of the simplified API, wrapping the necessary LDK and BDK functionalities.
/// The main interface object of LDK Node, wrapping the necessary LDK and BDK functionalities.
Comment thread
tnull marked this conversation as resolved.

///
/// Needs to be initialized and instantiated through [`Builder::build`].
pub struct Node {
Expand DownExpand Up@@ -716,12 +758,14 @@ impl Node {

	/// Blocks until the next event is available.
	///
	/// Note: this will always return the same event until handling is confirmed via [`Node::event_handled`].
	/// **Note:** this will always return the same event until handling is confirmed via [`Node::event_handled`].
	pub fn next_event(&self) -> Event {
 self.event_queue.next_event()
	}

	/// Confirm the last retrieved event handled.
	///
	/// **Note:** This **MUST** be called after each event has been handled.
	pub fn event_handled(&self) {
 self.event_queue.event_handled().unwrap();
	}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add initial README and crate-level docs by tnull · Pull Request #49 · lightningdevkit/ldk-node · GitHub
Skip to content
Add initial README and crate-level docs#49

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

 Merged

tnull
merged 3 commits into

from

Mar 22, 2023
 Merged


Add initial README and crate-level docs
#49
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
cafdda2

Add initial README and crate-level docs


tnull Mar 21, 2023
dc78b09

f Typo


tnull Mar 21, 2023
eb96580

f Address feedback, some formatting


tnull Mar 21, 2023

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


51 changes: 50 additions & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
# LDK Node
A ready-to-go node implementation built using LDK.
A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and [BDK](https://bitcoindevkit.org/).

LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a small, simple, and straightforward interface that enables users to easily set up and run a Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node aims to be sufficiently modular and configurable to be useful for a variety of use cases. 

## Getting Started

The primary abstraction of the library is the `Node`, which can be retrieved by setting up and configuring a `Builder` to your liking and calling `build()`. `Node` can then be controlled via commands such as `start`, `stop`, `connect_open_channel`, `send_payment`, etc.:

```rust
use ldk_node::Builder;
use ldk_node::lightning_invoice::Invoice;
use std::str::FromStr;

fn main() {
	let node = Builder::new()
 .set_network("testnet")
 .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
 .build();

	node.start().unwrap();

	let _funding_address = node.new_funding_address();

	// .. fund address ..

	node.sync_wallets().unwrap();

	node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();

	let invoice = Invoice::from_str("INVOICE_STR").unwrap();
	node.send_payment(invoice).unwrap();

	node.stop().unwrap();
}
```

## Modularity

LDK Node currently comes with a decidedly opionated set of design choices:

- On-chain data is handled by the integrated BDK wallet
- Chain data is accessed via Esplora (support for Electrum and `bitcoind` RPC will follow)
- Wallet and channel state is persisted to file system (support for SQLite will follow)
- Gossip data is sourced via Lightnings peer-to-peer network (support for [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) will follow)
- Entropy for the Lightning and on-chain wallets may be generated and persisted for or provided by the user (support for [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonics will follow)


## Language Support

LDK Node is written in [Rust](https://www.rust-lang.org/) and may therefore be natively included in any `std` Rust program. Beyond its Rust API it also offers language bindings for Swift, Kotlin, and Python based on [UniFFI](https://github.com/mozilla/uniffi-rs/).

66 changes: 55 additions & 11 deletions
src/lib.rs

View file


Open in desktop

Comment thread
tnull marked this conversation as resolved.

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,14 +9,56 @@

#![crate_name = "ldk_node"]

//! A library providing a simplified API for the Lightning Dev Kit. While LDK itself provides a
//! highly configurable and adaptable interface, this API champions simplicity and ease of use over
//! configurability. To this end, it provides an opionated set of design choices and ready-to-go
//! default modules, while still enabling some configurability when dearly needed by the user:
//! - Chain data is accessed through an Esplora client.
//! - Wallet and channel states are persisted to disk.
//! - Gossip is retrieved over the P2P network.

//! # LDK Node
//! A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and
//! [BDK](https://bitcoindevkit.org/).
//!
//! LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a
//! small, simple, and straightforward interface that enables users to easily set up and run a
//! Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node
//! aims to be sufficiently modular and configurable to be useful for a variety of use cases.
//!
//! ## Getting Started
//!
//! The primary abstraction of the library is the [`Node`], which can be retrieved by setting up
//! and configuring a [`Builder`] to your liking and calling [`build`]. `Node` can then be
//! controlled via commands such as [`start`], [`stop`], [`connect_open_channel`],
//! [`send_payment`], etc.:
//!
//! ```no_run
//! use ldk_node::Builder;
//! use ldk_node::lightning_invoice::Invoice;
//! use std::str::FromStr;
//!
//! fn main() {
//! let node = Builder::new()
//! .set_network("testnet")
//! .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
//! .build();
//!
//! node.start().unwrap();
//!
//! let _funding_address = node.new_funding_address();
//!
//! // .. fund address ..
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
//!
//! node.stop().unwrap();
//! }
//! ```
//!
//! [`build`]: Builder::build
//! [`start`]: Node::start
//! [`stop`]: Node::stop
//! [`connect_open_channel`]: Node::connect_open_channel
//! [`send_payment`]: Node::send_payment
//!
#![deny(missing_docs)]
#![deny(broken_intra_doc_links)]
#![deny(private_intra_doc_links)]
Expand DownExpand Up@@ -273,7 +315,7 @@ impl Builder {
 config.network,
 database,
 )
 .expect("Failed to setup on-chain wallet");
 .expect("Failed to set up on-chain wallet");

 let tx_sync = Arc::new(EsploraSyncClient::new(
 config.esplora_server_url.clone(),
Expand DownExpand Up@@ -482,7 +524,7 @@ struct Runtime {
	stop_wallet_sync: Arc<AtomicBool>,
}

/// The main interface object of the simplified API, wrapping the necessary LDK and BDK functionalities.
/// The main interface object of LDK Node, wrapping the necessary LDK and BDK functionalities.
Comment thread
tnull marked this conversation as resolved.

///
/// Needs to be initialized and instantiated through [`Builder::build`].
pub struct Node {
Expand DownExpand Up@@ -716,12 +758,14 @@ impl Node {

	/// Blocks until the next event is available.
	///
	/// Note: this will always return the same event until handling is confirmed via [`Node::event_handled`].
	/// **Note:** this will always return the same event until handling is confirmed via [`Node::event_handled`].
	pub fn next_event(&self) -> Event {
 self.event_queue.next_event()
	}

	/// Confirm the last retrieved event handled.
	///
	/// **Note:** This **MUST** be called after each event has been handled.
	pub fn event_handled(&self) {
 self.event_queue.event_handled().unwrap();
	}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add initial README and crate-level docs by tnull · Pull Request #49 · lightningdevkit/ldk-node · GitHub
Skip to content
Add initial README and crate-level docs#49

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

 Merged

tnull
merged 3 commits into

from

Mar 22, 2023
 Merged


Add initial README and crate-level docs
#49
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
cafdda2

Add initial README and crate-level docs


tnull Mar 21, 2023
dc78b09

f Typo


tnull Mar 21, 2023
eb96580

f Address feedback, some formatting


tnull Mar 21, 2023

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


51 changes: 50 additions & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
# LDK Node
A ready-to-go node implementation built using LDK.
A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and [BDK](https://bitcoindevkit.org/).

LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a small, simple, and straightforward interface that enables users to easily set up and run a Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node aims to be sufficiently modular and configurable to be useful for a variety of use cases. 

## Getting Started

The primary abstraction of the library is the `Node`, which can be retrieved by setting up and configuring a `Builder` to your liking and calling `build()`. `Node` can then be controlled via commands such as `start`, `stop`, `connect_open_channel`, `send_payment`, etc.:

```rust
use ldk_node::Builder;
use ldk_node::lightning_invoice::Invoice;
use std::str::FromStr;

fn main() {
	let node = Builder::new()
 .set_network("testnet")
 .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
 .build();

	node.start().unwrap();

	let _funding_address = node.new_funding_address();

	// .. fund address ..

	node.sync_wallets().unwrap();

	node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();

	let invoice = Invoice::from_str("INVOICE_STR").unwrap();
	node.send_payment(invoice).unwrap();

	node.stop().unwrap();
}
```

## Modularity

LDK Node currently comes with a decidedly opionated set of design choices:

- On-chain data is handled by the integrated BDK wallet
- Chain data is accessed via Esplora (support for Electrum and `bitcoind` RPC will follow)
- Wallet and channel state is persisted to file system (support for SQLite will follow)
- Gossip data is sourced via Lightnings peer-to-peer network (support for [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) will follow)
- Entropy for the Lightning and on-chain wallets may be generated and persisted for or provided by the user (support for [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonics will follow)


## Language Support

LDK Node is written in [Rust](https://www.rust-lang.org/) and may therefore be natively included in any `std` Rust program. Beyond its Rust API it also offers language bindings for Swift, Kotlin, and Python based on [UniFFI](https://github.com/mozilla/uniffi-rs/).

66 changes: 55 additions & 11 deletions
src/lib.rs

View file


Open in desktop

Comment thread
tnull marked this conversation as resolved.

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,14 +9,56 @@

#![crate_name = "ldk_node"]

//! A library providing a simplified API for the Lightning Dev Kit. While LDK itself provides a
//! highly configurable and adaptable interface, this API champions simplicity and ease of use over
//! configurability. To this end, it provides an opionated set of design choices and ready-to-go
//! default modules, while still enabling some configurability when dearly needed by the user:
//! - Chain data is accessed through an Esplora client.
//! - Wallet and channel states are persisted to disk.
//! - Gossip is retrieved over the P2P network.

//! # LDK Node
//! A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and
//! [BDK](https://bitcoindevkit.org/).
//!
//! LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a
//! small, simple, and straightforward interface that enables users to easily set up and run a
//! Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node
//! aims to be sufficiently modular and configurable to be useful for a variety of use cases.
//!
//! ## Getting Started
//!
//! The primary abstraction of the library is the [`Node`], which can be retrieved by setting up
//! and configuring a [`Builder`] to your liking and calling [`build`]. `Node` can then be
//! controlled via commands such as [`start`], [`stop`], [`connect_open_channel`],
//! [`send_payment`], etc.:
//!
//! ```no_run
//! use ldk_node::Builder;
//! use ldk_node::lightning_invoice::Invoice;
//! use std::str::FromStr;
//!
//! fn main() {
//! let node = Builder::new()
//! .set_network("testnet")
//! .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
//! .build();
//!
//! node.start().unwrap();
//!
//! let _funding_address = node.new_funding_address();
//!
//! // .. fund address ..
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
//!
//! node.stop().unwrap();
//! }
//! ```
//!
//! [`build`]: Builder::build
//! [`start`]: Node::start
//! [`stop`]: Node::stop
//! [`connect_open_channel`]: Node::connect_open_channel
//! [`send_payment`]: Node::send_payment
//!
#![deny(missing_docs)]
#![deny(broken_intra_doc_links)]
#![deny(private_intra_doc_links)]
Expand DownExpand Up@@ -273,7 +315,7 @@ impl Builder {
 config.network,
 database,
 )
 .expect("Failed to setup on-chain wallet");
 .expect("Failed to set up on-chain wallet");

 let tx_sync = Arc::new(EsploraSyncClient::new(
 config.esplora_server_url.clone(),
Expand DownExpand Up@@ -482,7 +524,7 @@ struct Runtime {
	stop_wallet_sync: Arc<AtomicBool>,
}

/// The main interface object of the simplified API, wrapping the necessary LDK and BDK functionalities.
/// The main interface object of LDK Node, wrapping the necessary LDK and BDK functionalities.
Comment thread
tnull marked this conversation as resolved.

///
/// Needs to be initialized and instantiated through [`Builder::build`].
pub struct Node {
Expand DownExpand Up@@ -716,12 +758,14 @@ impl Node {

	/// Blocks until the next event is available.
	///
	/// Note: this will always return the same event until handling is confirmed via [`Node::event_handled`].
	/// **Note:** this will always return the same event until handling is confirmed via [`Node::event_handled`].
	pub fn next_event(&self) -> Event {
 self.event_queue.next_event()
	}

	/// Confirm the last retrieved event handled.
	///
	/// **Note:** This **MUST** be called after each event has been handled.
	pub fn event_handled(&self) {
 self.event_queue.event_handled().unwrap();
	}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add initial README and crate-level docs by tnull · Pull Request #49 · lightningdevkit/ldk-node · GitHub
Skip to content
Add initial README and crate-level docs#49

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

 Merged

tnull
merged 3 commits into

from

Mar 22, 2023
 Merged


Add initial README and crate-level docs
#49
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
cafdda2

Add initial README and crate-level docs


tnull Mar 21, 2023
dc78b09

f Typo


tnull Mar 21, 2023
eb96580

f Address feedback, some formatting


tnull Mar 21, 2023

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


51 changes: 50 additions & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
# LDK Node
A ready-to-go node implementation built using LDK.
A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and [BDK](https://bitcoindevkit.org/).

LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a small, simple, and straightforward interface that enables users to easily set up and run a Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node aims to be sufficiently modular and configurable to be useful for a variety of use cases. 

## Getting Started

The primary abstraction of the library is the `Node`, which can be retrieved by setting up and configuring a `Builder` to your liking and calling `build()`. `Node` can then be controlled via commands such as `start`, `stop`, `connect_open_channel`, `send_payment`, etc.:

```rust
use ldk_node::Builder;
use ldk_node::lightning_invoice::Invoice;
use std::str::FromStr;

fn main() {
	let node = Builder::new()
 .set_network("testnet")
 .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
 .build();

	node.start().unwrap();

	let _funding_address = node.new_funding_address();

	// .. fund address ..

	node.sync_wallets().unwrap();

	node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();

	let invoice = Invoice::from_str("INVOICE_STR").unwrap();
	node.send_payment(invoice).unwrap();

	node.stop().unwrap();
}
```

## Modularity

LDK Node currently comes with a decidedly opionated set of design choices:

- On-chain data is handled by the integrated BDK wallet
- Chain data is accessed via Esplora (support for Electrum and `bitcoind` RPC will follow)
- Wallet and channel state is persisted to file system (support for SQLite will follow)
- Gossip data is sourced via Lightnings peer-to-peer network (support for [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) will follow)
- Entropy for the Lightning and on-chain wallets may be generated and persisted for or provided by the user (support for [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonics will follow)


## Language Support

LDK Node is written in [Rust](https://www.rust-lang.org/) and may therefore be natively included in any `std` Rust program. Beyond its Rust API it also offers language bindings for Swift, Kotlin, and Python based on [UniFFI](https://github.com/mozilla/uniffi-rs/).

66 changes: 55 additions & 11 deletions
src/lib.rs

View file


Open in desktop

Comment thread
tnull marked this conversation as resolved.

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,14 +9,56 @@

#![crate_name = "ldk_node"]

//! A library providing a simplified API for the Lightning Dev Kit. While LDK itself provides a
//! highly configurable and adaptable interface, this API champions simplicity and ease of use over
//! configurability. To this end, it provides an opionated set of design choices and ready-to-go
//! default modules, while still enabling some configurability when dearly needed by the user:
//! - Chain data is accessed through an Esplora client.
//! - Wallet and channel states are persisted to disk.
//! - Gossip is retrieved over the P2P network.

//! # LDK Node
//! A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and
//! [BDK](https://bitcoindevkit.org/).
//!
//! LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a
//! small, simple, and straightforward interface that enables users to easily set up and run a
//! Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node
//! aims to be sufficiently modular and configurable to be useful for a variety of use cases.
//!
//! ## Getting Started
//!
//! The primary abstraction of the library is the [`Node`], which can be retrieved by setting up
//! and configuring a [`Builder`] to your liking and calling [`build`]. `Node` can then be
//! controlled via commands such as [`start`], [`stop`], [`connect_open_channel`],
//! [`send_payment`], etc.:
//!
//! ```no_run
//! use ldk_node::Builder;
//! use ldk_node::lightning_invoice::Invoice;
//! use std::str::FromStr;
//!
//! fn main() {
//! let node = Builder::new()
//! .set_network("testnet")
//! .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
//! .build();
//!
//! node.start().unwrap();
//!
//! let _funding_address = node.new_funding_address();
//!
//! // .. fund address ..
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
//!
//! node.stop().unwrap();
//! }
//! ```
//!
//! [`build`]: Builder::build
//! [`start`]: Node::start
//! [`stop`]: Node::stop
//! [`connect_open_channel`]: Node::connect_open_channel
//! [`send_payment`]: Node::send_payment
//!
#![deny(missing_docs)]
#![deny(broken_intra_doc_links)]
#![deny(private_intra_doc_links)]
Expand DownExpand Up@@ -273,7 +315,7 @@ impl Builder {
 config.network,
 database,
 )
 .expect("Failed to setup on-chain wallet");
 .expect("Failed to set up on-chain wallet");

 let tx_sync = Arc::new(EsploraSyncClient::new(
 config.esplora_server_url.clone(),
Expand DownExpand Up@@ -482,7 +524,7 @@ struct Runtime {
	stop_wallet_sync: Arc<AtomicBool>,
}

/// The main interface object of the simplified API, wrapping the necessary LDK and BDK functionalities.
/// The main interface object of LDK Node, wrapping the necessary LDK and BDK functionalities.
Comment thread
tnull marked this conversation as resolved.

///
/// Needs to be initialized and instantiated through [`Builder::build`].
pub struct Node {
Expand DownExpand Up@@ -716,12 +758,14 @@ impl Node {

	/// Blocks until the next event is available.
	///
	/// Note: this will always return the same event until handling is confirmed via [`Node::event_handled`].
	/// **Note:** this will always return the same event until handling is confirmed via [`Node::event_handled`].
	pub fn next_event(&self) -> Event {
 self.event_queue.next_event()
	}

	/// Confirm the last retrieved event handled.
	///
	/// **Note:** This **MUST** be called after each event has been handled.
	pub fn event_handled(&self) {
 self.event_queue.event_handled().unwrap();
	}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add initial README and crate-level docs by tnull · Pull Request #49 · lightningdevkit/ldk-node · GitHub
Skip to content
Add initial README and crate-level docs#49

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

 Merged

tnull
merged 3 commits into

from

Mar 22, 2023
 Merged


Add initial README and crate-level docs
#49
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
cafdda2

Add initial README and crate-level docs


tnull Mar 21, 2023
dc78b09

f Typo


tnull Mar 21, 2023
eb96580

f Address feedback, some formatting


tnull Mar 21, 2023

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


51 changes: 50 additions & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
# LDK Node
A ready-to-go node implementation built using LDK.
A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and [BDK](https://bitcoindevkit.org/).

LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a small, simple, and straightforward interface that enables users to easily set up and run a Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node aims to be sufficiently modular and configurable to be useful for a variety of use cases. 

## Getting Started

The primary abstraction of the library is the `Node`, which can be retrieved by setting up and configuring a `Builder` to your liking and calling `build()`. `Node` can then be controlled via commands such as `start`, `stop`, `connect_open_channel`, `send_payment`, etc.:

```rust
use ldk_node::Builder;
use ldk_node::lightning_invoice::Invoice;
use std::str::FromStr;

fn main() {
	let node = Builder::new()
 .set_network("testnet")
 .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
 .build();

	node.start().unwrap();

	let _funding_address = node.new_funding_address();

	// .. fund address ..

	node.sync_wallets().unwrap();

	node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();

	let invoice = Invoice::from_str("INVOICE_STR").unwrap();
	node.send_payment(invoice).unwrap();

	node.stop().unwrap();
}
```

## Modularity

LDK Node currently comes with a decidedly opionated set of design choices:

- On-chain data is handled by the integrated BDK wallet
- Chain data is accessed via Esplora (support for Electrum and `bitcoind` RPC will follow)
- Wallet and channel state is persisted to file system (support for SQLite will follow)
- Gossip data is sourced via Lightnings peer-to-peer network (support for [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) will follow)
- Entropy for the Lightning and on-chain wallets may be generated and persisted for or provided by the user (support for [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonics will follow)


## Language Support

LDK Node is written in [Rust](https://www.rust-lang.org/) and may therefore be natively included in any `std` Rust program. Beyond its Rust API it also offers language bindings for Swift, Kotlin, and Python based on [UniFFI](https://github.com/mozilla/uniffi-rs/).

66 changes: 55 additions & 11 deletions
src/lib.rs

View file


Open in desktop

Comment thread
tnull marked this conversation as resolved.

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,14 +9,56 @@

#![crate_name = "ldk_node"]

//! A library providing a simplified API for the Lightning Dev Kit. While LDK itself provides a
//! highly configurable and adaptable interface, this API champions simplicity and ease of use over
//! configurability. To this end, it provides an opionated set of design choices and ready-to-go
//! default modules, while still enabling some configurability when dearly needed by the user:
//! - Chain data is accessed through an Esplora client.
//! - Wallet and channel states are persisted to disk.
//! - Gossip is retrieved over the P2P network.

//! # LDK Node
//! A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and
//! [BDK](https://bitcoindevkit.org/).
//!
//! LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a
//! small, simple, and straightforward interface that enables users to easily set up and run a
//! Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node
//! aims to be sufficiently modular and configurable to be useful for a variety of use cases.
//!
//! ## Getting Started
//!
//! The primary abstraction of the library is the [`Node`], which can be retrieved by setting up
//! and configuring a [`Builder`] to your liking and calling [`build`]. `Node` can then be
//! controlled via commands such as [`start`], [`stop`], [`connect_open_channel`],
//! [`send_payment`], etc.:
//!
//! ```no_run
//! use ldk_node::Builder;
//! use ldk_node::lightning_invoice::Invoice;
//! use std::str::FromStr;
//!
//! fn main() {
//! let node = Builder::new()
//! .set_network("testnet")
//! .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
//! .build();
//!
//! node.start().unwrap();
//!
//! let _funding_address = node.new_funding_address();
//!
//! // .. fund address ..
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
//!
//! node.stop().unwrap();
//! }
//! ```
//!
//! [`build`]: Builder::build
//! [`start`]: Node::start
//! [`stop`]: Node::stop
//! [`connect_open_channel`]: Node::connect_open_channel
//! [`send_payment`]: Node::send_payment
//!
#![deny(missing_docs)]
#![deny(broken_intra_doc_links)]
#![deny(private_intra_doc_links)]
Expand DownExpand Up@@ -273,7 +315,7 @@ impl Builder {
 config.network,
 database,
 )
 .expect("Failed to setup on-chain wallet");
 .expect("Failed to set up on-chain wallet");

 let tx_sync = Arc::new(EsploraSyncClient::new(
 config.esplora_server_url.clone(),
Expand DownExpand Up@@ -482,7 +524,7 @@ struct Runtime {
	stop_wallet_sync: Arc<AtomicBool>,
}

/// The main interface object of the simplified API, wrapping the necessary LDK and BDK functionalities.
/// The main interface object of LDK Node, wrapping the necessary LDK and BDK functionalities.
Comment thread
tnull marked this conversation as resolved.

///
/// Needs to be initialized and instantiated through [`Builder::build`].
pub struct Node {
Expand DownExpand Up@@ -716,12 +758,14 @@ impl Node {

	/// Blocks until the next event is available.
	///
	/// Note: this will always return the same event until handling is confirmed via [`Node::event_handled`].
	/// **Note:** this will always return the same event until handling is confirmed via [`Node::event_handled`].
	pub fn next_event(&self) -> Event {
 self.event_queue.next_event()
	}

	/// Confirm the last retrieved event handled.
	///
	/// **Note:** This **MUST** be called after each event has been handled.
	pub fn event_handled(&self) {
 self.event_queue.event_handled().unwrap();
	}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add initial README and crate-level docs by tnull · Pull Request #49 · lightningdevkit/ldk-node · GitHub
Skip to content
Add initial README and crate-level docs#49

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

 Merged

tnull
merged 3 commits into

from

Mar 22, 2023
 Merged


Add initial README and crate-level docs
#49
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
cafdda2

Add initial README and crate-level docs


tnull Mar 21, 2023
dc78b09

f Typo


tnull Mar 21, 2023
eb96580

f Address feedback, some formatting


tnull Mar 21, 2023

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


51 changes: 50 additions & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
# LDK Node
A ready-to-go node implementation built using LDK.
A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and [BDK](https://bitcoindevkit.org/).

LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a small, simple, and straightforward interface that enables users to easily set up and run a Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node aims to be sufficiently modular and configurable to be useful for a variety of use cases. 

## Getting Started

The primary abstraction of the library is the `Node`, which can be retrieved by setting up and configuring a `Builder` to your liking and calling `build()`. `Node` can then be controlled via commands such as `start`, `stop`, `connect_open_channel`, `send_payment`, etc.:

```rust
use ldk_node::Builder;
use ldk_node::lightning_invoice::Invoice;
use std::str::FromStr;

fn main() {
	let node = Builder::new()
 .set_network("testnet")
 .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
 .build();

	node.start().unwrap();

	let _funding_address = node.new_funding_address();

	// .. fund address ..

	node.sync_wallets().unwrap();

	node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();

	let invoice = Invoice::from_str("INVOICE_STR").unwrap();
	node.send_payment(invoice).unwrap();

	node.stop().unwrap();
}
```

## Modularity

LDK Node currently comes with a decidedly opionated set of design choices:

- On-chain data is handled by the integrated BDK wallet
- Chain data is accessed via Esplora (support for Electrum and `bitcoind` RPC will follow)
- Wallet and channel state is persisted to file system (support for SQLite will follow)
- Gossip data is sourced via Lightnings peer-to-peer network (support for [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) will follow)
- Entropy for the Lightning and on-chain wallets may be generated and persisted for or provided by the user (support for [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonics will follow)


## Language Support

LDK Node is written in [Rust](https://www.rust-lang.org/) and may therefore be natively included in any `std` Rust program. Beyond its Rust API it also offers language bindings for Swift, Kotlin, and Python based on [UniFFI](https://github.com/mozilla/uniffi-rs/).

66 changes: 55 additions & 11 deletions
src/lib.rs

View file


Open in desktop

Comment thread
tnull marked this conversation as resolved.

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,14 +9,56 @@

#![crate_name = "ldk_node"]

//! A library providing a simplified API for the Lightning Dev Kit. While LDK itself provides a
//! highly configurable and adaptable interface, this API champions simplicity and ease of use over
//! configurability. To this end, it provides an opionated set of design choices and ready-to-go
//! default modules, while still enabling some configurability when dearly needed by the user:
//! - Chain data is accessed through an Esplora client.
//! - Wallet and channel states are persisted to disk.
//! - Gossip is retrieved over the P2P network.

//! # LDK Node
//! A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and
//! [BDK](https://bitcoindevkit.org/).
//!
//! LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a
//! small, simple, and straightforward interface that enables users to easily set up and run a
//! Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node
//! aims to be sufficiently modular and configurable to be useful for a variety of use cases.
//!
//! ## Getting Started
//!
//! The primary abstraction of the library is the [`Node`], which can be retrieved by setting up
//! and configuring a [`Builder`] to your liking and calling [`build`]. `Node` can then be
//! controlled via commands such as [`start`], [`stop`], [`connect_open_channel`],
//! [`send_payment`], etc.:
//!
//! ```no_run
//! use ldk_node::Builder;
//! use ldk_node::lightning_invoice::Invoice;
//! use std::str::FromStr;
//!
//! fn main() {
//! let node = Builder::new()
//! .set_network("testnet")
//! .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
//! .build();
//!
//! node.start().unwrap();
//!
//! let _funding_address = node.new_funding_address();
//!
//! // .. fund address ..
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
//!
//! node.stop().unwrap();
//! }
//! ```
//!
//! [`build`]: Builder::build
//! [`start`]: Node::start
//! [`stop`]: Node::stop
//! [`connect_open_channel`]: Node::connect_open_channel
//! [`send_payment`]: Node::send_payment
//!
#![deny(missing_docs)]
#![deny(broken_intra_doc_links)]
#![deny(private_intra_doc_links)]
Expand DownExpand Up@@ -273,7 +315,7 @@ impl Builder {
 config.network,
 database,
 )
 .expect("Failed to setup on-chain wallet");
 .expect("Failed to set up on-chain wallet");

 let tx_sync = Arc::new(EsploraSyncClient::new(
 config.esplora_server_url.clone(),
Expand DownExpand Up@@ -482,7 +524,7 @@ struct Runtime {
	stop_wallet_sync: Arc<AtomicBool>,
}

/// The main interface object of the simplified API, wrapping the necessary LDK and BDK functionalities.
/// The main interface object of LDK Node, wrapping the necessary LDK and BDK functionalities.
Comment thread
tnull marked this conversation as resolved.

///
/// Needs to be initialized and instantiated through [`Builder::build`].
pub struct Node {
Expand DownExpand Up@@ -716,12 +758,14 @@ impl Node {

	/// Blocks until the next event is available.
	///
	/// Note: this will always return the same event until handling is confirmed via [`Node::event_handled`].
	/// **Note:** this will always return the same event until handling is confirmed via [`Node::event_handled`].
	pub fn next_event(&self) -> Event {
 self.event_queue.next_event()
	}

	/// Confirm the last retrieved event handled.
	///
	/// **Note:** This **MUST** be called after each event has been handled.
	pub fn event_handled(&self) {
 self.event_queue.event_handled().unwrap();
	}
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add initial README and crate-level docs by tnull · Pull Request #49 · lightningdevkit/ldk-node · GitHub
Skip to content
Add initial README and crate-level docs#49

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

 Merged

tnull
merged 3 commits into

from

Mar 22, 2023
 Merged


Add initial README and crate-level docs
#49
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
cafdda2

Add initial README and crate-level docs


tnull Mar 21, 2023
dc78b09

f Typo


tnull Mar 21, 2023
eb96580

f Address feedback, some formatting


tnull Mar 21, 2023

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


51 changes: 50 additions & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,51 @@
# LDK Node
A ready-to-go node implementation built using LDK.
A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and [BDK](https://bitcoindevkit.org/).

LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a small, simple, and straightforward interface that enables users to easily set up and run a Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node aims to be sufficiently modular and configurable to be useful for a variety of use cases. 

## Getting Started

The primary abstraction of the library is the `Node`, which can be retrieved by setting up and configuring a `Builder` to your liking and calling `build()`. `Node` can then be controlled via commands such as `start`, `stop`, `connect_open_channel`, `send_payment`, etc.:

```rust
use ldk_node::Builder;
use ldk_node::lightning_invoice::Invoice;
use std::str::FromStr;

fn main() {
	let node = Builder::new()
 .set_network("testnet")
 .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
 .build();

	node.start().unwrap();

	let _funding_address = node.new_funding_address();

	// .. fund address ..

	node.sync_wallets().unwrap();

	node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();

	let invoice = Invoice::from_str("INVOICE_STR").unwrap();
	node.send_payment(invoice).unwrap();

	node.stop().unwrap();
}
```

## Modularity

LDK Node currently comes with a decidedly opionated set of design choices:

- On-chain data is handled by the integrated BDK wallet
- Chain data is accessed via Esplora (support for Electrum and `bitcoind` RPC will follow)
- Wallet and channel state is persisted to file system (support for SQLite will follow)
- Gossip data is sourced via Lightnings peer-to-peer network (support for [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) will follow)
- Entropy for the Lightning and on-chain wallets may be generated and persisted for or provided by the user (support for [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonics will follow)


## Language Support

LDK Node is written in [Rust](https://www.rust-lang.org/) and may therefore be natively included in any `std` Rust program. Beyond its Rust API it also offers language bindings for Swift, Kotlin, and Python based on [UniFFI](https://github.com/mozilla/uniffi-rs/).

66 changes: 55 additions & 11 deletions
src/lib.rs

View file


Open in desktop

Comment thread
tnull marked this conversation as resolved.

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,14 +9,56 @@

#![crate_name = "ldk_node"]

//! A library providing a simplified API for the Lightning Dev Kit. While LDK itself provides a
//! highly configurable and adaptable interface, this API champions simplicity and ease of use over
//! configurability. To this end, it provides an opionated set of design choices and ready-to-go
//! default modules, while still enabling some configurability when dearly needed by the user:
//! - Chain data is accessed through an Esplora client.
//! - Wallet and channel states are persisted to disk.
//! - Gossip is retrieved over the P2P network.

//! # LDK Node
//! A ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org/) and
//! [BDK](https://bitcoindevkit.org/).
//!
//! LDK Node is a non-custodial Lightning node in library form. Its central goal is to provide a
//! small, simple, and straightforward interface that enables users to easily set up and run a
//! Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node
//! aims to be sufficiently modular and configurable to be useful for a variety of use cases.
//!
//! ## Getting Started
//!
//! The primary abstraction of the library is the [`Node`], which can be retrieved by setting up
//! and configuring a [`Builder`] to your liking and calling [`build`]. `Node` can then be
//! controlled via commands such as [`start`], [`stop`], [`connect_open_channel`],
//! [`send_payment`], etc.:
//!
//! ```no_run
//! use ldk_node::Builder;
//! use ldk_node::lightning_invoice::Invoice;
//! use std::str::FromStr;
//!
//! fn main() {
//! let node = Builder::new()
//! .set_network("testnet")
//! .set_esplora_server_url("https://blockstream.info/testnet/api".to_string())
//! .build();
//!
//! node.start().unwrap();
//!
//! let _funding_address = node.new_funding_address();
//!
//! // .. fund address ..
//!
//! node.sync_wallets().unwrap();
//!
//! node.connect_open_channel("NODE_ID@PEER_ADDR:PORT", 10000, false).unwrap();
//!
//! let invoice = Invoice::from_str("INVOICE_STR").unwrap();
//! node.send_payment(invoice).unwrap();
//!
//! node.stop().unwrap();
//! }
//! ```
//!
//! [`build`]: Builder::build
//! [`start`]: Node::start
//! [`stop`]: Node::stop
//! [`connect_open_channel`]: Node::connect_open_channel
//! [`send_payment`]: Node::send_payment
//!
#![deny(missing_docs)]
#![deny(broken_intra_doc_links)]
#![deny(private_intra_doc_links)]
Expand DownExpand Up@@ -273,7 +315,7 @@ impl Builder {
 config.network,
 database,
 )
 .expect("Failed to setup on-chain wallet");
 .expect("Failed to set up on-chain wallet");

 let tx_sync = Arc::new(EsploraSyncClient::new(
 config.esplora_server_url.clone(),
Expand DownExpand Up@@ -482,7 +524,7 @@ struct Runtime {
	stop_wallet_sync: Arc<AtomicBool>,
}

/// The main interface object of the simplified API, wrapping the necessary LDK and BDK functionalities.
/// The main interface object of LDK Node, wrapping the necessary LDK and BDK functionalities.
Comment thread
tnull marked this conversation as resolved.

///
/// Needs to be initialized and instantiated through [`Builder::build`].
pub struct Node {
Expand DownExpand Up@@ -716,12 +758,14 @@ impl Node {

	/// Blocks until the next event is available.
	///
	/// Note: this will always return the same event until handling is confirmed via [`Node::event_handled`].
	/// **Note:** this will always return the same event until handling is confirmed via [`Node::event_handled`].
	pub fn next_event(&self) -> Event {
 self.event_queue.next_event()
	}

	/// Confirm the last retrieved event handled.
	///
	/// **Note:** This **MUST** be called after each event has been handled.
	pub fn event_handled(&self) {
 self.event_queue.event_handled().unwrap();
	}
Expand Down