Skip to content

Check the validity and update the specs for the core types #1014

@cason

Description

@cason

We have section of our specification spec/core describing the core types adopted in CometBFT. While some minor changes have been made recently, the documentation itself appears to need a thorough review, for the sake of accuracy and possibly also completeness.

In particular, some validity predicates appear to be imprecise, for instance the restrictions regarding round numbers (tendermint/tendermint#10041), that probably also apply to other int fields (e.g., validator index) that are mistakenly restricted to be >0 when the 0 value is valid.

I also wonder whether there is a better way to keep this documentation consistent with the implementation (namely, the referenced data types) without manually editing Markdown tables.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P:tech-debtPriority: Technical debt that needs to be paid off to enable us to move faster, reliablydocumentationImprovements or additions to documentationspecSpecification-related

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions