@hyperlane-xyz/utils 3.9.0 → 3.10.1-beta0

package/dist/typeof.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeof.d.ts","sourceRoot":"","sources":["../src/typeof.ts"],"names":[],"mappings":"AAAA,wBAAgB,SAAS,CAAC,CAAC,EACzB,GAAG,EAAE,CAAC,GACL,GAAG,IAAI,CAAC,SAAS,IAAI,GAAG,SAAS,GAAG,CAAC,GAAG,KAAK,CAE/C;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,WAE/C"}

package/dist/typeof.js

@@ -0,0 +1,7 @@
+export function isNullish(val) {
+    return val === null || val === undefined;
+}
+export function isNumeric(value) {
+    return typeof value === 'number' || /^\d+$/.test(value);
+}
+//# sourceMappingURL=typeof.js.map

package/dist/typeof.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeof.js","sourceRoot":"","sources":["../src/typeof.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,SAAS,CACvB,GAAM;IAEN,OAAO,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAsB;IAC9C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC1D,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,88 @@
+import type { BigNumber, ethers } from 'ethers';
+export declare enum ProtocolType {
+    Ethereum = "ethereum",
+    Sealevel = "sealevel",
+    Fuel = "fuel",
+    Cosmos = "cosmos"
+}
+export type ProtocolTypeValue = `${ProtocolType}`;
+export declare const ProtocolSmallestUnit: {
+    ethereum: string;
+    sealevel: string;
+    cosmos: string;
+};
+/********* BASIC TYPES *********/
+export type Domain = number;
+export type ChainId = string | number;
+export type Address = string;
+export type AddressBytes32 = string;
+export type ChainCaip2Id = `${string}:${string}`;
+export type TokenCaip19Id = `${string}:${string}/${string}:${string}`;
+export type HexString = string;
+export type Numberish = number | string | bigint;
+export type WithAddress<T> = T & {
+    address: Address;
+};
+export type SignatureLike = {
+    r: string;
+    s?: string;
+    _vs?: string;
+    recoveryParam?: number;
+    v?: number;
+} | ethers.utils.BytesLike;
+export type MerkleProof = {
+    branch: ethers.utils.BytesLike[];
+    leaf: ethers.utils.BytesLike;
+    index: number;
+};
+/********* HYPERLANE CORE *********/
+export type Checkpoint = {
+    root: string;
+    index: number;
+    mailbox_domain: Domain;
+    merkle_tree_hook_address: Address;
+};
+/**
+ * Shape of a checkpoint in S3 as published by the agent.
+ */
+export type S3CheckpointWithId = {
+    value: {
+        checkpoint: Checkpoint;
+        message_id: HexString;
+    };
+    signature: SignatureLike;
+};
+export type S3Checkpoint = {
+    value: Checkpoint;
+    signature: SignatureLike;
+};
+export type CallData = {
+    to: Address;
+    data: string;
+    value?: BigNumber;
+};
+export declare enum MessageStatus {
+    NONE = 0,
+    PROCESSED = 1
+}
+export type ParsedMessage = {
+    version: number;
+    nonce: number;
+    origin: number;
+    sender: string;
+    destination: number;
+    recipient: string;
+    body: string;
+};
+export type ParsedLegacyMultisigIsmMetadata = {
+    checkpointRoot: string;
+    checkpointIndex: number;
+    originMailbox: string;
+    proof: ethers.utils.BytesLike[];
+    signatures: ethers.utils.BytesLike[];
+    validators: ethers.utils.BytesLike[];
+};
+export declare enum InterchainSecurityModuleType {
+    MULTISIG = 3
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhD,oBAAY,YAAY;IACtB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED,MAAM,MAAM,iBAAiB,GAAG,GAAG,YAAY,EAAE,CAAC;AAElD,eAAO,MAAM,oBAAoB;;;;CAIhC,CAAC;AAEF,iCAAiC;AACjC,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAC5B,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AACtC,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,MAAM,MAAM,YAAY,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AACjD,MAAM,MAAM,aAAa,GAAG,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;AACtE,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEjD,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG;IAC/B,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAGF,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE;QACL,UAAU,EAAE,UAAU,CAAC;QACvB,UAAU,EAAE,SAAS,CAAC;KACvB,CAAC;IACF,SAAS,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,UAAU,CAAC;IAClB,SAAS,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB,CAAC;AAEF,oBAAY,aAAa;IACvB,IAAI,IAAI;IACR,SAAS,IAAA;CACV;AAED,MAAM,MAAM,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,MAAM,MAAM,+BAA+B,GAAG;IAC5C,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;AAEF,oBAAY,4BAA4B;IACtC,QAAQ,IAAI;CACb"}

package/dist/types.js

@@ -0,0 +1,22 @@
+export var ProtocolType;
+(function (ProtocolType) {
+    ProtocolType["Ethereum"] = "ethereum";
+    ProtocolType["Sealevel"] = "sealevel";
+    ProtocolType["Fuel"] = "fuel";
+    ProtocolType["Cosmos"] = "cosmos";
+})(ProtocolType || (ProtocolType = {}));
+export const ProtocolSmallestUnit = {
+    [ProtocolType.Ethereum]: 'wei',
+    [ProtocolType.Sealevel]: 'lamports',
+    [ProtocolType.Cosmos]: 'uATOM',
+};
+export var MessageStatus;
+(function (MessageStatus) {
+    MessageStatus[MessageStatus["NONE"] = 0] = "NONE";
+    MessageStatus[MessageStatus["PROCESSED"] = 1] = "PROCESSED";
+})(MessageStatus || (MessageStatus = {}));
+export var InterchainSecurityModuleType;
+(function (InterchainSecurityModuleType) {
+    InterchainSecurityModuleType[InterchainSecurityModuleType["MULTISIG"] = 3] = "MULTISIG";
+})(InterchainSecurityModuleType || (InterchainSecurityModuleType = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,qCAAqB,CAAA;IACrB,6BAAa,CAAA;IACb,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAID,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,KAAK;IAC9B,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,UAAU;IACnC,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,OAAO;CAC/B,CAAC;AA+DF,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,iDAAQ,CAAA;IACR,2DAAS,CAAA;AACX,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAqBD,MAAM,CAAN,IAAY,4BAEX;AAFD,WAAY,4BAA4B;IACtC,uFAAY,CAAA;AACd,CAAC,EAFW,4BAA4B,KAA5B,4BAA4B,QAEvC"}

package/dist/validation.d.ts

@@ -0,0 +1,2 @@
+export declare function assert<T>(predicate: T, errorMessage?: string): asserts predicate is NonNullable<T>;
+//# sourceMappingURL=validation.d.ts.map

package/dist/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,wBAAgB,MAAM,CAAC,CAAC,EACtB,SAAS,EAAE,CAAC,EACZ,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,SAAS,IAAI,WAAW,CAAC,CAAC,CAAC,CAIrC"}

package/dist/validation.js

@@ -0,0 +1,6 @@
+export function assert(predicate, errorMessage) {
+    if (!predicate) {
+        throw new Error(errorMessage ?? 'Error');
+    }
+}
+//# sourceMappingURL=validation.js.map

package/dist/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,MAAM,CACpB,SAAY,EACZ,YAAqB;IAErB,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,OAAO,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC"}

package/dist/validator.d.ts

@@ -0,0 +1,17 @@
+import { Address, Checkpoint, Domain, HexString, SignatureLike } from './types.js';
+/**
+ * Utilities for validators to construct and verify checkpoints.
+ */
+export declare class BaseValidator {
+    readonly address: Address;
+    readonly localDomain: Domain;
+    readonly mailbox_address: Address;
+    constructor(address: Address, localDomain: Domain, mailbox_address: Address);
+    announceDomainHash(): string;
+    checkpointDomainHash(merkle_tree_address: Address): string;
+    message(checkpoint: Checkpoint, messageId: HexString): string;
+    messageHash(checkpoint: Checkpoint, messageId: HexString): Uint8Array;
+    recoverAddressFromCheckpoint(checkpoint: Checkpoint, signature: SignatureLike, messageId: HexString): Address;
+    matchesSigner(checkpoint: Checkpoint, signature: SignatureLike, messageId: HexString): boolean;
+}
+//# sourceMappingURL=validator.d.ts.map

package/dist/validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../src/validator.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,OAAO,EACP,UAAU,EACV,MAAM,EACN,SAAS,EACT,aAAa,EACd,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,qBAAa,aAAa;aAEN,OAAO,EAAE,OAAO;aAChB,WAAW,EAAE,MAAM;aACnB,eAAe,EAAE,OAAO;gBAFxB,OAAO,EAAE,OAAO,EAChB,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,OAAO;IAG1C,kBAAkB;IAIlB,oBAAoB,CAAC,mBAAmB,EAAE,OAAO;IAIjD,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS;IAWpD,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS;IAKxD,4BAA4B,CAC1B,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,aAAa,EACxB,SAAS,EAAE,SAAS,GACnB,OAAO;IAKV,aAAa,CACX,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,aAAa,EACxB,SAAS,EAAE,SAAS;CAUvB"}

package/dist/validator.js

@@ -0,0 +1,43 @@
+import { ethers } from 'ethers';
+import { domainHash } from './domains.js';
+/**
+ * Utilities for validators to construct and verify checkpoints.
+ */
+export class BaseValidator {
+    address;
+    localDomain;
+    mailbox_address;
+    constructor(address, localDomain, mailbox_address) {
+        this.address = address;
+        this.localDomain = localDomain;
+        this.mailbox_address = mailbox_address;
+    }
+    announceDomainHash() {
+        return domainHash(this.localDomain, this.mailbox_address);
+    }
+    checkpointDomainHash(merkle_tree_address) {
+        return domainHash(this.localDomain, merkle_tree_address);
+    }
+    message(checkpoint, messageId) {
+        const types = ['bytes32', 'bytes32', 'uint32', 'bytes32'];
+        const values = [
+            this.checkpointDomainHash(checkpoint.merkle_tree_hook_address),
+            checkpoint.root,
+            checkpoint.index,
+            messageId,
+        ];
+        return ethers.utils.solidityPack(types, values);
+    }
+    messageHash(checkpoint, messageId) {
+        const message = this.message(checkpoint, messageId);
+        return ethers.utils.arrayify(ethers.utils.keccak256(message));
+    }
+    recoverAddressFromCheckpoint(checkpoint, signature, messageId) {
+        const msgHash = this.messageHash(checkpoint, messageId);
+        return ethers.utils.verifyMessage(msgHash, signature);
+    }
+    matchesSigner(checkpoint, signature, messageId) {
+        return (this.recoverAddressFromCheckpoint(checkpoint, signature, messageId).toLowerCase() === this.address.toLowerCase());
+    }
+}
+//# sourceMappingURL=validator.js.map

package/dist/validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.js","sourceRoot":"","sources":["../src/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAS1C;;GAEG;AACH,MAAM,OAAO,aAAa;IAEN;IACA;IACA;IAHlB,YACkB,OAAgB,EAChB,WAAmB,EACnB,eAAwB;QAFxB,YAAO,GAAP,OAAO,CAAS;QAChB,gBAAW,GAAX,WAAW,CAAQ;QACnB,oBAAe,GAAf,eAAe,CAAS;IACvC,CAAC;IAEJ,kBAAkB;QAChB,OAAO,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IAC5D,CAAC;IAED,oBAAoB,CAAC,mBAA4B;QAC/C,OAAO,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;IAC3D,CAAC;IAED,OAAO,CAAC,UAAsB,EAAE,SAAoB;QAClD,MAAM,KAAK,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG;YACb,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,wBAAwB,CAAC;YAC9D,UAAU,CAAC,IAAI;YACf,UAAU,CAAC,KAAK;YAChB,SAAS;SACV,CAAC;QACF,OAAO,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,WAAW,CAAC,UAAsB,EAAE,SAAoB;QACtD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACpD,OAAO,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,4BAA4B,CAC1B,UAAsB,EACtB,SAAwB,EACxB,SAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACxD,OAAO,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,aAAa,CACX,UAAsB,EACtB,SAAwB,EACxB,SAAoB;QAEpB,OAAO,CACL,IAAI,CAAC,4BAA4B,CAC/B,UAAU,EACV,SAAS,EACT,SAAS,CACV,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAC/C,CAAC;IACJ,CAAC;CACF"}

package/package.json

@@ -1,30 +1,31 @@
 {
   "name": "@hyperlane-xyz/utils",
   "description": "General utilities and types for the Hyperlane network",
-  "version": "3.9.0",
+  "version": "3.10.1-beta0",
   "dependencies": {
     "@cosmjs/encoding": "^0.31.3",
     "@solana/web3.js": "^1.78.0",
     "bignumber.js": "^9.1.1",
-    "ethers": "^5.7.2"
+    "ethers": "^5.7.2",
+    "pino": "^8.19.0",
+    "yaml": "^2.3.1"
   },
   "devDependencies": {
     "@types/mocha": "^10.0.1",
     "chai": "^4.3.6",
     "mocha": "^10.2.0",
     "prettier": "^2.8.8",
-    "typescript": "5.1.6"
+    "typescript": "5.3.3"
   },
   "homepage": "https://www.hyperlane.xyz",
+  "repository": "https://github.com/hyperlane-xyz/hyperlane-monorepo",
   "keywords": [
     "Hyperlane",
     "Utilities",
     "Typescript"
   ],
   "license": "Apache-2.0",
-  "main": "dist/index.js",
   "prepublish": "yarn build",
-  "repository": "https://github.com/hyperlane-xyz/hyperlane-monorepo",
   "scripts": {
     "build": "tsc",
     "clean": "rm -rf ./dist",
@@ -33,9 +34,14 @@
     "test": "mocha --config .mocharc.json './src/**/*.test.ts'",
     "test:ci": "yarn test"
   },
-  "sideEffects": false,
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "/dist"
-  ]
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=16"
+  }
 }