Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lightningdevkit/ldk-node

A ready-to-go node implementation built using LDK.
https://github.com/lightningdevkit/ldk-node

Last synced: 4 days ago
JSON representation

A ready-to-go node implementation built using LDK.

Host: GitHub
URL: https://github.com/lightningdevkit/ldk-node
Owner: lightningdevkit
License: other
Created: 2022-08-26T13:00:53.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-12-09T08:12:37.000Z (about 1 month ago)
Last Synced: 2025-01-03T21:04:26.880Z (11 days ago)
Language: Rust
Homepage:
Size: 1.28 MB
Stars: 154
Watchers: 14
Forks: 86
Open Issues: 58
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE

Awesome Lists containing this project

awesome-bolt12 - LDK Node - A ready-to-go node implementation built using LDK. (Ecosystem / Lightning Implementations)

README

        # LDK Node

[![Crate](https://img.shields.io/crates/v/ldk-node.svg?logo=rust)](https://crates.io/crates/ldk-node)

[![Documentation](https://img.shields.io/static/v1?logo=read-the-docs&label=docs.rs&message=ldk-node&color=informational)](https://docs.rs/ldk-node)

[![Maven Central Android](https://img.shields.io/maven-central/v/org.lightningdevkit/ldk-node-android)](https://central.sonatype.com/artifact/org.lightningdevkit/ldk-node-android)

[![Maven Central JVM](https://img.shields.io/maven-central/v/org.lightningdevkit/ldk-node-jvm)](https://central.sonatype.com/artifact/org.lightningdevkit/ldk-node-jvm)

[![Security Audit](https://github.com/lightningdevkit/ldk-node/actions/workflows/audit.yml/badge.svg)](https://github.com/lightningdevkit/ldk-node/actions/workflows/audit.yml)

A ready-to-go Lightning node library built using [LDK][ldk] and [BDK][bdk].

LDK Node is a self-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`][api_docs_node], which can be retrieved by setting up and configuring a [`Builder`][api_docs_builder] to your liking and calling one of the `build` methods. `Node` can then be controlled via commands such as `start`, `stop`, `open_channel`, `send`, etc.

```rust

use ldk_node::Builder;

use ldk_node::lightning_invoice::Bolt11Invoice;

use ldk_node::lightning::ln::msgs::SocketAddress;

use ldk_node::bitcoin::secp256k1::PublicKey;

use ldk_node::bitcoin::Network;

use std::str::FromStr;

fn main() {

	let mut builder = Builder::new();

	builder.set_network(Network::Testnet);

	builder.set_chain_source_esplora("https://blockstream.info/testnet/api".to_string(), None);

	builder.set_gossip_source_rgs("https://rapidsync.lightningdevkit.org/testnet/snapshot".to_string());

	let node = builder.build().unwrap();

	node.start().unwrap();

	let funding_address = node.onchain_payment().new_address();

	// .. fund address ..

	let node_id = PublicKey::from_str("NODE_ID").unwrap();

	let node_addr = SocketAddress::from_str("IP_ADDR:PORT").unwrap();

	node.open_channel(node_id, node_addr, 10000, None, None).unwrap();

	let event = node.wait_next_event();

	println!("EVENT: {:?}", event);

	node.event_handled();

	let invoice = Bolt11Invoice::from_str("INVOICE_STR").unwrap();

	node.bolt11_payment().send(&invoice).unwrap();

	node.stop().unwrap();

}

```

## Modularity

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

- On-chain data is handled by the integrated [BDK][bdk] wallet.

- Chain data may currently be sourced from the Bitcoin Core RPC interface or an [Esplora][esplora] server, while support for Electrum will follow soon.

- Wallet and channel state may be persisted to an [SQLite][sqlite] database, to file system, or to a custom back-end to be implemented by the user.

- Gossip data may be sourced via Lightning's peer-to-peer network or the [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) protocol.

- Entropy for the Lightning and on-chain wallets may be sourced from raw bytes or a [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonic. In addition, LDK Node offers the means to generate and persist the entropy bytes to disk.

## Language Support

LDK Node itself is written in [Rust][rust] and may therefore be natively added as a library dependency to any `std` Rust program. However, beyond its Rust API it also offers language bindings for [Swift][swift], [Kotlin][kotlin], and [Python][python] based on the [UniFFI](https://github.com/mozilla/uniffi-rs/). Moreover, [Flutter bindings][flutter_bindings] are also available.

## MSRV

The Minimum Supported Rust Version (MSRV) is currently 1.63.0.

[api_docs]: https://docs.rs/ldk-node/*/ldk_node/

[api_docs_node]: https://docs.rs/ldk-node/*/ldk_node/struct.Node.html

[api_docs_builder]: https://docs.rs/ldk-node/*/ldk_node/struct.Builder.html

[rust_crate]: https://crates.io/

[ldk]: https://lightningdevkit.org/

[bdk]: https://bitcoindevkit.org/

[esplora]: https://github.com/Blockstream/esplora

[sqlite]: https://sqlite.org/

[rust]: https://www.rust-lang.org/

[swift]: https://www.swift.org/

[kotlin]: https://kotlinlang.org/

[python]: https://www.python.org/

[flutter_bindings]: https://github.com/LtbLightning/ldk-node-flutter