Skip to content

Commit cd2a812

Browse files
Merge pull request #20 from LtbLightning/v0.1.2
V0.1.2
2 parents 500b893 + 290fb22 commit cd2a812

26 files changed

+5524
-2951
lines changed

CHANGELOG.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,27 @@
1+
## [0.1.2]
2+
#### APIs added
3+
- Expose `generateEntropyMnemonic` function - a utility method for generating a BIP39 mnemonic.
4+
- Expose `Node` class's `updateChannelConfig` method.
5+
- Add `ChannelConfig?` to node.connectOpenChannel() params - a `ChannelConfig` may now be specified on channel open or updated afterwards.
6+
- Expose `counterpartyNodeId` & `channelValueSats` in `ChannelDetails`.
7+
- Expose `trustedPeers0Conf` in `Config` - allowing inbound trusted 0conf channels.
8+
- Non-permanently connected peers are now included in node.listPeers().
9+
10+
#### API changed
11+
- node.newFundingAddress renamed to `newOnchainAddress`.
12+
- node.sendToOnChainAddress renamed to `sendToOnchainAddress`.
13+
- node.sendAllToOnChainAddress renamed to `sendAllToOnchainAddress`.
14+
- Remove node.onChainBalance.
15+
116
## [0.1.1-alpha]
217
Support `Dart 3` and `Flutter 3.10`
318

19+
## [0.1.1]
20+
Support `Dart 3` and `Flutter 3.10`
21+
422
### Fixed
523
- `setEntropyBip39Mnemonic` issue resolved
6-
## [0.1.0-alpha]
24+
## [0.1.0]
725

826
This is the first release of `ldk_node`. It features support for sourcing chain data via an `Esplora` server, filesystem persistence, gossip sourcing via the `Lightning` peer-to-peer network, and configurble entropy sources for the integrated LDK & BDK-based wallets.
927

README.md

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

55
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.
66

7-
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, connectOpen_channel, sendPayment, etc.:
7+
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.:
88

99
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.
1010

@@ -15,7 +15,7 @@ To use the `ldk_node` package in your project, add it as a dependency in your pr
1515

1616
```dart
1717
dependencies:
18-
ldk_node: ^0.1.1-alpha
18+
ldk_node: ^0.1.2
1919
```
2020
or add from pub.dev using `pub add` command
2121

@@ -39,12 +39,25 @@ final path = "${directory.path}alice's_node";
3939
final esploraUrl = https://blockstream.info/testnet/api;
4040
4141
// configuration options for the node
42-
final config = Config( storageDirPath: path,
43-
esploraServerUrl: esploraUrl,
44-
network: Network.Testnet,
45-
listeningAddress: SocketAddr(ip:"0.0.0.0", port:80) );
42+
final config = Config(
43+
storageDirPath: nodePath,
44+
network: ldk.Network.regtest,
45+
listeningAddress: NetAddress.iPv4(addr: "0.0.0.0", port: 3006),
46+
onchainWalletSyncIntervalSecs: 30,
47+
walletSyncIntervalSecs: 30,
48+
feeRateCacheUpdateIntervalSecs: 100,
49+
logLevel: ldk.LogLevel.info,
50+
defaultCltvExpiryDelta: 144
51+
);
4652
Builder builder = Builder.fromConfig(config);
47-
final node = await builder.build();
53+
final node = await builder
54+
.setEntropyBip39Mnemonic(
55+
mnemonic: ldk.Mnemonic(
56+
internal:
57+
'certain sense kiss guide crumble hint transfer crime much stereo warm coral'))
58+
.setEsploraServer(
59+
esploraServerUrl: esploraUrl)
60+
.build();
4861
4962
// Starting the node
5063
await node.start();
@@ -53,3 +66,8 @@ await node.start();
5366
await node.syncWallets();
5467
5568
```
69+
70+
### References:
71+
- Setting up a local Esplora instance for testing:
72+
https://bitcoin.stackexchange.com/questions/116937/how-do-i-setup-an-esplora-instance-for-local-testing/116938#116938
73+
97.9 KB
Binary file not shown.
41.8 KB
Binary file not shown.
378 KB
Binary file not shown.

example/ios/Podfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
PODS:
22
- Flutter (1.0.0)
3-
- ldk_node (0.1.0):
3+
- ldk_node (0.1.2):
44
- Flutter
55
- path_provider_foundation (0.0.1):
66
- Flutter
@@ -21,7 +21,7 @@ EXTERNAL SOURCES:
2121

2222
SPEC CHECKSUMS:
2323
Flutter: f04841e97a9d0b0a8025694d0796dd46242b2854
24-
ldk_node: 22f8295d7ea99b61dea82fe2819057a4e3d0e1d1
24+
ldk_node: ab40477d6647d63d24fccd3431ccc7672bf79a25
2525
path_provider_foundation: eaf5b3e458fc0e5fbb9940fb09980e853fe058b8
2626

2727
PODFILE CHECKSUM: ef19549a9bc3046e7bb7d2fab4d021637c0c58a3

0 commit comments

Comments
 (0)