Skip to content

feat(contract-manager): multi-contract support + safety in sync_governance_vaas #3663

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
aditya520 wants to merge 1 commit into
base: main
Choose a base branch
from
+164 −73
Open

feat(contract-manager): multi-contract support + safety in sync_governance_vaas #3663

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
237 changes: 164 additions & 73 deletions contract_manager/scripts/sync_governance_vaas.ts
View file
Open in desktop
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot May 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚩 No test coverage for new CLI features

This PR adds several new features (--all, --contracts-file, --dry-run, --gas-price-gwei, multi-contract support, error-and-continue behavior) but does not include any tests. Per REVIEW.md, new functionality should have tests. While this is a CLI script that is harder to unit test, the core logic (contract filtering, gas price override, VAA processing loop) could be extracted into testable functions. At minimum, the --dry-run mode could serve as a basis for integration testing.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Original file line number Diff line number Diff line change
@@ -1,113 +1,204 @@
/** biome-ignore-all lint/suspicious/noConsole: this is a CLI script */
/** biome-ignore-all lint/style/noNonNullAssertion: store lookups are always present */
/* eslint-disable no-console */
/* eslint-disable @typescript-eslint/no-non-null-assertion */
/* eslint-disable unicorn/no-await-expression-member */
import fs from "node:fs";

import { parseVaa } from "@certusone/wormhole-sdk";
import { decodeGovernancePayload } from "@pythnetwork/xc-admin-common";
import yargs from "yargs";
import { hideBin } from "yargs/helpers";

import { toPrivateKey } from "../src/core/base";
import { SubmittedWormholeMessage, Vault } from "../src/node/utils/governance";
import {
EvmExecutorContract,
EvmPriceFeedContract,
} from "../src/core/contracts/evm";
import type { Vault } from "../src/node/utils/governance";
import { SubmittedWormholeMessage } from "../src/node/utils/governance";
import { DefaultStore } from "../src/node/utils/store";

const parser = yargs(hideBin(process.argv))
.usage(
"Tries to execute all vaas on a contract.\n" +
"Tries to execute all vaas on one or more contracts.\n" +
"Useful for recently deployed contracts.\n" +
"Usage: $0 --contract <contract_id> --private-key <private-key>",
"Usage: $0 (--contract <id> | --contracts-file <path> | --all) --private-key <hex>",
)
.options({
all: {
default: false,
desc: "Sync all mainnet pricefeed/executor contracts in the store.",
type: "boolean",
},
contract: {
array: true,
desc: "Contract id(s) to execute governance vaas for. Can be passed multiple times.",
type: "string",
demandOption: true,
desc: "Contract to execute governance vaas for",
},
"private-key": {
"contracts-file": {
desc: "Path to a newline-separated file of contract ids.",
type: "string",
demandOption: true,
desc: "Private key to sign the transactions executing the governance VAAs. Hex format, without 0x prefix.",
},
offset: {
"dry-run": {
default: false,
desc: "Decode and print what would be executed; do not submit transactions.",
type: "boolean",
},
"gas-price-gwei": {
desc: "Override gasPrice (gwei). Useful on chains with fast-moving base fees.",
type: "number",
},
offset: {
desc: "Starting sequence number to use, if not provided will start from contract last executed governance sequence number",
type: "number",
},
"private-key": {
demandOption: true,
desc: "Private key to sign the transactions executing the governance VAAs. Hex format, without 0x prefix.",
type: "string",
},
});

async function main() {
const argv = await parser.argv;
const contract = DefaultStore.contracts[argv.contract];
if (!contract) {
throw new Error(`Contract ${argv.contract} not found`);

const contracts: (EvmPriceFeedContract | EvmExecutorContract)[] = [];
if (argv.all) {
for (const c of Object.values(DefaultStore.contracts)) {
if (c instanceof EvmPriceFeedContract && c.chain.isMainnet())
contracts.push(c);
}
for (const c of Object.values(DefaultStore.executor_contracts)) {
if (c.chain.isMainnet()) contracts.push(c);
}
}
const governanceSource = await contract.getGovernanceDataSource();
const mainnetVault =
DefaultStore.vaults[
"mainnet-beta_FVQyHcooAtThJ83XFrNnv74BcinbRH3bRmfFamAHBfuj"
]!;
const devnetVault =
DefaultStore.vaults.devnet_6baWtW1zTUVMSJHJQVxDUXWzqrQeYBr6mu31j3bTKwY3!;
let matchedVault: Vault;
if (
(await devnetVault.getEmitter()).toBuffer().toString("hex") ===
governanceSource.emitterAddress
) {
console.log("devnet multisig matches governance source");
matchedVault = devnetVault;
} else if (
(await mainnetVault.getEmitter()).toBuffer().toString("hex") ===
governanceSource.emitterAddress
) {
console.log("mainnet multisig matches governance source");
matchedVault = mainnetVault;
} else {
throw new Error(
"can not find a multisig that matches the governance source of the contract",
const ids = [...(argv.contract ?? [])];
if (argv["contracts-file"]) {
ids.push(
...fs
.readFileSync(argv["contracts-file"], "utf8")
.split("\n")
.map((l) => l.trim())
.filter((l) => l.length > 0 && !l.startsWith("#")),
);
}
let lastExecuted = await contract.getLastExecutedGovernanceSequence();
console.log("last executed governance sequence", lastExecuted);
if (argv.offset && argv.offset > lastExecuted) {
console.log("skipping to offset", argv.offset);
lastExecuted = argv.offset - 1;
for (const id of ids) {
const c = DefaultStore.contracts[id] || DefaultStore.executor_contracts[id];
if (!c) {
console.warn(`[WARN] contract ${id} not found, skipping`);
continue;
}
if (
!(c instanceof EvmPriceFeedContract || c instanceof EvmExecutorContract)
) {
console.warn(`[WARN] contract ${id} is not an EVM contract, skipping`);
continue;
}
contracts.push(c);
}
if (contracts.length === 0) {
throw new Error("Must provide --contract, --contracts-file, or --all");
}
console.log("Starting from sequence number", lastExecuted);

// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
while (true) {
const submittedWormholeMessage = new SubmittedWormholeMessage(
await matchedVault.getEmitter(),
lastExecuted + 1,
matchedVault.cluster,
);
let vaa: Buffer;
try {
vaa = await submittedWormholeMessage.fetchVaa();
} catch (error) {
console.log(error);
console.log("no vaa found for sequence", lastExecuted + 1);
break;
}
const parsedVaa = parseVaa(vaa);
const action = decodeGovernancePayload(parsedVaa.payload);
if (!action) {
console.log("can not decode vaa, skipping");
for (const contract of contracts) {
if (contracts.length > 1) console.log(`=== ${contract.getId()} ===`);

const governanceSource = await contract.getGovernanceDataSource();
const mainnetVault =
DefaultStore.vaults[
"mainnet-beta_FVQyHcooAtThJ83XFrNnv74BcinbRH3bRmfFamAHBfuj"
]!;
const devnetVault =
DefaultStore.vaults.devnet_6baWtW1zTUVMSJHJQVxDUXWzqrQeYBr6mu31j3bTKwY3!;
let matchedVault: Vault;
if (
(await devnetVault.getEmitter()).toBuffer().toString("hex") ===
governanceSource.emitterAddress
) {
console.log("devnet multisig matches governance source");
matchedVault = devnetVault;
} else if (
action.targetChainId === "unset" ||
contract.getChain().wormholeChainName === action.targetChainId
(await mainnetVault.getEmitter()).toBuffer().toString("hex") ===
governanceSource.emitterAddress
) {
console.log("executing vaa", lastExecuted + 1);
await contract.executeGovernanceInstruction(
toPrivateKey(argv["private-key"]),
vaa,
);
console.log("mainnet multisig matches governance source");
matchedVault = mainnetVault;
} else {
console.log(
`vaa is not for this chain (${
contract.getChain().wormholeChainName
} != ${action.targetChainId}, skipping`,
);
console.log("no multisig matches governance source, skipping");
continue;
}
// EvmExecutorContract returns a string, EvmPriceFeedContract returns a number; coerce to be safe.
let lastExecuted = Number(
await contract.getLastExecutedGovernanceSequence(),
);
console.log("last executed governance sequence", lastExecuted);
if (argv.offset && argv.offset > lastExecuted) {
console.log("skipping to offset", argv.offset);
lastExecuted = argv.offset - 1;
}
console.log("Starting from sequence number", lastExecuted);

// Optional gas-price override (e.g. for Arbitrum's fast-moving base fee).
const originalGetGasPrice = contract.chain.getGasPrice.bind(contract.chain);
if (argv["gas-price-gwei"] !== undefined) {
const gasPriceWei = Math.trunc(argv["gas-price-gwei"] * 1e9).toString();
contract.chain.getGasPrice = async () => gasPriceWei;
}

try {
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
while (true) {
const submittedWormholeMessage = new SubmittedWormholeMessage(
await matchedVault.getEmitter(),
lastExecuted + 1,
matchedVault.cluster,
);
let vaa: Buffer;
try {
vaa = await submittedWormholeMessage.fetchVaa();
} catch {
console.log(
`reached end of VAA queue at sequence ${lastExecuted + 1}`,
);
break;
}
const parsedVaa = parseVaa(vaa);
const action = decodeGovernancePayload(parsedVaa.payload);
if (!action) {
console.log("can not decode vaa, skipping");
} else if (
action.targetChainId === "unset" ||
contract.chain.wormholeChainName === action.targetChainId
) {
if (argv["dry-run"]) {
console.log(`[dry-run] would execute vaa ${lastExecuted + 1}`);
} else {
console.log("executing vaa", lastExecuted + 1);
try {
await contract.executeGovernanceInstruction(
toPrivateKey(argv["private-key"]),
vaa,
);
} catch (error) {
console.log(
`failed to execute vaa ${lastExecuted + 1}, continuing:`,
(error as Error).message,
);
}
}
} else {
console.log(
`vaa is not for this chain (${
contract.chain.wormholeChainName
} != ${action.targetChainId}, skipping`,
);
}
lastExecuted++;
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot May 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Stop advancing sequence after failed execution

When executeGovernanceInstruction throws, the script logs and continues, but lastExecuted is still incremented unconditionally. This means a transient failure on sequence N causes the loop to fetch N+1; if N+1 succeeds, the on-chain lastExecutedGovernanceSequence jumps past N (see verifyGovernanceVM in target_chains/ethereum/contracts/contracts/pyth/PythGovernance.sol, which accepts any vm.sequence > lastExecuted and then sets it), making N permanently unexecutable as an old message. This introduces a durable desync risk from a single temporary RPC/gas failure.

Useful? React with 👍 / 👎.

}
} finally {
contract.chain.getGasPrice = originalGetGasPrice;
}
lastExecuted++;
}
}

Expand Down
Loading