@hyperlane-xyz/sdk 1.1.4 → 1.2.1

package/dist/providers/MultiProvider.d.ts

@@ -1,62 +1,229 @@
-import { Signer, ethers } from 'ethers';
-import { ChainMap, ChainName, IChainConnection, Remotes } from '../types';
-import { MultiGeneric } from '../utils/MultiGeneric';
-import { ChainConnection } from './ChainConnection';
-export declare class MultiProvider<Chain extends ChainName = ChainName> extends MultiGeneric<Chain, ChainConnection> {
-    constructor(chainConnectionConfigs: ChainMap<Chain, IChainConnection>);
+import { BigNumber, ContractReceipt, ContractTransaction, PopulatedTransaction, Signer, providers } from 'ethers';
+import { types } from '@hyperlane-xyz/utils';
+import { ChainMetadata } from '../consts/chainMetadata';
+import { ChainMap, ChainName } from '../types';
+declare type Provider = providers.Provider;
+interface MultiProviderOptions {
+    loggerName?: string;
+}
+export declare class MultiProvider {
+    readonly metadata: ChainMap<ChainMetadata>;
+    private readonly providers;
+    private signers;
+    private useSharedSigner;
+    private readonly logger;
+    /**
+     * Create a new MultiProvider with the given chainMetadata,
+     * or the SDK's default metadata if not provided
+     */
+    constructor(chainMetadata?: ChainMap<ChainMetadata>, options?: MultiProviderOptions);
+    /**
+     * Get the metadata for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    tryGetChainMetadata(chainNameOrId: ChainName | number): ChainMetadata | null;
+    /**
+     * Get the metadata for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getChainMetadata(chainNameOrId: ChainName | number): ChainMetadata;
+    /**
+     * Get the name for a given chain name, chain id, or domain id
+     */
+    tryGetChainName(chainNameOrId: ChainName | number): string | null;
+    /**
+     * Get the name for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getChainName(chainNameOrId: ChainName | number): string;
+    /**
+     * Get the names for all chains known to this MultiProvider
+     */
+    getKnownChainNames(): string[];
+    /**
+     * Get the id for a given chain name, chain id, or domain id
+     */
+    tryGetChainId(chainNameOrId: ChainName | number): number | null;
+    /**
+     * Get the id for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getChainId(chainNameOrId: ChainName | number): number;
     /**
-     * Get chainConnection for a chain
-     * @throws if chain is invalid or has not been set
+     * Get the ids for all chains known to this MultiProvider
      */
-    getChainConnection(chain: Chain): ChainConnection;
+    getKnownChainIds(): number[];
     /**
-     * Get chainConnection for a chain
-     * @returns value or null if chain value has not been set
+     * Get the domain id for a given chain name, chain id, or domain id
      */
-    tryGetChainConnection(chain: Chain): ChainConnection | null;
+    tryGetDomainId(chainNameOrId: ChainName | number): number | null;
     /**
-     * Set value for a chain
-     * @throws if chain is invalid or has not been set
+     * Get the domain id for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
      */
-    setChainConnection(chain: Chain, chainConnectionConfig: IChainConnection): ChainConnection;
+    getDomainId(chainNameOrId: ChainName | number): number;
     /**
-     * Get provider for a chain
-     * @throws if chain is invalid or has not been set
+     * Get the domain ids for a list of chain names, chain ids, or domain ids
+     * @throws if any chain's metadata has not been set
      */
-    getChainProvider(chain: Chain): ethers.providers.Provider;
+    getDomainIds(chainNamesOrIds: Array<ChainName | number>): number[];
     /**
-     * Get provider for a chain
-     * @returns value or null if chain value has not been set
+     * Get the ids for all chains known to this MultiProvider
      */
-    tryGetChainProvider(chain: Chain): ethers.providers.Provider | null;
+    getKnownDomainIds(): number[];
     /**
-     * Get signer for a chain
-     * @throws if chain is invalid or has not been set
+     * Get an Ethers provider for a given chain name, chain id, or domain id
      */
-    getChainSigner(chain: Chain): ethers.Signer;
+    tryGetProvider(chainNameOrId: ChainName | number): Provider | null;
     /**
-     * Get signer for a chain
-     * @returns value or null if chain value has not been set
+     * Get an Ethers provider for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
      */
-    tryGetChainSigner(chain: Chain): ethers.Signer | null;
+    getProvider(chainNameOrId: ChainName | number): Provider;
     /**
-     * Get the id for a given chain name
-     * Attempts to use SDK defaults first, otherwise queries network
-     * @throws if chain is invalid or has not been set
+     * Sets an Ethers provider for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
      */
-    getChainId(chain: Chain): number;
+    setProvider(chainNameOrId: ChainName | number, provider: Provider): Provider;
     /**
-     * Create a new MultiProvider which includes the provided chain connection config
+     * Sets Ethers providers for a set of chains
+     * @throws if chain's metadata has not been set
      */
-    extendWithChain<New extends Remotes<ChainName, Chain>>(chain: New, chainConnectionConfig: IChainConnection): MultiProvider<New & Chain>;
+    setProviders(providers: ChainMap<Provider>): void;
+    /**
+     * Get an Ethers signer for a given chain name, chain id, or domain id
+     * If signer is not yet connected, it will be connected
+     */
+    tryGetSigner(chainNameOrId: ChainName | number): Signer | null;
+    /**
+     * Get an Ethers signer for a given chain name, chain id, or domain id
+     * If signer is not yet connected, it will be connected
+     * @throws if chain's metadata or signer has not been set
+     */
+    getSigner(chainNameOrId: ChainName | number): Signer;
+    /**
+     * Get an Ethers signer for a given chain name, chain id, or domain id
+     * @throws if chain's metadata or signer has not been set
+     */
+    getSignerAddress(chainNameOrId: ChainName | number): Promise<types.Address>;
+    /**
+     * Sets an Ethers Signer for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set or shared signer has already been set
+     */
+    setSigner(chainNameOrId: ChainName | number, signer: Signer): Signer;
+    /**
+     * Sets Ethers Signers for a set of chains
+     * @throws if chain's metadata has not been set or shared signer has already been set
+     */
+    setSigners(signers: ChainMap<Signer>): void;
+    /**
+     * Gets the Signer if it's been set, otherwise the provider
+     */
+    tryGetSignerOrProvider(chainNameOrId: ChainName | number): Signer | Provider | null;
+    /**
+     * Gets the Signer if it's been set, otherwise the provider
+     * @throws if chain metadata has not been set
+     */
+    getSignerOrProvider(chainNameOrId: ChainName | number): Signer | Provider;
+    /**
+     * Sets Ethers Signers to be used for all chains
+     * Any subsequent calls to getSigner will return given signer
+     * Setting sharedSigner to null clears all signers
+     */
+    setSharedSigner(sharedSigner: Signer | null): Signer | null;
     /**
      * Create a new MultiProvider from the intersection
      * of current's chains and the provided chain list
      */
-    intersect<IntersectionChain extends Chain>(chains: ChainName[], throwIfNotSubset?: boolean): {
-        intersection: IntersectionChain[];
-        multiProvider: MultiProvider<IntersectionChain>;
+    intersect(chains: ChainName[], throwIfNotSubset?: boolean): {
+        intersection: ChainName[];
+        multiProvider: MultiProvider;
     };
-    rotateSigner(newSigner: Signer): void;
+    /**
+     * Get chain names excluding given chain name
+     */
+    getRemoteChains(name: ChainName): ChainName[];
+    /**
+     * Get an RPC URL for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getRpcUrl(chainNameOrId: ChainName | number): string;
+    /**
+     * Get a block explorer URL for a given chain name, chain id, or domain id
+     */
+    tryGetExplorerUrl(chainNameOrId: ChainName | number): string | null;
+    /**
+     * Get a block explorer URL for a given chain name, chain id, or domain id
+     * @throws if chain's metadata or block explorer data has no been set
+     */
+    getExplorerUrl(chainNameOrId: ChainName | number): string;
+    /**
+     * Get a block explorer's API URL for a given chain name, chain id, or domain id
+     */
+    tryGetExplorerApiUrl(chainNameOrId: ChainName | number): string | null;
+    /**
+     * Get a block explorer API URL for a given chain name, chain id, or domain id
+     * @throws if chain's metadata or block explorer data has no been set
+     */
+    getExplorerApiUrl(chainNameOrId: ChainName | number): string;
+    /**
+     * Get a block explorer URL for given chain's tx
+     */
+    tryGetExplorerTxUrl(chainNameOrId: ChainName | number, response: {
+        hash: string;
+    }): string | null;
+    /**
+     * Get a block explorer URL for given chain's tx
+     * @throws if chain's metadata or block explorer data has no been set
+     */
+    getExplorerTxUrl(chainNameOrId: ChainName | number, response: {
+        hash: string;
+    }): string;
+    /**
+     * Get a block explorer URL for given chain's address
+     */
+    tryGetExplorerAddressUrl(chainNameOrId: ChainName | number, _address?: string): Promise<string | null>;
+    /**
+     * Get a block explorer URL for given chain's address
+     * @throws if chain's metadata, signer, or block explorer data has no been set
+     */
+    getExplorerAddressUrl(chainNameOrId: ChainName | number, address?: string): Promise<string>;
+    /**
+     * Get the transaction overrides for a given chain name, chain id, or domain id
+     * @throws if chain's metadata has not been set
+     */
+    getTransactionOverrides(chainNameOrId: ChainName | number): Partial<providers.TransactionRequest>;
+    /**
+     * Wait for given tx to be confirmed
+     * @throws if chain's metadata or signer has not been set or tx fails
+     */
+    handleTx(chainNameOrId: ChainName | number, tx: ContractTransaction | Promise<ContractTransaction>): Promise<ContractReceipt>;
+    /**
+     * Populate a transaction's fields using signer address and overrides
+     * @throws if chain's metadata has not been set or tx fails
+     */
+    prepareTx(chainNameOrId: ChainName | number, tx: PopulatedTransaction, from?: string): Promise<providers.TransactionRequest>;
+    /**
+     * Estimate gas for given tx
+     * @throws if chain's metadata has not been set or tx fails
+     */
+    estimateGas(chainNameOrId: ChainName | number, tx: PopulatedTransaction, from?: string): Promise<BigNumber>;
+    /**
+     * Send a transaction and wait for confirmation
+     * @throws if chain's metadata or signer has not been set or tx fails
+     */
+    sendTransaction(chainNameOrId: ChainName | number, tx: PopulatedTransaction): Promise<ContractReceipt>;
+    /**
+     * Run given function on all known chains
+     */
+    mapKnownChains<Output>(fn: (n: ChainName) => Output): ChainMap<Output>;
+    /**
+     * Creates a MultiProvider using the given signer for all test networks
+     */
+    static createTestMultiProvider(params?: {
+        signer?: Signer;
+        provider?: Provider;
+    }): MultiProvider;
 }
+export {};
 //# sourceMappingURL=MultiProvider.d.ts.map

package/dist/providers/MultiProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MultiProvider.d.ts","sourceRoot":"","sources":["../../src/providers/MultiProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAExC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAGrD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,qBAAa,aAAa,CACxB,KAAK,SAAS,SAAS,GAAG,SAAS,CACnC,SAAQ,YAAY,CAAC,KAAK,EAAE,eAAe,CAAC;gBAChC,sBAAsB,EAAE,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAC;IASrE;;;OAGG;IACH,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAIjD;;;OAGG;IACH,qBAAqB,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe,GAAG,IAAI;IAI3D;;;OAGG;IACH,kBAAkB,CAChB,KAAK,EAAE,KAAK,EACZ,qBAAqB,EAAE,gBAAgB,GACtC,eAAe;IAKlB;;;OAGG;IACH,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ;IAQzD;;;OAGG;IACH,mBAAmB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,GAAG,IAAI;IAInE;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM;IAQ3C;;;OAGG;IACH,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,IAAI;IAIrD;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM;IAIhC;;OAEG;IACH,eAAe,CAAC,GAAG,SAAS,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,EACnD,KAAK,EAAE,GAAG,EACV,qBAAqB,EAAE,gBAAgB,GACtC,aAAa,CAAC,GAAG,GAAG,KAAK,CAAC;IAQ7B;;;OAGG;IACH,SAAS,CAAC,iBAAiB,SAAS,KAAK,EACvC,MAAM,EAAE,SAAS,EAAE,EACnB,gBAAgB,UAAQ,GACvB;QACD,YAAY,EAAE,iBAAiB,EAAE,CAAC;QAClC,aAAa,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;KACjD;IAgCD,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;CAatC"}
+{"version":3,"file":"MultiProvider.d.ts","sourceRoot":"","sources":["../../src/providers/MultiProvider.ts"],"names":[],"mappings":"AACA,OAAO,EACL,SAAS,EACT,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,MAAM,EACN,SAAS,EACV,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAE7C,OAAO,EACL,aAAa,EAGd,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAG/C,aAAK,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;AAEnC,UAAU,oBAAoB;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qBAAa,aAAa;IACxB,SAAgB,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAM;IACvD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IACpD,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAW;IAElC;;;OAGG;gBAED,aAAa,GAAE,QAAQ,CAAC,aAAa,CAAwB,EAC7D,OAAO,GAAE,oBAAyB;IAgCpC;;;OAGG;IACH,mBAAmB,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,aAAa,GAAG,IAAI;IAY5E;;;OAGG;IACH,gBAAgB,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,aAAa;IAOlE;;OAEG;IACH,eAAe,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAIjE;;;OAGG;IACH,YAAY,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAIvD;;OAEG;IACH,kBAAkB,IAAI,MAAM,EAAE;IAI9B;;OAEG;IACH,aAAa,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAI/D;;;OAGG;IACH,UAAU,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAIrD;;OAEG;IACH,gBAAgB,IAAI,MAAM,EAAE;IAI5B;;OAEG;IACH,cAAc,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAKhE;;;OAGG;IACH,WAAW,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAKtD;;;OAGG;IACH,YAAY,CAAC,eAAe,EAAE,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,MAAM,EAAE;IAIlE;;OAEG;IACH,iBAAiB,IAAI,MAAM,EAAE;IAI7B;;OAEG;IACH,cAAc,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,IAAI;IAwBlE;;;OAGG;IACH,WAAW,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ;IAOxD;;;OAGG;IACH,WAAW,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ;IAM5E;;;OAGG;IACH,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI;IAOjD;;;OAGG;IACH,YAAY,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAa9D;;;;OAIG;IACH,SAAS,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAMpD;;;OAGG;IACG,gBAAgB,CACpB,aAAa,EAAE,SAAS,GAAG,MAAM,GAChC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;IAMzB;;;OAGG;IACH,SAAS,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAYpE;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,IAAI;IAU3C;;OAEG;IACH,sBAAsB,CACpB,aAAa,EAAE,SAAS,GAAG,MAAM,GAChC,MAAM,GAAG,QAAQ,GAAG,IAAI;IAM3B;;;OAGG;IACH,mBAAmB,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ;IAIzE;;;;OAIG;IACH,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI;IAa3D;;;OAGG;IACH,SAAS,CACP,MAAM,EAAE,SAAS,EAAE,EACnB,gBAAgB,UAAQ,GACvB;QACD,YAAY,EAAE,SAAS,EAAE,CAAC;QAC1B,aAAa,EAAE,aAAa,CAAC;KAC9B;IA8BD;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE;IAI7C;;;OAGG;IACH,SAAS,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAOpD;;OAEG;IACH,iBAAiB,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAMnE;;;OAGG;IACH,cAAc,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAMzD;;OAEG;IACH,oBAAoB,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAUtE;;;OAGG;IACH,iBAAiB,CAAC,aAAa,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM;IAM5D;;OAEG;IACH,mBAAmB,CACjB,aAAa,EAAE,SAAS,GAAG,MAAM,EACjC,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GACzB,MAAM,GAAG,IAAI;IAKhB;;;OAGG;IACH,gBAAgB,CACd,aAAa,EAAE,SAAS,GAAG,MAAM,EACjC,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GACzB,MAAM;IAIT;;OAEG;IACG,wBAAwB,CAC5B,aAAa,EAAE,SAAS,GAAG,MAAM,EACjC,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAQzB;;;OAGG;IACG,qBAAqB,CACzB,aAAa,EAAE,SAAS,GAAG,MAAM,EACjC,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,CAAC;IAOlB;;;OAGG;IACH,uBAAuB,CACrB,aAAa,EAAE,SAAS,GAAG,MAAM,GAChC,OAAO,CAAC,SAAS,CAAC,kBAAkB,CAAC;IAIxC;;;OAGG;IACG,QAAQ,CACZ,aAAa,EAAE,SAAS,GAAG,MAAM,EACjC,EAAE,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC,GACrD,OAAO,CAAC,eAAe,CAAC;IAa3B;;;OAGG;IACG,SAAS,CACb,aAAa,EAAE,SAAS,GAAG,MAAM,EACjC,EAAE,EAAE,oBAAoB,EACxB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,CAAC,kBAAkB,CAAC;IAUxC;;;OAGG;IACG,WAAW,CACf,aAAa,EAAE,SAAS,GAAG,MAAM,EACjC,EAAE,EAAE,oBAAoB,EACxB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,CAAC;IAMrB;;;OAGG;IACG,eAAe,CACnB,aAAa,EAAE,SAAS,GAAG,MAAM,EACjC,EAAE,EAAE,oBAAoB,GACvB,OAAO,CAAC,eAAe,CAAC;IAQ3B;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,KAAK,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;IAQtE;;OAEG;IACH,MAAM,CAAC,uBAAuB,CAC5B,MAAM,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;KAAO,GACpD,aAAa;CAejB"}