Skip to content

Commit bc411c7

Browse files
committed
docs: update documentation for ldk-node 0.7.0 release
- Update CHANGELOG.md with new APIs and features - Update README.md with version 0.7.0 information - Add temp/ to .gitignore
1 parent d0d526e commit bc411c7

File tree

3 files changed

+35
-6
lines changed

3 files changed

+35
-6
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ migrate_working_dir/
2020
# VS Code which you may wish to be included in version control, so this line
2121
# is commented out by default.
2222
.vscode/
23+
temp/
2324

2425
# Flutter/Dart/Pub related
2526
# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.

CHANGELOG.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
1-
## [0.6.1]
2-
Updated `ldk-node` to `0.6.1`.
1+
## [0.7.0]
2+
Updated `ldk-node` to `0.7.0`.
3+
4+
### APIs added
5+
6+
- **Channel Splicing**: Experimental support for channel splicing via `spliceIn()` and `spliceOut()` methods
7+
- **Async Payments**: Static invoice support with `receiveStaticInvoice()` and `sendStaticInvoice()` methods
8+
- **Bitcoin Core REST**: New chain data source via `ChainDataSourceConfig.bitcoindRest()`
9+
- **Esplora with Headers**: `ChainDataSourceConfig.esploraWithHeaders()` for custom HTTP headers
10+
- **Pathfinding Scores**: `importPathfindingScores()` and `mergePathfindingScores()` methods
11+
- **Custom Preimage**: `sendWithPreimage()` for spontaneous payments with custom preimage
12+
- **Route Parameters**: `RouteParametersConfig` support for BOLT12 payments and refunds
13+
- **Mnemonic Word Count**: `Mnemonic.generateWithWordCount()` for configurable entropy
14+
15+
### Notes
16+
- Splicing-related transactions may still get misclassified in the payment store
17+
- Liquidity service data is now persisted across restarts
18+
- Improved shutdown robustness and reduced IO load via differential channel monitor updates
19+
20+
## [0.6.2]
21+
Updated `ldk-node` to `0.6.2`.
322

423
### Notes
524
- No breaking changes and no new functions exposed.

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,28 @@ A Flutter library for [LDK Node](https://github.com/lightningdevkit/ldk-node), a
2828

2929
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.
3030

31-
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, connectOpenChannel, sendPayment, etc.:
31+
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.
3232

33-
This release covers the same API from LDK Node 0.1.0 Rust. It has support for sourcing chain data via an Esplora server, filesystem persistence, gossip sourcing via the Lightning peer-to-peer network, and configurable entropy sources for the integrated LDK and BDK-based wallets.
33+
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.
3434

35-
Please note: This release is considered experimental, and should not be run in production
35+
### Key Features
36+
37+
- **Multiple Chain Data Sources**: Esplora, Electrum, and Bitcoin Core (RPC & REST) backends
38+
- **Channel Splicing**: Experimental support via `spliceIn()` and `spliceOut()` methods
39+
- **Async Payments**: Static invoice support with `receiveStaticInvoice()` and `sendStaticInvoice()`
40+
- **BOLT11 & BOLT12**: Full support for Lightning invoices, offers, and refunds
41+
- **LSP Integration**: LSPS2 just-in-time (JIT) channel support for inbound liquidity
42+
- **Unified QR Payments**: Generate and pay unified QR codes
43+
- **Custom Fee Rates**: Comprehensive `FeeRate` class for fine-grained fee control
44+
- **Pathfinding Scores**: Import and merge pathfinding scores for optimized routing
3645
### How to use ldk_node
3746

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

4049

4150
```dart
4251
dependencies:
43-
ldk_node: ^0.4.2
52+
ldk_node: ^0.7.0
4453
```
4554
or add from pub.dev using `pub add` command
4655

0 commit comments

Comments
 (0)