feat: Add context parameter to `InternalProvider` and `JsonRpcServer` methods #7061

rekmarks · 2025-11-05T07:02:37Z

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 Migrate JSON-RPC stack to JsonRpcEngineV2 #6327

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 communicated my changes to consumers by updating changelogs for packages I've changed, 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 refactor!: Migrate eth-json-rpc-middleware to JsonRpcEngineV2 #7065.

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.

^{Written by Cursor Bugbot for commit c853283. This will update automatically on new commits. Configure here.}

packages/json-rpc-engine/src/v2/MiddlewareContext.ts

…ext from object

packages/json-rpc-engine/src/v2/MiddlewareContext.ts

packages/json-rpc-engine/src/v2/utils.ts

mcmire

One question, but overall looks good to me.

mcmire · 2025-11-05T21:31:13Z

packages/eth-block-tracker/src/PollingBlockTracker.ts

+    Context extends ContextConstraint = MiddlewareContext,
+  >


Nit: Indentation?

Suggested change

Context extends ContextConstraint = MiddlewareContext,

>

Context extends ContextConstraint = MiddlewareContext,

>

This is what Prettier wants (there are no lint warnings or errors in the entire package).

Boo. Fine then 😆

mcmire · 2025-11-06T19:31:16Z

packages/json-rpc-engine/src/v2/JsonRpcServer.ts

  }

-  #coerceRequest(rawRequest: unknown, isRequest: boolean): JsonRpcCall {
+  static #coerceRequest(rawRequest: unknown, isRequest: boolean): JsonRpcCall {


I did not know you could have a static private property 🤔

Thoughts on making it public? Or maybe it doesn't need to be a static property on JsonRpcServer, it can be a function in utils?

Yeah, static private properties are neat! I only made this one static because I noticed that I could.

I don't really want to make the method public, because using it "correctly" requires capturing the original id beforehand as we do in handle(). I could make it into a external utility function and not export it if you have a strong preference for that?

Oh I see, for some reason I thought it was being referenced outside of this class and got confused how that was working.

I don't have a strong preference for this in that case.

mcmire · 2025-11-06T19:32:50Z

packages/json-rpc-engine/README.md

+console.log(result); // 'bar'
+```
+
+You can also pass a plain object as a shorthand for a `MiddlewareContext` instance:


Nice feature :)

mcmire

LGTM!

rekmarks · 2025-11-06T20:38:28Z

Skipping review from @MetaMask/swaps-engineers; we changed a type in a test.

rekmarks force-pushed the rekm/jrpce-internal-provider-context branch from 922dafc to 36a1cb5 Compare November 5, 2025 07:26

rekmarks mentioned this pull request Nov 5, 2025

feat: Add MiddlewareContext parameter to InternalProvider.handle() #7056

Closed

4 tasks

Base automatically changed from rekm/ejrpcp-v2 to main November 5, 2025 19:18

rekmarks added 3 commits November 5, 2025 11:19

feat: Permit specifying MiddlewareContext via object

3feb558

feat: Permit specifying context to JsonRpcServer.handle()

4fb7a6d

feat: Permit specifying context to InternalProvider.request()

6556f16

rekmarks force-pushed the rekm/jrpce-internal-provider-context branch from dd3379c to 86dc3b8 Compare November 5, 2025 19:19

rekmarks added 5 commits November 5, 2025 11:20

refactor: Update network client provider type

ccbc0d1

test: Fix bridge-controller tests

dba9904

refactor: Add context generic to PollingBlockTracker

f96650e

chore: Lint

48318e2

docs: Update changelogs

c0ef5d0

rekmarks force-pushed the rekm/jrpce-internal-provider-context branch from 86dc3b8 to c0ef5d0 Compare November 5, 2025 19:29

rekmarks changed the title ~~feat: Add MiddlewareContext generic to InternalProvider~~ feat: Add context parameter to InternalProvider and JsonRpcServer methods Nov 5, 2025

rekmarks marked this pull request as ready for review November 5, 2025 19:34

rekmarks requested review from a team as code owners November 5, 2025 19:34

cursor bot reviewed Nov 5, 2025

View reviewed changes

packages/json-rpc-engine/src/v2/MiddlewareContext.ts Show resolved Hide resolved

rekmarks mentioned this pull request Nov 5, 2025

refactor!(eth-json-rpc-middleware): Migrate to JsonRpcEngineV2 #6976

Closed

4 tasks

fix: Include symbol-keyed properties when constructing MiddlewareCont…

1deebb8

…ext from object

cursor bot reviewed Nov 5, 2025

View reviewed changes

packages/json-rpc-engine/src/v2/MiddlewareContext.ts Show resolved Hide resolved

refactor: Make JsonRpcServer.#coerceRequest static

d30da03

cursor bot reviewed Nov 5, 2025

View reviewed changes

packages/json-rpc-engine/src/v2/MiddlewareContext.ts Show resolved Hide resolved

fix: Resolve more MiddlewareContext bugs

2349423

rekmarks requested a review from Gudahtt November 5, 2025 20:20

rekmarks added 3 commits November 5, 2025 12:23

docs: Fix a docstring

3ef2de7

fix: Walk the prototype chain for JsonRpcEngineError.isInstance

b206d87

refactor: Rationalize class symbol identifier names

9a50958

rekmarks added 2 commits November 5, 2025 12:40

docs: Update json-rpc-engine readme

1237cd6

chore: Lint

5e87af2

cursor bot reviewed Nov 5, 2025

View reviewed changes

packages/json-rpc-engine/src/v2/MiddlewareContext.ts Show resolved Hide resolved

rekmarks requested a review from mcmire November 5, 2025 23:03

cursor bot reviewed Nov 5, 2025

View reviewed changes

packages/json-rpc-engine/src/v2/utils.ts Show resolved Hide resolved

refactor: Rationalize isInstance methods

c2632f3

rekmarks force-pushed the rekm/jrpce-internal-provider-context branch from 1273941 to c2632f3 Compare November 5, 2025 23:34

mcmire reviewed Nov 6, 2025

View reviewed changes

mcmire approved these changes Nov 6, 2025

View reviewed changes

rekmarks enabled auto-merge (squash) November 6, 2025 19:52

Merge branch 'main' into rekm/jrpce-internal-provider-context

c853283

rekmarks disabled auto-merge November 6, 2025 20:37

rekmarks merged commit 1894123 into main Nov 6, 2025
273 of 277 checks passed

rekmarks deleted the rekm/jrpce-internal-provider-context branch November 6, 2025 20:38

Uh oh!

feat: Add context parameter to InternalProvider and JsonRpcServer methods #7061

feat: Add context parameter to InternalProvider and JsonRpcServer methods #7061

Uh oh!

Conversation

rekmarks commented Nov 5, 2025 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

mcmire Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

rekmarks Nov 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mcmire Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

mcmire Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

rekmarks Nov 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mcmire Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

mcmire Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

rekmarks commented Nov 6, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: Add context parameter to `InternalProvider` and `JsonRpcServer` methods #7061

feat: Add context parameter to `InternalProvider` and `JsonRpcServer` methods #7061

rekmarks commented Nov 5, 2025 •

edited by cursor bot

Loading

rekmarks Nov 6, 2025 •

edited

Loading

rekmarks Nov 6, 2025 •

edited

Loading