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
|
// 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 (
"sync"
"time"
"github.com/dexon-foundation/dexon-consensus-core/common"
"github.com/dexon-foundation/dexon-consensus-core/core/blockdb"
"github.com/dexon-foundation/dexon-consensus-core/core/types"
"github.com/dexon-foundation/dexon-consensus-core/crypto"
)
// Shard represents a unit to produce a global ordering from multiple chains.
type Shard struct {
lock sync.RWMutex
ID uint32
nodeID types.NodeID
prvKey crypto.PrivateKey
sigToPub SigToPubFn
chainNum uint32
app Application
db blockdb.BlockDatabase
pool blockPool
lattice *blockLattice
toModule *totalOrdering
ctModule *consensusTimestamp
}
// NewShard constructs an Shard instance.
func NewShard(
ID uint32,
cfg *types.Config,
prvKey crypto.PrivateKey,
sigToPub SigToPubFn,
app Application,
db blockdb.BlockDatabase) (s *Shard) {
s = &Shard{
ID: ID,
nodeID: types.NewNodeID(prvKey.PublicKey()),
prvKey: prvKey,
sigToPub: sigToPub,
chainNum: cfg.NumChains,
app: app,
db: db,
pool: newBlockPool(cfg.NumChains),
lattice: newBlockLattice(ID, cfg.NumChains),
toModule: newTotalOrdering(
uint64(cfg.K),
uint64(float32(cfg.NumChains-1)*cfg.PhiRatio+1),
cfg.NumChains),
ctModule: newConsensusTimestamp(),
}
return
}
// PrepareBlock setup block's field based on current lattice status.
func (s *Shard) PrepareBlock(
b *types.Block, proposeTime time.Time) (err error) {
s.lock.RLock()
defer s.lock.RUnlock()
s.lattice.prepareBlock(b)
// TODO(mission): the proposeTime might be earlier than tip block of
// that chain. We should let blockLattice suggest the time.
b.ProposerID = s.nodeID
b.Timestamp = proposeTime
b.Payload = s.app.PreparePayload(b.Position)
if b.Hash, err = hashBlock(b); err != nil {
return
}
if b.Signature, err = s.prvKey.Sign(b.Hash); err != nil {
return
}
return
}
// SanityCheck check if a block is valid based on current lattice status.
//
// If some acking blocks don't exists, Shard would help to cache this block
// and retry when lattice updated in Shard.ProcessBlock.
func (s *Shard) SanityCheck(b *types.Block) (err error) {
// Check block.Position.
if b.Position.ShardID != s.ID {
err = ErrIncorrectBlockPosition
return
}
// Check the hash of block.
hash, err := hashBlock(b)
if err != nil || hash != b.Hash {
err = ErrIncorrectHash
return
}
// Check the signer.
pubKey, err := s.sigToPub(b.Hash, b.Signature)
if err != nil {
return
}
if !b.ProposerID.Equal(crypto.Keccak256Hash(pubKey.Bytes())) {
err = ErrIncorrectSignature
return
}
s.lock.RLock()
defer s.lock.RUnlock()
if err = s.lattice.sanityCheck(b); err != nil {
// Add to block pool, once the lattice updated,
// would be checked again.
if err == ErrAckingBlockNotExists {
s.pool.addBlock(b)
}
return
}
return
}
// ProcessBlock adds a block into lattice, and deliver ordered blocks.
// If any block pass sanity check after this block add into lattice, they
// would be returned, too.
//
// NOTE: assume the block passed sanity check.
func (s *Shard) ProcessBlock(
input *types.Block) (verified, delivered []*types.Block, err error) {
var (
tip, b *types.Block
toDelivered []*types.Block
inLattice []*types.Block
earlyDelivered bool
)
s.lock.Lock()
defer s.lock.Unlock()
if inLattice, err = s.lattice.addBlock(input); err != nil {
return
}
if err = s.db.Put(*input); err != nil {
return
}
// TODO(mission): remove this hack, BA related stuffs should not
// be done here.
s.app.StronglyAcked(input.Hash)
s.app.BlockConfirmed(input)
// Purge blocks in pool with the same chainID and lower height.
s.pool.purgeBlocks(input.Position.ChainID, input.Position.Height)
// Replay tips in pool to check their validity.
for i := uint32(0); i < s.chainNum; i++ {
if tip = s.pool.tip(i); tip == nil {
continue
}
err = s.lattice.sanityCheck(tip)
if err == nil {
verified = append(verified, tip)
}
if err == ErrAckingBlockNotExists {
continue
}
s.pool.removeTip(i)
}
// Perform total ordering for each block added to lattice.
for _, b = range inLattice {
toDelivered, earlyDelivered, err = s.toModule.processBlock(b)
if err != nil {
return
}
if len(toDelivered) == 0 {
continue
}
hashes := make(common.Hashes, len(toDelivered))
for idx := range toDelivered {
hashes[idx] = toDelivered[idx].Hash
}
s.app.TotalOrderingDeliver(hashes, earlyDelivered)
// Perform timestamp generation.
if err = s.ctModule.processBlocks(toDelivered); err != nil {
return
}
delivered = append(delivered, toDelivered...)
}
return
}
|