Commit Graph

4 Commits

Author SHA1 Message Date
Cory 308ee267a8
Followup suggestions from ADR-027 updates (#7232) (#7379)
* add grammar suggestions to adr-027

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-09-28 09:42:57 +00:00
Robert Zaremba 09998ef86e
adr-27: adding (#7232)
* adr-27: adding 

Each ADR should have an abstract and an example use case to quickly present the goal.
Here, adding this to DR 027: Deterministic Protobuf Serialization

* review update

* added link to TxRaw

* added list of major use-cases

* updated wording in context and abstract

* updated the adr-020 part

* add consequences and motivation for TxRaw

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* rewording

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
Co-authored-by: Simon Warta <2603011+webmaster128@users.noreply.github.com>
Co-authored-by: Cory <cjlevinson@gmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-09-23 23:06:55 +00:00
John Adler 2bb9a241bb
ADR-027: Make rules more precise (#7220)
* Update changelog.

* Fix typos.

* Remove 'by default' from packed encoding rule.

* Further specify longer requirement.

* Clarify that bool must have value of 1 if included.

* Fix typo variant -> varint.

* Disambiguate rule 3.

* Add more reasoning for requirements on zeroes.

* Reword rules to make bit restrictions clearer. Add exception for negative int32.

* Add reference for signed integer encoding.

* Clarify rule for signed int requirement.

* Deterministic -> bijective.

* Normalize spacing in 'protobuf 3'.

* Add background to clarify 70 bits.

* Fix nit: all -> most.

* Clarify is -> must.

Co-authored-by: Alessio Treglia <alessio@tendermint.com>
2020-09-11 14:46:37 +00:00
Simon Warta 1b9f144b9d
Propose ADR 027: Deterministic Protobuf Serialization (#6979)
* Add ADR 026: Protocol Buffer Regencode

* Use Regencode in ADR-020

* Apply suggestions from code review

Co-authored-by: Aaron Craelius <aaron@regen.network>

* Add reasoning behind omitting empty fields

* Rename to ADR 026: Deterministic Protobuf Serialization

* i++

* explicitely -> explicitly

* Fix description of optional values

* Update reasoning behind omitting default values

* Fix empty -> defaut

* Update docs/architecture/adr-027-deterministic-protobuf-serialization.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Add rules to avoid duplicate encoding and specify packed fields

* Add rule for variant encoding

* Add surrogate pair to test UTF-8 encoding

Co-authored-by: Aaron Craelius <aaron@regen.network>
Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
2020-08-19 17:22:15 +00:00