@gearbox-protocol/deploy-tools 5.14.1 → 5.15.0

package/dist/index.mjs

@@ -131227,7 +131227,7 @@ var require_chains = __commonJS({
       [exports2.CHAINS.Sonic]: "Sonic"
       // [CHAINS.Base]: "Polygon",
     };
-    var getNetworkType = (chainId, localAs = "Mainnet") => {
+    var getNetworkType2 = (chainId, localAs = "Mainnet") => {
       const chainType = SUPPORTED_CHAINS2[chainId];
       if (chainId === exports2.CHAINS.Local) {
         return localAs;
@@ -131236,7 +131236,7 @@ var require_chains = __commonJS({
       }
       throw new Error("Unsupported network");
     };
-    exports2.getNetworkType = getNetworkType;
+    exports2.getNetworkType = getNetworkType2;
     var isSupportedNetwork = (chainId) => chainId !== void 0 && !!SUPPORTED_CHAINS2[chainId];
     exports2.isSupportedNetwork = isSupportedNetwork;
     var detectNetwork2 = async (provider) => {
@@ -373952,6 +373952,13 @@ var CHAINS_BY_ID = {
   [base.id]: "Base",
   [sonic.id]: "Sonic"
 };
+var getNetworkType = (chainId) => {
+  const chainType = CHAINS_BY_ID[chainId];
+  if (chainType) {
+    return chainType;
+  }
+  throw new Error("Unsupported network");
+};
 async function detectChain(transportOrRPC) {
   const transport = typeof transportOrRPC === "string" ? http(transportOrRPC) : transportOrRPC;
   const tempClient = createPublicClient({ transport });
@@ -406362,6 +406369,142 @@ var ForkTemplate = z.object({
   riskCuratorNames: z.array(z.string()).nullish().transform((v) => v?.length ? v : void 0)
 });
 
+// ../../packages/shared/dist/governor.js
+var GOVERNOR = {
+  Mainnet: "0x29B97F37B3E0C704bCFD785F5b7bBa2A0B7df2c7",
+  Arbitrum: "0xF0C89a0eDCD68B4176A26B3bf7574498DD3E6d09",
+  Optimism: "0xF0C89a0eDCD68B4176A26B3bf7574498DD3E6d09",
+  Base: NOT_DEPLOYED,
+  Sonic: "0x1f3Ee385ce9A6333d73b61086349C4d0f5De0da8"
+};
+var EVENT_TO_STATUS = {
+  QueueBatch: "queued",
+  ExecuteBatch: "executed",
+  CancelBatch: "canceled"
+};
+var GOVERNOR_EVENTS = [
+  parseAbiItem("event QueueBatch(address indexed caller, uint256 indexed batchBlock)"),
+  parseAbiItem("event ExecuteBatch(address indexed caller, uint256 indexed batchBlock)"),
+  parseAbiItem("event CancelBatch(address indexed caller, uint256 indexed batchBlock)")
+];
+var TimelockQueueTransaction = parseAbiItem("event QueueTransaction( bytes32 indexed txHash, address indexed target, uint256 value, string signature, bytes data, uint256 eta )");
+async function loadGovernorBatches(opts) {
+  const { client, logger: logger2, governor: gov, fromBlock, toBlock } = opts;
+  let governor = gov;
+  if (!governor) {
+    const chainId = await client.getChainId();
+    const networkType = getNetworkType(chainId);
+    governor = GOVERNOR[networkType];
+  }
+  const timelock = await client.readContract({
+    address: governor,
+    abi: iGovernorAbi,
+    functionName: "timeLock"
+  });
+  logger2?.info({ timelock, governor, fromBlock, toBlock }, "reading from governor and timelock");
+  let govLogs = await client.getLogs({
+    address: governor,
+    events: GOVERNOR_EVENTS,
+    fromBlock,
+    toBlock,
+    strict: true
+  });
+  govLogs = govLogs.sort(compareLogs);
+  const batches = /* @__PURE__ */ new Map();
+  const batchesByTx = /* @__PURE__ */ new Map();
+  for (const govLog of govLogs) {
+    const { batchBlock } = govLog.args;
+    const status = EVENT_TO_STATUS[govLog.eventName];
+    let batch = batches.get(batchBlock);
+    if (batch?.status === status) {
+      throw new Error(`duplicate batch in block ${batchBlock}`);
+    }
+    if (!batch && (status === "canceled" || status === "executed")) {
+      throw new Error(`batch in block ${batchBlock} is ${status} before queued`);
+    }
+    batch = batch ?? {
+      block: batchBlock,
+      status,
+      queueTxHash: govLog.transactionHash,
+      transactions: []
+    };
+    batch.status = status;
+    batches.set(batchBlock, batch);
+    batchesByTx.set(batch.queueTxHash.toLowerCase(), batch);
+  }
+  logger2?.debug(`loaded ${batches.size} governor batches, in ${govLogs.length} events`);
+  let queue = [];
+  const pageSize = 100000n;
+  for (let start = fromBlock; start <= toBlock; start += pageSize) {
+    let end = start + pageSize - 1n;
+    if (end > toBlock) {
+      end = toBlock;
+    }
+    const logs = await client.getLogs({
+      address: timelock,
+      event: parseAbiItem("event QueueTransaction( bytes32 indexed txHash, address indexed target, uint256 value, string signature, bytes data, uint256 eta )"),
+      fromBlock: start,
+      toBlock: end,
+      strict: true
+    });
+    queue = queue.concat(logs);
+  }
+  queue = queue.sort(compareLogs);
+  logger2?.debug(`loaded ${queue.length} queued timelock transactions`);
+  for (const i of queue) {
+    const { transactionHash } = i;
+    const batch = batchesByTx.get(transactionHash.toLowerCase());
+    if (batch) {
+      batch.transactions.push(normalizeTimelockTx2(i));
+    } else {
+      logger2?.warn(`cannot find batch from transaction ${transactionHash}`);
+    }
+  }
+  let result = Array.from(batches.values());
+  result = result.sort((a, b) => a.block < b.block ? 1 : -1);
+  return result.map((b) => ({
+    id: `batch_${b.block}`,
+    description: `batch in block ${b.block}`,
+    type: "governor",
+    transactions: b.transactions,
+    status: b.status,
+    block: b.block,
+    queueTxHash: b.queueTxHash
+  }));
+}
+function compareLogs(a, b) {
+  if (a.blockNumber < b.blockNumber) {
+    return -1;
+  } else if (a.blockNumber > b.blockNumber) {
+    return 1;
+  } else {
+    return a.logIndex - b.logIndex;
+  }
+}
+function normalizeTimelockTx2(t) {
+  const { data, eta, signature, target, value } = t.args;
+  let funcSignature = signature;
+  if (!funcSignature.startsWith("function")) {
+    funcSignature = `function ${funcSignature}`;
+  }
+  const sighash = toFunctionSelector(funcSignature);
+  const abiItem = parseAbiItem(funcSignature);
+  const decoded = decodeAbiParameters(abiItem.inputs, data);
+  return {
+    target,
+    value: value.toString(10),
+    signature,
+    parameters: abiItem.inputs.map((input, i) => ({
+      name: input.name,
+      // TODO(viem): check if empty name is ok
+      type: input.type,
+      value: decoded[i]
+    })),
+    data: data.replace("0x", sighash),
+    eta: eta.toString(10)
+  };
+}
+
 // ../../packages/shared/dist/hex.js
 function hexEq(a, b) {
   const [aa, bb] = [a, b].map((s) => s.replace(/^0x/, "").toLowerCase());
@@ -410780,7 +410923,7 @@ __export(utilityContracts_exports, {
   BATCH_CHAIN: () => BATCH_CHAIN,
   BLACKLIST_HELPER: () => BLACKLIST_HELPER,
   CREATE2FACTORY: () => CREATE2FACTORY,
-  GOVERNOR: () => GOVERNOR,
+  GOVERNOR: () => GOVERNOR2,
   MULTISIG: () => MULTISIG,
   ROUTER_CREATE2FACTORY: () => ROUTER_CREATE2FACTORY,
   ROUTER_MULTISIG_ADDRESS: () => ROUTER_MULTISIG_ADDRESS,
@@ -410802,13 +410945,7 @@ var TIMELOCK2 = {
   Base: NOT_DEPLOYED,
   Sonic: "0xAdbF876ce58CB65c99b18078353e1DCB16E69e84"
 };
-var GOVERNOR = {
-  Mainnet: "0x29B97F37B3E0C704bCFD785F5b7bBa2A0B7df2c7",
-  Arbitrum: "0xF0C89a0eDCD68B4176A26B3bf7574498DD3E6d09",
-  Optimism: "0xF0C89a0eDCD68B4176A26B3bf7574498DD3E6d09",
-  Base: NOT_DEPLOYED,
-  Sonic: "0x1f3Ee385ce9A6333d73b61086349C4d0f5De0da8"
-};
+var GOVERNOR2 = GOVERNOR;
 var BATCH_CHAIN = {
   Mainnet: "0xB900bDEf6eAc8C5D97F8e876aBC39573Cf6626b2",
   Arbitrum: "0xAEbaa1015D0bc250F5b38aac9b8f65E0668cE3c2",
@@ -411351,7 +411488,7 @@ var GEARBOX_V1_BLOCK = 13810899;
 // ../../packages/node/dist/Verifier.js
 var import_bytecode_utils2 = __toESM(require_main(), 1);
 var import_lib_sourcify = __toESM(require_main2(), 1);
-var import_abi22 = __toESM(require_lib13(), 1);
+var import_abi23 = __toESM(require_lib13(), 1);
 var Verifier = class {
   logger;
   constructor() {
@@ -411426,8 +411563,8 @@ var Verifier = class {
               error: `Failed to match with creation bytecode: constructor ABI Inputs are missing`
             };
           }
-          const decodeResult = import_abi22.defaultAbiCoder.decode(constructorAbiParamInputs, abiEncodedConstructorArguments);
-          const encodeResult = import_abi22.defaultAbiCoder.encode(constructorAbiParamInputs, decodeResult);
+          const decodeResult = import_abi23.defaultAbiCoder.decode(constructorAbiParamInputs, abiEncodedConstructorArguments);
+          const encodeResult = import_abi23.defaultAbiCoder.encode(constructorAbiParamInputs, decodeResult);
           if (encodeResult !== abiEncodedConstructorArguments) {
             return {
               ...result,
@@ -413430,7 +413567,7 @@ var BalancerV3RouterGatewayParser = class extends AbstractParser {
     super(contractType, "constructor(address _balancerV3Router, address _permit2)");
     this._abi = parseAbi([
       "constructor(address _balancerV3Router, address _permit2)",
-      "function swapSingleTokenExactIn( address pool, IERC20 tokenIn, IERC20 tokenOut, uint256 exactAmountIn, uint256 minAmountOut, uint256 deadline, bool wethIsEth, bytes calldata userData ) external returns (uint256 amountOut)"
+      "function swapSingleTokenExactIn(address pool, address tokenIn, address tokenOut, uint256 exactAmountIn, uint256 minAmountOut, uint256 deadline, bool wethIsEth, bytes calldata userData) external returns (uint256 amountOut)"
     ]);
     this.parameterParsers = {
       constructor: [parseAddress(), parseAddress()]
@@ -415807,9 +415944,11 @@ var UpdateParser = class extends ProviderBase {
   }
   async parse(opts) {
     await this.init();
-    const { batchDir, safeTxHashes } = opts;
+    const { batchDir, safeTxHashes, governor } = opts;
     if (batchDir) {
       await this.#parseBatchDir(batchDir, opts.unsafeMainnetMeta);
+    } else if (governor) {
+      await this.#parseGovernorQueue(governor === true ? void 0 : governor);
     } else {
       await this.#parseSafeTxHashes(safeTxHashes);
     }
@@ -415915,6 +416054,30 @@ var UpdateParser = class extends ProviderBase {
     this.#collectCreate2Addresses(parsed);
     return parsed;
   }
+  async #parseGovernorQueue(fromBlock, toBlock) {
+    this.logger.info("parsing governor queue");
+    const latest = await this.client.getBlockNumber();
+    const batches = await loadGovernorBatches({
+      client: this.client,
+      governor: this.address("GOVERNOR"),
+      fromBlock: fromBlock ?? ADDRESS_PROVIDER_BLOCK[this.network],
+      toBlock: toBlock ?? latest,
+      logger: this.logger
+    });
+    const queued = batches.filter((b) => b.status === "queued");
+    this.logger.debug(`loaded ${batches.length} batches, ${queued.length} queued`);
+    for (let i = 0; i < queued.length; i++) {
+      try {
+        const parsed = await this.#parseNormalizedBatch(queued[i], i, queued.length);
+        this.#output.batches.push(parsed);
+      } catch (e) {
+        this.#output.batches.push({
+          id: queued[i].id,
+          error: `${e}`.replaceAll("\n", "\\n")
+        });
+      }
+    }
+  }
   #collectCreate2Addresses(tx) {
     if (isDeployTransaction(tx)) {
       this.#collectCreate2Addresses(tx.constructorTransaction);
@@ -417443,7 +417606,7 @@ function getRenderer(opts) {
 var package_default = {
   name: "@gearbox-protocol/deploy-tools",
   description: "Gearbox deploy tools",
-  version: "5.14.1",
+  version: "5.15.0",
   homepage: "https://gearbox.fi",
   keywords: [
     "gearbox"
@@ -417542,6 +417705,11 @@ function parse() {
       "--safe-tx-hashes [hash...]",
       "Safe tx hashes to get from safe api and verify"
     )
+  ).addOption(
+    new Option(
+      "--governor [starting block]",
+      "Parse governor queue starting from block (or entire queue if not specified)"
+    )
   ).addOption(
     new Option(
       "--unsafe-mainnet-meta",
@@ -417566,7 +417734,8 @@ function parse() {
     const parser = new UpdateParser(opts, version_default);
     const result = await parser.parse({
       ...opts,
-      safeTxHashes: opts.safeTxHashes
+      safeTxHashes: opts.safeTxHashes,
+      governor: opts.governor ? opts.governor === true ? true : BigInt(opts.governor) : void 0
     });
     if (opts.outFile) {
       await writeFile7(opts.outFile, json_stringify(result), "utf-8");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gearbox-protocol/deploy-tools",
   "description": "Gearbox deploy tools",
-  "version": "5.14.1",
+  "version": "5.15.0",
   "homepage": "https://gearbox.fi",
   "keywords": [
     "gearbox"