feat: Add Multichain API to `@metamask/multichain` #4813

jiexi · 2024-10-17T20:13:56Z

Explanation

This PR updates @metamask/multichain to add method handlers and middleware specific to the new Multichain API and which can be shared across the extension & mobile clients. The package includes implementations for managing multichain sessions, handling multichain RPC methods, and integrating multichain functionalities into the MetaMask extension. Key features of this package include:

Method Handlers: Implementations of the new RPC method handlers like wallet_createSession, wallet_invokeMethod, wallet_revokeSession, and wallet_getSession.
ScopesObject Transforms: Adds helpers that transform between NormalizedScopesObject and InternalScopesObject
Concurrent Eth Subscriptions: Adds helpers that orchestrate eth_subscriptions to numerous chains concurrently

These tools and utilities will be used in both clients (mobile + extension)'s multichain API implementations.

File Overview

packages/multichain/src/adapters/caip-permission-adapter-middleware.ts: Middleware for the EIP-1193 API that enforces a CAIP-25 permission for each request if that CAIP-25 permission was granted via wallet_createSession
packages/multichain/src/handlers/wallet-getSession.ts: Handlers for CAIP Multichain lifecycle methods except for wallet_createSession which seemed a little too platform specific to belong in a shared package currently
packages/multichain/src/middlewares/: Middleware for the Multichain API that helps facilitate concurrent eth subscriptions and for using @metamask/api-specs for method param validation for new CAIP Multichain methods
packages/multichain/src/scope/authorization.ts: Adds helpers that sort scopes based on if they are currently supported by the wallet (i.e. a network already exists the eip155 scope), if they could be supported by the wallet (i.e. the network does not already exist for the eip155 scope, but the dapp has provided EIP-3085 details for adding the network in the scopedProperties property of the wallet_createSession request), or if they cannot be served.
packages/multichain/src/scope/filter.ts: provides helpers used for the bucketing above in authorization.ts
types/@metamask/eth-json-rpc-filters.d.ts: Typedef for missing types in @metamask/eth-json-rpc-filters/subscriptionManager

References

Upstream: #4784
Downstream: None. This is the end.

Key Multichain API Standards implemented here:

CAIP-25 - wallet_creatSession
CAIP-27 - wallet_invokeMethod
CAIP-285 - wallet_revokeSession
CAIP-311 - wallet_sessionChanged
CAIP-312 - wallet_getSession

Open PR that uses this new package for exposing the multichain API in the extension: MetaMask/metamask-extension#27782

Changelog

`@metamask/multichain`

ADDED: Adds getInternalScopesObject and getSessionScopes helpers for transforming between NormalizedScopesObject and InternalScopesObject.
ADDED: Adds caipPermissionAdapterMiddleware for enforcing CAIP-25 permission on the EIP-1193 API.
ADDED: Adds walletGetSession, walletInvokeMethod, and walletRevokeSession handlers.
ADDED: Adds multichainMethodCallValidatorMiddleware for validating Multichain API method params as defined in @metamask/api-specs.
ADDED: Adds MultichainMiddlewareManager to multiplex a request to other middleware based on requested scope.
ADDED: Adds MultichainSubscriptionManager to handle concurrent subscriptions across multiple scopes.
ADDED: Adds bucketScopes which groups the scopes in a NormalizedScopesObject based on if the scopes are already supported, could be supported, or are not supportable.
ADDED: Adds getSupportedScopeObjects helper for getting only the supported methods and notifications from each NormalizedScopeObject in a NormalizedScopesObject.

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

## Explanation This PR fixes a lot of the linting and typescript errors. still some left but this covers a lot of it.  ## References  ## Changelog  ### `@metamask/package-a` - **<CATEGORY>**: Your change here - **<CATEGORY>**: Your change here ### `@metamask/package-b` - **<CATEGORY>**: Your change here - **<CATEGORY>**: Your change here ## 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 --------- Co-authored-by: Jiexi Luan <[email protected]>

## Explanation  Added ESM exports for multichain package ## References  ## Changelog  ### `@metamask/package-a` - **<CATEGORY>**: Your change here - **<CATEGORY>**: Your change here ### `@metamask/package-b` - **<CATEGORY>**: Your change here - **<CATEGORY>**: Your change here ## 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

…Objects

…is removed

jiexi · 2025-01-15T22:42:50Z

@SocketSecurity ignore npm/[email protected]

new author seems to be bot that is on numerous other popular npm packages

jiexi · 2025-01-15T22:43:33Z

@SocketSecurity ignore npm/@npmcli/[email protected]

new author seems to be bot that is on numerous other popular npm packages

jiexi · 2025-01-15T22:43:59Z

@SocketSecurity ignore npm/[email protected]

new author seems to be bot that is on numerous other popular npm packages

jiexi · 2025-01-15T22:46:10Z

@SocketSecurity ignore npm/[email protected]

author contributes to other repos with several thousand stars

jiexi · 2025-01-15T22:49:00Z

@SocketSecurity ignore npm/[email protected]

new author seems to be involved in node and typescript development. His two changes to this package are a removal of a file and bumping the node engine version

jiexi · 2025-01-15T22:51:54Z

@SocketSecurity ignore npm/[email protected]

New authors changes seem just to be fixes. Author is also part of the Netflix open source org
https://github.com/jshttp/negotiator/commits?author=wesleytodd

jiexi · 2025-01-15T22:52:29Z

@SocketSecurity ignore npm/[email protected]

makes sense for this package to have network access

…ultichain-api

…cirbe

packages/multichain/src/middlewares/MultichainMiddlewareManager.test.ts

FrederikBolding · 2025-01-16T18:50:03Z

packages/multichain/src/middlewares/MultichainMiddlewareManager.test.ts

+    expect(endSpy).not.toHaveBeenCalled();
+  });
+
+  it('should remove middleware by scope and origin', () => {


How do these tests verify that the middleware has been deleted?

they can't directly verify that the middleware is gone from state because those are stored in a private property on the class, so instead it tests the side effect, that being that next is called. I'll change these to call eth_subscribe though

…r.test.ts Co-authored-by: Frederik Bolding <[email protected]>

…ultichain-api

FrederikBolding · 2025-01-17T21:59:32Z

packages/multichain/src/middlewares/MultichainMiddlewareManager.test.ts

+    );
+    expect(middlewareSpy).not.toHaveBeenCalled();
+    expect(nextSpy).not.toHaveBeenCalled();
+    expect(endSpy).toHaveBeenCalled();


I don't follow the test change here, shouldn't next be called and not end?

it's because eth_subscribe is the method being called in this example (which results in end() being called since this triggers the case where eth_subscribe is called but no middleware is registered to handle it since we remove it as part of this scenario). ~~I can either overload this to test both eth_subscribe and other, or split it into two methods~~

EDIT: I realized that the "eth_subscribe" request scenario already exists but was named poorly. I've changed this scenario back to calling something other than "eth_subscribe" and this test now expects nextSpy to be called again

237eb59

jiexi and others added 30 commits October 10, 2024 14:02

Initial package

bc56104

Fix caip25Permission

a4b52ad

scopes

86ab58a

Fix middlewares

186d4b3

Fix adapters except permission middleware

6a93d1d

Rename handlers js to ts

231bcaa

permission middleware test js ts rename

4e52fc0

Add requires

a0bb278

add permittedChains adapter to exports

1cd8ef2

kill scope index barrel

c636def

barrel

a6aa7c1

Merge branch 'main' into caip-multichain

42134f7

remove subjectTypes from CAIP-25 permission

a13b9c7

update eth accounts adapter with empty wallet and wallet:eip155 Scope…

81db877

…Objects

fix caip25permission spec

a3fc263

upsert empty wallet:eip155 when setting permittedChains

afe5cb9

lint

9ea78be

Rename scope.test.ts to types.test.ts

5650d31

add networkClientId type to permission-adapter-middleware

df5167e

fix snapshot

9446b0b

Merge branch 'main' into caip-multichain

f65ca24

add KnownWalletScopeString enum

941849d

stop upserting wallet scope in setEthAccounts()

a250de2

lint

aa7ba39

update removeScope mutator to not revoke permission if requiredScope …

8415be6

…is removed

Fix specificationBuilder jsdoc and typing

c7f510e

Fix caip25permission type

4afa8f8

Fix caip25permission type

597e837

fix coverage

36449e9

adonesky1 and others added 6 commits January 16, 2025 09:21

update lock file

8fff351

Merge branch 'main' into caip-multichain-api

78f7775

add MiddlewareManager middleware eth_subscribe eth_unsubscribe catch

24f17e0

Merge branch 'main' into caip-multichain-api

13ad655

Merge remote-tracking branch 'origin/caip-multichain-api' into caip-m…

8c34b81

…ultichain-api

Only pass request to middleware if request is eth_subscribe or unsubs…

7d16401

…cirbe

FrederikBolding reviewed Jan 16, 2025

View reviewed changes

packages/multichain/src/middlewares/MultichainMiddlewareManager.test.ts Outdated Show resolved Hide resolved

FrederikBolding reviewed Jan 16, 2025

View reviewed changes

packages/multichain/src/middlewares/MultichainMiddlewareManager.test.ts Outdated Show resolved Hide resolved

FrederikBolding reviewed Jan 16, 2025

View reviewed changes

packages/multichain/src/middlewares/MultichainMiddlewareManager.test.ts Outdated Show resolved Hide resolved

FrederikBolding reviewed Jan 16, 2025

View reviewed changes

jiexi and others added 5 commits January 16, 2025 10:58

Update packages/multichain/src/middlewares/MultichainMiddlewareManage…

cc369d6

…r.test.ts Co-authored-by: Frederik Bolding <[email protected]>

Update packages/multichain/src/middlewares/MultichainMiddlewareManage…

3cb0fe7

…r.test.ts Co-authored-by: Frederik Bolding <[email protected]>

Update packages/multichain/src/middlewares/MultichainMiddlewareManage…

718b553

…r.test.ts Co-authored-by: Frederik Bolding <[email protected]>

fix should remove tests

4776860

Merge remote-tracking branch 'origin/caip-multichain-api' into caip-m…

d184228

…ultichain-api

FrederikBolding previously approved these changes Jan 16, 2025

View reviewed changes

Merge branch 'main' into caip-multichain-api

6700c42

jiexi dismissed FrederikBolding’s stale review via 6700c42 January 17, 2025 19:28

fix MultichainMiddlewareManager spec

af0d8c7

FrederikBolding reviewed Jan 17, 2025

View reviewed changes

jiexi added 2 commits January 17, 2025 15:33

fix MultichainMiddlewareManager spec and scenario names

237eb59

Merge branch 'main' into caip-multichain-api

ab3ce47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add Multichain API to `@metamask/multichain` #4813

feat: Add Multichain API to `@metamask/multichain` #4813

jiexi commented Oct 17, 2024 •

edited

Loading

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

FrederikBolding Jan 16, 2025

jiexi Jan 16, 2025

jiexi Jan 16, 2025

FrederikBolding Jan 17, 2025

jiexi Jan 17, 2025 •

edited

Loading

feat: Add Multichain API to @metamask/multichain #4813

Are you sure you want to change the base?

feat: Add Multichain API to @metamask/multichain #4813

Conversation

jiexi commented Oct 17, 2024 • edited Loading

Explanation

File Overview

References

Changelog

@metamask/multichain

Checklist

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

jiexi commented Jan 15, 2025

FrederikBolding Jan 16, 2025

Choose a reason for hiding this comment

jiexi Jan 16, 2025

Choose a reason for hiding this comment

jiexi Jan 16, 2025

Choose a reason for hiding this comment

FrederikBolding Jan 17, 2025

Choose a reason for hiding this comment

jiexi Jan 17, 2025 • edited Loading

Choose a reason for hiding this comment

feat: Add Multichain API to `@metamask/multichain` #4813

feat: Add Multichain API to `@metamask/multichain` #4813

jiexi commented Oct 17, 2024 •

edited

Loading

`@metamask/multichain`

jiexi Jan 17, 2025 •

edited

Loading