Skip to content

Reset graph and scorer if failing to find a path #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ovitrif merged 4 commits into from
Apr 18, 2025
Merged

Reset graph and scorer if failing to find a path #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
af0eb40
fix(ios): if fails to find route, reset graph reset scorer, sync both…
Jasonvdb Apr 17, 2025
a3e02ee
chore: code cleanup
Jasonvdb Apr 18, 2025
3608f7e
fix(android): if fails to find route, reset graph, scorer, sync both …
Jasonvdb Apr 18, 2025
bcfa5c7
fix(ios): connecting to peers in sequence to avoid crash
Jasonvdb Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 131 additions & 23 deletions lib/android/src/main/java/com/reactnativeldk/LdkModule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,6 @@ enum class LdkCallbackResponses {
peer_already_connected,
peer_currently_connecting,
chain_sync_success,
invoice_payment_success,
tx_set_confirmed,
tx_set_unconfirmed,
process_pending_htlc_forwards_success,
Expand Down Expand Up @@ -185,6 +184,8 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
private var currentNetwork: String? = null
private var currentBlockchainTipHash: String? = null
private var currentBlockchainHeight: Double? = null
private var currentScorerDownloadUrl: String? = null
private var currentRapidGossipSyncUrl: String? = null

//List of peers that "should" remain connected. Stores address: String, port: Double, pubKey: String
private var addedPeers = ConcurrentLinkedQueue<Map<String, Any>>()
Expand Down Expand Up @@ -292,6 +293,9 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
@ReactMethod
fun downloadScorer(scorerSyncUrl: String, skipHoursThreshold: Double, promise: Promise) {
val scorerFile = File(accountStoragePath + "/" + LdkFileNames.Scorer.fileName)

currentScorerDownloadUrl = scorerSyncUrl

//If old one is still recent, skip download. Else delete it.
if (scorerFile.exists()) {
val lastModifiedHours = (System.currentTimeMillis().toDouble() - scorerFile.lastModified().toDouble()) / 1000 / 60 / 60
Expand Down Expand Up @@ -329,6 +333,8 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
return handleReject(promise, LdkErrors.already_init)
}

currentRapidGossipSyncUrl = rapidGossipSyncUrl

val networkGraphFile = File(accountStoragePath + "/" + LdkFileNames.NetworkGraph.fileName)
if (networkGraphFile.exists()) {
(NetworkGraph.read(networkGraphFile.readBytes(), logger.logger) as? Result_NetworkGraphDecodeErrorZ.Result_NetworkGraphDecodeErrorZ_OK)?.let { res ->
Expand Down Expand Up @@ -427,7 +433,7 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
var channelManagerSerialized: ByteArray? = null
val channelManagerFile = File(accountStoragePath + "/" + LdkFileNames.ChannelManager.fileName)
if (channelManagerFile.exists()) {
channelManagerSerialized = channelManagerFile.readBytes()
channelManagerSerialized = channelManagerFile.readBytes()
}

//Scorer setup
Expand Down Expand Up @@ -558,11 +564,11 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
LdkEventEmitter.send(EventTypes.channel_manager_restarted, "")
LdkEventEmitter.send(EventTypes.native_log, "LDK restarted successfully")
handleResolve(promise, LdkCallbackResponses.ldk_restart)
},
},
{ reject ->
LdkEventEmitter.send(EventTypes.native_log, "Error restarting LDK. Error: $reject")
handleReject(promise, LdkErrors.unknown_error)
})
})

initChannelManager(
currentNetwork,
Expand Down Expand Up @@ -687,7 +693,7 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
if (currentlyConnectingPeers.contains(pubKey)) {
return handleResolve(promise, LdkCallbackResponses.peer_currently_connecting)
}

try {
currentlyConnectingPeers.add(pubKey)
peerHandler!!.connect(pubKey.hexa(), InetSocketAddress(address, port.toInt()), timeout.toInt())
Expand Down Expand Up @@ -925,26 +931,131 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
promise.resolve(parsedInvoice.res.asJson)
}

private fun resetGraphAndScorerAndRetryPayment(
originalError: LdkErrors,
paymentRequest: String,
amountSats: Double,
timeoutSeconds: Double,
promise: Promise
) {
if (accountStoragePath == "") {
LdkEventEmitter.send(EventTypes.native_log, "Failed to reset graph: account storage path not set")
return handleReject(promise, originalError)
}

// Check required data and URLs
val currentNetwork = currentNetwork ?: return handleReject(promise, originalError)

if (currentRapidGossipSyncUrl.isNullOrEmpty() || currentScorerDownloadUrl.isNullOrEmpty()) {
val missingUrl = if (currentRapidGossipSyncUrl.isNullOrEmpty()) "rapid gossip sync" else "scorer download"
LdkEventEmitter.send(EventTypes.native_log, "Failed to reset graph: $missingUrl URL not set")
return handleReject(promise, originalError)
}

val scorerFile = File("$accountStoragePath/${LdkFileNames.Scorer.fileName}")
val networkGraphFile = File("$accountStoragePath/${LdkFileNames.NetworkGraph.fileName}")

// Delete scorer if exists
if (scorerFile.exists()) {
try {
scorerFile.delete()
LdkEventEmitter.send(EventTypes.native_log, "Deleted scorer file")
} catch (e: Exception) {
LdkEventEmitter.send(EventTypes.native_log, "Failed to delete scorer file: ${e.localizedMessage}")
}
}

// Delete network graph if exists
if (networkGraphFile.exists()) {
try {
networkGraphFile.delete()
LdkEventEmitter.send(EventTypes.native_log, "Deleted network graph file")
networkGraph = null
} catch (e: Exception) {
LdkEventEmitter.send(EventTypes.native_log, "Failed to delete network graph file: ${e.localizedMessage}")
}
}

LdkEventEmitter.send(EventTypes.native_log, "Deleted scorer and network graph, resyncing from scratch so we can retry payment")

// Download everything again and retry
downloadScorer(currentScorerDownloadUrl!!, 1.0, object : PromiseImpl(
{ _ ->
LdkEventEmitter.send(EventTypes.native_log, "Scorer downloaded, initializing network graph...")
initNetworkGraph(currentNetwork, currentRapidGossipSyncUrl!!, 1.0, object : PromiseImpl(
{ _ ->
LdkEventEmitter.send(EventTypes.native_log, "Network graph initialized, restarting channel manager...")
restart(object : PromiseImpl(
{ _ ->
// Run handleDroppedPeers on a background thread (can't work in the UI thread)
Thread {
handleDroppedPeers()
}.start()

Thread.sleep(2500) //Wait a little as android peer connections happen async so we're just making sure they're all connected
val channelsInGraph = networkGraph?.read_only()?.list_channels()?.size
LdkEventEmitter.send(EventTypes.native_log, "Channels found in graph: $channelsInGraph")
LdkEventEmitter.send(EventTypes.native_log, "Peers connected: ${peerManager?.list_peers()?.size}")
LdkEventEmitter.send(EventTypes.native_log, "Restart complete. Attempting to retry payment after graph reset...")
val (paymentId2, error2) = handlePayment(paymentRequest, amountSats, timeoutSeconds)

if (error2 != null) {
LdkEventEmitter.send(EventTypes.native_log, "Failed to retry payment after graph reset: $error2")
handleReject(promise, error2)
} else {
LdkEventEmitter.send(EventTypes.native_log, "Successfully retried payment after graph reset")
// 2nd attempt found a path with fresh graph
promise.resolve(paymentId2)
}
},
{ _ -> handleReject(promise, originalError) }
) {})
},
{ _ -> handleReject(promise, originalError) }
) {})
},
{ _ -> handleReject(promise, originalError) }
) {})
}

@ReactMethod
fun pay(paymentRequest: String, amountSats: Double, timeoutSeconds: Double, promise: Promise) {
channelManager ?: return handleReject(promise, LdkErrors.init_channel_manager)
val (paymentId, error) = handlePayment(paymentRequest, amountSats, timeoutSeconds)
if (error != null) {
// If error is route not found, maybe a problem with the graph, so reset it, download all again and try payment one more time
if (error == LdkErrors.invoice_payment_fail_route_not_found) {
return resetGraphAndScorerAndRetryPayment(
error,
paymentRequest,
amountSats,
timeoutSeconds,
promise
)
}
return handleReject(promise, error)
}
return promise.resolve(paymentId)
}

private fun handlePayment(paymentRequest: String, amountSats: Double, timeoutSeconds: Double): Pair<String?, LdkErrors?> {
channelManager ?: return Pair(null, LdkErrors.init_channel_manager)

val invoiceParse = Bolt11Invoice.from_str(paymentRequest)
if (!invoiceParse.is_ok) {
return handleReject(promise, LdkErrors.decode_invoice_fail)
return Pair(null, LdkErrors.decode_invoice_fail)
}
val invoice = (invoiceParse as Result_Bolt11InvoiceParseOrSemanticErrorZ_OK).res

val isZeroValueInvoice = invoice.amount_milli_satoshis() is Option_u64Z.None

//If it's a zero invoice and we don't have an amount then don't proceed
if (isZeroValueInvoice && amountSats == 0.0) {
return handleReject(promise, LdkErrors.invoice_payment_fail_must_specify_amount)
return Pair(null, LdkErrors.invoice_payment_fail_must_specify_amount)
}

//Amount was set but not allowed to set own amount
if (amountSats > 0 && !isZeroValueInvoice) {
return handleReject(promise, LdkErrors.invoice_payment_fail_must_not_specify_amount)
return Pair(null, LdkErrors.invoice_payment_fail_must_not_specify_amount)
}

val paymentId = invoice.payment_hash()
Expand All @@ -953,7 +1064,7 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
UtilMethods.payment_parameters_from_invoice(invoice)

if (!detailsRes.is_ok) {
return handleReject(promise, LdkErrors.invoice_payment_fail_invoice)
return Pair(null, LdkErrors.invoice_payment_fail_invoice)
}

val sendDetails = detailsRes as Result_C3Tuple_ThirtyTwoBytesRecipientOnionFieldsRouteParametersZNoneZ_OK
Expand All @@ -974,26 +1085,23 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
"state" to "pending"
))

return handleResolve(promise, LdkCallbackResponses.invoice_payment_success)
return Pair(paymentId.hexEncodedString(), null)
}

val error = res as? Result_NoneRetryableSendFailureZ_Err
?: return handleReject(promise, LdkErrors.invoice_payment_fail_unknown)
?: return Pair(null, LdkErrors.invoice_payment_fail_unknown)

when (error.err) {
return when (error.err) {
RetryableSendFailure.LDKRetryableSendFailure_DuplicatePayment -> {
handleReject(promise, LdkErrors.invoice_payment_fail_duplicate_payment)
Pair(null, LdkErrors.invoice_payment_fail_duplicate_payment)
}

RetryableSendFailure.LDKRetryableSendFailure_PaymentExpired -> {
handleReject(promise, LdkErrors.invoice_payment_fail_payment_expired)
Pair(null, LdkErrors.invoice_payment_fail_payment_expired)
}

RetryableSendFailure.LDKRetryableSendFailure_RouteNotFound -> {
handleReject(promise, LdkErrors.invoice_payment_fail_route_not_found)
Pair(null, LdkErrors.invoice_payment_fail_route_not_found)
}

else -> handleReject(promise, LdkErrors.invoice_payment_fail_unknown)
else -> Pair(null, LdkErrors.invoice_payment_fail_unknown)
}
}

Expand Down Expand Up @@ -1409,10 +1517,10 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod

keysManager?.inner?.as_NodeSigner()
?.get_node_id(Recipient.LDKRecipient_Node)?.let { pubKeyRes ->
if (pubKeyRes.is_ok) {
logDump.add("NodeID: ${(pubKeyRes as Result_PublicKeyNoneZ_OK).res.hexEncodedString()}")
if (pubKeyRes.is_ok) {
logDump.add("NodeID: ${(pubKeyRes as Result_PublicKeyNoneZ_OK).res.hexEncodedString()}")
}
}
}

channelManager?.list_channels()?.forEach { channel ->
logDump.add("Open channel:")
Expand Down
Loading
Loading