Replace NetworksChainId constant with ChainId

The constant `NetworksChainId` was ambiguous in whether it referred to network or chain Ids, and it didn't match our enum naming conventions. It was also undocumented, and unclear in which networks it was intended to contain. It has been replaced with a `ChainId` constant with documentation and a clear scope (built-in networks). A `BuiltInNetworks` enum has been added as well to make that more clear. Relates to #1209
MetaMask · May 9, 2023 · d4daa70 · d4daa70
1 parent 9e26a16
commit d4daa70
Show file tree

Hide file tree

Showing 11 changed files with 144 additions and 147 deletions.
diff --git a/packages/assets-controllers/src/NftController.test.ts b/packages/assets-controllers/src/NftController.test.ts
@@ -13,7 +13,7 @@ import {
   ERC1155,
   OPENSEA_API_URL,
   ERC721,
-  NetworksChainId,
+  ChainId,
   NetworkType,
 } from '@metamask/controller-utils';
 import { Network } from '@ethersproject/providers';
@@ -799,15 +799,11 @@ describe('NftController', () => {
       changeNetwork(SEPOLIA);
 
       expect(
-        nftController.state.allNfts[selectedAddress]?.[
-          NetworksChainId[GOERLI.type]
-        ],
+        nftController.state.allNfts[selectedAddress]?.[ChainId[GOERLI.type]],
       ).toBeUndefined();
 
       expect(
-        nftController.state.allNfts[selectedAddress][
-          NetworksChainId[SEPOLIA.type]
-        ][0],
+        nftController.state.allNfts[selectedAddress][ChainId[SEPOLIA.type]][0],
       ).toStrictEqual({
         address: '0x01',
         description: 'description',

diff --git a/packages/assets-controllers/src/TokenDetectionController.test.ts b/packages/assets-controllers/src/TokenDetectionController.test.ts
@@ -7,7 +7,7 @@ import {
   NetworkState,
   ProviderConfig,
 } from '@metamask/network-controller';
-import { NetworksChainId, NetworkType } from '@metamask/controller-utils';
+import { ChainId, NetworkType } from '@metamask/controller-utils';
 import { PreferencesController } from '@metamask/preferences-controller';
 import { ControllerMessenger } from '@metamask/base-controller';
 import {
@@ -108,7 +108,7 @@ const setupTokenListController = (
   });
 
   const tokenList = new TokenListController({
-    chainId: NetworksChainId.mainnet,
+    chainId: ChainId.mainnet,
     preventPollingOnNetworkRestart: false,
     messenger: tokenListMessenger,
   });
@@ -137,21 +137,17 @@ describe('TokenDetectionController', () => {
     });
   };
   const mainnet = {
-    chainId: NetworksChainId.mainnet,
+    chainId: ChainId.mainnet,
     type: NetworkType.mainnet,
   };
 
   beforeEach(async () => {
     nock(TOKEN_END_POINT_API)
-      .get(`/tokens/${NetworksChainId.mainnet}`)
+      .get(`/tokens/${ChainId.mainnet}`)
       .reply(200, sampleTokenList)
-      .get(
-        `/token/${NetworksChainId.mainnet}?address=${tokenAFromList.address}`,
-      )
+      .get(`/token/${ChainId.mainnet}?address=${tokenAFromList.address}`)
       .reply(200, tokenAFromList)
-      .get(
-        `/token/${NetworksChainId.mainnet}?address=${tokenBFromList.address}`,
-      )
+      .get(`/token/${ChainId.mainnet}?address=${tokenBFromList.address}`)
       .reply(200, tokenBFromList)
       .persist();
 
@@ -211,7 +207,7 @@ describe('TokenDetectionController', () => {
       interval: DEFAULT_INTERVAL,
       selectedAddress: '',
       disabled: true,
-      chainId: NetworksChainId.mainnet,
+      chainId: ChainId.mainnet,
       isDetectionEnabledForNetwork: true,
       isDetectionEnabledFromPreferences: true,
     });
@@ -245,7 +241,7 @@ describe('TokenDetectionController', () => {
     expect(
       isTokenDetectionSupportedForNetwork(tokenDetection.config.chainId),
     ).toStrictEqual(true);
-    tokenDetection.configure({ chainId: NetworksChainId.goerli });
+    tokenDetection.configure({ chainId: ChainId.goerli });
     expect(
       isTokenDetectionSupportedForNetwork(tokenDetection.config.chainId),
     ).toStrictEqual(false);
@@ -254,7 +250,7 @@ describe('TokenDetectionController', () => {
   it('should not autodetect while not on supported networks', async () => {
     tokenDetection.configure({
       selectedAddress: '0x1',
-      chainId: NetworksChainId.goerli,
+      chainId: ChainId.goerli,
       isDetectionEnabledForNetwork: false,
     });
 
@@ -278,7 +274,7 @@ describe('TokenDetectionController', () => {
 
   it('should detect tokens correctly on the Aurora network', async () => {
     const auroraMainnet = {
-      chainId: NetworksChainId.aurora,
+      chainId: ChainId.aurora,
       type: NetworkType.mainnet,
     };
     preferences.update({ selectedAddress: '0x1' });
@@ -440,7 +436,7 @@ describe('TokenDetectionController', () => {
         isDetectionEnabledForNetwork: true,
         isDetectionEnabledFromPreferences: true,
         selectedAddress: '0x1',
-        chainId: NetworksChainId.mainnet,
+        chainId: ChainId.mainnet,
       },
     );
 
@@ -556,7 +552,7 @@ describe('TokenDetectionController', () => {
 
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     await networkStateChangeListener!({
-      providerConfig: { chainId: NetworksChainId.mainnet },
+      providerConfig: { chainId: ChainId.mainnet },
     });
 
     expect(getBalancesInSingleCallMock.called).toBe(true);