-
Notifications
You must be signed in to change notification settings - Fork 59
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
feat(fw,docs): Add eof/t8n tools specs, fix JSON schema generation in docs #549
base: main
Are you sure you want to change the base?
Conversation
Hey @winsvega, I revamped the specs and introduced the JSON schemas for all types that the tools are expected to parse or output, including examples for most JSON types. Use |
I am getting lost now. there was a nice description with examples the auto docs gen is ok, but I am not the type of a person who could read that. looks like the generated doc is about eof test parser, not the eof tool. with t8n however need more examples on all the types. yes.
this can also be hex, but not padded. "0x1", "0x2" also we have a notation here that if currentDifficulty not set, then there must be parentDifficulty and parentTimestamp so the tool will calculate currentDifficulty itself to be used for difficulty tests. same with bsefee |
Yes we now have auto-gen of these specs, I think it's important because with each fork we introduce new fields to the I really like the example parts of the new auto-gen doc, more than the parameters, I think the types are one of the most important aspects.
Yes I think it should only be hex, not decimal, more so when the other fields like
This could definitely be added to the schema, I think we could have something like this: currentBaseFee:
anyOf:
- pattern: ^([0-9]|[1-9][0-9]+)$
title: number
type: string
- type: 'null'
default: null
title: Currentbasefee
fork: London Although this is not within the standard of the JSON schema: https://json-schema.org/understanding-json-schema/reference/annotations |
@winsvega Updated |
update specs for stdin with multiple vectors
eof valid output contains section bytes
ποΈ Description
Specs for eof tool implementation,
π Related Issues
β Checklist
mkdocs serve
locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.