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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus library is free software: you can redistribute it
// and/or modify it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// The dexon-consensus library is distributed in the hope that it will be
// useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
// General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the dexon-consensus library. If not, see
// <http://www.gnu.org/licenses/>.
package core
import (
"time"
"github.com/dexon-foundation/dexon-consensus/common"
"github.com/dexon-foundation/dexon-consensus/core/crypto"
"github.com/dexon-foundation/dexon-consensus/core/types"
typesDKG "github.com/dexon-foundation/dexon-consensus/core/types/dkg"
)
// Application describes the application interface that interacts with DEXON
// consensus core.
type Application interface {
// PreparePayload is called when consensus core is preparing a block.
PreparePayload(position types.Position) ([]byte, error)
// PrepareWitness will return the witness data no lower than consensusHeight.
PrepareWitness(consensusHeight uint64) (types.Witness, error)
// VerifyBlock verifies if the block is valid.
VerifyBlock(block *types.Block) types.BlockVerifyStatus
// BlockConfirmed is called when a block is confirmed and added to lattice.
BlockConfirmed(block types.Block)
// BlockDelivered is called when a block is added to the compaction chain.
BlockDelivered(blockHash common.Hash,
blockPosition types.Position, result types.FinalizationResult)
}
// Debug describes the application interface that requires
// more detailed consensus execution.
type Debug interface {
// BlockReceived is called when the block received in agreement.
BlockReceived(common.Hash)
// TotalOrderingDelivered is called when the total ordering algorithm deliver
// a set of block.
TotalOrderingDelivered(common.Hashes, uint32)
// BlockReady is called when the block's randomness is ready.
BlockReady(common.Hash)
}
// Network describs the network interface that interacts with DEXON consensus
// core.
type Network interface {
// PullBlocks tries to pull blocks from the DEXON network.
PullBlocks(hashes common.Hashes)
// PullVotes tries to pull votes from the DEXON network.
PullVotes(position types.Position)
// PullRandomness tries to pull randomness from the DEXON network.
PullRandomness(hashes common.Hashes)
// BroadcastVote broadcasts vote to all nodes in DEXON network.
BroadcastVote(vote *types.Vote)
// BroadcastBlock broadcasts block to all nodes in DEXON network.
BroadcastBlock(block *types.Block)
// BroadcastAgreementResult broadcasts agreement result to DKG set.
BroadcastAgreementResult(randRequest *types.AgreementResult)
// BroadcastRandomnessResult broadcasts rand request to Notary set.
BroadcastRandomnessResult(randResult *types.BlockRandomnessResult)
// SendDKGPrivateShare sends PrivateShare to a DKG participant.
SendDKGPrivateShare(pub crypto.PublicKey, prvShare *typesDKG.PrivateShare)
// BroadcastDKGPrivateShare broadcasts PrivateShare to all DKG participants.
BroadcastDKGPrivateShare(prvShare *typesDKG.PrivateShare)
// BroadcastDKGPartialSignature broadcasts partialSignature to all
// DKG participants.
BroadcastDKGPartialSignature(psig *typesDKG.PartialSignature)
// ReceiveChan returns a channel to receive messages from DEXON network.
ReceiveChan() <-chan interface{}
}
// Governance interface specifies interface to control the governance contract.
// Note that there are a lot more methods in the governance contract, that this
// interface only define those that are required to run the consensus algorithm.
type Governance interface {
// Configuration returns the configuration at a given round.
// Return the genesis configuration if round == 0.
Configuration(round uint64) *types.Config
// CRS returns the CRS for a given round.
// Return the genesis CRS if round == 0.
CRS(round uint64) common.Hash
// Propose a CRS of round.
ProposeCRS(round uint64, signedCRS []byte)
// NodeSet returns the node set at a given round.
// Return the genesis node set if round == 0.
NodeSet(round uint64) []crypto.PublicKey
// NotifyRoundHeight notifies governance contract the consensus height of
// the first block of the given round.
NotifyRoundHeight(targetRound, consensusHeight uint64)
//// DKG-related methods.
// AddDKGComplaint adds a DKGComplaint.
AddDKGComplaint(round uint64, complaint *typesDKG.Complaint)
// DKGComplaints gets all the DKGComplaints of round.
DKGComplaints(round uint64) []*typesDKG.Complaint
// AddDKGMasterPublicKey adds a DKGMasterPublicKey.
AddDKGMasterPublicKey(round uint64, masterPublicKey *typesDKG.MasterPublicKey)
// DKGMasterPublicKeys gets all the DKGMasterPublicKey of round.
DKGMasterPublicKeys(round uint64) []*typesDKG.MasterPublicKey
// AddDKGMPKReady adds a DKG ready message.
AddDKGMPKReady(round uint64, ready *typesDKG.MPKReady)
// IsDKGFinal checks if DKG is ready.
IsDKGMPKReady(round uint64) bool
// AddDKGFinalize adds a DKG finalize message.
AddDKGFinalize(round uint64, final *typesDKG.Finalize)
// IsDKGFinal checks if DKG is final.
IsDKGFinal(round uint64) bool
// ReportForkVote reports a node for forking votes.
ReportForkVote(vote1, vote2 *types.Vote)
// ReportForkBlock reports a node for forking blocks.
ReportForkBlock(block1, block2 *types.Block)
}
// Ticker define the capability to tick by interval.
type Ticker interface {
// Tick would return a channel, which would be triggered until next tick.
Tick() <-chan time.Time
// Stop the ticker.
Stop()
}
|
