From aef2191e2a51d99e3c7df48c66da57ea9122c231 Mon Sep 17 00:00:00 2001 From: William Banfield <4561443+williambanfield@users.noreply.github.com> Date: Mon, 13 Dec 2021 19:19:33 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Callum Waters --- docs/rfc/rfc-007-deterministic-proto-bytes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/rfc/rfc-007-deterministic-proto-bytes.md b/docs/rfc/rfc-007-deterministic-proto-bytes.md index 1e39135f4..5b7c678a7 100644 --- a/docs/rfc/rfc-007-deterministic-proto-bytes.md +++ b/docs/rfc/rfc-007-deterministic-proto-bytes.md @@ -80,8 +80,8 @@ This could be implemented as a function in many languages that performed the fol 4. Set our proto decoder package to remove unknown fields on deserialization. This would still require that messages never unmarshal data structures with unknown fields. -This can be accomplished by defining adding fields to a structure that needs canonicalization -as a breaking changes within our semantic versioning and disallowing it within a major version. +This can be accomplished by defining the act of adding fields to a structure that needs canonicalization +as a breaking change within our semantic versioning and disallowing it within a major version. I.e., two versions of Tendermint that have different fields in proto messages which require canonical byte representation will not be able to interoperate. @@ -90,7 +90,7 @@ This could be implemented in multiple languages more simply than ensuring that t canonical proto serializers that match in each language. Finally, we should add clear documentation to the Tendermint codebase every time we -compare hashes of proto messages or use proto serialized bytes to produces a +compare hashes of proto messages or use proto serialized bytes to produce digital signatures that we have been careful to ensure that the hashes are performed properly.