refactor!: Migrate eth-json-rpc-middleware to JsonRpcEngineV2
#7065
+1,948
−1,568
Conversation
This file contains hidden or 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
rekmarks
force-pushed
the
rekm/ejrpc-rewrite-2
branch
3 times, most recently
from
8bf6c31 to
a345102
Compare
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
rekmarks
force-pushed
the
rekm/ejrpc-rewrite-2
branch
from
1e01c22 to
50e1c81
Compare
3 tasks
rekmarks
added a commit
that referenced
this pull request
Nov 6, 2025
… methods (#7061) ## Explanation Adds a `MiddlewareContext` parameter to `InternalProvider.request()` and `JsonRpcServer.handle()`. This is essentially a missing feature from the `JsonRpcEngineV2` implementation / migration, since callers are no longer able to add non-JSON-RPC properties to request objects and instead need to use the `context` object. As part of this, permit specifying a plain object as the context to avoid forcing callers to import `MiddlewareContext` whenever they want to make a JSON-RPC call with some particular context. Also opportunistically fixes a bug with the static `isInstance` methods of V2 engine classes, where we wouldn't walk the prototype chain when checking for the symbol property. ## References - Related to #6327 ## 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 communicated my changes to consumers by [updating changelogs for packages I've changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs), highlighting breaking changes as necessary - ~I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes~ - These changes are non-breaking, and will in any event be exhaustively covered via preview builds through #7065. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Adds a context option to `InternalProvider.request()`/`JsonRpcServer.handle()`, enables passing plain-object contexts across the V2 engine, makes `PollingBlockTracker` context-generic, and narrows Network Controller’s `Provider` type; updates tests/docs accordingly. > > - **JSON-RPC Engine (v2)**: > - Add `HandleOptions` with `context` (accepts `MiddlewareContext` or plain object) and forward it through `handle()` and `JsonRpcServer.handle()`. > - Enhance `MiddlewareContext` (construct from KeyValues object, `isInstance`) and export `InferKeyValues`; add shared `isInstance` util; minor server refactor (static request coercion). > - Update README and tests for context passing and utils. > - **eth-json-rpc-provider**: > - Make `InternalProvider` generic over `Context`; `request()` accepts `{ context }` and forwards to engine. > - Update tests and CHANGELOG. > - **eth-block-tracker**: > - Genericize `PollingBlockTracker` with `Context`; type provider as `InternalProvider<Context>`; update CHANGELOG. > - **Network Controller**: > - Narrow `Provider` to `InternalProvider<MiddlewareContext<{ origin: string; skipCache: boolean } & Record<string, unknown>>>`. > - Type updates in `create-network-client`, tests, and helpers; update CHANGELOG. > - **Tests/Utilities**: > - Update fakes (`FakeProvider`, `FakeBlockTracker`) and consumers to new generic/context types. > - Bridge controller test now uses `@metamask/network-controller` `Provider`. > - **Deps**: > - Add `@metamask/network-controller` to root `package.json`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit c853283. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
rekmarks
force-pushed
the
rekm/ejrpc-rewrite-2
branch
2 times, most recently
from
7e2d0c0 to
78988ea
Compare
rekmarks
force-pushed
the
rekm/ejrpc-rewrite-2
branch
from
78988ea to
536ed51
Compare
Member
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
rekmarks
commented
Nov 7, 2025
rekmarks
commented
Nov 8, 2025
| } | ||
| ], | ||
| "include": ["../../types", "./src", "./test", "./types"] | ||
| "include": ["../../types", "./src", "./test"] |
Member
Author
There was a problem hiding this comment.
There is no ./types directory.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
rekmarks
commented
Nov 8, 2025
| headers, | ||
| }, | ||
| ); | ||
| const jsonRpcResponse = await rpcService.request(klona(request), { |
Member
Author
There was a problem hiding this comment.
I naively cloned this, but I'm questioning whether we actually need to. The request is not mutated in rpc-service.ts. Can we just pass the frozen request?
rekmarks
commented
Nov 8, 2025
| "@metamask/eth-json-rpc-provider": "^5.0.1", | ||
| "@metamask/eth-sig-util": "^8.2.0", | ||
| "@metamask/json-rpc-engine": "^10.1.1", | ||
| "@metamask/message-manager": "^14.0.0", |
Member
Author
There was a problem hiding this comment.
Type-only import, but the types appear in the public interface.
rekmarks
force-pushed
the
rekm/ejrpc-rewrite-2
branch
from
3225e4a to
eb33694
Compare
6 tasks
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
Migrates
@metamask/eth-json-rpc-middlewareto theJsonRpcEngineV2conventions in a total overhaul of the package. The semantics of each middleware should be the same as before.One potential behavioral difference is that request cloning within middleware now occurs with
klonainstead ofklona/full. This is becauseklona/fullcopies property descriptors such that cloned requests are immutable but not frozen in theObject.isFrozen()sense. This is unlikely to make a difference in practice to us, since our request objects have historically been "plain" objects.As with all #6327-related work up to this point,
json-rpc-enginereceived minor refactors to facilitate the use of the new abstractions in situ.Incidentally, all lint rule exceptions have been removed and all lint warnings and errors have been resolved for
eth-json-rpc-middleware.Several other packages are changed to support or in consequence of the migration:
network-controllerNetworkClientis migrated toJsonRpcEngineV2.RpcServicenow usesReadonly<JsonRpcRequest>internally for request objects received via itsrequest()method, since the "fetch" middleware now passes it deeply frozen request objects directly.message-managerandsignature-controllerReferences
JsonRpcEngineV2#6327Checklist
Note
Migrates @metamask/eth-json-rpc-middleware and the NetworkClient to JsonRpcEngineV2, updates RPC request handling to use deeply frozen Readonly requests, and aligns related types and docs.
JsonRpcEngineV2(block-cache,block-ref,block-ref-rewrite,block-tracker-inspector,inflight-cache,retryOnEmpty,fetch,wallet, etc.).providerAsMiddlewareV2; keep legacy adapter for backward compatibility.MiddlewareContext(e.g.,origin,skipCache) and immutable request/results; tests updated accordingly.@metamask/message-manager,deep-freeze-strict(+ types).NetworkClientpipeline to V2; compose V2 middleware; useproviderFromMiddlewareV2.RpcService.requestnow acceptsReadonly<JsonRpcRequest>; add tests for frozen requests.destroysignature relaxed; internal composition helpers updated.OriginalRequest→MessageRequestand allow stringid; update types/usages.Written by Cursor Bugbot for commit ae42d6d. This will update automatically on new commits. Configure here.