@metamask/network-controller 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0]
+### Added
+- Initial release
+  - As a result of converting our shared controllers repo into a monorepo ([#831](https://github.com/MetaMask/controllers/pull/831)), we've created this package from select parts of [`@metamask/controllers` v33.0.0](https://github.com/MetaMask/controllers/tree/v33.0.0), namely:
+    - Everything in `src/network` (minus `NetworkType` and `NetworksChainId`, which were placed in `@metamask/controller-utils`)
+
+    All changes listed after this point were applied to this package following the monorepo conversion.
+
+[Unreleased]: https://github.com/MetaMask/controllers/compare/@metamask/network-controller@1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/controllers/releases/tag/@metamask/network-controller@1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2018 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/network-controller`
+
+Provides an interface to the currently selected network via a MetaMask-compatible provider object.
+
+## Installation
+
+`yarn add @metamask/network-controller`
+
+or
+
+`npm install @metamask/network-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/controllers#readme).

package/dist/NetworkController.d.ts

@@ -0,0 +1,117 @@
+import type { Patch } from 'immer';
+import { BaseControllerV2, RestrictedControllerMessenger } from '@metamask/base-controller';
+import { NetworkType } from '@metamask/controller-utils';
+/**
+ * @type ProviderConfig
+ *
+ * Configuration passed to web3-provider-engine
+ * @property rpcTarget - RPC target URL.
+ * @property type - Human-readable network name.
+ * @property chainId - Network ID as per EIP-155.
+ * @property ticker - Currency ticker.
+ * @property nickname - Personalized network name.
+ */
+export declare type ProviderConfig = {
+    rpcTarget?: string;
+    type: NetworkType;
+    chainId: string;
+    ticker?: string;
+    nickname?: string;
+};
+export declare type Block = {
+    baseFeePerGas?: string;
+};
+export declare type NetworkProperties = {
+    isEIP1559Compatible?: boolean;
+};
+/**
+ * @type NetworkState
+ *
+ * Network controller state
+ * @property network - Network ID as per net_version
+ * @property isCustomNetwork - Identifies if the network is a custom network
+ * @property provider - RPC URL and network name provider settings
+ */
+export declare type NetworkState = {
+    network: string;
+    isCustomNetwork: boolean;
+    provider: ProviderConfig;
+    properties: NetworkProperties;
+};
+declare const name = "NetworkController";
+export declare type EthQuery = any;
+export declare type NetworkControllerStateChangeEvent = {
+    type: `NetworkController:stateChange`;
+    payload: [NetworkState, Patch[]];
+};
+export declare type NetworkControllerProviderChangeEvent = {
+    type: `NetworkController:providerChange`;
+    payload: [ProviderConfig];
+};
+export declare type NetworkControllerGetProviderConfigAction = {
+    type: `NetworkController:getProviderConfig`;
+    handler: () => ProviderConfig;
+};
+export declare type NetworkControllerGetEthQueryAction = {
+    type: `NetworkController:getEthQuery`;
+    handler: () => EthQuery;
+};
+export declare type NetworkControllerMessenger = RestrictedControllerMessenger<typeof name, NetworkControllerGetProviderConfigAction | NetworkControllerGetEthQueryAction, NetworkControllerStateChangeEvent | NetworkControllerProviderChangeEvent, string, string>;
+export declare type NetworkControllerOptions = {
+    messenger: NetworkControllerMessenger;
+    infuraProjectId?: string;
+    state?: Partial<NetworkState>;
+};
+/**
+ * Controller that creates and manages an Ethereum network provider.
+ */
+export declare class NetworkController extends BaseControllerV2<typeof name, NetworkState, NetworkControllerMessenger> {
+    private ethQuery;
+    private internalProviderConfig;
+    private infuraProjectId;
+    private mutex;
+    constructor({ messenger, state, infuraProjectId }: NetworkControllerOptions);
+    private initializeProvider;
+    private refreshNetwork;
+    private registerProvider;
+    private setupInfuraProvider;
+    private getIsCustomNetwork;
+    private setupStandardProvider;
+    private updateProvider;
+    private safelyStopProvider;
+    private verifyNetwork;
+    /**
+     * Ethereum provider object for the current network
+     */
+    provider: any;
+    /**
+     * Sets a new configuration for web3-provider-engine.
+     *
+     * TODO: Replace this wth a method.
+     *
+     * @param providerConfig - The web3-provider-engine configuration.
+     */
+    set providerConfig(providerConfig: ProviderConfig);
+    get providerConfig(): ProviderConfig;
+    /**
+     * Refreshes the current network code.
+     */
+    lookupNetwork(): Promise<void>;
+    /**
+     * Convenience method to update provider network type settings.
+     *
+     * @param type - Human readable network name.
+     */
+    setProviderType(type: NetworkType): void;
+    /**
+     * Convenience method to update provider RPC settings.
+     *
+     * @param rpcTarget - The RPC endpoint URL.
+     * @param chainId - The chain ID as per EIP-155.
+     * @param ticker - The currency ticker.
+     * @param nickname - Personalized network name.
+     */
+    setRpcTarget(rpcTarget: string, chainId: string, ticker?: string, nickname?: string): void;
+    getEIP1559Compatibility(): Promise<unknown>;
+}
+export default NetworkController;

package/dist/NetworkController.js

@@ -0,0 +1,264 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworkController = void 0;
+const eth_query_1 = __importDefault(require("eth-query"));
+const provider_1 = __importDefault(require("web3-provider-engine/subproviders/provider"));
+const createProvider_1 = __importDefault(require("eth-json-rpc-infura/src/createProvider"));
+const zero_1 = __importDefault(require("web3-provider-engine/zero"));
+const async_mutex_1 = require("async-mutex");
+const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+const LOCALHOST_RPC_URL = 'http://localhost:8545';
+const name = 'NetworkController';
+const defaultState = {
+    network: 'loading',
+    isCustomNetwork: false,
+    provider: { type: controller_utils_1.MAINNET, chainId: controller_utils_1.NetworksChainId.mainnet },
+    properties: { isEIP1559Compatible: false },
+};
+/**
+ * Controller that creates and manages an Ethereum network provider.
+ */
+class NetworkController extends base_controller_1.BaseControllerV2 {
+    constructor({ messenger, state, infuraProjectId }) {
+        super({
+            name,
+            metadata: {
+                network: {
+                    persist: true,
+                    anonymous: false,
+                },
+                isCustomNetwork: {
+                    persist: true,
+                    anonymous: false,
+                },
+                properties: {
+                    persist: true,
+                    anonymous: false,
+                },
+                provider: {
+                    persist: true,
+                    anonymous: false,
+                },
+            },
+            messenger,
+            state: Object.assign(Object.assign({}, defaultState), state),
+        });
+        this.internalProviderConfig = {};
+        this.mutex = new async_mutex_1.Mutex();
+        this.infuraProjectId = infuraProjectId;
+        this.messagingSystem.registerActionHandler(`${this.name}:getProviderConfig`, () => {
+            return this.state.provider;
+        });
+        this.messagingSystem.registerActionHandler(`${this.name}:getEthQuery`, () => {
+            return this.ethQuery;
+        });
+    }
+    initializeProvider(type, rpcTarget, chainId, ticker, nickname) {
+        this.update((state) => {
+            state.isCustomNetwork = this.getIsCustomNetwork(chainId);
+        });
+        switch (type) {
+            case 'kovan':
+            case controller_utils_1.MAINNET:
+            case 'rinkeby':
+            case 'goerli':
+            case 'ropsten':
+                this.setupInfuraProvider(type);
+                break;
+            case 'localhost':
+                this.setupStandardProvider(LOCALHOST_RPC_URL);
+                break;
+            case controller_utils_1.RPC:
+                rpcTarget &&
+                    this.setupStandardProvider(rpcTarget, chainId, ticker, nickname);
+                break;
+            default:
+                throw new Error(`Unrecognized network type: '${type}'`);
+        }
+        this.getEIP1559Compatibility();
+    }
+    refreshNetwork() {
+        this.update((state) => {
+            state.network = 'loading';
+            state.properties = {};
+        });
+        const { rpcTarget, type, chainId, ticker } = this.state.provider;
+        this.initializeProvider(type, rpcTarget, chainId, ticker);
+        this.lookupNetwork();
+    }
+    registerProvider() {
+        this.provider.on('error', this.verifyNetwork.bind(this));
+        this.ethQuery = new eth_query_1.default(this.provider);
+    }
+    setupInfuraProvider(type) {
+        const infuraProvider = (0, createProvider_1.default)({
+            network: type,
+            projectId: this.infuraProjectId,
+        });
+        const infuraSubprovider = new provider_1.default(infuraProvider);
+        const config = Object.assign(Object.assign({}, this.internalProviderConfig), {
+            dataSubprovider: infuraSubprovider,
+            engineParams: {
+                blockTrackerProvider: infuraProvider,
+                pollingInterval: 12000,
+            },
+        });
+        this.updateProvider((0, zero_1.default)(config));
+    }
+    getIsCustomNetwork(chainId) {
+        return (chainId !== controller_utils_1.NetworksChainId.mainnet &&
+            chainId !== controller_utils_1.NetworksChainId.kovan &&
+            chainId !== controller_utils_1.NetworksChainId.rinkeby &&
+            chainId !== controller_utils_1.NetworksChainId.goerli &&
+            chainId !== controller_utils_1.NetworksChainId.ropsten &&
+            chainId !== controller_utils_1.NetworksChainId.localhost);
+    }
+    setupStandardProvider(rpcTarget, chainId, ticker, nickname) {
+        const config = Object.assign(Object.assign({}, this.internalProviderConfig), {
+            chainId,
+            engineParams: { pollingInterval: 12000 },
+            nickname,
+            rpcUrl: rpcTarget,
+            ticker,
+        });
+        this.updateProvider((0, zero_1.default)(config));
+    }
+    updateProvider(provider) {
+        this.safelyStopProvider(this.provider);
+        this.provider = provider;
+        this.registerProvider();
+    }
+    safelyStopProvider(provider) {
+        setTimeout(() => {
+            provider === null || provider === void 0 ? void 0 : provider.stop();
+        }, 500);
+    }
+    verifyNetwork() {
+        this.state.network === 'loading' && this.lookupNetwork();
+    }
+    /**
+     * Sets a new configuration for web3-provider-engine.
+     *
+     * TODO: Replace this wth a method.
+     *
+     * @param providerConfig - The web3-provider-engine configuration.
+     */
+    set providerConfig(providerConfig) {
+        this.internalProviderConfig = providerConfig;
+        const { type, rpcTarget, chainId, ticker, nickname } = this.state.provider;
+        this.initializeProvider(type, rpcTarget, chainId, ticker, nickname);
+        this.registerProvider();
+        this.lookupNetwork();
+    }
+    get providerConfig() {
+        throw new Error('Property only used for setting');
+    }
+    /**
+     * Refreshes the current network code.
+     */
+    lookupNetwork() {
+        return __awaiter(this, void 0, void 0, function* () {
+            /* istanbul ignore if */
+            if (!this.ethQuery || !this.ethQuery.sendAsync) {
+                return;
+            }
+            const releaseLock = yield this.mutex.acquire();
+            this.ethQuery.sendAsync({ method: 'net_version' }, (error, network) => {
+                try {
+                    if (this.state.network === network) {
+                        return;
+                    }
+                    this.update((state) => {
+                        state.network = error
+                            ? /* istanbul ignore next*/ 'loading'
+                            : network;
+                    });
+                    this.messagingSystem.publish(`NetworkController:providerChange`, this.state.provider);
+                }
+                finally {
+                    releaseLock();
+                }
+            });
+        });
+    }
+    /**
+     * Convenience method to update provider network type settings.
+     *
+     * @param type - Human readable network name.
+     */
+    setProviderType(type) {
+        // If testnet the ticker symbol should use a testnet prefix
+        const ticker = type in controller_utils_1.TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL &&
+            controller_utils_1.TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL[type].length > 0
+            ? controller_utils_1.TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL[type]
+            : 'ETH';
+        this.update((state) => {
+            state.provider.type = type;
+            state.provider.ticker = ticker;
+            state.provider.chainId = controller_utils_1.NetworksChainId[type];
+            state.provider.rpcTarget = undefined;
+            state.provider.nickname = undefined;
+        });
+        this.refreshNetwork();
+    }
+    /**
+     * Convenience method to update provider RPC settings.
+     *
+     * @param rpcTarget - The RPC endpoint URL.
+     * @param chainId - The chain ID as per EIP-155.
+     * @param ticker - The currency ticker.
+     * @param nickname - Personalized network name.
+     */
+    setRpcTarget(rpcTarget, chainId, ticker, nickname) {
+        this.update((state) => {
+            state.provider.type = controller_utils_1.RPC;
+            state.provider.rpcTarget = rpcTarget;
+            state.provider.chainId = chainId;
+            state.provider.ticker = ticker;
+            state.provider.nickname = nickname;
+        });
+        this.refreshNetwork();
+    }
+    getEIP1559Compatibility() {
+        var _a;
+        const { properties = {} } = this.state;
+        if (!properties.isEIP1559Compatible) {
+            if (typeof ((_a = this.ethQuery) === null || _a === void 0 ? void 0 : _a.sendAsync) !== 'function') {
+                return Promise.resolve(true);
+            }
+            return new Promise((resolve, reject) => {
+                this.ethQuery.sendAsync({ method: 'eth_getBlockByNumber', params: ['latest', false] }, (error, block) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        const isEIP1559Compatible = typeof block.baseFeePerGas !== 'undefined';
+                        if (properties.isEIP1559Compatible !== isEIP1559Compatible) {
+                            this.update((state) => {
+                                state.properties.isEIP1559Compatible = isEIP1559Compatible;
+                            });
+                        }
+                        resolve(isEIP1559Compatible);
+                    }
+                });
+            });
+        }
+        return Promise.resolve(true);
+    }
+}
+exports.NetworkController = NetworkController;
+exports.default = NetworkController;
+//# sourceMappingURL=NetworkController.js.map

package/dist/NetworkController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkController.js","sourceRoot":"","sources":["../src/NetworkController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,0DAAiC;AACjC,0FAAqE;AACrE,4FAA0E;AAC1E,qEAA+D;AAC/D,6CAAoC;AAEpC,+DAGmC;AACnC,iEAMoC;AA2CpC,MAAM,iBAAiB,GAAG,uBAAuB,CAAC;AAElD,MAAM,IAAI,GAAG,mBAAmB,CAAC;AAsCjC,MAAM,YAAY,GAAiB;IACjC,OAAO,EAAE,SAAS;IAClB,eAAe,EAAE,KAAK;IACtB,QAAQ,EAAE,EAAE,IAAI,EAAE,0BAAO,EAAE,OAAO,EAAE,kCAAe,CAAC,OAAO,EAAE;IAC7D,UAAU,EAAE,EAAE,mBAAmB,EAAE,KAAK,EAAE;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAa,iBAAkB,SAAQ,kCAItC;IASC,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,eAAe,EAA4B;QACzE,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ,EAAE;gBACR,OAAO,EAAE;oBACP,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;gBACD,UAAU,EAAE;oBACV,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;gBACD,QAAQ,EAAE;oBACR,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,KAAK;iBACjB;aACF;YACD,SAAS;YACT,KAAK,kCAAO,YAAY,GAAK,KAAK,CAAE;SACrC,CAAC,CAAC;QA7BG,2BAAsB,GAAmB,EAAoB,CAAC;QAI9D,UAAK,GAAG,IAAI,mBAAK,EAAE,CAAC;QA0B1B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,IAAI,CAAC,IAAI,oBAAoB,EAChC,GAAG,EAAE;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC7B,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,IAAI,CAAC,IAAI,cAAc,EAC1B,GAAG,EAAE;YACH,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,kBAAkB,CACxB,IAAiB,EACjB,SAAkB,EAClB,OAAgB,EAChB,MAAe,EACf,QAAiB;QAEjB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,QAAQ,IAAI,EAAE;YACZ,KAAK,OAAO,CAAC;YACb,KAAK,0BAAO,CAAC;YACb,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS;gBACZ,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,WAAW;gBACd,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;gBAC9C,MAAM;YACR,KAAK,sBAAG;gBACN,SAAS;oBACP,IAAI,CAAC,qBAAqB,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;gBACnE,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,GAAG,CAAC,CAAC;SAC3D;QACD,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEO,cAAc;QACpB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;YAC1B,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;QACjE,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1D,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,gBAAgB;QACtB,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAEO,mBAAmB,CAAC,IAAiB;QAC3C,MAAM,cAAc,GAAG,IAAA,wBAAoB,EAAC;YAC1C,OAAO,EAAE,IAAI;YACb,SAAS,EAAE,IAAI,CAAC,eAAe;SAChC,CAAC,CAAC;QACH,MAAM,iBAAiB,GAAG,IAAI,kBAAW,CAAC,cAAc,CAAC,CAAC;QAC1D,MAAM,MAAM,mCACP,IAAI,CAAC,sBAAsB,GAC3B;YACD,eAAe,EAAE,iBAAiB;YAClC,YAAY,EAAE;gBACZ,oBAAoB,EAAE,cAAc;gBACpC,eAAe,EAAE,KAAK;aACvB;SACF,CACF,CAAC;QACF,IAAI,CAAC,cAAc,CAAC,IAAA,cAAsB,EAAC,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IAEO,kBAAkB,CAAC,OAAgB;QACzC,OAAO,CACL,OAAO,KAAK,kCAAe,CAAC,OAAO;YACnC,OAAO,KAAK,kCAAe,CAAC,KAAK;YACjC,OAAO,KAAK,kCAAe,CAAC,OAAO;YACnC,OAAO,KAAK,kCAAe,CAAC,MAAM;YAClC,OAAO,KAAK,kCAAe,CAAC,OAAO;YACnC,OAAO,KAAK,kCAAe,CAAC,SAAS,CACtC,CAAC;IACJ,CAAC;IAEO,qBAAqB,CAC3B,SAAiB,EACjB,OAAgB,EAChB,MAAe,EACf,QAAiB;QAEjB,MAAM,MAAM,mCACP,IAAI,CAAC,sBAAsB,GAC3B;YACD,OAAO;YACP,YAAY,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE;YACxC,QAAQ;YACR,MAAM,EAAE,SAAS;YACjB,MAAM;SACP,CACF,CAAC;QACF,IAAI,CAAC,cAAc,CAAC,IAAA,cAAsB,EAAC,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IAEO,cAAc,CAAC,QAAa;QAClC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IAEO,kBAAkB,CAAC,QAAa;QACtC,UAAU,CAAC,GAAG,EAAE;YACd,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,EAAE,CAAC;QACnB,CAAC,EAAE,GAAG,CAAC,CAAC;IACV,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;IAC3D,CAAC;IAOD;;;;;;OAMG;IACH,IAAI,cAAc,CAAC,cAA8B;QAC/C,IAAI,CAAC,sBAAsB,GAAG,cAAc,CAAC;QAC7C,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC3E,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QACpE,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAED,IAAI,cAAc;QAChB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACG,aAAa;;YACjB,wBAAwB;YACxB,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;gBAC9C,OAAO;aACR;YACD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YAC/C,IAAI,CAAC,QAAQ,CAAC,SAAS,CACrB,EAAE,MAAM,EAAE,aAAa,EAAE,EACzB,CAAC,KAAY,EAAE,OAAe,EAAE,EAAE;gBAChC,IAAI;oBACF,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,EAAE;wBAClC,OAAO;qBACR;oBAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;wBACpB,KAAK,CAAC,OAAO,GAAG,KAAK;4BACnB,CAAC,CAAC,yBAAyB,CAAC,SAAS;4BACrC,CAAC,CAAC,OAAO,CAAC;oBACd,CAAC,CAAC,CAAC;oBAEH,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,kCAAkC,EAClC,IAAI,CAAC,KAAK,CAAC,QAAQ,CACpB,CAAC;iBACH;wBAAS;oBACR,WAAW,EAAE,CAAC;iBACf;YACH,CAAC,CACF,CAAC;QACJ,CAAC;KAAA;IAED;;;;OAIG;IACH,eAAe,CAAC,IAAiB;QAC/B,2DAA2D;QAC3D,MAAM,MAAM,GACV,IAAI,IAAI,wDAAqC;YAC7C,wDAAqC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC;YACpD,CAAC,CAAC,wDAAqC,CAAC,IAAI,CAAC;YAC7C,CAAC,CAAC,KAAK,CAAC;QAEZ,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;YAC3B,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;YAC/B,KAAK,CAAC,QAAQ,CAAC,OAAO,GAAG,kCAAe,CAAC,IAAI,CAAC,CAAC;YAC/C,KAAK,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC;YACrC,KAAK,CAAC,QAAQ,CAAC,QAAQ,GAAG,SAAS,CAAC;QACtC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CACV,SAAiB,EACjB,OAAe,EACf,MAAe,EACf,QAAiB;QAEjB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,QAAQ,CAAC,IAAI,GAAG,sBAAG,CAAC;YAC1B,KAAK,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC;YACrC,KAAK,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;YACjC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;YAC/B,KAAK,CAAC,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAED,uBAAuB;;QACrB,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEvC,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE;YACnC,IAAI,OAAO,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,SAAS,CAAA,KAAK,UAAU,EAAE;gBAClD,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aAC9B;YACD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,IAAI,CAAC,QAAQ,CAAC,SAAS,CACrB,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAC7D,CAAC,KAAY,EAAE,KAAY,EAAE,EAAE;oBAC7B,IAAI,KAAK,EAAE;wBACT,MAAM,CAAC,KAAK,CAAC,CAAC;qBACf;yBAAM;wBACL,MAAM,mBAAmB,GACvB,OAAO,KAAK,CAAC,aAAa,KAAK,WAAW,CAAC;wBAC7C,IAAI,UAAU,CAAC,mBAAmB,KAAK,mBAAmB,EAAE;4BAC1D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gCACpB,KAAK,CAAC,UAAU,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;4BAC7D,CAAC,CAAC,CAAC;yBACJ;wBACD,OAAO,CAAC,mBAAmB,CAAC,CAAC;qBAC9B;gBACH,CAAC,CACF,CAAC;YACJ,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF;AA3SD,8CA2SC;AAED,kBAAe,iBAAiB,CAAC","sourcesContent":["import EthQuery from 'eth-query';\nimport Subprovider from 'web3-provider-engine/subproviders/provider';\nimport createInfuraProvider from 'eth-json-rpc-infura/src/createProvider';\nimport createMetamaskProvider from 'web3-provider-engine/zero';\nimport { Mutex } from 'async-mutex';\nimport type { Patch } from 'immer';\nimport {\n  BaseControllerV2,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport {\n  MAINNET,\n  RPC,\n  TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL,\n  NetworksChainId,\n  NetworkType,\n} from '@metamask/controller-utils';\n\n/**\n * @type ProviderConfig\n *\n * Configuration passed to web3-provider-engine\n * @property rpcTarget - RPC target URL.\n * @property type - Human-readable network name.\n * @property chainId - Network ID as per EIP-155.\n * @property ticker - Currency ticker.\n * @property nickname - Personalized network name.\n */\nexport type ProviderConfig = {\n  rpcTarget?: string;\n  type: NetworkType;\n  chainId: string;\n  ticker?: string;\n  nickname?: string;\n};\n\nexport type Block = {\n  baseFeePerGas?: string;\n};\n\nexport type NetworkProperties = {\n  isEIP1559Compatible?: boolean;\n};\n\n/**\n * @type NetworkState\n *\n * Network controller state\n * @property network - Network ID as per net_version\n * @property isCustomNetwork - Identifies if the network is a custom network\n * @property provider - RPC URL and network name provider settings\n */\nexport type NetworkState = {\n  network: string;\n  isCustomNetwork: boolean;\n  provider: ProviderConfig;\n  properties: NetworkProperties;\n};\n\nconst LOCALHOST_RPC_URL = 'http://localhost:8545';\n\nconst name = 'NetworkController';\n\nexport type EthQuery = any;\n\nexport type NetworkControllerStateChangeEvent = {\n  type: `NetworkController:stateChange`;\n  payload: [NetworkState, Patch[]];\n};\n\nexport type NetworkControllerProviderChangeEvent = {\n  type: `NetworkController:providerChange`;\n  payload: [ProviderConfig];\n};\n\nexport type NetworkControllerGetProviderConfigAction = {\n  type: `NetworkController:getProviderConfig`;\n  handler: () => ProviderConfig;\n};\n\nexport type NetworkControllerGetEthQueryAction = {\n  type: `NetworkController:getEthQuery`;\n  handler: () => EthQuery;\n};\n\nexport type NetworkControllerMessenger = RestrictedControllerMessenger<\n  typeof name,\n  NetworkControllerGetProviderConfigAction | NetworkControllerGetEthQueryAction,\n  NetworkControllerStateChangeEvent | NetworkControllerProviderChangeEvent,\n  string,\n  string\n>;\n\nexport type NetworkControllerOptions = {\n  messenger: NetworkControllerMessenger;\n  infuraProjectId?: string;\n  state?: Partial<NetworkState>;\n};\n\nconst defaultState: NetworkState = {\n  network: 'loading',\n  isCustomNetwork: false,\n  provider: { type: MAINNET, chainId: NetworksChainId.mainnet },\n  properties: { isEIP1559Compatible: false },\n};\n\n/**\n * Controller that creates and manages an Ethereum network provider.\n */\nexport class NetworkController extends BaseControllerV2<\n  typeof name,\n  NetworkState,\n  NetworkControllerMessenger\n> {\n  private ethQuery: EthQuery;\n\n  private internalProviderConfig: ProviderConfig = {} as ProviderConfig;\n\n  private infuraProjectId: string | undefined;\n\n  private mutex = new Mutex();\n\n  constructor({ messenger, state, infuraProjectId }: NetworkControllerOptions) {\n    super({\n      name,\n      metadata: {\n        network: {\n          persist: true,\n          anonymous: false,\n        },\n        isCustomNetwork: {\n          persist: true,\n          anonymous: false,\n        },\n        properties: {\n          persist: true,\n          anonymous: false,\n        },\n        provider: {\n          persist: true,\n          anonymous: false,\n        },\n      },\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.infuraProjectId = infuraProjectId;\n    this.messagingSystem.registerActionHandler(\n      `${this.name}:getProviderConfig`,\n      () => {\n        return this.state.provider;\n      },\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${this.name}:getEthQuery`,\n      () => {\n        return this.ethQuery;\n      },\n    );\n  }\n\n  private initializeProvider(\n    type: NetworkType,\n    rpcTarget?: string,\n    chainId?: string,\n    ticker?: string,\n    nickname?: string,\n  ) {\n    this.update((state) => {\n      state.isCustomNetwork = this.getIsCustomNetwork(chainId);\n    });\n\n    switch (type) {\n      case 'kovan':\n      case MAINNET:\n      case 'rinkeby':\n      case 'goerli':\n      case 'ropsten':\n        this.setupInfuraProvider(type);\n        break;\n      case 'localhost':\n        this.setupStandardProvider(LOCALHOST_RPC_URL);\n        break;\n      case RPC:\n        rpcTarget &&\n          this.setupStandardProvider(rpcTarget, chainId, ticker, nickname);\n        break;\n      default:\n        throw new Error(`Unrecognized network type: '${type}'`);\n    }\n    this.getEIP1559Compatibility();\n  }\n\n  private refreshNetwork() {\n    this.update((state) => {\n      state.network = 'loading';\n      state.properties = {};\n    });\n    const { rpcTarget, type, chainId, ticker } = this.state.provider;\n    this.initializeProvider(type, rpcTarget, chainId, ticker);\n    this.lookupNetwork();\n  }\n\n  private registerProvider() {\n    this.provider.on('error', this.verifyNetwork.bind(this));\n    this.ethQuery = new EthQuery(this.provider);\n  }\n\n  private setupInfuraProvider(type: NetworkType) {\n    const infuraProvider = createInfuraProvider({\n      network: type,\n      projectId: this.infuraProjectId,\n    });\n    const infuraSubprovider = new Subprovider(infuraProvider);\n    const config = {\n      ...this.internalProviderConfig,\n      ...{\n        dataSubprovider: infuraSubprovider,\n        engineParams: {\n          blockTrackerProvider: infuraProvider,\n          pollingInterval: 12000,\n        },\n      },\n    };\n    this.updateProvider(createMetamaskProvider(config));\n  }\n\n  private getIsCustomNetwork(chainId?: string) {\n    return (\n      chainId !== NetworksChainId.mainnet &&\n      chainId !== NetworksChainId.kovan &&\n      chainId !== NetworksChainId.rinkeby &&\n      chainId !== NetworksChainId.goerli &&\n      chainId !== NetworksChainId.ropsten &&\n      chainId !== NetworksChainId.localhost\n    );\n  }\n\n  private setupStandardProvider(\n    rpcTarget: string,\n    chainId?: string,\n    ticker?: string,\n    nickname?: string,\n  ) {\n    const config = {\n      ...this.internalProviderConfig,\n      ...{\n        chainId,\n        engineParams: { pollingInterval: 12000 },\n        nickname,\n        rpcUrl: rpcTarget,\n        ticker,\n      },\n    };\n    this.updateProvider(createMetamaskProvider(config));\n  }\n\n  private updateProvider(provider: any) {\n    this.safelyStopProvider(this.provider);\n    this.provider = provider;\n    this.registerProvider();\n  }\n\n  private safelyStopProvider(provider: any) {\n    setTimeout(() => {\n      provider?.stop();\n    }, 500);\n  }\n\n  private verifyNetwork() {\n    this.state.network === 'loading' && this.lookupNetwork();\n  }\n\n  /**\n   * Ethereum provider object for the current network\n   */\n  provider: any;\n\n  /**\n   * Sets a new configuration for web3-provider-engine.\n   *\n   * TODO: Replace this wth a method.\n   *\n   * @param providerConfig - The web3-provider-engine configuration.\n   */\n  set providerConfig(providerConfig: ProviderConfig) {\n    this.internalProviderConfig = providerConfig;\n    const { type, rpcTarget, chainId, ticker, nickname } = this.state.provider;\n    this.initializeProvider(type, rpcTarget, chainId, ticker, nickname);\n    this.registerProvider();\n    this.lookupNetwork();\n  }\n\n  get providerConfig() {\n    throw new Error('Property only used for setting');\n  }\n\n  /**\n   * Refreshes the current network code.\n   */\n  async lookupNetwork() {\n    /* istanbul ignore if */\n    if (!this.ethQuery || !this.ethQuery.sendAsync) {\n      return;\n    }\n    const releaseLock = await this.mutex.acquire();\n    this.ethQuery.sendAsync(\n      { method: 'net_version' },\n      (error: Error, network: string) => {\n        try {\n          if (this.state.network === network) {\n            return;\n          }\n\n          this.update((state) => {\n            state.network = error\n              ? /* istanbul ignore next*/ 'loading'\n              : network;\n          });\n\n          this.messagingSystem.publish(\n            `NetworkController:providerChange`,\n            this.state.provider,\n          );\n        } finally {\n          releaseLock();\n        }\n      },\n    );\n  }\n\n  /**\n   * Convenience method to update provider network type settings.\n   *\n   * @param type - Human readable network name.\n   */\n  setProviderType(type: NetworkType) {\n    // If testnet the ticker symbol should use a testnet prefix\n    const ticker =\n      type in TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL &&\n      TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL[type].length > 0\n        ? TESTNET_NETWORK_TYPE_TO_TICKER_SYMBOL[type]\n        : 'ETH';\n\n    this.update((state) => {\n      state.provider.type = type;\n      state.provider.ticker = ticker;\n      state.provider.chainId = NetworksChainId[type];\n      state.provider.rpcTarget = undefined;\n      state.provider.nickname = undefined;\n    });\n    this.refreshNetwork();\n  }\n\n  /**\n   * Convenience method to update provider RPC settings.\n   *\n   * @param rpcTarget - The RPC endpoint URL.\n   * @param chainId - The chain ID as per EIP-155.\n   * @param ticker - The currency ticker.\n   * @param nickname - Personalized network name.\n   */\n  setRpcTarget(\n    rpcTarget: string,\n    chainId: string,\n    ticker?: string,\n    nickname?: string,\n  ) {\n    this.update((state) => {\n      state.provider.type = RPC;\n      state.provider.rpcTarget = rpcTarget;\n      state.provider.chainId = chainId;\n      state.provider.ticker = ticker;\n      state.provider.nickname = nickname;\n    });\n    this.refreshNetwork();\n  }\n\n  getEIP1559Compatibility() {\n    const { properties = {} } = this.state;\n\n    if (!properties.isEIP1559Compatible) {\n      if (typeof this.ethQuery?.sendAsync !== 'function') {\n        return Promise.resolve(true);\n      }\n      return new Promise((resolve, reject) => {\n        this.ethQuery.sendAsync(\n          { method: 'eth_getBlockByNumber', params: ['latest', false] },\n          (error: Error, block: Block) => {\n            if (error) {\n              reject(error);\n            } else {\n              const isEIP1559Compatible =\n                typeof block.baseFeePerGas !== 'undefined';\n              if (properties.isEIP1559Compatible !== isEIP1559Compatible) {\n                this.update((state) => {\n                  state.properties.isEIP1559Compatible = isEIP1559Compatible;\n                });\n              }\n              resolve(isEIP1559Compatible);\n            }\n          },\n        );\n      });\n    }\n    return Promise.resolve(true);\n  }\n}\n\nexport default NetworkController;\n"]}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './NetworkController';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./NetworkController"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC","sourcesContent":["export * from './NetworkController';\n"]}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@metamask/network-controller",
+  "version": "1.0.0",
+  "description": "Provides an interface to the currently selected network via a MetaMask-compatible provider object",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/controllers/tree/main/packages/network-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/controllers/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/controllers.git"
+  },
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build:docs": "typedoc",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/network-controller",
+    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "~1.0.0",
+    "@metamask/controller-utils": "~1.0.0",
+    "async-mutex": "^0.2.6",
+    "babel-runtime": "^6.26.0",
+    "eth-json-rpc-infura": "^5.1.0",
+    "eth-query": "^2.1.2",
+    "immer": "^9.0.6",
+    "web3-provider-engine": "^16.0.3"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.1.0",
+    "@types/jest": "^26.0.22",
+    "deepmerge": "^4.2.2",
+    "jest": "^26.4.2",
+    "sinon": "^9.2.4",
+    "ts-jest": "^26.5.2",
+    "typedoc": "^0.22.15",
+    "typedoc-plugin-missing-exports": "^0.22.6",
+    "typescript": "~4.6.3"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}