core/types/vote.go


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

// 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 (
    "fmt"

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

// VoteType is the type of vote.
type VoteType byte

// VoteType enum.
const (
    VoteAck VoteType = iota
    VoteConfirm
    VotePass
    // Do not add any type below MaxVoteType.
    MaxVoteType
)

// Vote is the vote structure defined in Crypto Shuffle Algorithm.
type Vote struct {
    ProposerID ValidatorID
    Type       VoteType
    BlockHash  common.Hash
    Period     uint64
    Signature  crypto.Signature
}

func (v *Vote) String() string {
    return fmt.Sprintf("Vote(%d:%d):%s",
        v.Period, v.Type, v.BlockHash.String()[:6])
}

// Clone returns a deep copy of a vote.
func (v *Vote) Clone() *Vote {
    return &Vote{
        ProposerID: v.ProposerID,
        Type:       v.Type,
        BlockHash:  v.BlockHash,
        Period:     v.Period,
        Signature:  v.Signature.Clone(),
    }
}