Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated public API methods containing blockNumber #1402

Merged

Conversation

mjsmike62
Copy link
Contributor

@mjsmike62 mjsmike62 commented Sep 14, 2023

Updated public API methods containing the blockNumber parameter, specifying that they are hexadecimal integer and also added finalized and safe to the string tags listing. Also, added finalized and safe to other public API methods that were missing these tags.

Fixes #1385

See https://besu-docs-1sz5lp094-hyperledger.vercel.app/development/public-networks/reference/api

  • Made additional edits as per Alex's review comments below, "Missing a few updates".
  • Made additional edits as per Sally MacFarlane's review comments below, "blockNumber can be hex OR decimal "
  • Made additional edits as per Sally MacFarlane's review comments below: changed 'decimal' to 'decimal integer'.

See:
https://besu-docs-lnswwc430-hyperledger.vercel.app/development/public-networks/reference/api
https://besu-docs-lnswwc430-hyperledger.vercel.app/development/private-networks/reference/api

@mjsmike62 mjsmike62 requested a review from a team as a code owner September 14, 2023 16:03
@vercel
Copy link

vercel bot commented Sep 14, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
besu-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 25, 2023 9:28pm

Copy link
Contributor

@alexandratran alexandratran left a comment

Choose a reason for hiding this comment

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

Missing a few updates:

  • admin_logsRemoveCache fromBlock and toBlock missing "hexadecimal"
  • eth_feeHistory newestBlock missing "hexadecimal"
  • debug_getRawReceipts blockNumber missing both "hexadecimal" and the new string tags

@mjsmike62
Copy link
Contributor Author

@alexandratran, the only place where I can find that eth_feeHistory is missing the hexadecimal integer description is in down-level versions of the docs.
eth_feeHistory
.

Copy link
Contributor

@macfarla macfarla left a comment

Choose a reason for hiding this comment

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

blockNumber can be hex OR decimal - see
https://besu.hyperledger.org/development/public-networks/how-to/use-besu-api/json-rpc#block-parameter

so you could have "0x10" or "16" and either would work

Copy link
Contributor

@macfarla macfarla left a comment

Choose a reason for hiding this comment

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

minor suggestion on wording

docs/private-networks/reference/api/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@alexandratran alexandratran left a comment

Choose a reason for hiding this comment

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

Added some suggestions for missed edits. You can go to Files changed on this PR, and for each suggestion, Add suggestion to batch. Then simply commit all my suggestions at once.

docs/private-networks/reference/api/index.md Outdated Show resolved Hide resolved
docs/private-networks/reference/api/index.md Outdated Show resolved Hide resolved
docs/private-networks/reference/api/index.md Outdated Show resolved Hide resolved
docs/private-networks/reference/api/index.md Outdated Show resolved Hide resolved
docs/private-networks/reference/api/index.md Outdated Show resolved Hide resolved
docs/private-networks/reference/api/index.md Outdated Show resolved Hide resolved
docs/public-networks/reference/api/index.md Outdated Show resolved Hide resolved
docs/public-networks/reference/api/index.md Outdated Show resolved Hide resolved
docs/public-networks/reference/api/index.md Outdated Show resolved Hide resolved
docs/public-networks/reference/api/index.md Outdated Show resolved Hide resolved
Co-authored-by: Alexandra Tran Carrillo <[email protected]>
Signed-off-by: Mike Sanko <[email protected]>
Copy link
Contributor

@alexandratran alexandratran left a comment

Choose a reason for hiding this comment

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

LGTM

@alexandratran alexandratran merged commit d681f15 into hyperledger:main Sep 25, 2023
8 checks passed
@mjsmike62 mjsmike62 deleted the 1385-update-parameter-description branch September 26, 2023 22:01
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.

Update blockNumber parameter descriptions
3 participants