-
Notifications
You must be signed in to change notification settings - Fork 199
/
staking.go
1878 lines (1619 loc) · 56.5 KB
/
staking.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
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//go:generate protoc -I=proto -I=$GOPATH/src -I=$GOPATH/src/github.com/ElrondNetwork/protobuf/protobuf --gogoslick_out=. staking.proto
package systemSmartContracts
import (
"bytes"
"encoding/hex"
"fmt"
"math"
"math/big"
"strconv"
"sync"
logger "github.com/ElrondNetwork/elrond-go-logger"
"github.com/ElrondNetwork/elrond-go/config"
"github.com/ElrondNetwork/elrond-go/core"
"github.com/ElrondNetwork/elrond-go/core/atomic"
"github.com/ElrondNetwork/elrond-go/core/check"
"github.com/ElrondNetwork/elrond-go/core/vmcommon"
"github.com/ElrondNetwork/elrond-go/marshal"
"github.com/ElrondNetwork/elrond-go/vm"
)
var log = logger.GetOrCreate("vm/systemsmartcontracts")
const ownerKey = "owner"
const nodesConfigKey = "nodesConfig"
const waitingListHeadKey = "waitingList"
const waitingElementPrefix = "w_"
type stakingSC struct {
eei vm.SystemEI
unBondPeriod uint64
stakeAccessAddr []byte //TODO add a viewAddress field and use it on all system SC view functions
jailAccessAddr []byte
endOfEpochAccessAddr []byte
numRoundsWithoutBleed uint64
bleedPercentagePerRound float64
maximumPercentageToBleed float64
gasCost vm.GasCost
minNumNodes uint64
maxNumNodes uint64
marshalizer marshal.Marshalizer
enableStakingEpoch uint32
stakeValue *big.Int
flagEnableStaking atomic.Flag
flagStakingV2 atomic.Flag
flagCorrectLastUnjailed atomic.Flag
correctLastUnjailedEpoch uint32
stakingV2Epoch uint32
walletAddressLen int
mutExecution sync.RWMutex
minNodePrice *big.Int
validatorToDelegationEnableEpoch uint32
flagValidatorToDelegation atomic.Flag
}
// ArgsNewStakingSmartContract holds the arguments needed to create a StakingSmartContract
type ArgsNewStakingSmartContract struct {
StakingSCConfig config.StakingSystemSCConfig
MinNumNodes uint64
Eei vm.SystemEI
StakingAccessAddr []byte
JailAccessAddr []byte
EndOfEpochAccessAddr []byte
GasCost vm.GasCost
Marshalizer marshal.Marshalizer
EpochNotifier vm.EpochNotifier
ValidatorToDelegationEnableEpoch uint32
}
type waitingListReturnData struct {
blsKeys [][]byte
stakedDataList []*StakedDataV2_0
lastKey []byte
afterLastjailed bool
}
// NewStakingSmartContract creates a staking smart contract
func NewStakingSmartContract(
args ArgsNewStakingSmartContract,
) (*stakingSC, error) {
if check.IfNil(args.Eei) {
return nil, vm.ErrNilSystemEnvironmentInterface
}
if len(args.StakingAccessAddr) < 1 {
return nil, vm.ErrInvalidStakingAccessAddress
}
if len(args.JailAccessAddr) < 1 {
return nil, vm.ErrInvalidJailAccessAddress
}
if len(args.EndOfEpochAccessAddr) < 1 {
return nil, vm.ErrInvalidEndOfEpochAccessAddress
}
if check.IfNil(args.Marshalizer) {
return nil, vm.ErrNilMarshalizer
}
if args.StakingSCConfig.BleedPercentagePerRound < 0 {
return nil, vm.ErrNegativeBleedPercentagePerRound
}
if args.StakingSCConfig.MaximumPercentageToBleed < 0 {
return nil, vm.ErrNegativeMaximumPercentageToBleed
}
if args.MinNumNodes > args.StakingSCConfig.MaxNumberOfNodesForStake {
return nil, vm.ErrInvalidMaxNumberOfNodes
}
if check.IfNil(args.EpochNotifier) {
return nil, vm.ErrNilEpochNotifier
}
minStakeValue, okValue := big.NewInt(0).SetString(args.StakingSCConfig.MinStakeValue, conversionBase)
if !okValue || minStakeValue.Cmp(zero) <= 0 {
return nil, fmt.Errorf("%w, value is %v", vm.ErrInvalidMinStakeValue, args.StakingSCConfig.MinStakeValue)
}
reg := &stakingSC{
eei: args.Eei,
unBondPeriod: args.StakingSCConfig.UnBondPeriod,
stakeAccessAddr: args.StakingAccessAddr,
jailAccessAddr: args.JailAccessAddr,
numRoundsWithoutBleed: args.StakingSCConfig.NumRoundsWithoutBleed,
bleedPercentagePerRound: args.StakingSCConfig.BleedPercentagePerRound,
maximumPercentageToBleed: args.StakingSCConfig.MaximumPercentageToBleed,
gasCost: args.GasCost,
minNumNodes: args.MinNumNodes,
maxNumNodes: args.StakingSCConfig.MaxNumberOfNodesForStake,
marshalizer: args.Marshalizer,
endOfEpochAccessAddr: args.EndOfEpochAccessAddr,
enableStakingEpoch: args.StakingSCConfig.StakeEnableEpoch,
stakingV2Epoch: args.StakingSCConfig.StakingV2Epoch,
walletAddressLen: len(args.StakingAccessAddr),
minNodePrice: minStakeValue,
correctLastUnjailedEpoch: args.StakingSCConfig.CorrectLastUnjailedEpoch,
validatorToDelegationEnableEpoch: args.ValidatorToDelegationEnableEpoch,
}
var conversionOk bool
reg.stakeValue, conversionOk = big.NewInt(0).SetString(args.StakingSCConfig.GenesisNodePrice, conversionBase)
if !conversionOk || reg.stakeValue.Cmp(zero) < 0 {
return nil, vm.ErrNegativeInitialStakeValue
}
args.EpochNotifier.RegisterNotifyHandler(reg)
return reg, nil
}
// Execute calls one of the functions from the staking smart contract and runs the code according to the input
func (s *stakingSC) Execute(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
s.mutExecution.RLock()
defer s.mutExecution.RUnlock()
if CheckIfNil(args) != nil {
return vmcommon.UserError
}
switch args.Function {
case core.SCDeployInitFunctionName:
return s.init(args)
case "stake":
return s.stake(args, false)
case "register":
return s.stake(args, true)
case "unStake":
return s.unStake(args)
case "unBond":
return s.unBond(args)
case "get":
return s.get(args)
case "isStaked":
return s.isStaked(args)
case "slash":
return s.slash(args)
case "jail":
return s.jail(args)
case "unJail":
return s.unJail(args)
case "changeRewardAddress":
return s.changeRewardAddress(args)
case "changeValidatorKeys":
return s.changeValidatorKey(args)
case "switchJailedWithWaiting":
return s.switchJailedWithWaiting(args)
case "getQueueIndex":
return s.getWaitingListIndex(args)
case "getQueueSize":
return s.getWaitingListSize(args)
case "getRewardAddress":
return s.getRewardAddress(args)
case "getBLSKeyStatus":
return s.getBLSKeyStatus(args)
case "getRemainingUnBondPeriod":
return s.getRemainingUnbondPeriod(args)
case "getQueueRegisterNonceAndRewardAddress":
return s.getWaitingListRegisterNonceAndRewardAddress(args)
case "updateConfigMinNodes":
return s.updateConfigMinNodes(args)
case "setOwnersOnAddresses":
return s.setOwnersOnAddresses(args)
case "getOwner":
return s.getOwner(args)
case "updateConfigMaxNodes":
return s.updateConfigMaxNodes(args)
case "stakeNodesFromQueue":
return s.stakeNodesFromQueue(args)
case "unStakeAtEndOfEpoch":
return s.unStakeAtEndOfEpoch(args)
case "getTotalNumberOfRegisteredNodes":
return s.getTotalNumberOfRegisteredNodes(args)
case "resetLastUnJailedFromQueue":
return s.resetLastUnJailedFromQueue(args)
case "cleanAdditionalQueue":
return s.cleanAdditionalQueue(args)
case "changeOwnerAndRewardAddress":
return s.changeOwnerAndRewardAddress(args)
}
return vmcommon.UserError
}
func (s *stakingSC) addToStakedNodes(value int64) {
stakeConfig := s.getConfig()
stakeConfig.StakedNodes += value
s.setConfig(stakeConfig)
}
func (s *stakingSC) removeFromStakedNodes() {
stakeConfig := s.getConfig()
if stakeConfig.StakedNodes > 0 {
stakeConfig.StakedNodes--
}
s.setConfig(stakeConfig)
}
func (s *stakingSC) numSpareNodes() int64 {
stakeConfig := s.getConfig()
return stakeConfig.StakedNodes - stakeConfig.JailedNodes - stakeConfig.MinNumNodes
}
func (s *stakingSC) canStake() bool {
stakeConfig := s.getConfig()
return stakeConfig.StakedNodes < stakeConfig.MaxNumNodes
}
func (s *stakingSC) canStakeIfOneRemoved() bool {
stakeConfig := s.getConfig()
return stakeConfig.StakedNodes <= stakeConfig.MaxNumNodes
}
func (s *stakingSC) canUnStake() bool {
return s.numSpareNodes() > 0
}
func (s *stakingSC) canUnBond() bool {
return s.numSpareNodes() >= 0
}
func (s *stakingSC) changeValidatorKey(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
if !bytes.Equal(args.CallerAddr, s.stakeAccessAddr) {
s.eei.AddReturnMessage("changeValidatorKey function not allowed to be called by address " + string(args.CallerAddr))
return vmcommon.UserError
}
s.eei.AddReturnMessage("function is deprecated")
return vmcommon.UserError
}
func (s *stakingSC) changeRewardAddress(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
if !bytes.Equal(args.CallerAddr, s.stakeAccessAddr) {
s.eei.AddReturnMessage("stake function not allowed to be called by address " + string(args.CallerAddr))
return vmcommon.UserError
}
if len(args.Arguments) < 2 {
s.eei.AddReturnMessage(fmt.Sprintf("invalid number of arguments: expected min %d, got %d", 2, len(args.Arguments)))
return vmcommon.UserError
}
newRewardAddress := args.Arguments[0]
if len(newRewardAddress) != s.walletAddressLen {
s.eei.AddReturnMessage("invalid reward address")
return vmcommon.UserError
}
for _, blsKey := range args.Arguments[1:] {
stakedData, err := s.getOrCreateRegisteredData(blsKey)
if err != nil {
s.eei.AddReturnMessage("cannot get or create registered data: error " + err.Error())
return vmcommon.UserError
}
if len(stakedData.RewardAddress) == 0 {
continue
}
stakedData.RewardAddress = newRewardAddress
err = s.saveStakingData(blsKey, stakedData)
if err != nil {
s.eei.AddReturnMessage("cannot save staking data: error " + err.Error())
return vmcommon.UserError
}
}
return vmcommon.Ok
}
func (s *stakingSC) removeFromJailedNodes() {
stakeConfig := s.getConfig()
if stakeConfig.JailedNodes > 0 {
stakeConfig.JailedNodes--
}
s.setConfig(stakeConfig)
}
func (s *stakingSC) unJailV1(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
if !bytes.Equal(args.CallerAddr, s.stakeAccessAddr) {
s.eei.AddReturnMessage("unJail function not allowed to be called by address " + string(args.CallerAddr))
return vmcommon.UserError
}
for _, argument := range args.Arguments {
stakedData, err := s.getOrCreateRegisteredData(argument)
if err != nil {
s.eei.AddReturnMessage("cannot get or created registered data: error " + err.Error())
return vmcommon.UserError
}
if len(stakedData.RewardAddress) == 0 {
s.eei.AddReturnMessage("cannot unJail a key that is not registered")
return vmcommon.UserError
}
if stakedData.UnJailedNonce <= stakedData.JailedNonce {
s.removeFromJailedNodes()
}
stakedData.JailedRound = math.MaxUint64
stakedData.UnJailedNonce = s.eei.BlockChainHook().CurrentNonce()
err = s.saveStakingData(argument, stakedData)
if err != nil {
s.eei.AddReturnMessage("cannot save staking data: error " + err.Error())
return vmcommon.UserError
}
}
return vmcommon.Ok
}
func (s *stakingSC) unJail(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
if !s.flagEnableStaking.IsSet() {
return s.unJailV1(args)
}
if !bytes.Equal(args.CallerAddr, s.stakeAccessAddr) {
s.eei.AddReturnMessage("unJail function not allowed to be called by address " + string(args.CallerAddr))
return vmcommon.UserError
}
if len(args.Arguments) != 1 {
s.eei.AddReturnMessage("wrong number of arguments, wanted 1")
return vmcommon.UserError
}
stakedData, err := s.getOrCreateRegisteredData(args.Arguments[0])
if err != nil {
s.eei.AddReturnMessage("cannot get or created registered data: error " + err.Error())
return vmcommon.UserError
}
if len(stakedData.RewardAddress) == 0 {
s.eei.AddReturnMessage("cannot unJail a key that is not registered")
return vmcommon.UserError
}
if !stakedData.Jailed && !s.eei.CanUnJail(args.Arguments[0]) {
s.eei.AddReturnMessage("cannot unJail a node which is not jailed")
return vmcommon.UserError
}
stakedData.JailedRound = math.MaxUint64
stakedData.UnJailedNonce = s.eei.BlockChainHook().CurrentNonce()
stakedData.Jailed = false
err = s.processStake(args.Arguments[0], stakedData, stakedData.NumJailed == 1)
if err != nil {
return vmcommon.UserError
}
err = s.saveStakingData(args.Arguments[0], stakedData)
if err != nil {
s.eei.AddReturnMessage("cannot save staking data: error " + err.Error())
return vmcommon.UserError
}
return vmcommon.Ok
}
func (s *stakingSC) jail(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
if !bytes.Equal(args.CallerAddr, s.jailAccessAddr) {
return vmcommon.UserError
}
for _, argument := range args.Arguments {
stakedData, err := s.getOrCreateRegisteredData(argument)
if err != nil {
s.eei.AddReturnMessage("cannot get or create registered data: error " + err.Error())
return vmcommon.UserError
}
if len(stakedData.RewardAddress) == 0 {
s.eei.AddReturnMessage("cannot jail a key that is not registered")
return vmcommon.UserError
}
stakedData.JailedRound = s.eei.BlockChainHook().CurrentRound()
stakedData.JailedNonce = s.eei.BlockChainHook().CurrentNonce()
stakedData.Jailed = true
stakedData.NumJailed++
err = s.saveStakingData(argument, stakedData)
if err != nil {
s.eei.AddReturnMessage("cannot save staking data: error " + err.Error())
return vmcommon.UserError
}
}
return vmcommon.Ok
}
func (s *stakingSC) get(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
if s.flagStakingV2.IsSet() {
s.eei.AddReturnMessage("function deprecated")
return vmcommon.UserError
}
if len(args.Arguments) < 1 {
s.eei.AddReturnMessage(fmt.Sprintf("invalid number of arguments: expected min %d, got %d", 1, 0))
return vmcommon.UserError
}
value := s.eei.GetStorage(args.Arguments[0])
s.eei.Finish(value)
return vmcommon.Ok
}
func (s *stakingSC) init(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
ownerAddress := s.eei.GetStorage([]byte(ownerKey))
if ownerAddress != nil {
s.eei.AddReturnMessage("smart contract was already initialized")
return vmcommon.UserError
}
s.eei.SetStorage([]byte(ownerKey), args.CallerAddr)
s.eei.SetStorage(args.CallerAddr, big.NewInt(0).Bytes())
stakeConfig := &StakingNodesConfig{
MinNumNodes: int64(s.minNumNodes),
MaxNumNodes: int64(s.maxNumNodes),
}
s.setConfig(stakeConfig)
epoch := s.eei.BlockChainHook().CurrentEpoch()
epochData := fmt.Sprintf("epoch_%d", epoch)
s.eei.SetStorage([]byte(epochData), s.stakeValue.Bytes())
return vmcommon.Ok
}
func (s *stakingSC) stake(args *vmcommon.ContractCallInput, onlyRegister bool) vmcommon.ReturnCode {
if !bytes.Equal(args.CallerAddr, s.stakeAccessAddr) {
s.eei.AddReturnMessage("stake function not allowed to be called by address " + string(args.CallerAddr))
return vmcommon.UserError
}
if len(args.Arguments) < 3 {
s.eei.AddReturnMessage("not enough arguments, needed BLS key, reward address and owner address")
return vmcommon.UserError
}
registrationData, err := s.getOrCreateRegisteredData(args.Arguments[0])
if err != nil {
s.eei.AddReturnMessage("cannot get or create registered data: error " + err.Error())
return vmcommon.UserError
}
if s.isNodeJailedOrWithBadRating(registrationData, args.Arguments[0]) {
s.eei.AddReturnMessage("cannot stake node which is jailed or with bad rating")
return vmcommon.UserError
}
registrationData.RewardAddress = args.Arguments[1]
registrationData.OwnerAddress = args.Arguments[2]
registrationData.StakeValue.Set(s.stakeValue)
if !onlyRegister {
err = s.processStake(args.Arguments[0], registrationData, false)
if err != nil {
return vmcommon.UserError
}
}
err = s.saveStakingData(args.Arguments[0], registrationData)
if err != nil {
s.eei.AddReturnMessage("cannot save staking registered data: error " + err.Error())
return vmcommon.UserError
}
return vmcommon.Ok
}
func (s *stakingSC) processStake(blsKey []byte, registrationData *StakedDataV2_0, addFirst bool) error {
if registrationData.Staked {
return nil
}
registrationData.RegisterNonce = s.eei.BlockChainHook().CurrentNonce()
if !s.canStake() {
s.eei.AddReturnMessage(fmt.Sprintf("staking is full key put into waiting list %s", hex.EncodeToString(blsKey)))
err := s.addToWaitingList(blsKey, addFirst)
if err != nil {
s.eei.AddReturnMessage("error while adding to waiting")
return err
}
registrationData.Waiting = true
s.eei.Finish([]byte{waiting})
return nil
}
err := s.removeFromWaitingList(blsKey)
if err != nil {
s.eei.AddReturnMessage("error while removing from waiting")
return err
}
s.addToStakedNodes(1)
s.activeStakingFor(registrationData)
return nil
}
func (s *stakingSC) activeStakingFor(stakingData *StakedDataV2_0) {
stakingData.RegisterNonce = s.eei.BlockChainHook().CurrentNonce()
stakingData.Staked = true
stakingData.StakedNonce = s.eei.BlockChainHook().CurrentNonce()
stakingData.UnStakedEpoch = core.DefaultUnstakedEpoch
stakingData.UnStakedNonce = 0
stakingData.Waiting = false
}
func (s *stakingSC) unStakeAtEndOfEpoch(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
if !bytes.Equal(args.CallerAddr, s.endOfEpochAccessAddr) {
// backward compatibility - no need for return message
return vmcommon.UserError
}
if len(args.Arguments) != 1 {
s.eei.AddReturnMessage("not enough arguments, needed the BLS key")
return vmcommon.UserError
}
registrationData, err := s.getOrCreateRegisteredData(args.Arguments[0])
if err != nil {
s.eei.AddReturnMessage("cannot get or create registered data: error " + err.Error())
return vmcommon.UserError
}
if len(registrationData.RewardAddress) == 0 {
s.eei.AddReturnMessage("cannot unStake a key that is not registered")
return vmcommon.UserError
}
if registrationData.Jailed && !registrationData.Staked {
s.eei.AddReturnMessage("already unStaked at switchJailedToWaiting")
return vmcommon.Ok
}
if !registrationData.Staked && !registrationData.Waiting {
log.Debug("stakingSC.unStakeAtEndOfEpoch: cannot unStake node which was already unStaked", "blsKey", hex.EncodeToString(args.Arguments[0]))
return vmcommon.Ok
}
if registrationData.Staked {
s.removeFromStakedNodes()
}
if registrationData.Waiting {
err = s.removeFromWaitingList(args.Arguments[0])
if err != nil {
s.eei.AddReturnMessage(err.Error())
return vmcommon.UserError
}
}
registrationData.Staked = false
registrationData.UnStakedEpoch = s.eei.BlockChainHook().CurrentEpoch()
registrationData.UnStakedNonce = s.eei.BlockChainHook().CurrentNonce()
registrationData.Waiting = false
err = s.saveStakingData(args.Arguments[0], registrationData)
if err != nil {
s.eei.AddReturnMessage("cannot save staking data: error " + err.Error())
return vmcommon.UserError
}
return vmcommon.Ok
}
func (s *stakingSC) unStake(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
if !bytes.Equal(args.CallerAddr, s.stakeAccessAddr) {
s.eei.AddReturnMessage("unStake function not allowed to be called by address " + string(args.CallerAddr))
return vmcommon.UserError
}
if len(args.Arguments) < 2 {
s.eei.AddReturnMessage("not enough arguments, needed BLS key and reward address")
return vmcommon.UserError
}
registrationData, err := s.getOrCreateRegisteredData(args.Arguments[0])
if err != nil {
s.eei.AddReturnMessage("cannot get or create registered data: error " + err.Error())
return vmcommon.UserError
}
if len(registrationData.RewardAddress) == 0 {
s.eei.AddReturnMessage("cannot unStake a key that is not registered")
return vmcommon.UserError
}
if !bytes.Equal(args.Arguments[1], registrationData.RewardAddress) {
s.eei.AddReturnMessage("unStake possible only from staker caller")
return vmcommon.UserError
}
if s.isNodeJailedOrWithBadRating(registrationData, args.Arguments[0]) {
s.eei.AddReturnMessage("cannot unStake node which is jailed or with bad rating")
return vmcommon.UserError
}
if !registrationData.Staked && !registrationData.Waiting {
s.eei.AddReturnMessage("cannot unStake node which was already unStaked")
return vmcommon.UserError
}
if !registrationData.Staked {
registrationData.Waiting = false
err = s.removeFromWaitingList(args.Arguments[0])
if err != nil {
s.eei.AddReturnMessage(err.Error())
return vmcommon.UserError
}
err = s.saveStakingData(args.Arguments[0], registrationData)
if err != nil {
s.eei.AddReturnMessage("cannot save staking data: error " + err.Error())
return vmcommon.UserError
}
return vmcommon.Ok
}
addOneFromQueue := !s.flagCorrectLastUnjailed.IsSet() || s.canStakeIfOneRemoved()
if addOneFromQueue {
_, err = s.moveFirstFromWaitingToStaked()
if err != nil {
s.eei.AddReturnMessage(err.Error())
return vmcommon.UserError
}
}
if !s.canUnStake() {
s.eei.AddReturnMessage("unStake is not possible as too many left")
return vmcommon.UserError
}
s.removeFromStakedNodes()
registrationData.Staked = false
registrationData.UnStakedEpoch = s.eei.BlockChainHook().CurrentEpoch()
registrationData.UnStakedNonce = s.eei.BlockChainHook().CurrentNonce()
registrationData.Waiting = false
err = s.saveStakingData(args.Arguments[0], registrationData)
if err != nil {
s.eei.AddReturnMessage("cannot save staking data: error " + err.Error())
return vmcommon.UserError
}
return vmcommon.Ok
}
func (s *stakingSC) moveFirstFromWaitingToStakedIfNeeded(blsKey []byte) (bool, error) {
waitingElementKey := s.createWaitingListKey(blsKey)
_, err := s.getWaitingListElement(waitingElementKey)
if err == nil {
// node in waiting - remove from it - and that's it
return false, s.removeFromWaitingList(blsKey)
}
return s.moveFirstFromWaitingToStaked()
}
func (s *stakingSC) moveFirstFromWaitingToStaked() (bool, error) {
waitingList, err := s.getWaitingListHead()
if err != nil {
return false, err
}
if waitingList.Length == 0 {
return false, nil
}
elementInList, err := s.getWaitingListElement(waitingList.FirstKey)
if err != nil {
return false, err
}
err = s.removeFromWaitingList(elementInList.BLSPublicKey)
if err != nil {
return false, err
}
nodeData, err := s.getOrCreateRegisteredData(elementInList.BLSPublicKey)
if err != nil {
return false, err
}
if len(nodeData.RewardAddress) == 0 || nodeData.Staked {
return false, vm.ErrInvalidWaitingList
}
nodeData.Waiting = false
nodeData.Staked = true
nodeData.RegisterNonce = s.eei.BlockChainHook().CurrentNonce()
nodeData.StakedNonce = s.eei.BlockChainHook().CurrentNonce()
nodeData.UnStakedNonce = 0
nodeData.UnStakedEpoch = core.DefaultUnstakedEpoch
s.addToStakedNodes(1)
return true, s.saveStakingData(elementInList.BLSPublicKey, nodeData)
}
func (s *stakingSC) unBond(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
if !bytes.Equal(args.CallerAddr, s.stakeAccessAddr) {
s.eei.AddReturnMessage("unBond function not allowed to be called by address " + string(args.CallerAddr))
return vmcommon.UserError
}
if len(args.Arguments) < 1 {
s.eei.AddReturnMessage("not enough arguments, needed BLS key")
return vmcommon.UserError
}
registrationData, err := s.getOrCreateRegisteredData(args.Arguments[0])
if err != nil {
s.eei.AddReturnMessage("cannot get or create registered data: error " + err.Error())
return vmcommon.UserError
}
blsKeyBytes := make([]byte, 2*len(args.Arguments[0]))
_ = hex.Encode(blsKeyBytes, args.Arguments[0])
encodedBlsKey := string(blsKeyBytes)
if len(registrationData.RewardAddress) == 0 {
s.eei.AddReturnMessage(fmt.Sprintf("cannot unBond key %s that is not registered", encodedBlsKey))
return vmcommon.UserError
}
if registrationData.Staked {
s.eei.AddReturnMessage(fmt.Sprintf("unBond is not possible for key %s which is staked", encodedBlsKey))
return vmcommon.UserError
}
if s.isNodeJailedOrWithBadRating(registrationData, args.Arguments[0]) {
s.eei.AddReturnMessage("cannot unBond node which is jailed or with bad rating " + encodedBlsKey)
return vmcommon.UserError
}
if registrationData.Waiting {
s.eei.AddReturnMessage(fmt.Sprintf("unBond in not possible for key %s which is in waiting list", encodedBlsKey))
return vmcommon.UserError
}
currentNonce := s.eei.BlockChainHook().CurrentNonce()
if registrationData.UnStakedNonce > 0 && currentNonce-registrationData.UnStakedNonce < s.unBondPeriod {
s.eei.AddReturnMessage(fmt.Sprintf("unBond is not possible for key %s because unBond period did not pass", encodedBlsKey))
return vmcommon.UserError
}
if !s.canUnBond() {
s.eei.AddReturnMessage("unBond is currently unavailable: number of total validators in the network is at minimum")
return vmcommon.UserError
}
if s.eei.IsValidator(args.Arguments[0]) {
s.eei.AddReturnMessage("unBond is not possible: the node with key " + encodedBlsKey + " is still a validator")
return vmcommon.UserError
}
s.eei.SetStorage(args.Arguments[0], nil)
return vmcommon.Ok
}
// backward compatibility
func (s *stakingSC) slash(_ *vmcommon.ContractCallInput) vmcommon.ReturnCode {
s.eei.AddReturnMessage("slash function called by not the owners address")
return vmcommon.UserError
}
func (s *stakingSC) isStaked(args *vmcommon.ContractCallInput) vmcommon.ReturnCode {
if len(args.Arguments) < 1 {
s.eei.AddReturnMessage(fmt.Sprintf("invalid number of arguments: expected min %d, got %d", 1, 0))
return vmcommon.UserError
}
if args.CallValue.Cmp(zero) != 0 {
s.eei.AddReturnMessage(vm.TransactionValueMustBeZero)
return vmcommon.UserError
}
registrationData, err := s.getOrCreateRegisteredData(args.Arguments[0])
if err != nil {
s.eei.AddReturnMessage("cannot get or create registered data: error " + err.Error())
return vmcommon.UserError
}
if len(registrationData.RewardAddress) == 0 {
s.eei.AddReturnMessage("key is not registered")
return vmcommon.UserError
}
if registrationData.Staked {
return vmcommon.Ok
}
s.eei.AddReturnMessage("account not staked")
return vmcommon.UserError
}
func (s *stakingSC) addToWaitingList(blsKey []byte, addJailed bool) error {
inWaitingListKey := s.createWaitingListKey(blsKey)
marshaledData := s.eei.GetStorage(inWaitingListKey)
if len(marshaledData) != 0 {
return nil
}
waitingList, err := s.getWaitingListHead()
if err != nil {
return err
}
waitingList.Length += 1
if waitingList.Length == 1 {
waitingList.FirstKey = inWaitingListKey
waitingList.LastKey = inWaitingListKey
if addJailed {
waitingList.LastJailedKey = inWaitingListKey
}
elementInWaiting := &ElementInList{
BLSPublicKey: blsKey,
PreviousKey: waitingList.LastKey,
NextKey: make([]byte, 0),
}
return s.saveElementAndList(inWaitingListKey, elementInWaiting, waitingList)
}
if addJailed {
return s.insertAfterLastJailed(waitingList, blsKey)
}
return s.addToEndOfTheList(waitingList, blsKey)
}
func (s *stakingSC) addToEndOfTheList(waitingList *WaitingList, blsKey []byte) error {
inWaitingListKey := s.createWaitingListKey(blsKey)
oldLastKey := make([]byte, len(waitingList.LastKey))
copy(oldLastKey, waitingList.LastKey)
lastElement, err := s.getWaitingListElement(waitingList.LastKey)
if err != nil {
return err
}
lastElement.NextKey = inWaitingListKey
elementInWaiting := &ElementInList{
BLSPublicKey: blsKey,
PreviousKey: oldLastKey,
NextKey: make([]byte, 0),
}
err = s.saveWaitingListElement(oldLastKey, lastElement)
if err != nil {
return err
}
waitingList.LastKey = inWaitingListKey
return s.saveElementAndList(inWaitingListKey, elementInWaiting, waitingList)
}
func (s *stakingSC) insertAfterLastJailed(
waitingList *WaitingList,
blsKey []byte,
) error {
inWaitingListKey := s.createWaitingListKey(blsKey)
if len(waitingList.LastJailedKey) == 0 {
nextKey := make([]byte, len(waitingList.FirstKey))
copy(nextKey, waitingList.FirstKey)
waitingList.FirstKey = inWaitingListKey
waitingList.LastJailedKey = inWaitingListKey
elementInWaiting := &ElementInList{
BLSPublicKey: blsKey,
PreviousKey: inWaitingListKey,
NextKey: nextKey,
}
return s.saveElementAndList(inWaitingListKey, elementInWaiting, waitingList)
}
lastJailedElement, err := s.getWaitingListElement(waitingList.LastJailedKey)
if err != nil {
return err
}
if bytes.Equal(waitingList.LastKey, waitingList.LastJailedKey) {
waitingList.LastJailedKey = inWaitingListKey
return s.addToEndOfTheList(waitingList, blsKey)
}
firstNonJailedElement, err := s.getWaitingListElement(lastJailedElement.NextKey)
if err != nil {
return err
}
elementInWaiting := &ElementInList{
BLSPublicKey: blsKey,
PreviousKey: make([]byte, len(inWaitingListKey)),
NextKey: make([]byte, len(inWaitingListKey)),
}
copy(elementInWaiting.PreviousKey, waitingList.LastJailedKey)
copy(elementInWaiting.NextKey, lastJailedElement.NextKey)
lastJailedElement.NextKey = inWaitingListKey
firstNonJailedElement.PreviousKey = inWaitingListKey
waitingList.LastJailedKey = inWaitingListKey
err = s.saveWaitingListElement(elementInWaiting.PreviousKey, lastJailedElement)
if err != nil {
return err
}
err = s.saveWaitingListElement(elementInWaiting.NextKey, firstNonJailedElement)
if err != nil {
return err
}
err = s.saveWaitingListElement(inWaitingListKey, elementInWaiting)
if err != nil {
return err
}
return s.saveWaitingListHead(waitingList)
}
func (s *stakingSC) saveElementAndList(key []byte, element *ElementInList, waitingList *WaitingList) error {
err := s.saveWaitingListElement(key, element)
if err != nil {
return err
}
return s.saveWaitingListHead(waitingList)
}
func (s *stakingSC) removeFromWaitingList(blsKey []byte) error {
inWaitingListKey := s.createWaitingListKey(blsKey)
marshaledData := s.eei.GetStorage(inWaitingListKey)
if len(marshaledData) == 0 {
return nil
}
s.eei.SetStorage(inWaitingListKey, nil)
elementToRemove := &ElementInList{}
err := s.marshalizer.Unmarshal(elementToRemove, marshaledData)
if err != nil {
return err
}
waitingList, err := s.getWaitingListHead()
if err != nil {
return err
}
if waitingList.Length == 0 {
return vm.ErrInvalidWaitingList
}
waitingList.Length -= 1
if waitingList.Length == 0 {
s.eei.SetStorage([]byte(waitingListHeadKey), nil)
return nil
}
// remove the first element
if bytes.Equal(elementToRemove.PreviousKey, inWaitingListKey) {
if bytes.Equal(inWaitingListKey, waitingList.LastJailedKey) {
waitingList.LastJailedKey = make([]byte, 0)
}
nextElement, errGet := s.getWaitingListElement(elementToRemove.NextKey)
if errGet != nil {
return errGet
}
nextElement.PreviousKey = elementToRemove.NextKey
waitingList.FirstKey = elementToRemove.NextKey
return s.saveElementAndList(elementToRemove.NextKey, nextElement, waitingList)
}
if !s.flagCorrectLastUnjailed.IsSet() || bytes.Equal(inWaitingListKey, waitingList.LastJailedKey) {
waitingList.LastJailedKey = make([]byte, len(elementToRemove.PreviousKey))
copy(waitingList.LastJailedKey, elementToRemove.PreviousKey)
}
previousElement, err := s.getWaitingListElement(elementToRemove.PreviousKey)
if err != nil {
return err
}
if len(elementToRemove.NextKey) == 0 {
waitingList.LastKey = elementToRemove.PreviousKey
previousElement.NextKey = make([]byte, 0)
return s.saveElementAndList(elementToRemove.PreviousKey, previousElement, waitingList)
}
nextElement, err := s.getWaitingListElement(elementToRemove.NextKey)
if err != nil {
return err
}
nextElement.PreviousKey = elementToRemove.PreviousKey
previousElement.NextKey = elementToRemove.NextKey
err = s.saveWaitingListElement(elementToRemove.NextKey, nextElement)