aboutsummaryrefslogtreecommitdiffstats
path: root/core/types/block.go
blob: 61cb458274e1b6e13878aaeedbe0263b4a72226e (plain) (blame)
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
// 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"
    "sort"
    "sync"
    "time"

    "github.com/dexon-foundation/dexon-consensus-core/common"
    "github.com/dexon-foundation/dexon-consensus-core/crypto"
)

var (
    // blockPool is the blocks cache to reuse allocated blocks.
    blockPool = sync.Pool{
        New: func() interface{} {
            return &Block{}
        },
    }
)

// 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 ValidatorID         `json:"proposer_id"`
    ParentHash common.Hash         `json:"parent_hash"`
    Hash       common.Hash         `json:"hash"`
    Position   Position            `json:"position"`
    Timestamp  time.Time           `json:"timestamps"`
    Acks       common.SortedHashes `json:"acks"`
    Payload    []byte              `json:"payload"`
    Signature  crypto.Signature    `json:"signature"`

    CRSSignature crypto.Signature `json:"crs_signature"`

    Witness Witness `json:"witness"`
}

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.ShardID = b.Position.ShardID
    bcopy.Position.ChainID = b.Position.ChainID
    bcopy.Position.Height = b.Position.Height
    bcopy.Signature = b.Signature.Clone()
    bcopy.CRSSignature = b.CRSSignature.Clone()
    bcopy.Witness.Timestamp = b.Witness.Timestamp
    bcopy.Witness.Height = b.Witness.Height
    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)
    return
}

// IsGenesis checks if the block is a genesisBlock
func (b *Block) IsGenesis() bool {
    return b.Position.Height == 0 && b.ParentHash == 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]
}

// ByHeight is the helper type for sorting slice of blocks by height.
type ByHeight []*Block

func (b ByHeight) Len() int {
    return len(b)
}

func (b ByHeight) Less(i int, j int) bool {
    return b[i].Position.Height < b[j].Position.Height
}

func (b ByHeight) Swap(i int, j int) {
    b[i], b[j] = b[j], b[i]
}