@hyperlane-xyz/utils 1.0.0-beta0 → 1.0.0-beta1

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * as types from './src/types';
+export * as utils from './src/utils';
+export { Validator, BaseValidator } from './src/validator';
+export * as logging from './src/logging';
+export { error, warn, log, debug, trace } from './src/logging';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,aAAa,CAAC;AACrC,OAAO,KAAK,KAAK,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,39 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.trace = exports.debug = exports.log = exports.warn = exports.error = exports.logging = exports.BaseValidator = exports.Validator = exports.utils = exports.types = void 0;
+exports.types = __importStar(require("./src/types"));
+exports.utils = __importStar(require("./src/utils"));
+var validator_1 = require("./src/validator");
+Object.defineProperty(exports, "Validator", { enumerable: true, get: function () { return validator_1.Validator; } });
+Object.defineProperty(exports, "BaseValidator", { enumerable: true, get: function () { return validator_1.BaseValidator; } });
+exports.logging = __importStar(require("./src/logging"));
+var logging_1 = require("./src/logging");
+Object.defineProperty(exports, "error", { enumerable: true, get: function () { return logging_1.error; } });
+Object.defineProperty(exports, "warn", { enumerable: true, get: function () { return logging_1.warn; } });
+Object.defineProperty(exports, "log", { enumerable: true, get: function () { return logging_1.log; } });
+Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return logging_1.debug; } });
+Object.defineProperty(exports, "trace", { enumerable: true, get: function () { return logging_1.trace; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAAqC;AACrC,qDAAqC;AACrC,6CAA2D;AAAlD,sGAAA,SAAS,OAAA;AAAE,0GAAA,aAAa,OAAA;AACjC,yDAAyC;AACzC,yCAA+D;AAAtD,gGAAA,KAAK,OAAA;AAAE,+FAAA,IAAI,OAAA;AAAE,8FAAA,GAAG,OAAA;AAAE,gGAAA,KAAK,OAAA;AAAE,gGAAA,KAAK,OAAA"}

package/dist/src/logging.d.ts

@@ -0,0 +1,6 @@
+export declare function trace(message: string, data?: any): void;
+export declare function debug(message: string, data?: any): void;
+export declare function log(message: string, data?: any): void;
+export declare function warn(message: string, data?: any): void;
+export declare function error(message: string, data?: any): void;
+//# sourceMappingURL=logging.d.ts.map

package/dist/src/logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.d.ts","sourceRoot":"","sources":["../../src/logging.ts"],"names":[],"mappings":"AAcA,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,QAEhD;AAED,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,QAEhD;AAED,wBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,QAE9C;AAED,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,QAE/C;AAED,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,QAEhD"}

package/dist/src/logging.js

@@ -0,0 +1,42 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.error = exports.warn = exports.log = exports.debug = exports.trace = void 0;
+const utils_1 = require("./utils");
+const ENV_LOG_LEVEL = ((_a = (0, utils_1.safelyAccessEnvVar)('LOG_LEVEL')) !== null && _a !== void 0 ? _a : 'debug').toLowerCase();
+const LOG_TRACE = ENV_LOG_LEVEL == 'trace';
+const LOG_DEBUG = LOG_TRACE || ENV_LOG_LEVEL == 'debug';
+const LOG_INFO = LOG_DEBUG || ENV_LOG_LEVEL == 'info';
+const LOG_WARN = LOG_INFO || ENV_LOG_LEVEL == 'warn';
+const LOG_ERROR = LOG_WARN || ENV_LOG_LEVEL == 'error';
+function trace(message, data) {
+    if (LOG_TRACE)
+        logWithFunction(console.trace, 'trace', message, data);
+}
+exports.trace = trace;
+function debug(message, data) {
+    if (LOG_DEBUG)
+        logWithFunction(console.debug, 'debug', message, data);
+}
+exports.debug = debug;
+function log(message, data) {
+    if (LOG_INFO)
+        logWithFunction(console.log, 'info', message, data);
+}
+exports.log = log;
+function warn(message, data) {
+    if (LOG_WARN)
+        logWithFunction(console.warn, 'warn', message, data);
+}
+exports.warn = warn;
+function error(message, data) {
+    if (LOG_ERROR)
+        logWithFunction(console.error, 'error', message, data);
+}
+exports.error = error;
+function logWithFunction(logFn, level, message, data) {
+    const fullLog = Object.assign(Object.assign({}, data), { level,
+        message });
+    logFn(JSON.stringify(fullLog));
+}
+//# sourceMappingURL=logging.js.map

package/dist/src/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../../src/logging.ts"],"names":[],"mappings":";;;;AAAA,mCAA6C;AAK7C,MAAM,aAAa,GAAG,CACpB,MAAA,IAAA,0BAAkB,EAAC,WAAW,CAAC,mCAAI,OAAO,CAC3C,CAAC,WAAW,EAAe,CAAC;AAC7B,MAAM,SAAS,GAAG,aAAa,IAAI,OAAO,CAAC;AAC3C,MAAM,SAAS,GAAG,SAAS,IAAI,aAAa,IAAI,OAAO,CAAC;AACxD,MAAM,QAAQ,GAAG,SAAS,IAAI,aAAa,IAAI,MAAM,CAAC;AACtD,MAAM,QAAQ,GAAG,QAAQ,IAAI,aAAa,IAAI,MAAM,CAAC;AACrD,MAAM,SAAS,GAAG,QAAQ,IAAI,aAAa,IAAI,OAAO,CAAC;AAEvD,SAAgB,KAAK,CAAC,OAAe,EAAE,IAAU;IAC/C,IAAI,SAAS;QAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AACxE,CAAC;AAFD,sBAEC;AAED,SAAgB,KAAK,CAAC,OAAe,EAAE,IAAU;IAC/C,IAAI,SAAS;QAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AACxE,CAAC;AAFD,sBAEC;AAED,SAAgB,GAAG,CAAC,OAAe,EAAE,IAAU;IAC7C,IAAI,QAAQ;QAAE,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AACpE,CAAC;AAFD,kBAEC;AAED,SAAgB,IAAI,CAAC,OAAe,EAAE,IAAU;IAC9C,IAAI,QAAQ;QAAE,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AACrE,CAAC;AAFD,oBAEC;AAED,SAAgB,KAAK,CAAC,OAAe,EAAE,IAAU;IAC/C,IAAI,SAAS;QAAE,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AACxE,CAAC;AAFD,sBAEC;AAED,SAAS,eAAe,CACtB,KAAmC,EACnC,KAAgB,EAChB,OAAe,EACf,IAAU;IAEV,MAAM,OAAO,mCACR,IAAI,KACP,KAAK;QACL,OAAO,GACR,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;AACjC,CAAC"}

package/dist/src/types.d.ts

@@ -0,0 +1,50 @@
+import { ethers } from 'ethers';
+/********* BASIC TYPES *********/
+export declare type Domain = number;
+export declare type Address = string;
+export declare type AddressBytes32 = string;
+export declare type HexString = string;
+export declare type SignatureLike = {
+    r: string;
+    s?: string;
+    _vs?: string;
+    recoveryParam?: number;
+    v?: number;
+} | ethers.utils.BytesLike;
+export declare type MerkleProof = {
+    branch: ethers.utils.BytesLike[];
+    leaf: ethers.utils.BytesLike;
+    index: number;
+};
+/********* HYPERLANE CORE *********/
+export declare type Checkpoint = {
+    root: string;
+    index: number;
+    signature: SignatureLike;
+};
+export declare type CallData = {
+    to: Address;
+    data: string;
+};
+export declare enum MessageStatus {
+    NONE = 0,
+    PROCESSED = 1
+}
+export declare type ParsedMessage = {
+    version: number;
+    nonce: number;
+    origin: number;
+    sender: string;
+    destination: number;
+    recipient: string;
+    body: string;
+};
+export declare type ParsedMultisigIsmMetadata = {
+    checkpointRoot: string;
+    checkpointIndex: number;
+    originMailbox: string;
+    proof: ethers.utils.BytesLike[];
+    signatures: ethers.utils.BytesLike[];
+    validators: ethers.utils.BytesLike[];
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,iCAAiC;AACjC,oBAAY,MAAM,GAAG,MAAM,CAAC;AAC5B,oBAAY,OAAO,GAAG,MAAM,CAAC;AAC7B,oBAAY,cAAc,GAAG,MAAM,CAAC;AACpC,oBAAY,SAAS,GAAG,MAAM,CAAC;AAG/B,oBAAY,aAAa,GACrB;IACE,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ,GACD,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;AAE3B,oBAAY,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oCAAoC;AACpC,oBAAY,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF,oBAAY,QAAQ,GAAG;IACrB,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,oBAAY,aAAa;IACvB,IAAI,IAAI;IACR,SAAS,IAAA;CACV;AAED,oBAAY,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,oBAAY,yBAAyB,GAAG;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;CACtC,CAAC"}

package/dist/src/types.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageStatus = void 0;
+var MessageStatus;
+(function (MessageStatus) {
+    MessageStatus[MessageStatus["NONE"] = 0] = "NONE";
+    MessageStatus[MessageStatus["PROCESSED"] = 1] = "PROCESSED";
+})(MessageStatus = exports.MessageStatus || (exports.MessageStatus = {}));
+//# sourceMappingURL=types.js.map

package/dist/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAqCA,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,iDAAQ,CAAA;IACR,2DAAS,CAAA;AACX,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB"}

package/dist/src/utils.d.ts

@@ -0,0 +1,43 @@
+/// <reference types="node" />
+import { BigNumber, ethers } from 'ethers';
+import { Address, Checkpoint, Domain, HexString, ParsedMessage, ParsedMultisigIsmMetadata } from './types';
+export declare function assert(predicate: any, errorMessage?: string): void;
+export declare function deepEquals(v1: any, v2: any): boolean;
+export declare const ensure0x: (hexstr: string) => string;
+export declare const strip0x: (hexstr: string) => string;
+export declare function addressToBytes32(address: Address): string;
+export declare function bytes32ToAddress(bytes32: string): Address;
+export declare function formatCallData<C extends ethers.Contract, I extends Parameters<C['interface']['encodeFunctionData']>>(destinationContract: C, functionName: I[0], functionArgs: I[1]): string;
+export declare const parseMultisigIsmMetadata: (metadata: string) => ParsedMultisigIsmMetadata;
+export declare const formatMultisigIsmMetadata: (metadata: ParsedMultisigIsmMetadata) => string;
+export declare const formatMessage: (version: number | BigNumber, nonce: number | BigNumber, originDomain: Domain, senderAddr: Address, destinationDomain: Domain, recipientAddr: Address, body: HexString) => string;
+export declare function messageId(message: HexString): string;
+/**
+ * Parse a serialized Hyperlane message from raw bytes.
+ *
+ * @param message
+ * @returns
+ */
+export declare function parseMessage(message: string): ParsedMessage;
+export declare function domainHash(domain: number, mailbox: string): string;
+export declare function sleep(ms: number): Promise<void>;
+export declare function retryAsync<T>(runner: () => T, attempts?: number, baseRetryMs?: number): Promise<T>;
+export declare function pollAsync<T>(runner: () => Promise<T>, delayMs?: number, maxAttempts?: number | undefined): Promise<T>;
+export declare function median(a: number[]): number;
+export declare function sum(a: number[]): number;
+export declare function mean(a: number[]): number;
+export declare function stdDev(a: number[]): number;
+export declare function streamToString(stream: NodeJS.ReadableStream): Promise<string>;
+export declare function isCheckpoint(obj: any): obj is Checkpoint;
+/**
+ * Wait up to a given amount of time, and throw an error if the promise does not resolve in time.
+ * @param promise The promise to timeout on.
+ * @param timeoutMs How long to wait for the promise in milliseconds.
+ * @param message The error message if a timeout occurs.
+ */
+export declare function timeout<T>(promise: Promise<T>, timeoutMs?: number, message?: string): Promise<T>;
+export declare function safelyAccessEnvVar(name: string): string | undefined;
+export declare function difference<T>(a: Set<T>, b: Set<T>): Set<T>;
+export declare function symmetricDifference<T>(a: Set<T>, b: Set<T>): Set<T>;
+export declare function setEquality<T>(a: Set<T>, b: Set<T>): boolean;
+//# sourceMappingURL=utils.d.ts.map

package/dist/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAS,MAAM,QAAQ,CAAC;AAElD,OAAO,EACL,OAAO,EACP,UAAU,EACV,MAAM,EACN,SAAS,EACT,aAAa,EACb,yBAAyB,EAC1B,MAAM,SAAS,CAAC;AAEjB,wBAAgB,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,YAAY,CAAC,EAAE,MAAM,QAI3D;AAED,wBAAgB,UAAU,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,WAE1C;AAED,eAAO,MAAM,QAAQ,WAAY,MAAM,WACW,CAAC;AAEnD,eAAO,MAAM,OAAO,WAAY,MAAM,WACc,CAAC;AAErD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAIzD;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED,wBAAgB,cAAc,CAC5B,CAAC,SAAS,MAAM,CAAC,QAAQ,EACzB,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,CAAC,EAC1D,mBAAmB,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAKxE;AAED,eAAO,MAAM,wBAAwB,aACzB,MAAM,KACf,yBA4CF,CAAC;AAEF,eAAO,MAAM,yBAAyB,aAC1B,yBAAyB,KAClC,MAqBF,CAAC;AAEF,eAAO,MAAM,aAAa,YACf,MAAM,GAAG,SAAS,SACpB,MAAM,GAAG,SAAS,gBACX,MAAM,cACR,OAAO,qBACA,MAAM,iBACV,OAAO,QAChB,SAAS,KACd,MAgBF,CAAC;AAEF,wBAAgB,SAAS,CAAC,OAAO,EAAE,SAAS,GAAG,MAAM,CAEpD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa,CAkB3D;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAKlE;AAED,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C;AAKD,wBAAsB,UAAU,CAAC,CAAC,EAChC,MAAM,EAAE,MAAM,CAAC,EACf,QAAQ,SAAI,EACZ,WAAW,SAAK,cAYjB;AAED,wBAAsB,SAAS,CAAC,CAAC,EAC/B,MAAM,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACxB,OAAO,SAAM,EACb,WAAW,GAAE,MAAM,GAAG,SAAqB,cAe5C;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAM1C;AAED,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAEvC;AAED,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAExC;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAI1C;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,CAS7E;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,UAAU,CAWxD;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,SAAoB,GAC1B,OAAO,CAAC,CAAC,CAAC,CAQZ;AAID,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,sBAM9C;AAGD,wBAAgB,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,UAMjD;AAED,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,UAU1D;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,WAElD"}

package/dist/src/utils.js

@@ -0,0 +1,279 @@
+"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.setEquality = exports.symmetricDifference = exports.difference = exports.safelyAccessEnvVar = exports.timeout = exports.isCheckpoint = exports.streamToString = exports.stdDev = exports.mean = exports.sum = exports.median = exports.pollAsync = exports.retryAsync = exports.sleep = exports.domainHash = exports.parseMessage = exports.messageId = exports.formatMessage = exports.formatMultisigIsmMetadata = exports.parseMultisigIsmMetadata = exports.formatCallData = exports.bytes32ToAddress = exports.addressToBytes32 = exports.strip0x = exports.ensure0x = exports.deepEquals = exports.assert = void 0;
+const ethers_1 = require("ethers");
+function assert(predicate, errorMessage) {
+    if (!predicate) {
+        throw new Error(errorMessage !== null && errorMessage !== void 0 ? errorMessage : 'Error');
+    }
+}
+exports.assert = assert;
+function deepEquals(v1, v2) {
+    return JSON.stringify(v1) === JSON.stringify(v2);
+}
+exports.deepEquals = deepEquals;
+const ensure0x = (hexstr) => hexstr.startsWith('0x') ? hexstr : `0x${hexstr}`;
+exports.ensure0x = ensure0x;
+const strip0x = (hexstr) => hexstr.startsWith('0x') ? hexstr.slice(2) : hexstr;
+exports.strip0x = strip0x;
+function addressToBytes32(address) {
+    return ethers_1.ethers.utils
+        .hexZeroPad(ethers_1.ethers.utils.hexStripZeros(address), 32)
+        .toLowerCase();
+}
+exports.addressToBytes32 = addressToBytes32;
+function bytes32ToAddress(bytes32) {
+    return ethers_1.ethers.utils.getAddress(bytes32.slice(-40));
+}
+exports.bytes32ToAddress = bytes32ToAddress;
+function formatCallData(destinationContract, functionName, functionArgs) {
+    return destinationContract.interface.encodeFunctionData(functionName, functionArgs);
+}
+exports.formatCallData = formatCallData;
+const parseMultisigIsmMetadata = (metadata) => {
+    const MERKLE_ROOT_OFFSET = 0;
+    const MERKLE_INDEX_OFFSET = 32;
+    const ORIGIN_MAILBOX_OFFSET = 36;
+    const MERKLE_PROOF_OFFSET = 68;
+    const THRESHOLD_OFFSET = 1092;
+    const SIGNATURES_OFFSET = 1093;
+    const SIGNATURE_LENGTH = 65;
+    const buf = Buffer.from(ethers_1.utils.arrayify(metadata));
+    const checkpointRoot = ethers_1.utils.hexlify(buf.slice(MERKLE_ROOT_OFFSET, MERKLE_INDEX_OFFSET));
+    const checkpointIndex = ethers_1.BigNumber.from(ethers_1.utils.hexlify(buf.slice(MERKLE_INDEX_OFFSET, ORIGIN_MAILBOX_OFFSET))).toNumber();
+    const originMailbox = ethers_1.utils.hexlify(buf.slice(ORIGIN_MAILBOX_OFFSET, MERKLE_PROOF_OFFSET));
+    const parseBytesArray = (start, count, size) => {
+        return [...Array(count).keys()].map((i) => ethers_1.utils.hexlify(buf.slice(start + size * i, start + size * (i + 1))));
+    };
+    const proof = parseBytesArray(MERKLE_PROOF_OFFSET, 32, 32);
+    const threshold = ethers_1.BigNumber.from(ethers_1.utils.hexlify(buf.slice(THRESHOLD_OFFSET, SIGNATURES_OFFSET))).toNumber();
+    const signatures = parseBytesArray(SIGNATURES_OFFSET, threshold, SIGNATURE_LENGTH);
+    const VALIDATORS_OFFSET = SIGNATURES_OFFSET + threshold * SIGNATURE_LENGTH;
+    const addressesCount = buf.slice(VALIDATORS_OFFSET).length / 32;
+    const validators = parseBytesArray(VALIDATORS_OFFSET, addressesCount, 32);
+    return {
+        checkpointRoot,
+        checkpointIndex,
+        originMailbox,
+        proof,
+        signatures,
+        validators,
+    };
+};
+exports.parseMultisigIsmMetadata = parseMultisigIsmMetadata;
+const formatMultisigIsmMetadata = (metadata) => {
+    return ethers_1.ethers.utils.solidityPack([
+        'bytes32',
+        'uint32',
+        'bytes32',
+        'bytes32[32]',
+        'uint8',
+        'bytes',
+        'address[]',
+    ], [
+        metadata.checkpointRoot,
+        metadata.checkpointIndex,
+        addressToBytes32(metadata.originMailbox),
+        metadata.proof,
+        metadata.signatures.length,
+        ethers_1.ethers.utils.hexConcat(metadata.signatures),
+        metadata.validators,
+    ]);
+};
+exports.formatMultisigIsmMetadata = formatMultisigIsmMetadata;
+const formatMessage = (version, nonce, originDomain, senderAddr, destinationDomain, recipientAddr, body) => {
+    senderAddr = addressToBytes32(senderAddr);
+    recipientAddr = addressToBytes32(recipientAddr);
+    return ethers_1.ethers.utils.solidityPack(['uint8', 'uint32', 'uint32', 'bytes32', 'uint32', 'bytes32', 'bytes'], [
+        version,
+        nonce,
+        originDomain,
+        senderAddr,
+        destinationDomain,
+        recipientAddr,
+        body,
+    ]);
+};
+exports.formatMessage = formatMessage;
+function messageId(message) {
+    return ethers_1.ethers.utils.solidityKeccak256(['bytes'], [message]);
+}
+exports.messageId = messageId;
+/**
+ * Parse a serialized Hyperlane message from raw bytes.
+ *
+ * @param message
+ * @returns
+ */
+function parseMessage(message) {
+    const VERSION_OFFSET = 0;
+    const NONCE_OFFSET = 1;
+    const ORIGIN_OFFSET = 5;
+    const SENDER_OFFSET = 9;
+    const DESTINATION_OFFSET = 41;
+    const RECIPIENT_OFFSET = 45;
+    const BODY_OFFSET = 77;
+    const buf = Buffer.from(ethers_1.utils.arrayify(message));
+    const version = buf.readUint8(VERSION_OFFSET);
+    const nonce = buf.readUInt32BE(NONCE_OFFSET);
+    const origin = buf.readUInt32BE(ORIGIN_OFFSET);
+    const sender = ethers_1.utils.hexlify(buf.slice(SENDER_OFFSET, DESTINATION_OFFSET));
+    const destination = buf.readUInt32BE(DESTINATION_OFFSET);
+    const recipient = ethers_1.utils.hexlify(buf.slice(RECIPIENT_OFFSET, BODY_OFFSET));
+    const body = ethers_1.utils.hexlify(buf.slice(BODY_OFFSET));
+    return { version, nonce, origin, sender, destination, recipient, body };
+}
+exports.parseMessage = parseMessage;
+function domainHash(domain, mailbox) {
+    return ethers_1.ethers.utils.solidityKeccak256(['uint32', 'bytes32', 'string'], [domain, addressToBytes32(mailbox), 'HYPERLANE']);
+}
+exports.domainHash = domainHash;
+function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+exports.sleep = sleep;
+// Retries an async function if it raises an exception,
+// with exponential backoff.
+// If all the tries fail it raises the last thrown exception
+function retryAsync(runner, attempts = 5, baseRetryMs = 50) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let saveError;
+        for (let i = 0; i < attempts; i++) {
+            try {
+                return runner();
+            }
+            catch (error) {
+                saveError = error;
+                yield sleep(baseRetryMs * Math.pow(2, i));
+            }
+        }
+        throw saveError;
+    });
+}
+exports.retryAsync = retryAsync;
+function pollAsync(runner, delayMs = 500, maxAttempts = undefined) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let attempts = 0;
+        let saveError;
+        while (!maxAttempts || attempts < maxAttempts) {
+            try {
+                const ret = yield runner();
+                return ret;
+            }
+            catch (error) {
+                saveError = error;
+                attempts += 1;
+                yield sleep(delayMs);
+            }
+        }
+        throw saveError;
+    });
+}
+exports.pollAsync = pollAsync;
+function median(a) {
+    const sorted = a.slice().sort();
+    const mid = Math.floor(sorted.length / 2);
+    const median = sorted.length % 2 == 0 ? (sorted[mid] + sorted[mid + 1]) / 2 : sorted[mid];
+    return median;
+}
+exports.median = median;
+function sum(a) {
+    return a.reduce((acc, i) => acc + i);
+}
+exports.sum = sum;
+function mean(a) {
+    return sum(a) / a.length;
+}
+exports.mean = mean;
+function stdDev(a) {
+    const xbar = mean(a);
+    const squaredDifferences = a.map((x) => Math.pow(x - xbar, 2));
+    return Math.sqrt(mean(squaredDifferences));
+}
+exports.stdDev = stdDev;
+function streamToString(stream) {
+    return new Promise((resolve, reject) => {
+        const chunks = [];
+        stream
+            .setEncoding('utf8')
+            .on('data', (chunk) => chunks.push(chunk))
+            .on('error', (err) => reject(err))
+            .on('end', () => resolve(String.prototype.concat(...chunks)));
+    });
+}
+exports.streamToString = streamToString;
+function isCheckpoint(obj) {
+    const isValidSignature = typeof obj.signature === 'string'
+        ? ethers_1.ethers.utils.isHexString(obj.signature)
+        : ethers_1.ethers.utils.isHexString(obj.signature.r) &&
+            ethers_1.ethers.utils.isHexString(obj.signature.s) &&
+            Number.isSafeInteger(obj.signature.v);
+    const isValidRoot = ethers_1.ethers.utils.isHexString(obj.root);
+    const isValidIndex = Number.isSafeInteger(obj.index);
+    return isValidIndex && isValidRoot && isValidSignature;
+}
+exports.isCheckpoint = isCheckpoint;
+/**
+ * Wait up to a given amount of time, and throw an error if the promise does not resolve in time.
+ * @param promise The promise to timeout on.
+ * @param timeoutMs How long to wait for the promise in milliseconds.
+ * @param message The error message if a timeout occurs.
+ */
+function timeout(promise, timeoutMs, message = 'Timeout reached') {
+    if (!timeoutMs || timeoutMs <= 0)
+        return promise;
+    return new Promise((resolve, reject) => {
+        setTimeout(() => {
+            reject(new Error(message));
+        }, timeoutMs);
+        promise.then(resolve).catch(reject);
+    });
+}
+exports.timeout = timeout;
+// Should be used instead of referencing process directly in case we don't
+// run in node.js
+function safelyAccessEnvVar(name) {
+    try {
+        return process.env[name];
+    }
+    catch (error) {
+        return undefined;
+    }
+}
+exports.safelyAccessEnvVar = safelyAccessEnvVar;
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set#implementing_basic_set_operations
+function difference(a, b) {
+    const _difference = new Set(a);
+    for (const elem of b) {
+        _difference.delete(elem);
+    }
+    return _difference;
+}
+exports.difference = difference;
+function symmetricDifference(a, b) {
+    const _difference = new Set(a);
+    for (const elem of b) {
+        if (_difference.has(elem)) {
+            _difference.delete(elem);
+        }
+        else {
+            _difference.add(elem);
+        }
+    }
+    return _difference;
+}
+exports.symmetricDifference = symmetricDifference;
+function setEquality(a, b) {
+    return symmetricDifference(a, b).size === 0;
+}
+exports.setEquality = setEquality;
+//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAkD;AAWlD,SAAgB,MAAM,CAAC,SAAc,EAAE,YAAqB;IAC1D,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,OAAO,CAAC,CAAC;KAC1C;AACH,CAAC;AAJD,wBAIC;AAED,SAAgB,UAAU,CAAC,EAAO,EAAE,EAAO;IACzC,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AACnD,CAAC;AAFD,gCAEC;AAEM,MAAM,QAAQ,GAAG,CAAC,MAAc,EAAE,EAAE,CACzC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;AADtC,QAAA,QAAQ,YAC8B;AAE5C,MAAM,OAAO,GAAG,CAAC,MAAc,EAAE,EAAE,CACxC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AADxC,QAAA,OAAO,WACiC;AAErD,SAAgB,gBAAgB,CAAC,OAAgB;IAC/C,OAAO,eAAM,CAAC,KAAK;SAChB,UAAU,CAAC,eAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;SACnD,WAAW,EAAE,CAAC;AACnB,CAAC;AAJD,4CAIC;AAED,SAAgB,gBAAgB,CAAC,OAAe;IAC9C,OAAO,eAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACrD,CAAC;AAFD,4CAEC;AAED,SAAgB,cAAc,CAG5B,mBAAsB,EAAE,YAAkB,EAAE,YAAkB;IAC9D,OAAO,mBAAmB,CAAC,SAAS,CAAC,kBAAkB,CACrD,YAAY,EACZ,YAAY,CACb,CAAC;AACJ,CAAC;AARD,wCAQC;AAEM,MAAM,wBAAwB,GAAG,CACtC,QAAgB,EACW,EAAE;IAC7B,MAAM,kBAAkB,GAAG,CAAC,CAAC;IAC7B,MAAM,mBAAmB,GAAG,EAAE,CAAC;IAC/B,MAAM,qBAAqB,GAAG,EAAE,CAAC;IACjC,MAAM,mBAAmB,GAAG,EAAE,CAAC;IAC/B,MAAM,gBAAgB,GAAG,IAAI,CAAC;IAC9B,MAAM,iBAAiB,GAAG,IAAI,CAAC;IAC/B,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAE5B,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,cAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClD,MAAM,cAAc,GAAG,cAAK,CAAC,OAAO,CAClC,GAAG,CAAC,KAAK,CAAC,kBAAkB,EAAE,mBAAmB,CAAC,CACnD,CAAC;IACF,MAAM,eAAe,GAAG,kBAAS,CAAC,IAAI,CACpC,cAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAAC,CACrE,CAAC,QAAQ,EAAE,CAAC;IACb,MAAM,aAAa,GAAG,cAAK,CAAC,OAAO,CACjC,GAAG,CAAC,KAAK,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,CACtD,CAAC;IACF,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,KAAa,EAAE,IAAY,EAAE,EAAE;QACrE,OAAO,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACxC,cAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CACnE,CAAC;IACJ,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,eAAe,CAAC,mBAAmB,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3D,MAAM,SAAS,GAAG,kBAAS,CAAC,IAAI,CAC9B,cAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAC9D,CAAC,QAAQ,EAAE,CAAC;IACb,MAAM,UAAU,GAAG,eAAe,CAChC,iBAAiB,EACjB,SAAS,EACT,gBAAgB,CACjB,CAAC;IACF,MAAM,iBAAiB,GAAG,iBAAiB,GAAG,SAAS,GAAG,gBAAgB,CAAC;IAC3E,MAAM,cAAc,GAAG,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,MAAM,GAAG,EAAE,CAAC;IAChE,MAAM,UAAU,GAAG,eAAe,CAAC,iBAAiB,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC;IAC1E,OAAO;QACL,cAAc;QACd,eAAe;QACf,aAAa;QACb,KAAK;QACL,UAAU;QACV,UAAU;KACX,CAAC;AACJ,CAAC,CAAC;AA9CW,QAAA,wBAAwB,4BA8CnC;AAEK,MAAM,yBAAyB,GAAG,CACvC,QAAmC,EAC3B,EAAE;IACV,OAAO,eAAM,CAAC,KAAK,CAAC,YAAY,CAC9B;QACE,SAAS;QACT,QAAQ;QACR,SAAS;QACT,aAAa;QACb,OAAO;QACP,OAAO;QACP,WAAW;KACZ,EACD;QACE,QAAQ,CAAC,cAAc;QACvB,QAAQ,CAAC,eAAe;QACxB,gBAAgB,CAAC,QAAQ,CAAC,aAAa,CAAC;QACxC,QAAQ,CAAC,KAAK;QACd,QAAQ,CAAC,UAAU,CAAC,MAAM;QAC1B,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC;QAC3C,QAAQ,CAAC,UAAU;KACpB,CACF,CAAC;AACJ,CAAC,CAAC;AAvBW,QAAA,yBAAyB,6BAuBpC;AAEK,MAAM,aAAa,GAAG,CAC3B,OAA2B,EAC3B,KAAyB,EACzB,YAAoB,EACpB,UAAmB,EACnB,iBAAyB,EACzB,aAAsB,EACtB,IAAe,EACP,EAAE;IACV,UAAU,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAC1C,aAAa,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAEhD,OAAO,eAAM,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,EACtE;QACE,OAAO;QACP,KAAK;QACL,YAAY;QACZ,UAAU;QACV,iBAAiB;QACjB,aAAa;QACb,IAAI;KACL,CACF,CAAC;AACJ,CAAC,CAAC;AAxBW,QAAA,aAAa,iBAwBxB;AAEF,SAAgB,SAAS,CAAC,OAAkB;IAC1C,OAAO,eAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;AAC9D,CAAC;AAFD,8BAEC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,OAAe;IAC1C,MAAM,cAAc,GAAG,CAAC,CAAC;IACzB,MAAM,YAAY,GAAG,CAAC,CAAC;IACvB,MAAM,aAAa,GAAG,CAAC,CAAC;IACxB,MAAM,aAAa,GAAG,CAAC,CAAC;IACxB,MAAM,kBAAkB,GAAG,EAAE,CAAC;IAC9B,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAC5B,MAAM,WAAW,GAAG,EAAE,CAAC;IAEvB,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,cAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IACjD,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAC9C,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAC/C,MAAM,MAAM,GAAG,cAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAC3E,MAAM,WAAW,GAAG,GAAG,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;IACzD,MAAM,SAAS,GAAG,cAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC,CAAC;IAC1E,MAAM,IAAI,GAAG,cAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IACnD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;AAC1E,CAAC;AAlBD,oCAkBC;AAED,SAAgB,UAAU,CAAC,MAAc,EAAE,OAAe;IACxD,OAAO,eAAM,CAAC,KAAK,CAAC,iBAAiB,CACnC,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,EAC/B,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,CACjD,CAAC;AACJ,CAAC;AALD,gCAKC;AAED,SAAgB,KAAK,CAAC,EAAU;IAC9B,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AACjE,CAAC;AAFD,sBAEC;AAED,uDAAuD;AACvD,4BAA4B;AAC5B,4DAA4D;AAC5D,SAAsB,UAAU,CAC9B,MAAe,EACf,QAAQ,GAAG,CAAC,EACZ,WAAW,GAAG,EAAE;;QAEhB,IAAI,SAAS,CAAC;QACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;YACjC,IAAI;gBACF,OAAO,MAAM,EAAE,CAAC;aACjB;YAAC,OAAO,KAAK,EAAE;gBACd,SAAS,GAAG,KAAK,CAAC;gBAClB,MAAM,KAAK,CAAC,WAAW,GAAG,SAAA,CAAC,EAAI,CAAC,CAAA,CAAC,CAAC;aACnC;SACF;QACD,MAAM,SAAS,CAAC;IAClB,CAAC;CAAA;AAfD,gCAeC;AAED,SAAsB,SAAS,CAC7B,MAAwB,EACxB,OAAO,GAAG,GAAG,EACb,cAAkC,SAAS;;QAE3C,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,SAAS,CAAC;QACd,OAAO,CAAC,WAAW,IAAI,QAAQ,GAAG,WAAW,EAAE;YAC7C,IAAI;gBACF,MAAM,GAAG,GAAG,MAAM,MAAM,EAAE,CAAC;gBAC3B,OAAO,GAAG,CAAC;aACZ;YAAC,OAAO,KAAK,EAAE;gBACd,SAAS,GAAG,KAAK,CAAC;gBAClB,QAAQ,IAAI,CAAC,CAAC;gBACd,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC;aACtB;SACF;QACD,MAAM,SAAS,CAAC;IAClB,CAAC;CAAA;AAlBD,8BAkBC;AAED,SAAgB,MAAM,CAAC,CAAW;IAChC,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC;IAChC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC1C,MAAM,MAAM,GACV,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7E,OAAO,MAAM,CAAC;AAChB,CAAC;AAND,wBAMC;AAED,SAAgB,GAAG,CAAC,CAAW;IAC7B,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;AACvC,CAAC;AAFD,kBAEC;AAED,SAAgB,IAAI,CAAC,CAAW;IAC9B,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AAC3B,CAAC;AAFD,oBAEC;AAED,SAAgB,MAAM,CAAC,CAAW;IAChC,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACrB,MAAM,kBAAkB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/D,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;AAC7C,CAAC;AAJD,wBAIC;AAED,SAAgB,cAAc,CAAC,MAA6B;IAC1D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,MAAM;aACH,WAAW,CAAC,MAAM,CAAC;aACnB,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACzC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aACjC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC;AATD,wCASC;AAED,SAAgB,YAAY,CAAC,GAAQ;IACnC,MAAM,gBAAgB,GACpB,OAAO,GAAG,CAAC,SAAS,KAAK,QAAQ;QAC/B,CAAC,CAAC,eAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC;QACzC,CAAC,CAAC,eAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;YACzC,eAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;YACzC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE5C,MAAM,WAAW,GAAG,eAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,YAAY,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACrD,OAAO,YAAY,IAAI,WAAW,IAAI,gBAAgB,CAAC;AACzD,CAAC;AAXD,oCAWC;AAED;;;;;GAKG;AACH,SAAgB,OAAO,CACrB,OAAmB,EACnB,SAAkB,EAClB,OAAO,GAAG,iBAAiB;IAE3B,IAAI,CAAC,SAAS,IAAI,SAAS,IAAI,CAAC;QAAE,OAAO,OAAO,CAAC;IACjD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7B,CAAC,EAAE,SAAS,CAAC,CAAC;QACd,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC;AAZD,0BAYC;AAED,0EAA0E;AAC1E,iBAAiB;AACjB,SAAgB,kBAAkB,CAAC,IAAY;IAC7C,IAAI;QACF,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;KAC1B;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AAND,gDAMC;AAED,yHAAyH;AACzH,SAAgB,UAAU,CAAI,CAAS,EAAE,CAAS;IAChD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;IAC/B,KAAK,MAAM,IAAI,IAAI,CAAC,EAAE;QACpB,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;KAC1B;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAND,gCAMC;AAED,SAAgB,mBAAmB,CAAI,CAAS,EAAE,CAAS;IACzD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;IAC/B,KAAK,MAAM,IAAI,IAAI,CAAC,EAAE;QACpB,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YACzB,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAC1B;aAAM;YACL,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SACvB;KACF;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAVD,kDAUC;AAED,SAAgB,WAAW,CAAI,CAAS,EAAE,CAAS;IACjD,OAAO,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC;AAC9C,CAAC;AAFD,kCAEC"}

package/dist/src/validator.d.ts

@@ -0,0 +1,26 @@
+import { ethers } from 'ethers';
+import { Address, Checkpoint, Domain, HexString } from './types';
+/**
+ * Utilities for validators to construct and verify checkpoints.
+ */
+export declare class BaseValidator {
+    localDomain: Domain;
+    address: Address;
+    mailbox: Address;
+    constructor(address: Address, localDomain: Domain, mailbox: Address);
+    domainHash(): string;
+    message(root: HexString, index: number): string;
+    messageHash(root: HexString, index: number): Uint8Array;
+    recoverAddressFromCheckpoint(checkpoint: Checkpoint): Address;
+    matchesSigner(checkpoint: Checkpoint): boolean;
+}
+/**
+ * Extension of BaseValidator that includes ethers signing utilities.
+ */
+export declare class Validator extends BaseValidator {
+    protected signer: ethers.Signer;
+    constructor(signer: ethers.Signer, address: Address, localDomain: Domain, mailbox: Address);
+    static fromSigner(signer: ethers.Signer, localDomain: Domain, mailbox: Address): Promise<Validator>;
+    signCheckpoint(root: HexString, index: number): Promise<Checkpoint>;
+}
+//# sourceMappingURL=validator.d.ts.map

package/dist/src/validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAGjE;;GAEG;AACH,qBAAa,aAAa;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;gBAEL,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAMnE,UAAU;IAIV,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM;IAOtC,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM;IAK1C,4BAA4B,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAK7D,aAAa,CAAC,UAAU,EAAE,UAAU;CAMrC;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,aAAa;IAExC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM;gBAArB,MAAM,EAAE,MAAM,CAAC,MAAM,EAC/B,OAAO,EAAE,OAAO,EAChB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,OAAO;WAKL,UAAU,CACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EACrB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,OAAO;IAUZ,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAS1E"}

package/dist/src/validator.js

@@ -0,0 +1,70 @@
+"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.Validator = exports.BaseValidator = void 0;
+const ethers_1 = require("ethers");
+const utils_1 = require("./utils");
+/**
+ * Utilities for validators to construct and verify checkpoints.
+ */
+class BaseValidator {
+    constructor(address, localDomain, mailbox) {
+        this.localDomain = localDomain;
+        this.address = address;
+        this.mailbox = mailbox;
+    }
+    domainHash() {
+        return (0, utils_1.domainHash)(this.localDomain, this.mailbox);
+    }
+    message(root, index) {
+        return ethers_1.ethers.utils.solidityPack(['bytes32', 'bytes32', 'uint32'], [this.domainHash(), root, index]);
+    }
+    messageHash(root, index) {
+        const message = this.message(root, index);
+        return ethers_1.ethers.utils.arrayify(ethers_1.ethers.utils.keccak256(message));
+    }
+    recoverAddressFromCheckpoint(checkpoint) {
+        const msgHash = this.messageHash(checkpoint.root, checkpoint.index);
+        return ethers_1.ethers.utils.verifyMessage(msgHash, checkpoint.signature);
+    }
+    matchesSigner(checkpoint) {
+        return (this.recoverAddressFromCheckpoint(checkpoint).toLowerCase() ===
+            this.address.toLowerCase());
+    }
+}
+exports.BaseValidator = BaseValidator;
+/**
+ * Extension of BaseValidator that includes ethers signing utilities.
+ */
+class Validator extends BaseValidator {
+    constructor(signer, address, localDomain, mailbox) {
+        super(address, localDomain, mailbox);
+        this.signer = signer;
+    }
+    static fromSigner(signer, localDomain, mailbox) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Validator(signer, yield signer.getAddress(), localDomain, mailbox);
+        });
+    }
+    signCheckpoint(root, index) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const msgHash = this.messageHash(root, index);
+            const signature = yield this.signer.signMessage(msgHash);
+            return {
+                root,
+                index,
+                signature,
+            };
+        });
+    }
+}
+exports.Validator = Validator;
+//# sourceMappingURL=validator.js.map

package/dist/src/validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../src/validator.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAgC;AAGhC,mCAAqC;AAErC;;GAEG;AACH,MAAa,aAAa;IAKxB,YAAY,OAAgB,EAAE,WAAmB,EAAE,OAAgB;QACjE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,UAAU;QACR,OAAO,IAAA,kBAAU,EAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,CAAC,IAAe,EAAE,KAAa;QACpC,OAAO,eAAM,CAAC,KAAK,CAAC,YAAY,CAC9B,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,EAChC,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,CACjC,CAAC;IACJ,CAAC;IAED,WAAW,CAAC,IAAe,EAAE,KAAa;QACxC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC1C,OAAO,eAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,4BAA4B,CAAC,UAAsB;QACjD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QACpE,OAAO,eAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC;IACnE,CAAC;IAED,aAAa,CAAC,UAAsB;QAClC,OAAO,CACL,IAAI,CAAC,4BAA4B,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE;YAC3D,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAC3B,CAAC;IACJ,CAAC;CACF;AAtCD,sCAsCC;AAED;;GAEG;AACH,MAAa,SAAU,SAAQ,aAAa;IAC1C,YACY,MAAqB,EAC/B,OAAgB,EAChB,WAAmB,EACnB,OAAgB;QAEhB,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QAL3B,WAAM,GAAN,MAAM,CAAe;IAMjC,CAAC;IAED,MAAM,CAAO,UAAU,CACrB,MAAqB,EACrB,WAAmB,EACnB,OAAgB;;YAEhB,OAAO,IAAI,SAAS,CAClB,MAAM,EACN,MAAM,MAAM,CAAC,UAAU,EAAE,EACzB,WAAW,EACX,OAAO,CACR,CAAC;QACJ,CAAC;KAAA;IAEK,cAAc,CAAC,IAAe,EAAE,KAAa;;YACjD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC9C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACzD,OAAO;gBACL,IAAI;gBACJ,KAAK;gBACL,SAAS;aACV,CAAC;QACJ,CAAC;KAAA;CACF;AAhCD,8BAgCC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hyperlane-xyz/utils",
   "description": "General utilities for the Hyperlane network",
-  "version": "1.0.0-beta0",
+  "version": "1.0.0-beta1",
   "dependencies": {
     "ethers": "^5.6.8"
   },