aboutsummaryrefslogtreecommitdiffstats
path: root/core/types/block.go
blob: 55e82da13ef8c883f25089eadba2541e0c45e78d (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
139
140
141
142
// 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 types

import (
    "bytes"
    "fmt"
    "time"

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

// Status represents the block process state.
type Status int

// Block Status.
const (
    BlockStatusInit Status = iota
    BlockStatusAcked
    BlockStatusOrdering
    BlockStatusFinal
)

// CompactionChainAck represents the acking to the compaction chain.
type CompactionChainAck struct {
    AckingBlockHash common.Hash `json:"acking_block_hash"`
    // Signature is the signature of the hash value of
    // Block.ConsensusInfoParentHash and Block.ConsensusInfo.
    ConsensusSignature crypto.Signature `json:"consensus_signature"`
}

// ConsensusInfo represents the consensus information on the compaction chain.
type ConsensusInfo struct {
    Timestamp time.Time `json:"timestamp"`
    Height    uint64    `json:"height"`
}

// 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"`
    Height             uint64                    `json:"height"`
    Timestamps         map[ValidatorID]time.Time `json:"timestamps"`
    Acks               map[common.Hash]struct{}  `json:"acks"`
    CompactionChainAck CompactionChainAck        `json:"compaction_chain_ack"`

    ConsensusInfo ConsensusInfo `json:"consensus_info"`
    // ConsensusInfoParentHash is the hash value of Block.ConsensusInfoParentHash
    // and Block.ConsensusInfo, where Block is the previous block on
    // the compaction chain.
    ConsensusInfoParentHash common.Hash `json:"consensus_info_parent_hash"`

    Ackeds          map[common.Hash]struct{} `json:"-"`
    AckedValidators map[ValidatorID]struct{} `json:"-"`
    Status          Status                   `json:"-"`
}

// BlockConverter interface define the interface for extracting block
// information from an existing object.
type BlockConverter interface {
    Block() *Block
}

func (b *Block) String() string {
    return fmt.Sprintf("Block(%v)", b.Hash.String()[:6])
}

// Clone returns a deep copy of a block.
func (b *Block) Clone() *Block {
    bcopy := &Block{
        ProposerID: b.ProposerID,
        ParentHash: b.ParentHash,
        Hash:       b.Hash,
        Height:     b.Height,
        Timestamps: make(map[ValidatorID]time.Time),
        Acks:       make(map[common.Hash]struct{}),
        CompactionChainAck: CompactionChainAck{
            AckingBlockHash: b.CompactionChainAck.AckingBlockHash,
        },
        ConsensusInfo: ConsensusInfo{
            Timestamp: b.ConsensusInfo.Timestamp,
            Height:    b.ConsensusInfo.Height,
        },
        ConsensusInfoParentHash: b.ConsensusInfoParentHash,
    }
    bcopy.CompactionChainAck.ConsensusSignature = append(
        crypto.Signature(nil), b.CompactionChainAck.ConsensusSignature...)
    for k, v := range b.Timestamps {
        bcopy.Timestamps[k] = v
    }
    for k, v := range b.Acks {
        bcopy.Acks[k] = v
    }
    return bcopy
}

// 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].Height < b[j].Height
}

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