@metamask/network-controller 21.0.0 → 21.1.0

package/dist/NetworkController.d.mts

@@ -0,0 +1,636 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Partialize } from "@metamask/controller-utils";
+import { InfuraNetworkType } from "@metamask/controller-utils";
+import EthQuery from "@metamask/eth-query";
+import type { SwappableProxy } from "@metamask/swappable-obj-proxy";
+import type { Hex } from "@metamask/utils";
+import type { Draft } from "immer";
+import type { Logger } from "loglevel";
+import { NetworkStatus } from "./constants.mjs";
+import type { AutoManagedNetworkClient, ProxyWithAccessibleTarget } from "./create-auto-managed-network-client.mjs";
+import { NetworkClientType } from "./types.mjs";
+import type { BlockTracker, Provider, CustomNetworkClientConfiguration, InfuraNetworkClientConfiguration } from "./types.mjs";
+export type Block = {
+    baseFeePerGas?: string;
+};
+/**
+ * Information about a network not held by any other part of state.
+ */
+export type NetworkMetadata = {
+    /**
+     * EIPs supported by the network.
+     */
+    EIPS: {
+        [eipNumber: number]: boolean;
+    };
+    /**
+     * Indicates the availability of the network
+     */
+    status: NetworkStatus;
+};
+/**
+ * The type of an RPC endpoint.
+ *
+ * @see {@link CustomRpcEndpoint}
+ * @see {@link InfuraRpcEndpoint}
+ */
+export declare enum RpcEndpointType {
+    Custom = "custom",
+    Infura = "infura"
+}
+/**
+ * An Infura RPC endpoint is a reference to a specific network that Infura
+ * supports as well as an Infura account we own that we allow users to make use
+ * of for free. We need to disambiguate these endpoints from custom RPC
+ * endpoints, because while the types for these kinds of object both have the
+ * same interface, the URL for an Infura endpoint contains the Infura project
+ * ID, and we don't want this to be present in state. We therefore hide it by
+ * representing it in the URL as `{infuraProjectId}`, which we replace this when
+ * create network clients. But we need to know somehow that we only need to do
+ * this replacement for Infura endpoints and not custom endpoints — hence the
+ * separate type.
+ */
+export type InfuraRpcEndpoint = {
+    /**
+     * The optional user-facing nickname of the endpoint.
+     */
+    name?: string;
+    /**
+     * The identifier for the network client that has been created for this RPC
+     * endpoint. This is also used to uniquely identify the RPC endpoint in a
+     * set of RPC endpoints as well: once assigned, it is used to determine
+     * whether the `name`, `type`, or `url` of the RPC endpoint has changed.
+     */
+    networkClientId: BuiltInNetworkClientId;
+    /**
+     * The type of this endpoint, always "default".
+     */
+    type: RpcEndpointType.Infura;
+    /**
+     * The URL of the endpoint. Expected to be a template with the string
+     * `{infuraProjectId}`, which will get replaced with the Infura project ID
+     * when the network client is created.
+     */
+    url: `https://${InfuraNetworkType}.infura.io/v3/{infuraProjectId}`;
+};
+/**
+ * A custom RPC endpoint is a reference to a user-defined server which fronts an
+ * EVM chain. It may refer to an Infura network, but only by coincidence.
+ */
+export type CustomRpcEndpoint = {
+    /**
+     * The optional user-facing nickname of the endpoint.
+     */
+    name?: string;
+    /**
+     * The identifier for the network client that has been created for this RPC
+     * endpoint. This is also used to uniquely identify the RPC endpoint in a
+     * set of RPC endpoints as well: once assigned, it is used to determine
+     * whether the `name`, `type`, or `url` of the RPC endpoint has changed.
+     */
+    networkClientId: CustomNetworkClientId;
+    /**
+     * The type of this endpoint, always "custom".
+     */
+    type: RpcEndpointType.Custom;
+    /**
+     * The URL of the endpoint.
+     */
+    url: string;
+};
+/**
+ * An RPC endpoint is a reference to a server which fronts an EVM chain. There
+ * are two varieties of RPC endpoints: Infura and custom.
+ *
+ * @see {@link CustomRpcEndpoint}
+ * @see {@link InfuraRpcEndpoint}
+ */
+export type RpcEndpoint = InfuraRpcEndpoint | CustomRpcEndpoint;
+/**
+ * From a user perspective, a network configuration holds information about a
+ * network that a user can select through the client. A "network" in this sense
+ * can explicitly refer to an EVM chain that the user explicitly adds or doesn't
+ * need to add (because it comes shipped with the client). The properties here
+ * therefore directly map to fields that a user sees and can edit for a network
+ * within the client.
+ *
+ * Internally, a network configuration represents a single conceptual EVM chain,
+ * which is represented tangibly via multiple RPC endpoints. A "network" is then
+ * something for which a network client object is created automatically or
+ * created on demand when it is added to the client.
+ */
+export type NetworkConfiguration = {
+    /**
+     * A set of URLs that allows the user to view activity that has occurred on
+     * the chain.
+     */
+    blockExplorerUrls: string[];
+    /**
+     * The ID of the chain. Represented in hexadecimal format with a leading "0x"
+     * instead of decimal format so that when viewed out of context it can be
+     * unambiguously interpreted.
+     */
+    chainId: Hex;
+    /**
+     * A reference to a URL that the client will use by default to allow the user
+     * to view activity that has occurred on the chain. This index must refer to
+     * an item in `blockExplorerUrls`.
+     */
+    defaultBlockExplorerUrlIndex?: number;
+    /**
+     * A reference to an RPC endpoint that all requests will use by default in order to
+     * interact with the chain. This index must refer to an item in
+     * `rpcEndpoints`.
+     */
+    defaultRpcEndpointIndex: number;
+    /**
+     * The user-facing nickname assigned to the chain.
+     */
+    name: string;
+    /**
+     * The name of the currency to use for the chain.
+     */
+    nativeCurrency: string;
+    /**
+     * The collection of possible RPC endpoints that the client can use to
+     * interact with the chain.
+     */
+    rpcEndpoints: RpcEndpoint[];
+};
+/**
+ * A custom RPC endpoint in a new network configuration, meant to be used in
+ * conjunction with `AddNetworkFields`.
+ *
+ * Custom RPC endpoints do not need a `networkClientId` property because it is
+ * assumed that they have not already been added and therefore network clients
+ * do not exist for them yet (and hence IDs need to be generated).
+ */
+export type AddNetworkCustomRpcEndpointFields = Omit<CustomRpcEndpoint, 'networkClientId'>;
+/**
+ * A new network configuration that `addNetwork` takes.
+ *
+ * Custom RPC endpoints do not need a `networkClientId` property because it is
+ * assumed that they have not already been added and are not represented by
+ * network clients yet.
+ */
+export type AddNetworkFields = Omit<NetworkConfiguration, 'rpcEndpoints'> & {
+    rpcEndpoints: (InfuraRpcEndpoint | AddNetworkCustomRpcEndpointFields)[];
+};
+/**
+ * A custom RPC endpoint in an updated representation of a network
+ * configuration, meant to be used in conjunction with `UpdateNetworkFields`.
+ *
+ * Custom RPC endpoints do not need a `networkClientId` property because it is
+ * assumed that they have not already been added and therefore network clients
+ * do not exist for them yet (and hence IDs need to be generated).
+ */
+export type UpdateNetworkCustomRpcEndpointFields = Partialize<CustomRpcEndpoint, 'networkClientId'>;
+/**
+ * An updated representation of an existing network configuration that
+ * `updateNetwork` takes.
+ *
+ * Custom RPC endpoints may or may not have a `networkClientId` property; if
+ * they do, then it is assumed that they already exist, and if not, then it is
+ * assumed that they are new and are not represented by network clients yet.
+ */
+export type UpdateNetworkFields = Omit<NetworkConfiguration, 'rpcEndpoints'> & {
+    rpcEndpoints: (InfuraRpcEndpoint | UpdateNetworkCustomRpcEndpointFields)[];
+};
+/**
+ * `Object.keys()` is intentionally generic: it returns the keys of an object,
+ * but it cannot make guarantees about the contents of that object, so the type
+ * of the keys is merely `string[]`. While this is technically accurate, it is
+ * also unnecessary if we have an object that we own and whose contents are
+ * known exactly.
+ *
+ * TODO: Move to @metamask/utils.
+ *
+ * @param object - The object.
+ * @returns The keys of an object, typed according to the type of the object
+ * itself.
+ */
+export declare function knownKeysOf<K extends PropertyKey>(object: Partial<Record<K, any>>): K[];
+/**
+ * The string that uniquely identifies an Infura network client.
+ */
+export type BuiltInNetworkClientId = InfuraNetworkType;
+/**
+ * The string that uniquely identifies a custom network client.
+ */
+export type CustomNetworkClientId = string;
+/**
+ * The string that uniquely identifies a network client.
+ */
+export type NetworkClientId = BuiltInNetworkClientId | CustomNetworkClientId;
+/**
+ * Extra information about each network, such as whether it is accessible or
+ * blocked and whether it supports EIP-1559, keyed by network client ID.
+ */
+export type NetworksMetadata = Record<NetworkClientId, NetworkMetadata>;
+/**
+ * The state that NetworkController stores.
+ */
+export type NetworkState = {
+    /**
+     * The ID of the network client that the proxies returned by
+     * `getSelectedNetworkClient` currently point to.
+     */
+    selectedNetworkClientId: NetworkClientId;
+    /**
+     * The registry of networks and corresponding RPC endpoints that the
+     * controller can use to make requests for various chains.
+     *
+     * @see {@link NetworkConfiguration}
+     */
+    networkConfigurationsByChainId: Record<Hex, NetworkConfiguration>;
+    /**
+     * Extra information about each network, such as whether it is accessible or
+     * blocked and whether it supports EIP-1559, keyed by network client ID.
+     */
+    networksMetadata: NetworksMetadata;
+};
+declare const controllerName = "NetworkController";
+/**
+ * Represents the block tracker for the currently selected network. (Note that
+ * this is a proxy around a proxy: the inner one exists so that the block
+ * tracker doesn't have to exist until it's used, and the outer one exists so
+ * that the currently selected network can change without consumers needing to
+ * refresh the object reference to that network.)
+ */
+export type BlockTrackerProxy = SwappableProxy<ProxyWithAccessibleTarget<BlockTracker>>;
+/**
+ * Represents the provider for the currently selected network. (Note that this
+ * is a proxy around a proxy: the inner one exists so that the provider doesn't
+ * have to exist until it's used, and the outer one exists so that the currently
+ * selected network can change without consumers needing to refresh the object
+ * reference to that network.)
+ */
+export type ProviderProxy = SwappableProxy<ProxyWithAccessibleTarget<Provider>>;
+export type NetworkControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, NetworkState>;
+/**
+ * `networkWillChange` is published when the current network is about to be
+ * switched, but the new provider has not been created and no state changes have
+ * occurred yet.
+ */
+export type NetworkControllerNetworkWillChangeEvent = {
+    type: 'NetworkController:networkWillChange';
+    payload: [NetworkState];
+};
+/**
+ * `networkDidChange` is published after a provider has been created for a newly
+ * switched network (but before the network has been confirmed to be available).
+ */
+export type NetworkControllerNetworkDidChangeEvent = {
+    type: 'NetworkController:networkDidChange';
+    payload: [NetworkState];
+};
+/**
+ * `infuraIsBlocked` is published after the network is switched to an Infura
+ * network, but when Infura returns an error blocking the user based on their
+ * location.
+ */
+export type NetworkControllerInfuraIsBlockedEvent = {
+    type: 'NetworkController:infuraIsBlocked';
+    payload: [];
+};
+/**
+ * `infuraIsBlocked` is published either after the network is switched to an
+ * Infura network and Infura does not return an error blocking the user based on
+ * their location, or the network is switched to a non-Infura network.
+ */
+export type NetworkControllerInfuraIsUnblockedEvent = {
+    type: 'NetworkController:infuraIsUnblocked';
+    payload: [];
+};
+/**
+ * `networkAdded` is published after a network configuration is added to the
+ * network configuration registry and network clients are created for it.
+ */
+export type NetworkControllerNetworkAddedEvent = {
+    type: 'NetworkController:networkAdded';
+    payload: [networkConfiguration: NetworkConfiguration];
+};
+export type NetworkControllerEvents = NetworkControllerStateChangeEvent | NetworkControllerNetworkWillChangeEvent | NetworkControllerNetworkDidChangeEvent | NetworkControllerInfuraIsBlockedEvent | NetworkControllerInfuraIsUnblockedEvent | NetworkControllerNetworkAddedEvent;
+export type NetworkControllerGetStateAction = ControllerGetStateAction<typeof controllerName, NetworkState>;
+export type NetworkControllerGetEthQueryAction = {
+    type: `NetworkController:getEthQuery`;
+    handler: () => EthQuery | undefined;
+};
+export type NetworkControllerGetNetworkClientByIdAction = {
+    type: `NetworkController:getNetworkClientById`;
+    handler: NetworkController['getNetworkClientById'];
+};
+export type NetworkControllerGetSelectedNetworkClientAction = {
+    type: `NetworkController:getSelectedNetworkClient`;
+    handler: NetworkController['getSelectedNetworkClient'];
+};
+export type NetworkControllerGetEIP1559CompatibilityAction = {
+    type: `NetworkController:getEIP1559Compatibility`;
+    handler: NetworkController['getEIP1559Compatibility'];
+};
+export type NetworkControllerFindNetworkClientIdByChainIdAction = {
+    type: `NetworkController:findNetworkClientIdByChainId`;
+    handler: NetworkController['findNetworkClientIdByChainId'];
+};
+/**
+ * Change the currently selected network to the given built-in network type.
+ *
+ * @deprecated This action has been replaced by `setActiveNetwork`, and will be
+ * removed in a future release.
+ */
+export type NetworkControllerSetProviderTypeAction = {
+    type: `NetworkController:setProviderType`;
+    handler: NetworkController['setProviderType'];
+};
+export type NetworkControllerSetActiveNetworkAction = {
+    type: `NetworkController:setActiveNetwork`;
+    handler: NetworkController['setActiveNetwork'];
+};
+export type NetworkControllerGetNetworkConfigurationByChainId = {
+    type: `NetworkController:getNetworkConfigurationByChainId`;
+    handler: NetworkController['getNetworkConfigurationByChainId'];
+};
+export type NetworkControllerGetNetworkConfigurationByNetworkClientId = {
+    type: `NetworkController:getNetworkConfigurationByNetworkClientId`;
+    handler: NetworkController['getNetworkConfigurationByNetworkClientId'];
+};
+export type NetworkControllerActions = NetworkControllerGetStateAction | NetworkControllerGetEthQueryAction | NetworkControllerGetNetworkClientByIdAction | NetworkControllerGetSelectedNetworkClientAction | NetworkControllerGetEIP1559CompatibilityAction | NetworkControllerFindNetworkClientIdByChainIdAction | NetworkControllerSetActiveNetworkAction | NetworkControllerSetProviderTypeAction | NetworkControllerGetNetworkConfigurationByChainId | NetworkControllerGetNetworkConfigurationByNetworkClientId;
+export type NetworkControllerMessenger = RestrictedControllerMessenger<typeof controllerName, NetworkControllerActions, NetworkControllerEvents, never, never>;
+export type NetworkControllerOptions = {
+    messenger: NetworkControllerMessenger;
+    infuraProjectId: string;
+    state?: Partial<NetworkState>;
+    log?: Logger;
+};
+/**
+ * Constructs properties for the NetworkController state whose values will be
+ * used if not provided to the constructor.
+ *
+ * @returns The default NetworkController state.
+ */
+export declare function getDefaultNetworkControllerState(): NetworkState;
+/**
+ * Get a list of all network configurations.
+ *
+ * @param state - NetworkController state
+ * @returns A list of all available network configurations
+ */
+export declare function getNetworkConfigurations(state: NetworkState): NetworkConfiguration[];
+/**
+ * Get a list of all available client IDs from a list of
+ * network configurations
+ * @param networkConfigurations - The array of network configurations
+ * @returns A list of all available client IDs
+ */
+export declare function getAvailableNetworkClientIds(networkConfigurations: NetworkConfiguration[]): string[];
+export declare const selectAvailableNetworkClientIds: ((state: NetworkState) => string[]) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: NetworkConfiguration[]) => string[];
+    memoizedResultFunc: ((resultFuncArgs_0: NetworkConfiguration[]) => string[]) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => string[];
+    dependencies: [typeof getNetworkConfigurations];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};
+/**
+ * The collection of auto-managed network clients that map to Infura networks.
+ */
+export type AutoManagedBuiltInNetworkClientRegistry = Record<BuiltInNetworkClientId, AutoManagedNetworkClient<InfuraNetworkClientConfiguration>>;
+/**
+ * The collection of auto-managed network clients that map to Infura networks.
+ */
+export type AutoManagedCustomNetworkClientRegistry = Record<CustomNetworkClientId, AutoManagedNetworkClient<CustomNetworkClientConfiguration>>;
+/**
+ * The collection of auto-managed network clients that map to Infura networks
+ * as well as custom networks that users have added.
+ */
+export type AutoManagedNetworkClientRegistry = {
+    [NetworkClientType.Infura]: AutoManagedBuiltInNetworkClientRegistry;
+    [NetworkClientType.Custom]: AutoManagedCustomNetworkClientRegistry;
+};
+/**
+ * Controller that creates and manages an Ethereum network provider.
+ */
+export declare class NetworkController extends BaseController<typeof controllerName, NetworkState, NetworkControllerMessenger> {
+    #private;
+    constructor({ messenger, state, infuraProjectId, log, }: NetworkControllerOptions);
+    /**
+     * Accesses the provider and block tracker for the currently selected network.
+     * @returns The proxy and block tracker proxies.
+     * @deprecated This method has been replaced by `getSelectedNetworkClient` (which has a more easily used return type) and will be removed in a future release.
+     */
+    getProviderAndBlockTracker(): {
+        provider: SwappableProxy<ProxyWithAccessibleTarget<Provider>> | undefined;
+        blockTracker: SwappableProxy<ProxyWithAccessibleTarget<BlockTracker>> | undefined;
+    };
+    /**
+     * Accesses the provider and block tracker for the currently selected network.
+     *
+     * @returns an object with the provider and block tracker proxies for the currently selected network.
+     */
+    getSelectedNetworkClient(): {
+        provider: SwappableProxy<ProxyWithAccessibleTarget<Provider>>;
+        blockTracker: SwappableProxy<ProxyWithAccessibleTarget<BlockTracker>>;
+    } | undefined;
+    /**
+     * Internally, the Infura and custom network clients are categorized by type
+     * so that when accessing either kind of network client, TypeScript knows
+     * which type to assign to the network client. For some cases it's more useful
+     * to be able to access network clients by ID instead of by type and then ID,
+     * so this function makes that possible.
+     *
+     * @returns The network clients registered so far, keyed by ID.
+     */
+    getNetworkClientRegistry(): AutoManagedBuiltInNetworkClientRegistry & AutoManagedCustomNetworkClientRegistry;
+    /**
+     * Returns the Infura network client with the given ID.
+     *
+     * @param infuraNetworkClientId - An Infura network client ID.
+     * @returns The Infura network client.
+     * @throws If an Infura network client does not exist with the given ID.
+     */
+    getNetworkClientById(infuraNetworkClientId: BuiltInNetworkClientId): AutoManagedNetworkClient<InfuraNetworkClientConfiguration>;
+    /**
+     * Returns the custom network client with the given ID.
+     *
+     * @param customNetworkClientId - A custom network client ID.
+     * @returns The custom network client.
+     * @throws If a custom network client does not exist with the given ID.
+     */
+    getNetworkClientById(customNetworkClientId: CustomNetworkClientId): AutoManagedNetworkClient<CustomNetworkClientConfiguration>;
+    /**
+     * Ensures that network clients for Infura and custom RPC endpoints have been
+     * created. Then, consulting state, initializes and establishes the currently
+     * selected network client.
+     */
+    initializeProvider(): Promise<void>;
+    /**
+     * Refreshes the network meta with EIP-1559 support and the network status
+     * based on the given network client ID.
+     *
+     * @param networkClientId - The ID of the network client to update.
+     */
+    lookupNetworkByClientId(networkClientId: NetworkClientId): Promise<void>;
+    /**
+     * Persists the following metadata about the given or selected network to
+     * state:
+     *
+     * - The status of the network, namely, whether it is available, geo-blocked
+     * (Infura only), or unavailable, or whether the status is unknown
+     * - Whether the network supports EIP-1559, or whether it is unknown
+     *
+     * Note that it is possible for the network to be switched while this data is
+     * being collected. If that is the case, no metadata for the (now previously)
+     * selected network will be updated.
+     *
+     * @param networkClientId - The ID of the network client to update.
+     * If no ID is provided, uses the currently selected network.
+     */
+    lookupNetwork(networkClientId?: NetworkClientId): Promise<void>;
+    /**
+     * Convenience method to update provider network type settings.
+     *
+     * @param type - Human readable network name.
+     * @deprecated This has been replaced by `setActiveNetwork`, and will be
+     * removed in a future release
+     */
+    setProviderType(type: InfuraNetworkType): Promise<void>;
+    /**
+     * Changes the selected network.
+     *
+     * @param networkClientId - The ID of a network client that will be used to
+     * make requests.
+     * @param options - Options for this method.
+     * @param options.updateState - Allows for updating state.
+     * @throws if no network client is associated with the given
+     * network client ID.
+     */
+    setActiveNetwork(networkClientId: string, options?: {
+        updateState?: (state: Draft<NetworkState>) => void;
+    }): Promise<void>;
+    /**
+     * Determines whether the network supports EIP-1559 by checking whether the
+     * latest block has a `baseFeePerGas` property, then updates state
+     * appropriately.
+     *
+     * @param networkClientId - The networkClientId to fetch the correct provider against which to check 1559 compatibility.
+     * @returns A promise that resolves to true if the network supports EIP-1559
+     * , false otherwise, or `undefined` if unable to determine the compatibility.
+     */
+    getEIP1559Compatibility(networkClientId?: NetworkClientId): Promise<boolean | undefined>;
+    get1559CompatibilityWithNetworkClientId(networkClientId: NetworkClientId): Promise<boolean>;
+    /**
+     * Ensures that the provider and block tracker proxies are pointed to the
+     * currently selected network and refreshes the metadata for the
+     */
+    resetConnection(): Promise<void>;
+    /**
+     * Returns the network configuration that has been filed under the given chain
+     * ID.
+     *
+     * @param chainId - The chain ID to use as a key.
+     * @returns The network configuration if one exists, or undefined.
+     */
+    getNetworkConfigurationByChainId(chainId: Hex): NetworkConfiguration | undefined;
+    /**
+     * Returns the network configuration that contains an RPC endpoint with the
+     * given network client ID.
+     *
+     * @param networkClientId - The network client ID to use as a key.
+     * @returns The network configuration if one exists, or undefined.
+     */
+    getNetworkConfigurationByNetworkClientId(networkClientId: NetworkClientId): NetworkConfiguration | undefined;
+    /**
+     * Creates and registers network clients for the collection of Infura and
+     * custom RPC endpoints that can be used to make requests for a particular
+     * chain, storing the given configuration object in state for later reference.
+     *
+     * @param fields - The object that describes the new network/chain and lists
+     * the RPC endpoints which front that chain.
+     * @returns The newly added network configuration.
+     * @throws if any part of `fields` would produce invalid state.
+     * @see {@link NetworkConfiguration}
+     */
+    addNetwork(fields: AddNetworkFields): NetworkConfiguration;
+    /**
+     * Updates the configuration for a previously stored network filed under the
+     * given chain ID, creating + registering new network clients to represent RPC
+     * endpoints that have been added and destroying + unregistering existing
+     * network clients for RPC endpoints that have been removed.
+     *
+     * Note that if `chainId` is changed, then all network clients associated with
+     * that chain will be removed and re-added, even if none of the RPC endpoints
+     * have changed.
+     *
+     * @param chainId - The chain ID associated with an existing network.
+     * @param fields - The object that describes the updates to the network/chain,
+     * including the new set of RPC endpoints which should front that chain.
+     * @param options - Options to provide.
+     * @param options.replacementSelectedRpcEndpointIndex - Usually you cannot
+     * remove an RPC endpoint that is being represented by the currently selected
+     * network client. This option allows you to specify another RPC endpoint
+     * (either an existing one or a new one) that should be used to select a new
+     * network instead.
+     * @returns The updated network configuration.
+     * @throws if `chainId` does not refer to an existing network configuration,
+     * if any part of `fields` would produce invalid state, etc.
+     * @see {@link NetworkConfiguration}
+     */
+    updateNetwork(chainId: Hex, fields: UpdateNetworkFields, { replacementSelectedRpcEndpointIndex, }?: {
+        replacementSelectedRpcEndpointIndex?: number;
+    }): Promise<NetworkConfiguration>;
+    /**
+     * Destroys and unregisters the network identified by the given chain ID, also
+     * removing the associated network configuration from state.
+     *
+     * @param chainId - The chain ID associated with an existing network.
+     * @throws if `chainId` does not refer to an existing network configuration,
+     * or if the currently selected network is being removed.
+     * @see {@link NetworkConfiguration}
+     */
+    removeNetwork(chainId: Hex): void;
+    /**
+     * Assuming that the network has been previously switched, switches to this
+     * new network.
+     *
+     * If the network has not been previously switched, this method is equivalent
+     * to {@link resetConnection}.
+     */
+    rollbackToPreviousProvider(): Promise<void>;
+    /**
+     * Deactivates the controller, stopping any ongoing polling.
+     *
+     * In-progress requests will not be aborted.
+     */
+    destroy(): Promise<void>;
+    /**
+     * Merges the given backup data into controller state.
+     *
+     * @param backup - The data that has been backed up.
+     * @param backup.networkConfigurationsByChainId - Network configurations,
+     * keyed by chain ID.
+     */
+    loadBackup({ networkConfigurationsByChainId, }: Pick<NetworkState, 'networkConfigurationsByChainId'>): void;
+    /**
+     * Searches for a network configuration ID with the given ChainID and returns it.
+     *
+     * @param chainId - ChainId to search for
+     * @returns networkClientId of the network configuration with the given chainId
+     */
+    findNetworkClientIdByChainId(chainId: Hex): NetworkClientId;
+}
+export {};
+//# sourceMappingURL=NetworkController.d.mts.map

package/dist/NetworkController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkController.d.mts","sourceRoot":"","sources":["../src/NetworkController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,6BAA6B,EAC9B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,mCAAmC;AAC7D,OAAO,EACL,iBAAiB,EAOlB,mCAAmC;AACpC,OAAO,QAAQ,4BAA4B;AAG3C,OAAO,KAAK,EAAE,cAAc,EAAE,sCAAsC;AACpE,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAG3C,OAAO,KAAK,EAAE,KAAK,EAAE,cAAc;AACnC,OAAO,KAAK,EAAE,MAAM,EAAE,iBAAiB;AAMvC,OAAO,EAAsB,aAAa,EAAE,wBAAoB;AAChE,OAAO,KAAK,EACV,wBAAwB,EACxB,yBAAyB,EAC1B,iDAA6C;AAG9C,OAAO,EAAE,iBAAiB,EAAE,oBAAgB;AAC5C,OAAO,KAAK,EACV,YAAY,EACZ,QAAQ,EACR,gCAAgC,EAChC,gCAAgC,EAEjC,oBAAgB;AAOjB,MAAM,MAAM,KAAK,GAAG;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IAGH,IAAI,EAAE;QACJ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;KAC9B,CAAC;IACF;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,eAAe;IACzB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,eAAe,EAAE,sBAAsB,CAAC;IACxC;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC;IAC7B;;;;OAIG;IACH,GAAG,EAAE,WAAW,iBAAiB,iCAAiC,CAAC;CACpE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,eAAe,EAAE,qBAAqB,CAAC;IACvC;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC;IAC7B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAEhE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B;;;;OAIG;IACH,OAAO,EAAE,GAAG,CAAC;IACb;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC;;;;OAIG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,iCAAiC,GAAG,IAAI,CAClD,iBAAiB,EACjB,iBAAiB,CAClB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,EAAE,cAAc,CAAC,GAAG;IAC1E,YAAY,EAAE,CAAC,iBAAiB,GAAG,iCAAiC,CAAC,EAAE,CAAC;CACzE,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAC3D,iBAAiB,EACjB,iBAAiB,CAClB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,oBAAoB,EAAE,cAAc,CAAC,GAAG;IAC7E,YAAY,EAAE,CAAC,iBAAiB,GAAG,oCAAoC,CAAC,EAAE,CAAC;CAC5E,CAAC;AAEF;;;;;;;;;;;;GAYG;AAGH,wBAAgB,WAAW,CAAC,CAAC,SAAS,WAAW,EAG/C,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,OAGhC;AAeD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,sBAAsB,GAAG,qBAAqB,CAAC;AAE7E;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,uBAAuB,EAAE,eAAe,CAAC;IACzC;;;;;OAKG;IACH,8BAA8B,EAAE,MAAM,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;IAClE;;;OAGG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;CACpC,CAAC;AAEF,QAAA,MAAM,cAAc,sBAAsB,CAAC;AAE3C;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,CAC5C,yBAAyB,CAAC,YAAY,CAAC,CACxC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEhF,MAAM,MAAM,iCAAiC,GAAG,0BAA0B,CACxE,OAAO,cAAc,EACrB,YAAY,CACb,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,EAAE,CAAC;CACb,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,EAAE,CAAC;CACb,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,iCAAiC,GACjC,uCAAuC,GACvC,sCAAsC,GACtC,qCAAqC,GACrC,uCAAuC,GACvC,kCAAkC,CAAC;AAEvC,MAAM,MAAM,+BAA+B,GAAG,wBAAwB,CACpE,OAAO,cAAc,EACrB,YAAY,CACb,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,MAAM,QAAQ,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;CACpD,CAAC;AAEF,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,iBAAiB,CAAC,0BAA0B,CAAC,CAAC;CACxD,CAAC;AAEF,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,gDAAgD,CAAC;IACvD,OAAO,EAAE,iBAAiB,CAAC,8BAA8B,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,oDAAoD,CAAC;IAC3D,OAAO,EAAE,iBAAiB,CAAC,kCAAkC,CAAC,CAAC;CAChE,CAAC;AAEF,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,4DAA4D,CAAC;IACnE,OAAO,EAAE,iBAAiB,CAAC,0CAA0C,CAAC,CAAC;CACxE,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAChC,+BAA+B,GAC/B,kCAAkC,GAClC,2CAA2C,GAC3C,+CAA+C,GAC/C,8CAA8C,GAC9C,mDAAmD,GACnD,uCAAuC,GACvC,sCAAsC,GACtC,iDAAiD,GACjD,yDAAyD,CAAC;AAE9D,MAAM,MAAM,0BAA0B,GAAG,6BAA6B,CACpE,OAAO,cAAc,EACrB,wBAAwB,EACxB,uBAAuB,EACvB,KAAK,EACL,KAAK,CACN,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,SAAS,EAAE,0BAA0B,CAAC;IACtC,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAwCF;;;;;GAKG;AACH,wBAAgB,gCAAgC,IAAI,YAAY,CAU/D;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,YAAY,GAClB,oBAAoB,EAAE,CAExB;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAC1C,qBAAqB,EAAE,oBAAoB,EAAE,GAC5C,MAAM,EAAE,CAMV;AAED,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;CAG3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG,MAAM,CAC1D,sBAAsB,EACtB,wBAAwB,CAAC,gCAAgC,CAAC,CAC3D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,MAAM,CACzD,qBAAqB,EACrB,wBAAwB,CAAC,gCAAgC,CAAC,CAC3D,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,uCAAuC,CAAC;IACpE,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,sCAAsC,CAAC;CACpE,CAAC;AA6MF;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,cAAc,CACnD,OAAO,cAAc,EACrB,YAAY,EACZ,0BAA0B,CAC3B;;gBAwBa,EACV,SAAS,EACT,KAAK,EACL,eAAe,EACf,GAAG,GACJ,EAAE,wBAAwB;IAuG3B;;;;OAIG;IACH,0BAA0B,IAAI;QAC5B,QAAQ,EAAE,cAAc,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAC;QAC1E,YAAY,EACR,cAAc,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC,GACvD,SAAS,CAAC;KACf;IAOD;;;;OAIG;IACH,wBAAwB,IACpB;QACE,QAAQ,EAAE,cAAc,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9D,YAAY,EAAE,cAAc,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC,CAAC;KACvE,GACD,SAAS;IAUb;;;;;;;;OAQG;IACH,wBAAwB,IAAI,uCAAuC,GACjE,sCAAsC;IAWxC;;;;;;OAMG;IACH,oBAAoB,CAClB,qBAAqB,EAAE,sBAAsB,GAC5C,wBAAwB,CAAC,gCAAgC,CAAC;IAE7D;;;;;;OAMG;IACH,oBAAoB,CAClB,qBAAqB,EAAE,qBAAqB,GAC3C,wBAAwB,CAAC,gCAAgC,CAAC;IA+E7D;;;;OAIG;IACG,kBAAkB;IAKxB;;;;;OAKG;IACG,uBAAuB,CAAC,eAAe,EAAE,eAAe;IAsF9D;;;;;;;;;;;;;;OAcG;IACG,aAAa,CAAC,eAAe,CAAC,EAAE,eAAe;IAoHrD;;;;;;OAMG;IACG,eAAe,CAAC,IAAI,EAAE,iBAAiB;IAkB7C;;;;;;;;;OASG;IACG,gBAAgB,CACpB,eAAe,EAAE,MAAM,EACvB,OAAO,GAAE;QACP,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,KAAK,IAAI,CAAC;KAC/C;IAsCR;;;;;;;;OAQG;IACG,uBAAuB,CAAC,eAAe,CAAC,EAAE,eAAe;IA2BzD,uCAAuC,CAC3C,eAAe,EAAE,eAAe;IAkClC;;;OAGG;IACG,eAAe;IAIrB;;;;;;OAMG;IACH,gCAAgC,CAC9B,OAAO,EAAE,GAAG,GACX,oBAAoB,GAAG,SAAS;IAInC;;;;;;OAMG;IACH,wCAAwC,CACtC,eAAe,EAAE,eAAe,GAC/B,oBAAoB,GAAG,SAAS;IAInC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,oBAAoB;IA4D1D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,aAAa,CACjB,OAAO,EAAE,GAAG,EACZ,MAAM,EAAE,mBAAmB,EAC3B,EACE,mCAAmC,GACpC,GAAE;QAAE,mCAAmC,CAAC,EAAE,MAAM,CAAA;KAAO,GACvD,OAAO,CAAC,oBAAoB,CAAC;IA+PhC;;;;;;;;OAQG;IACH,aAAa,CAAC,OAAO,EAAE,GAAG;IAgD1B;;;;;;OAMG;IACG,0BAA0B;IAIhC;;;;OAIG;IACG,OAAO;IAIb;;;;;;OAMG;IACH,UAAU,CAAC,EACT,8BAA8B,GAC/B,EAAE,IAAI,CAAC,YAAY,EAAE,gCAAgC,CAAC,GAAG,IAAI;IAS9D;;;;;OAKG;IACH,4BAA4B,CAAC,OAAO,EAAE,GAAG,GAAG,eAAe;CAsnB5D"}