feat: add ProbeHandle and probe success/failure events

.gitignore

@@ -29,6 +29,9 @@ swift.swiftdoc
 *.a
 *.d
 
+# macOS Finder metadata (icon positions, view options)
+.DS_Store
+
 # IDE and local files
 .idea
 .build

CHANGELOG.md

@@ -1,4 +1,4 @@
-# 0.7.0-rc.36 (Synonym Fork)
+# 0.7.0-rc.37 (Synonym Fork)
 
 ## Bug Fixes
 
@@ -58,6 +58,12 @@
 
 ## Synonym Fork Additions
 
+- Added pre-flight probe correlation: `Event::ProbeSuccessful` and `Event::ProbeFailed` (from LDK
+  probe lifecycle), plus `ProbeHandle` (`payment_id`, synthetic `payment_hash`) values returned
+  for probes actually dispatched by `Bolt11Payment::send_probes`, `send_probes_using_amount`, and
+  `SpontaneousPayment::send_probes` (some route paths may be skipped before dispatch). Match
+  handles to events by `payment_id` (and optionally `payment_hash`); these are not the BOLT11
+  invoice payment hash. UniFFI: `dictionary ProbeHandle` in `ldk_node.udl`.
 - Added `connection_timeout_secs` field to `ElectrumSyncConfig` (default: 10 s). This bounds
   Electrum socket operations for both the BDK on-chain and LDK tx-sync clients, preventing Tokio's
   blocking thread pool from being exhausted by threads stuck on dead sockets under total packet

Cargo.toml

@@ -4,7 +4,7 @@ exclude = ["bindings/uniffi-bindgen"]
 
 [package]
 name = "ldk-node"
-version = "0.7.0-rc.36"
+version = "0.7.0-rc.37"
 authors = ["Elias Rohrer <dev@tnull.de>"]
 homepage = "https://lightningdevkit.org/"
 license = "MIT OR Apache-2.0"

Package.swift

@@ -3,8 +3,8 @@
 
 import PackageDescription
 
-let tag = "v0.7.0-rc.36"
-let checksum = "de56fe19149808ccc5e517047ea7bf6b4d5d2c2e33d3ad539ef0155bf1aec8f7"
+let tag = "v0.7.0-rc.37"
+let checksum = "31ca289fb94221bf1a0077532a868d1e19912f19760735697023066b1160eea7"
 let url = "https://github.com/synonymdev/ldk-node/releases/download/\(tag)/LDKNodeFFI.xcframework.zip"
 
 let package = Package(

bindings/kotlin/.editorconfig

@@ -0,0 +1,7 @@
+# ktlint uses EditorConfig for indentation. Without this file it defaults to
+# 2 spaces for Kotlin script, while Gradle/IntelliJ convention here is 4 spaces.
+root = true
+
+[*.{kt,kts}]
+indent_style = space
+indent_size = 4

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

@@ -3,4 +3,4 @@ android.useAndroidX=true
 android.enableJetifier=true
 kotlin.code.style=official
 group=com.synonym
-version=0.7.0-rc.36
+version=0.7.0-rc.37

bindings/kotlin/ldk-node-android/lib/src/main/kotlin/org/lightningdevkit/ldknode/ldk_node.common.kt

@@ -185,10 +185,10 @@ interface Bolt11PaymentInterface {
     fun `send`(`invoice`: Bolt11Invoice, `routeParameters`: RouteParametersConfig?): PaymentId
 
     @Throws(NodeException::class)
-    fun `sendProbes`(`invoice`: Bolt11Invoice, `routeParameters`: RouteParametersConfig?)
+    fun `sendProbes`(`invoice`: Bolt11Invoice, `routeParameters`: RouteParametersConfig?): List<ProbeHandle>
 
     @Throws(NodeException::class)
-    fun `sendProbesUsingAmount`(`invoice`: Bolt11Invoice, `amountMsat`: kotlin.ULong, `routeParameters`: RouteParametersConfig?)
+    fun `sendProbesUsingAmount`(`invoice`: Bolt11Invoice, `amountMsat`: kotlin.ULong, `routeParameters`: RouteParametersConfig?): List<ProbeHandle>
 
     @Throws(NodeException::class)
     fun `sendUsingAmount`(`invoice`: Bolt11Invoice, `amountMsat`: kotlin.ULong, `routeParameters`: RouteParametersConfig?): PaymentId
@@ -650,7 +650,7 @@ interface SpontaneousPaymentInterface {
     fun `send`(`amountMsat`: kotlin.ULong, `nodeId`: PublicKey, `routeParameters`: RouteParametersConfig?): PaymentId
 
     @Throws(NodeException::class)
-    fun `sendProbes`(`amountMsat`: kotlin.ULong, `nodeId`: PublicKey)
+    fun `sendProbes`(`amountMsat`: kotlin.ULong, `nodeId`: PublicKey): List<ProbeHandle>
 
     @Throws(NodeException::class)
     fun `sendWithCustomTlvs`(`amountMsat`: kotlin.ULong, `nodeId`: PublicKey, `routeParameters`: RouteParametersConfig?, `customTlvs`: List<CustomTlvRecord>): PaymentId
@@ -1114,6 +1114,16 @@ data class PeerDetails (
 
 
 
+@kotlinx.serialization.Serializable
+data class ProbeHandle (
+    val `paymentHash`: PaymentHash, 
+    val `paymentId`: PaymentId
+) {
+    companion object
+}
+
+
+
 @kotlinx.serialization.Serializable
 data class RouteHintHop (
     val `srcNodeId`: PublicKey, 
@@ -1497,6 +1507,19 @@ sealed class Event {
     ) : Event() {
     }
     @kotlinx.serialization.Serializable
+    data class ProbeSuccessful(
+        val `paymentId`: PaymentId,
+        val `paymentHash`: PaymentHash,
+    ) : Event() {
+    }
+    @kotlinx.serialization.Serializable
+    data class ProbeFailed(
+        val `paymentId`: PaymentId,
+        val `paymentHash`: PaymentHash,
+        val `shortChannelId`: kotlin.ULong?,
+    ) : Event() {
+    }
+    @kotlinx.serialization.Serializable
     data class ChannelPending(
         val `channelId`: ChannelId,
         val `userChannelId`: UserChannelId,
@@ -2247,6 +2270,8 @@ enum class WordCount {
 
 
 
+
+
 
 
 

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

@@ -1,4 +1,4 @@
 org.gradle.jvmargs=-Xmx1536m
 kotlin.code.style=official
 group=com.synonym
-version=0.7.0-rc.36
+version=0.7.0-rc.37

bindings/kotlin/ldk-node-jvm/lib/src/main/kotlin/org/lightningdevkit/ldknode/ldk_node.common.kt

@@ -185,10 +185,10 @@ interface Bolt11PaymentInterface {
     fun `send`(`invoice`: Bolt11Invoice, `routeParameters`: RouteParametersConfig?): PaymentId
 
     @Throws(NodeException::class)
-    fun `sendProbes`(`invoice`: Bolt11Invoice, `routeParameters`: RouteParametersConfig?)
+    fun `sendProbes`(`invoice`: Bolt11Invoice, `routeParameters`: RouteParametersConfig?): List<ProbeHandle>
 
     @Throws(NodeException::class)
-    fun `sendProbesUsingAmount`(`invoice`: Bolt11Invoice, `amountMsat`: kotlin.ULong, `routeParameters`: RouteParametersConfig?)
+    fun `sendProbesUsingAmount`(`invoice`: Bolt11Invoice, `amountMsat`: kotlin.ULong, `routeParameters`: RouteParametersConfig?): List<ProbeHandle>
 
     @Throws(NodeException::class)
     fun `sendUsingAmount`(`invoice`: Bolt11Invoice, `amountMsat`: kotlin.ULong, `routeParameters`: RouteParametersConfig?): PaymentId
@@ -650,7 +650,7 @@ interface SpontaneousPaymentInterface {
     fun `send`(`amountMsat`: kotlin.ULong, `nodeId`: PublicKey, `routeParameters`: RouteParametersConfig?): PaymentId
 
     @Throws(NodeException::class)
-    fun `sendProbes`(`amountMsat`: kotlin.ULong, `nodeId`: PublicKey)
+    fun `sendProbes`(`amountMsat`: kotlin.ULong, `nodeId`: PublicKey): List<ProbeHandle>
 
     @Throws(NodeException::class)
     fun `sendWithCustomTlvs`(`amountMsat`: kotlin.ULong, `nodeId`: PublicKey, `routeParameters`: RouteParametersConfig?, `customTlvs`: List<CustomTlvRecord>): PaymentId
@@ -1114,6 +1114,16 @@ data class PeerDetails (
 
 
 
+@kotlinx.serialization.Serializable
+data class ProbeHandle (
+    val `paymentHash`: PaymentHash, 
+    val `paymentId`: PaymentId
+) {
+    companion object
+}
+
+
+
 @kotlinx.serialization.Serializable
 data class RouteHintHop (
     val `srcNodeId`: PublicKey, 
@@ -1497,6 +1507,19 @@ sealed class Event {
     ) : Event() {
     }
     @kotlinx.serialization.Serializable
+    data class ProbeSuccessful(
+        val `paymentId`: PaymentId,
+        val `paymentHash`: PaymentHash,
+    ) : Event() {
+    }
+    @kotlinx.serialization.Serializable
+    data class ProbeFailed(
+        val `paymentId`: PaymentId,
+        val `paymentHash`: PaymentHash,
+        val `shortChannelId`: kotlin.ULong?,
+    ) : Event() {
+    }
+    @kotlinx.serialization.Serializable
     data class ChannelPending(
         val `channelId`: ChannelId,
         val `userChannelId`: UserChannelId,
@@ -2247,6 +2270,8 @@ enum class WordCount {
 
 
 
+
+