@hyperlane-xyz/sdk 0.0.0-beta-20251201221151

package/README.md

@@ -0,0 +1,31 @@
+# Hyperlane SDK
+
+The Hyperlane SDK helps developers create and manage interchain applications.
+
+For more details on Hyperlane concepts, [see the documentation](https://docs.hyperlane.xyz)
+
+## Install
+
+```bash
+# Install with NPM
+npm install @hyperlane-xyz/sdk
+
+# Or with Yarn
+yarn add @hyperlane-xyz/sdk
+```
+
+Note, this package uses [ESM Modules](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c#pure-esm-package)
+
+## Contents
+
+The SDK includes various classes for building, deploying, and testing multi-chain applications. Different abstractions serve different use cases. A few common utilities include:
+
+- `MultiProvider` / `MultiProtocolProvider`: A utility for managing chain metadata, and RPC providers.
+- `HyperlaneApp` / `MultiProtocolApp`: A base to extend for a multi-chain app.
+- `HyperlaneCore` / `MultiProtocolCore`: A class for common interactions with Hyperlane core deployments.
+- `HyperlaneDeployer`: The base class for executing multi-chain contract deployments.
+- `Token` & `WarpCore`: Utilities for interacting with Warp Route deployments.
+
+## License
+
+Apache 2.0

package/dist/app/HyperlaneApp.d.ts

@@ -0,0 +1,13 @@
+import { HyperlaneAddresses, HyperlaneContracts, HyperlaneContractsMap, HyperlaneFactories } from '../contracts/types.js';
+import { MultiProvider } from '../providers/MultiProvider.js';
+import { ChainName } from '../types.js';
+import { MultiGeneric } from '../utils/MultiGeneric.js';
+export declare class HyperlaneApp<Factories extends HyperlaneFactories> extends MultiGeneric<HyperlaneContracts<Factories>> {
+    readonly multiProvider: MultiProvider;
+    readonly logger: import("pino").default.Logger<never>;
+    readonly contractsMap: HyperlaneContractsMap<Factories>;
+    constructor(contractsMap: HyperlaneContractsMap<Factories>, multiProvider: MultiProvider, logger?: import("pino").default.Logger<never>);
+    getContracts(chain: ChainName): HyperlaneContracts<Factories>;
+    getAddresses(chain: ChainName): HyperlaneAddresses<Factories>;
+}
+//# sourceMappingURL=HyperlaneApp.d.ts.map

package/dist/app/HyperlaneApp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HyperlaneApp.d.ts","sourceRoot":"","sources":["../../src/app/HyperlaneApp.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD,qBAAa,YAAY,CACvB,SAAS,SAAS,kBAAkB,CACpC,SAAQ,YAAY,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;aAKjC,aAAa,EAAE,aAAa;aAC5B,MAAM;IALxB,SAAgB,YAAY,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAC;gBAG7D,YAAY,EAAE,qBAAqB,CAAC,SAAS,CAAC,EAC9B,aAAa,EAAE,aAAa,EAC5B,MAAM,uCAAsC;IAS9D,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC;IAI7D,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC;CAG9D"}

package/dist/app/HyperlaneApp.js

@@ -0,0 +1,22 @@
+import { objMap, rootLogger } from '@hyperlane-xyz/utils';
+import { connectContracts, serializeContracts, } from '../contracts/contracts.js';
+import { MultiGeneric } from '../utils/MultiGeneric.js';
+export class HyperlaneApp extends MultiGeneric {
+    multiProvider;
+    logger;
+    contractsMap;
+    constructor(contractsMap, multiProvider, logger = rootLogger.child({ module: 'App' })) {
+        const connectedContractsMap = objMap(contractsMap, (chain, contracts) => connectContracts(contracts, multiProvider.getSignerOrProvider(chain)));
+        super(connectedContractsMap);
+        this.multiProvider = multiProvider;
+        this.logger = logger;
+        this.contractsMap = connectedContractsMap;
+    }
+    getContracts(chain) {
+        return this.get(chain);
+    }
+    getAddresses(chain) {
+        return serializeContracts(this.get(chain));
+    }
+}
+//# sourceMappingURL=HyperlaneApp.js.map

package/dist/app/HyperlaneApp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HyperlaneApp.js","sourceRoot":"","sources":["../../src/app/HyperlaneApp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EACL,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,2BAA2B,CAAC;AASnC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD,MAAM,OAAO,YAEX,SAAQ,YAA2C;IAKjC;IACA;IALF,YAAY,CAAmC;IAE/D,YACE,YAA8C,EAC9B,aAA4B,EAC5B,SAAS,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QAE5D,MAAM,qBAAqB,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CACtE,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CACtE,CAAC;QACF,KAAK,CAAC,qBAAqB,CAAC,CAAC;QANb,kBAAa,GAAb,aAAa,CAAe;QAC5B,WAAM,GAAN,MAAM,CAAsC;QAM5D,IAAI,CAAC,YAAY,GAAG,qBAAqB,CAAC;IAC5C,CAAC;IAED,YAAY,CAAC,KAAgB;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,YAAY,CAAC,KAAgB;QAC3B,OAAO,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;CACF"}

package/dist/app/MultiProtocolApp.d.ts

@@ -0,0 +1,86 @@
+/// <reference types="node" resolution-mode="require"/>
+import { PublicKey } from '@solana/web3.js';
+import { Address, ProtocolType } from '@hyperlane-xyz/utils';
+import { ChainMetadata } from '../metadata/chainMetadataTypes.js';
+import { MultiProtocolProvider } from '../providers/MultiProtocolProvider.js';
+import { CosmJsNativeProvider, CosmJsProvider, CosmJsWasmProvider, EthersV5Provider, RadixProvider, SolanaWeb3Provider, StarknetJsProvider, TypedProvider } from '../providers/ProviderType.js';
+import { ChainMap, ChainName } from '../types.js';
+import { MultiGeneric } from '../utils/MultiGeneric.js';
+/**
+ * A minimal interface for an adapter that can be used with MultiProtocolApp
+ * The purpose of adapters is to implement protocol-specific functionality
+ * E.g. EvmRouterAdapter implements EVM-specific router functionality
+ *   whereas SealevelRouterAdapter implements the same logic for Solana
+ */
+export declare abstract class BaseAppAdapter {
+    readonly chainName: ChainName;
+    readonly multiProvider: MultiProtocolProvider<any>;
+    readonly addresses: Record<string, Address>;
+    readonly logger: import("pino").default.Logger<never>;
+    abstract readonly protocol: ProtocolType;
+    constructor(chainName: ChainName, multiProvider: MultiProtocolProvider<any>, addresses: Record<string, Address>, logger?: import("pino").default.Logger<never>);
+}
+export type AdapterClassType<API> = new (chainName: ChainName, multiProvider: MultiProtocolProvider<any>, addresses: any, ...args: any) => API;
+export declare class BaseEvmAdapter extends BaseAppAdapter {
+    readonly protocol: ProtocolType;
+    getProvider(): EthersV5Provider['provider'];
+}
+export declare class BaseCosmWasmAdapter extends BaseAppAdapter {
+    readonly protocol: ProtocolType;
+    getProvider(): CosmJsWasmProvider['provider'];
+}
+export declare class BaseCosmosAdapter extends BaseAppAdapter {
+    readonly protocol: ProtocolType;
+    getProvider(): CosmJsProvider['provider'];
+}
+export declare class BaseCosmNativeAdapter extends BaseAppAdapter {
+    readonly protocol: ProtocolType;
+    getProvider(): CosmJsNativeProvider['provider'];
+}
+export declare class BaseSealevelAdapter extends BaseAppAdapter {
+    readonly protocol: ProtocolType;
+    getProvider(): SolanaWeb3Provider['provider'];
+    static derivePda(seeds: Array<string | Buffer>, programId: string | PublicKey): PublicKey;
+    static derivePdaWithBump(seeds: Array<string | Buffer>, programId: string | PublicKey): [PublicKey, number];
+    derivePda(seeds: Array<string | Buffer>, programId: string | PublicKey): PublicKey;
+    derivePdaWithBump(seeds: Array<string | Buffer>, programId: string | PublicKey): [PublicKey, number];
+}
+export declare class BaseStarknetAdapter extends BaseAppAdapter {
+    readonly protocol: ProtocolType;
+    getProvider(): StarknetJsProvider['provider'];
+}
+export declare class BaseRadixAdapter extends BaseAppAdapter {
+    readonly protocol: ProtocolType;
+    getProvider(): RadixProvider['provider'];
+}
+/**
+ * A version of HyperlaneApp that can support different
+ * provider types across different protocol types.
+ *
+ * Intentionally minimal as it's meant to be extended.
+ * Extend this class as needed to add useful methods/properties.
+ *
+ * @typeParam ContractAddrs - A map of contract names to addresses
+ * @typeParam IAdapterApi - The type of the adapters for implementing the app's
+ *   functionality across different protocols.
+ *
+ * @param multiProvider - A MultiProtocolProvider instance that MUST include the app's
+ *   contract addresses in its chain metadata
+ * @param logger - A logger instance
+ *
+ * @override protocolToAdapter - This should return an Adapter class for a given protocol type
+ */
+export declare abstract class MultiProtocolApp<IAdapterApi extends BaseAppAdapter, ContractAddrs extends Record<string, Address> = {}> extends MultiGeneric<ChainMetadata> {
+    readonly multiProvider: MultiProtocolProvider;
+    readonly addresses: ChainMap<ContractAddrs>;
+    readonly logger: import("pino").default.Logger<never>;
+    constructor(multiProvider: MultiProtocolProvider, addresses: ChainMap<ContractAddrs>, logger?: import("pino").default.Logger<never>);
+    abstract protocolToAdapter(protocol: ProtocolType): AdapterClassType<IAdapterApi>;
+    adapter(chain: ChainName): IAdapterApi;
+    adapters(): ChainMap<IAdapterApi>;
+    adapterMap<Output>(fn: (n: ChainName, a: IAdapterApi) => Promise<Output>): Promise<ChainMap<Output>>;
+    metadata(chain: ChainName): ChainMetadata;
+    protocol(chain: ChainName): ProtocolType;
+    provider(chain: ChainName): TypedProvider;
+}
+//# sourceMappingURL=MultiProtocolApp.d.ts.map

package/dist/app/MultiProtocolApp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultiProtocolApp.d.ts","sourceRoot":"","sources":["../../src/app/MultiProtocolApp.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EACL,OAAO,EACP,YAAY,EAKb,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACd,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD;;;;;GAKG;AACH,8BAAsB,cAAc;aAGhB,SAAS,EAAE,SAAS;aACpB,aAAa,EAAE,qBAAqB,CAAC,GAAG,CAAC;aACzC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;aAClC,MAAM;IALxB,kBAAyB,QAAQ,EAAE,YAAY,CAAC;gBAE9B,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,qBAAqB,CAAC,GAAG,CAAC,EACzC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,MAAM,uCAA6C;CAEtE;AAED,MAAM,MAAM,gBAAgB,CAAC,GAAG,IAAI,KAClC,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,qBAAqB,CAAC,GAAG,CAAC,EACzC,SAAS,EAAE,GAAG,EACd,GAAG,IAAI,EAAE,GAAG,KACT,GAAG,CAAC;AAET,qBAAa,cAAe,SAAQ,cAAc;IAChD,SAAgB,QAAQ,EAAE,YAAY,CAAyB;IAExD,WAAW,IAAI,gBAAgB,CAAC,UAAU,CAAC;CAGnD;AAED,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,SAAgB,QAAQ,EAAE,YAAY,CAAuB;IAEtD,WAAW,IAAI,kBAAkB,CAAC,UAAU,CAAC;CAGrD;AAED,qBAAa,iBAAkB,SAAQ,cAAc;IACnD,SAAgB,QAAQ,EAAE,YAAY,CAAuB;IAEtD,WAAW,IAAI,cAAc,CAAC,UAAU,CAAC;CAGjD;AAED,qBAAa,qBAAsB,SAAQ,cAAc;IACvD,SAAgB,QAAQ,EAAE,YAAY,CAA6B;IAE5D,WAAW,IAAI,oBAAoB,CAAC,UAAU,CAAC;CAGvD;AAED,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,SAAgB,QAAQ,EAAE,YAAY,CAAyB;IAExD,WAAW,IAAI,kBAAkB,CAAC,UAAU,CAAC;IAIpD,MAAM,CAAC,SAAS,CACd,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,EAC7B,SAAS,EAAE,MAAM,GAAG,SAAS,GAC5B,SAAS;IAIZ,MAAM,CAAC,iBAAiB,CACtB,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,EAC7B,SAAS,EAAE,MAAM,GAAG,SAAS,GAC5B,CAAC,SAAS,EAAE,MAAM,CAAC;IAStB,SAAS,CACP,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,EAC7B,SAAS,EAAE,MAAM,GAAG,SAAS,GAC5B,SAAS;IAIZ,iBAAiB,CACf,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,EAC7B,SAAS,EAAE,MAAM,GAAG,SAAS,GAC5B,CAAC,SAAS,EAAE,MAAM,CAAC;CAGvB;AAED,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,SAAgB,QAAQ,EAAE,YAAY,CAAyB;IAExD,WAAW,IAAI,kBAAkB,CAAC,UAAU,CAAC;CAGrD;AAED,qBAAa,gBAAiB,SAAQ,cAAc;IAClD,SAAgB,QAAQ,EAAE,YAAY,CAAsB;IAErD,WAAW,IAAI,aAAa,CAAC,UAAU,CAAC;CAGhD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,8BAAsB,gBAAgB,CACpC,WAAW,SAAS,cAAc,EAClC,aAAa,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,CAClD,SAAQ,YAAY,CAAC,aAAa,CAAC;aAEjB,aAAa,EAAE,qBAAqB;aACpC,SAAS,EAAE,QAAQ,CAAC,aAAa,CAAC;aAClC,MAAM;gBAFN,aAAa,EAAE,qBAAqB,EACpC,SAAS,EAAE,QAAQ,CAAC,aAAa,CAAC,EAClC,MAAM,uCAAmD;IAsB3E,QAAQ,CAAC,iBAAiB,CACxB,QAAQ,EAAE,YAAY,GACrB,gBAAgB,CAAC,WAAW,CAAC;IAGhC,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,WAAW;IAKtC,QAAQ,IAAI,QAAQ,CAAC,WAAW,CAAC;IAIjC,UAAU,CAAC,MAAM,EACf,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,MAAM,CAAC,GACpD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAI5B,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,aAAa;IAIzC,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,YAAY;IAIxC,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,aAAa;CAG1C"}

package/dist/app/MultiProtocolApp.js

@@ -0,0 +1,132 @@
+import { PublicKey } from '@solana/web3.js';
+import { ProtocolType, objMap, promiseObjAll, rootLogger, symmetricDifference, } from '@hyperlane-xyz/utils';
+import { MultiGeneric } from '../utils/MultiGeneric.js';
+/**
+ * A minimal interface for an adapter that can be used with MultiProtocolApp
+ * The purpose of adapters is to implement protocol-specific functionality
+ * E.g. EvmRouterAdapter implements EVM-specific router functionality
+ *   whereas SealevelRouterAdapter implements the same logic for Solana
+ */
+export class BaseAppAdapter {
+    chainName;
+    multiProvider;
+    addresses;
+    logger;
+    constructor(chainName, multiProvider, addresses, logger = rootLogger.child({ module: `AppAdapter` })) {
+        this.chainName = chainName;
+        this.multiProvider = multiProvider;
+        this.addresses = addresses;
+        this.logger = logger;
+    }
+}
+export class BaseEvmAdapter extends BaseAppAdapter {
+    protocol = ProtocolType.Ethereum;
+    getProvider() {
+        return this.multiProvider.getEthersV5Provider(this.chainName);
+    }
+}
+export class BaseCosmWasmAdapter extends BaseAppAdapter {
+    protocol = ProtocolType.Cosmos;
+    getProvider() {
+        return this.multiProvider.getCosmJsWasmProvider(this.chainName);
+    }
+}
+export class BaseCosmosAdapter extends BaseAppAdapter {
+    protocol = ProtocolType.Cosmos;
+    getProvider() {
+        return this.multiProvider.getCosmJsProvider(this.chainName);
+    }
+}
+export class BaseCosmNativeAdapter extends BaseAppAdapter {
+    protocol = ProtocolType.CosmosNative;
+    getProvider() {
+        return this.multiProvider.getCosmJsNativeProvider(this.chainName);
+    }
+}
+export class BaseSealevelAdapter extends BaseAppAdapter {
+    protocol = ProtocolType.Sealevel;
+    getProvider() {
+        return this.multiProvider.getSolanaWeb3Provider(this.chainName);
+    }
+    static derivePda(seeds, programId) {
+        return this.derivePdaWithBump(seeds, programId)[0];
+    }
+    static derivePdaWithBump(seeds, programId) {
+        const [pda, bump] = PublicKey.findProgramAddressSync(seeds.map((s) => Buffer.from(s)), new PublicKey(programId));
+        return [pda, bump];
+    }
+    // Dynamic aliases for static methods above for convenience
+    derivePda(seeds, programId) {
+        return BaseSealevelAdapter.derivePda(seeds, programId);
+    }
+    derivePdaWithBump(seeds, programId) {
+        return BaseSealevelAdapter.derivePdaWithBump(seeds, programId);
+    }
+}
+export class BaseStarknetAdapter extends BaseAppAdapter {
+    protocol = ProtocolType.Starknet;
+    getProvider() {
+        return this.multiProvider.getStarknetProvider(this.chainName);
+    }
+}
+export class BaseRadixAdapter extends BaseAppAdapter {
+    protocol = ProtocolType.Radix;
+    getProvider() {
+        return this.multiProvider.getRadixProvider(this.chainName);
+    }
+}
+/**
+ * A version of HyperlaneApp that can support different
+ * provider types across different protocol types.
+ *
+ * Intentionally minimal as it's meant to be extended.
+ * Extend this class as needed to add useful methods/properties.
+ *
+ * @typeParam ContractAddrs - A map of contract names to addresses
+ * @typeParam IAdapterApi - The type of the adapters for implementing the app's
+ *   functionality across different protocols.
+ *
+ * @param multiProvider - A MultiProtocolProvider instance that MUST include the app's
+ *   contract addresses in its chain metadata
+ * @param logger - A logger instance
+ *
+ * @override protocolToAdapter - This should return an Adapter class for a given protocol type
+ */
+export class MultiProtocolApp extends MultiGeneric {
+    multiProvider;
+    addresses;
+    logger;
+    constructor(multiProvider, addresses, logger = rootLogger.child({ module: 'MultiProtocolApp' })) {
+        const multiProviderChains = multiProvider.getKnownChainNames();
+        const addressesChains = Object.keys(addresses);
+        const setDifference = symmetricDifference(new Set(multiProviderChains), new Set(addressesChains));
+        if (setDifference.size > 0) {
+            throw new Error(`MultiProtocolProvider and addresses must have the same chains. Provider chains: ${multiProviderChains.join(', ')}. Addresses chains: ${addressesChains.join(', ')}. Difference: ${Array.from(setDifference)}`);
+        }
+        super(multiProvider.metadata);
+        this.multiProvider = multiProvider;
+        this.addresses = addresses;
+        this.logger = logger;
+    }
+    // Subclasses may want to override this to provide adapters more arguments
+    adapter(chain) {
+        const Adapter = this.protocolToAdapter(this.protocol(chain));
+        return new Adapter(chain, this.multiProvider, this.addresses[chain]);
+    }
+    adapters() {
+        return this.map((chain, _) => this.adapter(chain));
+    }
+    adapterMap(fn) {
+        return promiseObjAll(objMap(this.adapters(), fn));
+    }
+    metadata(chain) {
+        return this.get(chain);
+    }
+    protocol(chain) {
+        return this.metadata(chain).protocol;
+    }
+    provider(chain) {
+        return this.multiProvider.getProvider(chain);
+    }
+}
+//# sourceMappingURL=MultiProtocolApp.js.map

package/dist/app/MultiProtocolApp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultiProtocolApp.js","sourceRoot":"","sources":["../../src/app/MultiProtocolApp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAEL,YAAY,EACZ,MAAM,EACN,aAAa,EACb,UAAU,EACV,mBAAmB,GACpB,MAAM,sBAAsB,CAAC;AAe9B,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD;;;;;GAKG;AACH,MAAM,OAAgB,cAAc;IAGhB;IACA;IACA;IACA;IAJlB,YACkB,SAAoB,EACpB,aAAyC,EACzC,SAAkC,EAClC,SAAS,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;QAHnD,cAAS,GAAT,SAAS,CAAW;QACpB,kBAAa,GAAb,aAAa,CAA4B;QACzC,cAAS,GAAT,SAAS,CAAyB;QAClC,WAAM,GAAN,MAAM,CAA6C;IAClE,CAAC;CACL;AASD,MAAM,OAAO,cAAe,SAAQ,cAAc;IAChC,QAAQ,GAAiB,YAAY,CAAC,QAAQ,CAAC;IAExD,WAAW;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAChE,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IACrC,QAAQ,GAAiB,YAAY,CAAC,MAAM,CAAC;IAEtD,WAAW;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,cAAc;IACnC,QAAQ,GAAiB,YAAY,CAAC,MAAM,CAAC;IAEtD,WAAW;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9D,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IACvC,QAAQ,GAAiB,YAAY,CAAC,YAAY,CAAC;IAE5D,WAAW;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACpE,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IACrC,QAAQ,GAAiB,YAAY,CAAC,QAAQ,CAAC;IAExD,WAAW;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;IAED,MAAM,CAAC,SAAS,CACd,KAA6B,EAC7B,SAA6B;QAE7B,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,CAAC,iBAAiB,CACtB,KAA6B,EAC7B,SAA6B;QAE7B,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,SAAS,CAAC,sBAAsB,CAClD,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAChC,IAAI,SAAS,CAAC,SAAS,CAAC,CACzB,CAAC;QACF,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,2DAA2D;IAC3D,SAAS,CACP,KAA6B,EAC7B,SAA6B;QAE7B,OAAO,mBAAmB,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAED,iBAAiB,CACf,KAA6B,EAC7B,SAA6B;QAE7B,OAAO,mBAAmB,CAAC,iBAAiB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IACrC,QAAQ,GAAiB,YAAY,CAAC,QAAQ,CAAC;IAExD,WAAW;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAChE,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,cAAc;IAClC,QAAQ,GAAiB,YAAY,CAAC,KAAK,CAAC;IAErD,WAAW;QAChB,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;CACF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAgB,gBAGpB,SAAQ,YAA2B;IAEjB;IACA;IACA;IAHlB,YACkB,aAAoC,EACpC,SAAkC,EAClC,SAAS,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC;QAEzE,MAAM,mBAAmB,GAAG,aAAa,CAAC,kBAAkB,EAAE,CAAC;QAC/D,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,MAAM,aAAa,GAAG,mBAAmB,CACvC,IAAI,GAAG,CAAC,mBAAmB,CAAC,EAC5B,IAAI,GAAG,CAAC,eAAe,CAAC,CACzB,CAAC;QACF,IAAI,aAAa,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,mFAAmF,mBAAmB,CAAC,IAAI,CACzG,IAAI,CACL,uBAAuB,eAAe,CAAC,IAAI,CAC1C,IAAI,CACL,iBAAiB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAC9C,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QApBd,kBAAa,GAAb,aAAa,CAAuB;QACpC,cAAS,GAAT,SAAS,CAAyB;QAClC,WAAM,GAAN,MAAM,CAAmD;IAmB3E,CAAC;IAOD,0EAA0E;IAC1E,OAAO,CAAC,KAAgB;QACtB,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7D,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,UAAU,CACR,EAAqD;QAErD,OAAO,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,QAAQ,CAAC,KAAgB;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,QAAQ,CAAC,KAAgB;QACvB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC;IACvC,CAAC;IAED,QAAQ,CAAC,KAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;CACF"}

package/dist/app/MultiProtocolApp.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=MultiProtocolApp.test.d.ts.map

package/dist/app/MultiProtocolApp.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultiProtocolApp.test.d.ts","sourceRoot":"","sources":["../../src/app/MultiProtocolApp.test.ts"],"names":[],"mappings":""}

package/dist/app/MultiProtocolApp.test.js

@@ -0,0 +1,28 @@
+import { expect } from 'chai';
+import { ProtocolType } from '@hyperlane-xyz/utils';
+import { TestChainName } from '../consts/testChains.js';
+import { MultiProtocolProvider } from '../providers/MultiProtocolProvider.js';
+import { BaseCosmWasmAdapter, BaseEvmAdapter, BaseSealevelAdapter, MultiProtocolApp, } from './MultiProtocolApp.js';
+class TestMultiProtocolApp extends MultiProtocolApp {
+    protocolToAdapter(protocol) {
+        if (protocol === ProtocolType.Ethereum)
+            return BaseEvmAdapter;
+        if (protocol === ProtocolType.Sealevel)
+            return BaseSealevelAdapter;
+        if (protocol === ProtocolType.Cosmos)
+            return BaseCosmWasmAdapter;
+        throw new Error(`No adapter for protocol ${protocol}`);
+    }
+}
+describe('MultiProtocolApp', () => {
+    const multiProvider = MultiProtocolProvider.createTestMultiProtocolProvider();
+    it('creates an app class and gleans types from generic', async () => {
+        const addresses = {
+            test1: {},
+        };
+        const app = new TestMultiProtocolApp(multiProvider.intersect(Object.keys(addresses)).result, addresses);
+        expect(app).to.be.instanceOf(MultiProtocolApp);
+        expect(app.adapter(TestChainName.test1).protocol).to.eql(ProtocolType.Ethereum);
+    });
+});
+//# sourceMappingURL=MultiProtocolApp.test.js.map

package/dist/app/MultiProtocolApp.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultiProtocolApp.test.js","sourceRoot":"","sources":["../../src/app/MultiProtocolApp.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAE9E,OAAO,EAEL,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,oBAAqB,SAAQ,gBAAgC;IACxD,iBAAiB,CAAC,QAAsB;QAC/C,IAAI,QAAQ,KAAK,YAAY,CAAC,QAAQ;YAAE,OAAO,cAAc,CAAC;QAC9D,IAAI,QAAQ,KAAK,YAAY,CAAC,QAAQ;YAAE,OAAO,mBAAmB,CAAC;QACnE,IAAI,QAAQ,KAAK,YAAY,CAAC,MAAM;YAAE,OAAO,mBAAmB,CAAC;QACjE,MAAM,IAAI,KAAK,CAAC,2BAA2B,QAAQ,EAAE,CAAC,CAAC;IACzD,CAAC;CACF;AAED,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,MAAM,aAAa,GAAG,qBAAqB,CAAC,+BAA+B,EAAE,CAAC;IAC9E,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,SAAS,GAAG;YAChB,KAAK,EAAE,EAAE;SACV,CAAC;QACF,MAAM,GAAG,GAAG,IAAI,oBAAoB,CAClC,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,EACtD,SAAS,CACV,CAAC;QACF,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC/C,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,CACtD,YAAY,CAAC,QAAQ,CACtB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/aws/s3.d.ts

@@ -0,0 +1,22 @@
+export declare const S3_BUCKET_REGEX: RegExp;
+export interface S3Receipt<T = unknown> {
+    data: T;
+    modified: Date;
+}
+export interface S3Config {
+    bucket: string;
+    region: string;
+    folder?: string;
+    caching?: boolean;
+}
+export declare class S3Wrapper {
+    readonly config: S3Config;
+    private readonly client;
+    private cache;
+    static fromBucketUrl(bucketUrl: string): S3Wrapper;
+    constructor(config: S3Config);
+    formatKey(key: string): string;
+    getS3Obj<T>(key: string): Promise<S3Receipt<T> | undefined>;
+    url(key: string): string;
+}
+//# sourceMappingURL=s3.d.ts.map

package/dist/aws/s3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.d.ts","sourceRoot":"","sources":["../../src/aws/s3.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,eAAe,QAC0B,CAAC;AAEvD,MAAM,WAAW,SAAS,CAAC,CAAC,GAAG,OAAO;IACpC,IAAI,EAAE,CAAC,CAAC;IACR,QAAQ,EAAE,IAAI,CAAC;CAChB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,qBAAa,SAAS;IAeR,QAAQ,CAAC,MAAM,EAAE,QAAQ;IAdrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAW;IAElC,OAAO,CAAC,KAAK,CAA6C;IAE1D,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;gBAU7B,MAAM,EAAE,QAAQ;IAerC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIxB,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IA6BjE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;CAIzB"}

package/dist/aws/s3.js

@@ -0,0 +1,69 @@
+import { GetObjectCommand, S3Client } from '@aws-sdk/client-s3';
+import { streamToString } from '@hyperlane-xyz/utils';
+export const S3_BUCKET_REGEX = /^(?:https?:\/\/)?(.*)\.s3\.(.*)\.amazonaws.com\/?$/;
+export class S3Wrapper {
+    config;
+    client;
+    cache;
+    static fromBucketUrl(bucketUrl) {
+        const match = bucketUrl.match(S3_BUCKET_REGEX);
+        if (!match)
+            throw new Error('Could not parse bucket url');
+        return new S3Wrapper({
+            bucket: match[1],
+            region: match[2],
+            caching: true,
+        });
+    }
+    constructor(config) {
+        this.config = config;
+        this.client = new S3Client({
+            ...config,
+            // explicitly set empty credentials to allow usage without env vars
+            credentials: {
+                accessKeyId: '',
+                secretAccessKey: '',
+            },
+            signer: { sign: async (req) => req },
+        });
+        if (config.caching) {
+            this.cache = {};
+        }
+    }
+    formatKey(key) {
+        return this.config.folder ? `${this.config.folder}/${key}` : key;
+    }
+    async getS3Obj(key) {
+        const Key = this.formatKey(key);
+        if (this.cache?.[Key]) {
+            return this.cache[Key];
+        }
+        const command = new GetObjectCommand({
+            Bucket: this.config.bucket,
+            Key,
+        });
+        try {
+            const response = await this.client.send(command);
+            const body = await streamToString(response.Body);
+            const result = {
+                data: JSON.parse(body),
+                modified: response.LastModified,
+            };
+            if (this.cache) {
+                this.cache[Key] = result;
+            }
+            return result;
+        }
+        catch (e) {
+            if (e.message.includes('The specified key does not exist.')) {
+                return;
+            }
+            throw e;
+        }
+    }
+    url(key) {
+        const Key = this.formatKey(key);
+        return `https://${this.config.bucket}.s3.${this.config.region}.amazonaws.com/${Key}`;
+    }
+}
+//# sourceMappingURL=s3.js.map

package/dist/aws/s3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.js","sourceRoot":"","sources":["../../src/aws/s3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAKhE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,MAAM,CAAC,MAAM,eAAe,GAC1B,oDAAoD,CAAC;AAcvD,MAAM,OAAO,SAAS;IAeC;IAdJ,MAAM,CAAW;IAE1B,KAAK,CAA6C;IAE1D,MAAM,CAAC,aAAa,CAAC,SAAiB;QACpC,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC/C,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC1D,OAAO,IAAI,SAAS,CAAC;YACnB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAChB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAChB,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;IACL,CAAC;IAED,YAAqB,MAAgB;QAAhB,WAAM,GAAN,MAAM,CAAU;QACnC,IAAI,CAAC,MAAM,GAAG,IAAI,QAAQ,CAAC;YACzB,GAAG,MAAM;YACT,mEAAmE;YACnE,WAAW,EAAE;gBACX,WAAW,EAAE,EAAE;gBACf,eAAe,EAAE,EAAE;aACpB;YACD,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE;SACrC,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;IAED,SAAS,CAAC,GAAW;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,QAAQ,CAAI,GAAW;QAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,KAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;YACnC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YAC1B,GAAG;SACJ,CAAC,CAAC;QACH,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjD,MAAM,IAAI,GAAW,MAAM,cAAc,CAAC,QAAQ,CAAC,IAAgB,CAAC,CAAC;YACrE,MAAM,MAAM,GAAG;gBACb,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;gBACtB,QAAQ,EAAE,QAAQ,CAAC,YAAa;aACjC,CAAC;YACF,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;YAC3B,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,mCAAmC,CAAC,EAAE,CAAC;gBAC5D,OAAO;YACT,CAAC;YACD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED,GAAG,CAAC,GAAW;QACb,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,WAAW,IAAI,CAAC,MAAM,CAAC,MAAM,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,CAAC;IACvF,CAAC;CACF"}

package/dist/aws/validator.d.ts

@@ -0,0 +1,21 @@
+import { Announcement, BaseValidator, S3Announcement, S3CheckpointWithId, ValidatorConfig, ValidatorMetadata } from '@hyperlane-xyz/utils';
+import { S3Config, S3Wrapper } from './s3.js';
+export declare const S3_LOCATION_PREFIX = "s3://";
+/**
+ * Extension of BaseValidator that includes AWS S3 utilities.
+ */
+export declare class S3Validator extends BaseValidator {
+    validatorConfig: ValidatorConfig;
+    s3Config: S3Config;
+    s3Bucket: S3Wrapper;
+    constructor(validatorConfig: ValidatorConfig, s3Config: S3Config);
+    static fromStorageLocation(storageLocation: string): Promise<S3Validator>;
+    getAnnouncement(): Promise<Announcement>;
+    getSignedAnnouncement(): Promise<S3Announcement>;
+    getMetadata(): Promise<ValidatorMetadata>;
+    getCheckpoint(index: number): Promise<S3CheckpointWithId | void>;
+    getLatestCheckpointIndex(): Promise<number>;
+    storageLocation(): string;
+    getLatestCheckpointUrl(): string;
+}
+//# sourceMappingURL=validator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/aws/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EAElB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAO9C,eAAO,MAAM,kBAAkB,UAAU,CAAC;AAE1C;;GAEG;AACH,qBAAa,WAAY,SAAQ,aAAa;IAInC,eAAe,EAAE,eAAe;IAChC,QAAQ,EAAE,QAAQ;IAJpB,QAAQ,EAAE,SAAS,CAAC;gBAGlB,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,QAAQ;WAMd,mBAAmB,CAC9B,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,WAAW,CAAC;IA8BjB,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC;IAKxC,qBAAqB,IAAI,OAAO,CAAC,cAAc,CAAC;IAShD,WAAW,IAAI,OAAO,CAAC,iBAAiB,CAAC;IASzC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAchE,wBAAwB,IAAI,OAAO,CAAC,MAAM,CAAC;IASjD,eAAe,IAAI,MAAM;IAIzB,sBAAsB,IAAI,MAAM;CAGjC"}

package/dist/aws/validator.js

@@ -0,0 +1,91 @@
+import { BaseValidator, isS3CheckpointWithId, } from '@hyperlane-xyz/utils';
+import { S3Wrapper } from './s3.js';
+const checkpointWithMessageIdKey = (checkpointIndex) => `checkpoint_${checkpointIndex}_with_id.json`;
+const LATEST_KEY = 'checkpoint_latest_index.json';
+const ANNOUNCEMENT_KEY = 'announcement.json';
+const METADATA_KEY = 'metadata_latest.json';
+export const S3_LOCATION_PREFIX = 's3://';
+/**
+ * Extension of BaseValidator that includes AWS S3 utilities.
+ */
+export class S3Validator extends BaseValidator {
+    validatorConfig;
+    s3Config;
+    s3Bucket;
+    constructor(validatorConfig, s3Config) {
+        super(validatorConfig);
+        this.validatorConfig = validatorConfig;
+        this.s3Config = s3Config;
+        this.s3Bucket = new S3Wrapper(s3Config);
+    }
+    static async fromStorageLocation(storageLocation) {
+        if (storageLocation.startsWith(S3_LOCATION_PREFIX)) {
+            const suffix = storageLocation.slice(S3_LOCATION_PREFIX.length);
+            const pieces = suffix.split('/');
+            if (pieces.length >= 2) {
+                const s3Config = {
+                    bucket: pieces[0],
+                    region: pieces[1],
+                    folder: pieces.slice(2).join('/'),
+                    caching: true,
+                };
+                const s3Bucket = new S3Wrapper(s3Config);
+                const announcement = await s3Bucket.getS3Obj(ANNOUNCEMENT_KEY);
+                if (!announcement) {
+                    throw new Error('No announcement found');
+                }
+                const validatorConfig = {
+                    address: announcement.data.value.validator,
+                    localDomain: announcement.data.value.mailbox_domain,
+                    mailbox: announcement.data.value.mailbox_address,
+                };
+                return new S3Validator(validatorConfig, s3Config);
+            }
+        }
+        throw new Error(`Unable to parse location ${storageLocation}`);
+    }
+    async getAnnouncement() {
+        const { value } = await this.getSignedAnnouncement();
+        return value;
+    }
+    async getSignedAnnouncement() {
+        const resp = await this.s3Bucket.getS3Obj(ANNOUNCEMENT_KEY);
+        if (!resp) {
+            throw new Error(`No announcement found for ${this.config.localDomain}`);
+        }
+        return resp.data;
+    }
+    async getMetadata() {
+        const resp = await this.s3Bucket.getS3Obj(METADATA_KEY);
+        if (!resp) {
+            throw new Error(`No metadata found for ${this.config.localDomain}`);
+        }
+        return resp.data;
+    }
+    async getCheckpoint(index) {
+        const key = checkpointWithMessageIdKey(index);
+        const s3Object = await this.s3Bucket.getS3Obj(key);
+        if (!s3Object) {
+            return;
+        }
+        if (isS3CheckpointWithId(s3Object.data)) {
+            return s3Object.data;
+        }
+        else {
+            throw new Error('Failed to parse checkpoint');
+        }
+    }
+    async getLatestCheckpointIndex() {
+        const latestCheckpointIndex = await this.s3Bucket.getS3Obj(LATEST_KEY);
+        if (!latestCheckpointIndex)
+            return -1;
+        return latestCheckpointIndex.data;
+    }
+    storageLocation() {
+        return `${S3_LOCATION_PREFIX}/${this.s3Bucket.config.bucket}/${this.s3Bucket.config.region}`;
+    }
+    getLatestCheckpointUrl() {
+        return this.s3Bucket.url(LATEST_KEY);
+    }
+}
+//# sourceMappingURL=validator.js.map

package/dist/aws/validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../src/aws/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,aAAa,EAKb,oBAAoB,GACrB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAY,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C,MAAM,0BAA0B,GAAG,CAAC,eAAuB,EAAE,EAAE,CAC7D,cAAc,eAAe,eAAe,CAAC;AAC/C,MAAM,UAAU,GAAG,8BAA8B,CAAC;AAClD,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAC7C,MAAM,YAAY,GAAG,sBAAsB,CAAC;AAC5C,MAAM,CAAC,MAAM,kBAAkB,GAAG,OAAO,CAAC;AAE1C;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,aAAa;IAInC;IACA;IAJF,QAAQ,CAAY;IAE3B,YACS,eAAgC,EAChC,QAAkB;QAEzB,KAAK,CAAC,eAAe,CAAC,CAAC;QAHhB,oBAAe,GAAf,eAAe,CAAiB;QAChC,aAAQ,GAAR,QAAQ,CAAU;QAGzB,IAAI,CAAC,QAAQ,GAAG,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAC9B,eAAuB;QAEvB,IAAI,eAAe,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnD,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChE,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,QAAQ,GAAG;oBACf,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;oBACjB,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;oBACjB,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;oBACjC,OAAO,EAAE,IAAI;iBACd,CAAC;gBACF,MAAM,QAAQ,GAAG,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACzC,MAAM,YAAY,GAChB,MAAM,QAAQ,CAAC,QAAQ,CAAiB,gBAAgB,CAAC,CAAC;gBAC5D,IAAI,CAAC,YAAY,EAAE,CAAC;oBAClB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;gBAC3C,CAAC;gBAED,MAAM,eAAe,GAAG;oBACtB,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS;oBAC1C,WAAW,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc;oBACnD,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe;iBACjD,CAAC;gBAEF,OAAO,IAAI,WAAW,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,4BAA4B,eAAe,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,qBAAqB;QACzB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAiB,gBAAgB,CAAC,CAAC;QAC5E,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1E,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,WAAW;QACf,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAoB,YAAY,CAAC,CAAC;QAC3E,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QACtE,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,KAAa;QAC/B,MAAM,GAAG,GAAG,0BAA0B,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAqB,GAAG,CAAC,CAAC;QACvE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO;QACT,CAAC;QAED,IAAI,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACxC,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,wBAAwB;QAC5B,MAAM,qBAAqB,GACzB,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAS,UAAU,CAAC,CAAC;QAEnD,IAAI,CAAC,qBAAqB;YAAE,OAAO,CAAC,CAAC,CAAC;QAEtC,OAAO,qBAAqB,CAAC,IAAI,CAAC;IACpC,CAAC;IAED,eAAe;QACb,OAAO,GAAG,kBAAkB,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAC/F,CAAC;IAED,sBAAsB;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC;CACF"}