Merge branch 'main' into kunal/fix-fallback-ism-issue

.changeset/odd-keys-pretend.md

@@ -0,0 +1,7 @@
+---
+'@hyperlane-xyz/cli': minor
+'@hyperlane-xyz/infra': patch
+'@hyperlane-xyz/sdk': patch
+---
+
+Allow CLI to accept hook as a config

.eslintrc

@@ -23,6 +23,7 @@
     "no-extra-boolean-cast": ["error"],
     "no-ex-assign": ["error"],
     "no-constant-condition": ["off"],
+    "guard-for-in": ["error"],
     "@typescript-eslint/ban-ts-comment": ["off"],
     "@typescript-eslint/explicit-module-boundary-types": ["off"],
     "@typescript-eslint/no-explicit-any": ["off"],

package.json

@@ -22,7 +22,7 @@
     "clean": "yarn workspaces foreach --all --parallel run clean",
     "prettier": "yarn workspaces foreach --since --parallel run prettier",
     "lint": "yarn workspaces foreach --since --parallel run lint",
-    "test": "yarn workspaces foreach --since --parallel run test",
+    "test": "yarn workspaces foreach --all --parallel run test",
     "coverage": "yarn workspaces foreach --since --parallel run coverage",
     "version:prepare": "yarn changeset version && yarn workspaces foreach --all --parallel run version:update && yarn install --no-immutable",
     "version:check": "yarn changeset status",

typescript/cli/ci-test.sh

@@ -39,7 +39,7 @@ yarn workspace @hyperlane-xyz/cli run hyperlane deploy core \
     --chains ./examples/anvil-chains.yaml \
     --artifacts /tmp/empty-artifacts.json \
     --ism ./examples/ism.yaml \
-    --hook ./examples/hook-config.yaml \
+    --hook ./examples/hooks.yaml \
     --out /tmp \
     --key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 \
     --yes

typescript/cli/examples/hooks.yaml

@@ -0,0 +1,66 @@
+# A config to define the hooks for core contract deployments
+# Ideally, use the `hyperlane config create hooks` command to generate this file
+# but you we can refer to https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/typescript/sdk/src/hook/types.ts for the matching types
+
+# HooksConfig:
+#  required: HookConfig
+#  default: HookConfig
+
+# HookConfig:
+#   type: HookType
+#   ... hook-specific config
+
+# HookType:
+#  - merkleTreeHook
+#  - domainRoutingHook
+#  - interchainGasPaymaster
+#  - protocolFee
+#  - aggregationHook
+#  - opStack (not yet supported)
+
+anvil1:
+  required:
+    type: protocolFee
+    maxProtocolFee: '1000000000000000000' # in wei (string)
+    protocolFee: '200000000000000' # in wei (string)
+    beneficiary: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+    owner: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+  default:
+    type: domainRoutingHook
+    owner: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+    domains:
+      anvil2:
+        type: aggregationHook
+        hooks:
+          - type: merkleTreeHook
+          - type: interchainGasPaymaster
+            beneficiary: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+            owner: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+            oracleKey: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+            overhead:
+              anvil2: 50000 # gas amount (number)
+            gasOracleType:
+              anvil2: StorageGasOracle
+anvil2:
+  required:
+    type: protocolFee
+    maxProtocolFee: '1000000000000000000'
+    protocolFee: '200000000000000'
+    beneficiary: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+    owner: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+  default:
+    type: domainRoutingHook
+    owner: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+    domains:
+      anvil1:
+        type: aggregationHook
+        hooks:
+          - type: merkleTreeHook
+          - type: interchainGasPaymaster
+            beneficiary: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+            owner: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+            oracleKey: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+            overhead:
+              anvil1: 50000
+            gasOracleType:
+              anvil1: StorageGasOracle

typescript/cli/src/commands/config.ts

@@ -2,7 +2,7 @@ import { CommandModule } from 'yargs';
 
 import { log, logGreen } from '../../logger.js';
 import { createChainConfig, readChainConfigs } from '../config/chain.js';
-import { createHookConfig } from '../config/hooks.js';
+import { createHooksConfigMap } from '../config/hooks.js';
 import { createIsmConfigMap, readIsmConfig } from '../config/ism.js';
 import {
   createMultisigConfig,
@@ -96,8 +96,8 @@ const createIsmConfigCommand: CommandModule = {
 };
 
 const createHookConfigCommand: CommandModule = {
-  command: 'hook',
-  describe: 'Create a new Hook config',
+  command: 'hooks',
+  describe: 'Create a new hooks config (required & default)',
   builder: (yargs) =>
     yargs.options({
       output: outputFileOption('./configs/hooks.yaml'),
@@ -108,7 +108,7 @@ const createHookConfigCommand: CommandModule = {
     const format: FileFormat = argv.format;
     const outPath: string = argv.output;
     const chainConfigPath: string = argv.chains;
-    await createHookConfig({ format, outPath, chainConfigPath });
+    await createHooksConfigMap({ format, outPath, chainConfigPath });
     process.exit(0);
   },
 };