fix: fix PR comments

Author: salimtb

packages/assets-controllers/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Updated `NftController` and `NftDetectionController` to eliminate the dependency on the current chain.
+  - All functions that previously accepted networkClientId as an optional parameter now require it as a mandatory parameter
+
 ## [56.0.0]
 
 ### Changed

packages/network-controller/src/NetworkController.ts

@@ -17,6 +17,7 @@ import {
   BUILT_IN_NETWORKS,
   BuiltInNetworkName,
 } from '@metamask/controller-utils';
+import type { PollingBlockTrackerOptions } from '@metamask/eth-block-tracker';
 import EthQuery from '@metamask/eth-query';
 import { errorCodes } from '@metamask/rpc-errors';
 import { createEventEmitterProxy } from '@metamask/swappable-obj-proxy';
@@ -512,11 +513,6 @@ export type NetworkControllerGetNetworkClientByIdAction = {
   handler: NetworkController['getNetworkClientById'];
 };
 
-export type NetworkControllerGetNetworkClientIdByChainIdAction = {
-  type: `NetworkController:getNetworkClientIdByChainId`;
-  handler: NetworkController['getNetworkClientIdByChainId'];
-};
-
 export type NetworkControllerGetSelectedNetworkClientAction = {
   type: `NetworkController:getSelectedNetworkClient`;
   handler: NetworkController['getSelectedNetworkClient'];
@@ -592,8 +588,7 @@ export type NetworkControllerActions =
   | NetworkControllerGetNetworkConfigurationByNetworkClientId
   | NetworkControllerAddNetworkAction
   | NetworkControllerRemoveNetworkAction
-  | NetworkControllerUpdateNetworkAction
-  | NetworkControllerGetNetworkClientIdByChainIdAction;
+  | NetworkControllerUpdateNetworkAction;
 
 export type NetworkControllerMessenger = RestrictedMessenger<
   typeof controllerName,
@@ -627,16 +622,23 @@ export type NetworkControllerOptions = {
    */
   log?: Logger;
   /**
-   * A function that can be used to customize the options passed to a
-   * RPC service constructed for an RPC endpoint. The object that the function
-   * should return is the same as {@link RpcServiceOptions}, except that
-   * `failoverService` and `endpointUrl` are not accepted (as they are filled in
-   * automatically).
+   * A function that can be used to customize a RPC service constructed for an
+   * RPC endpoint. The function takes the URL of the endpoint and should return
+   * an object with type {@link RpcServiceOptions}, minus `failoverService`
+   * and `endpointUrl` (as they are filled in automatically).
    */
   getRpcServiceOptions: (
     rpcEndpointUrl: string,
   ) => Omit<RpcServiceOptions, 'failoverService' | 'endpointUrl'>;
-
+  /**
+   * A function that can be used to customize a block tracker constructed for an
+   * RPC endpoint. The function takes the URL of the endpoint and should return
+   * an object of type {@link PollingBlockTrackerOptions}, minus `provider` (as
+   * it is filled in automatically).
+   */
+  getBlockTrackerOptions?: (
+    rpcEndpointUrl: string,
+  ) => Omit<PollingBlockTrackerOptions, 'provider'>;
   /**
    * An array of Hex Chain IDs representing the additional networks to be included as default.
    */
@@ -1086,6 +1088,8 @@ export class NetworkController extends BaseController<
 
   readonly #getRpcServiceOptions: NetworkControllerOptions['getRpcServiceOptions'];
 
+  readonly #getBlockTrackerOptions: NetworkControllerOptions['getBlockTrackerOptions'];
+
   #networkConfigurationsByNetworkClientId: Map<
     NetworkClientId,
     NetworkConfiguration
@@ -1103,6 +1107,7 @@ export class NetworkController extends BaseController<
       infuraProjectId,
       log,
       getRpcServiceOptions,
+      getBlockTrackerOptions,
       additionalDefaultNetworks,
     } = options;
     const initialState = {
@@ -1137,6 +1142,7 @@ export class NetworkController extends BaseController<
     this.#infuraProjectId = infuraProjectId;
     this.#log = log;
     this.#getRpcServiceOptions = getRpcServiceOptions;
+    this.#getBlockTrackerOptions = getBlockTrackerOptions;
 
     this.#previouslySelectedNetworkClientId =
       this.state.selectedNetworkClientId;
@@ -1161,11 +1167,6 @@ export class NetworkController extends BaseController<
       this.getNetworkClientById.bind(this),
     );
 
-    this.messagingSystem.registerActionHandler(
-      `${this.name}:getNetworkClientIdByChainId`,
-      this.getNetworkClientIdByChainId.bind(this),
-    );
-
     this.messagingSystem.registerActionHandler(
       // TODO: Either fix this lint violation or explain why it's necessary to ignore.
       // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
@@ -1838,16 +1839,6 @@ export class NetworkController extends BaseController<
     return this.state.networkConfigurationsByChainId[chainId];
   }
 
-  getNetworkClientIdByChainId(chainId: Hex): NetworkClientId | undefined {
-    const networkConfiguration = this.getNetworkConfigurationByChainId(chainId);
-    if (networkConfiguration) {
-      return networkConfiguration.rpcEndpoints[
-        networkConfiguration.defaultRpcEndpointIndex
-      ]?.networkClientId;
-    }
-    return undefined;
-  }
-
   /**
    * Returns the network configuration that contains an RPC endpoint with the
    * given network client ID.
@@ -2659,6 +2650,7 @@ export class NetworkController extends BaseController<
             ticker: networkFields.nativeCurrency,
           },
           getRpcServiceOptions: this.#getRpcServiceOptions,
+          getBlockTrackerOptions: this.#getBlockTrackerOptions,
           messenger: this.messagingSystem,
         });
       } else {
@@ -2673,6 +2665,7 @@ export class NetworkController extends BaseController<
             ticker: networkFields.nativeCurrency,
           },
           getRpcServiceOptions: this.#getRpcServiceOptions,
+          getBlockTrackerOptions: this.#getBlockTrackerOptions,
           messenger: this.messagingSystem,
         });
       }
@@ -2833,6 +2826,7 @@ export class NetworkController extends BaseController<
                 ticker: networkConfiguration.nativeCurrency,
               },
               getRpcServiceOptions: this.#getRpcServiceOptions,
+              getBlockTrackerOptions: this.#getBlockTrackerOptions,
               messenger: this.messagingSystem,
             }),
           ] as const;
@@ -2848,6 +2842,7 @@ export class NetworkController extends BaseController<
               ticker: networkConfiguration.nativeCurrency,
             },
             getRpcServiceOptions: this.#getRpcServiceOptions,
+            getBlockTrackerOptions: this.#getBlockTrackerOptions,
             messenger: this.messagingSystem,
           }),
         ] as const;

packages/network-controller/src/index.ts

@@ -39,7 +39,6 @@ export type {
   NetworkControllerRpcEndpointUnavailableEvent,
   NetworkControllerRpcEndpointDegradedEvent,
   NetworkControllerRpcEndpointRequestRetriedEvent,
-  NetworkControllerGetNetworkClientIdByChainIdAction,
 } from './NetworkController';
 export {
   getDefaultNetworkControllerState,

packages/network-controller/tests/NetworkController.test.ts

@@ -1206,72 +1206,6 @@ describe('NetworkController', () => {
     });
   });
 
-  describe('getNetworkClientIdByChainId', () => {
-    it('returns undefined if no networkConfiguration found for the given chainId', async () => {
-      const infuraProjectId = 'some-infura-project-id';
-
-      await withController(
-        {
-          state: {
-            networkConfigurationsByChainId: {
-              '0x1337': buildCustomNetworkConfiguration({
-                chainId: '0x1337',
-                nativeCurrency: 'TOKEN1',
-                rpcEndpoints: [
-                  buildCustomRpcEndpoint({
-                    failoverUrls: ['https://first.failover.endpoint'],
-                    networkClientId: 'AAAA-AAAA-AAAA-AAAA',
-                    url: 'https://test.network/1',
-                  }),
-                ],
-              }),
-            },
-            selectedNetworkClientId: 'AAAA-AAAA-AAAA-AAAA',
-          },
-          infuraProjectId,
-        },
-        async ({ controller }) => {
-          const networkClientId =
-            controller.getNetworkClientIdByChainId('0x1111');
-
-          expect(networkClientId).toBeUndefined();
-        },
-      );
-    });
-
-    it('returns the correct network client ID for the given chainId', async () => {
-      const infuraProjectId = 'some-infura-project-id';
-
-      await withController(
-        {
-          state: {
-            networkConfigurationsByChainId: {
-              '0x1337': buildCustomNetworkConfiguration({
-                chainId: '0x1337',
-                nativeCurrency: 'TOKEN1',
-                rpcEndpoints: [
-                  buildCustomRpcEndpoint({
-                    failoverUrls: ['https://first.failover.endpoint'],
-                    networkClientId: 'AAAA-AAAA-AAAA-AAAA',
-                    url: 'https://test.network/1',
-                  }),
-                ],
-              }),
-            },
-            selectedNetworkClientId: 'AAAA-AAAA-AAAA-AAAA',
-          },
-          infuraProjectId,
-        },
-        async ({ controller }) => {
-          const networkClientId =
-            controller.getNetworkClientIdByChainId('0x1337');
-
-          expect(networkClientId).toBe('AAAA-AAAA-AAAA-AAAA');
-        },
-      );
-    });
-  });
-
   describe('getNetworkClientRegistry', () => {
     describe('if no network configurations were specified at initialization', () => {
       it('returns network clients for default RPC endpoints, keyed by network client ID', async () => {

packages/network-controller/tests/helpers.ts

@@ -6,7 +6,6 @@ import {
   NetworksTicker,
   toHex,
 } from '@metamask/controller-utils';
-import type { Hex } from '@metamask/utils';
 import { v4 as uuidV4 } from 'uuid';
 
 import { FakeBlockTracker } from '../../../tests/fake-block-tracker';
@@ -193,55 +192,6 @@ export function buildMockGetNetworkClientById(
   return getNetworkClientById;
 }
 
-/**
- * Builds a mock version of the `getNetworkClientIdByChainId` method on
- * NetworkController.
- *
- * @param mockNetworkClientConfigurationsByNetworkClientId - Allows for defining
- * the network client configuration — and thus the network client itself — that
- * belongs to a particular network client ID.
- * @returns The mock version of `getNetworkClientIdByChainId`.
- */
-export function buildMockGetNetworkClientByChainId(
-  mockNetworkClientConfigurationsByNetworkClientId: Record<
-    Hex,
-    NetworkClientConfiguration
-  > = {},
-): NetworkController['getNetworkClientIdByChainId'] {
-  const defaultMockNetworkClientConfigurationsByNetworkClientId = Object.values(
-    InfuraNetworkType,
-  ).reduce((obj, infuraNetworkType) => {
-    return {
-      ...obj,
-      [infuraNetworkType]:
-        buildInfuraNetworkClientConfiguration(infuraNetworkType),
-    };
-  }, {});
-  const mergedMockNetworkClientConfigurationsByNetworkClientId: Record<
-    NetworkClientId,
-    NetworkClientConfiguration
-  > = {
-    ...defaultMockNetworkClientConfigurationsByNetworkClientId,
-    ...mockNetworkClientConfigurationsByNetworkClientId,
-  };
-
-  function getNetworkClientIdByChainId(chainId: Hex): NetworkClientId;
-  // eslint-disable-next-line jsdoc/require-jsdoc
-  function getNetworkClientIdByChainId(chainId: Hex): NetworkClientId {
-    const networkClientConfigForChainId = Object.entries(
-      mergedMockNetworkClientConfigurationsByNetworkClientId,
-    ).find(([_, value]) => value.chainId === chainId);
-    if (!networkClientConfigForChainId) {
-      throw new Error(
-        `Unknown chainId '${chainId}'. Please add it to mockNetworkClientConfigurationsByNetworkClientId.`,
-      );
-    }
-    return networkClientConfigForChainId[0];
-  }
-
-  return getNetworkClientIdByChainId;
-}
-
 /**
  * Builds a configuration object for an Infura network client based on the name
  * of an Infura network.