@hyperlane-xyz/sdk 13.2.1 → 13.4.0

package/dist/router/types.js

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { ProxyAdmin__factory, TimelockController__factory, } from '@hyperlane-xyz/core';
+import { isNumeric } from '@hyperlane-xyz/utils';
 import { HookConfigSchema } from '../hook/types.js';
 import { IsmConfigSchema } from '../ism/types.js';
 import { ZHash } from '../metadata/customZodTypes.js';
@@ -28,18 +29,26 @@ export const MailboxClientConfigSchema = OwnableSchema.extend({
 export const ForeignDeploymentConfigSchema = z.object({
     foreignDeployment: z.string().optional(),
 });
-export const RemoteRouterDomain = z.string();
+export const RemoteRouterDomainOrChainNameSchema = z.string().or(z.number());
+export function resolveRouterMapConfig(multiProvider, routerMap) {
+    return Object.fromEntries(Object.entries(routerMap).map(([domainIdOrChainName, value]) => {
+        if (isNumeric(domainIdOrChainName)) {
+            return [parseInt(domainIdOrChainName), value];
+        }
+        const meta = multiProvider.getChainMetadata(domainIdOrChainName);
+        return [meta.domainId, value];
+    }));
+}
 export const RemoteRouterRouter = z.object({
     address: z.string().startsWith('0x'),
 });
-export const RemoteRoutersSchema = z.record(RemoteRouterDomain, RemoteRouterRouter);
+export const RemoteRoutersSchema = z.record(RemoteRouterDomainOrChainNameSchema, RemoteRouterRouter);
 export const RouterConfigSchema = MailboxClientConfigSchema.merge(ForeignDeploymentConfigSchema).merge(z.object({
     remoteRouters: RemoteRoutersSchema.optional(),
     proxyAdmin: DeployedOwnableSchema.optional(),
 }));
-const DestinationGasDomain = z.string();
 const DestinationGasAmount = z.string(); // This must be a string type to match Ether's type
-export const DestinationGasSchema = z.record(DestinationGasDomain, DestinationGasAmount);
+export const DestinationGasSchema = z.record(RemoteRouterDomainOrChainNameSchema, DestinationGasAmount);
 export const GasRouterConfigSchema = RouterConfigSchema.extend({
     gas: z.number().optional(),
     destinationGas: DestinationGasSchema.optional(),

package/dist/router/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/router/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAEL,mBAAmB,EAEnB,2BAA2B,GAC5B,MAAM,qBAAqB,CAAC;AAM7B,OAAO,EAAqB,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAoB,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AACtD,OAAO,EAAY,qBAAqB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AA4B7E,MAAM,CAAC,MAAM,gBAAgB,GAAqB;IAChD,UAAU,EAAE,IAAI,mBAAmB,EAAE;IACrC,kBAAkB,EAAE,IAAI,2BAA2B,EAAE;CACtD,CAAC;AAEF,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,6DAAsC,CAAA;IACtC,gDAAyB,CAAA;IACzB,0CAAmB,CAAA;AACrB,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B;AAQD,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,kFAA2D,CAAA;IAC3D,sEAA+C,CAAA;IAC/C,sDAA+B,CAAA;AACjC,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B;AA4BD,MAAM,CAAC,MAAM,yBAAyB,GAAG,aAAa,CAAC,MAAM,CAAC;IAC5D,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IACjC,wBAAwB,EAAE,eAAe,CAAC,QAAQ,EAAE;CACrD,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;AAC7C,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;CACrC,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CACzC,kBAAkB,EAClB,kBAAkB,CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,KAAK,CAC/D,6BAA6B,CAC9B,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;IACP,aAAa,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IAC7C,UAAU,EAAE,qBAAqB,CAAC,QAAQ,EAAE;CAC7C,CAAC,CACH,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;AACxC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,mDAAmD;AAC5F,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAC1C,oBAAoB,EACpB,oBAAoB,CACrB,CAAC;AACF,MAAM,CAAC,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,MAAM,CAAC;IAC7D,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,cAAc,EAAE,oBAAoB,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/router/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAEL,mBAAmB,EAEnB,2BAA2B,GAC5B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAA2B,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAK1E,OAAO,EAAqB,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAoB,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AAEtD,OAAO,EAAY,qBAAqB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAwB7E,MAAM,CAAC,MAAM,gBAAgB,GAAqB;IAChD,UAAU,EAAE,IAAI,mBAAmB,EAAE;IACrC,kBAAkB,EAAE,IAAI,2BAA2B,EAAE;CACtD,CAAC;AAEF,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,6DAAsC,CAAA;IACtC,gDAAyB,CAAA;IACzB,0CAAmB,CAAA;AACrB,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B;AAQD,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,kFAA2D,CAAA;IAC3D,sEAA+C,CAAA;IAC/C,sDAA+B,CAAA;AACjC,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B;AA4BD,MAAM,CAAC,MAAM,yBAAyB,GAAG,aAAa,CAAC,MAAM,CAAC;IAC5D,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,gBAAgB,CAAC,QAAQ,EAAE;IACjC,wBAAwB,EAAE,eAAe,CAAC,QAAQ,EAAE;CACrD,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AAK7E,MAAM,UAAU,sBAAsB,CACpC,aAA4B,EAC5B,SAAmD;IAEnD,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,mBAAmB,EAAE,KAAK,CAAC,EAAE,EAAE;QAC7D,IAAI,SAAS,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACnC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,KAAK,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,IAAI,GAAG,aAAa,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QACjE,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAChC,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;CACrC,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CACzC,mCAAmC,EACnC,kBAAkB,CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,KAAK,CAC/D,6BAA6B,CAC9B,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;IACP,aAAa,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IAC7C,UAAU,EAAE,qBAAqB,CAAC,QAAQ,EAAE;CAC7C,CAAC,CACH,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,mDAAmD;AAC5F,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAC1C,mCAAmC,EACnC,oBAAoB,CACrB,CAAC;AACF,MAAM,CAAC,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,MAAM,CAAC;IAC7D,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,cAAc,EAAE,oBAAoB,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC"}

package/dist/token/CosmosNativeWarpRouteReader.d.ts

@@ -0,0 +1,51 @@
+import { HyperlaneModuleClient, SigningHyperlaneModuleClient } from '@hyperlane-xyz/cosmos-sdk';
+import { Address } from '@hyperlane-xyz/utils';
+import { CosmosNativeHookReader } from '../hook/CosmosNativeHookReader.js';
+import { CosmosNativeIsmReader } from '../ism/CosmosNativeIsmReader.js';
+import { ChainMetadataManager } from '../metadata/ChainMetadataManager.js';
+import { DestinationGas, MailboxClientConfig, RemoteRouters } from '../router/types.js';
+import { ChainNameOrId } from '../types.js';
+import { TokenType } from './config.js';
+import { DerivedTokenRouterConfig, HypTokenConfig } from './types.js';
+export declare class CosmosNativeWarpRouteReader {
+    protected readonly metadataManager: ChainMetadataManager;
+    protected readonly chain: ChainNameOrId;
+    protected readonly cosmosProviderOrSigner: SigningHyperlaneModuleClient | HyperlaneModuleClient;
+    protected readonly logger: import("pino").default.Logger<never>;
+    hookReader: CosmosNativeHookReader;
+    ismReader: CosmosNativeIsmReader;
+    constructor(metadataManager: ChainMetadataManager, chain: ChainNameOrId, cosmosProviderOrSigner: SigningHyperlaneModuleClient | HyperlaneModuleClient);
+    /**
+     * Derives the configuration for a Hyperlane ERC20 router contract at the given address.
+     *
+     * @param warpRouteAddress - The address of the Hyperlane ERC20 router contract.
+     * @returns The configuration for the Hyperlane ERC20 router.
+     *
+     */
+    deriveWarpRouteConfig(warpRouteAddress: Address): Promise<DerivedTokenRouterConfig>;
+    /**
+     * Derives the token type for a given Warp Route address using specific methods
+     *
+     * @param warpRouteAddress - The Warp Route address to derive the token type for.
+     * @returns The derived token type, which can be one of: collateralVault, collateral, native, or synthetic.
+     */
+    deriveTokenType(warpRouteAddress: Address): Promise<TokenType>;
+    /**
+     * Fetches the base metadata for a Warp Route contract.
+     *
+     * @param routerAddress - The address of the Warp Route contract.
+     * @returns The base metadata for the Warp Route contract, including the mailbox, owner, hook, and ism.
+     */
+    fetchMailboxClientConfig(routerAddress: Address): Promise<MailboxClientConfig>;
+    /**
+     * Fetches the metadata for a token address.
+     *
+     * @param warpRouteAddress - The address of the token.
+     * @returns A partial ERC20 metadata object containing the token name, symbol, total supply, and decimals.
+     * Throws if unsupported token type
+     */
+    fetchTokenConfig(type: TokenType, warpRouteAddress: Address): Promise<HypTokenConfig>;
+    fetchRemoteRouters(warpRouteAddress: Address): Promise<RemoteRouters>;
+    fetchDestinationGas(warpRouteAddress: Address): Promise<DestinationGas>;
+}
+//# sourceMappingURL=CosmosNativeWarpRouteReader.d.ts.map

package/dist/token/CosmosNativeWarpRouteReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CosmosNativeWarpRouteReader.d.ts","sourceRoot":"","sources":["../../src/token/CosmosNativeWarpRouteReader.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,OAAO,EAAsB,MAAM,sBAAsB,CAAC;AAEnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,aAAa,EAEd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEtE,qBAAa,2BAA2B;IAQpC,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,oBAAoB;IACxD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,aAAa;IACvC,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EACrC,4BAA4B,GAC5B,qBAAqB;IAX3B,SAAS,CAAC,QAAQ,CAAC,MAAM,uCAEtB;IACH,UAAU,EAAE,sBAAsB,CAAC;IACnC,SAAS,EAAE,qBAAqB,CAAC;gBAGZ,eAAe,EAAE,oBAAoB,EACrC,KAAK,EAAE,aAAa,EACpB,sBAAsB,EACrC,4BAA4B,GAC5B,qBAAqB;IAY3B;;;;;;OAMG;IACG,qBAAqB,CACzB,gBAAgB,EAAE,OAAO,GACxB,OAAO,CAAC,wBAAwB,CAAC;IAiBpC;;;;;OAKG;IACG,eAAe,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IAqBpE;;;;;OAKG;IACG,wBAAwB,CAC5B,aAAa,EAAE,OAAO,GACrB,OAAO,CAAC,mBAAmB,CAAC;IAoB/B;;;;;;OAMG;IACG,gBAAgB,CACpB,IAAI,EAAE,SAAS,EACf,gBAAgB,EAAE,OAAO,GACxB,OAAO,CAAC,cAAc,CAAC;IAOpB,kBAAkB,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IAgBrE,mBAAmB,CACvB,gBAAgB,EAAE,OAAO,GACxB,OAAO,CAAC,cAAc,CAAC;CAa3B"}

package/dist/token/CosmosNativeWarpRouteReader.js

@@ -0,0 +1,123 @@
+import { warpTypes } from '@hyperlane-xyz/cosmos-types';
+import { assert, rootLogger } from '@hyperlane-xyz/utils';
+import { CosmosNativeHookReader } from '../hook/CosmosNativeHookReader.js';
+import { CosmosNativeIsmReader } from '../ism/CosmosNativeIsmReader.js';
+import { RemoteRoutersSchema, } from '../router/types.js';
+import { TokenType } from './config.js';
+export class CosmosNativeWarpRouteReader {
+    metadataManager;
+    chain;
+    cosmosProviderOrSigner;
+    logger = rootLogger.child({
+        module: 'CosmosNativeWarpRouteReader',
+    });
+    hookReader;
+    ismReader;
+    constructor(metadataManager, chain, cosmosProviderOrSigner) {
+        this.metadataManager = metadataManager;
+        this.chain = chain;
+        this.cosmosProviderOrSigner = cosmosProviderOrSigner;
+        this.hookReader = new CosmosNativeHookReader(metadataManager, cosmosProviderOrSigner);
+        this.ismReader = new CosmosNativeIsmReader(metadataManager, cosmosProviderOrSigner);
+    }
+    /**
+     * Derives the configuration for a Hyperlane ERC20 router contract at the given address.
+     *
+     * @param warpRouteAddress - The address of the Hyperlane ERC20 router contract.
+     * @returns The configuration for the Hyperlane ERC20 router.
+     *
+     */
+    async deriveWarpRouteConfig(warpRouteAddress) {
+        // Derive the config type
+        const type = await this.deriveTokenType(warpRouteAddress);
+        const baseMetadata = await this.fetchMailboxClientConfig(warpRouteAddress);
+        const tokenConfig = await this.fetchTokenConfig(type, warpRouteAddress);
+        const remoteRouters = await this.fetchRemoteRouters(warpRouteAddress);
+        const destinationGas = await this.fetchDestinationGas(warpRouteAddress);
+        return {
+            ...baseMetadata,
+            ...tokenConfig,
+            remoteRouters,
+            destinationGas,
+            type,
+        };
+    }
+    /**
+     * Derives the token type for a given Warp Route address using specific methods
+     *
+     * @param warpRouteAddress - The Warp Route address to derive the token type for.
+     * @returns The derived token type, which can be one of: collateralVault, collateral, native, or synthetic.
+     */
+    async deriveTokenType(warpRouteAddress) {
+        const { token } = await this.cosmosProviderOrSigner.query.warp.Token({
+            id: warpRouteAddress,
+        });
+        if (!token) {
+            throw new Error(`Failed to find token for address ${warpRouteAddress}`);
+        }
+        switch (token.token_type) {
+            case warpTypes.HypTokenType.HYP_TOKEN_TYPE_COLLATERAL:
+                return TokenType.collateral;
+            case warpTypes.HypTokenType.HYP_TOKEN_TYPE_SYNTHETIC:
+                return TokenType.synthetic;
+            default:
+                throw new Error(`Failed to determine token type for address ${warpRouteAddress}`);
+        }
+    }
+    /**
+     * Fetches the base metadata for a Warp Route contract.
+     *
+     * @param routerAddress - The address of the Warp Route contract.
+     * @returns The base metadata for the Warp Route contract, including the mailbox, owner, hook, and ism.
+     */
+    async fetchMailboxClientConfig(routerAddress) {
+        const { token } = await this.cosmosProviderOrSigner.query.warp.Token({
+            id: routerAddress,
+        });
+        assert(token, `Failed to find token for address ${routerAddress}`);
+        const config = {
+            mailbox: token.origin_mailbox,
+            owner: token.owner,
+        };
+        if (token.ism_id) {
+            const derivedIsm = await this.ismReader.deriveIsmConfig(token.ism_id);
+            config.interchainSecurityModule = derivedIsm;
+        }
+        return config;
+    }
+    /**
+     * Fetches the metadata for a token address.
+     *
+     * @param warpRouteAddress - The address of the token.
+     * @returns A partial ERC20 metadata object containing the token name, symbol, total supply, and decimals.
+     * Throws if unsupported token type
+     */
+    async fetchTokenConfig(type, warpRouteAddress) {
+        return {
+            type,
+            token: warpRouteAddress,
+        };
+    }
+    async fetchRemoteRouters(warpRouteAddress) {
+        const { remote_routers } = await this.cosmosProviderOrSigner.query.warp.RemoteRouters({
+            id: warpRouteAddress,
+        });
+        const routers = {};
+        for (const router of remote_routers) {
+            routers[router.receiver_domain] = {
+                address: router.receiver_contract,
+            };
+        }
+        return RemoteRoutersSchema.parse(routers);
+    }
+    async fetchDestinationGas(warpRouteAddress) {
+        const { remote_routers } = await this.cosmosProviderOrSigner.query.warp.RemoteRouters({
+            id: warpRouteAddress,
+        });
+        return Object.fromEntries(remote_routers.map((routerConfig) => [
+            routerConfig.receiver_domain,
+            routerConfig.gas,
+        ]));
+    }
+}
+//# sourceMappingURL=CosmosNativeWarpRouteReader.js.map

package/dist/token/CosmosNativeWarpRouteReader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CosmosNativeWarpRouteReader.js","sourceRoot":"","sources":["../../src/token/CosmosNativeWarpRouteReader.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAW,MAAM,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAExE,OAAO,EAIL,mBAAmB,GACpB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,MAAM,OAAO,2BAA2B;IAQjB;IACA;IACA;IATF,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC;QAC3C,MAAM,EAAE,6BAA6B;KACtC,CAAC,CAAC;IACH,UAAU,CAAyB;IACnC,SAAS,CAAwB;IAEjC,YACqB,eAAqC,EACrC,KAAoB,EACpB,sBAEM;QAJN,oBAAe,GAAf,eAAe,CAAsB;QACrC,UAAK,GAAL,KAAK,CAAe;QACpB,2BAAsB,GAAtB,sBAAsB,CAEhB;QAEzB,IAAI,CAAC,UAAU,GAAG,IAAI,sBAAsB,CAC1C,eAAe,EACf,sBAAsB,CACvB,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAqB,CACxC,eAAe,EACf,sBAAsB,CACvB,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,qBAAqB,CACzB,gBAAyB;QAEzB,yBAAyB;QACzB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAC1D,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;QAC3E,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACxE,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;QACtE,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;QAExE,OAAO;YACL,GAAG,YAAY;YACf,GAAG,WAAW;YACd,aAAa;YACb,cAAc;YACd,IAAI;SACuB,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,gBAAyB;QAC7C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;YACnE,EAAE,EAAE,gBAAgB;SACrB,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,oCAAoC,gBAAgB,EAAE,CAAC,CAAC;QAC1E,CAAC;QAED,QAAQ,KAAK,CAAC,UAAU,EAAE,CAAC;YACzB,KAAK,SAAS,CAAC,YAAY,CAAC,yBAAyB;gBACnD,OAAO,SAAS,CAAC,UAAU,CAAC;YAC9B,KAAK,SAAS,CAAC,YAAY,CAAC,wBAAwB;gBAClD,OAAO,SAAS,CAAC,SAAS,CAAC;YAC7B;gBACE,MAAM,IAAI,KAAK,CACb,8CAA8C,gBAAgB,EAAE,CACjE,CAAC;QACN,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB,CAC5B,aAAsB;QAEtB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;YACnE,EAAE,EAAE,aAAa;SAClB,CAAC,CAAC;QAEH,MAAM,CAAC,KAAK,EAAE,oCAAoC,aAAa,EAAE,CAAC,CAAC;QAEnE,MAAM,MAAM,GAAwB;YAClC,OAAO,EAAE,KAAK,CAAC,cAAc;YAC7B,KAAK,EAAE,KAAK,CAAC,KAAK;SACnB,CAAC;QAEF,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtE,MAAM,CAAC,wBAAwB,GAAG,UAAU,CAAC;QAC/C,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CACpB,IAAe,EACf,gBAAyB;QAEzB,OAAO;YACL,IAAI;YACJ,KAAK,EAAE,gBAAgB;SACN,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,gBAAyB;QAChD,MAAM,EAAE,cAAc,EAAE,GACtB,MAAM,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC;YACzD,EAAE,EAAE,gBAAgB;SACrB,CAAC,CAAC;QAEL,MAAM,OAAO,GAAwC,EAAE,CAAC;QACxD,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE,CAAC;YACpC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG;gBAChC,OAAO,EAAE,MAAM,CAAC,iBAAiB;aAClC,CAAC;QACJ,CAAC;QAED,OAAO,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,mBAAmB,CACvB,gBAAyB;QAEzB,MAAM,EAAE,cAAc,EAAE,GACtB,MAAM,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC;YACzD,EAAE,EAAE,gBAAgB;SACrB,CAAC,CAAC;QAEL,OAAO,MAAM,CAAC,WAAW,CACvB,cAAc,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC;YACnC,YAAY,CAAC,eAAe;YAC5B,YAAY,CAAC,GAAG;SACjB,CAAC,CACH,CAAC;IACJ,CAAC;CACF"}

package/dist/token/EvmERC20WarpModule.d.ts

@@ -45,6 +45,11 @@ export declare class EvmERC20WarpModule extends HyperlaneModule<ProtocolType.Eth
      */
     createEnrollRemoteRoutersUpdateTxs(actualConfig: DerivedTokenRouterConfig, expectedConfig: HypTokenRouterConfig): AnnotatedEV5Transaction[];
     createUnenrollRemoteRoutersUpdateTxs(actualConfig: DerivedTokenRouterConfig, expectedConfig: HypTokenRouterConfig): AnnotatedEV5Transaction[];
+    createAddRebalancersUpdateTxs(actualConfig: DerivedTokenRouterConfig, expectedConfig: HypTokenRouterConfig): AnnotatedEV5Transaction[];
+    createRemoveRebalancersUpdateTxs(actualConfig: DerivedTokenRouterConfig, expectedConfig: HypTokenRouterConfig): AnnotatedEV5Transaction[];
+    getAllowedBridgesApprovalTxs(actualConfig: DerivedTokenRouterConfig, expectedConfig: HypTokenRouterConfig): Promise<AnnotatedEV5Transaction[]>;
+    createAddAllowedBridgesUpdateTxs(actualConfig: DerivedTokenRouterConfig, expectedConfig: HypTokenRouterConfig): Promise<AnnotatedEV5Transaction[]>;
+    createRemoveBridgesTxs(actualConfig: DerivedTokenRouterConfig, expectedConfig: HypTokenRouterConfig): AnnotatedEV5Transaction[];
     /**
      * Create a transaction to update the remote routers for the Warp Route contract.
      *
@@ -96,6 +101,14 @@ export declare class EvmERC20WarpModule extends HyperlaneModule<ProtocolType.Eth
         deployedHook: Address;
         updateTransactions: AnnotatedEV5Transaction[];
     }>;
+    /**
+     * Creates a transaction to upgrade the Warp Route implementation if the package version is below specified version.
+     *
+     * @param actualConfig - The current on-chain configuration
+     * @param expectedConfig - The expected configuration
+     * @returns An array of transactions to upgrade the implementation if needed
+     */
+    upgradeWarpRouteImplementationTx(actualConfig: DerivedTokenRouterConfig, expectedConfig: HypTokenRouterConfig): Promise<AnnotatedEV5Transaction[]>;
     /**
      * Deploys the Warp Route.
      *

package/dist/token/EvmERC20WarpModule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EvmERC20WarpModule.d.ts","sourceRoot":"","sources":["../../src/token/EvmERC20WarpModule.ts"],"names":[],"mappings":"AASA,OAAO,EACL,OAAO,EACP,MAAM,EACN,UAAU,EACV,YAAY,EASb,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EACL,eAAe,EACf,qBAAqB,EACtB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AAIxE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAGvD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EACL,wBAAwB,EACxB,oBAAoB,EAIrB,MAAM,YAAY,CAAC;AAEpB,KAAK,kBAAkB,GAAG,kBAAkB,CAAC,qBAAqB,CAAC,GAAG;IACpE,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC;AACF,qBAAa,kBAAmB,SAAQ,eAAe,CACrD,YAAY,CAAC,QAAQ,EACrB,oBAAoB,EACpB,kBAAkB,CACnB;IAUG,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa;IAE/C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACrC,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAZtC,SAAS,CAAC,MAAM,uCAEb;IACH,MAAM,EAAE,uBAAuB,CAAC;IAChC,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,SAAgB,QAAQ,EAAE,MAAM,CAAC;gBAGZ,aAAa,EAAE,aAAa,EAC/C,IAAI,EAAE,qBAAqB,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,EAClD,iBAAiB,CAAC,+BAAmB,EACrC,gBAAgB,CAAC,8BAAkB;IAgBxD;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,wBAAwB,CAAC;IAM/C;;;;;OAKG;IACG,MAAM,CACV,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAiCrC;;;;;;OAMG;IACH,kCAAkC,CAChC,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,uBAAuB,EAAE;IAmD5B,oCAAoC,CAClC,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,uBAAuB,EAAE;IAyC5B;;;;;;OAMG;IACH,gCAAgC,CAC9B,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,uBAAuB,EAAE;IAyC5B;;;;;;OAMG;IACG,kBAAkB,CACtB,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAwC/B,mBAAmB,CACvB,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAqCrC;;;;;;OAMG;IACH,wBAAwB,CACtB,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,uBAAuB,EAAE;IAU5B;;;;OAIG;IACG,iBAAiB,CACrB,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC;QACT,WAAW,EAAE,OAAO,CAAC;QACrB,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;KAC/C,CAAC;IA4BF;;;;OAIG;IACG,kBAAkB,CACtB,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC;QACT,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;KAC/C,CAAC;IASI,aAAa,CAAC,cAAc,EAAE,oBAAoB,GAAG,OAAO,CAAC;QACjE,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;KAC/C,CAAC;IA4BI,kBAAkB,CACtB,cAAc,EAAE,oBAAoB,EACpC,YAAY,EAAE,wBAAwB,GACrC,OAAO,CAAC;QACT,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;KAC/C,CAAC;IA6BF;;;;;;;OAOG;WACU,MAAM,CAAC,MAAM,EAAE;QAC1B,KAAK,EAAE,aAAa,CAAC;QACrB,MAAM,EAAE,oBAAoB,CAAC;QAC7B,aAAa,EAAE,aAAa,CAAC;QAC7B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;QACpC,qBAAqB,EAAE,kBAAkB,CAAC,qBAAqB,CAAC,CAAC;KAClE,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAmChC"}
+{"version":3,"file":"EvmERC20WarpModule.d.ts","sourceRoot":"","sources":["../../src/token/EvmERC20WarpModule.ts"],"names":[],"mappings":"AAeA,OAAO,EACL,OAAO,EACP,MAAM,EACN,UAAU,EACV,YAAY,EAWb,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EACL,eAAe,EACf,qBAAqB,EACtB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAM/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AAIxE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAGvD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAGvE,OAAO,EACL,wBAAwB,EACxB,oBAAoB,EAQrB,MAAM,YAAY,CAAC;AAEpB,KAAK,kBAAkB,GAAG,kBAAkB,CAAC,qBAAqB,CAAC,GAAG;IACpE,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CAAC;AAkBF,qBAAa,kBAAmB,SAAQ,eAAe,CACrD,YAAY,CAAC,QAAQ,EACrB,oBAAoB,EACpB,kBAAkB,CACnB;IAUG,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa;IAE/C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACrC,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAZtC,SAAS,CAAC,MAAM,uCAEb;IACH,MAAM,EAAE,uBAAuB,CAAC;IAChC,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,OAAO,EAAE,UAAU,CAAC;IACpC,SAAgB,QAAQ,EAAE,MAAM,CAAC;gBAGZ,aAAa,EAAE,aAAa,EAC/C,IAAI,EAAE,qBAAqB,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,EAClD,iBAAiB,CAAC,+BAAmB,EACrC,gBAAgB,CAAC,8BAAkB;IAgBxD;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,wBAAwB,CAAC;IAM/C;;;;;OAKG;IACG,MAAM,CACV,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC,uBAAuB,EAAE,CAAC;IA2CrC;;;;;;OAMG;IACH,kCAAkC,CAChC,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,uBAAuB,EAAE;IAmD5B,oCAAoC,CAClC,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,uBAAuB,EAAE;IAyC5B,6BAA6B,CAC3B,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,uBAAuB,EAAE;IAuC5B,gCAAgC,CAC9B,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,uBAAuB,EAAE;IAuCtB,4BAA4B,CAChC,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAgE/B,gCAAgC,CACpC,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAyDrC,sBAAsB,CACpB,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,uBAAuB,EAAE;IAkD5B;;;;;;OAMG;IACH,gCAAgC,CAC9B,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,uBAAuB,EAAE;IAkD5B;;;;;;OAMG;IACG,kBAAkB,CACtB,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAwC/B,mBAAmB,CACvB,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAqCrC;;;;;;OAMG;IACH,wBAAwB,CACtB,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,uBAAuB,EAAE;IAU5B;;;;OAIG;IACG,iBAAiB,CACrB,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC;QACT,WAAW,EAAE,OAAO,CAAC;QACrB,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;KAC/C,CAAC;IA4BF;;;;OAIG;IACG,kBAAkB,CACtB,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC;QACT,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;KAC/C,CAAC;IASI,aAAa,CAAC,cAAc,EAAE,oBAAoB,GAAG,OAAO,CAAC;QACjE,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;KAC/C,CAAC;IA4BI,kBAAkB,CACtB,cAAc,EAAE,oBAAoB,EACpC,YAAY,EAAE,wBAAwB,GACrC,OAAO,CAAC;QACT,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;KAC/C,CAAC;IA6BF;;;;;;OAMG;IACG,gCAAgC,CACpC,YAAY,EAAE,wBAAwB,EACtC,cAAc,EAAE,oBAAoB,GACnC,OAAO,CAAC,uBAAuB,EAAE,CAAC;IA8ErC;;;;;;;OAOG;WACU,MAAM,CAAC,MAAM,EAAE;QAC1B,KAAK,EAAE,aAAa,CAAC;QACrB,MAAM,EAAE,oBAAoB,CAAC;QAC7B,aAAa,EAAE,aAAa,CAAC;QAC7B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;QACtC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;QACpC,qBAAqB,EAAE,kBAAkB,CAAC,qBAAqB,CAAC,CAAC;KAClE,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAsEhC"}