fix: allow tracerConfig as JSON object in debug RPC #887
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
Previously, debug_traceBlockByNumber and related endpoints only accepted tracerConfig as an escaped JSON string due to protobuf type definitions. This caused incompatibility with standard Ethereum (like curl requests) which sends tracerConfig as a JSON object. This commit implements custom MarshalJSON and UnmarshalJSON methods for TraceConfig. It creates a polyglot unmarshaler that accepts both: 1. Standard JSON Objects (Ethereum compliant) 2. Escaped JSON Strings (Legacy/Backwards compatible)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Fixes a compatibility issue where
debug_traceBlockByNumberand related JSON-RPC endpoints reject requests containingtracerConfigas a JSON object. While standard Ethereum clients sendtracerConfigas a raw object, the current Protobuf definition expects an escaped JSON string, causing unmarshal errors.Changes introduced:
UnmarshalJSONandMarshalJSONmethods forTraceConfiginx/vm/types/trace_config.go.x/vm/types/trace_config_test.gocovering object format, string format, and round-trip serialization.Critical files to review:
x/vm/types/trace_config.go(New custom JSON logic)x/vm/types/trace_config_test.go(Verification of the fix)Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
go test -v ./x/vm/types/ -run TestTraceConfigto verify both JSON formats are accepted.mainbranch