Skip to content

Commit 9e73621

Browse files
committed
update godoc
1 parent 530e2d6 commit 9e73621

File tree

2 files changed

+2
-5
lines changed

2 files changed

+2
-5
lines changed

consensus/hotstuff/committee.go

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,12 @@ type Replicas interface {
6464
DKG(view uint64) (DKG, error)
6565

6666
// IdentitiesByEpoch returns a list of the legitimate HotStuff participants for the epoch
67-
// given by the input view. The list of participants is filtered by the provided selector.
67+
// given by the input view.
6868
// The returned list of HotStuff participants:
6969
// * contains nodes that are allowed to submit votes or timeouts within the given epoch
7070
// (un-ejected, non-zero weight at the beginning of the epoch)
7171
// * is ordered in the canonical order
7272
// * contains no duplicates.
73-
// The list of all legitimate HotStuff participants for the given epoch can be obtained by using `filter.Any`
7473
//
7574
// CAUTION: DO NOT use this method for validating block proposals.
7675
// CAUTION: This method considers epochs outside of Previous, Current, Next, w.r.t. the
@@ -109,13 +108,11 @@ type DynamicCommittee interface {
109108
Replicas
110109

111110
// IdentitiesByBlock returns a list of the legitimate HotStuff participants for the given block.
112-
// The list of participants is filtered by the provided selector.
113111
// The returned list of HotStuff participants:
114112
// * contains nodes that are allowed to submit proposals, votes, and timeouts
115113
// (un-ejected, non-zero weight at current block)
116114
// * is ordered in the canonical order
117115
// * contains no duplicates.
118-
// The list of all legitimate HotStuff participants for the given epoch can be obtained by using `filter.Any`
119116
//
120117
// No errors are expected during normal operation.
121118
IdentitiesByBlock(blockID flow.Identifier) (flow.IdentityList, error)

consensus/hotstuff/signature/block_signer_decoder.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
)
1212

1313
// BlockSignerDecoder is a wrapper around the `hotstuff.DynamicCommittee`, which implements
14-
// the auxilluary logic for de-coding signer indices of a block (header) to full node IDs
14+
// the auxiliary logic for de-coding signer indices of a block (header) to full node IDs
1515
type BlockSignerDecoder struct {
1616
hotstuff.DynamicCommittee
1717
}

0 commit comments

Comments
 (0)