feat: allow using a chainId or networkClientId to fetch top assets (#403)

## Explanation

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

This PR allows passing in either a `chainId` or a `networkClientId` to
`fetchTopAssets`. Previously only `networkClientId` was allowed.

This is to support the case of Bridge where a user could select a
destination chain that they have not added to MM yet, there by not
having a `networkClientId` to provide. The user will have a destination
`chainId` that we want to look up top assets on.

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

Related to MetaMask/metamask-mobile#14258

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/swaps-controller`

- CHANGED: Allow passing in either a `chainId` or a `networkClientId` to
`fetchTopAssets`. Previously only `networkClientId` was allowed.

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

Author: infiniteflower

src/SwapsController.test.ts

@@ -2520,6 +2520,67 @@ describe('SwapsController', () => {
         expect(swapsUtilFetchTopAssets).not.toHaveBeenCalled();
       });
     });
+
+    describe('when the chain ID is provided', () => {
+      it('persists fetched top assets to the chain cache and the main part of state', async () => {
+        const clientId = 'client-id';
+        const chainId = POLYGON_CHAIN_ID;
+        const fetchedTokens = [
+          {
+            address: '0x1111111',
+            symbol: 'TOKEN1',
+            decimals: 1,
+          },
+          {
+            address: '0x2222222',
+            symbol: 'TOKEN2',
+            decimals: 2,
+          },
+        ];
+        const controller = getSwapsController({
+          options: {
+            clientId,
+          },
+        });
+        swapsUtilFetchTopAssets.mockImplementation(
+          async (givenChainId, givenClientId) => {
+            if (givenChainId === chainId && givenClientId === clientId) {
+              return fetchedTokens;
+            }
+            throw new Error(
+              `Unknown chain ID '${givenChainId}' and/or client ID '${givenClientId}'`,
+            );
+          },
+        );
+
+        await controller.fetchTopAssetsWithCache({ chainId });
+
+        expect(controller.state.topAssets).toStrictEqual(fetchedTokens);
+        expect(controller.state.chainCache).toStrictEqual({
+          '0x1': {
+            aggregatorMetadata: null,
+            tokens: null,
+            topAssets: null,
+            aggregatorMetadataLastFetched: 0,
+            topAssetsLastFetched: 0,
+            tokensLastFetched: 0,
+          },
+          [chainId]: {
+            topAssets: fetchedTokens,
+            topAssetsLastFetched: Date.now(),
+          },
+        });
+      });
+    });
+
+    describe('when the chain ID is not provided and the network client ID is not provided', () => {
+      it('throws an error', async () => {
+        const controller = getSwapsController();
+        await expect(controller.fetchTopAssetsWithCache({})).rejects.toThrow(
+          'One of networkClientId or chainId is required',
+        );
+      });
+    });
   });
 
   describe('fetchAggregatorMetadataWithCache', () => {

src/SwapsController.ts

@@ -1013,31 +1013,42 @@ export default class SwapsController extends BaseController<
    * Fetches the top assets and updates the state with them.
    * @param args - The arguments to this method.
    * @param args.networkClientId - The ID of a network client from
-   * NetworkController.
+   * NetworkController. This or chainId is required.
+   * @param args.chainId - The chain ID to fetch the top assets for. This or
+   * networkClientId is required. chainId will be preferred over networkClientId.
    */
   async fetchTopAssetsWithCache({
     networkClientId,
+    chainId,
   }: {
-    networkClientId: NetworkClientId;
+    networkClientId?: NetworkClientId;
+    chainId?: Hex;
   }) {
-    const chainId = this.#getChainId(networkClientId);
+    let chainIdToUse;
+    if (chainId) {
+      chainIdToUse = chainId;
+    } else if (networkClientId) {
+      chainIdToUse = this.#getChainId(networkClientId);
+    } else {
+      throw new Error('One of networkClientId or chainId is required');
+    }
 
-    if (!this.#supportedChainIds.includes(chainId)) {
+    if (!this.#supportedChainIds.includes(chainIdToUse)) {
       return;
     }
 
     const { topAssets } = this.state;
 
     const topAssetsLastFetchedForChain =
-      this.state.chainCache[chainId]?.topAssetsLastFetched ?? 0;
+      this.state.chainCache[chainIdToUse]?.topAssetsLastFetched ?? 0;
 
     const isPastThresholdForChain =
       this.#fetchTopAssetsThreshold < Date.now() - topAssetsLastFetchedForChain;
 
     if (!topAssets || isPastThresholdForChain) {
       const releaseLock = await this.#mutex.acquire();
       try {
-        const newTopAssets = await fetchTopAssets(chainId, this.#clientId);
+        const newTopAssets = await fetchTopAssets(chainIdToUse, this.#clientId);
         const data = {
           topAssets: newTopAssets,
           topAssetsLastFetched: Date.now(),
@@ -1046,7 +1057,7 @@ export default class SwapsController extends BaseController<
           _state.topAssets = data.topAssets;
           _state.chainCache = getNewChainCache(
             _state.chainCache,
-            chainId,
+            chainIdToUse,
             data,
           );
         });
@@ -1055,7 +1066,7 @@ export default class SwapsController extends BaseController<
         this.update((_state) => {
           _state.chainCache = getNewChainCache(
             _state.chainCache,
-            chainId,
+            chainIdToUse,
             data,
           );
         });