Skip to content

[OpenRPC] Fix eth_getFinalizedHeader example with realistic BNB data and proper schema#1187

Merged
SahilAujla merged 1 commit intomainfrom
docs/openrpc/fix-eth-getfinalizedheader-example
Apr 7, 2026
Merged

[OpenRPC] Fix eth_getFinalizedHeader example with realistic BNB data and proper schema#1187
SahilAujla merged 1 commit intomainfrom
docs/openrpc/fix-eth-getfinalizedheader-example

Conversation

@JackReacher0807
Copy link
Copy Markdown
Collaborator

Summary

Fixes DOCS-34: The eth_getFinalizedHeader method definition had placeholder example values and an incomplete schema.

Changes

Example data

  • Replaced placeholder values (0xabc123..., 0x123456, 0xdef456...) with real BNB mainnet block header data
  • Expanded from 3 fields to all 23 header fields returned by the method
  • Added verifiedValidatorNum: -3 param to example (the method requires this parameter)

Method definition

  • Added verifiedValidatorNum parameter with description explaining the finality threshold shortcuts (-1, -2, -3)
  • Updated method description to explain the dual finality mechanism

Result schema

  • Replaced loose type: object + additionalProperties: true with fully typed properties
  • Each field uses $ref to existing base-types (hash32, uint, address, bytes, bytes8, bytes256)
  • Added descriptions for every field

Validation

  • pnpm run validate:rpc
  • pnpm run generate:rpc

…and proper schema

- Replace placeholder values (0xabc123...) with real BNB mainnet block header data
- Add all 23 header fields to the example (was only 3)
- Add verifiedValidatorNum param (method requires it per BSC docs)
- Add proper description explaining finality threshold shortcuts
- Replace loose additionalProperties:true schema with typed properties
  using  to existing base-types (hash32, uint, address, bytes, etc.)
@JackReacher0807 JackReacher0807 requested a review from a team as a code owner April 7, 2026 19:30
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 7, 2026

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Apr 7, 2026, 7:31 PM

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 7, 2026

🔍 Link Check

Status: ⏭️ Skipped (no content changes)

View workflow run

@SahilAujla SahilAujla merged commit 4f5955c into main Apr 7, 2026
8 checks passed
@SahilAujla SahilAujla deleted the docs/openrpc/fix-eth-getfinalizedheader-example branch April 7, 2026 20:44
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.

3 participants