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
|
// 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/>.
// TODO(jimmy-dexon): remove comments of WitnessAck before open source.
package types
import (
"bytes"
"fmt"
"io"
"sort"
"sync"
"time"
"github.com/dexon-foundation/dexon/rlp"
"github.com/dexon-foundation/dexon-consensus-core/common"
"github.com/dexon-foundation/dexon-consensus-core/core/crypto"
)
// BlockVerifyStatus is the return code for core.Application.VerifyBlock
type BlockVerifyStatus int
// Enums for return value of core.Application.VerifyBlock.
const (
// VerifyOK: Block is verified.
VerifyOK BlockVerifyStatus = iota
// VerifyRetryLater: Block is unable to be verified at this moment.
// Try again later.
VerifyRetryLater
// VerifyInvalidBlock: Block is an invalid one.
VerifyInvalidBlock
)
var (
// blockPool is the blocks cache to reuse allocated blocks.
blockPool = sync.Pool{
New: func() interface{} {
return &Block{}
},
}
)
type rlpTimestamp struct {
time.Time
}
func (t *rlpTimestamp) EncodeRLP(w io.Writer) error {
return rlp.Encode(w, uint64(t.UTC().UnixNano()))
}
func (t *rlpTimestamp) DecodeRLP(s *rlp.Stream) error {
var nano uint64
err := s.Decode(&nano)
if err == nil {
sec := int64(nano) / 1000000000
nsec := int64(nano) % 1000000000
t.Time = time.Unix(sec, nsec).UTC()
}
return err
}
// FinalizationResult represents the result of DEXON consensus algorithm.
type FinalizationResult struct {
ParentHash common.Hash `json:"parent_hash"`
Randomness []byte `json:"randomness"`
Timestamp time.Time `json:"timestamp"`
Height uint64 `json:"height"`
}
type rlpFinalizationResult struct {
ParentHash common.Hash
Randomness []byte
Timestamp *rlpTimestamp
Height uint64
}
// EncodeRLP implements rlp.Encoder
func (f *FinalizationResult) EncodeRLP(w io.Writer) error {
return rlp.Encode(w, &rlpFinalizationResult{
ParentHash: f.ParentHash,
Randomness: f.Randomness,
Timestamp: &rlpTimestamp{f.Timestamp},
Height: f.Height,
})
}
// DecodeRLP implements rlp.Decoder
func (f *FinalizationResult) DecodeRLP(s *rlp.Stream) error {
var dec rlpFinalizationResult
err := s.Decode(&dec)
if err == nil {
*f = FinalizationResult{
ParentHash: dec.ParentHash,
Randomness: dec.Randomness,
Timestamp: dec.Timestamp.Time,
Height: dec.Height,
}
}
return err
}
// Witness represents the consensus information on the compaction chain.
type Witness struct {
Height uint64 `json:"height"`
Data []byte `json:"data"`
}
// RecycleBlock put unused block into cache, which might be reused if
// not garbage collected.
func RecycleBlock(b *Block) {
blockPool.Put(b)
}
// NewBlock initiate a block.
func NewBlock() (b *Block) {
b = blockPool.Get().(*Block)
b.Acks = b.Acks[:0]
return
}
// Block represents a single event broadcasted on the network.
type Block struct {
ProposerID NodeID `json:"proposer_id"`
ParentHash common.Hash `json:"parent_hash"`
Hash common.Hash `json:"hash"`
Position Position `json:"position"`
Timestamp time.Time `json:"timestamp"`
Acks common.SortedHashes `json:"acks"`
Payload []byte `json:"payload"`
PayloadHash common.Hash `json:"payload_hash"`
Witness Witness `json:"witness"`
Finalization FinalizationResult `json:"finalization"`
Signature crypto.Signature `json:"signature"`
CRSSignature crypto.Signature `json:"crs_signature"`
}
type rlpBlock struct {
ProposerID NodeID
ParentHash common.Hash
Hash common.Hash
Position Position
Timestamp *rlpTimestamp
Acks common.SortedHashes
Payload []byte
PayloadHash common.Hash
Witness *Witness
Finalization *FinalizationResult
Signature crypto.Signature
CRSSignature crypto.Signature
}
// EncodeRLP implements rlp.Encoder
func (b *Block) EncodeRLP(w io.Writer) error {
return rlp.Encode(w, rlpBlock{
ProposerID: b.ProposerID,
ParentHash: b.ParentHash,
Hash: b.Hash,
Position: b.Position,
Timestamp: &rlpTimestamp{b.Timestamp},
Acks: b.Acks,
Payload: b.Payload,
PayloadHash: b.PayloadHash,
Witness: &b.Witness,
Finalization: &b.Finalization,
Signature: b.Signature,
CRSSignature: b.CRSSignature,
})
}
// DecodeRLP implements rlp.Decoder
func (b *Block) DecodeRLP(s *rlp.Stream) error {
var dec rlpBlock
err := s.Decode(&dec)
if err == nil {
*b = Block{
ProposerID: dec.ProposerID,
ParentHash: dec.ParentHash,
Hash: dec.Hash,
Position: dec.Position,
Timestamp: dec.Timestamp.Time,
Acks: dec.Acks,
Payload: dec.Payload,
PayloadHash: dec.PayloadHash,
Witness: *dec.Witness,
Finalization: *dec.Finalization,
Signature: dec.Signature,
CRSSignature: dec.CRSSignature,
}
}
return err
}
func (b *Block) String() string {
return fmt.Sprintf("Block(%v:%d:%d)", b.Hash.String()[:6],
b.Position.ChainID, b.Position.Height)
}
// Clone returns a deep copy of a block.
func (b *Block) Clone() (bcopy *Block) {
bcopy = NewBlock()
bcopy.ProposerID = b.ProposerID
bcopy.ParentHash = b.ParentHash
bcopy.Hash = b.Hash
bcopy.Position.Round = b.Position.Round
bcopy.Position.ChainID = b.Position.ChainID
bcopy.Position.Height = b.Position.Height
bcopy.Signature = b.Signature.Clone()
bcopy.CRSSignature = b.CRSSignature.Clone()
bcopy.Finalization.ParentHash = b.Finalization.ParentHash
bcopy.Finalization.Timestamp = b.Finalization.Timestamp
bcopy.Finalization.Height = b.Finalization.Height
bcopy.Witness.Height = b.Witness.Height
bcopy.Witness.Data = make([]byte, len(b.Witness.Data))
copy(bcopy.Witness.Data, b.Witness.Data)
bcopy.Timestamp = b.Timestamp
bcopy.Acks = make(common.SortedHashes, len(b.Acks))
copy(bcopy.Acks, b.Acks)
bcopy.Payload = make([]byte, len(b.Payload))
copy(bcopy.Payload, b.Payload)
bcopy.PayloadHash = b.PayloadHash
bcopy.Finalization.Randomness = make([]byte, len(b.Finalization.Randomness))
copy(bcopy.Finalization.Randomness, b.Finalization.Randomness)
return
}
// IsGenesis checks if the block is a genesisBlock
func (b *Block) IsGenesis() bool {
return b.Position.Height == 0 && b.ParentHash == common.Hash{}
}
// IsFinalized checks if the finalization data is ready.
func (b *Block) IsFinalized() bool {
return b.Finalization.Height != 0
}
// IsEmpty checks if the block is an 'empty block'.
func (b *Block) IsEmpty() bool {
return b.ProposerID.Hash == common.Hash{}
}
// IsAcking checks if a block acking another by it's hash.
func (b *Block) IsAcking(hash common.Hash) bool {
idx := sort.Search(len(b.Acks), func(i int) bool {
return bytes.Compare(b.Acks[i][:], hash[:]) >= 0
})
return !(idx == len(b.Acks) || b.Acks[idx] != hash)
}
// ByHash is the helper type for sorting slice of blocks by hash.
type ByHash []*Block
func (b ByHash) Len() int {
return len(b)
}
func (b ByHash) Less(i int, j int) bool {
return bytes.Compare([]byte(b[i].Hash[:]), []byte(b[j].Hash[:])) == -1
}
func (b ByHash) Swap(i int, j int) {
b[i], b[j] = b[j], b[i]
}
// ByPosition is the helper type for sorting slice of blocks by position.
type ByPosition []*Block
// Len implements Len method in sort.Sort interface.
func (bs ByPosition) Len() int {
return len(bs)
}
// Less implements Less method in sort.Sort interface.
func (bs ByPosition) Less(i int, j int) bool {
return bs[j].Position.Newer(&bs[i].Position)
}
// Swap implements Swap method in sort.Sort interface.
func (bs ByPosition) Swap(i int, j int) {
bs[i], bs[j] = bs[j], bs[i]
}
// Push implements Push method in heap interface.
func (bs *ByPosition) Push(x interface{}) {
*bs = append(*bs, x.(*Block))
}
// Pop implements Pop method in heap interface.
func (bs *ByPosition) Pop() (ret interface{}) {
n := len(*bs)
*bs, ret = (*bs)[0:n-1], (*bs)[n-1]
return
}
// ByFinalizationHeight is the helper type for sorting slice of blocks by
// finalization height.
type ByFinalizationHeight []*Block
// Len implements Len method in sort.Sort interface.
func (bs ByFinalizationHeight) Len() int {
return len(bs)
}
// Less implements Less method in sort.Sort interface.
func (bs ByFinalizationHeight) Less(i int, j int) bool {
return bs[i].Finalization.Height < bs[j].Finalization.Height
}
// Swap implements Swap method in sort.Sort interface.
func (bs ByFinalizationHeight) Swap(i int, j int) {
bs[i], bs[j] = bs[j], bs[i]
}
// Push implements Push method in heap interface.
func (bs *ByFinalizationHeight) Push(x interface{}) {
*bs = append(*bs, x.(*Block))
}
// Pop implements Pop method in heap interface.
func (bs *ByFinalizationHeight) Pop() (ret interface{}) {
n := len(*bs)
*bs, ret = (*bs)[0:n-1], (*bs)[n-1]
return
}
|