-
Notifications
You must be signed in to change notification settings - Fork 55
/
invariants.go
227 lines (213 loc) · 8.51 KB
/
invariants.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
package keeper
import (
"fmt"
"time"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/crescent-network/crescent/v2/x/farming/types"
)
// RegisterInvariants registers all farming invariants.
func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper) {
ir.RegisterRoute(types.ModuleName, "positive-staking-amount",
PositiveStakingAmountInvariant(k))
ir.RegisterRoute(types.ModuleName, "positive-queued-staking-amount",
PositiveQueuedStakingAmountInvariant(k))
ir.RegisterRoute(types.ModuleName, "staking-reserved-amount",
StakingReservedAmountInvariant(k))
ir.RegisterRoute(types.ModuleName, "remaining-rewards-amount",
RemainingRewardsAmountInvariant(k))
ir.RegisterRoute(types.ModuleName, "non-negative-outstanding-rewards",
NonNegativeOutstandingRewardsInvariant(k))
ir.RegisterRoute(types.ModuleName, "outstanding-rewards-amount",
OutstandingRewardsAmountInvariant(k))
ir.RegisterRoute(types.ModuleName, "unharvested-rewards-amount",
UnharvestedRewardsAmountInvariant(k))
ir.RegisterRoute(types.ModuleName, "non-negative-historical-rewards",
NonNegativeHistoricalRewardsInvariant(k))
ir.RegisterRoute(types.ModuleName, "positive-total-stakings-amount",
PositiveTotalStakingsAmountInvariant(k))
}
// AllInvariants runs all invariants of the farming module.
func AllInvariants(k Keeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
for _, inv := range []func(Keeper) sdk.Invariant{
PositiveStakingAmountInvariant,
StakingReservedAmountInvariant,
RemainingRewardsAmountInvariant,
NonNegativeOutstandingRewardsInvariant,
OutstandingRewardsAmountInvariant,
UnharvestedRewardsAmountInvariant,
NonNegativeHistoricalRewardsInvariant,
PositiveTotalStakingsAmountInvariant,
} {
res, stop := inv(k)(ctx)
if stop {
return res, stop
}
}
return "", false
}
}
// PositiveStakingAmountInvariant checks that the amount of staking coins is positive.
func PositiveStakingAmountInvariant(k Keeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
msg := ""
count := 0
k.IterateStakings(ctx, func(stakingCoinDenom string, farmerAcc sdk.AccAddress, staking types.Staking) (stop bool) {
if !staking.Amount.IsPositive() {
msg += fmt.Sprintf("\t%v has non-positive staking amount: %v\n",
farmerAcc, sdk.Coin{Denom: stakingCoinDenom, Amount: staking.Amount})
count++
}
return false
})
broken := count != 0
return sdk.FormatInvariant(
types.ModuleName, "positive staking amount",
fmt.Sprintf("found %d staking coins with non-positive amount\n%s", count, msg),
), broken
}
}
// PositiveQueuedStakingAmountInvariant checks that the amount of queued staking coins is positive.
func PositiveQueuedStakingAmountInvariant(k Keeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
msg := ""
count := 0
k.IterateQueuedStakings(ctx, func(_ time.Time, stakingCoinDenom string, farmerAcc sdk.AccAddress, queuedStaking types.QueuedStaking) (stop bool) {
if !queuedStaking.Amount.IsPositive() {
msg += fmt.Sprintf("\t%v has non-positive queued staking amount: %v\n",
farmerAcc, sdk.Coin{Denom: stakingCoinDenom, Amount: queuedStaking.Amount})
count++
}
return false
})
broken := count != 0
return sdk.FormatInvariant(
types.ModuleName, "positive queued staking amount",
fmt.Sprintf("found %d queued staking coins with non-positive amount\n%s", count, msg),
), broken
}
}
// StakingReservedAmountInvariant checks that the balance of StakingReserveAcc greater than the amount of staked, Queued coins in all staking objects.
func StakingReservedAmountInvariant(k Keeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
err := k.ValidateStakingReservedAmount(ctx)
broken := err != nil
return sdk.FormatInvariant(types.ModuleName, "staking reserved amount",
"the balance of StakingReserveAcc less than the amount of staked, queued coins in all staking objects",
), broken
}
}
// RemainingRewardsAmountInvariant checks that the balance of the RewardsReserveAcc of all plans greater than the total amount of unwithdrawn reward coins in all reward objects
func RemainingRewardsAmountInvariant(k Keeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
err := k.ValidateRemainingRewardsAmount(ctx)
broken := err != nil
return sdk.FormatInvariant(types.ModuleName, "remaining rewards amount",
"the balance of the RewardsReserveAcc of all plans less than the total amount of unwithdrawn reward coins in all reward objects",
), broken
}
}
// NonNegativeOutstandingRewardsInvariant checks that all OutstandingRewards are
// non-negative.
func NonNegativeOutstandingRewardsInvariant(k Keeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
msg := ""
count := 0
k.IterateOutstandingRewards(ctx, func(stakingCoinDenom string, rewards types.OutstandingRewards) (stop bool) {
if rewards.Rewards.IsAnyNegative() {
msg += fmt.Sprintf("\t%v has negative outstanding rewards: %v\n", stakingCoinDenom, rewards.Rewards)
count++
}
return false
})
broken := count != 0
return sdk.FormatInvariant(
types.ModuleName, "non-negative outstanding rewards",
fmt.Sprintf("found %d staking coin with negative outstanding rewards\n%s", count, msg),
), broken
}
}
// OutstandingRewardsAmountInvariant checks that OutstandingRewards are
// consistent with rewards that can be withdrawn.
func OutstandingRewardsAmountInvariant(k Keeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
totalRewards := sdk.DecCoins{}
k.IterateOutstandingRewards(ctx, func(stakingCoinDenom string, rewards types.OutstandingRewards) (stop bool) {
totalRewards = totalRewards.Add(rewards.Rewards...)
return false
})
balances := k.bankKeeper.SpendableCoins(ctx, types.RewardsReserveAcc)
_, hasNeg := sdk.NewDecCoinsFromCoins(balances...).SafeSub(totalRewards)
broken := hasNeg
return sdk.FormatInvariant(
types.ModuleName, "wrong outstanding rewards",
fmt.Sprintf("balance of rewards reserve pool is less than outstanding rewards\n"+
"\texpected minimum amount of balance: %s\n"+
"\tbalance: %s", totalRewards, balances,
),
), broken
}
}
// UnharvestedRewardsAmountInvariant checks that UnharvestedRewards are
// consistent with rewards that can be withdrawn.
func UnharvestedRewardsAmountInvariant(k Keeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
totalRewards := sdk.Coins{}
k.IterateAllUnharvestedRewards(ctx, func(_ sdk.AccAddress, _ string, rewards types.UnharvestedRewards) (stop bool) {
totalRewards = totalRewards.Add(rewards.Rewards...)
return false
})
balances := k.bankKeeper.SpendableCoins(ctx, types.UnharvestedRewardsReserveAcc)
_, hasNeg := balances.SafeSub(totalRewards)
broken := hasNeg
return sdk.FormatInvariant(
types.ModuleName, "wrong unharvested rewards amount",
fmt.Sprintf("balances of unharvested rewards reserve account is less than total unharvested rewards\n"+
"\texpected minimum balances: %s\n"+
"\tactual balances: %s", totalRewards, balances,
),
), broken
}
}
// NonNegativeHistoricalRewardsInvariant checks that all HistoricalRewards are
// non-negative.
func NonNegativeHistoricalRewardsInvariant(k Keeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
msg := ""
count := 0
k.IterateHistoricalRewards(ctx, func(stakingCoinDenom string, epoch uint64, rewards types.HistoricalRewards) (stop bool) {
if rewards.CumulativeUnitRewards.IsAnyNegative() {
msg += fmt.Sprintf("\t%v has negative historical rewards at epoch %d: %v\n",
stakingCoinDenom, epoch, rewards.CumulativeUnitRewards)
count++
}
return false
})
broken := count != 0
return sdk.FormatInvariant(
types.ModuleName, "non-negative historical rewards",
fmt.Sprintf("found %d staking coin with negative historical rewards\n%s", count, msg),
), broken
}
}
// PositiveTotalStakingsAmountInvariant checks that all TotalStakings
// have positive amount.
func PositiveTotalStakingsAmountInvariant(k Keeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
msg := ""
count := 0
k.IterateTotalStakings(ctx, func(stakingCoinDenom string, totalStakings types.TotalStakings) (stop bool) {
if !totalStakings.Amount.IsPositive() {
msg += fmt.Sprintf("\t%v has non-positive total staking amount: %v\n",
stakingCoinDenom, totalStakings.Amount)
count++
}
return false
})
broken := count != 0
return sdk.FormatInvariant(
types.ModuleName, "positive total stakings amount",
fmt.Sprintf("found %d total stakings with non-positive amount\n%s", count, msg),
), broken
}
}