@hyperlane-xyz/sdk 4.0.0 → 4.2.0-beta.2

package/dist/core/HyperlaneRelayer.js

@@ -0,0 +1,144 @@
+import { z } from 'zod';
+import { assert, objMap, objMerge, pollAsync, promiseObjAll, } from '@hyperlane-xyz/utils';
+import { EvmHookReader } from '../hook/EvmHookReader.js';
+import { HookConfigSchema } from '../hook/schemas.js';
+import { EvmIsmReader } from '../ism/EvmIsmReader.js';
+import { BaseMetadataBuilder } from '../ism/metadata/builder.js';
+import { IsmConfigSchema } from '../ism/schemas.js';
+import { HyperlaneCore } from './HyperlaneCore.js';
+const WithAddressSchema = z.object({
+    address: z.string(),
+});
+const DerivedHookConfigWithAddressSchema = HookConfigSchema.and(WithAddressSchema);
+const DerivedIsmConfigWithAddressSchema = IsmConfigSchema.and(WithAddressSchema);
+export const RelayerCacheSchema = z.object({
+    hook: z.record(z.record(DerivedHookConfigWithAddressSchema)),
+    ism: z.record(z.record(DerivedIsmConfigWithAddressSchema)),
+});
+export class HyperlaneRelayer {
+    multiProvider;
+    metadataBuilder;
+    core;
+    retryTimeout;
+    cache;
+    stopRelayingHandler;
+    logger;
+    constructor({ core, caching = true, retryTimeout = 5 * 1000, }) {
+        this.core = core;
+        this.retryTimeout = retryTimeout;
+        this.logger = core.logger.child({ module: 'Relayer' });
+        this.metadataBuilder = new BaseMetadataBuilder(core);
+        this.multiProvider = core.multiProvider;
+        if (caching) {
+            this.cache = {
+                hook: {},
+                ism: {},
+            };
+        }
+    }
+    async getHookConfig(chain, hook) {
+        let config;
+        if (this.cache?.hook[chain]?.[hook]) {
+            config = this.cache.hook[chain][hook];
+        }
+        else {
+            const evmHookReader = new EvmHookReader(this.multiProvider, chain);
+            config = await evmHookReader.deriveHookConfig(hook);
+        }
+        if (!config) {
+            throw new Error(`Hook config not found for ${hook}`);
+        }
+        if (this.cache) {
+            this.cache.hook[chain] ??= {};
+            this.cache.hook[chain][hook] = config;
+        }
+        return config;
+    }
+    async getIsmConfig(chain, ism) {
+        let config;
+        if (this.cache?.ism[chain]?.[ism]) {
+            config = this.cache.ism[chain][ism];
+        }
+        else {
+            const evmIsmReader = new EvmIsmReader(this.multiProvider, chain);
+            config = await evmIsmReader.deriveIsmConfig(ism);
+        }
+        if (!config) {
+            throw new Error(`ISM config not found for ${ism}`);
+        }
+        if (this.cache) {
+            this.cache.ism[chain] ??= {};
+            this.cache.ism[chain][ism] = config;
+        }
+        return config;
+    }
+    async getSenderHookConfig(message) {
+        const originChain = this.core.getOrigin(message);
+        const hook = await this.core.getSenderHookAddress(message);
+        return this.getHookConfig(originChain, hook);
+    }
+    async getRecipientIsmConfig(message) {
+        const destinationChain = this.core.getDestination(message);
+        const ism = await this.core.getRecipientIsmAddress(message);
+        return this.getIsmConfig(destinationChain, ism);
+    }
+    async relayMessage(dispatchTx, messageIndex = 0, message = HyperlaneCore.getDispatchedMessages(dispatchTx)[messageIndex]) {
+        this.logger.info(`Preparing to relay message ${message.id}`);
+        const isDelivered = await this.core.isDelivered(message);
+        if (isDelivered) {
+            this.logger.debug(`Message ${message.id} already delivered`);
+            return this.core.getProcessedReceipt(message);
+        }
+        this.logger.debug({ message }, `Simulating recipient message handling`);
+        await this.core.estimateHandle(message);
+        // parallelizable because configs are on different chains
+        const [ism, hook] = await Promise.all([
+            this.getRecipientIsmConfig(message),
+            this.getSenderHookConfig(message),
+        ]);
+        this.logger.debug({ ism, hook }, `Retrieved ISM and hook configs`);
+        const blockTime = this.multiProvider.getChainMetadata(message.parsed.destination).blocks?.estimateBlockTime;
+        const waitTime = blockTime ? blockTime * 2 : this.retryTimeout;
+        const metadata = await pollAsync(() => this.metadataBuilder.build({ message, ism, hook, dispatchTx }), waitTime, 12);
+        this.logger.info({ message, metadata }, `Relaying message ${message.id}`);
+        return this.core.deliver(message, metadata);
+    }
+    hydrate(cache) {
+        assert(this.cache, 'Caching not enabled');
+        this.cache = objMerge(this.cache, cache);
+    }
+    // fill cache with default ISM and hook configs for quicker relaying (optional)
+    async hydrateDefaults() {
+        assert(this.cache, 'Caching not enabled');
+        const defaults = await this.core.getDefaults();
+        await promiseObjAll(objMap(defaults, async (chain, { ism, hook }) => {
+            this.logger.debug(`Hydrating ${chain} cache with default ISM and hook configs`);
+            await this.getHookConfig(chain, hook);
+            await this.getIsmConfig(chain, ism);
+        }));
+    }
+    start(chains = this.multiProvider.getKnownChainNames()) {
+        assert(!this.stopRelayingHandler, 'Relayer already started');
+        const { removeHandler } = this.core.onDispatch(async (message, event) => {
+            const destination = message.parsed.destination;
+            const chain = this.multiProvider.tryGetChainName(destination);
+            if (!chain) {
+                this.logger.warn(`Unknown destination ${destination}`);
+                return;
+            }
+            if (!chains.includes(chain)) {
+                this.logger.info(`Skipping message to chain ${chain}`);
+                return;
+            }
+            const dispatchReceipt = await event.getTransactionReceipt();
+            await this.relayMessage(dispatchReceipt, undefined, message);
+        }, chains);
+        this.stopRelayingHandler = removeHandler;
+    }
+    stop(chains = this.multiProvider.getKnownChainNames()) {
+        assert(this.stopRelayingHandler, 'Relayer not started');
+        this.stopRelayingHandler(chains);
+        this.stopRelayingHandler = undefined;
+    }
+}
+//# sourceMappingURL=HyperlaneRelayer.js.map

package/dist/core/HyperlaneRelayer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HyperlaneRelayer.js","sourceRoot":"","sources":["../../src/core/HyperlaneRelayer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAEL,MAAM,EACN,MAAM,EACN,QAAQ,EACR,SAAS,EACT,aAAa,GACd,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAqB,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAoB,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIpD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGnD,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAEH,MAAM,kCAAkC,GACtC,gBAAgB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;AAC1C,MAAM,iCAAiC,GACrC,eAAe,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;AAEzC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAAC;IAC5D,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,iCAAiC,CAAC,CAAC;CAC3D,CAAC,CAAC;AAIH,MAAM,OAAO,gBAAgB;IACjB,aAAa,CAAgB;IAC7B,eAAe,CAAsB;IAC5B,IAAI,CAAgB;IACpB,YAAY,CAAS;IAEjC,KAAK,CAA2B;IAE7B,mBAAmB,CAA+C;IAE5D,MAAM,CAAS;IAE/B,YAAY,EACV,IAAI,EACJ,OAAO,GAAG,IAAI,EACd,YAAY,GAAG,CAAC,GAAG,IAAI,GAKxB;QACC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC,eAAe,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QACxC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,KAAK,GAAG;gBACX,IAAI,EAAE,EAAE;gBACR,GAAG,EAAE,EAAE;aACR,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,KAAgB,EAChB,IAAa;QAEb,IAAI,MAAqC,CAAC;QAC1C,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAkC,CAAC;QACzE,CAAC;aAAM,CAAC;YACN,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;YACnE,MAAM,GAAG,MAAM,aAAa,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAC9B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QACxC,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,KAAgB,EAChB,GAAY;QAEZ,IAAI,MAAoC,CAAC;QACzC,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAiC,CAAC;QACtE,CAAC;aAAM,CAAC;YACN,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;YACjE,MAAM,GAAG,MAAM,YAAY,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QACnD,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,4BAA4B,GAAG,EAAE,CAAC,CAAC;QACrD,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;QACtC,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,mBAAmB,CACvB,OAA0B;QAE1B,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACjD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,qBAAqB,CACzB,OAA0B;QAE1B,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC3D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,UAAwC,EACxC,YAAY,GAAG,CAAC,EAChB,OAAO,GAAG,aAAa,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC;QAEvE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,8BAA8B,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAE7D,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACzD,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,OAAO,CAAC,EAAE,oBAAoB,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,uCAAuC,CAAC,CAAC;QACxE,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAExC,yDAAyD;QACzD,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC;YACnC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC;SAClC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,gCAAgC,CAAC,CAAC;QAEnE,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,gBAAgB,CACnD,OAAO,CAAC,MAAM,CAAC,WAAW,CAC3B,CAAC,MAAM,EAAE,iBAAiB,CAAC;QAC5B,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;QAE/D,MAAM,QAAQ,GAAG,MAAM,SAAS,CAC9B,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EACpE,QAAQ,EACR,EAAE,CACH,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,oBAAoB,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,CAAC,KAAmB;QACzB,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,eAAe;QACnB,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;QAE1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QAC/C,MAAM,aAAa,CACjB,MAAM,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE;YAC9C,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,aAAa,KAAK,0CAA0C,CAC7D,CAAC;YACF,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACtC,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE;QACpD,MAAM,CAAC,CAAC,IAAI,CAAC,mBAAmB,EAAE,yBAAyB,CAAC,CAAC;QAE7D,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YACtE,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC;YAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;YAC9D,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,WAAW,EAAE,CAAC,CAAC;gBACvD,OAAO;YACT,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,KAAK,EAAE,CAAC,CAAC;gBACvD,OAAO;YACT,CAAC;YAED,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,qBAAqB,EAAE,CAAC;YAC5D,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAC/D,CAAC,EAAE,MAAM,CAAC,CAAC;QAEX,IAAI,CAAC,mBAAmB,GAAG,aAAa,CAAC;IAC3C,CAAC;IAED,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE;QACnD,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAAC;QACxD,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;IACvC,CAAC;CACF"}