aboutsummaryrefslogtreecommitdiffstats
path: root/core/test/governance.go
blob: a2e6f69700acdeaaab37c3f32ee65ce621231d69 (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
// 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"
    "time"

    "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"
)

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

// Governance is an implementation of Goverance for testing purpose.
type Governance struct {
    lambda             time.Duration
    notarySet          map[types.NodeID]struct{}
    privateKeys        map[types.NodeID]crypto.PrivateKey
    DKGComplaint       map[uint64][]*types.DKGComplaint
    DKGMasterPublicKey map[uint64][]*types.DKGMasterPublicKey
}

// NewGovernance constructs a Governance instance.
func NewGovernance(nodeCount int, lambda time.Duration) (
    g *Governance, err error) {
    g = &Governance{
        lambda:             lambda,
        notarySet:          make(map[types.NodeID]struct{}),
        privateKeys:        make(map[types.NodeID]crypto.PrivateKey),
        DKGComplaint:       make(map[uint64][]*types.DKGComplaint),
        DKGMasterPublicKey: make(map[uint64][]*types.DKGMasterPublicKey),
    }
    for i := 0; i < nodeCount; i++ {
        prv, err := eth.NewPrivateKey()
        if err != nil {
            return nil, err
        }
        nID := types.NewNodeID(prv.PublicKey())
        g.notarySet[nID] = struct{}{}
        g.privateKeys[nID] = prv
    }
    return
}

// GetNotarySet implements Governance interface to return current
// notary set.
func (g *Governance) GetNotarySet() map[types.NodeID]struct{} {
    return g.notarySet
}

// GetConfiguration returns the configuration at a given block height.
func (g *Governance) GetConfiguration(blockHeight uint64) *types.Config {
    return &types.Config{
        NumShards:  1,
        NumChains:  uint32(len(g.notarySet)),
        GenesisCRS: "__ DEXON",
        Lambda:     g.lambda,
        K:          0,
        PhiRatio:   0.667,
    }
}

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

    key, exists := g.privateKeys[nID]
    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
}