aboutsummaryrefslogtreecommitdiffstats
path: root/simulation/governance.go
blob: 2b0f56b44371751889b5fd237e3a4b65bc9a8c45 (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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
// 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"
    "time"

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

// simGovernance is a simulated governance contract implementing the
// core.Governance interface.
type simGovernance struct {
    id                 types.NodeID
    lock               sync.RWMutex
    nodeSet            map[types.NodeID]crypto.PublicKey
    expectedNumNodes   int
    k                  int
    phiRatio           float32
    chainNum           uint32
    crs                []common.Hash
    tsig               map[uint64]crypto.Signature
    dkgComplaint       map[uint64][]*types.DKGComplaint
    dkgMasterPublicKey map[uint64][]*types.DKGMasterPublicKey
    dkgFinal           map[uint64]map[types.NodeID]struct{}
    lambdaBA           time.Duration
    lambdaDKG          time.Duration
    roundInterval      time.Duration
    network            *network
}

// newSimGovernance returns a new simGovernance instance.
func newSimGovernance(
    id types.NodeID,
    numNodes int, consensusConfig config.Consensus) *simGovernance {
    hashCRS := crypto.Keccak256Hash([]byte(consensusConfig.GenesisCRS))
    return &simGovernance{
        id:                 id,
        nodeSet:            make(map[types.NodeID]crypto.PublicKey),
        expectedNumNodes:   numNodes,
        k:                  consensusConfig.K,
        phiRatio:           consensusConfig.PhiRatio,
        chainNum:           consensusConfig.ChainNum,
        crs:                []common.Hash{hashCRS},
        tsig:               make(map[uint64]crypto.Signature),
        dkgComplaint:       make(map[uint64][]*types.DKGComplaint),
        dkgMasterPublicKey: make(map[uint64][]*types.DKGMasterPublicKey),
        dkgFinal:           make(map[uint64]map[types.NodeID]struct{}),
        lambdaBA: time.Duration(consensusConfig.LambdaBA) *
            time.Millisecond,
        lambdaDKG: time.Duration(consensusConfig.LambdaDKG) *
            time.Millisecond,
        roundInterval: time.Duration(consensusConfig.RoundInterval) *
            time.Millisecond,
    }
}

func (g *simGovernance) setNetwork(network *network) {
    g.network = network
}

// NodeSet returns the current notary set.
func (g *simGovernance) NodeSet(round uint64) (ret []crypto.PublicKey) {
    g.lock.RLock()
    defer g.lock.RUnlock()

    for _, pubKey := range g.nodeSet {
        ret = append(ret, pubKey)
    }
    return
}

// Configuration returns the configuration at a given round.
func (g *simGovernance) Configuration(round uint64) *types.Config {
    return &types.Config{
        NumChains:        g.chainNum,
        LambdaBA:         g.lambdaBA,
        LambdaDKG:        g.lambdaDKG,
        K:                g.k,
        PhiRatio:         g.phiRatio,
        NotarySetSize:    uint32(len(g.nodeSet)),
        DKGSetSize:       uint32(len(g.nodeSet)),
        MinBlockInterval: g.lambdaBA * 3,
        MaxBlockInterval: g.lambdaBA * 8,
        RoundInterval:    g.roundInterval,
    }
}

// CRS returns the CRS for a given round.
func (g *simGovernance) CRS(round uint64) common.Hash {
    if round >= uint64(len(g.crs)) {
        return common.Hash{}
    }
    return g.crs[round]
}

// ProposeCRS proposes a CRS of round.
func (g *simGovernance) ProposeCRS(signedCRS []byte) {
    crs := crypto.Keccak256Hash(signedCRS)
    if g.crs[len(g.crs)-1].Equal(crs) {
        return
    }
    g.crs = append(g.crs, crs)
}

// addNode add a new node into the simulated governance contract.
func (g *simGovernance) addNode(pubKey crypto.PublicKey) {
    nID := types.NewNodeID(pubKey)

    g.lock.Lock()
    defer g.lock.Unlock()

    if _, exists := g.nodeSet[nID]; exists {
        return
    }
    if len(g.nodeSet) == g.expectedNumNodes {
        panic(fmt.Errorf("attempt to add node when ready"))
    }
    g.nodeSet[nID] = pubKey
}

// AddDKGComplaint adds a DKGComplaint.
func (g *simGovernance) AddDKGComplaint(
    round uint64, complaint *types.DKGComplaint) {
    if round != complaint.Round {
        return
    }
    if g.IsDKGFinal(complaint.Round) {
        return
    }
    if _, exist := g.dkgFinal[complaint.Round][complaint.ProposerID]; exist {
        return
    }
    // TODO(jimmy-dexon): check if the input is valid.
    g.dkgComplaint[complaint.Round] = append(
        g.dkgComplaint[complaint.Round], complaint)
    if complaint.ProposerID == g.id {
        g.network.broadcast(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(
    round uint64, masterPublicKey *types.DKGMasterPublicKey) {
    if round != masterPublicKey.Round {
        return
    }
    // TODO(jimmy-dexon): check if the input is valid.
    g.dkgMasterPublicKey[masterPublicKey.Round] = append(
        g.dkgMasterPublicKey[masterPublicKey.Round], masterPublicKey)
    if masterPublicKey.ProposerID == g.id {
        g.network.broadcast(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
}

// AddDKGFinalize adds a DKG finalize message.
func (g *simGovernance) AddDKGFinalize(
    round uint64, final *types.DKGFinalize) {
    if round != final.Round {
        return
    }
    // TODO(jimmy-dexon): check if the input is valid.
    if _, exist := g.dkgFinal[final.Round]; !exist {
        g.dkgFinal[final.Round] = make(map[types.NodeID]struct{})
    }
    g.dkgFinal[final.Round][final.ProposerID] = struct{}{}
    if final.ProposerID == g.id {
        g.network.broadcast(final)
    }
}

// IsDKGFinal checks if DKG is final.
func (g *simGovernance) IsDKGFinal(round uint64) bool {
    return len(g.dkgFinal[round]) > int(g.Configuration(round).DKGSetSize)/3*2
}