aboutsummaryrefslogtreecommitdiffstats
path: root/simulation/governance.go
blob: 5220ae50dfb0c2f98bddbb7c30fbb37c1da60d82 (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
// 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 simulation

import (
    "fmt"
    "sync"

    "github.com/dexon-foundation/dexon-consensus-core/core/types"
    "github.com/dexon-foundation/dexon-consensus-core/simulation/config"
    "github.com/shopspring/decimal"
)

// simGovernance is a simulated governance contract implementing the
// core.Governance interface.
type simGovernance struct {
    lock                  sync.RWMutex
    validatorSet          map[types.ValidatorID]decimal.Decimal
    expectedNumValidators int
    k                     int
    phiRatio              float32
    chainNum              uint32
    crs                   string
    dkgComplaint          map[uint64][]*types.DKGComplaint
    dkgMasterPublicKey    map[uint64][]*types.DKGMasterPublicKey
}

// newSimGovernance returns a new simGovernance instance.
func newSimGovernance(
    numValidators int, consensusConfig config.Consensus) *simGovernance {
    return &simGovernance{
        validatorSet:          make(map[types.ValidatorID]decimal.Decimal),
        expectedNumValidators: numValidators,
        k:                  consensusConfig.K,
        phiRatio:           consensusConfig.PhiRatio,
        chainNum:           consensusConfig.ChainNum,
        crs:                consensusConfig.GenesisCRS,
        dkgComplaint:       make(map[uint64][]*types.DKGComplaint),
        dkgMasterPublicKey: make(map[uint64][]*types.DKGMasterPublicKey),
    }
}

// GetValidatorSet returns the validator set.
func (g *simGovernance) GetValidatorSet() (
    ret map[types.ValidatorID]decimal.Decimal) {

    g.lock.RLock()
    defer g.lock.RUnlock()

    // Return the cloned validatorSet.
    ret = make(map[types.ValidatorID]decimal.Decimal)
    for k, v := range g.validatorSet {
        ret[k] = v
    }
    return
}

// GetTotalOrderingK returns K.
func (g *simGovernance) GetTotalOrderingK() int {
    return g.k
}

// GetTotalOrderingK returns PhiRatio.
func (g *simGovernance) GetPhiRatio() float32 {
    return g.phiRatio
}

// GetBlockProposingInterval returns block proposing interval.
func (g *simGovernance) GetBlockProposingInterval() int {
    return 0
}

// GetChainNumber returns number of chain.
func (g *simGovernance) GetChainNumber() uint32 {
    return g.chainNum
}

// GetConfigurationChangeEvent returns configuration change event since last
// epoch.
func (g *simGovernance) GetConfigurationChangeEvent(
    epoch int) []types.ConfigurationChangeEvent {
    return nil
}

// GetGenesisCRS returns CRS.
func (g *simGovernance) GetGenesisCRS() string {
    return g.crs
}

// addValidator add a new validator into the simulated governance contract.
func (g *simGovernance) addValidator(vID types.ValidatorID) {
    g.lock.Lock()
    defer g.lock.Unlock()

    if _, exists := g.validatorSet[vID]; exists {
        return
    }
    if len(g.validatorSet) == g.expectedNumValidators {
        panic(fmt.Errorf("attempt to add validator when ready"))
    }
    g.validatorSet[vID] = decimal.NewFromFloat(0)
}

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

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

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

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