@hyperlane-xyz/sdk 1.0.0-beta0 → 1.0.0-beta2

package/dist/gas/calculator.js

@@ -0,0 +1,240 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InterchainGasCalculator = void 0;
+const coingecko_api_1 = __importDefault(require("coingecko-api"));
+const ethers_1 = require("ethers");
+const utils_1 = require("@hyperlane-xyz/utils");
+const chainMetadata_1 = require("../consts/chainMetadata");
+const HyperlaneCore_1 = require("../core/HyperlaneCore");
+const domains_1 = require("../domains");
+const number_1 = require("../utils/number");
+const token_prices_1 = require("./token-prices");
+/**
+ * A note on arithmetic:
+ * The ethers.BigNumber implementation behaves very similar to Solidity's
+ * number handling by not supporting decimals. To avoid adding another big
+ * number implementation as a dependency, we use ethers.FixedNumber, a
+ * fixed point implementation intended to model how Solidity's half-supported
+ * fixed point numbers work, see https://docs.soliditylang.org/en/v0.8.13/types.html#fixed-point-numbers).
+ *
+ * Generally, ceiling is used rather than floor here to err on the side of over-
+ * estimating amounts.
+ */
+// If a chain doesn't specify how many decimals their native token has, 18 is used.
+const DEFAULT_TOKEN_DECIMALS = 18;
+// Intrinsic gas for a transaction. Does not consider calldata costs or differences in
+// intrinsic gas for different chains.
+const GAS_INTRINSIC = 21000;
+// The gas used to process a message when the quorum size is zero.
+// Includes intrinsic gas and all other gas that does not scale with the
+// quorum size. Excludes the cost of calling `recipient.handle()`.
+// Derived by observing the amount of gas consumed for a quorum of 1 (~103000 gas),
+// and subtracting the gas overhead per signature.
+const GAS_OVERHEAD_BASE = 95000;
+// The amount of gas used for each signature when a signed checkpoint
+// is submitted for verification.
+// Really observed to be about 8568, but rounding up for safety.
+const GAS_OVERHEAD_PER_SIGNATURE = 9000;
+/**
+ * Calculates interchain gas payments.
+ */
+class InterchainGasCalculator {
+    constructor(multiProvider, core, config) {
+        var _a, _b;
+        this.multiProvider = multiProvider;
+        this.core = core;
+        if (config === null || config === void 0 ? void 0 : config.tokenPriceGetter) {
+            this.tokenPriceGetter = config.tokenPriceGetter;
+        }
+        else {
+            const coinGecko = new coingecko_api_1.default();
+            this.tokenPriceGetter = new token_prices_1.CoinGeckoTokenPriceGetter(coinGecko);
+        }
+        this.paymentEstimateMultiplier = ethers_1.FixedNumber.from((_a = config === null || config === void 0 ? void 0 : config.paymentEstimateMultiplier) !== null && _a !== void 0 ? _a : '1.25');
+        this.messageGasEstimateBuffer = ethers_1.BigNumber.from((_b = config === null || config === void 0 ? void 0 : config.messageGasEstimateBuffer) !== null && _b !== void 0 ? _b : 50000);
+    }
+    static fromEnvironment(env, multiProvider, config) {
+        const core = HyperlaneCore_1.HyperlaneCore.fromEnvironment(env, multiProvider);
+        return new InterchainGasCalculator(multiProvider, core, config);
+    }
+    /**
+     * Given an amount of gas to consume on the destination chain, calculates the
+     * estimated payment denominated in the native token of the origin chain.
+     * Considers the exchange rate between the native tokens of the origin and
+     * destination chains and the suggested gas price of the destination chain.
+     * @param origin The name of the origin chain.
+     * @param destination The name of the destination chain.
+     * @param gas The amount of gas to pay for on the destination chain.
+     * @returns An estimated amount of origin chain tokens to cover gas costs on the
+     * destination chain.
+     */
+    estimatePaymentForGas(origin, destination, gas) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const destinationGasPrice = yield this.getGasPrice(destination);
+            const destinationGasCost = gas.mul(destinationGasPrice);
+            const originGasCost = yield this.convertBetweenTokens(destination, origin, destinationGasCost);
+            // Applies a multiplier
+            return (0, number_1.mulBigAndFixed)(originGasCost, this.paymentEstimateMultiplier, true);
+        });
+    }
+    /**
+     * Given an amount of gas the message's recipient `handle` function is expected
+     * to use, calculates the estimated payment denominated in the native
+     * token of the origin chain. Considers the exchange rate between the native
+     * tokens of the origin and destination chains, the suggested gas price on
+     * the destination chain, gas costs incurred by a relayer when submitting a signed
+     * checkpoint to the destination chain, and the overhead gas cost in Inbox of processing
+     * a message.
+     * @param origin The name of the origin chain.
+     * @param destination The name of the destination chain.
+     * @param handleGas The amount of gas the recipient `handle` function
+     * is estimated to use.
+     * @returns An estimated amount of origin chain tokens to cover gas costs of the
+     * message on the destination chain.
+     */
+    estimatePaymentForHandleGas(origin, destination, handleGas) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const destinationGas = handleGas.add(yield this.estimateGasForProcess(origin, destination));
+            return this.estimatePaymentForGas(origin, destination, destinationGas);
+        });
+    }
+    /**
+     * Calculates the estimated payment to process the message on its destination chain,
+     * denominated in the native token of the origin chain. The gas used by the message's
+     * recipient handler function is estimated in an eth_estimateGas call to the
+     * destination chain, and is then used to calculate the payment using
+     * Currently made private as it does not work properly for Arbitrum.
+     * {@link estimatePaymentForHandleGasAmount}.
+     * @param message The parsed message to estimate payment for.
+     * @returns An estimated amount of origin chain tokens to cover gas costs of the
+     * message on the destination chain.
+     */
+    estimatePaymentForMessage(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const handleGas = yield this.estimateGasForHandle(message);
+            return this.estimatePaymentForHandleGas(message.origin, message.destination, handleGas);
+        });
+    }
+    /**
+     * Using the exchange rates provided by tokenPriceGetter, returns the amount of
+     * `toChain` native tokens equivalent in value to the provided `fromAmount` of
+     * `fromChain` native tokens. Accounts for differences in the decimals of the tokens.
+     * @param fromChain The chain whose native token is being converted from.
+     * @param toChain The chain whose native token is being converted into.
+     * @param fromAmount The amount of `fromChain` native tokens to convert from.
+     * @returns The amount of `toChain` native tokens whose value is equivalent to
+     * `fromAmount` of `fromChain` native tokens.
+     */
+    convertBetweenTokens(fromChain, toChain, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Does not factor in differing token decimals.
+            const exchangeRate = yield this.tokenPriceGetter.getTokenExchangeRate(fromChain, toChain);
+            // 1/100th of a cent
+            const PRECISION = 1000;
+            return (0, number_1.convertDecimalValue)(value.mul(Math.round(exchangeRate * PRECISION)).div(PRECISION), this.tokenDecimals(fromChain), this.tokenDecimals(toChain));
+        });
+    }
+    /**
+     * Gets a suggested gas price for a chain.
+     * @param chainName The name of the chain to get the gas price for
+     * @returns The suggested gas price in wei on the destination chain.
+     */
+    getGasPrice(chain) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const provider = this.multiProvider.getChainConnection(chain).provider;
+            if (provider == undefined) {
+                throw new Error(`Missing provider for ${chain}`);
+            }
+            return provider.getGasPrice();
+        });
+    }
+    /**
+     * Gets the number of decimals of the provided chain's native token.
+     * @param chain The chain.
+     * @returns The number of decimals of `chain`'s native token.
+     */
+    tokenDecimals(chain) {
+        var _a;
+        return (_a = chainMetadata_1.chainMetadata[chain].nativeToken.decimals) !== null && _a !== void 0 ? _a : DEFAULT_TOKEN_DECIMALS;
+    }
+    /**
+     * Estimates the amount of gas used by message's recipient `handle` function
+     * on its destination chain. This does not assume the Inbox of the destination
+     * chain has a checkpoint that the message is included in, and does not
+     * consider intrinsic gas or any "overhead" gas incurred by Inbox.process.
+     * The estimated gas returned is the sum of:
+     * 1. The estimated gas consumption of a direct call to the `handle`
+     *    function of the recipient address using the correct parameters and
+     *    setting the `from` address of the transaction to the address of the inbox.
+     * 2. A buffer to account for inaccuracies in the above estimation.
+     * @param message The message to estimate recipient `handle` gas usage for.
+     * @returns The estimated gas required by the message's recipient handle function
+     * on the destination chain.
+     */
+    estimateGasForHandle(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const provider = this.multiProvider.getChainConnection(message.destination)
+                .provider;
+            const mailbox = this.core.getContracts(message.destination).mailbox
+                .contract;
+            const handlerInterface = new ethers_1.ethers.utils.Interface([
+                'function handle(uint32,bytes32,bytes)',
+            ]);
+            // Estimates a direct call to the `handle` function of the recipient
+            // with the `from` address set to the inbox.
+            // This includes intrinsic gas.
+            const directHandleCallGas = yield provider.estimateGas({
+                to: utils_1.utils.bytes32ToAddress(message.recipient),
+                from: mailbox.address,
+                data: handlerInterface.encodeFunctionData('handle', [
+                    chainMetadata_1.chainMetadata[message.origin].id,
+                    utils_1.utils.addressToBytes32(message.sender),
+                    message.body,
+                ]),
+            });
+            // Subtract intrinsic gas, which is included in directHandleCallGas.
+            // Note the "real" intrinsic gas will always be higher than this.intrinsicGas
+            // due to calldata costs, but this is desired because subtracting the lower bound
+            // this.intrinsicGas will result in a more generous final estimate.
+            return directHandleCallGas
+                .add(this.messageGasEstimateBuffer)
+                .sub(this.intrinsicGas());
+        });
+    }
+    /**
+     * @returns A generous estimation of the gas consumption of all process
+     * operations within Inbox.sol, including intrinsic gas. Does not include any gas
+     * consumed within a message's recipient `handle` function.
+     */
+    estimateGasForProcess(origin, destination) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // TODO: Check the recipient module
+            const module = this.core.getContracts(destination).multisigIsm;
+            const threshold = yield module.threshold(domains_1.ChainNameToDomainId[origin]);
+            return ethers_1.BigNumber.from(threshold)
+                .mul(GAS_OVERHEAD_PER_SIGNATURE)
+                .add(GAS_OVERHEAD_BASE);
+        });
+    }
+    /**
+     * @returns The intrinsic gas of a basic transaction. Note this does not consider calldata
+     * costs or potentially different intrinsic gas costs for different chains.
+     */
+    intrinsicGas() {
+        return ethers_1.BigNumber.from(GAS_INTRINSIC);
+    }
+}
+exports.InterchainGasCalculator = InterchainGasCalculator;
+//# sourceMappingURL=calculator.js.map

package/dist/gas/calculator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculator.js","sourceRoot":"","sources":["../../src/gas/calculator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kEAAsC;AACtC,mCAAwD;AAExD,gDAA6C;AAE7C,2DAAwD;AACxD,yDAI+B;AAC/B,wCAAiD;AAGjD,4CAAsE;AAEtE,iDAA6E;AAE7E;;;;;;;;;;GAUG;AAEH,mFAAmF;AACnF,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC,sFAAsF;AACtF,sCAAsC;AACtC,MAAM,aAAa,GAAG,KAAM,CAAC;AAE7B,kEAAkE;AAClE,wEAAwE;AACxE,kEAAkE;AAClE,mFAAmF;AACnF,kDAAkD;AAClD,MAAM,iBAAiB,GAAG,KAAM,CAAC;AAEjC,qEAAqE;AACrE,iCAAiC;AACjC,gEAAgE;AAChE,MAAM,0BAA0B,GAAG,IAAK,CAAC;AAkCzC;;GAEG;AACH,MAAa,uBAAuB;IAkBlC,YACE,aAAmC,EACnC,IAA0B,EAC1B,MAAsC;;QAEtC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,EAAE;YAC5B,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;SACjD;aAAM;YACL,MAAM,SAAS,GAAG,IAAI,uBAAS,EAAE,CAAC;YAClC,IAAI,CAAC,gBAAgB,GAAG,IAAI,wCAAyB,CAAC,SAAS,CAAC,CAAC;SAClE;QAED,IAAI,CAAC,yBAAyB,GAAG,oBAAW,CAAC,IAAI,CAC/C,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,yBAAyB,mCAAI,MAAM,CAC5C,CAAC;QACF,IAAI,CAAC,wBAAwB,GAAG,kBAAS,CAAC,IAAI,CAC5C,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,wBAAwB,mCAAI,KAAM,CAC3C,CAAC;IACJ,CAAC;IA9BD,MAAM,CAAC,eAAe,CACpB,GAAQ,EACR,aAAuD,EACvD,MAAsC;QAEtC,MAAM,IAAI,GAAG,6BAAa,CAAC,eAAe,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/D,OAAO,IAAI,uBAAuB,CAAC,aAAa,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAyBD;;;;;;;;;;OAUG;IACG,qBAAqB,CACzB,MAAmC,EACnC,WAAwB,EACxB,GAAc;;YAEd,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YAChE,MAAM,kBAAkB,GAAG,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YACxD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,oBAAoB,CACnD,WAAW,EACX,MAAM,EACN,kBAAkB,CACnB,CAAC;YACF,uBAAuB;YACvB,OAAO,IAAA,uBAAc,EACnB,aAAa,EACb,IAAI,CAAC,yBAAyB,EAC9B,IAAI,CACL,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,2BAA2B,CAC/B,MAAmC,EACnC,WAAwB,EACxB,SAAoB;;YAEpB,MAAM,cAAc,GAAG,SAAS,CAAC,GAAG,CAClC,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,CACtD,CAAC;YACF,OAAO,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;QACzE,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACa,yBAAyB,CACvC,OAA0C;;YAE1C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC,2BAA2B,CACrC,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,WAAW,EACnB,SAAS,CACV,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;;;;OASG;IACa,oBAAoB,CAClC,SAAgB,EAChB,OAAc,EACd,KAAgB;;YAEhB,+CAA+C;YAC/C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,CACnE,SAAS,EACT,OAAO,CACR,CAAC;YAEF,oBAAoB;YACpB,MAAM,SAAS,GAAG,IAAI,CAAC;YAEvB,OAAO,IAAA,4BAAmB,EACxB,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,EAC9D,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,EAC7B,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAC5B,CAAC;QACJ,CAAC;KAAA;IAED;;;;OAIG;IACa,WAAW,CAAC,KAAY;;YACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,QAAS,CAAC;YACxE,IAAI,QAAQ,IAAI,SAAS,EAAE;gBACzB,MAAM,IAAI,KAAK,CAAC,wBAAwB,KAAK,EAAE,CAAC,CAAC;aAClD;YACD,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;QAChC,CAAC;KAAA;IAED;;;;OAIG;IACO,aAAa,CAAC,KAAY;;QAClC,OAAO,MAAA,6BAAa,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,QAAQ,mCAAI,sBAAsB,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACa,oBAAoB,CAClC,OAAyC;;YAEzC,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,OAAO,CAAC,WAAW,CAAC;iBACxE,QAAS,CAAC;YAEb,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO;iBAChE,QAAQ,CAAC;YAEZ,MAAM,gBAAgB,GAAG,IAAI,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC;gBAClD,uCAAuC;aACxC,CAAC,CAAC;YACH,oEAAoE;YACpE,4CAA4C;YAC5C,+BAA+B;YAC/B,MAAM,mBAAmB,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC;gBACrD,EAAE,EAAE,aAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,SAAS,CAAC;gBAC7C,IAAI,EAAE,OAAO,CAAC,OAAO;gBACrB,IAAI,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,QAAQ,EAAE;oBAClD,6BAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE;oBAChC,aAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC;oBACtC,OAAO,CAAC,IAAI;iBACb,CAAC;aACH,CAAC,CAAC;YAEH,oEAAoE;YACpE,6EAA6E;YAC7E,iFAAiF;YACjF,mEAAmE;YACnE,OAAO,mBAAmB;iBACvB,GAAG,CAAC,IAAI,CAAC,wBAAwB,CAAC;iBAClC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAC9B,CAAC;KAAA;IAED;;;;OAIG;IACa,qBAAqB,CACnC,MAAmC,EACnC,WAAwB;;YAExB,mCAAmC;YACnC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC;YAC/D,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,6BAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;YACtE,OAAO,kBAAS,CAAC,IAAI,CAAC,SAAS,CAAC;iBAC7B,GAAG,CAAC,0BAA0B,CAAC;iBAC/B,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC5B,CAAC;KAAA;IAED;;;OAGG;IACO,YAAY;QACpB,OAAO,kBAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;CACF;AArPD,0DAqPC"}

package/dist/gas/calculator.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=calculator.test.d.ts.map

package/dist/gas/calculator.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculator.test.d.ts","sourceRoot":"","sources":["../../src/gas/calculator.test.ts"],"names":[],"mappings":""}

package/dist/gas/calculator.test.js

@@ -0,0 +1,208 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const ethers_1 = require("ethers");
+const sinon_1 = __importDefault(require("sinon"));
+const chains_1 = require("../consts/chains");
+const HyperlaneCore_1 = require("../core/HyperlaneCore");
+const MultiProvider_1 = require("../providers/MultiProvider");
+const testUtils_1 = require("../test/testUtils");
+const calculator_1 = require("./calculator");
+const HANDLE_GAS = 100000;
+const SUGGESTED_GAS_PRICE = 10;
+const INBOX_PROCESS_OVERHEAD_GAS = 100000;
+// Exposes protected methods so they can be stubbed.
+class TestInterchainGasCalculator extends calculator_1.InterchainGasCalculator {
+    estimateGasForProcess(origin, destination) {
+        return super.estimateGasForProcess(origin, destination);
+    }
+    estimateGasForHandle(message) {
+        return super.estimateGasForHandle(message);
+    }
+    convertBetweenTokens(fromChain, toChain, fromAmount) {
+        return super.convertBetweenTokens(fromChain, toChain, fromAmount);
+    }
+    tokenDecimals(chain) {
+        return super.tokenDecimals(chain);
+    }
+    getGasPrice(chain) {
+        return super.getGasPrice(chain);
+    }
+}
+describe('InterchainGasCalculator', () => {
+    const provider = new testUtils_1.MockProvider();
+    // TODO: fix types to not require the <any> here.
+    // This is because InterchainGasCalculator isn't very strongly typed,
+    // which is because ParsedMessage isn't very strongly typed. This results
+    // in InterchainGasCalculator expecting a multiprovider with providers for
+    // every chain.
+    const multiProvider = new MultiProvider_1.MultiProvider({
+        test1: { provider },
+        test2: { provider },
+        test3: { provider },
+    });
+    const core = HyperlaneCore_1.HyperlaneCore.fromEnvironment('test', multiProvider);
+    const origin = chains_1.Chains.test1;
+    const destination = chains_1.Chains.test2;
+    let tokenPriceGetter;
+    let calculator;
+    beforeEach(() => {
+        tokenPriceGetter = new testUtils_1.MockTokenPriceGetter();
+        tokenPriceGetter.setTokenPrice(origin, 9.0909);
+        tokenPriceGetter.setTokenPrice(destination, 5.5);
+        calculator = new TestInterchainGasCalculator(multiProvider, core, {
+            tokenPriceGetter,
+            // A multiplier of 1 makes testing easier to reason about
+            paymentEstimateMultiplier: '1',
+        });
+    });
+    afterEach(() => {
+        sinon_1.default.restore();
+        provider.clearMethodResolveValues();
+    });
+    describe('estimatePaymentForGas', () => {
+        it('estimates origin token payment from a specified destination gas amount', () => __awaiter(void 0, void 0, void 0, function* () {
+            // Set destination gas price to 10 wei
+            provider.setMethodResolveValue('getGasPrice', ethers_1.BigNumber.from(SUGGESTED_GAS_PRICE));
+            const estimatedPayment = yield calculator.estimatePaymentForGas(origin, destination, ethers_1.BigNumber.from(HANDLE_GAS));
+            // 100k gas * 10 gas price * ($5.5 per destination token / $9.0909 per origin token)
+            (0, chai_1.expect)(estimatedPayment.toNumber()).to.equal(605000);
+        }));
+    });
+    describe('estimatePaymentForHandleGas', () => {
+        it('estimates origin token payment from a specified destination handle gas amount', () => __awaiter(void 0, void 0, void 0, function* () {
+            // Set destination gas price to 10 wei
+            provider.setMethodResolveValue('getGasPrice', ethers_1.BigNumber.from(SUGGESTED_GAS_PRICE));
+            // Stub the inbox process overhead gas
+            sinon_1.default
+                .stub(calculator, 'estimateGasForProcess')
+                .returns(Promise.resolve(ethers_1.BigNumber.from(INBOX_PROCESS_OVERHEAD_GAS)));
+            const estimatedPayment = yield calculator.estimatePaymentForHandleGas(origin, destination, ethers_1.BigNumber.from(HANDLE_GAS));
+            // (100_000 dest handler gas + 100_000 process overhead gas)
+            // * 10 gas price * ($5.5 per destination token / $9.0909 per origin token)
+            (0, chai_1.expect)(estimatedPayment.toNumber()).to.equal(1210000);
+        }));
+    });
+    /*
+    describe('estimatePaymentForMessage', () => {
+      it('estimates origin token payment from a specified message', async () => {
+        // Set destination gas price to 10 wei
+        provider.setMethodResolveValue(
+          'getGasPrice',
+          BigNumber.from(SUGGESTED_GAS_PRICE),
+        );
+        // Set the estimated handle gas
+        sinon
+          .stub(calculator, 'estimateGasForHandle')
+          .returns(Promise.resolve(BigNumber.from(HANDLE_GAS)));
+        // Stub the inbox process overhead gas
+        sinon
+          .stub(calculator, 'estimateGasForProcess')
+          .returns(Promise.resolve(BigNumber.from(INBOX_PROCESS_OVERHEAD_GAS)));
+  
+        const zeroAddressBytes32 = utils.addressToBytes32(
+          ethers.constants.AddressZero,
+        );
+        const message: ParsedMessage<TestChainNames, Chains.test2> = {
+          origin: origin,
+          sender: zeroAddressBytes32,
+          destination: destination,
+          recipient: zeroAddressBytes32,
+          body: '0x12345678',
+        };
+  
+        const estimatedPayment = await calculator.estimatePaymentForMessage(
+          message,
+        );
+  
+        // (100_000 dest handler gas + 100_000 process overhead gas)
+        // * 10 gas price * ($5.5 per destination token / $9.0909 per origin token)
+        expect(estimatedPayment.toNumber()).to.equal(1_210_000);
+      });
+    });
+    */
+    describe('convertBetweenTokens', () => {
+        const destinationWei = ethers_1.BigNumber.from('1000');
+        it('converts using the USD value of origin and destination native tokens', () => __awaiter(void 0, void 0, void 0, function* () {
+            const originWei = yield calculator.convertBetweenTokens(destination, origin, destinationWei);
+            // 1000 * (5.5 / 9.0909)
+            (0, chai_1.expect)(originWei.toNumber()).to.equal(605);
+        }));
+        it('considers when the origin token decimals > the destination token decimals', () => __awaiter(void 0, void 0, void 0, function* () {
+            calculator.tokenDecimals = (chain) => {
+                if (chain === origin) {
+                    return 20;
+                }
+                return 18;
+            };
+            const originWei = yield calculator.convertBetweenTokens(destination, origin, destinationWei);
+            // 1000 * (5.5 / 9.0909) * 100
+            (0, chai_1.expect)(originWei.toNumber()).to.equal(60500);
+        }));
+        it('considers when the origin token decimals < the destination token decimals', () => __awaiter(void 0, void 0, void 0, function* () {
+            sinon_1.default
+                .stub(calculator, 'tokenDecimals')
+                .callsFake((chain) => {
+                if (chain === origin) {
+                    return 16;
+                }
+                return 18;
+            });
+            const originWei = yield calculator.convertBetweenTokens(destination, origin, destinationWei);
+            // 1000 * (5.5 / 9.0909) / 100
+            (0, chai_1.expect)(originWei.toNumber()).to.equal(6);
+        }));
+    });
+    describe('getGasPrice', () => {
+        it('gets the gas price from the provider', () => __awaiter(void 0, void 0, void 0, function* () {
+            provider.setMethodResolveValue('getGasPrice', ethers_1.BigNumber.from(SUGGESTED_GAS_PRICE));
+            (0, chai_1.expect)((yield calculator.getGasPrice(destination)).toNumber()).to.equal(SUGGESTED_GAS_PRICE);
+        }));
+    });
+    describe('estimateGasForProcess', () => {
+        let threshold;
+        // Mock the return value of MultisigIsm.threshold
+        // to return `threshold`. Because the mocking involves a closure,
+        // changing `threshold` will change the return value of MultisigIsm.threshold.
+        before(() => {
+            const getContractsStub = sinon_1.default.stub(core, 'getContracts');
+            let thresholdStub;
+            getContractsStub.callsFake((chain) => {
+                // Get the "real" return value of getContracts.
+                const contracts = getContractsStub.wrappedMethod.bind(core)(chain);
+                // Ethers contracts are frozen using Object.freeze, so we make a copy
+                // of the object so we can stub `threshold`.
+                const multisigIsm = Object.assign({}, contracts.multisigIsm);
+                // Because we are stubbing vaidatorManager.threshold when core.getContracts gets called,
+                // we must ensure we don't try to stub more than once or sinon will complain.
+                if (!thresholdStub) {
+                    thresholdStub = sinon_1.default
+                        .stub(multisigIsm, 'threshold')
+                        .callsFake(() => Promise.resolve(threshold));
+                    contracts.multisigIsm = multisigIsm;
+                }
+                return contracts;
+            });
+        });
+        it('scales the gas cost with the quorum threshold', () => __awaiter(void 0, void 0, void 0, function* () {
+            threshold = 2;
+            const gasWithThresholdLow = yield calculator.estimateGasForProcess(origin, destination);
+            threshold = 3;
+            const gasWithThresholdHigh = yield calculator.estimateGasForProcess(origin, destination);
+            (0, chai_1.expect)(gasWithThresholdHigh.gt(gasWithThresholdLow)).to.be.true;
+        }));
+    });
+});
+//# sourceMappingURL=calculator.test.js.map

package/dist/gas/calculator.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculator.test.js","sourceRoot":"","sources":["../../src/gas/calculator.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,+BAA8B;AAC9B,mCAAmC;AACnC,kDAA0B;AAE1B,6CAA0C;AAC1C,yDAAsD;AAEtD,8DAA2D;AAC3D,iDAAuE;AAGvE,6CAAsE;AAEtE,MAAM,UAAU,GAAG,MAAO,CAAC;AAC3B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,0BAA0B,GAAG,MAAO,CAAC;AAE3C,oDAAoD;AACpD,MAAM,2BAEJ,SAAQ,oCAA8B;IACtC,qBAAqB,CACnB,MAAmC,EACnC,WAAwB;QAExB,OAAO,KAAK,CAAC,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC1D,CAAC;IACD,oBAAoB,CAClB,OAAyC;QAEzC,OAAO,KAAK,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IACD,oBAAoB,CAClB,SAAgB,EAChB,OAAc,EACd,UAAqB;QAErB,OAAO,KAAK,CAAC,oBAAoB,CAAC,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IACpE,CAAC;IACD,aAAa,CAAC,KAAY;QACxB,OAAO,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IACD,WAAW,CAAC,KAAY;QACtB,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;CACF;AAED,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,MAAM,QAAQ,GAAG,IAAI,wBAAY,EAAE,CAAC;IACpC,iDAAiD;IACjD,qEAAqE;IACrE,yEAAyE;IACzE,0EAA0E;IAC1E,eAAe;IACf,MAAM,aAAa,GAAG,IAAI,6BAAa,CAAC;QACtC,KAAK,EAAE,EAAE,QAAQ,EAAE;QACnB,KAAK,EAAE,EAAE,QAAQ,EAAE;QACnB,KAAK,EAAE,EAAE,QAAQ,EAAE;KACpB,CAAC,CAAC;IACH,MAAM,IAAI,GAAkC,6BAAa,CAAC,eAAe,CACvE,MAAM,EACN,aAAa,CACd,CAAC;IACF,MAAM,MAAM,GAAG,eAAM,CAAC,KAAK,CAAC;IAC5B,MAAM,WAAW,GAAG,eAAM,CAAC,KAAK,CAAC;IAEjC,IAAI,gBAAsC,CAAC;IAC3C,IAAI,UAAuD,CAAC;IAE5D,UAAU,CAAC,GAAG,EAAE;QACd,gBAAgB,GAAG,IAAI,gCAAoB,EAAE,CAAC;QAC9C,gBAAgB,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/C,gBAAgB,CAAC,aAAa,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QACjD,UAAU,GAAG,IAAI,2BAA2B,CAAC,aAAa,EAAE,IAAI,EAAE;YAChE,gBAAgB;YAChB,yDAAyD;YACzD,yBAAyB,EAAE,GAAG;SAC/B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,eAAK,CAAC,OAAO,EAAE,CAAC;QAChB,QAAQ,CAAC,wBAAwB,EAAE,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,EAAE,CAAC,wEAAwE,EAAE,GAAS,EAAE;YACtF,sCAAsC;YACtC,QAAQ,CAAC,qBAAqB,CAC5B,aAAa,EACb,kBAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CACpC,CAAC;YAEF,MAAM,gBAAgB,GAAG,MAAM,UAAU,CAAC,qBAAqB,CAC7D,MAAM,EACN,WAAW,EACX,kBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAC3B,CAAC;YAEF,oFAAoF;YACpF,IAAA,aAAM,EAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAO,CAAC,CAAC;QACxD,CAAC,CAAA,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;QAC3C,EAAE,CAAC,+EAA+E,EAAE,GAAS,EAAE;YAC7F,sCAAsC;YACtC,QAAQ,CAAC,qBAAqB,CAC5B,aAAa,EACb,kBAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CACpC,CAAC;YAEF,sCAAsC;YACtC,eAAK;iBACF,IAAI,CAAC,UAAU,EAAE,uBAAuB,CAAC;iBACzC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAS,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC;YAExE,MAAM,gBAAgB,GAAG,MAAM,UAAU,CAAC,2BAA2B,CACnE,MAAM,EACN,WAAW,EACX,kBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAC3B,CAAC;YAEF,4DAA4D;YAC5D,2EAA2E;YAC3E,IAAA,aAAM,EAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAS,CAAC,CAAC;QAC1D,CAAC,CAAA,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAqCE;IAEF,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,MAAM,cAAc,GAAG,kBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE9C,EAAE,CAAC,sEAAsE,EAAE,GAAS,EAAE;YACpF,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,oBAAoB,CACrD,WAAW,EACX,MAAM,EACN,cAAc,CACf,CAAC;YAEF,wBAAwB;YACxB,IAAA,aAAM,EAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7C,CAAC,CAAA,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,GAAS,EAAE;YACzF,UAAU,CAAC,aAAa,GAAG,CAAC,KAAqB,EAAE,EAAE;gBACnD,IAAI,KAAK,KAAK,MAAM,EAAE;oBACpB,OAAO,EAAE,CAAC;iBACX;gBACD,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC;YAEF,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,oBAAoB,CACrD,WAAW,EACX,MAAM,EACN,cAAc,CACf,CAAC;YAEF,8BAA8B;YAC9B,IAAA,aAAM,EAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAA,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,GAAS,EAAE;YACzF,eAAK;iBACF,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC;iBACjC,SAAS,CAAC,CAAC,KAAqB,EAAE,EAAE;gBACnC,IAAI,KAAK,KAAK,MAAM,EAAE;oBACpB,OAAO,EAAE,CAAC;iBACX;gBACD,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;YAEL,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,oBAAoB,CACrD,WAAW,EACX,MAAM,EACN,cAAc,CACf,CAAC;YAEF,8BAA8B;YAC9B,IAAA,aAAM,EAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAA,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,sCAAsC,EAAE,GAAS,EAAE;YACpD,QAAQ,CAAC,qBAAqB,CAC5B,aAAa,EACb,kBAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CACpC,CAAC;YAEF,IAAA,aAAM,EAAC,CAAC,MAAM,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CACrE,mBAAmB,CACpB,CAAC;QACJ,CAAC,CAAA,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,IAAI,SAAiB,CAAC;QACtB,iDAAiD;QACjD,iEAAiE;QACjE,8EAA8E;QAC9E,MAAM,CAAC,GAAG,EAAE;YACV,MAAM,gBAAgB,GAAG,eAAK,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;YAC1D,IAAI,aAA0C,CAAC;YAC/C,gBAAgB,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;gBACnC,+CAA+C;gBAC/C,MAAM,SAAS,GACb,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;gBAEnD,qEAAqE;gBACrE,4CAA4C;gBAC5C,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;gBAE7D,wFAAwF;gBACxF,6EAA6E;gBAC7E,IAAI,CAAC,aAAa,EAAE;oBAClB,aAAa,GAAG,eAAK;yBAClB,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC;yBAC9B,SAAS,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;oBAE/C,SAAS,CAAC,WAAW,GAAG,WAAW,CAAC;iBACrC;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,GAAS,EAAE;YAC7D,SAAS,GAAG,CAAC,CAAC;YACd,MAAM,mBAAmB,GAAG,MAAM,UAAU,CAAC,qBAAqB,CAChE,MAAM,EACN,WAAW,CACZ,CAAC;YAEF,SAAS,GAAG,CAAC,CAAC;YACd,MAAM,oBAAoB,GAAG,MAAM,UAAU,CAAC,qBAAqB,CACjE,MAAM,EACN,WAAW,CACZ,CAAC;YAEF,IAAA,aAAM,EAAC,oBAAoB,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAClE,CAAC,CAAA,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/gas/token-prices.d.ts

@@ -0,0 +1,34 @@
+import CoinGecko from 'coingecko-api';
+import { ChainName } from '../types';
+export interface TokenPriceGetter {
+    getTokenPrice(chain: ChainName): Promise<number>;
+    getTokenExchangeRate(base: ChainName, quote: ChainName): Promise<number>;
+}
+export declare type CoinGeckoInterface = Pick<CoinGecko, 'simple'>;
+export declare type CoinGeckoSimpleInterface = CoinGecko['simple'];
+export declare type CoinGeckoSimplePriceParams = Parameters<CoinGeckoSimpleInterface['price']>[0];
+export declare type CoinGeckoResponse = ReturnType<CoinGeckoSimpleInterface['price']>;
+declare type TokenPriceCacheEntry = {
+    price: number;
+    timestamp: Date;
+};
+declare class TokenPriceCache {
+    protected cache: Map<ChainName, TokenPriceCacheEntry>;
+    protected freshSeconds: number;
+    protected evictionSeconds: number;
+    constructor(freshSeconds?: number, evictionSeconds?: number);
+    put(chain: ChainName, price: number): void;
+    isFresh(chain: ChainName): boolean;
+    fetch(chain: ChainName): number;
+}
+export declare class CoinGeckoTokenPriceGetter implements TokenPriceGetter {
+    protected coinGecko: CoinGeckoInterface;
+    protected cache: TokenPriceCache;
+    constructor(coinGecko: CoinGeckoInterface, expirySeconds?: number);
+    getTokenPrice(chain: ChainName): Promise<number>;
+    getTokenExchangeRate(base: ChainName, quote: ChainName): Promise<number>;
+    private getTokenPrices;
+    private queryTokenPrices;
+}
+export {};
+//# sourceMappingURL=token-prices.d.ts.map

package/dist/gas/token-prices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-prices.d.ts","sourceRoot":"","sources":["../../src/gas/token-prices.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,eAAe,CAAC;AAMtC,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACjD,oBAAoB,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC1E;AAED,oBAAY,kBAAkB,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AAC3D,oBAAY,wBAAwB,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAC3D,oBAAY,0BAA0B,GAAG,UAAU,CACjD,wBAAwB,CAAC,OAAO,CAAC,CAClC,CAAC,CAAC,CAAC,CAAC;AACL,oBAAY,iBAAiB,GAAG,UAAU,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;AAE9E,aAAK,oBAAoB,GAAG;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,IAAI,CAAC;CACjB,CAAC;AAEF,cAAM,eAAe;IACnB,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;IACtD,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;gBAEtB,YAAY,SAAK,EAAE,eAAe,SAAc;IAM5D,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAK1C,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;IAWlC,KAAK,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM;CAchC;AAED,qBAAa,yBAA0B,YAAW,gBAAgB;IAChE,SAAS,CAAC,SAAS,EAAE,kBAAkB,CAAC;IACxC,SAAS,CAAC,KAAK,EAAE,eAAe,CAAC;gBAErB,SAAS,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,MAAM;IAK3D,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IAKhD,oBAAoB,CACxB,IAAI,EAAE,SAAS,EACf,KAAK,EAAE,SAAS,GACf,OAAO,CAAC,MAAM,CAAC;YAKJ,cAAc;YA0Bd,gBAAgB;CAe/B"}

package/dist/gas/token-prices.js

@@ -0,0 +1,105 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoinGeckoTokenPriceGetter = void 0;
+const utils_1 = require("@hyperlane-xyz/utils");
+const chainMetadata_1 = require("../consts/chainMetadata");
+const chains_1 = require("../consts/chains");
+class TokenPriceCache {
+    constructor(freshSeconds = 60, evictionSeconds = 3 * 60 * 60) {
+        this.cache = new Map();
+        this.freshSeconds = freshSeconds;
+        this.evictionSeconds = evictionSeconds;
+    }
+    put(chain, price) {
+        const now = new Date();
+        this.cache.set(chain, { timestamp: now, price });
+    }
+    isFresh(chain) {
+        const entry = this.cache.get(chain);
+        if (!entry)
+            return false;
+        const expiryTime = new Date(entry.timestamp.getTime() + 1000 * this.freshSeconds);
+        const now = new Date();
+        return now < expiryTime;
+    }
+    fetch(chain) {
+        const entry = this.cache.get(chain);
+        if (!entry) {
+            throw new Error(`no entry found for ${chain} in token price cache`);
+        }
+        const evictionTime = new Date(entry.timestamp.getTime() + 1000 * this.evictionSeconds);
+        const now = new Date();
+        if (now > evictionTime) {
+            throw new Error(`evicted entry found for ${chain} in token price cache`);
+        }
+        return entry.price;
+    }
+}
+class CoinGeckoTokenPriceGetter {
+    constructor(coinGecko, expirySeconds) {
+        this.coinGecko = coinGecko;
+        this.cache = new TokenPriceCache(expirySeconds);
+    }
+    getTokenPrice(chain) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const [price] = yield this.getTokenPrices([chain]);
+            return price;
+        });
+    }
+    getTokenExchangeRate(base, quote) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const [basePrice, quotePrice] = yield this.getTokenPrices([base, quote]);
+            return basePrice / quotePrice;
+        });
+    }
+    getTokenPrices(chains) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const isMainnet = chains.map((c) => chains_1.Mainnets.includes(c));
+            const allMainnets = isMainnet.every((v) => v === true);
+            const allTestnets = isMainnet.every((v) => v === false);
+            if (allTestnets) {
+                // Testnet tokens are all artificially priced at 1.0 USD.
+                return chains.map(() => 1);
+            }
+            if (!allMainnets) {
+                throw new Error('Cannot mix testnets and mainnets when fetching token prices');
+            }
+            const toQuery = chains.filter((c) => !this.cache.isFresh(c));
+            if (toQuery.length > 0) {
+                try {
+                    yield this.queryTokenPrices(toQuery);
+                }
+                catch (e) {
+                    (0, utils_1.warn)('Failed to query token prices', e);
+                }
+            }
+            return chains.map((chain) => this.cache.fetch(chain));
+        });
+    }
+    queryTokenPrices(chains) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const currency = 'usd';
+            // The CoinGecko API expects, in some cases, IDs that do not match
+            // ChainNames.
+            const ids = chains.map((chain) => chainMetadata_1.chainMetadata[chain].gasCurrencyCoinGeckoId || chain);
+            const response = yield this.coinGecko.simple.price({
+                ids,
+                vs_currencies: [currency],
+            });
+            const prices = ids.map((id) => response.data[id][currency]);
+            // Update the cache with the newly fetched prices
+            chains.map((chain, i) => this.cache.put(chain, prices[i]));
+        });
+    }
+}
+exports.CoinGeckoTokenPriceGetter = CoinGeckoTokenPriceGetter;
+//# sourceMappingURL=token-prices.js.map

package/dist/gas/token-prices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-prices.js","sourceRoot":"","sources":["../../src/gas/token-prices.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,gDAA4C;AAE5C,2DAAwD;AACxD,6CAA4C;AAoB5C,MAAM,eAAe;IAKnB,YAAY,YAAY,GAAG,EAAE,EAAE,eAAe,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE;QAC1D,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAmC,CAAC;QACxD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED,GAAG,CAAC,KAAgB,EAAE,KAAa;QACjC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,CAAC,KAAgB;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QAEzB,MAAM,UAAU,GAAG,IAAI,IAAI,CACzB,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,YAAY,CACrD,CAAC;QACF,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,OAAO,GAAG,GAAG,UAAU,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,KAAgB;QACpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,sBAAsB,KAAK,uBAAuB,CAAC,CAAC;SACrE;QACD,MAAM,YAAY,GAAG,IAAI,IAAI,CAC3B,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,eAAe,CACxD,CAAC;QACF,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,GAAG,YAAY,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,2BAA2B,KAAK,uBAAuB,CAAC,CAAC;SAC1E;QACD,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;CACF;AAED,MAAa,yBAAyB;IAIpC,YAAY,SAA6B,EAAE,aAAsB;QAC/D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,eAAe,CAAC,aAAa,CAAC,CAAC;IAClD,CAAC;IAEK,aAAa,CAAC,KAAgB;;YAClC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACnD,OAAO,KAAK,CAAC;QACf,CAAC;KAAA;IAEK,oBAAoB,CACxB,IAAe,EACf,KAAgB;;YAEhB,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;YACzE,OAAO,SAAS,GAAG,UAAU,CAAC;QAChC,CAAC;KAAA;IAEa,cAAc,CAAC,MAAmB;;YAC9C,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1D,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;YACvD,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC;YACxD,IAAI,WAAW,EAAE;gBACf,yDAAyD;gBACzD,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;aAC5B;YAED,IAAI,CAAC,WAAW,EAAE;gBAChB,MAAM,IAAI,KAAK,CACb,6DAA6D,CAC9D,CAAC;aACH;YAED,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7D,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtB,IAAI;oBACF,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;iBACtC;gBAAC,OAAO,CAAC,EAAE;oBACV,IAAA,YAAI,EAAC,8BAA8B,EAAE,CAAC,CAAC,CAAC;iBACzC;aACF;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QACxD,CAAC;KAAA;IAEa,gBAAgB,CAAC,MAAmB;;YAChD,MAAM,QAAQ,GAAG,KAAK,CAAC;YACvB,kEAAkE;YAClE,cAAc;YACd,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CACpB,CAAC,KAAK,EAAE,EAAE,CAAC,6BAAa,CAAC,KAAK,CAAC,CAAC,sBAAsB,IAAI,KAAK,CAChE,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC;gBACjD,GAAG;gBACH,aAAa,EAAE,CAAC,QAAQ,CAAC;aAC1B,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5D,iDAAiD;YACjD,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7D,CAAC;KAAA;CACF;AA/DD,8DA+DC"}

package/dist/gas/token-prices.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=token-prices.test.d.ts.map

package/dist/gas/token-prices.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-prices.test.d.ts","sourceRoot":"","sources":["../../src/gas/token-prices.test.ts"],"names":[],"mappings":""}