-
Notifications
You must be signed in to change notification settings - Fork 39
/
prepstatus.go
684 lines (599 loc) · 15.2 KB
/
prepstatus.go
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
/*
* Copyright 2020 ICON Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package icstate
import (
"fmt"
"math/big"
"math/bits"
"github.com/icon-project/goloop/common/codec"
"github.com/icon-project/goloop/common/errors"
"github.com/icon-project/goloop/icon/icmodule"
"github.com/icon-project/goloop/icon/iiss/icobject"
)
type Grade int
const (
GradeMain Grade = iota
GradeSub
GradeCandidate
GradeNone
)
func (g Grade) String() string {
switch g {
case GradeMain:
return "M"
case GradeSub:
return "S"
case GradeCandidate:
return "C"
case GradeNone:
return "N"
default:
return "X"
}
}
type Status int
const (
Active Status = iota
Unregistered
Disqualified
NotReady
)
func (s Status) String() string {
switch s {
case Active:
return "A"
case Unregistered:
return "U"
case Disqualified:
return "D"
case NotReady:
return "N"
default:
return "X"
}
}
type VoteState int
const (
None VoteState = iota
Ready
Success
Failure
)
func (vs VoteState) String() string {
switch vs {
case Ready:
return "R"
case None:
return "N"
case Success:
return "S"
case Failure:
return "F"
default:
return "X"
}
}
type prepStatusData struct {
grade Grade
status Status
delegated *big.Int
bonded *big.Int
vTotal int64
vFail int64
vFailCont int64
vPenaltyMask uint32
lastState VoteState
lastHeight int64
effectiveDelegated *big.Int
}
func (ps *prepStatusData) Bonded() *big.Int {
return ps.bonded
}
func (ps *prepStatusData) Grade() Grade {
return ps.grade
}
func (ps *prepStatusData) Status() Status {
return ps.status
}
func (ps *prepStatusData) IsActive() bool {
return ps.status == Active
}
// IsAlreadyPenalized returns true if this PRep got penalized during this term
func (ps *prepStatusData) IsAlreadyPenalized() bool {
return (ps.vPenaltyMask & 1) != 0
}
func (ps *prepStatusData) GetVPenaltyCount() int {
return bits.OnesCount32(ps.vPenaltyMask)
}
func (ps *prepStatusData) LastState() VoteState {
return ps.lastState
}
func (ps *prepStatusData) LastHeight() int64 {
return ps.lastHeight
}
func (ps *prepStatusData) Delegated() *big.Int {
return ps.delegated
}
func (ps *prepStatusData) EffectiveDelegated() *big.Int {
return ps.effectiveDelegated
}
func (ps *prepStatusData) getVoted() *big.Int {
return new(big.Int).Add(ps.delegated, ps.bonded)
}
// GetBondedDelegation return amount of bonded delegation
// Bonded delegation formula
// totalVoted = bond + delegation
// bondRatio = bond / totalVoted * 100
// bondedDelegation = totalVoted * (bondRatio / bondRequirement)
// = bond * 100 / bondRequirement
// if bondedDelegation > totalVoted
// bondedDelegation = totalVoted
func (ps *prepStatusData) GetBondedDelegation(bondRequirement int64) *big.Int {
if bondRequirement < 0 || bondRequirement > 100 {
// should not be negative or over 100 for bond requirement
return big.NewInt(0)
}
totalVoted := ps.getVoted() // bonded + delegated
if bondRequirement == 0 {
// when bondRequirement is 0, it means no threshold for BondedRequirement,
// so it returns 100% of totalVoted.
// And it should not be divided by 0 in the following code that could occurs Panic.
return totalVoted
}
multiplier := big.NewInt(100)
bondedDelegation := new(big.Int).Mul(ps.bonded, multiplier) // not divided by bond requirement yet
br := big.NewInt(bondRequirement)
bondedDelegation.Div(bondedDelegation, br)
if totalVoted.Cmp(bondedDelegation) > 0 {
return bondedDelegation
} else {
return totalVoted
}
}
// GetPower returns the power score of a PRep.
// Power is the same as delegated of a given PRep before rev 14
// and will be bondedDelegation since rev 14.
// But the calculation formula for power can be changed in the future.
func (ps *prepStatusData) GetPower(bondRequirement int64) *big.Int {
return ps.GetBondedDelegation(bondRequirement)
}
func (ps *prepStatusData) VTotal() int64 {
return ps.vTotal
}
// GetVTotal returns the calculated number of validation
func (ps *prepStatusData) GetVTotal(blockHeight int64) int64 {
if ps.lastState == None {
return ps.vTotal
}
return ps.vTotal + ps.getSafeHeightDiff(blockHeight)
}
func (ps *prepStatusData) VFail() int64 {
return ps.vFail
}
// GetVFail returns the calculated number of validation failures
func (ps *prepStatusData) GetVFail(blockHeight int64) int64 {
if ps.lastState == Failure {
return ps.vFail + ps.getSafeHeightDiff(blockHeight)
}
return ps.vFail
}
// GetVFailCont returns the number of consecutive validation failures
func (ps *prepStatusData) GetVFailCont(blockHeight int64) int64 {
if ps.lastState == Failure {
return ps.vFailCont + ps.getSafeHeightDiff(blockHeight)
}
return ps.vFailCont
}
func (ps *prepStatusData) getSafeHeightDiff(blockHeight int64) int64 {
diff := blockHeight - ps.lastHeight
if diff < 0 {
panic(errors.Errorf("Invalid blockHeight: blockHeight=%d < lastHeight=%d", blockHeight, ps.lastHeight))
}
return diff
}
func (ps *prepStatusData) equal(other *prepStatusData) bool {
if ps == other {
return true
}
return ps.grade == other.grade &&
ps.status == other.status &&
ps.delegated.Cmp(other.delegated) == 0 &&
ps.bonded.Cmp(other.bonded) == 0 &&
ps.vTotal == other.vTotal &&
ps.vFail == other.vFail &&
ps.vFailCont == other.vFailCont &&
ps.vPenaltyMask == other.vPenaltyMask &&
ps.lastState == other.lastState &&
ps.lastHeight == other.lastHeight
}
func (ps prepStatusData) clone() prepStatusData {
return prepStatusData{
grade: ps.grade,
status: ps.status,
delegated: ps.delegated,
bonded: ps.bonded,
vTotal: ps.vTotal,
vFail: ps.vFail,
vFailCont: ps.vFailCont,
vPenaltyMask: ps.vPenaltyMask,
lastState: ps.lastState,
lastHeight: ps.lastHeight,
effectiveDelegated: ps.effectiveDelegated,
}
}
func (ps *prepStatusData) ToJSON(blockHeight int64, bondRequirement int64) map[string]interface{} {
jso := make(map[string]interface{})
jso["grade"] = int(ps.grade)
jso["status"] = int(ps.status)
jso["penalty"] = int64(ps.getPenaltyType())
jso["lastHeight"] = ps.lastHeight
jso["delegated"] = ps.delegated
jso["bonded"] = ps.bonded
jso["power"] = ps.GetPower(bondRequirement)
totalBlocks := ps.GetVTotal(blockHeight)
jso["totalBlocks"] = totalBlocks
jso["validatedBlocks"] = totalBlocks - ps.GetVFail(blockHeight)
return jso
}
func (ps *prepStatusData) getPenaltyType() icmodule.PenaltyType {
if ps.status == Disqualified {
return icmodule.PenaltyPRepDisqualification
}
if (ps.vPenaltyMask & 1) == 0 {
return icmodule.PenaltyNone
} else {
return icmodule.PenaltyBlockValidation
}
}
func (ps *prepStatusData) GetStatsInJSON(blockHeight int64) map[string]interface{} {
jso := make(map[string]interface{})
jso["grade"] = int(ps.grade)
jso["status"] = int(ps.status)
jso["lastHeight"] = ps.lastHeight
jso["lastState"] = int(ps.lastState)
jso["penalties"] = ps.GetVPenaltyCount()
jso["total"] = ps.vTotal
jso["fail"] = ps.vFail
jso["failCont"] = ps.vFailCont
jso["realTotal"] = ps.GetVTotal(blockHeight)
jso["realFail"] = ps.GetVFail(blockHeight)
jso["realFailCont"] = ps.GetVFailCont(blockHeight)
return jso
}
func (ps *prepStatusData) IsEmpty() bool {
return ps.grade == GradeCandidate &&
ps.delegated.Sign() == 0 &&
ps.bonded.Sign() == 0 &&
ps.vFail == 0 &&
ps.vFailCont == 0 &&
ps.vTotal == 0 &&
ps.lastState == None &&
ps.lastHeight == 0 &&
ps.status == NotReady
}
func (ps *prepStatusData) String() string {
return fmt.Sprintf(
"st=%s grade=%s ls=%s lh=%d vf=%d vt=%d vpc=%d vfco=%d dd=%s bd=%s vote=%s ed=%d",
ps.status,
ps.grade,
ps.lastState,
ps.lastHeight,
ps.vFail,
ps.vTotal,
ps.GetVPenaltyCount(),
ps.vFailCont,
ps.delegated,
ps.bonded,
ps.getVoted(),
ps.effectiveDelegated,
)
}
func (ps *prepStatusData) Format(f fmt.State, c rune) {
switch c {
case 'v':
var format string
if f.Flag('+') {
format = "PRepStatus{" +
"status=%s grade=%s lastState=%s lastHeight=%d " +
"vFail=%d vTotal=%d vPenaltyCount=%d vFailCont=%d " +
"delegated=%s bonded=%s effectiveDelegated=%d}"
} else {
format = "PRepStatus{%s %s %s %d %d %d %d %d %s %s %d}"
}
_, _ = fmt.Fprintf(
f, format,
ps.status,
ps.grade,
ps.lastState,
ps.lastHeight,
ps.vFail,
ps.vTotal,
ps.GetVPenaltyCount(),
ps.vFailCont,
ps.delegated,
ps.bonded,
ps.effectiveDelegated,
)
case 's':
_, _ = fmt.Fprint(f, ps.String())
}
}
type PRepStatusSnapshot struct {
icobject.NoDatabase
prepStatusData
}
func (ps *PRepStatusSnapshot) Version() int {
return 0
}
func (ps *PRepStatusSnapshot) RLPDecodeFields(decoder codec.Decoder) error {
return decoder.DecodeAll(
&ps.grade,
&ps.status,
&ps.delegated,
&ps.bonded,
&ps.vTotal,
&ps.vFail,
&ps.vFailCont,
&ps.vPenaltyMask,
&ps.lastState,
&ps.lastHeight,
)
}
func (ps *PRepStatusSnapshot) RLPEncodeFields(encoder codec.Encoder) error {
return encoder.EncodeMulti(
ps.grade,
ps.status,
ps.delegated,
ps.bonded,
ps.vTotal,
ps.vFail,
ps.vFailCont,
ps.vPenaltyMask,
ps.lastState,
ps.lastHeight,
)
}
func (ps *PRepStatusSnapshot) Equal(o icobject.Impl) bool {
other, ok := o.(*PRepStatusSnapshot)
if !ok {
return false
}
return ps.equal(&other.prepStatusData)
}
var emptyPRepStatusSnapshot = &PRepStatusSnapshot{
prepStatusData: prepStatusData{
grade: GradeCandidate,
delegated: new(big.Int),
bonded: new(big.Int),
vFail: 0,
vFailCont: 0,
vTotal: 0,
lastState: None,
lastHeight: 0,
status: NotReady,
},
}
type PRepStatusState struct {
prepStatusData
last *PRepStatusSnapshot
}
func (ps *PRepStatusState) Reset(ss *PRepStatusSnapshot) *PRepStatusState {
if ps.last != ss {
ed := ps.effectiveDelegated
ps.last = ss
ps.prepStatusData = ss.prepStatusData.clone()
ps.effectiveDelegated = ed
}
return ps
}
func (ps *PRepStatusState) setDirty() {
if ps.last != nil {
ps.last = nil
}
}
func (ps *PRepStatusState) Clear() {
ps.Reset(emptyPRepStatusSnapshot)
}
func (ps *PRepStatusState) GetSnapshot() *PRepStatusSnapshot {
if ps.last == nil {
ps.last = &PRepStatusSnapshot{
prepStatusData: ps.prepStatusData.clone(),
}
}
return ps.last
}
func (ps *PRepStatusState) IsEmpty() bool {
return ps.grade == GradeCandidate &&
ps.delegated.Sign() == 0 &&
ps.bonded.Sign() == 0 &&
ps.vFail == 0 &&
ps.vFailCont == 0 &&
ps.vTotal == 0 &&
ps.lastState == None &&
ps.lastHeight == 0 &&
ps.status == NotReady
}
func (ps *PRepStatusState) SetDelegated(delegated *big.Int) {
ps.delegated = delegated
ps.setDirty()
}
func (ps *PRepStatusState) SetEffectiveDelegated(value *big.Int) {
ps.effectiveDelegated = value
ps.setDirty()
}
func (ps *PRepStatusState) SetBonded(v *big.Int) {
ps.bonded = v
ps.setDirty()
}
func (ps *PRepStatusState) SetStatus(s Status) {
ps.status = s
ps.setDirty()
}
func (ps *PRepStatusState) Activate() error {
if ps.status != NotReady {
return errors.InvalidStateError.Errorf("AlreadyUsed")
}
ps.status = Active
ps.setDirty()
return nil
}
func (ps *PRepStatusState) SetVTotal(t int64) {
ps.vTotal = t
ps.setDirty()
}
func (ps *PRepStatusState) resetVFailCont() {
if ps.IsAlreadyPenalized() {
ps.vFailCont = 0
}
}
func buildPenaltyMask(input int) (res uint32) {
res = uint32((uint64(1) << input) - 1)
return
}
func (ps *PRepStatusState) shiftVPenaltyMask(limit int) {
ps.vPenaltyMask = (ps.vPenaltyMask << 1) & buildPenaltyMask(limit)
}
func (ps *PRepStatusState) ResetVPenaltyMask() {
if ps.vPenaltyMask != 0 {
ps.vPenaltyMask = 0
ps.setDirty()
}
}
func (ps *PRepStatusState) OnBlockVote(blockHeight int64, voted bool) error {
voteState := Success
if !voted {
voteState = Failure
}
if ps.lastState == voteState {
return nil
}
var err error
if voted {
err = ps.onTrueBlockVote(blockHeight)
} else {
err = ps.onFalseBlockVote(blockHeight)
}
if err == nil {
ps.setDirty()
}
return err
}
func (ps *PRepStatusState) onFalseBlockVote(blockHeight int64) error {
if err := ps.syncBlockVoteStats(blockHeight - 1); err != nil {
return err
}
ps.vFail++
ps.vFailCont++
ps.vTotal++
ps.lastHeight = blockHeight
ps.lastState = Failure
return nil
}
func (ps *PRepStatusState) onTrueBlockVote(blockHeight int64) error {
if err := ps.syncBlockVoteStats(blockHeight - 1); err != nil {
return err
}
ps.vFailCont = 0
ps.vTotal++
ps.lastHeight = blockHeight
ps.lastState = Success
return nil
}
// OnMainPRepIn is called only in case of penalized main prep replacement
func (ps *PRepStatusState) OnMainPRepIn(limit int) error {
if ps.grade != GradeSub {
return errors.Errorf("Invalid grade: %v -> M", ps.grade)
}
ps.onMainPRepIn(limit)
ps.setDirty()
return nil
}
func (ps *PRepStatusState) onMainPRepIn(limit int) {
ps.grade = GradeMain
ps.shiftVPenaltyMask(limit)
}
func (ps *PRepStatusState) onMainPRepOut(newGrade Grade) {
ps.grade = newGrade
}
// OnValidatorOut is called when this PRep node address disappears from ConsensusInfo
func (ps *PRepStatusState) OnValidatorOut(blockHeight int64) error {
lh := ps.lastHeight
if blockHeight < lh {
return errors.Errorf("blockHeight(%d) < lastHeight(%d)", blockHeight, lh)
}
if err := ps.syncBlockVoteStats(blockHeight); err != nil {
return err
}
ps.lastState = None
ps.setDirty()
return nil
}
func (ps *PRepStatusState) OnPenaltyImposed(blockHeight int64) error {
if err := ps.syncBlockVoteStats(blockHeight); err != nil {
return err
}
ps.vFailCont = 0
ps.vPenaltyMask |= 1
ps.grade = GradeCandidate
ps.setDirty()
return nil
}
func (ps *PRepStatusState) OnTermEnd(newGrade Grade, limit int) error {
ps.resetVFailCont()
if newGrade == GradeMain {
ps.onMainPRepIn(limit)
} else {
ps.onMainPRepOut(newGrade)
}
ps.setDirty()
return nil
}
// TODO: This function will be deprecated
// syncBlockVoteStats updates vote stats data at a given blockHeight
func (ps *PRepStatusState) syncBlockVoteStats(blockHeight int64) error {
if blockHeight < ps.lastHeight {
return errors.Errorf("blockHeight(%d) < lastHeight(%d)", blockHeight, ps.lastHeight)
}
if blockHeight == ps.lastHeight || ps.lastState == None {
return nil
}
ps.vFail = ps.GetVFail(blockHeight)
ps.vTotal = ps.GetVTotal(blockHeight)
ps.vFailCont = ps.GetVFailCont(blockHeight)
ps.lastHeight = blockHeight
return nil
}
func (ps *PRepStatusState) DisableAs(status Status) (Grade, error) {
switch ps.status {
case Active:
grade := ps.grade
ps.grade = GradeNone
ps.status = status
ps.setDirty()
return grade, nil
default:
return ps.grade, errors.InvalidStateError.Errorf("InvalidState(status=%s)", ps.status)
}
}
func newPRepStatusWithTag(_ icobject.Tag) *PRepStatusSnapshot {
return new(PRepStatusSnapshot)
}
func NewPRepStatusWithSnapshot(snapshot *PRepStatusSnapshot) *PRepStatusState {
return new(PRepStatusState).Reset(snapshot)
}
func NewPRepStatus() *PRepStatusState {
return new(PRepStatusState).Reset(emptyPRepStatusSnapshot)
}