-
Notifications
You must be signed in to change notification settings - Fork 55
/
liquidstaking.go
212 lines (181 loc) · 6.8 KB
/
liquidstaking.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
package types
import (
"github.com/cosmos/cosmos-sdk/codec"
sdk "github.com/cosmos/cosmos-sdk/types"
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
)
type WhitelistedValsMap map[string]WhitelistedValidator
func (whitelistedValsMap WhitelistedValsMap) IsListed(operatorAddr string) bool {
if _, ok := whitelistedValsMap[operatorAddr]; ok {
return true
} else {
return false
}
}
func GetWhitelistedValsMap(whitelistedValidators []WhitelistedValidator) WhitelistedValsMap {
whitelistedValsMap := make(WhitelistedValsMap)
for _, wv := range whitelistedValidators {
whitelistedValsMap[wv.ValidatorAddress] = wv
}
return whitelistedValsMap
}
// Validate validates LiquidValidator.
func (v LiquidValidator) Validate() error {
_, valErr := sdk.ValAddressFromBech32(v.OperatorAddress)
if valErr != nil {
return valErr
}
return nil
}
func (v LiquidValidator) GetOperator() sdk.ValAddress {
if v.OperatorAddress == "" {
return nil
}
addr, err := sdk.ValAddressFromBech32(v.OperatorAddress)
if err != nil {
panic(err)
}
return addr
}
func (v LiquidValidator) GetDelShares(ctx sdk.Context, sk StakingKeeper) sdk.Dec {
del, found := sk.GetDelegation(ctx, LiquidStakingProxyAcc, v.GetOperator())
if !found {
return sdk.ZeroDec()
}
return del.GetShares()
}
func (v LiquidValidator) GetLiquidTokens(ctx sdk.Context, sk StakingKeeper, onlyBonded bool) sdk.Int {
delShares := v.GetDelShares(ctx, sk)
if !delShares.IsPositive() {
return sdk.ZeroInt()
}
val := sk.Validator(ctx, v.GetOperator())
if onlyBonded && !val.IsBonded() {
return sdk.ZeroInt()
}
return val.TokensFromSharesTruncated(delShares).TruncateInt()
}
func (v LiquidValidator) GetWeight(whitelistedValsMap WhitelistedValsMap, active bool) sdk.Int {
if wv, ok := whitelistedValsMap[v.OperatorAddress]; ok && active {
return wv.TargetWeight
} else {
return sdk.ZeroInt()
}
}
func (v LiquidValidator) GetStatus(activeCondition bool) ValidatorStatus {
if activeCondition {
return ValidatorStatusActive
} else {
return ValidatorStatusInactive
}
}
// ActiveCondition checks the liquid validator could be active by below cases
//- included on whitelist
//- existed valid validator on staking module ( existed, not nil del shares and tokens, valid exchange rate)
//- not tombstoned
func ActiveCondition(validator stakingtypes.Validator, whitelisted bool, tombstoned bool) bool {
return whitelisted &&
!tombstoned &&
// !Unspecified ==> Bonded, Unbonding, Unbonded
validator.GetStatus() != stakingtypes.Unspecified &&
!validator.GetTokens().IsNil() &&
!validator.GetDelegatorShares().IsNil() &&
!validator.InvalidExRate()
}
// LiquidValidators is a collection of LiquidValidator
type LiquidValidators []LiquidValidator
type ActiveLiquidValidators LiquidValidators
// MinMaxGap Return the list of LiquidValidator with the maximum gap and minimum gap from the target weight of LiquidValidators, respectively.
func (vs LiquidValidators) MinMaxGap(targetMap, liquidTokenMap map[string]sdk.Int) (minGapVal LiquidValidator, maxGapVal LiquidValidator, amountNeeded sdk.Int, lastRedelegation bool) {
maxGap := sdk.ZeroInt()
minGap := sdk.ZeroInt()
for _, val := range vs {
gap := liquidTokenMap[val.OperatorAddress].Sub(targetMap[val.OperatorAddress])
if gap.GT(maxGap) {
maxGap = gap
maxGapVal = val
}
if gap.LT(minGap) {
minGap = gap
minGapVal = val
}
}
amountNeeded = sdk.MinInt(maxGap, minGap.Abs())
// lastRedelegation when maxGap validator's liquid token == amountNeeded for redelegation all delShares
lastRedelegation = amountNeeded.IsPositive() &&
!targetMap[maxGapVal.OperatorAddress].IsPositive() &&
liquidTokenMap[maxGapVal.OperatorAddress].Equal(amountNeeded)
return minGapVal, maxGapVal, amountNeeded, lastRedelegation
}
func (vs LiquidValidators) Len() int {
return len(vs)
}
func (vs LiquidValidators) TotalLiquidTokens(ctx sdk.Context, sk StakingKeeper, onlyBonded bool) (sdk.Int, map[string]sdk.Int) {
totalLiquidTokens := sdk.ZeroInt()
liquidTokenMap := map[string]sdk.Int{}
for _, lv := range vs {
liquidTokens := lv.GetLiquidTokens(ctx, sk, onlyBonded)
liquidTokenMap[lv.OperatorAddress] = liquidTokens
totalLiquidTokens = totalLiquidTokens.Add(liquidTokens)
}
return totalLiquidTokens, liquidTokenMap
}
func (vs LiquidValidators) Map() map[string]struct{} {
valsMap := map[string]struct{}{}
for _, val := range vs {
valsMap[val.OperatorAddress] = struct{}{}
}
return valsMap
}
func (avs ActiveLiquidValidators) Len() int {
return LiquidValidators(avs).Len()
}
func (avs ActiveLiquidValidators) TotalActiveLiquidTokens(ctx sdk.Context, sk StakingKeeper, onlyBonded bool) (sdk.Int, map[string]sdk.Int) {
return LiquidValidators(avs).TotalLiquidTokens(ctx, sk, onlyBonded)
}
// TotalWeight for active liquid validator
func (avs ActiveLiquidValidators) TotalWeight(whitelistedValsMap WhitelistedValsMap) sdk.Int {
totalWeight := sdk.ZeroInt()
for _, val := range avs {
totalWeight = totalWeight.Add(val.GetWeight(whitelistedValsMap, true))
}
return totalWeight
}
// NativeTokenToBToken returns bTokenTotalSupply * nativeTokenAmount / netAmount
func NativeTokenToBToken(nativeTokenAmount, bTokenTotalSupplyAmount sdk.Int, netAmount sdk.Dec) (bTokenAmount sdk.Int) {
return bTokenTotalSupplyAmount.ToDec().MulTruncate(nativeTokenAmount.ToDec()).QuoTruncate(netAmount.TruncateDec()).TruncateInt()
}
// BTokenToNativeToken returns bTokenAmount * netAmount / bTokenTotalSupply with truncations
func BTokenToNativeToken(bTokenAmount, bTokenTotalSupplyAmount sdk.Int, netAmount sdk.Dec) (nativeTokenAmount sdk.Dec) {
return bTokenAmount.ToDec().MulTruncate(netAmount).Quo(bTokenTotalSupplyAmount.ToDec()).TruncateDec()
}
// DeductFeeRate returns Input * (1-FeeRate) with truncations
func DeductFeeRate(input sdk.Dec, feeRate sdk.Dec) (feeDeductedOutput sdk.Dec) {
return input.MulTruncate(sdk.OneDec().Sub(feeRate)).TruncateDec()
}
func (nas NetAmountState) CalcNetAmount() sdk.Dec {
return nas.ProxyAccBalance.Add(nas.TotalLiquidTokens).Add(nas.TotalUnbondingBalance).ToDec().Add(nas.TotalRemainingRewards)
}
func (nas NetAmountState) CalcMintRate() sdk.Dec {
if nas.NetAmount.IsNil() || !nas.NetAmount.IsPositive() {
return sdk.ZeroDec()
}
return nas.BtokenTotalSupply.ToDec().QuoTruncate(nas.NetAmount)
}
type LiquidValidatorStates []LiquidValidatorState
func MustMarshalLiquidValidator(cdc codec.BinaryCodec, val *LiquidValidator) []byte {
return cdc.MustMarshal(val)
}
// must unmarshal a liquid validator from a store value
func MustUnmarshalLiquidValidator(cdc codec.BinaryCodec, value []byte) LiquidValidator {
validator, err := UnmarshalLiquidValidator(cdc, value)
if err != nil {
panic(err)
}
return validator
}
// unmarshal a liquid validator from a store value
func UnmarshalLiquidValidator(cdc codec.BinaryCodec, value []byte) (val LiquidValidator, err error) {
err = cdc.Unmarshal(value, &val)
return val, err
}