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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
|
// Copyright 2018 The dexon-consensus-core Authors
// This file is part of the dexon-consensus-core library.
//
// The dexon-consensus-core 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-core 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-core library. If not, see
// <http://www.gnu.org/licenses/>.
package core
import (
"fmt"
"sort"
"sync"
"time"
"github.com/dexon-foundation/dexon-consensus-core/blockdb"
"github.com/dexon-foundation/dexon-consensus-core/common"
"github.com/dexon-foundation/dexon-consensus-core/core/types"
"github.com/dexon-foundation/dexon-consensus-core/crypto"
)
// SigToPubFn is a function to recover public key from signature.
type SigToPubFn func(hash common.Hash, signature crypto.Signature) (
crypto.PublicKey, error)
// ErrMissingBlockInfo would be reported if some information is missing when
// calling PrepareBlock. It implements error interface.
type ErrMissingBlockInfo struct {
MissingField string
}
func (e *ErrMissingBlockInfo) Error() string {
return "missing " + e.MissingField + " in block"
}
// Errors for consensus core.
var (
ErrProposerNotValidator = fmt.Errorf(
"proposer is not a validator")
ErrIncorrectHash = fmt.Errorf(
"hash of block is incorrect")
ErrIncorrectSignature = fmt.Errorf(
"signature of block is incorrect")
ErrGenesisBlockNotEmpty = fmt.Errorf(
"genesis block should be empty")
)
// Consensus implements DEXON Consensus algorithm.
type Consensus struct {
ID types.ValidatorID
app Application
gov Governance
rbModule *reliableBroadcast
toModule *totalOrdering
ctModule *consensusTimestamp
ccModule *compactionChain
db blockdb.BlockDatabase
network Network
tick *time.Ticker
prvKey crypto.PrivateKey
sigToPub SigToPubFn
lock sync.RWMutex
stopChan chan struct{}
}
// NewConsensus construct an Consensus instance.
func NewConsensus(
app Application,
gov Governance,
db blockdb.BlockDatabase,
network Network,
tick *time.Ticker,
prv crypto.PrivateKey,
sigToPub SigToPubFn) *Consensus {
validatorSet := gov.GetValidatorSet()
// Setup acking by information returned from Governace.
rb := newReliableBroadcast()
rb.setChainNum(len(validatorSet))
for vID := range validatorSet {
rb.addValidator(vID)
}
// Setup sequencer by information returned from Governace.
var validators types.ValidatorIDs
for vID := range validatorSet {
validators = append(validators, vID)
}
to := newTotalOrdering(
uint64(gov.GetTotalOrderingK()),
uint64(float32(len(validatorSet)-1)*gov.GetPhiRatio()+1),
validators)
return &Consensus{
ID: types.NewValidatorID(prv.PublicKey()),
rbModule: rb,
toModule: to,
ctModule: newConsensusTimestamp(),
ccModule: newCompactionChain(db, sigToPub),
app: newNonBlockingApplication(app),
gov: gov,
db: db,
network: network,
tick: tick,
prvKey: prv,
sigToPub: sigToPub,
stopChan: make(chan struct{}),
}
}
// Run starts running Consensus core.
func (con *Consensus) Run() {
go con.processMsg(con.network.ReceiveChan())
chainID := uint64(0)
hashes := make(common.Hashes, 0, len(con.gov.GetValidatorSet()))
for vID := range con.gov.GetValidatorSet() {
hashes = append(hashes, vID.Hash)
}
sort.Sort(hashes)
for i, hash := range hashes {
if hash == con.ID.Hash {
chainID = uint64(i)
break
}
}
genesisBlock := &types.Block{
ProposerID: con.ID,
ChainID: chainID,
}
if err := con.PrepareGenesisBlock(genesisBlock, time.Now().UTC()); err != nil {
fmt.Println(err)
}
if err := con.ProcessBlock(genesisBlock); err != nil {
fmt.Println(err)
}
con.network.BroadcastBlock(genesisBlock)
ProposingBlockLoop:
for {
select {
case <-con.tick.C:
case <-con.stopChan:
break ProposingBlockLoop
}
block := &types.Block{
ProposerID: con.ID,
ChainID: chainID,
}
if err := con.PrepareBlock(block, time.Now().UTC()); err != nil {
fmt.Println(err)
}
if err := con.ProcessBlock(block); err != nil {
fmt.Println(err)
}
con.network.BroadcastBlock(block)
}
}
// Stop the Consensus core.
func (con *Consensus) Stop() {
con.stopChan <- struct{}{}
con.stopChan <- struct{}{}
}
func (con *Consensus) processMsg(msgChan <-chan interface{}) {
for {
var msg interface{}
select {
case msg = <-msgChan:
case <-con.stopChan:
return
}
switch val := msg.(type) {
case *types.Block:
if err := con.ProcessBlock(val); err != nil {
fmt.Println(err)
}
types.RecycleBlock(val)
case *types.NotaryAck:
if err := con.ProcessNotaryAck(val); err != nil {
fmt.Println(err)
}
case *types.Vote:
if err := con.ProcessVote(val); err != nil {
fmt.Println(err)
}
}
}
}
// ProcessVote is the entry point to submit ont vote to a Consensus instance.
func (con *Consensus) ProcessVote(vote *types.Vote) (err error) {
return
}
// sanityCheck checks if the block is a valid block
func (con *Consensus) sanityCheck(b *types.Block) (err error) {
// Check the hash of block.
hash, err := hashBlock(b)
if err != nil || hash != b.Hash {
return ErrIncorrectHash
}
// Check the signer.
pubKey, err := con.sigToPub(b.Hash, b.Signature)
if err != nil {
return err
}
if !b.ProposerID.Equal(crypto.Keccak256Hash(pubKey.Bytes())) {
return ErrIncorrectSignature
}
return nil
}
// ProcessBlock is the entry point to submit one block to a Consensus instance.
func (con *Consensus) ProcessBlock(b *types.Block) (err error) {
// TODO(jimmy-dexon): BlockConverter.Block() is called twice in this method.
if err := con.sanityCheck(b); err != nil {
return err
}
var (
deliveredBlocks []*types.Block
earlyDelivered bool
)
// To avoid application layer modify the content of block during
// processing, we should always operate based on the cloned one.
b = b.Clone()
con.lock.Lock()
defer con.lock.Unlock()
// Perform reliable broadcast checking.
if err = con.rbModule.processBlock(b); err != nil {
return err
}
con.app.BlockConfirmed(b.Clone())
for _, b := range con.rbModule.extractBlocks() {
// Notify application layer that some block is strongly acked.
con.app.StronglyAcked(b.Hash)
// Perform total ordering.
deliveredBlocks, earlyDelivered, err = con.toModule.processBlock(b)
if err != nil {
return
}
if len(deliveredBlocks) == 0 {
continue
}
for _, b := range deliveredBlocks {
if err = con.db.Put(*b); err != nil {
return
}
}
// TODO(mission): handle membership events here.
hashes := make(common.Hashes, len(deliveredBlocks))
for idx := range deliveredBlocks {
hashes[idx] = deliveredBlocks[idx].Hash
}
con.app.TotalOrderingDeliver(hashes, earlyDelivered)
// Perform timestamp generation.
deliveredBlocks, _, err = con.ctModule.processBlocks(
deliveredBlocks)
if err != nil {
return
}
for _, b := range deliveredBlocks {
if err = con.ccModule.processBlock(b); err != nil {
return
}
if err = con.db.Update(*b); err != nil {
return
}
con.app.DeliverBlock(b.Hash, b.Notary.Timestamp)
// TODO(mission): Find a way to safely recycle the block.
// We should deliver block directly to
// nonBlockingApplication and let them recycle the
// block.
}
var notaryAck *types.NotaryAck
notaryAck, err = con.ccModule.prepareNotaryAck(con.prvKey)
if err != nil {
return
}
err = con.ProcessNotaryAck(notaryAck)
if err != nil {
return
}
con.app.NotaryAckDeliver(notaryAck)
}
return
}
func (con *Consensus) checkPrepareBlock(
b *types.Block, proposeTime time.Time) (err error) {
if (b.ProposerID == types.ValidatorID{}) {
err = &ErrMissingBlockInfo{MissingField: "ProposerID"}
return
}
return
}
// PrepareBlock would setup header fields of block based on its ProposerID.
func (con *Consensus) PrepareBlock(b *types.Block,
proposeTime time.Time) (err error) {
if err = con.checkPrepareBlock(b, proposeTime); err != nil {
return
}
con.lock.RLock()
defer con.lock.RUnlock()
con.rbModule.prepareBlock(b)
b.Timestamps[b.ProposerID] = proposeTime
b.Payloads = con.app.PreparePayloads(b.ShardID, b.ChainID, b.Height)
b.Hash, err = hashBlock(b)
if err != nil {
return
}
b.Signature, err = con.prvKey.Sign(b.Hash)
if err != nil {
return
}
return
}
// PrepareGenesisBlock would setup header fields for genesis block.
func (con *Consensus) PrepareGenesisBlock(b *types.Block,
proposeTime time.Time) (err error) {
if err = con.checkPrepareBlock(b, proposeTime); err != nil {
return
}
if len(b.Payloads) != 0 {
err = ErrGenesisBlockNotEmpty
return
}
b.Height = 0
b.ParentHash = common.Hash{}
b.Acks = make(map[common.Hash]struct{})
b.Timestamps = make(map[types.ValidatorID]time.Time)
for vID := range con.gov.GetValidatorSet() {
b.Timestamps[vID] = time.Time{}
}
b.Timestamps[b.ProposerID] = proposeTime
b.Hash, err = hashBlock(b)
if err != nil {
return
}
b.Signature, err = con.prvKey.Sign(b.Hash)
if err != nil {
return
}
return
}
// ProcessNotaryAck is the entry point to submit one notary ack.
func (con *Consensus) ProcessNotaryAck(notaryAck *types.NotaryAck) (err error) {
notaryAck = notaryAck.Clone()
if _, exists := con.gov.GetValidatorSet()[notaryAck.ProposerID]; !exists {
err = ErrProposerNotValidator
return
}
err = con.ccModule.processNotaryAck(notaryAck)
return
}
// NotaryAcks returns the latest NotaryAck received from all other validators.
func (con *Consensus) NotaryAcks() map[types.ValidatorID]*types.NotaryAck {
return con.ccModule.notaryAcks()
}
|