feat: Add external pathfinding scores support for LDK Node

kaloudis · kaloudis · commit a6561f43f4af · 2026-04-18T00:54:06.000-04:00
diff --git a/android/app/src/main/java/app/zeusln/zeus/LdkNodeModule.kt b/android/app/src/main/java/app/zeusln/zeus/LdkNodeModule.kt
@@ -28,6 +28,7 @@ class LdkNodeModule(reactContext: ReactApplicationContext) : ReactContextBaseJav
     // Stored builder settings (not part of Config)
     private var storedEsploraServerUrl: String? = null
     private var storedRgsServerUrl: String? = null
+    private var storedScorerUrl: String? = null
     private var storedLsps1NodeId: PublicKey? = null
     private var storedLsps1Address: SocketAddress? = null
     private var storedLsps1Token: String? = null
@@ -60,6 +61,7 @@ class LdkNodeModule(reactContext: ReactApplicationContext) : ReactContextBaseJav
         storedTrustedPeers0conf = emptyList()
         storedEsploraServerUrl = null
         storedRgsServerUrl = null
+        storedScorerUrl = null
         storedLsps1NodeId = null
         storedLsps1Address = null
         storedLsps1Token = null
@@ -151,6 +153,18 @@ class LdkNodeModule(reactContext: ReactApplicationContext) : ReactContextBaseJav
         }
     }
 
+    @ReactMethod
+    fun setPathfindingScoresSource(url: String, promise: Promise) {
+        try {
+            val builder = this.builder ?: throw Exception("Builder not initialized")
+            this.storedScorerUrl = url
+            builder.setPathfindingScoresSource(url)
+            promise.resolve(null)
+        } catch (e: Exception) {
+            promise.reject("error", errorMessage(e))
+        }
+    }
+
     @ReactMethod
     fun setGossipSourceP2p(promise: Promise) {
         try {
@@ -468,6 +482,10 @@ class LdkNodeModule(reactContext: ReactApplicationContext) : ReactContextBaseJav
             Log.d("LdkNodeModule", "applyBuilderSettings: RGS server = $it")
             builder.setGossipSourceRgs(it)
         }
+        this.storedScorerUrl?.let {
+            Log.d("LdkNodeModule", "applyBuilderSettings: Scorer URL = $it")
+            builder.setPathfindingScoresSource(it)
+        }
         this.storedLsps1NodeId?.let { nodeId ->
             this.storedLsps1Address?.let { address ->
                 builder.setLiquiditySourceLsps1(nodeId, address, this.storedLsps1Token)
diff --git a/ios/LdkNodeMobile/LdkNodeModule.swift b/ios/LdkNodeMobile/LdkNodeModule.swift
@@ -19,6 +19,7 @@ class LdkNodeModule: RCTEventEmitter {
     // Stored builder settings (not part of Config)
     private var storedEsploraServerUrl: String?
     private var storedRgsServerUrl: String?
+    private var storedScorerUrl: String?
     private var storedLsps1NodeId: PublicKey?
     private var storedLsps1Address: SocketAddress?
     private var storedLsps1Token: String?
@@ -79,6 +80,7 @@ class LdkNodeModule: RCTEventEmitter {
         storedTrustedPeers0conf = []
         storedEsploraServerUrl = nil
         storedRgsServerUrl = nil
+        storedScorerUrl = nil
         storedLsps1NodeId = nil
         storedLsps1Address = nil
         storedLsps1Token = nil
@@ -166,6 +168,18 @@ class LdkNodeModule: RCTEventEmitter {
         resolve(["status": "ok"])
     }
 
+    @objc(setPathfindingScoresSource:resolver:rejecter:)
+    func setPathfindingScoresSource(_ url: String, resolver resolve: @escaping RCTPromiseResolveBlock, rejecter reject: @escaping RCTPromiseRejectBlock) {
+        guard let builder = self.builder else {
+            reject("error", "Builder not initialized", nil)
+            return
+        }
+
+        self.storedScorerUrl = url
+        builder.setPathfindingScoresSource(url: url)
+        resolve(nil)
+    }
+
     @objc(setTrustedPeers0conf:resolver:rejecter:)
     func setTrustedPeers0conf(_ peers: [String], resolver resolve: @escaping RCTPromiseResolveBlock, rejecter reject: @escaping RCTPromiseRejectBlock) {
         guard self.builder != nil else {
@@ -469,6 +483,10 @@ class LdkNodeModule: RCTEventEmitter {
             NSLog("LdkNodeModule: applyBuilderSettings: RGS server = \(rgsUrl)")
             builder.setGossipSourceRgs(rgsServerUrl: rgsUrl)
         }
+        if let scorerUrl = self.storedScorerUrl {
+            NSLog("LdkNodeModule: applyBuilderSettings: Scorer URL = \(scorerUrl)")
+            builder.setPathfindingScoresSource(url: scorerUrl)
+        }
         if let lsps1NodeId = self.storedLsps1NodeId, let lsps1Address = self.storedLsps1Address {
             builder.setLiquiditySourceLsps1(nodeId: lsps1NodeId, address: lsps1Address, token: self.storedLsps1Token)
         }
diff --git a/ldknode/LdkNode.d.ts b/ldknode/LdkNode.d.ts
@@ -442,6 +442,7 @@ export interface ILdkNodeModule {
     setStorageDirPath(path: string): Promise<void>;
     setEsploraServer(serverUrl: string): Promise<void>;
     setGossipSourceRgs(rgsServerUrl: string): Promise<void>;
+    setPathfindingScoresSource(url: string): Promise<void>;
     setGossipSourceP2p(): Promise<void>;
     setListeningAddresses(addresses: string[]): Promise<void>;
 
diff --git a/ldknode/LdkNodeInjection.ts b/ldknode/LdkNodeInjection.ts
@@ -47,6 +47,10 @@ const setGossipSourceRgs = async (rgsServerUrl: string): Promise<void> => {
     return await LdkNodeModule.setGossipSourceRgs(rgsServerUrl);
 };
 
+const setPathfindingScoresSource = async (url: string): Promise<void> => {
+    return await LdkNodeModule.setPathfindingScoresSource(url);
+};
+
 const setGossipSourceP2p = async (): Promise<void> => {
     return await LdkNodeModule.setGossipSourceP2p();
 };
@@ -802,6 +806,7 @@ const initializeNode = async ({
     mnemonic,
     passphrase,
     rgsServerUrl,
+    scorerUrl,
     listeningAddresses,
     lsps1Config,
     trustedPeers0conf,
@@ -814,6 +819,7 @@ const initializeNode = async ({
     mnemonic: string;
     passphrase?: string | null;
     rgsServerUrl?: string;
+    scorerUrl?: string;
     listeningAddresses?: string[];
     lsps1Config?: {
         nodeId: string;
@@ -846,6 +852,11 @@ const initializeNode = async ({
         console.log('LDK Node: No RGS server configured, using P2P gossip');
     }
 
+    if (scorerUrl) {
+        await setPathfindingScoresSource(scorerUrl);
+        console.log(`LDK Node: Scorer URL set to ${scorerUrl}`);
+    }
+
     if (listeningAddresses && listeningAddresses.length > 0) {
         await setListeningAddresses(listeningAddresses);
     }
@@ -976,6 +987,7 @@ export interface ILdkNodeInjections {
         setStorageDirPath: (path: string) => Promise<void>;
         setEsploraServer: (serverUrl: string) => Promise<void>;
         setGossipSourceRgs: (rgsServerUrl: string) => Promise<void>;
+        setPathfindingScoresSource: (url: string) => Promise<void>;
         setGossipSourceP2p: () => Promise<void>;
         setListeningAddresses: (addresses: string[]) => Promise<void>;
         setLiquiditySourceLsps1: (params: {
@@ -1210,6 +1222,7 @@ export interface ILdkNodeInjections {
             mnemonic: string;
             passphrase?: string | null;
             rgsServerUrl?: string;
+            scorerUrl?: string;
             listeningAddresses?: string[];
             lsps1Config?: {
                 nodeId: string;
@@ -1240,6 +1253,7 @@ const LdkNodeInjection: ILdkNodeInjections = {
         setStorageDirPath,
         setEsploraServer,
         setGossipSourceRgs,
+        setPathfindingScoresSource,
         setGossipSourceP2p,
         setListeningAddresses,
         setLiquiditySourceLsps1,
diff --git a/stores/SettingsStore.ts b/stores/SettingsStore.ts
@@ -55,6 +55,7 @@ export interface Node {
     ldkPassphrase?: string;
     ldkEsploraServer?: string;
     ldkRgsServer?: string;
+    ldkScorerUrl?: string;
     ldkVssServer?: string;
 }
 
@@ -1650,6 +1651,7 @@ export default class SettingsStore {
     @observable public ldkNetwork?: string;
     @observable public ldkEsploraServer?: string;
     @observable public ldkRgsServer?: string;
+    @observable public ldkScorerUrl?: string;
     @observable public ldkVssServer?: string;
     @observable public ldkNodeSyncing: boolean = false;
     @observable public isChannelMigrating: boolean = false;
@@ -1859,6 +1861,7 @@ export default class SettingsStore {
             this.ldkNetwork = node.ldkNetwork;
             this.ldkEsploraServer = node.ldkEsploraServer;
             this.ldkRgsServer = node.ldkRgsServer;
+            this.ldkScorerUrl = node.ldkScorerUrl;
             this.ldkVssServer = node.ldkVssServer;
             // NWC
             this.nostrWalletConnectUrl = node.nostrWalletConnectUrl;
@@ -1873,6 +1876,7 @@ export default class SettingsStore {
             this.ldkNetwork = undefined;
             this.ldkEsploraServer = undefined;
             this.ldkRgsServer = undefined;
+            this.ldkScorerUrl = undefined;
             this.ldkVssServer = undefined;
         }
     };
diff --git a/utils/LdkNodeUtils.ts b/utils/LdkNodeUtils.ts
@@ -46,6 +46,9 @@ export const RGS_SERVERS_TESTNET = [
     'https://rapidsync.lightningdevkit.org/testnet/snapshot'
 ];
 
+// Default pathfinding scores server
+export const DEFAULT_SCORER_URL = 'https://scores.zeusln.com/latest.bin';
+
 /**
  * Get the storage directory path for LDK Node data
  */
@@ -164,6 +167,7 @@ async function initNode({
     network,
     esploraServerUrl,
     rgsServerUrl,
+    scorerUrl,
     listeningAddresses,
     lsps1Config,
     trustedPeers0conf,
@@ -175,6 +179,7 @@ async function initNode({
     network: SupportedNetwork;
     esploraServerUrl?: string;
     rgsServerUrl?: string;
+    scorerUrl?: string;
     listeningAddresses?: string[];
     lsps1Config?: {
         nodeId: string;
@@ -202,6 +207,7 @@ async function initNode({
         mnemonic,
         passphrase: passphrase || null,
         rgsServerUrl: rgsUrl,
+        scorerUrl,
         listeningAddresses,
         lsps1Config,
         trustedPeers0conf,
@@ -223,6 +229,7 @@ export async function createLdkNodeWallet({
     network,
     esploraServerUrl,
     rgsServerUrl,
+    scorerUrl,
     listeningAddresses,
     lsps1Config,
     trustedPeers0conf,
@@ -234,6 +241,7 @@ export async function createLdkNodeWallet({
     network: SupportedNetwork;
     esploraServerUrl?: string;
     rgsServerUrl?: string;
+    scorerUrl?: string;
     listeningAddresses?: string[];
     lsps1Config?: {
         nodeId: string;
@@ -263,6 +271,7 @@ export async function createLdkNodeWallet({
         network,
         esploraServerUrl,
         rgsServerUrl,
+        scorerUrl,
         listeningAddresses,
         lsps1Config,
         trustedPeers0conf,
@@ -286,6 +295,7 @@ export async function startLdkNodeWallet({
     network,
     esploraServerUrl,
     rgsServerUrl,
+    scorerUrl,
     listeningAddresses,
     lsps1Config,
     trustedPeers0conf,
@@ -299,6 +309,7 @@ export async function startLdkNodeWallet({
     network: SupportedNetwork;
     esploraServerUrl?: string;
     rgsServerUrl?: string;
+    scorerUrl?: string;
     listeningAddresses?: string[];
     lsps1Config?: {
         nodeId: string;
@@ -321,6 +332,7 @@ export async function startLdkNodeWallet({
             network,
             esploraServerUrl,
             rgsServerUrl,
+            scorerUrl,
             listeningAddresses,
             lsps1Config,
             trustedPeers0conf,
diff --git a/views/Settings/SeedRecovery.tsx b/views/Settings/SeedRecovery.tsx
@@ -62,7 +62,8 @@ import {
     stopLdkNode,
     getDefaultEsploraServer,
     getDefaultRgsServer,
-    DEFAULT_VSS_SERVER
+    DEFAULT_VSS_SERVER,
+    DEFAULT_SCORER_URL
 } from '../../utils/LdkNodeUtils';
 
 import { BIP39_WORD_LIST } from '../../utils/Bip39Utils';
@@ -755,6 +756,7 @@ export default class SeedRecovery extends React.PureComponent<
                         network: networkType,
                         esploraServerUrl: getDefaultEsploraServer(networkType),
                         rgsServerUrl: getDefaultRgsServer(networkType),
+                        scorerUrl: DEFAULT_SCORER_URL,
                         lsps1Config,
                         trustedPeers0conf: trustedPeers,
                         vssServerUrl: DEFAULT_VSS_SERVER
diff --git a/views/Settings/WalletConfiguration.tsx b/views/Settings/WalletConfiguration.tsx
@@ -78,6 +78,7 @@ import {
     getDefaultEsploraServer,
     getDefaultRgsServer,
     DEFAULT_VSS_SERVER,
+    DEFAULT_SCORER_URL,
     SupportedNetwork
 } from '../../utils/LdkNodeUtils';
 
@@ -1115,6 +1116,7 @@ export default class WalletConfiguration extends React.Component<
                 esploraServerUrl:
                     ldkEsploraServer || getDefaultEsploraServer(networkType),
                 rgsServerUrl: ldkRgsServer || getDefaultRgsServer(networkType),
+                scorerUrl: DEFAULT_SCORER_URL,
                 lsps1Config,
                 trustedPeers0conf: trustedPeers,
                 vssServerUrl: DEFAULT_VSS_SERVER
diff --git a/views/Wallet/Wallet.tsx b/views/Wallet/Wallet.tsx
@@ -60,7 +60,8 @@ import {
 import {
     startLdkNodeWallet,
     stopLdkNode,
-    DEFAULT_VSS_SERVER
+    DEFAULT_VSS_SERVER,
+    DEFAULT_SCORER_URL
 } from '../../utils/LdkNodeUtils';
 import { localeString, bridgeJavaStrings } from '../../utils/LocaleUtils';
 import { isBatterySaverEnabled } from '../../utils/BatteryUtils';
@@ -555,6 +556,7 @@ export default class Wallet extends React.Component<WalletProps, WalletState> {
             ldkNetwork,
             ldkEsploraServer,
             ldkRgsServer,
+            ldkScorerUrl,
             ldkVssServer,
             updateSettings,
             fetchLock
@@ -666,6 +668,10 @@ export default class Wallet extends React.Component<WalletProps, WalletState> {
                         | 'regtest',
                     esploraServerUrl: ldkEsploraServer,
                     rgsServerUrl: ldkRgsServer,
+                    scorerUrl:
+                        ldkScorerUrl === undefined
+                            ? DEFAULT_SCORER_URL
+                            : ldkScorerUrl,
                     lsps1Config,
                     trustedPeers0conf: trustedPeers,
                     vssServerUrl: ldkVssServer || DEFAULT_VSS_SERVER,
