[docs-agent] Fix invalid hex character in eth_getProof storage key example (DOCS-102)#1341
Open
alchemy-bot wants to merge 2 commits into
Open
[docs-agent] Fix invalid hex character in eth_getProof storage key example (DOCS-102)#1341alchemy-bot wants to merge 2 commits into
alchemy-bot wants to merge 2 commits into
Conversation
…ample The shared eth_getProof example in src/openrpc/chains/_components/custom/methods.yaml had a 32-byte storage key with a literal 's' character (0x283s34c8...), causing the live RPC to return 'hex string invalid' on every EVM chain page that inherits the example. Surfaced by the DOCS-101 Try It audit (affects ~29 chains). Verified the corrected value (0x283534c8...) returns HTTP 200 with a real eth_getProof result on eth-mainnet via docs-demo. Refs DOCS-102 Requested-by: @SahilAujla
🔗 Preview Mode
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 72abe3776a
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Codex review on PR #1341 flagged that with the typo fix accepted, the example now requests two storage keys but the result fixture only contained one storageProof entry — eth_getProof returns one proof entry per requested storage key, so the fixture was inconsistent with the params. Added the matching second entry. Used proof: [] and value: "0x0" because the live mainnet response for that address returns no storage at the second slot (the empty case); the first entry retains its synthetic illustrative proof so the example still shows the non-trivial response shape. Refs DOCS-102 Requested-by: @SahilAujla
Collaborator
|
@codex review |
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
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.
Summary
The shared
eth_getProofexample insrc/openrpc/chains/_components/custom/methods.yamlhas a 32-byte storage key with a literalscharacter (0x283s34c8e2b1...).sis not a valid hex digit, so every EVM chain that inherits this example returnshex string invalidon Try It.Replacing the
swith5gives a syntactically valid 32-byte hex string. The corrected value (0x283534c8e2b1...) was live-verified to return HTTP 200 with a realeth_getProofresult oneth-mainnet.g.alchemy.com/v2/docs-demo.Impact
DOCS-101 audit caught this affecting ~29 EVM chains (every chain spec that
$ref's the sharedeth_getProofexample). One-line fix in the shared YAML, no per-chain changes needed.Linear
DOCS-102 — Fix invalid hex character in shared eth_getProof storage key example
Surfaced by DOCS-101 audit (PR #1340).
Requested by
@SahilAujla (via Slack thread)