Merge branch 'main' into refactor/973-throw-rpc-error-validation

MetaMask · Sep 26, 2023 · dba7fa2 · dba7fa2
2 parents 094c55d + c06ea78
commit dba7fa2
Show file tree

Hide file tree

Showing 27 changed files with 3,879 additions and 6,081 deletions.
diff --git a/packages/assets-controllers/src/NftDetectionController.ts b/packages/assets-controllers/src/NftDetectionController.ts
@@ -115,9 +115,8 @@ export interface ApiNftCreator {
  *
  * NftDetection configuration
  * @property interval - Polling interval used to fetch new token rates
- * @property networkType - Network type ID as per net_version
+ * @property chainId - Current chain ID
  * @property selectedAddress - Vault selected address
- * @property tokens - List of tokens associated with the active vault
  */
 export interface NftDetectionConfig extends BaseConfig {
   interval: number;

diff --git a/packages/assets-controllers/src/TokenListController.test.ts b/packages/assets-controllers/src/TokenListController.test.ts
@@ -519,7 +519,6 @@ function buildNetworkControllerStateWithProviderConfig(
   return {
     selectedNetworkClientId,
     providerConfig,
-    networkId: '1',
     networksMetadata: {
       [selectedNetworkClientId]: {
         EIPS: {},

diff --git a/packages/controller-utils/src/constants.ts b/packages/controller-utils/src/constants.ts
@@ -1,4 +1,9 @@
-import { NetworkType, NetworksTicker, ChainId, NetworkId } from './types';
+import {
+  NetworkType,
+  NetworksTicker,
+  ChainId,
+  BuiltInNetworkName,
+} from './types';
 
 export const RPC = 'rpc';
 export const FALL_BACK_VS_CURRENCY = 'ETH';
@@ -125,13 +130,14 @@ export enum ApprovalType {
   WatchAsset = 'wallet_watchAsset',
 }
 
-export const NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP: Record<
-  NetworkId,
-  NetworkType
+export const CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP: Record<
+  ChainId,
+  BuiltInNetworkName
 > = {
-  [NetworkId.goerli]: NetworkType.goerli,
-  [NetworkId.sepolia]: NetworkType.sepolia,
-  [NetworkId.mainnet]: NetworkType.mainnet,
-  [NetworkId['linea-goerli']]: NetworkType['linea-goerli'],
-  [NetworkId['linea-mainnet']]: NetworkType['linea-mainnet'],
+  [ChainId.goerli]: BuiltInNetworkName.Goerli,
+  [ChainId.sepolia]: BuiltInNetworkName.Sepolia,
+  [ChainId.mainnet]: BuiltInNetworkName.Mainnet,
+  [ChainId['linea-goerli']]: BuiltInNetworkName.LineaGoerli,
+  [ChainId['linea-mainnet']]: BuiltInNetworkName.LineaMainnet,
+  [ChainId.aurora]: BuiltInNetworkName.Aurora,
 };
diff --git a/packages/controller-utils/src/types.ts b/packages/controller-utils/src/types.ts
@@ -61,18 +61,6 @@ export const ChainId = {
 } as const;
 export type ChainId = (typeof ChainId)[keyof typeof ChainId];
 
-/**
- * Decimal string network IDs of built-in Infura networks, by name.
- */
-export const NetworkId = {
-  [InfuraNetworkType.mainnet]: '1',
-  [InfuraNetworkType.goerli]: '5',
-  [InfuraNetworkType.sepolia]: '11155111',
-  [InfuraNetworkType['linea-goerli']]: '59140',
-  [InfuraNetworkType['linea-mainnet']]: '59144',
-} as const;
-export type NetworkId = (typeof NetworkId)[keyof typeof NetworkId];
-
 export enum NetworksTicker {
   mainnet = 'ETH',
   goerli = 'GoerliETH',

diff --git a/packages/ens-controller/src/EnsController.test.ts b/packages/ens-controller/src/EnsController.test.ts
@@ -119,7 +119,6 @@ describe('EnsController', () => {
       provider: getProvider(),
       onNetworkStateChange: (listener) => {
         listener({
-          networkId: '1',
           providerConfig: {
             chainId: toHex(1),
             type: NetworkType.mainnet,
@@ -445,7 +444,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: null,
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -464,9 +462,8 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1544',
             providerConfig: {
-              chainId: toHex(1),
+              chainId: toHex(0),
               type: NetworkType.mainnet,
               ticker: NetworksTicker.mainnet,
             },
@@ -490,7 +487,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -514,7 +510,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -537,7 +532,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -563,7 +557,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -589,7 +582,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -617,7 +609,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,
@@ -644,7 +635,6 @@ describe('EnsController', () => {
         provider: getProvider(),
         onNetworkStateChange: (listener) => {
           listener({
-            networkId: '1',
             providerConfig: {
               chainId: toHex(1),
               type: NetworkType.mainnet,

diff --git a/packages/ens-controller/src/EnsController.ts b/packages/ens-controller/src/EnsController.ts
@@ -5,36 +5,22 @@ import type {
 import { Web3Provider } from '@ethersproject/providers';
 import type { RestrictedControllerMessenger } from '@metamask/base-controller';
 import { BaseControllerV2 } from '@metamask/base-controller';
+import type { ChainId } from '@metamask/controller-utils';
 import {
   normalizeEnsName,
   isValidHexAddress,
   toChecksumHexAddress,
-  NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP,
+  CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP,
   convertHexToDecimal,
 } from '@metamask/controller-utils';
 import type { NetworkState } from '@metamask/network-controller';
 import type { Hex } from '@metamask/utils';
-import { createProjectLogger, hasProperty } from '@metamask/utils';
+import { createProjectLogger } from '@metamask/utils';
 import ensNetworkMap from 'ethereum-ens-network-map';
 import { toASCII } from 'punycode/';
 
 const log = createProjectLogger('ens-controller');
 
-/**
- * Checks whether the given string is a known network ID.
- *
- * @param networkId - Network id.
- * @returns Boolean indicating if the network ID is recognized.
- */
-function isKnownNetworkId(
-  networkId: string | null,
-): networkId is keyof typeof NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP {
-  return (
-    networkId !== null &&
-    hasProperty(NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP, networkId)
-  );
-}
-
 const name = 'EnsController';
 
 /**
@@ -118,9 +104,7 @@ export class EnsController extends BaseControllerV2<
     state?: Partial<EnsControllerState>;
     provider?: ExternalProvider | JsonRpcFetchFunc;
     onNetworkStateChange?: (
-      listener: (
-        networkState: Pick<NetworkState, 'networkId' | 'providerConfig'>,
-      ) => void,
+      listener: (networkState: Pick<NetworkState, 'providerConfig'>) => void,
     ) => void;
   }) {
     super({
@@ -136,15 +120,14 @@ export class EnsController extends BaseControllerV2<
     if (provider && onNetworkStateChange) {
       onNetworkStateChange((networkState) => {
         this.resetState();
-        const currentNetwork = networkState.networkId;
-        if (
-          isKnownNetworkId(currentNetwork) &&
-          this.#getNetworkEnsSupport(currentNetwork)
-        ) {
+        const currentChainId = networkState.providerConfig.chainId;
+        if (this.#getChainEnsSupport(currentChainId)) {
           this.#ethProvider = new Web3Provider(provider, {
-            chainId: convertHexToDecimal(networkState.providerConfig.chainId),
-            name: NETWORK_ID_TO_ETHERS_NETWORK_NAME_MAP[currentNetwork],
-            ensAddress: ensNetworkMap[currentNetwork],
+            chainId: convertHexToDecimal(currentChainId),
+            name: CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP[
+              currentChainId as ChainId
+            ],
+            ensAddress: ensNetworkMap[parseInt(currentChainId, 16)],
           });
         } else {
           this.#ethProvider = null;
@@ -269,13 +252,13 @@ export class EnsController extends BaseControllerV2<
   }
 
   /**
-   * Check if network supports ENS.
+   * Check if the chain supports ENS.
    *
-   * @param networkId - Network id.
-   * @returns Boolean indicating if the network supports ENS.
+   * @param chainId - chain id.
+   * @returns Boolean indicating if the chain supports ENS.
    */
-  #getNetworkEnsSupport(networkId: string) {
-    return Boolean(ensNetworkMap[networkId]);
+  #getChainEnsSupport(chainId: string) {
+    return Boolean(ensNetworkMap[parseInt(chainId, 16)]);
   }
 
   /**

diff --git a/packages/gas-fee-controller/src/GasFeeController.test.ts b/packages/gas-fee-controller/src/GasFeeController.test.ts
@@ -77,8 +77,8 @@ const setupNetworkController = async ({
   // Call this without awaiting to simulate what the extension or mobile app
   // might do
   networkController.initializeProvider();
-  // Ensure that the request for net_version that the network controller makes
-  // goes through
+  // Ensure that the request for eth_getBlockByNumber made by the PollingBlockTracker
+  // inside the NetworkController goes through
   await clock.nextAsync();
 
   return networkController;