mirrors/tendermint
1
0
Fork 0
mirror of https://github.com/tendermint/tendermint.git synced 2026-02-04 19:12:05 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
d22abb2001fc1439fedc21bedea7b6034bb31413
tendermint/proto
History
William Banfield 6ed2c42d7b Document steps for updating the timeout parameters. (#8217) 
closes: #8182 

This pull request adds documentation to the `UPGRADING.md` file as well as a set of deprecation checks for the old timeout parameters in the `config.toml` file. It additionally documents the parameters in the `genesis.md`.
2022-03-30 22:11:48 +00:00
..
tendermint
Document steps for updating the timeout parameters. (#8217)
2022-03-30 22:11:48 +00:00
buf.lock
proto: update proto generation to use buf (#7975)
2022-03-11 14:10:46 -05:00
buf.yaml
proto: update proto generation to use buf (#7975)
2022-03-11 14:10:46 -05:00
README.md
Fix broken Markdown links (#8214)
2022-03-29 12:07:12 -07:00

README.md

Protocol Buffers

This sections defines the protocol buffers used in Tendermint. This is split into two directories: spec, the types required for all implementations and tendermint, a set of types internal to the Go implementation. All generated go code is also stored in tendermint. More descriptions of the data structures are located in the spec directory as follows:

Process to generate protos

The .proto files within this section are core to the protocol and updates must be treated as such.

Steps

  1. Make an issue with the proposed change.
    • Within the issue members, from the Tendermint team will leave comments. If there is not consensus on the change an RFC may be requested. 1a. Submission of an RFC as a pull request should be made to facilitate further discussion. 1b. Merge the RFC.
  2. Make the necessary changes to the .proto file(s), core data structures and/or ABCI protocol.
  3. Rebuild the Go protocol buffers by running make proto-gen. Ensure that the project builds correctly by running make build.