feat(infra): svm igp update script (#7223)

Author: paulbalaji

.changeset/eighty-dragons-shop.md

@@ -0,0 +1,5 @@
+---
+"@hyperlane-xyz/sdk": minor
+---
+
+Fixed critical schema bug where SealevelIgpData.gas_oracles was incorrectly typed as Map<number, bigint> instead of Map<number, SealevelGasOracle>, preventing proper deserialization of on-chain gas oracle state. Added SealevelRemoteGasData, SealevelGasOracle, and related Borsh schemas to match the Rust implementation. Implemented createSetGasOracleConfigsInstruction() and createSetDestinationGasOverheadsInstruction() methods on the IGP adapters, along with gasOracleMatches() helper with BigInt-safe comparison for detecting configuration drift between expected and actual on-chain values.

typescript/infra/config/environments/mainnet3/igp.ts

@@ -46,7 +46,24 @@ export function getOverheadWithOverrides(local: ChainName, remote: ChainName) {
 
 function getOracleConfigWithOverrides(origin: ChainName) {
   const oracleConfig = storageGasOracleConfig[origin];
-  /* apply overrides in here if needed */
+
+  // WORKAROUND for Sealevel IGP decimal bug (solaxy-specific):
+  // The Rust Sealevel IGP code hardcodes SOL_DECIMALS = 9, but solaxy has 6 decimals.
+  // Rather than trying to calculate the correct workaround values, we hardcode
+  // the values that are already set on-chain and known to work.
+  if (origin === 'solaxy') {
+    oracleConfig.ethereum = {
+      gasPrice: '9',
+      tokenExchangeRate: '15000000000000000000',
+      tokenDecimals: 6,
+    };
+    oracleConfig.solanamainnet = {
+      gasPrice: '1',
+      tokenExchangeRate: '15000000000000000000',
+      tokenDecimals: 6,
+    };
+  }
+
   return oracleConfig;
 }
 

typescript/infra/scripts/gas/print-all-gas-oracles.ts

@@ -1,16 +1,15 @@
-import { ChainMap, ProtocolAgnositicGasOracleConfig } from '@hyperlane-xyz/sdk';
+import { ChainMap } from '@hyperlane-xyz/sdk';
 import { stringifyObject } from '@hyperlane-xyz/utils';
 
 import { getChains } from '../../config/registry.js';
+import {
+  type GasOracleConfigWithOverhead,
+  OracleConfigSchema,
+} from '../../src/config/gas-oracle.js';
 import { writeAndFormatJsonAtPath } from '../../src/utils/utils.js';
 import { getArgs, withOutputFile } from '../agent-utils.js';
 import { getEnvironmentConfig } from '../core-utils.js';
 
-interface GasOracleConfigWithOverhead {
-  oracleConfig: ProtocolAgnositicGasOracleConfig;
-  overhead?: number;
-}
-
 async function main() {
   const allChainChoices = getChains();
 
@@ -68,8 +67,9 @@ async function main() {
             );
           }
 
+          const validatedOracleConfig = OracleConfigSchema.parse(oracleConfig);
           destAcc[destination] = {
-            oracleConfig,
+            oracleConfig: validatedOracleConfig,
             overhead: igpConfig?.overhead?.[destination],
           };
           return destAcc;

typescript/infra/scripts/sealevel-helpers/print-gas-oracles.ts

@@ -13,8 +13,9 @@ import {
 import { WarpRouteIds } from '../../config/environments/mainnet3/warp/warpIds.js';
 import { getChain, getWarpAddresses } from '../../config/registry.js';
 import { DeployEnvironment } from '../../src/config/environment.js';
+import { svmGasOracleConfigPath } from '../../src/utils/sealevel.js';
 import { writeAndFormatJsonAtPath } from '../../src/utils/utils.js';
-import { getArgs, withOutputFile } from '../agent-utils.js';
+import { getArgs, withWrite } from '../agent-utils.js';
 import { getEnvironmentConfig } from '../core-utils.js';
 
 // This script exists to print the gas oracle configs for a given environment
@@ -26,7 +27,7 @@ interface GasOracleConfigWithOverhead {
 }
 
 async function main() {
-  const { environment, outFile } = await withOutputFile(getArgs()).argv;
+  const { environment, write } = await withWrite(getArgs()).argv;
 
   const environmentConfig = getEnvironmentConfig(environment);
 
@@ -75,11 +76,12 @@ async function main() {
       value !== undefined,
   );
 
-  console.log(stringifyObject(gasOracles, 'json', 2));
-
-  if (outFile) {
-    console.log(`Writing config to ${outFile}`);
-    writeAndFormatJsonAtPath(outFile, gasOracles);
+  if (write) {
+    const filepath = svmGasOracleConfigPath(environment);
+    console.log(`Writing config to ${filepath}`);
+    await writeAndFormatJsonAtPath(filepath, gasOracles);
+  } else {
+    console.log(stringifyObject(gasOracles, 'json', 2));
   }
 }
 

typescript/infra/scripts/sealevel-helpers/print-multisig-ism-config.ts

@@ -1,23 +1,51 @@
-import { IsmType } from '@hyperlane-xyz/sdk';
+import path from 'path';
 
+import { ChainName, IsmType } from '@hyperlane-xyz/sdk';
+
+import { Contexts } from '../../config/contexts.js';
 import { multisigIsms } from '../../config/multisigIsm.js';
 import { getChains } from '../../config/registry.js';
-import { getArgs, withContext } from '../agent-utils.js';
+import { DeployEnvironment } from '../../src/config/environment.js';
+import {
+  assertContext,
+  getMonorepoRoot,
+  writeAndFormatJsonAtPath,
+} from '../../src/utils/utils.js';
+import { getArgs, withWrite } from '../agent-utils.js';
 
 // This script exists to print the default multisig ISM validator sets for a given environment
 // so they can easily be copied into the Sealevel tooling. :'(
 
+const multisigIsmConfigPath = (
+  environment: DeployEnvironment,
+  context: Contexts,
+  local: ChainName,
+) =>
+  path.resolve(
+    getMonorepoRoot(),
+    `rust/sealevel/environments/${environment}/multisig-ism-message-id/${local}/${context}/multisig-config.json`,
+  );
+
 async function main() {
-  const args = await withContext(getArgs())
+  const {
+    environment,
+    local,
+    context = Contexts.Hyperlane,
+    write,
+  } = await withWrite(getArgs())
+    .describe('context', 'write multisig ISM config to context')
+    .choices('context', [Contexts.Hyperlane, Contexts.ReleaseCandidate])
+    .alias('x', 'context')
     .describe('local', 'local chain')
     .choices('local', getChains())
     .demandOption('local').argv;
 
   const config = multisigIsms(
-    args.environment,
-    args.local,
+    environment,
+    local,
     IsmType.MESSAGE_ID_MULTISIG,
-    args.context,
+    // generate for hyperlane context by default
+    Contexts.Hyperlane,
   );
 
   // Cap any thresholds to 4 due to the Sealevel transaction size limit.
@@ -44,7 +72,17 @@ async function main() {
     }
   }
 
-  console.log(JSON.stringify(config, null, 2));
+  if (write) {
+    // write to the context directory
+    // we use the `hyperlane` context for all config generation
+    // but when deploying new SVM ISMS, we deploy/configure a new "release candidate" ISM
+    // before promoting it to the `hyperlane` context and setting it as the default ISM
+    const filepath = multisigIsmConfigPath(environment, context, local);
+    console.log(`Writing config to ${filepath}`);
+    await writeAndFormatJsonAtPath(filepath, config);
+  } else {
+    console.log(JSON.stringify(config, null, 2));
+  }
 }
 
 main().catch((err) => {