Skip to content

[docs-agent] Fix invalid hex character in eth_getProof storage key example (DOCS-102)#1341

Open
alchemy-bot wants to merge 2 commits into
mainfrom
docs/fix-eth-getproof-storage-key
Open

[docs-agent] Fix invalid hex character in eth_getProof storage key example (DOCS-102)#1341
alchemy-bot wants to merge 2 commits into
mainfrom
docs/fix-eth-getproof-storage-key

Conversation

@alchemy-bot
Copy link
Copy Markdown
Contributor

Summary

The shared eth_getProof example in src/openrpc/chains/_components/custom/methods.yaml has a 32-byte storage key with a literal s character (0x283s34c8e2b1...). s is not a valid hex digit, so every EVM chain that inherits this example returns hex string invalid on Try It.

Replacing the s with 5 gives a syntactically valid 32-byte hex string. The corrected value (0x283534c8e2b1...) was live-verified to return HTTP 200 with a real eth_getProof result on eth-mainnet.g.alchemy.com/v2/docs-demo.

$ curl -X POST 'https://eth-mainnet.g.alchemy.com/v2/docs-demo' \
    -H 'Content-Type: application/json' \
    -H 'Origin: https://www.alchemy.com' \
    -H 'Referer: https://www.alchemy.com/' \
    -d '{"jsonrpc":"2.0","id":1,"method":"eth_getProof","params":[
        "0xe5cB067E90D5Cd1F8052B83562Ae670bA4A211a8",
        ["0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
         "0x283534c8e2b1456f09832c71e5d6a0b4f8c9e1d3a2b5c7f0e6d4a8b2c1f3e5d7"],
        "latest"]}'

{"jsonrpc":"2.0","id":1,"result":{"accountProof":[...],"address":"0xe5cb...","balance":"0x...","codeHash":"0x...","nonce":"0x...","storageHash":"0x...","storageProof":[...]}}

Impact

DOCS-101 audit caught this affecting ~29 EVM chains (every chain spec that $ref's the shared eth_getProof example). 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)

…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
@alchemy-bot alchemy-bot requested a review from a team as a code owner May 29, 2026 17:34
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 29, 2026

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview May 29, 2026, 5:40 PM

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread src/openrpc/chains/_components/custom/methods.yaml
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
@SahilAujla
Copy link
Copy Markdown
Collaborator

@codex review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants