Proposal: implement custom TLV records for spontaneous payments

.github/workflows/rust.yml

@@ -48,7 +48,8 @@ jobs:
           cargo update -p hashlink --precise "0.8.2" --verbose # hashlink 0.8.3 requires hashbrown 0.14, requiring 1.64.0
           cargo update -p proptest --precise "1.2.0" --verbose # proptest 1.3.0 requires rustc 1.64.0
           cargo update -p regex --precise "1.9.6" --verbose # regex 1.10.0 requires rustc 1.65.0
-          cargo update -p home --precise "0.5.5" --verbose # home v0.5.9, requires rustc 1.70 or newer
+          cargo update -p home --precise "0.5.5" --verbose # home v0.5.9 requires rustc 1.70 or newer
+          cargo update -p url --precise "2.5.0" --verbose # url v2.5.1 requires rustc 1.67 or newer
       - name: Set RUSTFLAGS to deny warnings
         if: "matrix.toolchain == 'stable'"
         run: echo "RUSTFLAGS=-D warnings" >> "$GITHUB_ENV"

CHANGELOG.md

@@ -1,3 +1,55 @@
+# 0.3.0 - June 21, 2024
+
+This third minor release notably adds support for BOLT12 payments, Anchor
+channels, and sourcing inbound liquidity via LSPS2 just-in-time channels.
+
+## Feature and API updates
+- Support for creating and paying BOLT12 offers and refunds has been added (#265).
+- Support for Anchor channels has been added (#141).
+- Support for sourcing inbound liquidity via LSPS2 just-in-time (JIT) channels has been added (#223).
+- The node's local view of the network graph can now be accessed via interface methods (#293).
+- A new `next_event_async` method was added that allows polling the event queue asynchronously (#224).
+- A `default_config` method was introduced that allows to retrieve sane default values, also in bindings (#242).
+- The `PaymentFailed` and `ChannelClosed` events now include `reason` fields (#260).
+- All available balances outside of channel balances are now exposed via a unified `list_balances` interface method (#250).
+- The maximum in-flight HTLC value has been bumped to 100% of the channel capacity for private outbound channels (#303) and, if JIT channel support is enabled, for inbound channels (#262).
+- The fee paid is now exposed via the `PaymentSuccessful` event (#271).
+- A `status` method has been added allowing to retrieve information about the `Node`'s status (#272).
+- `Node` no longer takes a `KVStore` type parameter, allowing to use the filesystem storage backend in bindings (#244).
+- The payment APIs have been restructured to use per-type (`bolt11`, `onchain`, `bolt12`, ..) payment handlers which can be accessed via corresponding `Node::{type}_payment` methods (#270).
+- Fully resolved channel monitors are now eventually moved to an archive location (#307).
+- The ability to register and claim from custom payment hashes generated outside of LDK Node has been added (#308).
+
+## Bug Fixes
+- Node announcements are now correctly only broadcast if we have any public, sufficiently confirmed channels (#248, #314).
+- Falling back to default fee values is now disallowed on mainnet, ensuring we won't startup without a successful fee cache update (#249).
+- Persisted peers are now correctly reconnected after startup (#265).
+- Concurrent connection attempts to the same peer are no longer overriding each other (#266).
+- Several steps have been taken to reduce the risk of blocking node operation on wallet syncing in the face of unresponsive Esplora services (#281).
+
+## Compatibility Notes
+- LDK has been updated to version 0.0.123 (#291).
+
+In total, this release features 54 files changed, 7282 insertions, 2410 deletions in 165 commits from 3 authors, in alphabetical order:
+
+- Elias Rohrer
+- jbesraa
+- Srikanth Iyengar
+
+# 0.2.2 - May 21, 2024
+
+This is a bugfix release that reestablishes compatibility of Swift packages
+with Xcode 15.3 and later.
+
+## Bug Fixes
+
+- Swift bindings can now be built using Xcode 15.3 and later again (#294)
+
+In total, this release features 5 files changed, 66 insertions, 2 deletions
+deletions in 2 commits from 1 author, in alphabetical order:
+
+- Elias Rohrer
+
 # 0.2.1 - Jan 26, 2024
 
 This is a bugfix release bumping the used LDK and BDK dependencies to the

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ldk-node"
-version = "0.2.1"
+version = "0.3.0"
 authors = ["Elias Rohrer <dev@tnull.de>"]
 homepage = "https://lightningdevkit.org/"
 license = "MIT OR Apache-2.0"
@@ -28,14 +28,14 @@ panic = 'abort'     # Abort on panic
 default = []
 
 [dependencies]
-lightning = { version = "0.0.121", features = ["std"] }
-lightning-invoice = { version = "0.29.0" }
-lightning-net-tokio = { version = "0.0.121" }
-lightning-persister = { version = "0.0.121" }
-lightning-background-processor = { version = "0.0.121", features = ["futures"] }
-lightning-rapid-gossip-sync = { version = "0.0.121" }
-lightning-transaction-sync = { version = "0.0.121", features = ["esplora-async-https", "time"] }
-lightning-liquidity = { version = "0.1.0-alpha.1", features = ["std"] }
+lightning = { version = "0.0.123", features = ["std"] }
+lightning-invoice = { version = "0.31.0" }
+lightning-net-tokio = { version = "0.0.123" }
+lightning-persister = { version = "0.0.123" }
+lightning-background-processor = { version = "0.0.123", features = ["futures"] }
+lightning-rapid-gossip-sync = { version = "0.0.123" }
+lightning-transaction-sync = { version = "0.0.123", features = ["esplora-async-https", "time"] }
+lightning-liquidity = { version = "0.1.0-alpha.4", features = ["std"] }
 
 #lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["std"] }
 #lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main" }
@@ -64,8 +64,7 @@ bip39 = "2.0.0"
 
 rand = "0.8.5"
 chrono = { version = "0.4", default-features = false, features = ["clock"] }
-futures = "0.3"
-tokio = { version = "1", default-features = false, features = [ "rt-multi-thread", "time", "sync" ] }
+tokio = { version = "1.37", default-features = false, features = [ "rt-multi-thread", "time", "sync" ] }
 esplora-client = { version = "0.6", default-features = false }
 libc = "0.2"
 uniffi = { version = "0.26.0", features = ["build"], optional = true }
@@ -78,7 +77,7 @@ prost = { version = "0.11.6", default-features = false}
 winapi = { version = "0.3", features = ["winbase"] }
 
 [dev-dependencies]
-lightning = { version = "0.0.121", features = ["std", "_test_utils"] }
+lightning = { version = "0.0.123", features = ["std", "_test_utils"] }
 #lightning = { git = "https://github.com/lightningdevkit/rust-lightning", branch="main", features = ["std", "_test_utils"] }
 electrum-client = { version = "0.15.1", default-features = true }
 bitcoincore-rpc = { version = "0.17.0", default-features = false }

Package.swift

@@ -3,8 +3,8 @@
 
 import PackageDescription
 
-let tag = "v0.2.1"
-let checksum = "cca3d5f380c3c216c22ac892cb04a792f3982730e570df71d824462f14c1350e"
+let tag = "v0.3.0"
+let checksum = "07c8741768956bf1a51d1c25f751b5e29d1ae9ee2fd786c4282031c9a8a92f0c"
 let url = "https://github.com/lightningdevkit/ldk-node/releases/download/\(tag)/LDKNodeFFI.xcframework.zip"
 
 let package = Package(

README.md

@@ -11,7 +11,7 @@ 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`, `connect_open_channel`, `send_payment`, etc.
+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`, `connect_open_channel`, `send`, etc.
 
 ```rust
 use ldk_node::Builder;
@@ -31,7 +31,7 @@ fn main() {
 
 	node.start().unwrap();
 
-	let funding_address = node.new_onchain_address();
+	let funding_address = node.onchain_payment().new_address();
 
 	// .. fund address ..
 
@@ -44,7 +44,7 @@ fn main() {
 	node.event_handled();
 
 	let invoice = Bolt11Invoice::from_str("INVOICE_STR").unwrap();
-	node.send_payment(&invoice).unwrap();
+	node.bolt11_payment().send(&invoice).unwrap();
 
 	node.stop().unwrap();
 }

bindings/kotlin/ldk-node-android/gradle.properties

@@ -2,4 +2,4 @@ org.gradle.jvmargs=-Xmx1536m
 android.useAndroidX=true
 android.enableJetifier=true
 kotlin.code.style=official
-libraryVersion=0.2.1
+libraryVersion=0.3.0

bindings/kotlin/ldk-node-android/lib/src/androidTest/kotlin/org/lightningdevkit/ldknode/AndroidLibTest.kt

@@ -51,10 +51,10 @@ class AndroidLibTest {
         val nodeId2 = node2.nodeId()
         println("Node Id 2: $nodeId2")
 
-        val address1 = node1.newOnchainAddress()
+        val address1 = node1.onchain_payment().newOnchainAddress()
         println("Funding address 1: $address1")
 
-        val address2 = node2.newOnchainAddress()
+        val address2 = node2.onchain_payment().newOnchainAddress()
         println("Funding address 2: $address2")
 
         node1.stop()

bindings/kotlin/ldk-node-jvm/gradle.properties

@@ -1,3 +1,3 @@
 org.gradle.jvmargs=-Xmx1536m
 kotlin.code.style=official
-libraryVersion=0.2.1
+libraryVersion=0.3.0

bindings/kotlin/ldk-node-jvm/lib/src/test/kotlin/org/lightningdevkit/ldknode/LibraryTest.kt

@@ -146,10 +146,10 @@ class LibraryTest {
         val nodeId2 = node2.nodeId()
         println("Node Id 2: $nodeId2")
 
-        val address1 = node1.newOnchainAddress()
+        val address1 = node1.onchainPayment().newAddress()
         println("Funding address 1: $address1")
 
-        val address2 = node2.newOnchainAddress()
+        val address2 = node2.onchainPayment().newAddress()
         println("Funding address 2: $address2")
 
         val txid1 = sendToAddress(address1, 100000u)
@@ -203,9 +203,9 @@ class LibraryTest {
         val spendableBalance2AfterOpen = node2.listBalances().spendableOnchainBalanceSats
         println("Spendable balance 1 after open: $spendableBalance1AfterOpen")
         println("Spendable balance 2 after open: $spendableBalance2AfterOpen")
-        assert(spendableBalance1AfterOpen > 49000u)
-        assert(spendableBalance1AfterOpen < 50000u)
-        assertEquals(100000uL, spendableBalance2AfterOpen)
+        assert(spendableBalance1AfterOpen > 24000u)
+        assert(spendableBalance1AfterOpen < 25000u)
+        assertEquals(75000uL, spendableBalance2AfterOpen)
 
         val channelReadyEvent1 = node1.waitNextEvent()
         println("Got event: $channelReadyEvent1")
@@ -222,9 +222,9 @@ class LibraryTest {
             else -> return
         }
 
-        val invoice = node2.receivePayment(2500000u, "asdf", 9217u)
+        val invoice = node2.bolt11Payment().receive(2500000u, "asdf", 9217u)
 
-        node1.sendPayment(invoice)
+        node1.bolt11Payment().send(invoice)
 
         val paymentSuccessfulEvent = node1.waitNextEvent()
         println("Got event: $paymentSuccessfulEvent")