/
msg_server.go
1076 lines (992 loc) · 34 KB
/
msg_server.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
package keeper
import (
"context"
"errors"
"fmt"
"cosmossdk.io/collections"
cosmoserrors "cosmossdk.io/errors"
cosmosMath "cosmossdk.io/math"
"github.com/allora-network/allora-chain/app/params"
state "github.com/allora-network/allora-chain/x/emissions"
sdk "github.com/cosmos/cosmos-sdk/types"
)
type msgServer struct {
k Keeper
}
var _ state.MsgServer = msgServer{}
// NewMsgServerImpl returns an implementation of the module MsgServer interface.
func NewMsgServerImpl(keeper Keeper) state.MsgServer {
return &msgServer{k: keeper}
}
func (ms msgServer) UpdateParams(ctx context.Context, msg *state.MsgUpdateParams) (*state.MsgUpdateParamsResponse, error) {
sender, err := sdk.AccAddressFromBech32(msg.Sender)
if err != nil {
return nil, err
}
isAdmin, err := ms.k.IsWhitelistAdmin(ctx, sender)
if err != nil {
return nil, err
}
if !isAdmin {
return nil, state.ErrNotWhitelistAdmin
}
existingParams, err := ms.k.GetParams(ctx)
if err != nil {
return nil, err
}
// every option is a repeated field, so we interpret an empty array as "make no change"
newParams := msg.Params
if len(newParams.Version) == 1 {
existingParams.Version = newParams.Version[0]
}
if len(newParams.EpochLength) == 1 {
existingParams.EpochLength = newParams.EpochLength[0]
}
if len(newParams.MinTopicUnmetDemand) == 1 {
existingParams.MinTopicUnmetDemand = newParams.MinTopicUnmetDemand[0]
}
if len(newParams.MaxTopicsPerBlock) == 1 {
existingParams.MaxTopicsPerBlock = newParams.MaxTopicsPerBlock[0]
}
if len(newParams.MinRequestUnmetDemand) == 1 {
existingParams.MinRequestUnmetDemand = newParams.MinRequestUnmetDemand[0]
}
if len(newParams.MaxMissingInferencePercent) == 1 {
existingParams.MaxMissingInferencePercent = newParams.MaxMissingInferencePercent[0]
}
if len(newParams.RequiredMinimumStake) == 1 {
existingParams.RequiredMinimumStake = newParams.RequiredMinimumStake[0]
}
if len(newParams.RemoveStakeDelayWindow) == 1 {
existingParams.RemoveStakeDelayWindow = newParams.RemoveStakeDelayWindow[0]
}
if len(newParams.MinRequestCadence) == 1 {
existingParams.MinRequestCadence = newParams.MinRequestCadence[0]
}
if len(newParams.MinWeightCadence) == 1 {
existingParams.MinWeightCadence = newParams.MinWeightCadence[0]
}
if len(newParams.MaxInferenceRequestValidity) == 1 {
existingParams.MaxInferenceRequestValidity = newParams.MaxInferenceRequestValidity[0]
}
if len(newParams.MaxRequestCadence) == 1 {
existingParams.MaxRequestCadence = newParams.MaxRequestCadence[0]
}
if len(newParams.PercentRewardsReputersWorkers) == 1 {
existingParams.PercentRewardsReputersWorkers = newParams.PercentRewardsReputersWorkers[0]
}
err = ms.k.SetParams(ctx, existingParams)
if err != nil {
return nil, err
}
return &state.MsgUpdateParamsResponse{}, nil
}
func (ms msgServer) CreateNewTopic(ctx context.Context, msg *state.MsgCreateNewTopic) (*state.MsgCreateNewTopicResponse, error) {
fmt.Println("CreateNewTopic called with: ", msg)
// Check if the sender is in the topic creation whitelist
creator, err := sdk.AccAddressFromBech32(msg.Creator)
if err != nil {
return nil, err
}
isTopicCreator, err := ms.k.IsInTopicCreationWhitelist(ctx, creator)
if err != nil {
return nil, err
}
if !isTopicCreator {
return nil, state.ErrNotInTopicCreationWhitelist
}
id, err := ms.k.GetNumTopics(ctx)
if err != nil {
return nil, err
}
fastestCadence, err := ms.k.GetParamsMinRequestCadence(ctx)
if err != nil {
return nil, err
}
if msg.InferenceCadence < fastestCadence {
return nil, state.ErrInferenceCadenceBelowMinimum
}
weightFastestCadence, err := ms.k.GetParamsMinWeightCadence(ctx)
if err != nil {
return nil, err
}
if msg.WeightCadence < weightFastestCadence {
return nil, state.ErrWeightCadenceBelowMinimum
}
topic := state.Topic{
Id: id,
Creator: creator.String(),
Metadata: msg.Metadata,
WeightLogic: msg.WeightLogic,
WeightMethod: msg.WeightMethod,
WeightCadence: msg.WeightCadence,
WeightLastRan: 0,
InferenceLogic: msg.InferenceLogic,
InferenceMethod: msg.InferenceMethod,
InferenceCadence: msg.InferenceCadence,
InferenceLastRan: 0,
Active: true,
DefaultArg: msg.DefaultArg,
}
_, err = ms.k.IncrementTopicId(ctx)
if err != nil {
return nil, err
}
if err := ms.k.SetTopic(ctx, id, topic); err != nil {
return nil, err
}
// Rather than set latest weight-adjustment timestamp of a topic to 0
// we do nothing, since no value in the map means zero
return &state.MsgCreateNewTopicResponse{TopicId: id}, nil
}
func (ms msgServer) SetWeights(ctx context.Context, msg *state.MsgSetWeights) (*state.MsgSetWeightsResponse, error) {
// Check if the sender is in the weight setting whitelist
sender, err := sdk.AccAddressFromBech32(msg.Sender)
if err != nil {
return nil, err
}
isWeightSetter, err := ms.k.IsInWeightSettingWhitelist(ctx, sender)
if err != nil {
return nil, err
}
if !isWeightSetter {
return nil, state.ErrNotInWeightSettingWhitelist
}
// Iterate through the array and set the weights
for _, weightEntry := range msg.Weights {
fmt.Println("Topic: ", weightEntry.TopicId, "| Reputer: ", weightEntry.Reputer, "| Worker: ", weightEntry.Worker, "| Weight: ", weightEntry.Weight)
reputerAddr, err := sdk.AccAddressFromBech32(weightEntry.Reputer)
if err != nil {
return nil, err
}
workerAddr, err := sdk.AccAddressFromBech32(weightEntry.Worker)
if err != nil {
return nil, err
}
err = ms.k.SetWeight(ctx, weightEntry.TopicId, reputerAddr, workerAddr, weightEntry.Weight)
if err != nil {
return nil, err
}
}
return &state.MsgSetWeightsResponse{}, nil
}
// T1: a tx function that accepts a list of inferences and possibly returns an error
func (ms msgServer) ProcessInferences(ctx context.Context, msg *state.MsgProcessInferences) (*state.MsgProcessInferencesResponse, error) {
sdkCtx := sdk.UnwrapSDKContext(ctx)
inferences := msg.Inferences
// Group inferences by topicId - Create a map to store the grouped inferences
groupedInferences := make(map[uint64][]*state.Inference)
// Iterate through the array and group by topic_id
for _, inference := range inferences {
groupedInferences[inference.TopicId] = append(groupedInferences[inference.TopicId], inference)
}
actualTimestamp := uint64(sdkCtx.BlockTime().Unix())
// Update all_inferences
for topicId, inferences := range groupedInferences {
topicInferences := &state.Inferences{
Inferences: inferences,
}
err := ms.k.InsertInferences(ctx, topicId, actualTimestamp, *topicInferences)
if err != nil {
return nil, err
}
}
// Return an empty response as the operation was successful
return &state.MsgProcessInferencesResponse{}, nil
}
// ########################################
// # Node Registration #
// ########################################
// Registers a new network participant to the network for the first time
func (ms msgServer) Register(ctx context.Context, msg *state.MsgRegister) (*state.MsgRegisterResponse, error) {
if msg.GetLibP2PKey() == "" {
return nil, state.ErrLibP2PKeyRequired
}
address, err := sdk.AccAddressFromBech32(msg.Creator)
if err != nil {
return nil, err
}
// require funds to be at least greater than the minimum stake
requiredMinimumStake, err := ms.k.GetParamsRequiredMinimumStake(ctx)
if err != nil {
return nil, err
}
// check user existing stake
addressExistingStake, err := ms.k.GetDelegatorStake(ctx, address)
if err != nil {
return nil, err
}
// check if the user has enough funds to register
totalAddressStake := addressExistingStake.Add(msg.GetInitialStake())
if totalAddressStake.LT(requiredMinimumStake) {
return nil, cosmoserrors.Wrapf(state.ErrInsufficientStakeToRegister,
"required minimum stake: %s, existing address stake: %s, initial stake: %s",
requiredMinimumStake, addressExistingStake, msg.GetInitialStake())
}
// check if topics exists and if address is already registered in any of them
registeredTopicIds, err := ms.k.GetRegisteredTopicIdsByAddress(ctx, address)
if err != nil {
return nil, err
}
if len(registeredTopicIds) > 0 {
return nil, state.ErrAddressAlreadyRegisteredInATopic
}
for _, topicId := range msg.TopicIds {
// check if topic exists
topicExists, err := ms.k.TopicExists(ctx, topicId)
if !topicExists {
return nil, state.ErrTopicDoesNotExist
} else if err != nil {
return nil, err
}
}
// move the tokens from the creator to the module account
// then add the stake to the total, topicTotal, and 3 staking tracking maps
moveFundsAddStake(ctx, ms, address, msg)
nodeInfo := state.OffchainNode{
NodeAddress: msg.Creator,
LibP2PKey: msg.LibP2PKey,
MultiAddress: msg.MultiAddress,
}
if msg.IsReputer {
// add node to topicReputers
// add node to reputers
err = ms.k.InsertReputer(ctx, msg.TopicIds, address, nodeInfo)
if err != nil {
return nil, err
}
} else {
if msg.Owner == "" {
return nil, state.ErrOwnerCannotBeEmpty
}
nodeInfo.Owner = msg.Owner
nodeInfo.NodeId = msg.Owner + "|" + msg.LibP2PKey
// add node to topicWorkers
// add node to workers
err = ms.k.InsertWorker(ctx, msg.TopicIds, address, nodeInfo)
if err != nil {
return nil, err
}
}
return &state.MsgRegisterResponse{
Success: true,
Message: "Node successfully registered",
}, nil
}
// Add additional topics after initial reputer or worker registration
func (ms msgServer) AddNewRegistration(ctx context.Context, msg *state.MsgAddNewRegistration) (*state.MsgAddNewRegistrationResponse, error) {
// check if topics exists and if address is already registered in any of them
address, err := sdk.AccAddressFromBech32(msg.Creator)
if err != nil {
return nil, err
}
// check if topic exists
topicExists, err := ms.k.TopicExists(ctx, msg.TopicId)
if err != nil {
return nil, err
} else if !topicExists {
return nil, state.ErrTopicDoesNotExist
}
registeredTopicIds, err := ms.k.GetRegisteredTopicIdsByAddress(ctx, address)
if err != nil {
return nil, err
}
if len(registeredTopicIds) == 0 {
return nil, state.ErrAddressIsNotRegisteredInAnyTopic
}
// copy overall staking power of the wallet to the topic stake
totalAddressStake, err := ms.k.GetStakePlacedUponTarget(ctx, address)
if err != nil {
return nil, err
}
// add to topic stake
err = ms.k.AddStakeToTopics(ctx, []uint64{msg.GetTopicId()}, totalAddressStake)
if err != nil {
return nil, err
}
nodeInfo := state.OffchainNode{
NodeAddress: msg.Creator,
LibP2PKey: msg.LibP2PKey,
MultiAddress: msg.MultiAddress,
}
if msg.IsReputer {
// get topics where the users is registered as reputer
reputerRegisteredTopicIds, err := ms.k.GetRegisteredTopicIdByReputerAddress(ctx, address)
if err != nil {
return nil, err
}
for _, topicIdRegistered := range reputerRegisteredTopicIds {
if topicIdRegistered == msg.TopicId {
return nil, state.ErrReputerAlreadyRegisteredInTopic
}
}
// add node to topicReputers
err = ms.k.InsertReputer(ctx, []uint64{msg.TopicId}, address, nodeInfo)
if err != nil {
return nil, err
}
} else {
// get topics where the users is registered as worker
reputerRegisteredTopicIds, err := ms.k.GetRegisteredTopicIdsByWorkerAddress(ctx, address)
if err != nil {
return nil, err
}
for _, topicIdRegistered := range reputerRegisteredTopicIds {
if topicIdRegistered == msg.TopicId {
return nil, state.ErrReputerAlreadyRegisteredInTopic
}
}
// add node to topicWorkers
err = ms.k.InsertWorker(ctx, []uint64{msg.TopicId}, address, nodeInfo)
if err != nil {
return nil, err
}
}
return &state.MsgAddNewRegistrationResponse{
Success: true,
Message: fmt.Sprintf("Node successfully registered in topic %d", msg.TopicId),
}, nil
}
// Remove registration from a topic
func (ms msgServer) RemoveRegistration(ctx context.Context, msg *state.MsgRemoveRegistration) (*state.MsgRemoveRegistrationResponse, error) {
// check if topic exists
topicExists, err := ms.k.TopicExists(ctx, msg.TopicId)
if err != nil {
return nil, err
} else if !topicExists {
return nil, state.ErrTopicDoesNotExist
}
// Check if the address is registered in the specified topic
address, err := sdk.AccAddressFromBech32(msg.Creator)
if err != nil {
return nil, err
}
registeredTopicIds, err := ms.k.GetRegisteredTopicIdsByAddress(ctx, address)
if err != nil {
return nil, err
}
isRegisteredInTopic := false
for _, topicId := range registeredTopicIds {
if topicId == msg.TopicId {
isRegisteredInTopic = true
break
}
}
if !isRegisteredInTopic {
return nil, state.ErrAddressIsNotRegisteredInThisTopic
}
// remove overall staking power of the wallet to the topic stake
totalAddressStake, err := ms.k.GetStakePlacedUponTarget(ctx, address)
if err != nil {
return nil, err
}
// remove from topic stake
err = ms.k.RemoveStakeFromTopics(ctx, []uint64{msg.TopicId}, totalAddressStake)
if err != nil {
return nil, err
}
// Proceed based on whether the address is registered as a reputer or worker
if msg.IsReputer {
// Remove the reputer registration from the topic
err = ms.k.RemoveReputer(ctx, msg.TopicId, address)
if err != nil {
return nil, err
}
} else {
// Remove the worker registration from the topic
err = ms.k.RemoveWorker(ctx, msg.TopicId, address)
if err != nil {
return nil, err
}
}
// Return a successful response
return &state.MsgRemoveRegistrationResponse{
Success: true,
Message: fmt.Sprintf("Node successfully removed from topic %d", msg.TopicId),
}, nil
}
// Function for reputers or workers to call to add stake to an existing stake position.
func (ms msgServer) AddStake(ctx context.Context, msg *state.MsgAddStake) (*state.MsgAddStakeResponse, error) {
// 1. check the sender is registered
senderAddr, err := sdk.AccAddressFromBech32(msg.Sender)
if err != nil {
return nil, err
}
targetAddr, err := sdk.AccAddressFromBech32(msg.StakeTarget)
if err != nil {
return nil, err
}
err = checkNodeRegistered(ctx, ms, senderAddr)
if err != nil {
return nil, err
}
// 2. check the target exists and is registered
err = checkNodeRegistered(ctx, ms, targetAddr)
if err != nil {
return nil, err
}
// 3. check the sender has enough funds to add the stake
// bank module does this for us in module SendCoins / subUnlockedCoins so we don't need to check
// 4. send the funds
amountInt := cosmosMath.NewIntFromBigInt(msg.Amount.BigInt())
coins := sdk.NewCoins(sdk.NewCoin(params.DefaultBondDenom, amountInt))
ms.k.bankKeeper.SendCoinsFromAccountToModule(ctx, senderAddr, state.AlloraStakingAccountName, coins)
// 5. get target topics Registerd
TopicIds, err := ms.k.GetRegisteredTopicIdsByAddress(ctx, targetAddr)
if err != nil {
return nil, err
}
// 6. update the stake data structures
err = ms.k.AddStake(ctx, TopicIds, msg.Sender, msg.StakeTarget, msg.Amount)
if err != nil {
return nil, err
}
return &state.MsgAddStakeResponse{}, nil
}
func (ms msgServer) ModifyStake(ctx context.Context, msg *state.MsgModifyStake) (*state.MsgModifyStakeResponse, error) {
// 1. check the sender is registered
senderAddr, err := sdk.AccAddressFromBech32(msg.Sender)
if err != nil {
return nil, err
}
// 2. For all stake befores, check the sum is less than or equal to this sender's existing stake
// 3. For all stake befores, check that the bond is greater than or equal to the amount being removed
senderTotalStake, err := ms.k.GetDelegatorStake(ctx, senderAddr)
if err != nil {
return nil, err
}
beforeSum := cosmosMath.NewUint(0)
for _, stakeBefore := range msg.PlacementsRemove {
beforeSum = beforeSum.Add(stakeBefore.Amount)
targetAddr, err := sdk.AccAddressFromBech32(stakeBefore.Target)
if err != nil {
return nil, err
}
bond, err := ms.k.GetBond(ctx, senderAddr, targetAddr)
if err != nil {
return nil, err
}
if bond.LT(stakeBefore.Amount) {
return nil, state.ErrModifyStakeBeforeBondLessThanAmountModified
}
}
if senderTotalStake.LT(beforeSum) {
return nil, state.ErrModifyStakeBeforeSumGreaterThanSenderStake
}
// 4. For all stake afters, check that the target is a valid signed up participant
// 5. For all stake afters, check that the sum is equal to the sum of stake befores
afterSum := cosmosMath.NewUint(0)
for _, stakeAfter := range msg.PlacementsAdd {
targetAddr, err := sdk.AccAddressFromBech32(stakeAfter.Target)
if err != nil {
return nil, err
}
afterSum = afterSum.Add(stakeAfter.Amount)
err = checkNodeRegistered(ctx, ms, targetAddr)
if err != nil {
return nil, err
}
}
if !afterSum.Equal(beforeSum) {
return nil, state.ErrModifyStakeSumBeforeNotEqualToSumAfter
}
// Update the stake data structures
// 6. For all stake befores, remove the stake
// 7. For all stake afters, add the stake to the existing stake position
for _, stakeBefore := range msg.PlacementsRemove {
targetAddr, err := sdk.AccAddressFromBech32(stakeBefore.Target)
if err != nil {
return nil, err
}
err = ms.k.SubStakePlacement(ctx, senderAddr, targetAddr, stakeBefore.Amount)
if err != nil {
return nil, err
}
err = ms.k.SubStakePlacedUponTarget(ctx, targetAddr, stakeBefore.Amount)
if err != nil {
return nil, err
}
TopicIds, err := ms.k.GetRegisteredTopicIdsByAddress(ctx, targetAddr)
if err != nil {
return nil, err
}
err = ms.k.RemoveStakeFromTopics(ctx, TopicIds, stakeBefore.Amount)
if err != nil {
return nil, err
}
}
for _, stakeAfter := range msg.PlacementsAdd {
targetAddr, err := sdk.AccAddressFromBech32(stakeAfter.Target)
if err != nil {
return nil, err
}
err = ms.k.AddStakePlacement(ctx, senderAddr, targetAddr, stakeAfter.Amount)
if err != nil {
return nil, err
}
err = ms.k.AddStakePlacedUponTarget(ctx, targetAddr, stakeAfter.Amount)
if err != nil {
return nil, err
}
TopicIds, err := ms.k.GetRegisteredTopicIdsByAddress(ctx, targetAddr)
if err != nil {
return nil, err
}
err = ms.k.AddStakeToTopics(ctx, TopicIds, stakeAfter.Amount)
if err != nil {
return nil, err
}
}
return &state.MsgModifyStakeResponse{}, nil
}
// StartRemoveStake kicks off a stake removal process. Stake Removals are placed into a delayed queue.
// once the withdrawal delay has passed then ConfirmRemoveStake can be called to remove the stake.
// if a stake removal is not confirmed within a certain time period, the stake removal becomes invalid
// and one must start the stake removal process again and wait the delay again.
func (ms msgServer) StartRemoveStake(ctx context.Context, msg *state.MsgStartRemoveStake) (*state.MsgStartRemoveStakeResponse, error) {
sdkCtx := sdk.UnwrapSDKContext(ctx)
// 1. check the sender is registered
senderAddr, err := sdk.AccAddressFromBech32(msg.Sender)
if err != nil {
return nil, err
}
stakeRemoval := state.StakeRemoval{
TimestampRemovalStarted: uint64(sdkCtx.BlockTime().Unix()),
Placements: make([]*state.StakeRemovalPlacement, 0),
}
for _, stakePlacement := range msg.PlacementsRemove {
// 2. check the target exists and is registered
targetAddr, err := sdk.AccAddressFromBech32(stakePlacement.Target)
if err != nil {
return nil, err
}
// 3. check the sender has enough stake already placed on the target to remove the stake
stakePlaced, err := ms.k.GetBond(ctx, senderAddr, targetAddr)
if err != nil {
return nil, err
}
if stakePlaced.LT(stakePlacement.Amount) {
return nil, state.ErrInsufficientStakeToRemove
}
// 4. get topics ids where the target is registered
TopicIds, err := ms.k.GetRegisteredTopicIdsByAddress(ctx, targetAddr)
if err != nil {
return nil, err
}
// 6. If user is removing stake from themselves and he still registered in topics
// check that the stake is greater than the minimum required
requiredMinimumStake, err := ms.k.GetParamsRequiredMinimumStake(ctx)
if err != nil {
return nil, err
}
if senderAddr.String() == targetAddr.String() &&
stakePlaced.Sub(stakePlacement.Amount).LT(requiredMinimumStake) &&
len(TopicIds) > 0 {
return nil, state.ErrInsufficientStakeAfterRemoval
}
// 7. push to the stake removal object
stakeRemoval.Placements = append(stakeRemoval.Placements, &state.StakeRemovalPlacement{
TopicIds: TopicIds,
Target: stakePlacement.Target,
Amount: stakePlacement.Amount,
})
}
// 8. if no errors have occured and the removal is valid, add the stake removal to the delayed queue
err = ms.k.SetStakeRemovalQueueForDelegator(ctx, senderAddr, stakeRemoval)
if err != nil {
return nil, err
}
return &state.MsgStartRemoveStakeResponse{}, nil
}
// Function for reputers or workers to call to remove stake from an existing stake position.
func (ms msgServer) ConfirmRemoveStake(ctx context.Context, msg *state.MsgConfirmRemoveStake) (*state.MsgConfirmRemoveStakeResponse, error) {
sdkCtx := sdk.UnwrapSDKContext(ctx)
// pull the stake removal from the delayed queue
senderAddr, err := sdk.AccAddressFromBech32(msg.Sender)
if err != nil {
return nil, err
}
stakeRemoval, err := ms.k.GetStakeRemovalQueueForDelegator(ctx, senderAddr)
if err != nil {
if errors.Is(err, collections.ErrNotFound) {
return nil, state.ErrConfirmRemoveStakeNoRemovalStarted
}
return nil, err
}
// check the timestamp is valid
timeNow := uint64(sdkCtx.BlockTime().Unix())
if stakeRemoval.TimestampRemovalStarted > timeNow {
return nil, state.ErrConfirmRemoveStakeTooEarly
}
delayWindow, err := ms.k.GetParamsRemoveStakeDelayWindow(ctx)
if err != nil {
return nil, err
}
if stakeRemoval.TimestampRemovalStarted+delayWindow < timeNow {
return nil, state.ErrConfirmRemoveStakeTooLate
}
// skip checking all the data is valid
// the data should be valid because it was checked when the stake removal was started
// send the money
for _, stakePlacement := range stakeRemoval.Placements {
targetAddr, err := sdk.AccAddressFromBech32(stakePlacement.Target)
if err != nil {
return nil, err
}
// 5. check the module has enough funds to send back to the sender
// bank module does this for us in module SendCoins / subUnlockedCoins so we don't need to check
// 6. send the funds
amountInt := cosmosMath.NewIntFromBigInt(stakePlacement.Amount.BigInt())
coins := sdk.NewCoins(sdk.NewCoin(params.DefaultBondDenom, amountInt))
ms.k.bankKeeper.SendCoinsFromModuleToAccount(ctx, state.AlloraStakingAccountName, senderAddr, coins)
// 7. update the stake data structures
err = ms.k.RemoveStakeFromBond(ctx, stakePlacement.TopicIds, senderAddr, targetAddr, stakePlacement.Amount)
if err != nil {
return nil, err
}
}
return &state.MsgConfirmRemoveStakeResponse{}, nil
}
// StartRemoveAllStake kicks off a stake removal process. Stake Removals are placed into a delayed queue.
// once the withdrawal delay has passed then ConfirmRemoveStake can be called to remove the stake.
// if a stake removal is not confirmed within a certain time period, the stake removal becomes invalid
// and one must start the stake removal process again and wait the delay again.
// RemoveAllStake is just a convenience wrapper around StartRemoveStake.
func (ms msgServer) StartRemoveAllStake(ctx context.Context, msg *state.MsgStartRemoveAllStake) (*state.MsgStartRemoveAllStakeResponse, error) {
senderAddr, err := sdk.AccAddressFromBech32(msg.Sender)
if err != nil {
return nil, err
}
targets, amounts, err := ms.k.GetAllBondsForDelegator(ctx, senderAddr)
if err != nil {
return nil, err
}
msgRemoveStake := &state.MsgStartRemoveStake{
Sender: msg.Sender,
PlacementsRemove: make([]*state.StakePlacement, 0),
}
for i, target := range targets {
msgRemoveStake.PlacementsRemove = append(msgRemoveStake.PlacementsRemove, &state.StakePlacement{
Target: target.String(),
Amount: amounts[i],
})
}
_, err = ms.StartRemoveStake(ctx, msgRemoveStake)
if err != nil {
return nil, err
}
return &state.MsgStartRemoveAllStakeResponse{}, nil
}
func (ms msgServer) RequestInference(ctx context.Context, msg *state.MsgRequestInference) (*state.MsgRequestInferenceResponse, error) {
sdkCtx := sdk.UnwrapSDKContext(ctx)
for _, requestItem := range msg.Requests {
request := state.CreateNewInferenceRequestFromListItem(msg.Sender, requestItem)
// 1. check the topic is valid
topicExists, err := ms.k.TopicExists(ctx, request.TopicId)
if err != nil {
return nil, err
}
if !topicExists {
return nil, state.ErrInvalidTopicId
}
requestId, err := request.GetRequestId()
if err != nil {
return nil, err
}
// 2. check the request isn't already in the mempool
requestExists, err := ms.k.IsRequestInMempool(ctx, request.TopicId, requestId)
if err != nil {
return nil, err
}
if requestExists {
return nil, state.ErrInferenceRequestAlreadyInMempool
}
// 3. Check the BidAmount is greater than the price per request
if request.BidAmount.LT(request.MaxPricePerInference) {
return nil, state.ErrInferenceRequestBidAmountLessThanPrice
}
// 4. Check the timestamp valid until is in the future
timeNow := uint64(sdkCtx.BlockTime().Unix())
if request.TimestampValidUntil < timeNow {
return nil, state.ErrInferenceRequestTimestampValidUntilInPast
}
// 5. Check the timestamp validity is no more than the maximum allowed time in the future
maxInferenceRequestValidity, err := ms.k.GetParamsMaxInferenceRequestValidity(ctx)
if err != nil {
return nil, err
}
if request.TimestampValidUntil > timeNow+maxInferenceRequestValidity {
return nil, state.ErrInferenceRequestTimestampValidUntilTooFarInFuture
}
if request.Cadence != 0 {
// 6. Check the cadence is either 0, or greater than the minimum fastest cadence allowed
minFastestAllowedCadence, err := ms.k.GetParamsMinRequestCadence(ctx)
if err != nil {
return nil, err
}
if request.Cadence < minFastestAllowedCadence {
return nil, state.ErrInferenceRequestCadenceTooFast
}
// 7. Check the cadence is no more than the maximum allowed slowest cadence
maxSlowestAllowedCadence, err := ms.k.GetParamsMaxRequestCadence(ctx)
if err != nil {
return nil, err
}
if request.Cadence > maxSlowestAllowedCadence {
return nil, state.ErrInferenceRequestCadenceTooSlow
}
}
// 8. Check the cadence is not greater than the timestamp valid until
if timeNow+request.Cadence > request.TimestampValidUntil {
return nil, state.ErrInferenceRequestWillNeverBeScheduled
}
MinRequestUnmetDemand, err := ms.k.GetParamsMinRequestUnmetDemand(ctx)
if err != nil {
return nil, err
}
// Check that the request isn't spam by checking that the amount of funds it bids is greater than a global minimum demand per request
if request.BidAmount.LT(MinRequestUnmetDemand) {
return nil, state.ErrInferenceRequestBidAmountTooLow
}
// 9. Check sender has funds to pay for the inference request
// bank module does this for us in module SendCoins / subUnlockedCoins so we don't need to check
// 10. Send funds
senderAddr, err := sdk.AccAddressFromBech32(request.Sender)
if err != nil {
return nil, err
}
amountInt := cosmosMath.NewIntFromBigInt(request.BidAmount.BigInt())
coins := sdk.NewCoins(sdk.NewCoin(params.DefaultBondDenom, amountInt))
err = ms.k.bankKeeper.SendCoinsFromAccountToModule(ctx, senderAddr, state.AlloraRequestsAccountName, coins)
if err != nil {
return nil, err
}
// 11. record the number of tokens sent to the module account
err = ms.k.SetRequestDemand(ctx, requestId, request.BidAmount)
if err != nil {
return nil, err
}
// 12. Write request state into the mempool state
request.LastChecked = timeNow
err = ms.k.AddToMempool(ctx, *request)
if err != nil {
return nil, err
}
}
return &state.MsgRequestInferenceResponse{}, nil
}
// ########################################
// # Private Functions #
// ########################################
// Making common interfaces available to protobuf messages
func moveFundsAddStake(
ctx context.Context,
ms msgServer,
nodeAddr sdk.AccAddress,
msg *state.MsgRegister) error {
// move funds
initialStakeInt := cosmosMath.NewIntFromBigInt(msg.GetInitialStake().BigInt())
amount := sdk.NewCoins(sdk.NewCoin(params.DefaultBondDenom, initialStakeInt))
err := ms.k.bankKeeper.SendCoinsFromAccountToModule(ctx, nodeAddr, state.AlloraStakingAccountName, amount)
if err != nil {
return err
}
// for now we will force initial stake deposits to be placed upon oneself.
// add to total stake
// add to topic stake
// add to stakeOwnedByDelegator
// add to stakePlacement
// add to stakePlacedUponTarget
err = ms.k.AddStake(ctx, msg.GetTopicIds(), msg.GetCreator(), msg.GetCreator(), msg.GetInitialStake())
if err != nil {
return err
}
return nil
}
// checks if a node is registered in the system and if it is,
// returns whether said node is a reputer or a worker
func checkNodeRegistered(ctx context.Context, ms msgServer, node sdk.AccAddress) error {
reputerRegisteredTopicIds, err := ms.k.GetRegisteredTopicIdByReputerAddress(ctx, node)
if err != nil {
return err
}
if len(reputerRegisteredTopicIds) > 0 {
return nil
}
workerRegisteredTopicIds, err := ms.k.GetRegisteredTopicIdsByWorkerAddress(ctx, node)
if err != nil {
return err
}
if len(workerRegisteredTopicIds) > 0 {
return nil
}
return state.ErrAddressNotRegistered
}
func (ms msgServer) ReactivateTopic(ctx context.Context, msg *state.MsgReactivateTopic) (*state.MsgReactivateTopicResponse, error) {
// Check that the topic has enough demand to be reactivated
unmetDemand, err := ms.k.GetTopicUnmetDemand(ctx, msg.TopicId)
if err != nil {
return nil, err
}
minTopicUnmentDemand, err := ms.k.GetParamsMinTopicUnmetDemand(ctx)
if err != nil {
return nil, err
}
// If the topic does not have enough demand, return an error
if unmetDemand.LT(minTopicUnmentDemand) {
return nil, state.ErrTopicNotEnoughDemand
}
// If the topic has enough demand, reactivate it
err = ms.k.ReactivateTopic(ctx, msg.TopicId)
if err != nil {
return nil, err
}
return &state.MsgReactivateTopicResponse{Success: true}, nil
}
///
/// WHITELIST FUNCTIONS
///
func (ms msgServer) AddToWhitelistAdmin(ctx context.Context, msg *state.MsgAddToWhitelistAdmin) (*state.MsgAddToWhitelistAdminResponse, error) {
// Check that sender is also a whitelist admin
senderAddr, err := sdk.AccAddressFromBech32(msg.Sender)
if err != nil {
return nil, err
}
targetAddr, err := sdk.AccAddressFromBech32(msg.Address)
if err != nil {
return nil, err
}
isAdmin, err := ms.k.IsWhitelistAdmin(ctx, senderAddr)
if err != nil {
return nil, err
}
if !isAdmin {
return nil, state.ErrNotWhitelistAdmin
}
// Add the address to the whitelist
err = ms.k.AddWhitelistAdmin(ctx, targetAddr)
if err != nil {
return nil, err
}
return &state.MsgAddToWhitelistAdminResponse{}, nil
}
func (ms msgServer) RemoveFromWhitelistAdmin(ctx context.Context, msg *state.MsgRemoveFromWhitelistAdmin) (*state.MsgRemoveFromWhitelistAdminResponse, error) {
// Check that sender is also a whitelist admin
senderAddr, err := sdk.AccAddressFromBech32(msg.Sender)
if err != nil {
return nil, err
}
targetAddr, err := sdk.AccAddressFromBech32(msg.Address)
if err != nil {
return nil, err
}
isAdmin, err := ms.k.IsWhitelistAdmin(ctx, senderAddr)
if err != nil {
return nil, err
}
if !isAdmin {
return nil, state.ErrNotWhitelistAdmin
}
// Remove the address from the whitelist
err = ms.k.RemoveWhitelistAdmin(ctx, targetAddr)
if err != nil {
return nil, err
}
return &state.MsgRemoveFromWhitelistAdminResponse{}, nil
}
func (ms msgServer) AddToTopicCreationWhitelist(ctx context.Context, msg *state.MsgAddToTopicCreationWhitelist) (*state.MsgAddToTopicCreationWhitelistResponse, error) {
// Check that sender is also a whitelist admin
senderAddr, err := sdk.AccAddressFromBech32(msg.Sender)
if err != nil {
return nil, err
}
targetAddr, err := sdk.AccAddressFromBech32(msg.Address)
if err != nil {
return nil, err
}
isAdmin, err := ms.k.IsWhitelistAdmin(ctx, senderAddr)
if err != nil {
return nil, err
}
if !isAdmin {
return nil, state.ErrNotWhitelistAdmin
}
// Add the address to the whitelist
err = ms.k.AddToTopicCreationWhitelist(ctx, targetAddr)
if err != nil {
return nil, err
}
return &state.MsgAddToTopicCreationWhitelistResponse{}, nil