@hyperlane-xyz/provider-sdk 3.0.1 → 3.1.0

package/dist/mailbox.d.ts

@@ -0,0 +1,90 @@
+import { Artifact, ArtifactDeployed, ConfigOnChain, IArtifactManager } from './artifact.js';
+import type { ChainLookup } from './chain.js';
+import type { DerivedCoreConfig } from './core.js';
+import type { DeployedHookAddress, DeployedHookArtifact, DerivedHookConfig, HookArtifactConfig } from './hook.js';
+import type { DeployedIsmAddress, DeployedIsmArtifact, DerivedIsmConfig, IsmArtifactConfig } from './ism.js';
+/**
+ * Mailbox configuration for the Artifact API.
+ * Defines the parameters needed to deploy or configure a mailbox.
+ */
+export interface MailboxArtifactConfig {
+    owner: string;
+    defaultIsm: Artifact<IsmArtifactConfig, DeployedIsmAddress>;
+    defaultHook: Artifact<HookArtifactConfig, DeployedHookAddress>;
+    requiredHook: Artifact<HookArtifactConfig, DeployedHookAddress>;
+}
+/**
+ * Deployment data returned after deploying a mailbox.
+ * Contains the on-chain address and optionally the domain ID.
+ */
+export interface DeployedMailboxAddress {
+    address: string;
+    domainId?: number;
+}
+/**
+ * Describes the configuration of a deployed mailbox
+ */
+export type DeployedMailboxArtifact = ArtifactDeployed<ConfigOnChain<MailboxArtifactConfig>, DeployedMailboxAddress>;
+/**
+ * Mailbox artifact configs map
+ */
+export interface MailboxArtifactConfigs {
+    mailbox: MailboxArtifactConfig;
+}
+export type MailboxType = keyof MailboxArtifactConfigs;
+/**
+ * Should be used to implement an object/closure or class that is in charge of coordinating
+ * deployment of a Mailbox config, including nested ISM and Hook deployments.
+ */
+export type IMailboxArtifactManager = IArtifactManager<MailboxType, MailboxArtifactConfigs, DeployedMailboxAddress>;
+/**
+ * Raw mailbox config - uses ArtifactOnChain for nested artifacts instead of Artifact.
+ * This is the format used by protocol implementations that work directly with on-chain state.
+ */
+export type MailboxOnChain = ConfigOnChain<MailboxArtifactConfig>;
+/**
+ * Raw mailbox artifact configs map
+ */
+export interface RawMailboxArtifactConfigs {
+    mailbox: MailboxOnChain;
+}
+/**
+ * Should be used for the specific artifact code that
+ * deploys or reads a single mailbox artifact on chain
+ */
+export type RawMailboxArtifactConfig = RawMailboxArtifactConfigs[MailboxType];
+/**
+ * Describes the configuration of deployed mailbox without nested config expansion
+ */
+export type DeployedRawMailboxArtifact = ArtifactDeployed<RawMailboxArtifactConfig, DeployedMailboxAddress>;
+/**
+ * Should be used to implement an object/closure or class that individually deploys
+ * Mailboxes on chain
+ */
+export interface IRawMailboxArtifactManager extends IArtifactManager<MailboxType, RawMailboxArtifactConfigs, DeployedMailboxAddress> {
+    /**
+     * Read a mailbox by its address.
+     * This is the entry point for reading mailbox configuration from the chain.
+     * @param address The on-chain address of the mailbox
+     * @returns The artifact configuration and deployment data
+     */
+    readMailbox(address: string): Promise<DeployedRawMailboxArtifact>;
+}
+/**
+ * Converts a DeployedMailboxArtifact (with fully expanded nested ISM/hook artifacts)
+ * to the DerivedCoreConfig format for backward compatibility.
+ *
+ * This function is used by CoreArtifactReader to provide the deriveCoreConfig() method
+ * that existing code expects. The conversion functions for ISM and Hook artifacts
+ * must be passed in to avoid circular dependencies.
+ *
+ * @param artifact The deployed mailbox artifact with expanded nested configs
+ * @param chainLookup Chain lookup for converting domain IDs to chain names
+ * @param converters Object containing ismArtifactToDerivedConfig and hookArtifactToDerivedConfig functions
+ * @returns DerivedCoreConfig in the legacy format (from core.ts)
+ */
+export declare function mailboxArtifactToDerivedCoreConfig(artifact: DeployedMailboxArtifact, chainLookup: ChainLookup, converters: {
+    ismArtifactToDerivedConfig: (artifact: DeployedIsmArtifact, chainLookup: ChainLookup) => DerivedIsmConfig;
+    hookArtifactToDerivedConfig: (artifact: DeployedHookArtifact, chainLookup: ChainLookup) => DerivedHookConfig;
+}): DerivedCoreConfig;
+//# sourceMappingURL=mailbox.d.ts.map

package/dist/mailbox.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mailbox.d.ts","sourceRoot":"","sources":["../src/mailbox.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,gBAAgB,EAEhB,aAAa,EACb,gBAAgB,EAEjB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EACV,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,UAAU,CAAC;AAKlB;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,QAAQ,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAAC;IAC5D,WAAW,EAAE,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC,CAAC;IAC/D,YAAY,EAAE,QAAQ,CAAC,kBAAkB,EAAE,mBAAmB,CAAC,CAAC;CACjE;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,CACpD,aAAa,CAAC,qBAAqB,CAAC,EACpC,sBAAsB,CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,qBAAqB,CAAC;CAChC;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,sBAAsB,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,gBAAgB,CACpD,WAAW,EACX,sBAAsB,EACtB,sBAAsB,CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,cAAc,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,yBAAyB,CAAC,WAAW,CAAC,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,gBAAgB,CACvD,wBAAwB,EACxB,sBAAsB,CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,gBAAgB,CAClE,WAAW,EACX,yBAAyB,EACzB,sBAAsB,CACvB;IACC;;;;;OAKG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;CACnE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kCAAkC,CAChD,QAAQ,EAAE,uBAAuB,EACjC,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE;IACV,0BAA0B,EAAE,CAC1B,QAAQ,EAAE,mBAAmB,EAC7B,WAAW,EAAE,WAAW,KACrB,gBAAgB,CAAC;IACtB,2BAA2B,EAAE,CAC3B,QAAQ,EAAE,oBAAoB,EAC9B,WAAW,EAAE,WAAW,KACrB,iBAAiB,CAAC;CACxB,GACA,iBAAiB,CA6BnB"}

package/dist/mailbox.js

@@ -0,0 +1,29 @@
+import { ArtifactState, isArtifactDeployed, } from './artifact.js';
+import { assert } from '@hyperlane-xyz/utils';
+/**
+ * Converts a DeployedMailboxArtifact (with fully expanded nested ISM/hook artifacts)
+ * to the DerivedCoreConfig format for backward compatibility.
+ *
+ * This function is used by CoreArtifactReader to provide the deriveCoreConfig() method
+ * that existing code expects. The conversion functions for ISM and Hook artifacts
+ * must be passed in to avoid circular dependencies.
+ *
+ * @param artifact The deployed mailbox artifact with expanded nested configs
+ * @param chainLookup Chain lookup for converting domain IDs to chain names
+ * @param converters Object containing ismArtifactToDerivedConfig and hookArtifactToDerivedConfig functions
+ * @returns DerivedCoreConfig in the legacy format (from core.ts)
+ */
+export function mailboxArtifactToDerivedCoreConfig(artifact, chainLookup, converters) {
+    const { defaultIsm, defaultHook, requiredHook, owner } = artifact.config;
+    // All nested artifacts should be in DEPLOYED state after CoreArtifactReader.read()
+    assert(isArtifactDeployed(defaultIsm), `Expected defaultIsm to be ${ArtifactState.DEPLOYED}, got ${defaultIsm.artifactState}`);
+    assert(isArtifactDeployed(defaultHook), `Expected defaultHook to be ${ArtifactState.DEPLOYED}, got ${defaultHook.artifactState}`);
+    assert(isArtifactDeployed(requiredHook), `Expected requiredHook to be ${ArtifactState.DEPLOYED}, got ${requiredHook.artifactState}`);
+    return {
+        owner,
+        defaultIsm: converters.ismArtifactToDerivedConfig(defaultIsm, chainLookup),
+        defaultHook: converters.hookArtifactToDerivedConfig(defaultHook, chainLookup),
+        requiredHook: converters.hookArtifactToDerivedConfig(requiredHook, chainLookup),
+    };
+}
+//# sourceMappingURL=mailbox.js.map

package/dist/mailbox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mailbox.js","sourceRoot":"","sources":["../src/mailbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,aAAa,EAGb,kBAAkB,GACnB,MAAM,eAAe,CAAC;AAevB,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAgG9C;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kCAAkC,CAChD,QAAiC,EACjC,WAAwB,EACxB,UASC;IAED,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC;IAEzE,mFAAmF;IACnF,MAAM,CACJ,kBAAkB,CAAC,UAAU,CAAC,EAC9B,6BAA6B,aAAa,CAAC,QAAQ,SAAS,UAAU,CAAC,aAAa,EAAE,CACvF,CAAC;IACF,MAAM,CACJ,kBAAkB,CAAC,WAAW,CAAC,EAC/B,8BAA8B,aAAa,CAAC,QAAQ,SAAS,WAAW,CAAC,aAAa,EAAE,CACzF,CAAC;IACF,MAAM,CACJ,kBAAkB,CAAC,YAAY,CAAC,EAChC,+BAA+B,aAAa,CAAC,QAAQ,SAAS,YAAY,CAAC,aAAa,EAAE,CAC3F,CAAC;IAEF,OAAO;QACL,KAAK;QACL,UAAU,EAAE,UAAU,CAAC,0BAA0B,CAAC,UAAU,EAAE,WAAW,CAAC;QAC1E,WAAW,EAAE,UAAU,CAAC,2BAA2B,CACjD,WAAW,EACX,WAAW,CACZ;QACD,YAAY,EAAE,UAAU,CAAC,2BAA2B,CAClD,YAAY,EACZ,WAAW,CACZ;KACF,CAAC;AACJ,CAAC"}

package/dist/validator-announce.d.ts

@@ -0,0 +1,67 @@
+import { ArtifactDeployed, IArtifactManager } from './artifact.js';
+/**
+ * Validator Announce configuration for the Artifact API.
+ * Defines the parameters needed to deploy or configure a validator announce contract.
+ */
+export interface ValidatorAnnounceArtifactConfig {
+    mailboxAddress: string;
+}
+/**
+ * Deployment data returned after deploying a validator announce contract.
+ * Contains the on-chain address.
+ */
+export interface DeployedValidatorAnnounceAddress {
+    address: string;
+}
+/**
+ * Describes the configuration of a deployed validator announce contract
+ */
+export type DeployedValidatorAnnounceArtifact = ArtifactDeployed<ValidatorAnnounceArtifactConfig, DeployedValidatorAnnounceAddress>;
+/**
+ * Validator announce artifact configs map
+ */
+export interface ValidatorAnnounceArtifactConfigs {
+    validatorAnnounce: ValidatorAnnounceArtifactConfig;
+}
+export type ValidatorAnnounceType = keyof ValidatorAnnounceArtifactConfigs;
+/**
+ * Should be used to implement an object/closure or class that is in charge of coordinating
+ * deployment of a ValidatorAnnounce config.
+ */
+export type IValidatorAnnounceArtifactManager = IArtifactManager<ValidatorAnnounceType, ValidatorAnnounceArtifactConfigs, DeployedValidatorAnnounceAddress>;
+/**
+ * Raw validator announce config - identical to the compound config since there are no nested artifacts.
+ * Kept for consistency with the artifact API pattern.
+ */
+export interface RawValidatorAnnounceConfig {
+    mailboxAddress: string;
+}
+/**
+ * Raw validator announce artifact configs map
+ */
+export interface RawValidatorAnnounceArtifactConfigs {
+    validatorAnnounce: RawValidatorAnnounceConfig;
+}
+/**
+ * Should be used for the specific artifact code that
+ * deploys or reads a single validator announce artifact on chain
+ */
+export type RawValidatorAnnounceArtifactConfig = RawValidatorAnnounceArtifactConfigs[ValidatorAnnounceType];
+/**
+ * Describes the configuration of deployed validator announce without nested config expansion
+ */
+export type DeployedRawValidatorAnnounceArtifact = ArtifactDeployed<RawValidatorAnnounceArtifactConfig, DeployedValidatorAnnounceAddress>;
+/**
+ * Should be used to implement an object/closure or class that individually deploys
+ * ValidatorAnnounce contracts on chain
+ */
+export interface IRawValidatorAnnounceArtifactManager extends IArtifactManager<ValidatorAnnounceType, RawValidatorAnnounceArtifactConfigs, DeployedValidatorAnnounceAddress> {
+    /**
+     * Read a validator announce contract by its address.
+     * This is the entry point for reading validator announce configuration from the chain.
+     * @param address The on-chain address of the validator announce contract
+     * @returns The artifact configuration and deployment data
+     */
+    readValidatorAnnounce(address: string): Promise<DeployedRawValidatorAnnounceArtifact>;
+}
+//# sourceMappingURL=validator-announce.d.ts.map

package/dist/validator-announce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator-announce.d.ts","sourceRoot":"","sources":["../src/validator-announce.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAInE;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,gBAAgB,CAC9D,+BAA+B,EAC/B,gCAAgC,CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,iBAAiB,EAAE,+BAA+B,CAAC;CACpD;AAED,MAAM,MAAM,qBAAqB,GAAG,MAAM,gCAAgC,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,gBAAgB,CAC9D,qBAAqB,EACrB,gCAAgC,EAChC,gCAAgC,CACjC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD,iBAAiB,EAAE,0BAA0B,CAAC;CAC/C;AAED;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAC5C,mCAAmC,CAAC,qBAAqB,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,gBAAgB,CACjE,kCAAkC,EAClC,gCAAgC,CACjC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,oCAAqC,SAAQ,gBAAgB,CAC5E,qBAAqB,EACrB,mCAAmC,EACnC,gCAAgC,CACjC;IACC;;;;;OAKG;IACH,qBAAqB,CACnB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,oCAAoC,CAAC,CAAC;CAClD"}

package/dist/validator-announce.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=validator-announce.js.map

package/dist/validator-announce.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperlane-xyz/provider-sdk",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Protocol Provider SDK for the Hyperlane Protocol",
   "license": "Apache-2.0",
   "repository": "https://github.com/hyperlane-xyz/hyperlane-monorepo",
@@ -17,6 +17,8 @@
     "./hook": "./dist/hook.js",
     "./ism": "./dist/ism.js",
     "./core": "./dist/core.js",
+    "./mailbox": "./dist/mailbox.js",
+    "./validator-announce": "./dist/validator-announce.js",
     "./warp": "./dist/warp.js",
     "./factory": "./dist/factory.js",
     "./submitter": "./dist/submitter.js",
@@ -26,7 +28,7 @@
   "dependencies": {
     "pino": "^8.19.0",
     "zod": "^3.21.2",
-    "@hyperlane-xyz/utils": "27.0.0"
+    "@hyperlane-xyz/utils": "27.1.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.11",
@@ -37,8 +39,8 @@
     "mocha": "^11.5.0",
     "tsx": "^4.19.1",
     "typescript": "5.8.3",
-    "@hyperlane-xyz/eslint-config": "^27.0.0",
-    "@hyperlane-xyz/tsconfig": "^27.0.0"
+    "@hyperlane-xyz/eslint-config": "^27.1.0",
+    "@hyperlane-xyz/tsconfig": "^27.1.0"
   },
   "scripts": {
     "build": "tsc",