-
Notifications
You must be signed in to change notification settings - Fork 429
Add examples for engine
methods
#465
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
Conversation
This is great! I wish Engine API were getting these examples in its early days :-D I understand that they are brought from Besu API docs and happy to merge this PR as is. But the following additions would be really nice:
|
Spellchecker has a problem with hex strings. I have found the following solution to that: - name: json schemas
...
pipeline:
- pyspelling.filters.context:
context_visible_first: true
delimiters:
- open: ''
content: 0x[a-fA-F0-9]+
close: '' cc @lightclient |
@mkalinin thanks for the feedback. I've made the additions as per your request, but I need some confirmation and additional input for some of the added examples. In particular, can you provide good examples for the following parameters?
|
engine
methodsengine
methods
I think you can find good examples of these methods calls in the Hive logs, for instance, here is the Besu logs of Cancun Engine API checks. |
@mkalinin Thanks, added in the missing examples. |
- '0xc00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000' | ||
- '0x80c5f2e1eb23939cf3600f61872e3e9964d0acafb440634e530d6139a193b889c56a0c07d737729dbe0626706fc9f25f' | ||
- '0x98daeed734da114470da559bd4b4c7259e1f7952555241dcbc90cf194a2ef676fc6005f3672fada2a3645edb297a7553' | ||
blobs: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Blobs are huge! Maybe we want to trim its values, curious what others think about it? cc @lightclient
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work! thank you!
Add examples for:
engine_exchangeCapabilities
engine_exchangeTransitionConfigurationV1
engine_forkchoiceUpdatedV1
engine_forkchoiceUpdatedV2
engine_forkchoiceUpdatedV3
engine_getPayloadBodiesByHashV1
engine_getPayloadBodiesByRangeV1
engine_getPayloadV1
engine_getPayloadV2
engine_getPayloadV3
engine_newPayloadV1
engine_newPayloadV2
engine_newPayloadV3
The V1 examples are taken from the Besu Engine API docs.
This will be one in a series of PRs adding examples to this OpenRPC spec.