Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Commit

Permalink
adjust doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rphmeier committed Jun 19, 2020
1 parent 99466c0 commit 6d10f7f
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions roadmap/implementors-guide/src/types/backing.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,8 @@ enum Statement {
///
/// This variant should only be used in the production of `SignedStatement`s. The only difference between
/// this enum and `Statement` is that the `Seconded` variant contains a `Hash` instead of a `CandidateReceipt`.
/// The rationale behind the difference is that a `CandidateReceipt` contains `HeadData`, which does not have
/// bounded size. By using this enum instead, we ensure that the production and validation of signatures is fast
/// while retaining their necessary cryptographic properties.
/// The rationale behind the difference is that the signature should always be on the hash instead of the
/// full data, as this lowers the requirement for checking while retaining necessary cryptographic properties
enum CompactStatement {
/// A statement about a new candidate being seconded by a validator. This is an implicit validity vote.
Seconded(Hash),
Expand All @@ -92,7 +91,7 @@ enum CompactStatement {
A statement which has been [cryptographically signed](#signed-wrapper) by a validator.

```rust
/// A signed statement, containing the abridged candidate receipt in the `Seconded` variant.
/// A signed statement, containing the committed candidate receipt in the `Seconded` variant.
pub type SignedFullStatement = Signed<Statement, CompactStatement>;

/// A signed statement, containing only the hash.
Expand Down

0 comments on commit 6d10f7f

Please sign in to comment.