Merge pull request #187 from synonymdev/mainnet-probe-amount-profiles

Add mainnet probe amount profiles

Author: piotr-iohk

docs/mainnet-probe.md

@@ -17,6 +17,7 @@ It is orchestrated nightly by the private `bitkit-nightly` repo (`mainnet-probe.
 
 | Variable | Default | Description |
 | --- | --- | --- |
+| `PROBE_AMOUNT_PROFILE` | `full` | Default amount set for targets that do not define `amountMsat` or `amountsMsat`: `small`, `large`, `cover`, or `full`. |
 | `PROBE_ORDER` | `config` | Order of probes per target: `config` = amounts as listed in target config, `desc` = highest amount first (avoids small probes "warming up" scorer knowledge of the route), `random` = global shuffle of all target+amount pairs. |
 | `PROBE_RESET_SCORES` | `false` | When `true`, deletes the persisted pathfinding scores (`scorer` and `external_pathfinding_scores_cache` VSS keys) and restarts the node before probing, so every run starts from a fresh scorer (external scores are re-downloaded on startup). Recommended for scorer A/B experiments; the nightly job enables it by default. Accepts `true/false/1/0/yes/no`. |
 | `PROBE_RESET_SCORES_TIMEOUT_SECONDS` | `180` | Timeout for the scores reset devtools command (covers node stop + VSS deletes + node start). |

test/helpers/probe.ts

@@ -58,6 +58,14 @@ const DEFAULT_READINESS_POLL_MS = 5_000;
 const DEFAULT_MIN_GRAPH_CHANNELS = 10_000;
 const DEFAULT_RESET_SCORES_TIMEOUT_SECONDS = 180;
 const DEFAULT_SCORES_SYNC_MAX_AGE_S = 900;
+const DEFAULT_PROBE_AMOUNT_PROFILE = 'full';
+const PROBE_AMOUNT_PROFILES = {
+  small: [1_000_000],
+  large: [80_000_000],
+  cover: [1_000_000, 25_000_000, 80_000_000],
+  full: [1_000_000, 10_000_000, 25_000_000, 50_000_000, 80_000_000],
+} as const;
+type ProbeAmountProfile = keyof typeof PROBE_AMOUNT_PROFILES;
 
 export type ProbeReadiness = {
   ready: boolean;
@@ -102,6 +110,16 @@ export function resolveProbeOrder(): ProbeOrder {
   throw new Error(`Invalid PROBE_ORDER value: ${raw} (expected desc, random or config)`);
 }
 
+export function resolveProbeAmountProfile(): ProbeAmountProfile {
+  const profile = process.env.PROBE_AMOUNT_PROFILE ?? DEFAULT_PROBE_AMOUNT_PROFILE;
+  if (profile === 'small' || profile === 'large' || profile === 'cover' || profile === 'full') {
+    return profile;
+  }
+  throw new Error(
+    `Invalid PROBE_AMOUNT_PROFILE: ${profile}. Expected 'small', 'large', 'cover', or 'full'.`
+  );
+}
+
 export function buildProbeQueue(targets: ProbeTarget[], order: ProbeOrder): ProbeQueueEntry[] {
   const queue = targets.flatMap((target) => {
     const amounts = expandProbeTargetAmounts(target);
@@ -127,10 +145,11 @@ function shuffleInPlace<T>(items: T[]): T[] {
 }
 
 export function expandProbeTargetAmounts(target: ProbeTarget): number[] {
-  const amounts = target.amountsMsat ?? (target.amountMsat ? [target.amountMsat] : []);
-  if (amounts.length === 0) {
-    throw new Error(`Probe target '${target.name}' must define amountMsat or amountsMsat`);
-  }
+  const amounts =
+    target.amountsMsat ??
+    (target.amountMsat
+      ? [target.amountMsat]
+      : [...PROBE_AMOUNT_PROFILES[resolveProbeAmountProfile()]]);
 
   return amounts.map((amountMsat) => {
     if (!Number.isInteger(amountMsat) || amountMsat <= 0) {

test/specs/mainnet/probe.e2e.ts

@@ -6,6 +6,7 @@ import {
   parseNonNegativeIntEnv,
   parseProbeCommandSuccess,
   probeModeForTargetType,
+  resolveProbeAmountProfile,
   resetPathfindingScores,
   resolveProbeOrder,
   resolveProbeResetScores,
@@ -234,6 +235,8 @@ describe('@probe_mainnet - Lightning probe smoke', () => {
       const probes = buildProbeQueue(targets, probeOrder);
       const probeDelayMs = resolveProbeDelayMs();
       const probeRetries = resolveProbeRetries();
+      console.info(`→ [Probe] Probe amount profile configured: ${resolveProbeAmountProfile()}`);
+      console.info(`→ [Probe] Probe order configured: ${resolveProbeOrder()}`);
       console.info(`→ [Probe] Probe retries configured: ${probeRetries}`);
       console.info(
         `→ [Probe] Probe order '${probeOrder}': ${probes