Skip to content

fix(relay-health): consume pool state and unify diagnostics #321

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

Open
rlucky02 wants to merge 2 commits into
base: main
Choose a base branch
from
+702 −376
Open

fix(relay-health): consume pool state and unify diagnostics #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e715e91
fix: unify relay health diagnostics with pool state
rlucky02 Apr 9, 2026
f637f17
fix: separate relay advisories from health issues
rlucky02 Apr 9, 2026
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
268 changes: 2 additions & 266 deletions relay-diagnostic/relay-diagnostic.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,286 +8,22 @@
*/

import { Command } from "commander";
import { NETWORK, getApiBaseUrl } from "../src/lib/config/networks.js";
import { NETWORK } from "../src/lib/config/networks.js";
import { getSponsorRelayUrl, getSponsorApiKey } from "../src/lib/config/sponsor.js";
import { getHiroApi } from "../src/lib/services/hiro-api.js";
import { checkRelayHealth } from "../src/lib/services/relay-health.service.js";
import { getWalletManager } from "../src/lib/services/wallet-manager.js";
import { printJson, handleError } from "../src/lib/utils/cli.js";

// ---------------------------------------------------------------------------
// Types
// ---------------------------------------------------------------------------

interface StuckTransaction {
txid: string;
nonce: number;
pendingSeconds: number;
}

interface NonceStatus {
lastExecuted: number;
lastMempool: number | null;
possibleNext: number;
missingNonces: number[];
mempoolNonces: number[];
hasGaps: boolean;
gapCount: number;
mempoolDesync: boolean;
desyncGap: number;
}

interface RelayHealthStatus {
healthy: boolean;
network: string;
version?: string;
sponsorAddress?: string;
nonceStatus?: NonceStatus;
stuckTransactions?: StuckTransaction[];
issues?: string[];
}

interface HiroNonceInfo {
last_executed_tx_nonce: number | null;
last_mempool_tx_nonce: number | null;
possible_next_nonce: number;
detected_missing_nonces: number[];
detected_mempool_nonces: number[];
}

interface RelayRecoveryResult {
supported: boolean;
message?: string;
result?: unknown;
}

// ---------------------------------------------------------------------------
// Constants
// ---------------------------------------------------------------------------

const SPONSOR_ADDRESSES: Partial<Record<string, string>> = {
mainnet: "SP1PMPPVCMVW96FSWFV30KJQ4MNBMZ8MRWR3JWQ7",
};

// ---------------------------------------------------------------------------
// Core logic
// ---------------------------------------------------------------------------

async function getNonceInfo(
network: "mainnet" | "testnet",
address: string
): Promise<HiroNonceInfo> {
const baseUrl = getApiBaseUrl(network);
const controller = new AbortController();
const timeout = setTimeout(() => controller.abort(), 30000);
try {
const res = await fetch(
`${baseUrl}/extended/v1/address/${address}/nonces`,
{ signal: controller.signal }
);
if (!res.ok) {
throw new Error(
`Failed to fetch nonce info for ${address}: HTTP ${res.status}`
);
}
return (await res.json()) as HiroNonceInfo;
} finally {
clearTimeout(timeout);
}
}

async function checkRelayHealth(
network: "mainnet" | "testnet"
): Promise<RelayHealthStatus & { formatted: string }> {
const relayUrl = getSponsorRelayUrl(network);
const issues: string[] = [];

try {
const controller = new AbortController();
const timeout = setTimeout(() => controller.abort(), 30000);
let healthData: { status?: string; version?: string };
try {
const healthRes = await fetch(`${relayUrl}/health`, {
method: "GET",
signal: controller.signal,
});

if (!healthRes.ok) {
issues.push(`Relay health check failed: HTTP ${healthRes.status}`);
const status: RelayHealthStatus = { healthy: false, network, issues };
return { ...status, formatted: formatRelayHealthStatus(status) };
}

healthData = (await healthRes.json()) as {
status?: string;
version?: string;
};
} finally {
clearTimeout(timeout);
}

const version = healthData.version;

if (healthData.status !== "ok") {
issues.push(`Relay status: ${healthData.status ?? "unknown"}`);
}

const sponsorAddress = SPONSOR_ADDRESSES[network];
if (!sponsorAddress) {
issues.push("Unknown sponsor address for network");
const status: RelayHealthStatus = {
healthy: issues.length === 0,
network,
version,
issues: issues.length > 0 ? issues : undefined,
};
return { ...status, formatted: formatRelayHealthStatus(status) };
}

const nonceInfo = await getNonceInfo(network, sponsorAddress);

const hasGaps = nonceInfo.detected_missing_nonces.length > 0;
const gapCount = nonceInfo.detected_missing_nonces.length;
const lastExecuted = nonceInfo.last_executed_tx_nonce ?? 0;
const lastMempool = nonceInfo.last_mempool_tx_nonce ?? null;
const desyncGap = lastMempool !== null ? lastMempool - lastExecuted : 0;
const mempoolDesync = desyncGap > 5;

if (hasGaps) {
const preview = nonceInfo.detected_missing_nonces.slice(0, 5).join(", ");
issues.push(
`Sponsor has ${gapCount} missing nonce(s): ${preview}${gapCount > 5 ? "..." : ""}`
);
}

if (mempoolDesync) {
issues.push(
`Mempool desync detected: sponsor nonce ${lastExecuted} (executed) vs ${lastMempool} (mempool), gap of ${desyncGap}`
);
} else if (nonceInfo.detected_mempool_nonces.length > 10) {
issues.push(
`Sponsor has ${nonceInfo.detected_mempool_nonces.length} transactions stuck in mempool`
);
}

const nonceStatus: NonceStatus = {
lastExecuted,
lastMempool,
possibleNext: nonceInfo.possible_next_nonce,
missingNonces: nonceInfo.detected_missing_nonces,
mempoolNonces: nonceInfo.detected_mempool_nonces,
hasGaps,
gapCount,
mempoolDesync,
desyncGap,
};

let stuckTransactions: StuckTransaction[] | undefined;
try {
const hiroApi = getHiroApi(network);
const mempoolRes = await hiroApi.getMempoolTransactions({
sender_address: sponsorAddress,
limit: 50,
});
const nowSeconds = Math.floor(Date.now() / 1000);
const stuck = mempoolRes.results
.filter((tx) => nowSeconds - tx.receipt_time > 600)
.map((tx) => ({
txid: tx.tx_id,
nonce: tx.nonce,
pendingSeconds: nowSeconds - tx.receipt_time,
}))
.sort((a, b) => b.pendingSeconds - a.pendingSeconds)
.slice(0, 10);

if (stuck.length > 0) {
stuckTransactions = stuck;
}
} catch {
// Non-fatal: stuck-tx fetch is best-effort
}

const status: RelayHealthStatus = {
healthy: issues.length === 0,
network,
version,
sponsorAddress,
nonceStatus,
stuckTransactions,
issues: issues.length > 0 ? issues : undefined,
};

return { ...status, formatted: formatRelayHealthStatus(status) };
} catch (error) {
issues.push(
`Relay health check error: ${error instanceof Error ? error.message : String(error)}`
);
const status: RelayHealthStatus = { healthy: false, network, issues };
return { ...status, formatted: formatRelayHealthStatus(status) };
}
}

function formatRelayHealthStatus(status: RelayHealthStatus): string {
const lines: string[] = [];

lines.push(`Relay Health Check (${status.network})`);
lines.push(`Status: ${status.healthy ? "HEALTHY" : "UNHEALTHY"}`);

if (status.version) lines.push(`Version: ${status.version}`);
if (status.sponsorAddress) lines.push(`Sponsor: ${status.sponsorAddress}`);

if (status.nonceStatus) {
const ns = status.nonceStatus;
lines.push("");
lines.push("Nonce Status:");
lines.push(` Last executed: ${ns.lastExecuted}`);
lines.push(` Last mempool: ${ns.lastMempool ?? "none"}`);
lines.push(` Next nonce: ${ns.possibleNext}`);

if (ns.hasGaps) {
const preview = ns.missingNonces.slice(0, 10).join(", ");
lines.push(
` GAPS Missing nonces (${ns.gapCount}): ${preview}${ns.gapCount > 10 ? "..." : ""}`
);
} else {
lines.push(" OK No nonce gaps");
}

if (ns.mempoolDesync) {
lines.push(
` DESYNC Mempool desync: executed=${ns.lastExecuted}, mempool=${ns.lastMempool ?? "none"}, gap=${ns.desyncGap}`
);
}

if (ns.mempoolNonces.length > 0) {
const preview = ns.mempoolNonces.slice(0, 10).join(", ");
lines.push(
` WARN Mempool nonces (${ns.mempoolNonces.length}): ${preview}${ns.mempoolNonces.length > 10 ? "..." : ""}`
);
}
}

if (status.stuckTransactions && status.stuckTransactions.length > 0) {
lines.push("");
lines.push("Stuck Transactions:");
for (const tx of status.stuckTransactions) {
const minutes = Math.floor(tx.pendingSeconds / 60);
const seconds = tx.pendingSeconds % 60;
const duration = minutes > 0 ? `${minutes}m ${seconds}s` : `${seconds}s`;
lines.push(` nonce=${tx.nonce} pending=${duration} txid=${tx.txid}`);
}
}

if (status.issues && status.issues.length > 0) {
lines.push("");
lines.push("Issues:");
for (const issue of status.issues) {
lines.push(` - ${issue}`);
}
}

return lines.join("\n");
}

async function attemptRbf(
network: "mainnet" | "testnet",
txids?: string[],
Expand Down
Loading