chore: improve docs

dashpay · Dec 12, 2023 · 6083720 · 6083720
1 parent d26b1c8
commit 6083720
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/proto/tendermint/abci/types.proto b/proto/tendermint/abci/types.proto
@@ -452,7 +452,9 @@ message RequestVerifyVoteExtension {
   repeated ExtendVoteExtension vote_extensions = 5;
   // Sign ID that will be used to sign the vote extensions.
   // If not set, Tenderdash will generate it based on height and round.
-  // It should be unique per voting round.
+
+  // If set, it SHOULD be unique per voting round, and it MUST start with `dpbvote` string.
+  //
   // Use with caution - it can have severe security consequences.
   optional bytes sign_id = 6;
 }

diff --git a/spec/abci++/api.md b/spec/abci++/api.md
@@ -773,8 +773,12 @@ from this condition, but not sure), and _p_ receives a Precommit message for rou
 | validator_pro_tx_hash | [bytes](#bytes) |  | ProTxHash of the validator that signed the extensions. |
 | height | [int64](#int64) |  | Height of the block (for sanity check). |
 | round | [int32](#int32) |  | Round number for the block. |
-| vote_extensions | [ExtendVoteExtension](#tendermint-abci-ExtendVoteExtension) | repeated | Application-specific information signed by Tenderdash. Can have 0 length. |
-| sign_id | [bytes](#bytes) | optional | Sign ID that will be used to sign the vote extensions. If not set, Tenderdash will generate it based on height and round. It should be unique per voting round. Use with caution - it can have severe security consequences. |
+| vote_extensions | [ExtendVoteExtension](#tendermint-abci-ExtendVoteExtension) | repeated | Application-specific information signed by Tenderdash. Can have 0 length.
+
+Sign ID that will be used to sign the vote extensions. If not set, Tenderdash will generate it based on height and round. |
+| sign_id | [bytes](#bytes) | optional | If set, it SHOULD be unique per voting round, and it MUST start with `dpbvote` string.
+
+Use with caution - it can have severe security consequences. |