ldk-node-flutter

KO | EN

gitlite — search

#react #golang #java #hacktoberfest #docker #python #theme #php #minecraft #linux #password #android

ldk-node-flutter

★ 45 Open GitHub ↗

Lightning Development Kit Node library for Flutter

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## LDK_Node

A Flutter library for [LDK Node](https://github.com/lightningdevkit/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. 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.

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, openChannel, sendPayment, etc.

This release covers the API from LDK Node 0.7.0 Rust. It has support for sourcing chain data via Esplora, Electrum, or Bitcoin Core RPC/REST backends, filesystem persistence, gossip sourcing via the Lightning peer-to-peer network, and configurable entropy sources for the integrated LDK and BDK-based wallets.

### Key Features

- **Multiple Chain Data Sources**: Esplora, Electrum, and Bitcoin Core (RPC & REST) backends
- **Channel Splicing**: Experimental support via `spliceIn()` and `spliceOut()` methods
- **Async Payments**: Static invoice support with `receiveStaticInvoice()` and `sendStaticInvoice()`
- **BOLT11 & BOLT12**: Full support for Lightning invoices, offers, and refunds
- **LSP Integration**: LSPS2 just-in-time (JIT) channel support for inbound liquidity
- **Unified QR Payments**: Generate and pay unified QR codes
- **Custom Fee Rates**: Comprehensive `FeeRate` class for fine-grained fee control
- **Pathfinding Scores**: Import and merge pathfinding scores for optimized routing
### How to use ldk_node

To use the `ldk_node` package in your project, add it as a dependency in your project's pubspec.yaml:

```dart
dependencies:
  ldk_node: ^0.7.0
```
or add from pub.dev using `pub add` command

```
  flutter pub add ldk_node
```

### Examples

### Build, Start & Sync the local node

```dart
import 'package:ldk_node/ldk_node.dart';

// ....

// Path to a directory where the application may place data that is user-generated
final path = "${directory.path}/alice's_node";

// For a node on the testnet network with default config and service 
// esploraUrl: "https://mempool.space/testnet/api";
Builder builder = Builder.testnet()
                         .setStorageDirPath(path) 
                         .setEntropyBip39Mnemonic( 
                                    mnemonic: Mnemonic(
                                                   'certain sense kiss guide crumble hint transfer crime much stereo warm coral'));
    final node  = await builder.build();

// Starting the node
await node.start();

// Syncing the node
await node.syncWallets();

```

### References:
- Setting up a local Esplora instance for testing:
https://bitcoin.stackexchange.com/questions/116937/how-do-i-setup-an-esplora-instance-for-local-testing/116938#116938

ldk-node-flutter

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README