aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/byzantine-lab/dexon-consensus/core/utils/utils.go
blob: 6ff5bb62f784cd756d4c10bbf58cb418a8b6ed13 (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
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus 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 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 library. If not, see
// <http://www.gnu.org/licenses/>.

package utils

import (
    "context"
    "fmt"

    "github.com/byzantine-lab/dexon-consensus/common"
    "github.com/byzantine-lab/dexon-consensus/core/types"
    typesDKG "github.com/byzantine-lab/dexon-consensus/core/types/dkg"
)

var dkgDelayRound uint64

// SetDKGDelayRound sets the variable.
func SetDKGDelayRound(delay uint64) {
    dkgDelayRound = delay
}

type configAccessor interface {
    Configuration(round uint64) *types.Config
}

// GetConfigWithPanic is a helper to access configs, and panic when config for
// that round is not ready yet.
func GetConfigWithPanic(accessor configAccessor, round uint64,
    logger common.Logger) *types.Config {
    if logger != nil {
        logger.Debug("Calling Governance.Configuration", "round", round)
    }
    c := accessor.Configuration(round)
    if c == nil {
        panic(fmt.Errorf("configuration is not ready %v", round))
    }
    return c
}

type crsAccessor interface {
    CRS(round uint64) common.Hash
}

// GetCRSWithPanic is a helper to access CRS, and panic when CRS for that
// round is not ready yet.
func GetCRSWithPanic(accessor crsAccessor, round uint64,
    logger common.Logger) common.Hash {
    if logger != nil {
        logger.Debug("Calling Governance.CRS", "round", round)
    }
    crs := accessor.CRS(round)
    if (crs == common.Hash{}) {
        panic(fmt.Errorf("CRS is not ready %v", round))
    }
    return crs
}

// VerifyDKGComplaint verifies if its a valid DKGCompliant.
func VerifyDKGComplaint(
    complaint *typesDKG.Complaint, mpk *typesDKG.MasterPublicKey) (bool, error) {
    ok, err := VerifyDKGComplaintSignature(complaint)
    if err != nil {
        return false, err
    }
    if !ok {
        return false, nil
    }
    if complaint.IsNack() {
        return true, nil
    }
    if complaint.Round != mpk.Round {
        return false, nil
    }
    ok, err = VerifyDKGMasterPublicKeySignature(mpk)
    if err != nil {
        return false, err
    }
    if !ok {
        return false, nil
    }
    ok, err = mpk.PublicKeyShares.VerifyPrvShare(
        typesDKG.NewID(complaint.PrivateShare.ReceiverID),
        &complaint.PrivateShare.PrivateShare)
    if err != nil {
        return false, err
    }
    return !ok, nil
}

// LaunchDummyReceiver launches a go routine to receive from the receive
// channel of a network module. An context is required to stop the go routine
// automatically. An optinal message handler could be provided.
func LaunchDummyReceiver(
    ctx context.Context, recv <-chan types.Msg, handler func(types.Msg)) (
    context.CancelFunc, <-chan struct{}) {
    var (
        dummyCtx, dummyCancel = context.WithCancel(ctx)
        finishedChan          = make(chan struct{}, 1)
    )
    go func() {
        defer func() {
            finishedChan <- struct{}{}
        }()
    loop:
        for {
            select {
            case <-dummyCtx.Done():
                break loop
            case v, ok := <-recv:
                if !ok {
                    panic(fmt.Errorf(
                        "receive channel is closed before dummy receiver"))
                }
                if handler != nil {
                    handler(v)
                }
            }
        }
    }()
    return dummyCancel, finishedChan
}

// GetDKGThreshold return expected threshold for given DKG set size.
func GetDKGThreshold(config *types.Config) int {
    return int(config.NotarySetSize*2/3) + 1
}

// GetDKGValidThreshold return threshold for DKG set to considered valid.
func GetDKGValidThreshold(config *types.Config) int {
    return int(config.NotarySetSize * 5 / 6)
}

// GetBAThreshold return threshold for BA votes.
func GetBAThreshold(config *types.Config) int {
    return int(config.NotarySetSize*2/3 + 1)
}

// GetNextRoundValidationHeight returns the block height to check if the next
// round is ready.
func GetNextRoundValidationHeight(begin, length uint64) uint64 {
    return begin + length*9/10
}

// GetRoundHeight wraps the workaround for the round height logic in fullnode.
func GetRoundHeight(accessor interface{}, round uint64) uint64 {
    type roundHeightAccessor interface {
        GetRoundHeight(round uint64) uint64
    }
    accessorInst := accessor.(roundHeightAccessor)
    height := accessorInst.GetRoundHeight(round)
    if round == 0 && height < types.GenesisHeight {
        return types.GenesisHeight
    }
    return height
}

// IsDKGValid check if DKG is correctly prepared.
func IsDKGValid(
    gov governanceAccessor, logger common.Logger, round, reset uint64) (
    valid bool, gpkInvalid bool) {
    if !gov.IsDKGFinal(round) {
        logger.Debug("DKG is not final", "round", round, "reset", reset)
        return
    }
    if !gov.IsDKGSuccess(round) {
        logger.Debug("DKG is not successful", "round", round, "reset", reset)
        return
    }
    cfg := GetConfigWithPanic(gov, round, logger)
    gpk, err := typesDKG.NewGroupPublicKey(
        round,
        gov.DKGMasterPublicKeys(round),
        gov.DKGComplaints(round),
        GetDKGThreshold(cfg))
    if err != nil {
        logger.Debug("Group public key setup failed",
            "round", round,
            "reset", reset,
            "error", err)
        gpkInvalid = true
        return
    }
    if len(gpk.QualifyNodeIDs) < GetDKGValidThreshold(cfg) {
        logger.Debug("Group public key threshold not reach",
            "round", round,
            "reset", reset,
            "qualified", len(gpk.QualifyNodeIDs))
        gpkInvalid = true
        return
    }
    valid = true
    return
}