feat: fetch networks with transaction activity by accounts #5551

vinnyhoward · 2025-03-25T23:44:52Z

Explanation

Currently, our client manually adds networks and checks user activity one network at a time. This is inefficient and doesn't scale well.

This PR introduces a more efficient approach by:

Adding a new API integration that fetches active networks for multiple accounts in a single request
Managing network activity state through the controller
Adding type-safe methods to handle both EVM and non-EVM accounts
Extracting network fetching logic into a dedicated service layer

Key additions:

getNetworksWithTransactionActivityByAccounts: Fetches active networks for accounts
MultichainNetworkService: New service layer handling network activity fetching
Enhanced state management for network configurations and activity
Improved error handling and fallback mechanisms

The new implementation:

Reduces API calls through batch fetching
Improves separation of concerns with dedicated service layer
Enhances type safety and error handling
Provides better state management with fallbacks

PRs for Client Integration
Extension
Mobile

References

Related to #4469

Changelog

`@metamask/multichain-network-controller`

ADDED: New method getNetworksWithTransactionActivityByAccounts to fetch active networks for accounts
ADDED: New MultichainNetworkServiceController for handling network activity fetching
ADDED: New types for network activity state and responses
CHANGED: Enhanced error handling for network requests
CHANGED: Improved type safety for messenger actions
CHANGED: Updated state management for network activity

Checklist

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

… controller, renamed variables/keys to be more descriptive

… on network

…-networks-method

… func

…-networks-method

Add CAIP-10 account formatting and network activity fetching with full test coverage. Includes error handling and future-proofing for BTC/Solana support.

…-networks-method

packages/multichain-network-controller/src/utils.ts

salimtb · 2025-04-02T14:18:23Z

@metamask-bot @metamaskbot publish-preview

salimtb · 2025-04-02T14:18:42Z

can you pls fix the broken unit test

packages/multichain-network-controller/src/MultichainNetworkController.ts

… and fix Solana address validation This commit improves the test coverage and fixes issues with Solana address validation in the multichain network controller. The changes ensure proper handling of both EVM and non-EVM network addresses. Key Changes: - Fixed Solana address format in tests to use base58 instead of hex format - Updated test expectations for mixed EVM and non-EVM network responses - Corrected validation regex for Solana addresses

…k/core into feat-4469-active-networks-method

Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

- Extract repeated mock addresses and CAIP IDs into reusable constants - Add proper TypeScript types for mock data and test helpers - Create reusable createMockAccount helper function - Remove should from test descriptions for better readability - Update test names to be more action-oriented and specific

mcmire

One more thing and then I'm good :)

packages/multichain-network-controller/package.json

packages/multichain-network-controller/src/MultichainNetworkController.test.ts

packages/multichain-network-controller/src/MultichainNetworkController.ts

…troller - Use PublicInterface pattern for network service dependency instead of concrete implementation. - This improves testability and reduces coupling between the controller and service implementation.

mcmire

LGTM!

packages/multichain-network-controller/src/MultichainNetworkController.test.ts

packages/multichain-network-controller/src/types.ts

packages/multichain-network-controller/src/utils.ts

packages/multichain-network-controller/src/MultichainNetworkService.ts

- Replace regex pattern validation with CaipAccountIdStruct from @metamask/utils - Remove assertCaipAccountIds utility function in favor of superstruct validation - Update error handling in MultichainNetworkService to use assert for better errors - Fix Solana chain reference in tests to use proper mainnet identifier This change leverages existing superstruct validation from utils package, reducing duplicate validation logic and providing better error messages.

…o pattern

…-networks-method

…ests into accounts-api

ccharly

Final review round 💪

I did left a bunch of suggestions (mainly for tests that I didn't review during last reviews)

The code looks really great now, thanks a lot for making all those changes 😄

...chain-network-controller/src/MultichainNetworkController/MultichainNetworkController.test.ts

packages/multichain-network-controller/src/types.ts

ccharly · 2025-04-11T08:33:23Z

packages/multichain-network-controller/src/utils.test.ts

+    it('uses default block explorer index when undefined', () => {
+      const network: NetworkConfiguration = {
+        chainId: '0x1',
+        name: 'Ethereum Mainnet',
+        nativeCurrency: 'ETH',
+        blockExplorerUrls: ['https://etherscan.io'],
+        defaultBlockExplorerUrlIndex: undefined,
+        rpcEndpoints: [],
+        defaultRpcEndpointIndex: 0,
+      };
+      expect(toMultichainNetworkConfiguration(network)).toStrictEqual({
+        chainId: 'eip155:1',
+        isEvm: true,
+        name: 'Ethereum Mainnet',
+        nativeCurrency: 'ETH',
+        blockExplorerUrls: ['https://etherscan.io'],
+        defaultBlockExplorerUrlIndex: 0,
+      });
+    });


Out of curiosity, was this a missing test? It doesn't feel related to this PR's scope 😄 (that's probably ok, especially this was missing 👍)

Oh I just saw a missing test case and decided to add it. Might as well add it if I'm here but I can remove since it doesn't relate to the scope

packages/multichain-network-controller/src/api/accounts-api.test.ts

.../multichain-network-controller/src/MultichainNetworkService/MultichainNetworkService.test.ts

…rvice/MultichainNetworkService.test.ts Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

…st.ts Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

…ntroller/MultichainNetworkController.test.ts Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

refactor: moved logic from networks controller to multichain networks…

a038b1f

… controller, renamed variables/keys to be more descriptive

vinnyhoward force-pushed the feat-4469-active-networks-method branch from d7c63ef to a038b1f Compare March 27, 2025 23:28

vinnyhoward added 2 commits March 28, 2025 15:37

feat: getNetworksWithActivityByAccounts fetches active accounts based…

ed1e38b

… on network

Merge branch 'main' of github.com:MetaMask/core into feat-4469-active…

77e7d53

…-networks-method

vinnyhoward changed the title ~~feat: active networks~~ feat: networks with activity Mar 31, 2025

vinnyhoward marked this pull request as ready for review March 31, 2025 18:19

vinnyhoward requested review from a team as code owners March 31, 2025 18:19

vinnyhoward added 6 commits March 31, 2025 12:46

fix: added proper mocks and tests coverage

8305935

fix: increase test coverage

570daeb

fix: increased test coverage and removed abort controller in new util…

33da755

… func

Merge branch 'main' of github.com:MetaMask/core into feat-4469-active…

515e8ca

…-networks-method

feat: add multichain network activity support

f795988

Add CAIP-10 account formatting and network activity fetching with full test coverage. Includes error handling and future-proofing for BTC/Solana support.

Merge branch 'main' of github.com:MetaMask/core into feat-4469-active…

9e07ee4

…-networks-method

This was referenced Apr 1, 2025

feat(4469): networks with activity integration MetaMask/metamask-mobile#14348

Open

feat(4469): networks with activity integration MetaMask/metamask-extension#31414

Open

vinnyhoward commented Apr 1, 2025

View reviewed changes

packages/multichain-network-controller/src/utils.ts Outdated Show resolved Hide resolved

feat: updated headers to track where API is in use

c27c25f

salimtb reviewed Apr 2, 2025

View reviewed changes

packages/multichain-network-controller/src/MultichainNetworkController.ts Outdated Show resolved Hide resolved

salimtb reviewed Apr 2, 2025

View reviewed changes

packages/multichain-network-controller/src/MultichainNetworkController.ts Outdated Show resolved Hide resolved

salimtb reviewed Apr 2, 2025

View reviewed changes

packages/multichain-network-controller/src/MultichainNetworkController.ts Outdated Show resolved Hide resolved

vinnyhoward added 6 commits April 2, 2025 13:16

Merge branch 'main' into feat-4469-active-networks-method

ac8bf2e

test: increased coverage

11f780a

Merge branch 'feat-4469-active-networks-method' of github.com:MetaMas…

0aeff1a

…k/core into feat-4469-active-networks-method

update: bump controller-utils version

e52518a

fix: improved formatCaipAccountId tests

1fc89c1

vinnyhoward and others added 5 commits April 9, 2025 11:32

Update packages/multichain-network-controller/src/types.ts

a63885f

Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Update packages/multichain-network-controller/src/types.ts

2e3ce04

Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Update packages/multichain-network-controller/src/utils.ts

d78a816

Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Merge branch 'main' into feat-4469-active-networks-method

91e210e

mcmire reviewed Apr 9, 2025

View reviewed changes

vinnyhoward added 2 commits April 9, 2025 14:08

refactor: use abstract network service type in multichain network con…

276f1b2

…troller - Use PublicInterface pattern for network service dependency instead of concrete implementation. - This improves testability and reduces coupling between the controller and service implementation.

fix: lint

eb661b5

mcmire previously approved these changes Apr 9, 2025

View reviewed changes

ccharly reviewed Apr 10, 2025

View reviewed changes

packages/multichain-network-controller/src/MultichainNetworkService.ts Outdated Show resolved Hide resolved

vinnyhoward dismissed mcmire’s stale review via 8357ae7 April 10, 2025 17:04

vinnyhoward added 5 commits April 10, 2025 11:15

refactor: reorganized folder structure

d05ea8e

fix: lint

3f9ea1c

refactor: moved all api related logic into its own file to mirror rep…

dc6f29e

…o pattern

Merge branch 'main' of github.com:MetaMask/core into feat-4469-active…

2cc91f2

…-networks-method

refactor: moved all api related utlity functions and its respective t…

7acf9a5

…ests into accounts-api

vinnyhoward changed the title ~~feat: networks with activity~~ feat: fetch networks with transaction activity Apr 10, 2025

vinnyhoward changed the title ~~feat: fetch networks with transaction activity~~ feat: fetch networks with transaction activity by accounts Apr 10, 2025

ccharly reviewed Apr 11, 2025

View reviewed changes

vinnyhoward and others added 9 commits April 11, 2025 12:57

Update packages/multichain-network-controller/src/MultichainNetworkSe…

5a1b297

…rvice/MultichainNetworkService.test.ts Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Update packages/multichain-network-controller/src/api/accounts-api.te…

89f1f8b

…st.ts Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Update packages/multichain-network-controller/src/api/accounts-api.te…

ef2e717

…st.ts Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Update packages/multichain-network-controller/src/api/accounts-api.te…

8575f42

…st.ts Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Update packages/multichain-network-controller/src/api/accounts-api.te…

eedaca9

…st.ts Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Update packages/multichain-network-controller/src/types.ts

38d67de

Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Update packages/multichain-network-controller/src/MultichainNetworkCo…

ee22bdf

…ntroller/MultichainNetworkController.test.ts Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Update packages/multichain-network-controller/src/MultichainNetworkCo…

67b43a0

…ntroller/MultichainNetworkController.test.ts Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Update packages/multichain-network-controller/src/MultichainNetworkCo…

79b99de

…ntroller/MultichainNetworkController.test.ts Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: fetch networks with transaction activity by accounts #5551

feat: fetch networks with transaction activity by accounts #5551

vinnyhoward commented Mar 25, 2025 •

edited

Loading

salimtb commented Apr 2, 2025

salimtb commented Apr 2, 2025

mcmire left a comment

mcmire left a comment

ccharly left a comment

ccharly Apr 11, 2025

vinnyhoward Apr 11, 2025

feat: fetch networks with transaction activity by accounts #5551

Are you sure you want to change the base?

feat: fetch networks with transaction activity by accounts #5551

Conversation

vinnyhoward commented Mar 25, 2025 • edited Loading

Explanation

References

Changelog

@metamask/multichain-network-controller

Checklist

salimtb commented Apr 2, 2025

salimtb commented Apr 2, 2025

mcmire left a comment

Choose a reason for hiding this comment

mcmire left a comment

Choose a reason for hiding this comment

ccharly left a comment

Choose a reason for hiding this comment

ccharly Apr 11, 2025

Choose a reason for hiding this comment

vinnyhoward Apr 11, 2025

Choose a reason for hiding this comment

vinnyhoward commented Mar 25, 2025 •

edited

Loading

`@metamask/multichain-network-controller`