search

cometbft / cometbft

CometBFT: A distributed, Byzantine fault-tolerant, deterministic state machine replication engine. A fork and successor to Tendermint Core.
https://docs.cometbft.com
Apache License 2.0
651 stars 481 forks source link

spec: Revise content of `spec/core/data_structures.md` #2211

Open cason opened 10 months ago

cason commented 10 months ago

The spec file https://github.com/cometbft/cometbft/blob/main/spec/core/data_structures.md:

Here we describe the data structures in the CometBFT blockchain and the rules for validating them.

However, when adapting it with PBTS parameters (#2206), we realized that possibly some descriptions and probably some validation rules are outdated or not matching the implementation.

It will be important to revise this content, as it is considered by developers and applications using CometBFT types.

NOTE: some updates were already performed in branch feature/pbts. Consider that as base branch or wait until it is merged to main.

cason commented 10 months ago

It is also a question whether this should be under spec, as it looks more like a reference documentation to me.

andynog commented 10 months ago

I agree this is more like a reference documentation and would fit well under the new reference section in the docs. There might be some bits of information on the doc that are more spec related but I believe it should be fine to be under reference. When you merge the feature/pbts and include the content for that we can move this doc.