-
Notifications
You must be signed in to change notification settings - Fork 666
/
consensus.go
58 lines (45 loc) · 1.81 KB
/
consensus.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
// Copyright (C) 2019-2021, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package snowman
import (
"github.com/ava-labs/avalanchego/ids"
"github.com/ava-labs/avalanchego/snow"
"github.com/ava-labs/avalanchego/snow/consensus/snowball"
)
// Consensus represents a general snowman instance that can be used directly to
// process a series of dependent operations.
type Consensus interface {
// Takes in the context, snowball parameters, and the last accepted block.
Initialize(
ctx *snow.ConsensusContext,
params snowball.Parameters,
lastAcceptedID ids.ID,
lastAcceptedHeight uint64,
) error
// Returns the parameters that describe this snowman instance
Parameters() snowball.Parameters
// Returns the number of blocks processing
NumProcessing() int
// Adds a new decision. Assumes the dependency has already been added.
// Returns if a critical error has occurred.
Add(Block) error
// Decided returns true if the block has been decided.
Decided(Block) bool
// Processing returns true if the block ID is currently processing.
Processing(ids.ID) bool
// IsPreferred returns true if the block is currently on the preferred
// chain.
IsPreferred(Block) bool
// Returns the ID of the tail of the strongly preferred sequence of
// decisions.
Preference() ids.ID
// RecordPoll collects the results of a network poll. Assumes all decisions
// have been previously added. Returns if a critical error has occurred.
RecordPoll(ids.Bag) error
// Finalized returns true if all decisions that have been added have been
// finalized. Note, it is possible that after returning finalized, a new
// decision may be added such that this instance is no longer finalized.
Finalized() bool
// HealthCheck returns information about the consensus health.
HealthCheck() (interface{}, error)
}