@hyperlane-xyz/sdk 19.4.0 → 19.6.0

package/dist/fee/EvmTokenFeeModule.js

@@ -0,0 +1,182 @@
+import { constants } from 'ethers';
+import { RoutingFee__factory } from '@hyperlane-xyz/core';
+import { assert, deepEquals, eqAddress, isZeroishAddress, objMap, objMerge, objOmit, promiseObjAll, rootLogger, } from '@hyperlane-xyz/utils';
+import { transferOwnershipTransactions } from '../contracts/contracts.js';
+import { HyperlaneModule, } from '../core/AbstractHyperlaneModule.js';
+import { normalizeConfig } from '../utils/ism.js';
+import { EvmTokenFeeDeployer } from './EvmTokenFeeDeployer.js';
+import { EvmTokenFeeReader, } from './EvmTokenFeeReader.js';
+import { ImmutableTokenFeeType, TokenFeeConfigSchema, TokenFeeType, } from './types.js';
+export class EvmTokenFeeModule extends HyperlaneModule {
+    multiProvider;
+    contractVerifier;
+    logger = rootLogger.child({ module: 'EvmTokenFeeModule' });
+    deployer;
+    reader;
+    chainName;
+    chainId;
+    constructor(multiProvider, params, contractVerifier) {
+        super(params);
+        this.multiProvider = multiProvider;
+        this.contractVerifier = contractVerifier;
+        this.chainName = multiProvider.getChainName(params.chain);
+        this.chainId = multiProvider.getDomainId(this.chainName);
+        this.deployer = new EvmTokenFeeDeployer(multiProvider, this.chainName, {
+            logger: this.logger,
+            contractVerifier: contractVerifier,
+        });
+        this.reader = new EvmTokenFeeReader(multiProvider, this.chainName);
+    }
+    static async create({ multiProvider, chain, config, contractVerifier, }) {
+        const chainName = multiProvider.getChainName(chain);
+        const module = new EvmTokenFeeModule(multiProvider, {
+            addresses: {
+                deployedFee: constants.AddressZero,
+            },
+            chain,
+            config,
+        }, contractVerifier);
+        const contracts = await module.deploy({
+            multiProvider,
+            chainName,
+            contractVerifier,
+            config,
+        });
+        module.args.addresses.deployedFee =
+            contracts[chainName][config.type].address;
+        return module;
+    }
+    // Processes the Input config to the Final config
+    // For LinearFee, it converts the bps to maxFee and halfAmount
+    static async expandConfig(params) {
+        const { config, multiProvider, chainName } = params;
+        let intermediaryConfig;
+        if (config.type === TokenFeeType.LinearFee) {
+            const reader = new EvmTokenFeeReader(params.multiProvider, params.chainName);
+            let { maxFee, halfAmount } = config;
+            if (!isZeroishAddress(config.token)) {
+                const { maxFee: convertedMaxFee, halfAmount: convertedHalfAmount } = await reader.convertFromBps(config.bps, config.token);
+                maxFee = convertedMaxFee;
+                halfAmount = convertedHalfAmount;
+            }
+            assert(maxFee && halfAmount, 'Config properties "maxFee" and "halfAmount" must be supplied when "token" is not supplied');
+            intermediaryConfig = {
+                type: TokenFeeType.LinearFee,
+                token: config.token,
+                owner: config.owner,
+                bps: config.bps,
+                maxFee,
+                halfAmount,
+            };
+        }
+        else if (config.type === TokenFeeType.RoutingFee) {
+            const feeContracts = config.feeContracts
+                ? await promiseObjAll(objMap(config.feeContracts, async (_, innerConfig) => {
+                    return EvmTokenFeeModule.expandConfig({
+                        config: innerConfig,
+                        multiProvider,
+                        chainName,
+                    });
+                }))
+                : undefined;
+            intermediaryConfig = {
+                type: TokenFeeType.RoutingFee,
+                token: config.token,
+                owner: config.owner,
+                maxFee: constants.MaxUint256.toBigInt(),
+                halfAmount: constants.MaxUint256.toBigInt(),
+                feeContracts,
+            };
+        }
+        else {
+            intermediaryConfig = config;
+        }
+        return TokenFeeConfigSchema.parse(intermediaryConfig);
+    }
+    async deploy(params) {
+        const deployer = new EvmTokenFeeDeployer(params.multiProvider, params.chainName, {
+            contractVerifier: params.contractVerifier,
+        });
+        return deployer.deploy({ [params.chainName]: params.config });
+    }
+    async read(params) {
+        const address = params?.address ?? this.args.addresses.deployedFee;
+        const routingDestinations = params?.routingDestinations;
+        return this.reader.deriveTokenFeeConfig({
+            address: address,
+            routingDestinations,
+        });
+    }
+    async update(targetConfig, params) {
+        let updateTransactions = [];
+        const normalizedTargetConfig = normalizeConfig(await EvmTokenFeeModule.expandConfig({
+            config: targetConfig,
+            multiProvider: this.multiProvider,
+            chainName: this.chainName,
+        }));
+        const actualConfig = await this.read(params);
+        const normalizedActualConfig = normalizeConfig(actualConfig);
+        //If configs are the same, return empty array
+        if (deepEquals(normalizedActualConfig, normalizedTargetConfig)) {
+            this.logger.debug(`Same config for ${normalizedTargetConfig.type}, no update needed`);
+            return [];
+        }
+        // Redeploy immutable fee types, if owner is the same, but the rest of the config is different
+        const nonOwnerDiffers = !deepEquals(objOmit(normalizedActualConfig, { owner: true }), objOmit(normalizedTargetConfig, { owner: true }));
+        if (ImmutableTokenFeeType.includes(normalizedTargetConfig.type) &&
+            nonOwnerDiffers) {
+            this.logger.info(`Immutable fee type ${normalizedTargetConfig.type}, redeploying`);
+            const contracts = await this.deploy({
+                config: normalizedTargetConfig,
+                multiProvider: this.multiProvider,
+                chainName: this.chainName,
+                contractVerifier: this.contractVerifier,
+            });
+            this.args.addresses.deployedFee =
+                contracts[this.chainName][normalizedTargetConfig.type].address;
+            return [];
+        }
+        // if the type is a mutable (for now, only routing fee), then update
+        updateTransactions = [
+            ...(await this.updateRoutingFee(objMerge(actualConfig, normalizedTargetConfig, 10, true))),
+            ...this.createOwnershipUpdateTxs(normalizedActualConfig, normalizedTargetConfig),
+        ];
+        return updateTransactions;
+    }
+    async updateRoutingFee(targetConfig) {
+        const updateTransactions = [];
+        if (!targetConfig.feeContracts)
+            return [];
+        const currentRoutingAddress = this.args.addresses.deployedFee;
+        await promiseObjAll(objMap(targetConfig.feeContracts, async (chainName, config) => {
+            const address = config.address;
+            const subFeeModule = new EvmTokenFeeModule(this.multiProvider, {
+                addresses: {
+                    deployedFee: address,
+                },
+                chain: this.chainName,
+                config,
+            }, this.contractVerifier);
+            const subFeeUpdateTransactions = await subFeeModule.update(config, {
+                address,
+            });
+            const { deployedFee: deployedSubFee } = subFeeModule.serialize();
+            updateTransactions.push(...subFeeUpdateTransactions);
+            if (!eqAddress(deployedSubFee, address)) {
+                const annotation = `Sub fee contract redeployed. Updating contract for ${chainName} to ${deployedSubFee}`;
+                this.logger.debug(annotation);
+                updateTransactions.push({
+                    annotation: annotation,
+                    chainId: this.chainId,
+                    to: currentRoutingAddress,
+                    data: RoutingFee__factory.createInterface().encodeFunctionData('setFeeContract(uint32,address)', [this.multiProvider.getDomainId(chainName), deployedSubFee]),
+                });
+            }
+        }));
+        return updateTransactions;
+    }
+    createOwnershipUpdateTxs(actualConfig, expectedConfig) {
+        return transferOwnershipTransactions(this.multiProvider.getEvmChainId(this.args.chain), this.args.addresses.deployedFee, actualConfig, expectedConfig, `${expectedConfig.type} Warp Route`);
+    }
+}
+//# sourceMappingURL=EvmTokenFeeModule.js.map

package/dist/fee/EvmTokenFeeModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvmTokenFeeModule.js","sourceRoot":"","sources":["../../src/fee/EvmTokenFeeModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAGL,MAAM,EACN,UAAU,EACV,SAAS,EACT,gBAAgB,EAChB,MAAM,EACN,QAAQ,EACR,OAAO,EACP,aAAa,EACb,UAAU,GACX,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAE1E,OAAO,EACL,eAAe,GAEhB,MAAM,oCAAoC,CAAC;AAK5C,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAGL,iBAAiB,GAElB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EACL,qBAAqB,EAGrB,oBAAoB,EACpB,YAAY,GACb,MAAM,YAAY,CAAC;AAMpB,MAAM,OAAO,iBAAkB,SAAQ,eAItC;IAOsB;IAEA;IARF,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAAC;IAC3D,QAAQ,CAAsB;IAC9B,MAAM,CAAoB;IAC1B,SAAS,CAAS;IAClB,OAAO,CAAS;IACnC,YACqB,aAA4B,EAC/C,MAA2E,EACxD,gBAAmC;QAEtD,KAAK,CAAC,MAAM,CAAC,CAAC;QAJK,kBAAa,GAAb,aAAa,CAAe;QAE5B,qBAAgB,GAAhB,gBAAgB,CAAmB;QAGtD,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1D,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEzD,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAmB,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,EAAE;YACrE,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,gBAAgB,EAAE,gBAAgB;SACnC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAClB,aAAa,EACb,KAAK,EACL,MAAM,EACN,gBAAgB,GAMjB;QACC,MAAM,SAAS,GAAG,aAAa,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAClC,aAAa,EACb;YACE,SAAS,EAAE;gBACT,WAAW,EAAE,SAAS,CAAC,WAAW;aACnC;YACD,KAAK;YACL,MAAM;SACP,EACD,gBAAgB,CACjB,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC;YACpC,aAAa;YACb,SAAS;YACT,gBAAgB;YAChB,MAAM;SACP,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW;YAC/B,SAAS,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;QAE5C,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,iDAAiD;IACjD,8DAA8D;IACvD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAIhC;QACC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QACpD,IAAI,kBAAkC,CAAC;QACvC,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC,SAAS,EAAE,CAAC;YAC3C,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAClC,MAAM,CAAC,aAAa,EACpB,MAAM,CAAC,SAAS,CACjB,CAAC;YAEF,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;YAEpC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBACpC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,mBAAmB,EAAE,GAChE,MAAM,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;gBACxD,MAAM,GAAG,eAAe,CAAC;gBACzB,UAAU,GAAG,mBAAmB,CAAC;YACnC,CAAC;YAED,MAAM,CACJ,MAAM,IAAI,UAAU,EACpB,2FAA2F,CAC5F,CAAC;YAEF,kBAAkB,GAAG;gBACnB,IAAI,EAAE,YAAY,CAAC,SAAS;gBAC5B,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,MAAM;gBACN,UAAU;aACX,CAAC;QACJ,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC,UAAU,EAAE,CAAC;YACnD,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY;gBACtC,CAAC,CAAC,MAAM,aAAa,CACjB,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,CAAC,EAAE,WAAW,EAAE,EAAE;oBACnD,OAAO,iBAAiB,CAAC,YAAY,CAAC;wBACpC,MAAM,EAAE,WAAW;wBACnB,aAAa;wBACb,SAAS;qBACV,CAAC,CAAC;gBACL,CAAC,CAAC,CACH;gBACH,CAAC,CAAC,SAAS,CAAC;YAEd,kBAAkB,GAAG;gBACnB,IAAI,EAAE,YAAY,CAAC,UAAU;gBAC7B,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACvC,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE;gBAC3C,YAAY;aACb,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,kBAAkB,GAAG,MAAM,CAAC;QAC9B,CAAC;QAED,OAAO,oBAAoB,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxD,CAAC;IAEO,KAAK,CAAC,MAAM,CAAC,MAKpB;QACC,MAAM,QAAQ,GAAG,IAAI,mBAAmB,CACtC,MAAM,CAAC,aAAa,EACpB,MAAM,CAAC,SAAS,EAChB;YACE,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;SAC1C,CACF,CAAC;QACF,OAAO,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,KAAK,CAAC,IAAI,CACR,MAAsC;QAEtC,MAAM,OAAO,GAAG,MAAM,EAAE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;QACnE,MAAM,mBAAmB,GAAG,MAAM,EAAE,mBAAmB,CAAC;QAExD,OAAO,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;YACtC,OAAO,EAAE,OAAO;YAChB,mBAAmB;SACpB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CACV,YAAiC,EACjC,MAAsC;QAEtC,IAAI,kBAAkB,GAA8B,EAAE,CAAC;QAEvD,MAAM,sBAAsB,GAAmB,eAAe,CAC5D,MAAM,iBAAiB,CAAC,YAAY,CAAC;YACnC,MAAM,EAAE,YAAY;YACpB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC,CACH,CAAC;QAEF,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,sBAAsB,GAC1B,eAAe,CAAC,YAAY,CAAC,CAAC;QAEhC,6CAA6C;QAC7C,IAAI,UAAU,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,EAAE,CAAC;YAC/D,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,mBAAmB,sBAAsB,CAAC,IAAI,oBAAoB,CACnE,CAAC;YACF,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,8FAA8F;QAC9F,MAAM,eAAe,GAAG,CAAC,UAAU,CACjC,OAAO,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAChD,OAAO,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CACjD,CAAC;QACF,IACE,qBAAqB,CAAC,QAAQ,CAC5B,sBAAsB,CAAC,IAA8C,CACtE;YACD,eAAe,EACf,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,sBAAsB,sBAAsB,CAAC,IAAI,eAAe,CACjE,CAAC;YACF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC;gBAClC,MAAM,EAAE,sBAAsB;gBAC9B,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;aACxC,CAAC,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW;gBAC7B,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAEjE,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,oEAAoE;QACpE,kBAAkB,GAAG;YACnB,GAAG,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAC7B,QAAQ,CACN,YAAY,EACZ,sBAAsB,EACtB,EAAE,EACF,IAAI,CACsB,CAC7B,CAAC;YACF,GAAG,IAAI,CAAC,wBAAwB,CAC9B,sBAAsB,EACtB,sBAAsB,CACvB;SACF,CAAC;QAEF,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,YAAqC;QAClE,MAAM,kBAAkB,GAA8B,EAAE,CAAC;QAEzD,IAAI,CAAC,YAAY,CAAC,YAAY;YAAE,OAAO,EAAE,CAAC;QAC1C,MAAM,qBAAqB,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;QAC9D,MAAM,aAAa,CACjB,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE;YAC5D,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;YAC/B,MAAM,YAAY,GAAG,IAAI,iBAAiB,CACxC,IAAI,CAAC,aAAa,EAClB;gBACE,SAAS,EAAE;oBACT,WAAW,EAAE,OAAO;iBACrB;gBACD,KAAK,EAAE,IAAI,CAAC,SAAS;gBACrB,MAAM;aACP,EACD,IAAI,CAAC,gBAAgB,CACtB,CAAC;YACF,MAAM,wBAAwB,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE;gBACjE,OAAO;aACR,CAAC,CAAC;YACH,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,YAAY,CAAC,SAAS,EAAE,CAAC;YAEjE,kBAAkB,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,CAAC;YAErD,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,OAAO,CAAC,EAAE,CAAC;gBACxC,MAAM,UAAU,GAAG,sDAAsD,SAAS,OAAO,cAAc,EAAE,CAAC;gBAC1G,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC9B,kBAAkB,CAAC,IAAI,CAAC;oBACtB,UAAU,EAAE,UAAU;oBACtB,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,EAAE,EAAE,qBAAqB;oBACzB,IAAI,EAAE,mBAAmB,CAAC,eAAe,EAAE,CAAC,kBAAkB,CAC5D,gCAAgC,EAChC,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC,CAC5D;iBACF,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CACH,CAAC;QAEF,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAEO,wBAAwB,CAC9B,YAA4B,EAC5B,cAA8B;QAE9B,OAAO,6BAA6B,CAClC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EACjD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAC/B,YAAY,EACZ,cAAc,EACd,GAAG,cAAc,CAAC,IAAI,aAAa,CACpC,CAAC;IACJ,CAAC;CACF"}

package/dist/fee/EvmTokenFeeReader.d.ts

@@ -0,0 +1,25 @@
+import { Address, WithAddress } from '@hyperlane-xyz/utils';
+import { MultiProvider } from '../providers/MultiProvider.js';
+import { ChainName, ChainNameOrId } from '../types.js';
+import { HyperlaneReader } from '../utils/HyperlaneReader.js';
+import { FeeParameters, RoutingFeeConfig, TokenFeeConfig } from './types.js';
+export type DerivedTokenFeeConfig = WithAddress<TokenFeeConfig>;
+export type DerivedRoutingFeeConfig = WithAddress<RoutingFeeConfig> & {
+    feeContracts: Record<ChainName, DerivedTokenFeeConfig>;
+};
+export type TokenFeeReaderParams = {
+    address: Address;
+    routingDestinations?: number[];
+};
+export declare class EvmTokenFeeReader extends HyperlaneReader {
+    protected readonly multiProvider: MultiProvider;
+    protected readonly chain: ChainNameOrId;
+    constructor(multiProvider: MultiProvider, chain: ChainNameOrId);
+    deriveTokenFeeConfig(params: TokenFeeReaderParams): Promise<DerivedTokenFeeConfig>;
+    private deriveLinearFeeConfig;
+    private deriveProgressiveFeeConfig;
+    private deriveRegressiveFeeConfig;
+    private deriveRoutingFeeConfig;
+    convertFromBps(bps: bigint, tokenAddress: Address): Promise<FeeParameters>;
+}
+//# sourceMappingURL=EvmTokenFeeReader.d.ts.map

package/dist/fee/EvmTokenFeeReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvmTokenFeeReader.d.ts","sourceRoot":"","sources":["../../src/fee/EvmTokenFeeReader.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,WAAW,EAAU,MAAM,sBAAsB,CAAC;AAEpE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D,OAAO,EACL,aAAa,EAEb,gBAAgB,EAChB,cAAc,EAGf,MAAM,YAAY,CAAC;AAGpB,MAAM,MAAM,qBAAqB,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;AAEhE,MAAM,MAAM,uBAAuB,GAAG,WAAW,CAAC,gBAAgB,CAAC,GAAG;IACpE,YAAY,EAAE,MAAM,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC;CACxD,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAChC,CAAC;AAEF,qBAAa,iBAAkB,SAAQ,eAAe;IAElD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa;IAC/C,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,aAAa;gBADpB,aAAa,EAAE,aAAa,EAC5B,KAAK,EAAE,aAAa;IAKnC,oBAAoB,CACxB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,qBAAqB,CAAC;YAiCnB,qBAAqB;YAyBrB,0BAA0B;YAM1B,yBAAyB;YAMzB,sBAAsB;IA2C9B,cAAc,CAClB,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,OAAO,GACpB,OAAO,CAAC,aAAa,CAAC;CAY1B"}

package/dist/fee/EvmTokenFeeReader.hardhat-test.d.ts

@@ -0,0 +1,4 @@
+export declare const MAX_FEE = 1157920892373161954235709850086879078532699846656405640394n;
+export declare const HALF_AMOUNT = 5789604461865809771178549250434395392663499233282028201970n;
+export declare const BPS: bigint;
+//# sourceMappingURL=EvmTokenFeeReader.hardhat-test.d.ts.map

package/dist/fee/EvmTokenFeeReader.hardhat-test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvmTokenFeeReader.hardhat-test.d.ts","sourceRoot":"","sources":["../../src/fee/EvmTokenFeeReader.hardhat-test.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,OAAO,8DACyC,CAAC;AAC9D,eAAO,MAAM,WAAW,8DACqC,CAAC;AAC9D,eAAO,MAAM,GAAG,QAAqC,CAAC"}

package/dist/fee/EvmTokenFeeReader.hardhat-test.js

@@ -0,0 +1,133 @@
+import { expect } from 'chai';
+import { constants } from 'ethers';
+import hre from 'hardhat';
+import { ERC20Test__factory } from '@hyperlane-xyz/core';
+import { TestChainName } from '../consts/testChains.js';
+import { MultiProvider } from '../providers/MultiProvider.js';
+import { randomInt } from '../test/testUtils.js';
+import { normalizeConfig } from '../utils/ism.js';
+import { EvmTokenFeeDeployer } from './EvmTokenFeeDeployer.js';
+import { EvmTokenFeeReader } from './EvmTokenFeeReader.js';
+import { TokenFeeConfigSchema, TokenFeeType } from './types.js';
+import { convertToBps } from './utils.js';
+export const MAX_FEE = 1157920892373161954235709850086879078532699846656405640394n;
+export const HALF_AMOUNT = 5789604461865809771178549250434395392663499233282028201970n;
+export const BPS = convertToBps(MAX_FEE, HALF_AMOUNT);
+describe('EvmTokenFeeReader', () => {
+    let multiProvider;
+    let signer;
+    let token;
+    const TOKEN_TOTAL_SUPPLY = '100000000000000000000';
+    before(async () => {
+        [signer] = await hre.ethers.getSigners();
+        multiProvider = MultiProvider.createTestMultiProvider({ signer });
+        const factory = new ERC20Test__factory(signer);
+        token = await factory.deploy('fake', 'FAKE', TOKEN_TOTAL_SUPPLY, 18);
+        await token.deployed();
+    });
+    describe('LinearFee', () => {
+        it('should read the token fee config', async () => {
+            const config = TokenFeeConfigSchema.parse({
+                type: TokenFeeType.LinearFee,
+                maxFee: MAX_FEE,
+                halfAmount: HALF_AMOUNT,
+                bps: BPS,
+                token: token.address,
+                owner: signer.address,
+            });
+            const deployer = new EvmTokenFeeDeployer(multiProvider, TestChainName.test2);
+            const deployedContracts = await deployer.deploy({
+                [TestChainName.test2]: config,
+            });
+            const reader = new EvmTokenFeeReader(multiProvider, TestChainName.test2);
+            const tokenFee = deployedContracts[TestChainName.test2][TokenFeeType.LinearFee];
+            const onchainConfig = await reader.deriveTokenFeeConfig({
+                address: tokenFee.address,
+            });
+            expect(normalizeConfig(onchainConfig)).to.deep.equal(normalizeConfig({
+                ...config,
+                maxFee: MAX_FEE,
+                halfAmount: HALF_AMOUNT,
+                bps: BPS,
+            }));
+        });
+        it('should convert maxFee and halfAmount to bps', async () => {
+            const maxFee = BigInt(randomInt(2, 100000000));
+            const halfAmount = maxFee * 5n;
+            const config = {
+                type: TokenFeeType.LinearFee,
+                owner: signer.address,
+                token: token.address,
+                maxFee,
+                halfAmount,
+                bps: convertToBps(maxFee, halfAmount),
+            };
+            const parsedConfig = TokenFeeConfigSchema.parse(config);
+            const deployer = new EvmTokenFeeDeployer(multiProvider, TestChainName.test2);
+            await deployer.deploy({
+                [TestChainName.test3]: parsedConfig,
+            });
+            const convertedBps = convertToBps(maxFee, halfAmount);
+            expect(convertedBps).to.equal(BPS);
+        });
+        it('should be able to convert bps to maxFee and halfAmount, and back', async () => {
+            const bps = BigInt(randomInt(1, 10000));
+            const config = {
+                type: TokenFeeType.LinearFee,
+                owner: signer.address,
+                token: token.address,
+                bps,
+            };
+            const reader = new EvmTokenFeeReader(multiProvider, TestChainName.test2);
+            const { maxFee: convertedMaxFee, halfAmount: convertedHalfAmount } = await reader.convertFromBps(config.bps, config.token);
+            // Get bps using helper function
+            const convertedBps = convertToBps(convertedMaxFee, convertedHalfAmount);
+            expect(convertedBps).to.equal(bps);
+        });
+    });
+    describe('RoutingFee', () => {
+        it('should be able to derive a routing fee config and its sub fees', async () => {
+            const routingFeeConfig = {
+                type: TokenFeeType.RoutingFee,
+                owner: signer.address,
+                token: token.address,
+                maxFee: constants.MaxUint256.toBigInt(),
+                halfAmount: constants.MaxUint256.toBigInt(),
+                feeContracts: {
+                    [TestChainName.test2]: {
+                        owner: signer.address,
+                        token: token.address,
+                        type: TokenFeeType.LinearFee,
+                        maxFee: MAX_FEE,
+                        halfAmount: HALF_AMOUNT,
+                        bps: BPS,
+                    },
+                    [TestChainName.test3]: {
+                        owner: signer.address,
+                        token: token.address,
+                        type: TokenFeeType.LinearFee,
+                        maxFee: MAX_FEE,
+                        halfAmount: HALF_AMOUNT,
+                        bps: BPS,
+                    },
+                },
+            };
+            const deployer = new EvmTokenFeeDeployer(multiProvider, TestChainName.test2);
+            const deployedContracts = await deployer.deploy({
+                [TestChainName.test2]: routingFeeConfig,
+            });
+            const reader = new EvmTokenFeeReader(multiProvider, TestChainName.test2);
+            const destinations = [
+                multiProvider.getDomainId(TestChainName.test2),
+                multiProvider.getDomainId(TestChainName.test3),
+            ];
+            const routingFee = await reader.deriveTokenFeeConfig({
+                address: deployedContracts[TestChainName.test2][TokenFeeType.RoutingFee]
+                    .address,
+                routingDestinations: destinations,
+            });
+            expect(normalizeConfig(routingFee)).to.deep.equal(normalizeConfig(routingFeeConfig));
+        });
+    });
+});
+//# sourceMappingURL=EvmTokenFeeReader.hardhat-test.js.map

package/dist/fee/EvmTokenFeeReader.hardhat-test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvmTokenFeeReader.hardhat-test.js","sourceRoot":"","sources":["../../src/fee/EvmTokenFeeReader.hardhat-test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,GAAG,MAAM,SAAS,CAAC;AAE1B,OAAO,EAAa,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEpE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAkB,oBAAoB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,MAAM,CAAC,MAAM,OAAO,GAClB,2DAA2D,CAAC;AAC9D,MAAM,CAAC,MAAM,WAAW,GACtB,2DAA2D,CAAC;AAC9D,MAAM,CAAC,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;AAEtD,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,IAAI,aAA4B,CAAC;IACjC,IAAI,MAAyB,CAAC;IAC9B,IAAI,KAAgB,CAAC;IAErB,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;IAEnD,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QACzC,aAAa,GAAG,aAAa,CAAC,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAElE,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC/C,KAAK,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAC;QACrE,MAAM,KAAK,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;YAChD,MAAM,MAAM,GAAG,oBAAoB,CAAC,KAAK,CAAC;gBACxC,IAAI,EAAE,YAAY,CAAC,SAAS;gBAC5B,MAAM,EAAE,OAAO;gBACf,UAAU,EAAE,WAAW;gBACvB,GAAG,EAAE,GAAG;gBACR,KAAK,EAAE,KAAK,CAAC,OAAO;gBACpB,KAAK,EAAE,MAAM,CAAC,OAAO;aACtB,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,mBAAmB,CACtC,aAAa,EACb,aAAa,CAAC,KAAK,CACpB,CAAC;YACF,MAAM,iBAAiB,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;gBAC9C,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,MAAM;aAC9B,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;YACzE,MAAM,QAAQ,GACZ,iBAAiB,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YACjE,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC;gBACtD,OAAO,EAAE,QAAQ,CAAC,OAAO;aAC1B,CAAC,CAAC;YACH,MAAM,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAClD,eAAe,CAAC;gBACd,GAAG,MAAM;gBACT,MAAM,EAAE,OAAO;gBACf,UAAU,EAAE,WAAW;gBACvB,GAAG,EAAE,GAAG;aACT,CAAC,CACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,SAAW,CAAC,CAAC,CAAC;YACjD,MAAM,UAAU,GAAG,MAAM,GAAG,EAAE,CAAC;YAE/B,MAAM,MAAM,GAAG;gBACb,IAAI,EAAE,YAAY,CAAC,SAAS;gBAC5B,KAAK,EAAE,MAAM,CAAC,OAAO;gBACrB,KAAK,EAAE,KAAK,CAAC,OAAO;gBACpB,MAAM;gBACN,UAAU;gBACV,GAAG,EAAE,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC;aACtC,CAAC;YACF,MAAM,YAAY,GAAG,oBAAoB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACxD,MAAM,QAAQ,GAAG,IAAI,mBAAmB,CACtC,aAAa,EACb,aAAa,CAAC,KAAK,CACpB,CAAC;YACF,MAAM,QAAQ,CAAC,MAAM,CAAC;gBACpB,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,YAAY;aACpC,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACtD,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;YAChF,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,KAAM,CAAC,CAAC,CAAC;YACzC,MAAM,MAAM,GAAG;gBACb,IAAI,EAAE,YAAY,CAAC,SAAS;gBAC5B,KAAK,EAAE,MAAM,CAAC,OAAO;gBACrB,KAAK,EAAE,KAAK,CAAC,OAAO;gBACpB,GAAG;aACJ,CAAC;YAEF,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;YACzE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,mBAAmB,EAAE,GAChE,MAAM,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YAExD,gCAAgC;YAChC,MAAM,YAAY,GAAG,YAAY,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;YACxE,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;YAC9E,MAAM,gBAAgB,GAAmB;gBACvC,IAAI,EAAE,YAAY,CAAC,UAAU;gBAC7B,KAAK,EAAE,MAAM,CAAC,OAAO;gBACrB,KAAK,EAAE,KAAK,CAAC,OAAO;gBACpB,MAAM,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACvC,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE;gBAC3C,YAAY,EAAE;oBACZ,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;wBACrB,KAAK,EAAE,MAAM,CAAC,OAAO;wBACrB,KAAK,EAAE,KAAK,CAAC,OAAO;wBACpB,IAAI,EAAE,YAAY,CAAC,SAAS;wBAC5B,MAAM,EAAE,OAAO;wBACf,UAAU,EAAE,WAAW;wBACvB,GAAG,EAAE,GAAG;qBACT;oBACD,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;wBACrB,KAAK,EAAE,MAAM,CAAC,OAAO;wBACrB,KAAK,EAAE,KAAK,CAAC,OAAO;wBACpB,IAAI,EAAE,YAAY,CAAC,SAAS;wBAC5B,MAAM,EAAE,OAAO;wBACf,UAAU,EAAE,WAAW;wBACvB,GAAG,EAAE,GAAG;qBACT;iBACF;aACF,CAAC;YACF,MAAM,QAAQ,GAAG,IAAI,mBAAmB,CACtC,aAAa,EACb,aAAa,CAAC,KAAK,CACpB,CAAC;YACF,MAAM,iBAAiB,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;gBAC9C,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,gBAAgB;aACxC,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;YAEzE,MAAM,YAAY,GAAG;gBACnB,aAAa,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC;gBAC9C,aAAa,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC;aAC/C,CAAC;YACF,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC;gBACnD,OAAO,EACL,iBAAiB,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC;qBAC5D,OAAO;gBACZ,mBAAmB,EAAE,YAAY;aAClC,CAAC,CAAC;YACH,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAC/C,eAAe,CAAC,gBAAgB,CAAC,CAClC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/fee/EvmTokenFeeReader.js

@@ -0,0 +1,116 @@
+import { constants } from 'ethers';
+import { BaseFee__factory, ERC20__factory, LinearFee__factory, RoutingFee__factory, } from '@hyperlane-xyz/core';
+import { assert } from '@hyperlane-xyz/utils';
+import { HyperlaneReader } from '../utils/HyperlaneReader.js';
+import { OnchainTokenFeeType, TokenFeeType, onChainTypeToTokenFeeTypeMap, } from './types.js';
+import { MAX_BPS, convertToBps } from './utils.js';
+export class EvmTokenFeeReader extends HyperlaneReader {
+    multiProvider;
+    chain;
+    constructor(multiProvider, chain) {
+        super(multiProvider, chain);
+        this.multiProvider = multiProvider;
+        this.chain = chain;
+    }
+    async deriveTokenFeeConfig(params) {
+        const { address, routingDestinations } = params;
+        const tokenFee = BaseFee__factory.connect(address, this.provider);
+        let derivedConfig;
+        const onchainFeeType = await tokenFee.feeType();
+        switch (onchainFeeType) {
+            case OnchainTokenFeeType.LinearFee:
+                derivedConfig = await this.deriveLinearFeeConfig(address);
+                break;
+            case OnchainTokenFeeType.ProgressiveFee:
+                derivedConfig = await this.deriveProgressiveFeeConfig(address);
+                break;
+            case OnchainTokenFeeType.RegressiveFee:
+                derivedConfig = await this.deriveRegressiveFeeConfig(address);
+                break;
+            case OnchainTokenFeeType.RoutingFee:
+                assert(routingDestinations, `routingDestinations required for ${onChainTypeToTokenFeeTypeMap[onchainFeeType]}`);
+                derivedConfig = await this.deriveRoutingFeeConfig({
+                    address,
+                    routingDestinations,
+                });
+                break;
+            default:
+                throw new Error(`Unsupported token fee type: ${onchainFeeType}`);
+        }
+        return derivedConfig;
+    }
+    async deriveLinearFeeConfig(address) {
+        const tokenFee = LinearFee__factory.connect(address, this.provider);
+        const [token, owner, maxFee, halfAmount] = await Promise.all([
+            tokenFee.token(),
+            tokenFee.owner(),
+            tokenFee.maxFee(),
+            tokenFee.halfAmount(),
+        ]);
+        const maxFeeBn = BigInt(maxFee.toString());
+        const halfAmountBn = BigInt(halfAmount.toString());
+        const bps = convertToBps(maxFeeBn, halfAmountBn);
+        return {
+            type: TokenFeeType.LinearFee,
+            maxFee: maxFeeBn,
+            halfAmount: halfAmountBn,
+            address,
+            bps,
+            token,
+            owner,
+        };
+    }
+    async deriveProgressiveFeeConfig(_address) {
+        throw new Error('Not implemented');
+    }
+    async deriveRegressiveFeeConfig(_address) {
+        throw new Error('Not implemented');
+    }
+    async deriveRoutingFeeConfig(params) {
+        const { address, routingDestinations } = params;
+        const routingFee = RoutingFee__factory.connect(address, this.provider);
+        const [token, owner, maxFee, halfAmount] = await Promise.all([
+            routingFee.token(),
+            routingFee.owner(),
+            routingFee.maxFee(),
+            routingFee.halfAmount(),
+        ]);
+        const maxFeeBn = BigInt(maxFee.toString());
+        const halfAmountBn = BigInt(halfAmount.toString());
+        const feeContracts = {};
+        if (routingDestinations)
+            await Promise.all(routingDestinations.map(async (destination) => {
+                const subFeeAddress = await routingFee.feeContracts(destination);
+                if (subFeeAddress === constants.AddressZero)
+                    return;
+                const chainName = this.multiProvider.getChainName(destination);
+                feeContracts[chainName] = await this.deriveTokenFeeConfig({
+                    address: subFeeAddress,
+                    // Currently, it's not possible to configure nested routing fees domains,
+                    // but we should not expect that to exist
+                    routingDestinations,
+                });
+            }));
+        return {
+            type: TokenFeeType.RoutingFee,
+            maxFee: maxFeeBn,
+            halfAmount: halfAmountBn,
+            address,
+            token,
+            owner,
+            feeContracts,
+        };
+    }
+    async convertFromBps(bps, tokenAddress) {
+        // Assume maxFee is uint256.max / token.totalSupply
+        const token = ERC20__factory.connect(tokenAddress, this.provider);
+        const totalSupplyBn = await token.totalSupply();
+        const maxFee = BigInt(constants.MaxUint256.div(totalSupplyBn).toString());
+        const halfAmount = ((maxFee / 2n) * MAX_BPS) / bps;
+        return {
+            maxFee,
+            halfAmount,
+        };
+    }
+}
+//# sourceMappingURL=EvmTokenFeeReader.js.map

package/dist/fee/EvmTokenFeeReader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvmTokenFeeReader.js","sourceRoot":"","sources":["../../src/fee/EvmTokenFeeReader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAwB,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAIpE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D,OAAO,EAEL,mBAAmB,EAGnB,YAAY,EACZ,4BAA4B,GAC7B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAanD,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IAE/B;IACA;IAFrB,YACqB,aAA4B,EAC5B,KAAoB;QAEvC,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QAHT,kBAAa,GAAb,aAAa,CAAe;QAC5B,UAAK,GAAL,KAAK,CAAe;IAGzC,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,MAA4B;QAE5B,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QAChD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAElE,IAAI,aAAoC,CAAC;QACzC,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,CAAC;QAChD,QAAQ,cAAc,EAAE,CAAC;YACvB,KAAK,mBAAmB,CAAC,SAAS;gBAChC,aAAa,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;gBAC1D,MAAM;YACR,KAAK,mBAAmB,CAAC,cAAc;gBACrC,aAAa,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;gBAC/D,MAAM;YACR,KAAK,mBAAmB,CAAC,aAAa;gBACpC,aAAa,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;gBAC9D,MAAM;YACR,KAAK,mBAAmB,CAAC,UAAU;gBACjC,MAAM,CACJ,mBAAmB,EACnB,oCAAoC,4BAA4B,CAAC,cAAc,CAAC,EAAE,CACnF,CAAC;gBACF,aAAa,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC;oBAChD,OAAO;oBACP,mBAAmB;iBACpB,CAAC,CAAC;gBACH,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,+BAA+B,cAAc,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,qBAAqB,CACjC,OAAgB;QAEhB,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpE,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC3D,QAAQ,CAAC,KAAK,EAAE;YAChB,QAAQ,CAAC,KAAK,EAAE;YAChB,QAAQ,CAAC,MAAM,EAAE;YACjB,QAAQ,CAAC,UAAU,EAAE;SACtB,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3C,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnD,MAAM,GAAG,GAAG,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAEjD,OAAO;YACL,IAAI,EAAE,YAAY,CAAC,SAAS;YAC5B,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE,YAAY;YACxB,OAAO;YACP,GAAG;YACH,KAAK;YACL,KAAK;SACN,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,0BAA0B,CACtC,QAAiB;QAEjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAEO,KAAK,CAAC,yBAAyB,CACrC,QAAiB;QAEjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAClC,MAA4B;QAE5B,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QAChD,MAAM,UAAU,GAAG,mBAAmB,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvE,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC3D,UAAU,CAAC,KAAK,EAAE;YAClB,UAAU,CAAC,KAAK,EAAE;YAClB,UAAU,CAAC,MAAM,EAAE;YACnB,UAAU,CAAC,UAAU,EAAE;SACxB,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3C,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEnD,MAAM,YAAY,GAA6C,EAAE,CAAC;QAElE,IAAI,mBAAmB;YACrB,MAAM,OAAO,CAAC,GAAG,CACf,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE;gBAC5C,MAAM,aAAa,GAAG,MAAM,UAAU,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;gBACjE,IAAI,aAAa,KAAK,SAAS,CAAC,WAAW;oBAAE,OAAO;gBACpD,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;gBAC/D,YAAY,CAAC,SAAS,CAAC,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC;oBACxD,OAAO,EAAE,aAAa;oBAEtB,yEAAyE;oBACzE,yCAAyC;oBACzC,mBAAmB;iBACpB,CAAC,CAAC;YACL,CAAC,CAAC,CACH,CAAC;QACJ,OAAO;YACL,IAAI,EAAE,YAAY,CAAC,UAAU;YAC7B,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE,YAAY;YACxB,OAAO;YACP,KAAK;YACL,KAAK;YACL,YAAY;SACb,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,GAAW,EACX,YAAqB;QAErB,mDAAmD;QACnD,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClE,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,WAAW,EAAE,CAAC;QAChD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE1E,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,CAAC;QACnD,OAAO;YACL,MAAM;YACN,UAAU;SACX,CAAC;IACJ,CAAC;CACF"}

package/dist/fee/contracts.d.ts

@@ -0,0 +1,9 @@
+import { LinearFee__factory, ProgressiveFee__factory, RegressiveFee__factory, RoutingFee__factory } from '@hyperlane-xyz/core';
+export declare const evmTokenFeeFactories: {
+    readonly LinearFee: LinearFee__factory;
+    readonly ProgressiveFee: ProgressiveFee__factory;
+    readonly RegressiveFee: RegressiveFee__factory;
+    readonly RoutingFee: RoutingFee__factory;
+};
+export type EvmTokenFeeFactories = typeof evmTokenFeeFactories;
+//# sourceMappingURL=contracts.d.ts.map

package/dist/fee/contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../../src/fee/contracts.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,qBAAqB,CAAC;AAI7B,eAAO,MAAM,oBAAoB;;;;;CAKyB,CAAC;AAE3D,MAAM,MAAM,oBAAoB,GAAG,OAAO,oBAAoB,CAAC"}

package/dist/fee/contracts.js

@@ -0,0 +1,9 @@
+import { LinearFee__factory, ProgressiveFee__factory, RegressiveFee__factory, RoutingFee__factory, } from '@hyperlane-xyz/core';
+import { TokenFeeType } from './types.js';
+export const evmTokenFeeFactories = {
+    [TokenFeeType.LinearFee]: new LinearFee__factory(),
+    [TokenFeeType.ProgressiveFee]: new ProgressiveFee__factory(),
+    [TokenFeeType.RegressiveFee]: new RegressiveFee__factory(),
+    [TokenFeeType.RoutingFee]: new RoutingFee__factory(),
+};
+//# sourceMappingURL=contracts.js.map

package/dist/fee/contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../../src/fee/contracts.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,IAAI,kBAAkB,EAAE;IAClD,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,IAAI,uBAAuB,EAAE;IAC5D,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,IAAI,sBAAsB,EAAE;IAC1D,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,IAAI,mBAAmB,EAAE;CACI,CAAC"}