@metamask-previews/network-controller 30.0.1-preview-3f3a92d7b → 30.0.1-preview-16512b784

package/CHANGELOG.md

@@ -7,10 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Expose missing public `NetworkController` methods through its messenger ([#8350](https://github.com/MetaMask/core/pull/8350))
+  - The following actions are now available:
+    - `NetworkController:enableRpcFailover`
+    - `NetworkController:disableRpcFailover`
+    - `NetworkController:getProviderAndBlockTracker`
+    - `NetworkController:getNetworkClientRegistry`
+    - `NetworkController:initializeProvider`
+    - `NetworkController:lookupNetwork`
+    - `NetworkController:lookupNetworkByClientId`
+    - `NetworkController:get1559CompatibilityWithNetworkClientId`
+    - `NetworkController:resetConnection`
+    - `NetworkController:rollbackToPreviousProvider`
+    - `NetworkController:loadBackup`
+  - Corresponding action types are available as well.
+- Add `getEthQuery` method to `NetworkController` ([#8350](https://github.com/MetaMask/core/pull/8350))
+
 ### Changed
 
 - Bump `@metamask/controller-utils` from `^11.19.0` to `^11.20.0` ([#8344](https://github.com/MetaMask/core/pull/8344))
 
+### Deprecated
+
+- `NetworkControllerGetNetworkConfigurationByNetworkClientId` type is deprecated in favor of `NetworkControllerGetNetworkConfigurationByNetworkClientIdAction` ([#8350](https://github.com/MetaMask/core/pull/8350))
+
 ## [30.0.1]
 
 ### Changed

package/dist/NetworkController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=NetworkController-method-action-types.cjs.map

package/dist/NetworkController-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkController-method-action-types.cjs","sourceRoot":"","sources":["../src/NetworkController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { NetworkController } from './NetworkController';\n\n/**\n * Returns the EthQuery instance for the currently selected network.\n *\n * @returns The EthQuery instance, or undefined if the provider has not been\n * initialized.\n */\nexport type NetworkControllerGetEthQueryAction = {\n  type: `NetworkController:getEthQuery`;\n  handler: NetworkController['getEthQuery'];\n};\n\n/**\n * Enables the RPC failover functionality. That is, if any RPC endpoints are\n * configured with failover URLs, then traffic will automatically be diverted\n * to them if those RPC endpoints are unavailable.\n */\nexport type NetworkControllerEnableRpcFailoverAction = {\n  type: `NetworkController:enableRpcFailover`;\n  handler: NetworkController['enableRpcFailover'];\n};\n\n/**\n * Disables the RPC failover functionality. That is, even if any RPC endpoints\n * are configured with failover URLs, then traffic will not automatically be\n * diverted to them if those RPC endpoints are unavailable.\n */\nexport type NetworkControllerDisableRpcFailoverAction = {\n  type: `NetworkController:disableRpcFailover`;\n  handler: NetworkController['disableRpcFailover'];\n};\n\n/**\n * Accesses the provider and block tracker for the currently selected network.\n *\n * @returns The proxy and block tracker proxies.\n * @deprecated This method has been replaced by `getSelectedNetworkClient` (which has a more easily used return type) and will be removed in a future release.\n */\nexport type NetworkControllerGetProviderAndBlockTrackerAction = {\n  type: `NetworkController:getProviderAndBlockTracker`;\n  handler: NetworkController['getProviderAndBlockTracker'];\n};\n\n/**\n * Accesses the provider and block tracker for the currently selected network.\n *\n * @returns an object with the provider and block tracker proxies for the currently selected network.\n */\nexport type NetworkControllerGetSelectedNetworkClientAction = {\n  type: `NetworkController:getSelectedNetworkClient`;\n  handler: NetworkController['getSelectedNetworkClient'];\n};\n\n/**\n * Accesses the chain ID from the selected network client.\n *\n * @returns The chain ID of the selected network client in hex format or undefined if there is no network client.\n */\nexport type NetworkControllerGetSelectedChainIdAction = {\n  type: `NetworkController:getSelectedChainId`;\n  handler: NetworkController['getSelectedChainId'];\n};\n\n/**\n * Internally, the Infura and custom network clients are categorized by type\n * so that when accessing either kind of network client, TypeScript knows\n * which type to assign to the network client. For some cases it's more useful\n * to be able to access network clients by ID instead of by type and then ID,\n * so this function makes that possible.\n *\n * @returns The network clients registered so far, keyed by ID.\n */\nexport type NetworkControllerGetNetworkClientRegistryAction = {\n  type: `NetworkController:getNetworkClientRegistry`;\n  handler: NetworkController['getNetworkClientRegistry'];\n};\n\n/**\n * Returns the Infura network client with the given ID.\n *\n * @param infuraNetworkClientId - An Infura network client ID.\n * @returns The Infura network client.\n * @throws If an Infura network client does not exist with the given ID.\n */\nexport type NetworkControllerGetNetworkClientByIdAction = {\n  type: `NetworkController:getNetworkClientById`;\n  handler: NetworkController['getNetworkClientById'];\n};\n\n/**\n * Creates proxies for accessing the global network client and its block\n * tracker. You must call this method in order to use\n * `getProviderAndBlockTracker` (or its replacement,\n * `getSelectedNetworkClient`).\n *\n * @param options - Optional arguments.\n * @param options.lookupNetwork - Usually, metadata for the global network\n * will be populated via a call to `lookupNetwork` after creating the provider\n * and block tracker proxies. This allows for responding to the status of the\n * global network after initializing this controller; however, it requires\n * making a request to the network to do so. In the clients, where controllers\n * are initialized before the UI is shown, this may be undesirable, as it\n * means that if the user has just installed MetaMask, their IP address may be\n * shared with a third party before they have a chance to finish onboarding.\n * You can pass `false` if you'd like to disable this request and call\n * `lookupNetwork` yourself.\n */\nexport type NetworkControllerInitializeProviderAction = {\n  type: `NetworkController:initializeProvider`;\n  handler: NetworkController['initializeProvider'];\n};\n\n/**\n * Uses a request for the latest block to gather the following information on\n * the given or selected network, persisting it to state:\n *\n * - The connectivity status: whether it is available, geo-blocked (Infura\n * only), unavailable, or unknown\n * - The capabilities status: whether it supports EIP-1559, whether it does\n * not, or whether it is unknown\n *\n * @param networkClientId - The ID of the network client to inspect.\n * If no ID is provided, uses the currently selected network.\n */\nexport type NetworkControllerLookupNetworkAction = {\n  type: `NetworkController:lookupNetwork`;\n  handler: NetworkController['lookupNetwork'];\n};\n\n/**\n * Uses a request for the latest block to gather the following information on\n * the given network, persisting it to state:\n *\n * - The connectivity status: whether the network is available, geo-blocked\n * (Infura only), unavailable, or unknown\n * - The feature compatibility status: whether the network supports EIP-1559,\n * whether it does not, or whether it is unknown\n *\n * @param networkClientId - The ID of the network client to inspect.\n * @deprecated Please use `lookupNetwork` and pass a network client ID\n * instead. This method will be removed in a future major version.\n */\nexport type NetworkControllerLookupNetworkByClientIdAction = {\n  type: `NetworkController:lookupNetworkByClientId`;\n  handler: NetworkController['lookupNetworkByClientId'];\n};\n\n/**\n * Convenience method to update provider network type settings.\n *\n * @param type - Human readable network name.\n * @deprecated This has been replaced by `setActiveNetwork`, and will be\n * removed in a future release\n */\nexport type NetworkControllerSetProviderTypeAction = {\n  type: `NetworkController:setProviderType`;\n  handler: NetworkController['setProviderType'];\n};\n\n/**\n * Changes the selected network.\n *\n * @param networkClientId - The ID of a network client that will be used to\n * make requests.\n * @param options - Options for this method.\n * @param options.updateState - Allows for updating state.\n * @throws if no network client is associated with the given\n * network client ID.\n */\nexport type NetworkControllerSetActiveNetworkAction = {\n  type: `NetworkController:setActiveNetwork`;\n  handler: NetworkController['setActiveNetwork'];\n};\n\n/**\n * Determines whether the network supports EIP-1559 by checking whether the\n * latest block has a `baseFeePerGas` property, then updates state\n * appropriately.\n *\n * @param networkClientId - The networkClientId to fetch the correct provider against which to check 1559 compatibility.\n * @returns A promise that resolves to true if the network supports EIP-1559\n * , false otherwise, or `undefined` if unable to determine the compatibility.\n */\nexport type NetworkControllerGetEIP1559CompatibilityAction = {\n  type: `NetworkController:getEIP1559Compatibility`;\n  handler: NetworkController['getEIP1559Compatibility'];\n};\n\nexport type NetworkControllerGet1559CompatibilityWithNetworkClientIdAction = {\n  type: `NetworkController:get1559CompatibilityWithNetworkClientId`;\n  handler: NetworkController['get1559CompatibilityWithNetworkClientId'];\n};\n\n/**\n * Ensures that the provider and block tracker proxies are pointed to the\n * currently selected network and refreshes the metadata for the\n */\nexport type NetworkControllerResetConnectionAction = {\n  type: `NetworkController:resetConnection`;\n  handler: NetworkController['resetConnection'];\n};\n\n/**\n * Returns the network configuration that has been filed under the given chain\n * ID.\n *\n * @param chainId - The chain ID to use as a key.\n * @returns The network configuration if one exists, or undefined.\n */\nexport type NetworkControllerGetNetworkConfigurationByChainIdAction = {\n  type: `NetworkController:getNetworkConfigurationByChainId`;\n  handler: NetworkController['getNetworkConfigurationByChainId'];\n};\n\n/**\n * Returns the network configuration that contains an RPC endpoint with the\n * given network client ID.\n *\n * @param networkClientId - The network client ID to use as a key.\n * @returns The network configuration if one exists, or undefined.\n */\nexport type NetworkControllerGetNetworkConfigurationByNetworkClientIdAction = {\n  type: `NetworkController:getNetworkConfigurationByNetworkClientId`;\n  handler: NetworkController['getNetworkConfigurationByNetworkClientId'];\n};\n\n/**\n * Creates and registers network clients for the collection of Infura and\n * custom RPC endpoints that can be used to make requests for a particular\n * chain, storing the given configuration object in state for later reference.\n *\n * @param fields - The object that describes the new network/chain and lists\n * the RPC endpoints which front that chain.\n * @returns The newly added network configuration.\n * @throws if any part of `fields` would produce invalid state.\n * @see {@link NetworkConfiguration}\n */\nexport type NetworkControllerAddNetworkAction = {\n  type: `NetworkController:addNetwork`;\n  handler: NetworkController['addNetwork'];\n};\n\n/**\n * Updates the configuration for a previously stored network filed under the\n * given chain ID, creating + registering new network clients to represent RPC\n * endpoints that have been added and destroying + unregistering existing\n * network clients for RPC endpoints that have been removed.\n *\n * Note that if `chainId` is changed, then all network clients associated with\n * that chain will be removed and re-added, even if none of the RPC endpoints\n * have changed.\n *\n * @param chainId - The chain ID associated with an existing network.\n * @param fields - The object that describes the updates to the network/chain,\n * including the new set of RPC endpoints which should front that chain.\n * @param options - Options to provide.\n * @param options.replacementSelectedRpcEndpointIndex - Usually you cannot\n * remove an RPC endpoint that is being represented by the currently selected\n * network client. This option allows you to specify another RPC endpoint\n * (either an existing one or a new one) that should be used to select a new\n * network instead.\n * @returns The updated network configuration.\n * @throws if `chainId` does not refer to an existing network configuration,\n * if any part of `fields` would produce invalid state, etc.\n * @see {@link NetworkConfiguration}\n */\nexport type NetworkControllerUpdateNetworkAction = {\n  type: `NetworkController:updateNetwork`;\n  handler: NetworkController['updateNetwork'];\n};\n\n/**\n * Destroys and unregisters the network identified by the given chain ID, also\n * removing the associated network configuration from state.\n *\n * @param chainId - The chain ID associated with an existing network.\n * @throws if `chainId` does not refer to an existing network configuration,\n * or if the currently selected network is being removed.\n * @see {@link NetworkConfiguration}\n */\nexport type NetworkControllerRemoveNetworkAction = {\n  type: `NetworkController:removeNetwork`;\n  handler: NetworkController['removeNetwork'];\n};\n\n/**\n * Assuming that the network has been previously switched, switches to this\n * new network.\n *\n * If the network has not been previously switched, this method is equivalent\n * to {@link resetConnection}.\n */\nexport type NetworkControllerRollbackToPreviousProviderAction = {\n  type: `NetworkController:rollbackToPreviousProvider`;\n  handler: NetworkController['rollbackToPreviousProvider'];\n};\n\n/**\n * Merges the given backup data into controller state.\n *\n * @param backup - The data that has been backed up.\n * @param backup.networkConfigurationsByChainId - Network configurations,\n * keyed by chain ID.\n */\nexport type NetworkControllerLoadBackupAction = {\n  type: `NetworkController:loadBackup`;\n  handler: NetworkController['loadBackup'];\n};\n\n/**\n * Searches for the default RPC endpoint configured for the given chain and\n * returns its network client ID. This can then be passed to\n * {@link getNetworkClientById} to retrieve the network client.\n *\n * @param chainId - Chain ID to search for.\n * @returns The ID of the network client created for the chain's default RPC\n * endpoint.\n */\nexport type NetworkControllerFindNetworkClientIdByChainIdAction = {\n  type: `NetworkController:findNetworkClientIdByChainId`;\n  handler: NetworkController['findNetworkClientIdByChainId'];\n};\n\n/**\n * Union of all NetworkController action types.\n */\nexport type NetworkControllerMethodActions =\n  | NetworkControllerGetEthQueryAction\n  | NetworkControllerEnableRpcFailoverAction\n  | NetworkControllerDisableRpcFailoverAction\n  | NetworkControllerGetProviderAndBlockTrackerAction\n  | NetworkControllerGetSelectedNetworkClientAction\n  | NetworkControllerGetSelectedChainIdAction\n  | NetworkControllerGetNetworkClientRegistryAction\n  | NetworkControllerGetNetworkClientByIdAction\n  | NetworkControllerInitializeProviderAction\n  | NetworkControllerLookupNetworkAction\n  | NetworkControllerLookupNetworkByClientIdAction\n  | NetworkControllerSetProviderTypeAction\n  | NetworkControllerSetActiveNetworkAction\n  | NetworkControllerGetEIP1559CompatibilityAction\n  | NetworkControllerGet1559CompatibilityWithNetworkClientIdAction\n  | NetworkControllerResetConnectionAction\n  | NetworkControllerGetNetworkConfigurationByChainIdAction\n  | NetworkControllerGetNetworkConfigurationByNetworkClientIdAction\n  | NetworkControllerAddNetworkAction\n  | NetworkControllerUpdateNetworkAction\n  | NetworkControllerRemoveNetworkAction\n  | NetworkControllerRollbackToPreviousProviderAction\n  | NetworkControllerLoadBackupAction\n  | NetworkControllerFindNetworkClientIdByChainIdAction;\n"]}

package/dist/NetworkController-method-action-types.d.cts

@@ -0,0 +1,308 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { NetworkController } from "./NetworkController.cjs";
+/**
+ * Returns the EthQuery instance for the currently selected network.
+ *
+ * @returns The EthQuery instance, or undefined if the provider has not been
+ * initialized.
+ */
+export type NetworkControllerGetEthQueryAction = {
+    type: `NetworkController:getEthQuery`;
+    handler: NetworkController['getEthQuery'];
+};
+/**
+ * Enables the RPC failover functionality. That is, if any RPC endpoints are
+ * configured with failover URLs, then traffic will automatically be diverted
+ * to them if those RPC endpoints are unavailable.
+ */
+export type NetworkControllerEnableRpcFailoverAction = {
+    type: `NetworkController:enableRpcFailover`;
+    handler: NetworkController['enableRpcFailover'];
+};
+/**
+ * Disables the RPC failover functionality. That is, even if any RPC endpoints
+ * are configured with failover URLs, then traffic will not automatically be
+ * diverted to them if those RPC endpoints are unavailable.
+ */
+export type NetworkControllerDisableRpcFailoverAction = {
+    type: `NetworkController:disableRpcFailover`;
+    handler: NetworkController['disableRpcFailover'];
+};
+/**
+ * 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.
+ */
+export type NetworkControllerGetProviderAndBlockTrackerAction = {
+    type: `NetworkController:getProviderAndBlockTracker`;
+    handler: NetworkController['getProviderAndBlockTracker'];
+};
+/**
+ * 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.
+ */
+export type NetworkControllerGetSelectedNetworkClientAction = {
+    type: `NetworkController:getSelectedNetworkClient`;
+    handler: NetworkController['getSelectedNetworkClient'];
+};
+/**
+ * Accesses the chain ID from the selected network client.
+ *
+ * @returns The chain ID of the selected network client in hex format or undefined if there is no network client.
+ */
+export type NetworkControllerGetSelectedChainIdAction = {
+    type: `NetworkController:getSelectedChainId`;
+    handler: NetworkController['getSelectedChainId'];
+};
+/**
+ * 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.
+ */
+export type NetworkControllerGetNetworkClientRegistryAction = {
+    type: `NetworkController:getNetworkClientRegistry`;
+    handler: NetworkController['getNetworkClientRegistry'];
+};
+/**
+ * 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.
+ */
+export type NetworkControllerGetNetworkClientByIdAction = {
+    type: `NetworkController:getNetworkClientById`;
+    handler: NetworkController['getNetworkClientById'];
+};
+/**
+ * Creates proxies for accessing the global network client and its block
+ * tracker. You must call this method in order to use
+ * `getProviderAndBlockTracker` (or its replacement,
+ * `getSelectedNetworkClient`).
+ *
+ * @param options - Optional arguments.
+ * @param options.lookupNetwork - Usually, metadata for the global network
+ * will be populated via a call to `lookupNetwork` after creating the provider
+ * and block tracker proxies. This allows for responding to the status of the
+ * global network after initializing this controller; however, it requires
+ * making a request to the network to do so. In the clients, where controllers
+ * are initialized before the UI is shown, this may be undesirable, as it
+ * means that if the user has just installed MetaMask, their IP address may be
+ * shared with a third party before they have a chance to finish onboarding.
+ * You can pass `false` if you'd like to disable this request and call
+ * `lookupNetwork` yourself.
+ */
+export type NetworkControllerInitializeProviderAction = {
+    type: `NetworkController:initializeProvider`;
+    handler: NetworkController['initializeProvider'];
+};
+/**
+ * Uses a request for the latest block to gather the following information on
+ * the given or selected network, persisting it to state:
+ *
+ * - The connectivity status: whether it is available, geo-blocked (Infura
+ * only), unavailable, or unknown
+ * - The capabilities status: whether it supports EIP-1559, whether it does
+ * not, or whether it is unknown
+ *
+ * @param networkClientId - The ID of the network client to inspect.
+ * If no ID is provided, uses the currently selected network.
+ */
+export type NetworkControllerLookupNetworkAction = {
+    type: `NetworkController:lookupNetwork`;
+    handler: NetworkController['lookupNetwork'];
+};
+/**
+ * Uses a request for the latest block to gather the following information on
+ * the given network, persisting it to state:
+ *
+ * - The connectivity status: whether the network is available, geo-blocked
+ * (Infura only), unavailable, or unknown
+ * - The feature compatibility status: whether the network supports EIP-1559,
+ * whether it does not, or whether it is unknown
+ *
+ * @param networkClientId - The ID of the network client to inspect.
+ * @deprecated Please use `lookupNetwork` and pass a network client ID
+ * instead. This method will be removed in a future major version.
+ */
+export type NetworkControllerLookupNetworkByClientIdAction = {
+    type: `NetworkController:lookupNetworkByClientId`;
+    handler: NetworkController['lookupNetworkByClientId'];
+};
+/**
+ * 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
+ */
+export type NetworkControllerSetProviderTypeAction = {
+    type: `NetworkController:setProviderType`;
+    handler: NetworkController['setProviderType'];
+};
+/**
+ * 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.
+ */
+export type NetworkControllerSetActiveNetworkAction = {
+    type: `NetworkController:setActiveNetwork`;
+    handler: NetworkController['setActiveNetwork'];
+};
+/**
+ * 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.
+ */
+export type NetworkControllerGetEIP1559CompatibilityAction = {
+    type: `NetworkController:getEIP1559Compatibility`;
+    handler: NetworkController['getEIP1559Compatibility'];
+};
+export type NetworkControllerGet1559CompatibilityWithNetworkClientIdAction = {
+    type: `NetworkController:get1559CompatibilityWithNetworkClientId`;
+    handler: NetworkController['get1559CompatibilityWithNetworkClientId'];
+};
+/**
+ * Ensures that the provider and block tracker proxies are pointed to the
+ * currently selected network and refreshes the metadata for the
+ */
+export type NetworkControllerResetConnectionAction = {
+    type: `NetworkController:resetConnection`;
+    handler: NetworkController['resetConnection'];
+};
+/**
+ * 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.
+ */
+export type NetworkControllerGetNetworkConfigurationByChainIdAction = {
+    type: `NetworkController:getNetworkConfigurationByChainId`;
+    handler: NetworkController['getNetworkConfigurationByChainId'];
+};
+/**
+ * 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.
+ */
+export type NetworkControllerGetNetworkConfigurationByNetworkClientIdAction = {
+    type: `NetworkController:getNetworkConfigurationByNetworkClientId`;
+    handler: NetworkController['getNetworkConfigurationByNetworkClientId'];
+};
+/**
+ * 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}
+ */
+export type NetworkControllerAddNetworkAction = {
+    type: `NetworkController:addNetwork`;
+    handler: NetworkController['addNetwork'];
+};
+/**
+ * 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}
+ */
+export type NetworkControllerUpdateNetworkAction = {
+    type: `NetworkController:updateNetwork`;
+    handler: NetworkController['updateNetwork'];
+};
+/**
+ * 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}
+ */
+export type NetworkControllerRemoveNetworkAction = {
+    type: `NetworkController:removeNetwork`;
+    handler: NetworkController['removeNetwork'];
+};
+/**
+ * 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}.
+ */
+export type NetworkControllerRollbackToPreviousProviderAction = {
+    type: `NetworkController:rollbackToPreviousProvider`;
+    handler: NetworkController['rollbackToPreviousProvider'];
+};
+/**
+ * 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.
+ */
+export type NetworkControllerLoadBackupAction = {
+    type: `NetworkController:loadBackup`;
+    handler: NetworkController['loadBackup'];
+};
+/**
+ * Searches for the default RPC endpoint configured for the given chain and
+ * returns its network client ID. This can then be passed to
+ * {@link getNetworkClientById} to retrieve the network client.
+ *
+ * @param chainId - Chain ID to search for.
+ * @returns The ID of the network client created for the chain's default RPC
+ * endpoint.
+ */
+export type NetworkControllerFindNetworkClientIdByChainIdAction = {
+    type: `NetworkController:findNetworkClientIdByChainId`;
+    handler: NetworkController['findNetworkClientIdByChainId'];
+};
+/**
+ * Union of all NetworkController action types.
+ */
+export type NetworkControllerMethodActions = NetworkControllerGetEthQueryAction | NetworkControllerEnableRpcFailoverAction | NetworkControllerDisableRpcFailoverAction | NetworkControllerGetProviderAndBlockTrackerAction | NetworkControllerGetSelectedNetworkClientAction | NetworkControllerGetSelectedChainIdAction | NetworkControllerGetNetworkClientRegistryAction | NetworkControllerGetNetworkClientByIdAction | NetworkControllerInitializeProviderAction | NetworkControllerLookupNetworkAction | NetworkControllerLookupNetworkByClientIdAction | NetworkControllerSetProviderTypeAction | NetworkControllerSetActiveNetworkAction | NetworkControllerGetEIP1559CompatibilityAction | NetworkControllerGet1559CompatibilityWithNetworkClientIdAction | NetworkControllerResetConnectionAction | NetworkControllerGetNetworkConfigurationByChainIdAction | NetworkControllerGetNetworkConfigurationByNetworkClientIdAction | NetworkControllerAddNetworkAction | NetworkControllerUpdateNetworkAction | NetworkControllerRemoveNetworkAction | NetworkControllerRollbackToPreviousProviderAction | NetworkControllerLoadBackupAction | NetworkControllerFindNetworkClientIdByChainIdAction;
+//# sourceMappingURL=NetworkController-method-action-types.d.cts.map

package/dist/NetworkController-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkController-method-action-types.d.cts","sourceRoot":"","sources":["../src/NetworkController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,gCAA4B;AAE7D;;;;;GAKG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,iBAAiB,CAAC,aAAa,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;CACjD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;CAClD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,iBAAiB,CAAC,4BAA4B,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,iBAAiB,CAAC,0BAA0B,CAAC,CAAC;CACxD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;CAClD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,iBAAiB,CAAC,0BAA0B,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,iBAAiB,CAAC,sBAAsB,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,IAAI,EAAE,sCAAsC,CAAC;IAC7C,OAAO,EAAE,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;CAClD,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,iBAAiB,CAAC,eAAe,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;CAC/C,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,8DAA8D,GAAG;IAC3E,IAAI,EAAE,2DAA2D,CAAC;IAClE,OAAO,EAAE,iBAAiB,CAAC,yCAAyC,CAAC,CAAC;CACvE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;CAC/C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,uDAAuD,GAAG;IACpE,IAAI,EAAE,oDAAoD,CAAC;IAC3D,OAAO,EAAE,iBAAiB,CAAC,kCAAkC,CAAC,CAAC;CAChE,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,+DAA+D,GAAG;IAC5E,IAAI,EAAE,4DAA4D,CAAC;IACnE,OAAO,EAAE,iBAAiB,CAAC,0CAA0C,CAAC,CAAC;CACxE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,iBAAiB,CAAC,eAAe,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,iBAAiB,CAAC,eAAe,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,iBAAiB,CAAC,4BAA4B,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,gDAAgD,CAAC;IACvD,OAAO,EAAE,iBAAiB,CAAC,8BAA8B,CAAC,CAAC;CAC5D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACtC,kCAAkC,GAClC,wCAAwC,GACxC,yCAAyC,GACzC,iDAAiD,GACjD,+CAA+C,GAC/C,yCAAyC,GACzC,+CAA+C,GAC/C,2CAA2C,GAC3C,yCAAyC,GACzC,oCAAoC,GACpC,8CAA8C,GAC9C,sCAAsC,GACtC,uCAAuC,GACvC,8CAA8C,GAC9C,8DAA8D,GAC9D,sCAAsC,GACtC,uDAAuD,GACvD,+DAA+D,GAC/D,iCAAiC,GACjC,oCAAoC,GACpC,oCAAoC,GACpC,iDAAiD,GACjD,iCAAiC,GACjC,mDAAmD,CAAC"}