aboutsummaryrefslogtreecommitdiffstats
path: root/core/test/governance.go
blob: 64ca39f584361edf54fa265a3a771f9d9abfc639 (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
143
144
145
146
147
148
149
150
151
152
// 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 test

import (
    "fmt"

    "github.com/dexon-foundation/dexon-consensus-core/core/types"
    "github.com/dexon-foundation/dexon-consensus-core/crypto"
    "github.com/dexon-foundation/dexon-consensus-core/crypto/eth"
    "github.com/shopspring/decimal"
)

var (
    // ErrPrivateKeyNotExists means caller request private key for an
    // unknown validator ID.
    ErrPrivateKeyNotExists = fmt.Errorf("private key not exists")
)

// Governance is an implementation of Goverance for testing purpose.
type Governance struct {
    BlockProposingInterval int
    Validators             map[types.ValidatorID]decimal.Decimal
    PrivateKeys            map[types.ValidatorID]crypto.PrivateKey
    DKGComplaint           map[uint64][]*types.DKGComplaint
    DKGMasterPublicKey     map[uint64][]*types.DKGMasterPublicKey
}

// NewGovernance constructs a Governance instance.
func NewGovernance(validatorCount, proposingInterval int) (
    g *Governance, err error) {
    g = &Governance{
        BlockProposingInterval: proposingInterval,
        Validators:             make(map[types.ValidatorID]decimal.Decimal),
        PrivateKeys:            make(map[types.ValidatorID]crypto.PrivateKey),
        DKGComplaint:           make(map[uint64][]*types.DKGComplaint),
        DKGMasterPublicKey:     make(map[uint64][]*types.DKGMasterPublicKey),
    }
    for i := 0; i < validatorCount; i++ {
        prv, err := eth.NewPrivateKey()
        if err != nil {
            return nil, err
        }
        vID := types.NewValidatorID(prv.PublicKey())
        g.Validators[vID] = decimal.NewFromFloat(0)
        g.PrivateKeys[vID] = prv
    }
    return
}

// GetValidatorSet implements Governance interface to return current
// validator set.
func (g *Governance) GetValidatorSet() map[types.ValidatorID]decimal.Decimal {
    return g.Validators
}

// GetBlockProposingInterval implements Governance interface to return maximum
// allowed block proposing interval in millisecond.
func (g *Governance) GetBlockProposingInterval() int {
    return g.BlockProposingInterval
}

// GetTotalOrderingK returns K.
func (g *Governance) GetTotalOrderingK() int {
    return 0
}

// GetPhiRatio returns phi ratio.
func (g *Governance) GetPhiRatio() float32 {
    return 0.667
}

// GetNumShards returns the number of shards.
func (g *Governance) GetNumShards() uint32 {
    return 1
}

// GetNumChains returns the number of chains.
func (g *Governance) GetNumChains() uint32 {
    return uint32(len(g.Validators))
}

// GetConfigurationChangeEvent Get configuration change events after a certain
// epoch.
func (g *Governance) GetConfigurationChangeEvent(
    epoch int) []types.ConfigurationChangeEvent {
    return nil
}

// GetGenesisCRS returns the CRS string.
func (g *Governance) GetGenesisCRS() string {
    return "🆕 DEXON"
}

// GetPrivateKey return the private key for that validator, this function
// is a test utility and not a general core.Governance interface.
func (g *Governance) GetPrivateKey(
    vID types.ValidatorID) (key crypto.PrivateKey, err error) {

    key, exists := g.PrivateKeys[vID]
    if !exists {
        err = ErrPrivateKeyNotExists
        return
    }
    return
}

// AddDKGComplaint add a DKGComplaint.
func (g *Governance) AddDKGComplaint(complaint *types.DKGComplaint) {
    g.DKGComplaint[complaint.Round] = append(g.DKGComplaint[complaint.Round], complaint)
}

// DKGComplaints returns the DKGComplaints of round.
func (g *Governance) DKGComplaints(round uint64) []*types.DKGComplaint {
    complaints, exist := g.DKGComplaint[round]
    if !exist {
        return []*types.DKGComplaint{}
    }
    return complaints
}

// AddDKGMasterPublicKey adds a DKGMasterPublicKey.
func (g *Governance) AddDKGMasterPublicKey(
    masterPublicKey *types.DKGMasterPublicKey) {
    g.DKGMasterPublicKey[masterPublicKey.Round] = append(
        g.DKGMasterPublicKey[masterPublicKey.Round], masterPublicKey)
}

// DKGMasterPublicKeys returns the DKGMasterPublicKeys of round.
func (g *Governance) DKGMasterPublicKeys(
    round uint64) []*types.DKGMasterPublicKey {
    masterPublicKeys, exist := g.DKGMasterPublicKey[round]
    if !exist {
        return []*types.DKGMasterPublicKey{}
    }
    return masterPublicKeys
}