@hyperlane-xyz/cli 3.2.0 → 3.3.0

package/dist/src/config/hooks.d.ts

@@ -1,8 +1,55 @@
 import { z } from 'zod';
-import { ChainMap, ChainName, HookConfig, HookType, IgpHookConfig, MerkleTreeHookConfig, MultisigIsmConfig, ProtocolFeeHookConfig } from '@hyperlane-xyz/sdk';
+import { ChainMap, ChainName, GasOracleContractType, HookType, HooksConfig, MultisigConfig } from '@hyperlane-xyz/sdk';
 import { Address } from '@hyperlane-xyz/utils';
 import { FileFormat } from '../utils/files.js';
-declare const HookConfigMapSchema: z.ZodObject<{}, "strip", z.ZodObject<{
+declare const HookConfigSchema: z.ZodUnion<[z.ZodObject<{
+    type: z.ZodLiteral<HookType.PROTOCOL_FEE>;
+    owner: z.ZodString;
+    beneficiary: z.ZodString;
+    maxProtocolFee: z.ZodString;
+    protocolFee: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: HookType.PROTOCOL_FEE;
+    owner: string;
+    beneficiary: string;
+    maxProtocolFee: string;
+    protocolFee: string;
+}, {
+    type: HookType.PROTOCOL_FEE;
+    owner: string;
+    beneficiary: string;
+    maxProtocolFee: string;
+    protocolFee: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<HookType.MERKLE_TREE>;
+}, "strip", z.ZodTypeAny, {
+    type: HookType.MERKLE_TREE;
+}, {
+    type: HookType.MERKLE_TREE;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<HookType.INTERCHAIN_GAS_PAYMASTER>;
+    owner: z.ZodString;
+    beneficiary: z.ZodString;
+    overhead: z.ZodRecord<z.ZodString, z.ZodNumber>;
+    gasOracleType: z.ZodRecord<z.ZodString, z.ZodLiteral<GasOracleContractType>>;
+    oracleKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: HookType.INTERCHAIN_GAS_PAYMASTER;
+    owner: string;
+    beneficiary: string;
+    overhead: Record<string, number>;
+    gasOracleType: Record<string, GasOracleContractType>;
+    oracleKey: string;
+}, {
+    type: HookType.INTERCHAIN_GAS_PAYMASTER;
+    owner: string;
+    beneficiary: string;
+    overhead: Record<string, number>;
+    gasOracleType: Record<string, GasOracleContractType>;
+    oracleKey: string;
+}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>]>;
+export type HookConfig = z.infer<typeof HookConfigSchema>;
+declare const HooksConfigMapSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
     required: z.ZodUnion<[z.ZodObject<{
         type: z.ZodLiteral<HookType.PROTOCOL_FEE>;
         owner: z.ZodString;
@@ -27,96 +74,28 @@ declare const HookConfigMapSchema: z.ZodObject<{}, "strip", z.ZodObject<{
         type: HookType.MERKLE_TREE;
     }, {
         type: HookType.MERKLE_TREE;
-    }>]>;
-    default: z.ZodUnion<[z.ZodObject<{
-        type: z.ZodLiteral<HookType.PROTOCOL_FEE>;
-        owner: z.ZodString;
-        beneficiary: z.ZodString;
-        maxProtocolFee: z.ZodString;
-        protocolFee: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    }, {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
     }>, z.ZodObject<{
-        type: z.ZodLiteral<HookType.MERKLE_TREE>;
-    }, "strip", z.ZodTypeAny, {
-        type: HookType.MERKLE_TREE;
-    }, {
-        type: HookType.MERKLE_TREE;
-    }>]>;
-}, "strip", z.ZodTypeAny, {
-    required: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
-    default: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
-}, {
-    required: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
-    default: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
-}>, z.objectOutputType<{}, z.ZodObject<{
-    required: z.ZodUnion<[z.ZodObject<{
-        type: z.ZodLiteral<HookType.PROTOCOL_FEE>;
+        type: z.ZodLiteral<HookType.INTERCHAIN_GAS_PAYMASTER>;
         owner: z.ZodString;
         beneficiary: z.ZodString;
-        maxProtocolFee: z.ZodString;
-        protocolFee: z.ZodString;
+        overhead: z.ZodRecord<z.ZodString, z.ZodNumber>;
+        gasOracleType: z.ZodRecord<z.ZodString, z.ZodLiteral<GasOracleContractType>>;
+        oracleKey: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        type: HookType.PROTOCOL_FEE;
+        type: HookType.INTERCHAIN_GAS_PAYMASTER;
         owner: string;
         beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
+        overhead: Record<string, number>;
+        gasOracleType: Record<string, GasOracleContractType>;
+        oracleKey: string;
     }, {
-        type: HookType.PROTOCOL_FEE;
+        type: HookType.INTERCHAIN_GAS_PAYMASTER;
         owner: string;
         beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    }>, z.ZodObject<{
-        type: z.ZodLiteral<HookType.MERKLE_TREE>;
-    }, "strip", z.ZodTypeAny, {
-        type: HookType.MERKLE_TREE;
-    }, {
-        type: HookType.MERKLE_TREE;
-    }>]>;
+        overhead: Record<string, number>;
+        gasOracleType: Record<string, GasOracleContractType>;
+        oracleKey: string;
+    }>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>]>;
     default: z.ZodUnion<[z.ZodObject<{
         type: z.ZodLiteral<HookType.PROTOCOL_FEE>;
         owner: z.ZodString;
@@ -141,149 +120,48 @@ declare const HookConfigMapSchema: z.ZodObject<{}, "strip", z.ZodObject<{
         type: HookType.MERKLE_TREE;
     }, {
         type: HookType.MERKLE_TREE;
-    }>]>;
-}, "strip", z.ZodTypeAny, {
-    required: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
-    default: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
-}, {
-    required: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
-    default: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
-}>, "strip">, z.objectInputType<{}, z.ZodObject<{
-    required: z.ZodUnion<[z.ZodObject<{
-        type: z.ZodLiteral<HookType.PROTOCOL_FEE>;
-        owner: z.ZodString;
-        beneficiary: z.ZodString;
-        maxProtocolFee: z.ZodString;
-        protocolFee: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    }, {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
     }>, z.ZodObject<{
-        type: z.ZodLiteral<HookType.MERKLE_TREE>;
-    }, "strip", z.ZodTypeAny, {
-        type: HookType.MERKLE_TREE;
-    }, {
-        type: HookType.MERKLE_TREE;
-    }>]>;
-    default: z.ZodUnion<[z.ZodObject<{
-        type: z.ZodLiteral<HookType.PROTOCOL_FEE>;
+        type: z.ZodLiteral<HookType.INTERCHAIN_GAS_PAYMASTER>;
         owner: z.ZodString;
         beneficiary: z.ZodString;
-        maxProtocolFee: z.ZodString;
-        protocolFee: z.ZodString;
+        overhead: z.ZodRecord<z.ZodString, z.ZodNumber>;
+        gasOracleType: z.ZodRecord<z.ZodString, z.ZodLiteral<GasOracleContractType>>;
+        oracleKey: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        type: HookType.PROTOCOL_FEE;
+        type: HookType.INTERCHAIN_GAS_PAYMASTER;
         owner: string;
         beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
+        overhead: Record<string, number>;
+        gasOracleType: Record<string, GasOracleContractType>;
+        oracleKey: string;
     }, {
-        type: HookType.PROTOCOL_FEE;
+        type: HookType.INTERCHAIN_GAS_PAYMASTER;
         owner: string;
         beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    }>, z.ZodObject<{
-        type: z.ZodLiteral<HookType.MERKLE_TREE>;
-    }, "strip", z.ZodTypeAny, {
-        type: HookType.MERKLE_TREE;
-    }, {
-        type: HookType.MERKLE_TREE;
-    }>]>;
+        overhead: Record<string, number>;
+        gasOracleType: Record<string, GasOracleContractType>;
+        oracleKey: string;
+    }>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>]>;
 }, "strip", z.ZodTypeAny, {
-    required: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
-    default: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
+    required?: any;
+    default?: any;
 }, {
-    required: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
-    default: {
-        type: HookType.PROTOCOL_FEE;
-        owner: string;
-        beneficiary: string;
-        maxProtocolFee: string;
-        protocolFee: string;
-    } | {
-        type: HookType.MERKLE_TREE;
-    };
-}>, "strip">>;
-export type HookConfigMap = z.infer<typeof HookConfigMapSchema>;
+    required?: any;
+    default?: any;
+}>>;
+export type HooksConfigMap = z.infer<typeof HooksConfigMapSchema>;
 export declare function isValidHookConfigMap(config: any): boolean;
-export declare function presetHookConfigs(owner: Address, local: ChainName, destinationChains: ChainName[], ismConfig?: MultisigIsmConfig): {
-    required: ProtocolFeeHookConfig;
-    default: {
-        type: HookType;
-        hooks: (MerkleTreeHookConfig | IgpHookConfig)[];
-    };
-};
-export declare function readHookConfig(filePath: string): ChainMap<HookConfig> | undefined;
-export declare function createHookConfig({ format, outPath, chainConfigPath, }: {
+export declare function presetHookConfigs(owner: Address, local: ChainName, destinationChains: ChainName[], multisigConfig?: MultisigConfig): HooksConfig;
+export declare function readHooksConfigMap(filePath: string): ChainMap<HooksConfig> | undefined;
+export declare function createHooksConfigMap({ format, outPath, chainConfigPath, }: {
     format: FileFormat;
     outPath: string;
     chainConfigPath: string;
 }): Promise<void>;
+export declare function createHookConfig(chain: ChainName, remotes: ChainName[]): Promise<HookConfig>;
+export declare function createProtocolFeeConfig(chain: ChainName): Promise<HookConfig>;
+export declare function createIGPConfig(remotes: ChainName[]): Promise<HookConfig>;
+export declare function createAggregationConfig(chain: ChainName, remotes: ChainName[]): Promise<HookConfig>;
+export declare function createRoutingConfig(origin: ChainName, remotes: ChainName[]): Promise<HookConfig>;
 export {};
 //# sourceMappingURL=hooks.d.ts.map

package/dist/src/config/hooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../src/config/hooks.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,QAAQ,EACR,SAAS,EAET,UAAU,EACV,QAAQ,EACR,aAAa,EACb,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EAGtB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,OAAO,EAIR,MAAM,sBAAsB,CAAC;AAI9B,OAAO,EAAE,UAAU,EAAmC,MAAM,mBAAmB,CAAC;AAsBhF,QAAA,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAAsC,CAAC;AAChE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,GAAG,WAE/C;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,EACd,KAAK,EAAE,SAAS,EAChB,iBAAiB,EAAE,SAAS,EAAE,EAC9B,SAAS,CAAC,EAAE,iBAAiB;;;;;;EAqD9B;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,oCAuB9C;AAKD,wBAAsB,gBAAgB,CAAC,EACrC,MAAM,EACN,OAAO,EACP,eAAe,GAChB,EAAE;IACD,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;CACzB,iBAgFA"}
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../src/config/hooks.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,QAAQ,EACR,SAAS,EACT,qBAAqB,EACrB,QAAQ,EACR,WAAW,EACX,cAAc,EAIf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,OAAO,EAIR,MAAM,sBAAsB,CAAC;AAI9B,OAAO,EAAE,UAAU,EAAmC,MAAM,mBAAmB,CAAC;AAwChF,QAAA,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0EAMpB,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAM1D,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAA8B,CAAC;AACzD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,GAAG,WAE/C;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,EACd,KAAK,EAAE,SAAS,EAChB,iBAAiB,EAAE,SAAS,EAAE,EAC9B,cAAc,CAAC,EAAE,cAAc,GAC9B,WAAW,CAuDb;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,qCAoBlD;AAED,wBAAsB,oBAAoB,CAAC,EACzC,MAAM,EACN,OAAO,EACP,eAAe,GAChB,EAAE;IACD,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;CACzB,iBAyBA;AAED,wBAAsB,gBAAgB,CACpC,KAAK,EAAE,SAAS,EAChB,OAAO,EAAE,SAAS,EAAE,GACnB,OAAO,CAAC,UAAU,CAAC,CAmDrB;AAED,wBAAsB,uBAAuB,CAC3C,KAAK,EAAE,SAAS,GACf,OAAO,CAAC,UAAU,CAAC,CA6CrB;AAED,wBAAsB,eAAe,CACnC,OAAO,EAAE,SAAS,EAAE,GACnB,OAAO,CAAC,UAAU,CAAC,CA2CrB;AAED,wBAAsB,uBAAuB,CAC3C,KAAK,EAAE,SAAS,EAChB,OAAO,EAAE,SAAS,EAAE,GACnB,OAAO,CAAC,UAAU,CAAC,CAgBrB;AAED,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,SAAS,EAAE,GACnB,OAAO,CAAC,UAAU,CAAC,CAmBrB"}