@hyperlane-xyz/sdk 0.5.0-beta0

package/dist/deploy/verify/ContractVerifier.js

@@ -0,0 +1,129 @@
+"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.ContractVerifier = void 0;
+const cross_fetch_1 = __importDefault(require("cross-fetch"));
+const debug_1 = require("debug");
+const ethers_1 = require("ethers");
+const utils_1 = require("@hyperlane-xyz/utils");
+const MultiGeneric_1 = require("../../utils/MultiGeneric");
+var ExplorerApiActions;
+(function (ExplorerApiActions) {
+    ExplorerApiActions["VERIFY_IMPLEMENTATION"] = "verifysourcecode";
+    ExplorerApiActions["MARK_PROXY"] = "verifyproxycontract";
+    ExplorerApiActions["CHECK_STATUS"] = "checkverifystatus";
+    ExplorerApiActions["CHECK_PROXY_STATUS"] = "checkproxyverification";
+})(ExplorerApiActions || (ExplorerApiActions = {}));
+var ExplorerApiErrors;
+(function (ExplorerApiErrors) {
+    ExplorerApiErrors["ALREADY_VERIFIED"] = "Contract source code already verified";
+    ExplorerApiErrors["VERIFICATION_PENDING"] = "Pending in queue";
+    ExplorerApiErrors["PROXY_FAILED"] = "A corresponding implementation contract was unfortunately not detected for the proxy address.";
+})(ExplorerApiErrors || (ExplorerApiErrors = {}));
+class ContractVerifier extends MultiGeneric_1.MultiGeneric {
+    constructor(verificationInputs, multiProvider, apiKeys, flattenedSource, // flattened source code from eg `hardhat flatten`
+    compilerOptions) {
+        super(verificationInputs);
+        this.multiProvider = multiProvider;
+        this.apiKeys = apiKeys;
+        this.flattenedSource = flattenedSource;
+        this.compilerOptions = compilerOptions;
+        this.logger = (0, debug_1.debug)('hyperlane:ContractVerifier');
+    }
+    verify() {
+        return Promise.allSettled(this.chains().map((chain) => this.verifyChain(chain, this.get(chain))));
+    }
+    verifyChain(chain, inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.logger(`Verifying ${chain}...`);
+            const chainLogger = this.logger.extend(chain);
+            for (const input of inputs) {
+                yield this.verifyContract(chain, input, chainLogger);
+            }
+        });
+    }
+    submitForm(chain, action, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const chainConnection = this.multiProvider.getChainConnection(chain);
+            const apiUrl = chainConnection.getApiUrl();
+            const params = new URLSearchParams(Object.assign({ apikey: this.apiKeys[chain], module: 'contract', action }, options));
+            let response;
+            if (action === ExplorerApiActions.CHECK_STATUS ||
+                action === ExplorerApiActions.CHECK_PROXY_STATUS) {
+                response = yield (0, cross_fetch_1.default)(`${apiUrl}?${params}`);
+            }
+            else {
+                response = yield (0, cross_fetch_1.default)(apiUrl, {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': 'application/x-www-form-urlencoded',
+                    },
+                    body: params,
+                });
+            }
+            // avoid rate limiting (5 requests per second)
+            yield utils_1.utils.sleep(1000 / 5);
+            const result = JSON.parse(yield response.text());
+            if (result.message === 'NOTOK') {
+                switch (result.result) {
+                    case ExplorerApiErrors.VERIFICATION_PENDING:
+                        yield utils_1.utils.sleep(5000);
+                        return this.submitForm(chain, action, options);
+                    case ExplorerApiErrors.ALREADY_VERIFIED:
+                        return;
+                    case ExplorerApiErrors.PROXY_FAILED:
+                    default:
+                        throw new Error(`Verification failed: ${result.result}`);
+                }
+            }
+            return result.result;
+        });
+    }
+    verifyContract(chain, input, logger = this.logger) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (input.address === ethers_1.ethers.constants.AddressZero) {
+                return;
+            }
+            logger(`Checking ${input.address} (${input.name})...`);
+            const data = Object.assign({ sourceCode: this.flattenedSource, contractname: input.name, contractaddress: input.address, 
+                // TYPO IS ENFORCED BY API
+                constructorArguements: utils_1.utils.strip0x((_a = input.constructorArguments) !== null && _a !== void 0 ? _a : '') }, this.compilerOptions);
+            const guid = yield this.submitForm(chain, ExplorerApiActions.VERIFY_IMPLEMENTATION, data);
+            const addressUrl = yield this.multiProvider
+                .getChainConnection(chain)
+                .getAddressUrl(input.address);
+            // poll for verified status
+            if (guid) {
+                yield this.submitForm(chain, ExplorerApiActions.CHECK_STATUS, { guid });
+            }
+            logger(`Already verified at ${addressUrl}#code`);
+            // mark as proxy (if applicable)
+            if (input.isProxy) {
+                const proxyGuid = yield this.submitForm(chain, ExplorerApiActions.MARK_PROXY, {
+                    address: input.address,
+                });
+                // poll for verified proxy status
+                if (proxyGuid) {
+                    yield this.submitForm(chain, ExplorerApiActions.CHECK_PROXY_STATUS, {
+                        guid: proxyGuid,
+                    });
+                }
+                logger(`Already verified at ${addressUrl}#readProxyContract`);
+            }
+        });
+    }
+}
+exports.ContractVerifier = ContractVerifier;
+//# sourceMappingURL=ContractVerifier.js.map

package/dist/deploy/verify/ContractVerifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContractVerifier.js","sourceRoot":"","sources":["../../../src/deploy/verify/ContractVerifier.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,8DAAgC;AAChC,iCAAwC;AACxC,mCAAgC;AAEhC,gDAA6C;AAI7C,2DAAwD;AAQxD,IAAK,kBAKJ;AALD,WAAK,kBAAkB;IACrB,gEAA0C,CAAA;IAC1C,wDAAkC,CAAA;IAClC,wDAAkC,CAAA;IAClC,mEAA6C,CAAA;AAC/C,CAAC,EALI,kBAAkB,KAAlB,kBAAkB,QAKtB;AAED,IAAK,iBAIJ;AAJD,WAAK,iBAAiB;IACpB,+EAA0D,CAAA;IAC1D,8DAAyC,CAAA;IACzC,mIAA8G,CAAA;AAChH,CAAC,EAJI,iBAAiB,KAAjB,iBAAiB,QAIrB;AAED,MAAa,gBAA0C,SAAQ,2BAG9D;IAGC,YACE,kBAAsD,EACnC,aAAmC,EACnC,OAAgC,EAChC,eAAuB,EAAE,kDAAkD;IAC3E,eAAgC;QAEnD,KAAK,CAAC,kBAAkB,CAAC,CAAC;QALP,kBAAa,GAAb,aAAa,CAAsB;QACnC,YAAO,GAAP,OAAO,CAAyB;QAChC,oBAAe,GAAf,eAAe,CAAQ;QACvB,oBAAe,GAAf,eAAe,CAAiB;QAGnD,IAAI,CAAC,MAAM,GAAG,IAAA,aAAK,EAAC,4BAA4B,CAAC,CAAC;IACpD,CAAC;IAED,MAAM;QACJ,OAAO,OAAO,CAAC,UAAU,CACvB,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CACvE,CAAC;IACJ,CAAC;IAEK,WAAW,CAAC,KAAY,EAAE,MAAyB;;YACvD,IAAI,CAAC,MAAM,CAAC,aAAa,KAAK,KAAK,CAAC,CAAC;YACrC,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC9C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;gBAC1B,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;aACtD;QACH,CAAC;KAAA;IAEa,UAAU,CACtB,KAAY,EACZ,MAA0B,EAC1B,OAAgC;;YAEhC,MAAM,eAAe,GAAG,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACrE,MAAM,MAAM,GAAG,eAAe,CAAC,SAAS,EAAE,CAAC;YAE3C,MAAM,MAAM,GAAG,IAAI,eAAe,iBAChC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAC3B,MAAM,EAAE,UAAU,EAClB,MAAM,IACH,OAAO,EACV,CAAC;YAEH,IAAI,QAAkB,CAAC;YACvB,IACE,MAAM,KAAK,kBAAkB,CAAC,YAAY;gBAC1C,MAAM,KAAK,kBAAkB,CAAC,kBAAkB,EAChD;gBACA,QAAQ,GAAG,MAAM,IAAA,qBAAK,EAAC,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC,CAAC;aAC/C;iBAAM;gBACL,QAAQ,GAAG,MAAM,IAAA,qBAAK,EAAC,MAAM,EAAE;oBAC7B,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACP,cAAc,EAAE,mCAAmC;qBACpD;oBACD,IAAI,EAAE,MAAM;iBACb,CAAC,CAAC;aACJ;YAED,8CAA8C;YAC9C,MAAM,aAAK,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;YAE5B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;YACjD,IAAI,MAAM,CAAC,OAAO,KAAK,OAAO,EAAE;gBAC9B,QAAQ,MAAM,CAAC,MAAM,EAAE;oBACrB,KAAK,iBAAiB,CAAC,oBAAoB;wBACzC,MAAM,aAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBACxB,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;oBACjD,KAAK,iBAAiB,CAAC,gBAAgB;wBACrC,OAAO;oBACT,KAAK,iBAAiB,CAAC,YAAY,CAAC;oBACpC;wBACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;iBAC5D;aACF;YAED,OAAO,MAAM,CAAC,MAAM,CAAC;QACvB,CAAC;KAAA;IAEK,cAAc,CAClB,KAAY,EACZ,KAAgC,EAChC,MAAM,GAAG,IAAI,CAAC,MAAM;;;YAEpB,IAAI,KAAK,CAAC,OAAO,KAAK,eAAM,CAAC,SAAS,CAAC,WAAW,EAAE;gBAClD,OAAO;aACR;YAED,MAAM,CAAC,YAAY,KAAK,CAAC,OAAO,KAAK,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC;YAEvD,MAAM,IAAI,mBACR,UAAU,EAAE,IAAI,CAAC,eAAe,EAChC,YAAY,EAAE,KAAK,CAAC,IAAI,EACxB,eAAe,EAAE,KAAK,CAAC,OAAO;gBAC9B,0BAA0B;gBAC1B,qBAAqB,EAAE,aAAK,CAAC,OAAO,CAAC,MAAA,KAAK,CAAC,oBAAoB,mCAAI,EAAE,CAAC,IACnE,IAAI,CAAC,eAAe,CACxB,CAAC;YAEF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAChC,KAAK,EACL,kBAAkB,CAAC,qBAAqB,EACxC,IAAI,CACL,CAAC;YAEF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa;iBACxC,kBAAkB,CAAC,KAAK,CAAC;iBACzB,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAEhC,2BAA2B;YAC3B,IAAI,IAAI,EAAE;gBACR,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,kBAAkB,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;aACzE;YACD,MAAM,CAAC,uBAAuB,UAAU,OAAO,CAAC,CAAC;YAEjD,gCAAgC;YAChC,IAAI,KAAK,CAAC,OAAO,EAAE;gBACjB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU,CACrC,KAAK,EACL,kBAAkB,CAAC,UAAU,EAC7B;oBACE,OAAO,EAAE,KAAK,CAAC,OAAO;iBACvB,CACF,CAAC;gBACF,iCAAiC;gBACjC,IAAI,SAAS,EAAE;oBACb,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,kBAAkB,CAAC,kBAAkB,EAAE;wBAClE,IAAI,EAAE,SAAS;qBAChB,CAAC,CAAC;iBACJ;gBACD,MAAM,CAAC,uBAAuB,UAAU,oBAAoB,CAAC,CAAC;aAC/D;;KACF;CACF;AAxID,4CAwIC"}

package/dist/deploy/verify/types.d.ts

@@ -0,0 +1,14 @@
+export declare type ContractVerificationInput = {
+    name: string;
+    address: string;
+    constructorArguments?: string;
+    isProxy?: boolean;
+};
+export declare type VerificationInput = ContractVerificationInput[];
+export declare type CompilerOptions = {
+    codeformat: 'solidity-single-file' | 'solidity-standard-json-input';
+    compilerversion: string;
+    optimizationUsed: '0' | '1';
+    runs: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/deploy/verify/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/deploy/verify/types.ts"],"names":[],"mappings":"AAAA,oBAAY,yBAAyB,GAAG;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,oBAAY,iBAAiB,GAAG,yBAAyB,EAAE,CAAC;AAE5D,oBAAY,eAAe,GAAG;IAC5B,UAAU,EAAE,sBAAsB,GAAG,8BAA8B,CAAC;IACpE,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,GAAG,GAAG,GAAG,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/deploy/verify/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/deploy/verify/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/deploy/verify/types.ts"],"names":[],"mappings":""}

package/dist/deploy/verify/utils.d.ts

@@ -0,0 +1,6 @@
+import { ethers, utils } from 'ethers';
+import { ContractVerificationInput } from './types';
+export declare function formatFunctionArguments(fragment: utils.Fragment, args: any[]): any;
+export declare function getConstructorArguments(contract: ethers.Contract, bytecode: string): any;
+export declare function getContractVerificationInput(name: string, contract: ethers.Contract, bytecode: string, isProxy?: boolean): ContractVerificationInput;
+//# sourceMappingURL=utils.d.ts.map

package/dist/deploy/verify/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/deploy/verify/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAEvC,OAAO,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AAEpD,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EACxB,IAAI,EAAE,GAAG,EAAE,GACV,GAAG,CAKL;AAED,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ,EACzB,QAAQ,EAAE,MAAM,GACf,GAAG,CAIL;AAED,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,CAAC,QAAQ,EACzB,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,OAAgC,GACxC,yBAAyB,CAO3B"}

package/dist/deploy/verify/utils.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getContractVerificationInput = exports.getConstructorArguments = exports.formatFunctionArguments = void 0;
+function formatFunctionArguments(fragment, args) {
+    const params = Object.fromEntries(fragment.inputs.map((input, index) => [input.name, args[index]]));
+    return JSON.stringify(params, null, 2);
+}
+exports.formatFunctionArguments = formatFunctionArguments;
+function getConstructorArguments(contract, bytecode) {
+    const tx = contract.deployTransaction;
+    if (tx === undefined)
+        throw new Error('deploy transaction not found');
+    return tx.data.replace(bytecode, '');
+}
+exports.getConstructorArguments = getConstructorArguments;
+function getContractVerificationInput(name, contract, bytecode, isProxy = name.endsWith('Proxy')) {
+    return {
+        name,
+        address: contract.address,
+        constructorArguments: getConstructorArguments(contract, bytecode),
+        isProxy,
+    };
+}
+exports.getContractVerificationInput = getContractVerificationInput;
+//# sourceMappingURL=utils.js.map

package/dist/deploy/verify/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/deploy/verify/utils.ts"],"names":[],"mappings":";;;AAIA,SAAgB,uBAAuB,CACrC,QAAwB,EACxB,IAAW;IAEX,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAC/B,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CACjE,CAAC;IACF,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACzC,CAAC;AARD,0DAQC;AAED,SAAgB,uBAAuB,CACrC,QAAyB,EACzB,QAAgB;IAEhB,MAAM,EAAE,GAAG,QAAQ,CAAC,iBAAiB,CAAC;IACtC,IAAI,EAAE,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IACtE,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AACvC,CAAC;AAPD,0DAOC;AAED,SAAgB,4BAA4B,CAC1C,IAAY,EACZ,QAAyB,EACzB,QAAgB,EAChB,UAAmB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;IAEzC,OAAO;QACL,IAAI;QACJ,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,oBAAoB,EAAE,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,CAAC;QACjE,OAAO;KACR,CAAC;AACJ,CAAC;AAZD,oEAYC"}

package/dist/domains.d.ts

@@ -0,0 +1,4 @@
+import { CompleteChainMap } from './types';
+export declare const DomainIdToChainName: Record<number, "polygon" | "arbitrum" | "alfajores" | "bsc" | "mumbai" | "kovan" | "goerli" | "fuji" | "celo" | "ethereum" | "avalanche" | "optimism" | "bsctestnet" | "arbitrumrinkeby" | "optimismkovan" | "auroratestnet" | "moonbasealpha" | "test1" | "test2" | "test3">;
+export declare const ChainNameToDomainId: CompleteChainMap<number>;
+//# sourceMappingURL=domains.d.ts.map

package/dist/domains.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"domains.d.ts","sourceRoot":"","sources":["../src/domains.ts"],"names":[],"mappings":"AAEA,OAAO,EAAa,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEtD,eAAO,MAAM,mBAAmB,+QAEF,CAAC;AAE/B,eAAO,MAAM,mBAAmB,0BAEH,CAAC"}

package/dist/domains.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChainNameToDomainId = exports.DomainIdToChainName = void 0;
+const chainMetadata_1 = require("./consts/chainMetadata");
+const chains_1 = require("./consts/chains");
+exports.DomainIdToChainName = Object.fromEntries(chains_1.AllChains.map((chain) => [chainMetadata_1.chainMetadata[chain].id, chain]));
+exports.ChainNameToDomainId = Object.fromEntries(chains_1.AllChains.map((chain) => [chain, chainMetadata_1.chainMetadata[chain].id]));
+//# sourceMappingURL=domains.js.map

package/dist/domains.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"domains.js","sourceRoot":"","sources":["../src/domains.ts"],"names":[],"mappings":";;;AAAA,0DAAuD;AACvD,4CAA4C;AAG/B,QAAA,mBAAmB,GAAG,MAAM,CAAC,WAAW,CACnD,kBAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,6BAAa,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAC9B,CAAC;AAElB,QAAA,mBAAmB,GAAG,MAAM,CAAC,WAAW,CACnD,kBAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,6BAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAC/B,CAAC"}

package/dist/events.d.ts

@@ -0,0 +1,25 @@
+import { providers } from 'ethers';
+import type { TypedEvent, TypedEventFilter } from '@hyperlane-xyz/core/dist/common';
+import { MultiProvider } from './providers/MultiProvider';
+import { ChainName } from './types';
+export declare class Annotated<T extends TypedEvent> {
+    readonly domain: number;
+    readonly eventName?: string;
+    readonly event: T;
+    readonly receipt: providers.TransactionReceipt;
+    constructor(domain: number, receipt: providers.TransactionReceipt, event: T, callerKnowsWhatTheyAreDoing?: boolean);
+    static fromEvent<T extends TypedEvent>(domain: number, event: T): Promise<Annotated<T>>;
+    static fromEvents<T extends TypedEvent>(domain: number, events: T[]): Promise<Annotated<T>[]>;
+    get contractAddress(): string;
+    get transactionHash(): string;
+    get blockNumber(): number;
+    get blockHash(): string;
+}
+export interface TSContract<T extends TypedEvent> {
+    queryFilter(event: TypedEventFilter<T>, fromBlockOrBlockhash?: number | undefined, toBlock?: number | undefined): Promise<Array<T>>;
+}
+export declare function queryAnnotatedEvents<T extends TypedEvent>(multiprovider: MultiProvider<any>, chain: ChainName, contract: TSContract<T>, filter: TypedEventFilter<T>, startBlock?: number, endBlock?: number): Promise<Array<Annotated<T>>>;
+export declare function findAnnotatedSingleEvent<T extends TypedEvent>(multiprovider: MultiProvider<any>, chain: ChainName, contract: TSContract<T>, filter: TypedEventFilter<T>, startBlock?: number): Promise<Array<Annotated<T>>>;
+export declare function getEvents<T extends TypedEvent>(multiprovider: MultiProvider<any>, chain: ChainName, contract: TSContract<T>, filter: TypedEventFilter<T>, startBlock?: number, endBlock?: number): Promise<Array<T>>;
+export declare function findEvent<T extends TypedEvent>(multiprovider: MultiProvider<any>, chain: ChainName, contract: TSContract<T>, filter: TypedEventFilter<T>, startBlock?: number): Promise<Array<T>>;
+//# sourceMappingURL=events.d.ts.map

package/dist/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC,OAAO,KAAK,EACV,UAAU,EACV,gBAAgB,EACjB,MAAM,iCAAiC,CAAC;AAGzC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC,qBAAa,SAAS,CAAC,CAAC,SAAS,UAAU;IACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,kBAAkB,CAAC;gBAE7C,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,SAAS,CAAC,kBAAkB,EACrC,KAAK,EAAE,CAAC,EACR,2BAA2B,UAAQ;WAYxB,SAAS,CAAC,CAAC,SAAS,UAAU,EACzC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,CAAC,GACP,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;WAKX,UAAU,CAAC,CAAC,SAAS,UAAU,EAC1C,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,CAAC,EAAE,GACV,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IAM1B,IAAI,eAAe,IAAI,MAAM,CAQ5B;IAED,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,SAAS,IAAI,MAAM,CAEtB;CACF;AAGD,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,UAAU;IAC9C,WAAW,CACT,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC1B,oBAAoB,CAAC,EAAE,MAAM,GAAG,SAAS,EACzC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAC3B,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;CACtB;AAED,wBAAsB,oBAAoB,CAAC,CAAC,SAAS,UAAU,EAC7D,aAAa,EAAE,aAAa,CAAC,GAAG,CAAC,EACjC,KAAK,EAAE,SAAS,EAChB,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EACvB,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC3B,UAAU,CAAC,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAU9B;AAED,wBAAsB,wBAAwB,CAAC,CAAC,SAAS,UAAU,EACjE,aAAa,EAAE,aAAa,CAAC,GAAG,CAAC,EACjC,KAAK,EAAE,SAAS,EAChB,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EACvB,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC3B,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAS9B;AAED,wBAAsB,SAAS,CAAC,CAAC,SAAS,UAAU,EAClD,aAAa,EAAE,aAAa,CAAC,GAAG,CAAC,EACjC,KAAK,EAAE,SAAS,EAChB,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EACvB,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC3B,UAAU,CAAC,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAanB;AAED,wBAAsB,SAAS,CAAC,CAAC,SAAS,UAAU,EAClD,aAAa,EAAE,aAAa,CAAC,GAAG,CAAC,EACjC,KAAK,EAAE,SAAS,EAChB,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EACvB,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC3B,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAYnB"}

package/dist/events.js

@@ -0,0 +1,161 @@
+"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.findEvent = exports.getEvents = exports.findAnnotatedSingleEvent = exports.queryAnnotatedEvents = exports.Annotated = void 0;
+const chainMetadata_1 = require("./consts/chainMetadata");
+class Annotated {
+    constructor(domain, receipt, event, callerKnowsWhatTheyAreDoing = false) {
+        var _a;
+        if (!callerKnowsWhatTheyAreDoing) {
+            throw new Error('Please instantiate using fromEvent or fromEvents');
+        }
+        this.domain = domain;
+        this.receipt = receipt;
+        this.eventName = (_a = event.eventSignature) === null || _a === void 0 ? void 0 : _a.split('(')[0];
+        this.event = event;
+    }
+    static fromEvent(domain, event) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const receipt = yield event.getTransactionReceipt();
+            return new Annotated(domain, receipt, event, true);
+        });
+    }
+    static fromEvents(domain, events) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return Promise.all(events.map((event) => __awaiter(this, void 0, void 0, function* () { return Annotated.fromEvent(domain, event); })));
+        });
+    }
+    get contractAddress() {
+        var _a;
+        // ok to use ! assertion here as we assume that the event is in the receipt
+        const address = (_a = this.receipt.logs.find((log) => log.logIndex === this.event.logIndex)) === null || _a === void 0 ? void 0 : _a.address;
+        if (!address)
+            throw new Error('Missing receipt. Class is in an inconsistent state');
+        return address;
+    }
+    get transactionHash() {
+        return this.receipt.transactionHash;
+    }
+    get blockNumber() {
+        return this.receipt.blockNumber;
+    }
+    get blockHash() {
+        return this.receipt.blockHash;
+    }
+}
+exports.Annotated = Annotated;
+function queryAnnotatedEvents(multiprovider, chain, contract, filter, startBlock, endBlock) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const events = yield getEvents(multiprovider, chain, contract, filter, startBlock, endBlock);
+        return Annotated.fromEvents(chainMetadata_1.chainMetadata[chain].id, events);
+    });
+}
+exports.queryAnnotatedEvents = queryAnnotatedEvents;
+function findAnnotatedSingleEvent(multiprovider, chain, contract, filter, startBlock) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const events = yield findEvent(multiprovider, chain, contract, filter, startBlock);
+        return Annotated.fromEvents(chainMetadata_1.chainMetadata[chain].id, events);
+    });
+}
+exports.findAnnotatedSingleEvent = findAnnotatedSingleEvent;
+function getEvents(multiprovider, chain, contract, filter, startBlock, endBlock) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const domain = chainMetadata_1.chainMetadata[chain];
+        if (domain.paginate) {
+            return getPaginatedEvents(multiprovider, chain, contract, filter, startBlock, endBlock);
+        }
+        return contract.queryFilter(filter, startBlock, endBlock);
+    });
+}
+exports.getEvents = getEvents;
+function findEvent(multiprovider, chain, contract, filter, startBlock) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const domain = chainMetadata_1.chainMetadata[chain];
+        if (domain.paginate) {
+            return findFromPaginatedEvents(multiprovider, chain, contract, filter, startBlock);
+        }
+        return contract.queryFilter(filter, startBlock);
+    });
+}
+exports.findEvent = findEvent;
+function getPaginatedEvents(multiprovider, chain, contract, filter, startBlock, endBlock) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const domain = chainMetadata_1.chainMetadata[chain];
+        if (!domain.paginate) {
+            throw new Error('Domain need not be paginated');
+        }
+        // get the first block by params
+        // or domain deployment block
+        const firstBlock = startBlock
+            ? Math.max(startBlock, domain.paginate.from)
+            : domain.paginate.from;
+        // get the last block by params
+        // or current block number
+        let lastBlock;
+        if (!endBlock) {
+            const provider = multiprovider.getChainConnection(chain).provider;
+            lastBlock = yield provider.getBlockNumber();
+        }
+        else {
+            lastBlock = endBlock;
+        }
+        // query domain pagination limit at a time, concurrently
+        const eventArrayPromises = [];
+        for (let from = firstBlock; from <= lastBlock; from += domain.paginate.blocks) {
+            const nextFrom = from + domain.paginate.blocks;
+            const to = Math.min(nextFrom, lastBlock);
+            const eventArrayPromise = contract.queryFilter(filter, from, to);
+            eventArrayPromises.push(eventArrayPromise);
+        }
+        // await promises & concatenate results
+        const eventArrays = yield Promise.all(eventArrayPromises);
+        let events = [];
+        for (const eventArray of eventArrays) {
+            events = events.concat(eventArray);
+        }
+        return events;
+    });
+}
+function findFromPaginatedEvents(multiprovider, chain, contract, filter, startBlock, endBlock) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const domain = chainMetadata_1.chainMetadata[chain];
+        if (!domain.paginate) {
+            throw new Error('Domain need not be paginated');
+        }
+        // get the first block by params
+        // or domain deployment block
+        const firstBlock = startBlock
+            ? Math.max(startBlock, domain.paginate.from)
+            : domain.paginate.from;
+        // get the last block by params
+        // or current block number
+        let lastBlock;
+        if (!endBlock) {
+            const provider = multiprovider.getChainConnection(chain).provider;
+            lastBlock = yield provider.getBlockNumber();
+        }
+        else {
+            lastBlock = endBlock;
+        }
+        // query domain pagination limit at a time, concurrently
+        // eslint-disable-next-line for-direction
+        for (let end = lastBlock; end > firstBlock; end -= domain.paginate.blocks) {
+            const nextEnd = end - domain.paginate.blocks;
+            const from = Math.max(nextEnd, firstBlock);
+            const queriedEvents = yield contract.queryFilter(filter, from, end);
+            if (queriedEvents.length > 0) {
+                return queriedEvents;
+            }
+        }
+        return [];
+    });
+}
+//# sourceMappingURL=events.js.map

package/dist/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":";;;;;;;;;;;;AAOA,0DAAuD;AAIvD,MAAa,SAAS;IAKpB,YACE,MAAc,EACd,OAAqC,EACrC,KAAQ,EACR,2BAA2B,GAAG,KAAK;;QAEnC,IAAI,CAAC,2BAA2B,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACrE;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,MAAA,KAAK,CAAC,cAAc,0CAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,MAAM,CAAO,SAAS,CACpB,MAAc,EACd,KAAQ;;YAER,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,qBAAqB,EAAE,CAAC;YACpD,OAAO,IAAI,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QACrD,CAAC;KAAA;IAED,MAAM,CAAO,UAAU,CACrB,MAAc,EACd,MAAW;;YAEX,OAAO,OAAO,CAAC,GAAG,CAChB,MAAM,CAAC,GAAG,CAAC,CAAO,KAAK,EAAE,EAAE,gDAAC,OAAA,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA,GAAA,CAAC,CAChE,CAAC;QACJ,CAAC;KAAA;IAED,IAAI,eAAe;;QACjB,2EAA2E;QAC3E,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CACpC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,CAC9C,0CAAE,OAAO,CAAC;QACX,IAAI,CAAC,OAAO;YACV,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;IACtC,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;IAClC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;IAChC,CAAC;CACF;AA3DD,8BA2DC;AAWD,SAAsB,oBAAoB,CACxC,aAAiC,EACjC,KAAgB,EAChB,QAAuB,EACvB,MAA2B,EAC3B,UAAmB,EACnB,QAAiB;;QAEjB,MAAM,MAAM,GAAG,MAAM,SAAS,CAC5B,aAAa,EACb,KAAK,EACL,QAAQ,EACR,MAAM,EACN,UAAU,EACV,QAAQ,CACT,CAAC;QACF,OAAO,SAAS,CAAC,UAAU,CAAC,6BAAa,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;CAAA;AAjBD,oDAiBC;AAED,SAAsB,wBAAwB,CAC5C,aAAiC,EACjC,KAAgB,EAChB,QAAuB,EACvB,MAA2B,EAC3B,UAAmB;;QAEnB,MAAM,MAAM,GAAG,MAAM,SAAS,CAC5B,aAAa,EACb,KAAK,EACL,QAAQ,EACR,MAAM,EACN,UAAU,CACX,CAAC;QACF,OAAO,SAAS,CAAC,UAAU,CAAC,6BAAa,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;CAAA;AAfD,4DAeC;AAED,SAAsB,SAAS,CAC7B,aAAiC,EACjC,KAAgB,EAChB,QAAuB,EACvB,MAA2B,EAC3B,UAAmB,EACnB,QAAiB;;QAEjB,MAAM,MAAM,GAAG,6BAAa,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,MAAM,CAAC,QAAQ,EAAE;YACnB,OAAO,kBAAkB,CACvB,aAAa,EACb,KAAK,EACL,QAAQ,EACR,MAAM,EACN,UAAU,EACV,QAAQ,CACT,CAAC;SACH;QACD,OAAO,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;CAAA;AApBD,8BAoBC;AAED,SAAsB,SAAS,CAC7B,aAAiC,EACjC,KAAgB,EAChB,QAAuB,EACvB,MAA2B,EAC3B,UAAmB;;QAEnB,MAAM,MAAM,GAAG,6BAAa,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,MAAM,CAAC,QAAQ,EAAE;YACnB,OAAO,uBAAuB,CAC5B,aAAa,EACb,KAAK,EACL,QAAQ,EACR,MAAM,EACN,UAAU,CACX,CAAC;SACH;QACD,OAAO,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;CAAA;AAlBD,8BAkBC;AAED,SAAe,kBAAkB,CAC/B,aAAiC,EACjC,KAAgB,EAChB,QAAuB,EACvB,MAA2B,EAC3B,UAAmB,EACnB,QAAiB;;QAEjB,MAAM,MAAM,GAAG,6BAAa,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;QACD,gCAAgC;QAChC,6BAA6B;QAC7B,MAAM,UAAU,GAAG,UAAU;YAC3B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC5C,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QACzB,+BAA+B;QAC/B,0BAA0B;QAC1B,IAAI,SAAS,CAAC;QACd,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,QAAQ,GAAG,aAAa,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,QAAS,CAAC;YACnE,SAAS,GAAG,MAAM,QAAQ,CAAC,cAAc,EAAE,CAAC;SAC7C;aAAM;YACL,SAAS,GAAG,QAAQ,CAAC;SACtB;QACD,wDAAwD;QACxD,MAAM,kBAAkB,GAAG,EAAE,CAAC;QAC9B,KACE,IAAI,IAAI,GAAG,UAAU,EACrB,IAAI,IAAI,SAAS,EACjB,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,EAC9B;YACA,MAAM,QAAQ,GAAG,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC/C,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACzC,MAAM,iBAAiB,GAAG,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YACjE,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;SAC5C;QACD,uCAAuC;QACvC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAC1D,IAAI,MAAM,GAAa,EAAE,CAAC;QAC1B,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACpC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;SACpC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CAAA;AAED,SAAe,uBAAuB,CACpC,aAAiC,EACjC,KAAgB,EAChB,QAAuB,EACvB,MAA2B,EAC3B,UAAmB,EACnB,QAAiB;;QAEjB,MAAM,MAAM,GAAG,6BAAa,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;QACD,gCAAgC;QAChC,6BAA6B;QAC7B,MAAM,UAAU,GAAG,UAAU;YAC3B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC5C,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QACzB,+BAA+B;QAC/B,0BAA0B;QAC1B,IAAI,SAAS,CAAC;QACd,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,QAAQ,GAAG,aAAa,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,QAAS,CAAC;YACnE,SAAS,GAAG,MAAM,QAAQ,CAAC,cAAc,EAAE,CAAC;SAC7C;aAAM;YACL,SAAS,GAAG,QAAQ,CAAC;SACtB;QACD,wDAAwD;QACxD,yCAAyC;QACzC,KAAK,IAAI,GAAG,GAAG,SAAS,EAAE,GAAG,GAAG,UAAU,EAAE,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE;YACzE,MAAM,OAAO,GAAG,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAC3C,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;YACpE,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC5B,OAAO,aAAa,CAAC;aACtB;SACF;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CAAA"}

package/dist/gas/calculator.d.ts

@@ -0,0 +1,134 @@
+import { BigNumber } from 'ethers';
+import { CoreEnvironment, CoreEnvironmentChain, HyperlaneCore } from '../core/HyperlaneCore';
+import { MultiProvider } from '../providers/MultiProvider';
+import { ChainName, Remotes } from '../types';
+import { TokenPriceGetter } from './token-prices';
+export interface InterchainGasCalculatorConfig {
+    /**
+     * A multiplier applied to the estimated origin token payment amount.
+     * This should be high enough to account for movements in token exchange
+     * rates and gas prices.
+     * @defaultValue 1.25
+     */
+    paymentEstimateMultiplier?: string;
+    /**
+     * An amount of additional gas to add to the estimated gas of processing a message.
+     * Only used when estimating a payment from a message.
+     * @defaultValue 50,000
+     */
+    messageGasEstimateBuffer?: string;
+    /**
+     * Used to get the native token prices of the origin and destination chains.
+     * @defaultValue An instance of DefaultTokenPriceGetter.
+     */
+    tokenPriceGetter?: TokenPriceGetter;
+}
+export declare type ParsedMessage<Chain extends ChainName, Destination extends Chain> = {
+    origin: Exclude<Chain, Destination>;
+    sender: string;
+    destination: Destination;
+    recipient: string;
+    body: string;
+};
+/**
+ * Calculates interchain gas payments.
+ */
+export declare class InterchainGasCalculator<Chain extends ChainName> {
+    private core;
+    private multiProvider;
+    private tokenPriceGetter;
+    private paymentEstimateMultiplier;
+    private messageGasEstimateBuffer;
+    static fromEnvironment<Env extends CoreEnvironment>(env: Env, multiProvider: MultiProvider<CoreEnvironmentChain<Env>>, config?: InterchainGasCalculatorConfig): InterchainGasCalculator<CoreEnvironmentChain<Env>>;
+    constructor(multiProvider: MultiProvider<Chain>, core: HyperlaneCore<Chain>, config?: InterchainGasCalculatorConfig);
+    /**
+     * 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<Destination extends Chain>(origin: Exclude<Chain, Destination>, destination: Destination, gas: BigNumber): Promise<BigNumber>;
+    /**
+     * 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<Destination extends Chain>(origin: Exclude<Chain, Destination>, destination: Destination, handleGas: BigNumber): Promise<BigNumber>;
+    /**
+     * 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.
+     */
+    protected estimatePaymentForMessage<Destination extends Chain>(message: ParsedMessage<Chain, Destination>): Promise<BigNumber>;
+    /**
+     * 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.
+     */
+    protected convertBetweenTokens(fromChain: Chain, toChain: Chain, value: BigNumber): Promise<BigNumber>;
+    /**
+     * 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.
+     */
+    protected getGasPrice(chain: Chain): Promise<BigNumber>;
+    /**
+     * 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.
+     */
+    protected tokenDecimals(chain: Chain): number;
+    /**
+     * 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.
+     */
+    protected estimateGasForHandle<LocalChain extends Chain>(message: ParsedMessage<Chain, LocalChain>): Promise<BigNumber>;
+    /**
+     * @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.
+     */
+    protected estimateGasForProcess<Destination extends Chain>(origin: Remotes<Chain, Destination>, destination: Destination): Promise<BigNumber>;
+    /**
+     * @returns The intrinsic gas of a basic transaction. Note this does not consider calldata
+     * costs or potentially different intrinsic gas costs for different chains.
+     */
+    protected intrinsicGas(): BigNumber;
+}
+//# sourceMappingURL=calculator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"calculator.d.ts","sourceRoot":"","sources":["../../src/gas/calculator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAuB,MAAM,QAAQ,CAAC;AAKxD,OAAO,EACL,eAAe,EACf,oBAAoB,EACpB,aAAa,EACd,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAG9C,OAAO,EAA6B,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAiC7E,MAAM,WAAW,6BAA6B;IAC5C;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED,oBAAY,aAAa,CACvB,KAAK,SAAS,SAAS,EACvB,WAAW,SAAS,KAAK,IACvB;IACF,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,WAAW,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,qBAAa,uBAAuB,CAAC,KAAK,SAAS,SAAS;IAC1D,OAAO,CAAC,IAAI,CAAuB;IACnC,OAAO,CAAC,aAAa,CAAuB;IAE5C,OAAO,CAAC,gBAAgB,CAAmB;IAE3C,OAAO,CAAC,yBAAyB,CAAqB;IACtD,OAAO,CAAC,wBAAwB,CAAmB;IAEnD,MAAM,CAAC,eAAe,CAAC,GAAG,SAAS,eAAe,EAChD,GAAG,EAAE,GAAG,EACR,aAAa,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,EACvD,MAAM,CAAC,EAAE,6BAA6B,GACrC,uBAAuB,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;gBAMnD,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,EACnC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,EAC1B,MAAM,CAAC,EAAE,6BAA6B;IAoBxC;;;;;;;;;;OAUG;IACG,qBAAqB,CAAC,WAAW,SAAS,KAAK,EACnD,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,EACnC,WAAW,EAAE,WAAW,EACxB,GAAG,EAAE,SAAS,GACb,OAAO,CAAC,SAAS,CAAC;IAgBrB;;;;;;;;;;;;;;OAcG;IACG,2BAA2B,CAAC,WAAW,SAAS,KAAK,EACzD,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,EACnC,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,SAAS,GACnB,OAAO,CAAC,SAAS,CAAC;IAOrB;;;;;;;;;;OAUG;cACa,yBAAyB,CAAC,WAAW,SAAS,KAAK,EACjE,OAAO,EAAE,aAAa,CAAC,KAAK,EAAE,WAAW,CAAC,GACzC,OAAO,CAAC,SAAS,CAAC;IASrB;;;;;;;;;OASG;cACa,oBAAoB,CAClC,SAAS,EAAE,KAAK,EAChB,OAAO,EAAE,KAAK,EACd,KAAK,EAAE,SAAS,GACf,OAAO,CAAC,SAAS,CAAC;IAiBrB;;;;OAIG;cACa,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC;IAQ7D;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM;IAI7C;;;;;;;;;;;;;OAaG;cACa,oBAAoB,CAAC,UAAU,SAAS,KAAK,EAC3D,OAAO,EAAE,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,GACxC,OAAO,CAAC,SAAS,CAAC;IAkCrB;;;;OAIG;cACa,qBAAqB,CAAC,WAAW,SAAS,KAAK,EAC7D,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,EACnC,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,SAAS,CAAC;IAMrB;;;OAGG;IACH,SAAS,CAAC,YAAY,IAAI,SAAS;CAGpC"}