wip: Add Multichain API support #3759
Conversation
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
FrederikBolding
force-pushed
the
fb/multichain-api
branch
from
6945f3c to
78ff428
Compare
FrederikBolding
force-pushed
the
fb/multichain-api
branch
from
917fc58 to
491f06d
Compare
| import { getMockOptions } from '../test-utils/options'; | ||
|
|
||
| const MOCK_HOOKS: RestrictedMiddlewareHooks = { | ||
| const MOCK_HOOKS = { |
There was a problem hiding this comment.
Why'd you remove the type? Can it be replaces by satisfies?
There was a problem hiding this comment.
To make it easier to modify the mocks in each test without casting. They seem to be inferred correctly when passed in
| options, | ||
| }: GetPermissionSpecificationsOptions) { | ||
| return { | ||
| [caip25EndowmentBuilder.targetName]: |
There was a problem hiding this comment.
Should probably be in buildSnapEndowmentSpecifications.
There was a problem hiding this comment.
No, this is the multichain endowment that is specified in the clients, which is granted when using wallet_createSession. We don't want that to be part of the Snap endowments.
packages/snaps-simulation/src/middleware/internal-methods/chain-id.ts
Outdated
Show resolved
Hide resolved
| optionalScopes: request.params.optionalScopes ?? {}, | ||
| sessionProperties: {}, | ||
| isMultichainOrigin: true, | ||
| } as Caip25CaveatValue; |
| } | ||
|
|
||
| // TODO: Struct? | ||
| const { request: wrappedRequest, scope } = request.params as any; |
There was a problem hiding this comment.
Just leaving a comment so we don't forget about replacing any here.
| const mergedScopes = { | ||
| ...value.requiredScopes, | ||
| ...value.optionalScopes, | ||
| } as Record<CaipChainId, InternalScopeObject & { methods: string[] }>; |
There was a problem hiding this comment.
Yes, this is slightly different from the proper types because we store methods so that we can recreate the session scopes. In the clients these values are not stored in the permission, but instead recreated whenever requested.
There was a problem hiding this comment.
I chose this way of doing it to let the Snap register any non-EVM action as long as they mock it
| const nonEvmMethods = Object.keys(mergedScopes).reduce< | ||
| Record<CaipChainId, string[]> | ||
| >((accumulator, scope) => { | ||
| const castScope = scope as CaipChainId | 'wallet'; |
There was a problem hiding this comment.
Yeah, because Object.keys just returns string[]
| return new PermissionController({ | ||
| messenger, | ||
| caveatSpecifications: { | ||
| [Caip25CaveatType]: caip25CaveatBuilder({ |
There was a problem hiding this comment.
How come this isn't part of snapsEndowmentCaveatSpecifications?
| * @param request - The JSON-RPC request. | ||
| * @returns The JSON-RPC response. | ||
| */ | ||
| export async function invokeMethod<ReturnType>( |
There was a problem hiding this comment.
This could be moved to the Module class, so it can be used like this.invokeMethod, removing the need to provide the scope.
There was a problem hiding this comment.
Good point. I feel like I had a justification for this at some point, but I can't think of one now.
Adds support for using the multichain API in Snaps. This is accomplished by setting up a separate provider and substream called
metamask-multichain-provider. Whensnap.requestis called with a multichain request, this provider and substream is used. The clients will need to route to the proper JSON-RPC pipeline based on the substream and verify that the Snap has the proper permission (TBD).Additionally this PR adds a example Snap for usage of this API, that can leverage Ethereum and Solana APIs at once. It also adds limited simulation support for the multichain API. The simulation framework implements a basic version of the multichain API where sessions are tracked and requests are routed to supported EVM providers. There are no underlying providers for non-EVM request, but they can be mocked.
TODO:
wallet_revokeSessionsupport