feat: Add Multichain API to @metamask/multichain
#4813
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Explanation This PR fixes a lot of the linting and typescript errors. still some left but this covers a lot of it. <!-- 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? --> ## 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 --> ## 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/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 <!-- 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? --> Added ESM exports for multichain package ## 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 --> ## 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/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
FrederikBolding
previously approved these changes
Jan 16, 2025
| ); | ||
| expect(middlewareSpy).not.toHaveBeenCalled(); | ||
| expect(nextSpy).not.toHaveBeenCalled(); | ||
| expect(endSpy).toHaveBeenCalled(); |
There was a problem hiding this comment.
I don't follow the test change here, shouldn't next be called and not end?
There was a problem hiding this comment.
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
FrederikBolding
previously approved these changes
Jan 18, 2025
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
FrederikBolding
approved these changes
Jan 22, 2025
mcmire
approved these changes
Jan 22, 2025
| if (result.errors) { | ||
| errors.push( | ||
| ...result.errors.map((e) => { | ||
| return transformError(e, p, paramToCheck) as JsonRpcError; |
There was a problem hiding this comment.
Nit: Why do we need to typecast here?
| const errors: JsonRpcError[] = []; | ||
| for (const param of methodToCheck.params) { | ||
| if (!isObject(params)) { | ||
| return [rpcErrors.invalidParams()] as JsonRpcError[]; |
There was a problem hiding this comment.
Nit: Why do we need to typecast here?
| @@ -57,7 +57,7 @@ export const addPermittedEthChainId = ( | |||
| caip25CaveatValue: Caip25CaveatValue, | |||
| chainId: Hex, | |||
| ): Caip25CaveatValue => { | |||
| const scopeString = `eip155:${parseInt(chainId, 16)}`; | |||
| const scopeString = `eip155:${hexToBigInt(chainId).toString(10)}`; | |||
There was a problem hiding this comment.
I think this is one of the few times I've seen the chain ID converted to a bigint instead of a BN!
adonesky1
approved these changes
Jan 22, 2025
Merged
adonesky1
added a commit
that referenced
this pull request
Jan 22, 2025
## @metamask/multichain ## [3.0.0] ### Add - Add key Multichain API methods ([#4813](#4813)) - Adds `getInternalScopesObject` and `getSessionScopes` helpers for transforming between `NormalizedScopesObject` and `InternalScopesObject`. - Adds `walletGetSession`, `walletInvokeMethod`, and `walletRevokeSession` handlers. - Adds `multichainMethodCallValidatorMiddleware` for validating Multichain API method params as defined in @metamask/api-specs. - Adds `MultichainMiddlewareManager` to multiplex a request to other middleware based on requested scope. - Adds `MultichainSubscriptionManager` to handle concurrent subscriptions across multiple scopes. - Adds `bucketScopes` which groups the scopes in a `NormalizedScopesObject` based on if the scopes are already supported, could be supported, or are not supportable. - Adds `getSupportedScopeObjects` helper for getting only the supported methods and notifications from each `NormalizedScopeObject` in a `NormalizedScopesObject`. - Fixes `removeScope` mutator incorrectly returning malformed CAIP-25 caveat values ([#5183](#5183)). ### Changed - Bump `@metamask/controller-utils` from `^11.4.4` to `^11.4.5` ([#5012](#5135)) - Bump `@metamask/permission-controller` from `^11.0.4` to `^11.0.5` ([#5012](#5135)) - Bump `@metamask/utils` to `^11.0.1` and `@metamask/rpc-errors` to `^7.0.2` ([#5080](#5080)) --------- Co-authored-by: jiexi <[email protected]>
Merged
adonesky1
added a commit
that referenced
this pull request
Jan 22, 2025
## `@metamask/multichain` ## [2.1.0] ### Added - Add key Multichain API methods ([#4813](#4813)) - Adds `getInternalScopesObject` and `getSessionScopes` helpers for transforming between `NormalizedScopesObject` and `InternalScopesObject`. - Adds handlers for `wallet_getSession`, `wallet_invokeMethod`, and `wallet_revokeSession` methods. - Adds `multichainMethodCallValidatorMiddleware` for validating Multichain API method params as defined in @metamask/api-specs. - Adds `MultichainMiddlewareManager` to multiplex a request to other middleware based on requested scope. - Adds `MultichainSubscriptionManager` to handle concurrent subscriptions across multiple scopes. - Adds `bucketScopes` which groups the scopes in a `NormalizedScopesObject` based on if the scopes are already supported, could be supported, or are not supportable. - Adds `getSupportedScopeObjects` helper for getting only the supported methods and notifications from each `NormalizedScopeObject` in a `NormalizedScopesObject`. ### Changed - Bump `@metamask/controller-utils` from `^11.4.4` to `^11.4.5` ([#5012](#5135)) - Bump `@metamask/permission-controller` from `^11.0.4` to `^11.0.5` ([#5012](#5135)) - Bump `@metamask/utils` to `^11.0.1` and `@metamask/rpc-errors` to `^7.0.2` ([#5080](#5080)) ### Fixed - Fixes `removeScope` mutator incorrectly returning malformed CAIP-25 caveat values ([#5183](#5183)).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
This PR updates
@metamask/multichainto 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:wallet_createSession,wallet_invokeMethod,wallet_revokeSession, andwallet_getSession.NormalizedScopesObjectandInternalScopesObjectThese 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 viawallet_createSessionpackages/multichain/src/handlers/wallet-getSession.ts: Handlers for CAIP Multichain lifecycle methods except forwallet_createSessionwhich seemed a little too platform specific to belong in a shared package currentlypackages/multichain/src/middlewares/: Middleware for the Multichain API that helps facilitate concurrent eth subscriptions and for using@metamask/api-specsfor method param validation for new CAIP Multichain methodspackages/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 thescopedPropertiesproperty of thewallet_createSessionrequest), or if they cannot be served.packages/multichain/src/scope/filter.ts: provides helpers used for the bucketing above inauthorization.tstypes/@metamask/eth-json-rpc-filters.d.ts: Typedef for missing types in@metamask/eth-json-rpc-filters/subscriptionManagerReferences
Upstream: #4784
Downstream: None. This is the end.
Key Multichain API Standards implemented here:
wallet_creatSessionwallet_invokeMethodwallet_revokeSessionwallet_sessionChangedwallet_getSessionOpen PR that uses this new package for exposing the multichain API in the extension: MetaMask/metamask-extension#27782
Changelog
@metamask/multichaingetInternalScopesObjectandgetSessionScopeshelpers for transforming betweenNormalizedScopesObjectandInternalScopesObject.caipPermissionAdapterMiddlewarefor enforcing CAIP-25 permission on the EIP-1193 API.walletGetSession,walletInvokeMethod, andwalletRevokeSessionhandlers.multichainMethodCallValidatorMiddlewarefor validating Multichain API method params as defined in@metamask/api-specs.MultichainMiddlewareManagerto multiplex a request to other middleware based on requested scope.MultichainSubscriptionManagerto handle concurrent subscriptions across multiple scopes.bucketScopeswhich groups the scopes in aNormalizedScopesObjectbased on if the scopes are already supported, could be supported, or are not supportable.getSupportedScopeObjectshelper for getting only the supported methods and notifications from eachNormalizedScopeObjectin aNormalizedScopesObject.Checklist