/
params.go
206 lines (179 loc) · 7.31 KB
/
params.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
package types
import (
"fmt"
"time"
sdk "github.com/cosmos/cosmos-sdk/types"
paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
"github.com/shentufoundation/shentu/v2/common"
)
// default parameter values
var (
// default values for Shield pool's parameters
DefaultProtectionPeriod = time.Hour * 24 * 21 // 21 days
DefaultShieldFeesRate = sdk.NewDecWithPrec(769, 5) // 0.769%
DefaultWithdrawPeriod = time.Hour * 24 * 21 // 21 days
DefaultPoolShieldLimit = sdk.NewDecWithPrec(50, 2) // 50%
DefaultMinShieldPurchase = sdk.NewCoins(sdk.NewCoin(common.MicroCTKDenom, sdk.NewInt(50000000))) // 50 CTK
// default values for Shield claim proposal's parameters
DefaultClaimPeriod = time.Hour * 24 * 21 // 21 days
DefaultPayoutPeriod = time.Hour * 24 * 56 // 56 days
DefaultMinClaimProposalDeposit = sdk.NewCoins(sdk.NewCoin(common.MicroCTKDenom, sdk.NewInt(100000000))) // 100 CTK
DefaultClaimProposalDepositRate = sdk.NewDecWithPrec(10, 2) // 10%
DefaultClaimProposalFeesRate = sdk.NewDecWithPrec(1, 2) // 1%
// default distribution parameters
DefaultA = sdk.NewDecWithPrec(10, 2) // 0.1
DefaultB = sdk.NewDecWithPrec(30, 2) // 0.3
DefaultL = sdk.NewDecWithPrec(1, 0) // 1
// default value for staking-shield rate parameter
DefaultStakingShieldRate = sdk.NewDec(2)
)
// parameter keys
var (
ParamStoreKeyPoolParams = []byte("shieldpoolparams")
ParamStoreKeyClaimProposalParams = []byte("claimproposalparams")
ParamStoreKeyStakingShieldRate = []byte("stakingshieldrateparams")
ParamStoreKeyDistribution = []byte("distributionparams")
)
// ParamKeyTable is the key declaration for parameters.
func ParamKeyTable() paramtypes.KeyTable {
return paramtypes.NewKeyTable(
paramtypes.NewParamSetPair(ParamStoreKeyPoolParams, PoolParams{}, validatePoolParams),
paramtypes.NewParamSetPair(ParamStoreKeyClaimProposalParams, ClaimProposalParams{}, validateClaimProposalParams),
paramtypes.NewParamSetPair(ParamStoreKeyStakingShieldRate, sdk.Dec{}, validateStakingShieldRateParams),
paramtypes.NewParamSetPair(ParamStoreKeyDistribution, DistributionParams{}, validateDistributionParams),
)
}
// NewPoolParams creates a new PoolParams object.
func NewPoolParams(protectionPeriod, withdrawPeriod time.Duration, shieldFeesRate sdk.Dec, poolShieldLimit sdk.Dec, minShieldPurchase sdk.Coins) PoolParams {
return PoolParams{
ProtectionPeriod: protectionPeriod,
ShieldFeesRate: shieldFeesRate,
WithdrawPeriod: withdrawPeriod,
PoolShieldLimit: poolShieldLimit,
MinShieldPurchase: minShieldPurchase,
}
}
// DefaultPoolParams returns a default PoolParams instance.
func DefaultPoolParams() PoolParams {
return NewPoolParams(DefaultProtectionPeriod, DefaultWithdrawPeriod, DefaultShieldFeesRate, DefaultPoolShieldLimit, DefaultMinShieldPurchase)
}
func validatePoolParams(i interface{}) error {
v, ok := i.(PoolParams)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
protectionPeriod := v.ProtectionPeriod
shieldFeesRate := v.ShieldFeesRate
withdrawPeriod := v.WithdrawPeriod
poolShieldLimit := v.PoolShieldLimit
minShieldPurchase := v.MinShieldPurchase
if protectionPeriod <= 0 {
return fmt.Errorf("protection period must be positive: %s", protectionPeriod)
}
if shieldFeesRate.IsNegative() || shieldFeesRate.GT(sdk.OneDec()) {
return fmt.Errorf("shield fees rate should be positive and less or equal to one but is %s", shieldFeesRate)
}
if withdrawPeriod <= 0 {
return fmt.Errorf("withdraw period must be positive: %s", withdrawPeriod)
}
if poolShieldLimit.IsNegative() || poolShieldLimit.GT(sdk.OneDec()) {
return fmt.Errorf("pool shield limit should be positive and less or equal to one but is %s", poolShieldLimit)
}
if !minShieldPurchase.IsValid() {
return fmt.Errorf("minimum shield purchase must be a valid sdk.Coins, is %s", minShieldPurchase.String())
}
return nil
}
// NewClaimProposalParams creates a new ClaimProposalParams instance.
func NewClaimProposalParams(claimPeriod, payoutPeriod time.Duration, minDeposit sdk.Coins, depositRate, feesRate sdk.Dec) ClaimProposalParams {
return ClaimProposalParams{
ClaimPeriod: claimPeriod,
PayoutPeriod: payoutPeriod,
MinDeposit: minDeposit,
DepositRate: depositRate,
FeesRate: feesRate,
}
}
// DefaultClaimProposalParams returns a default ClaimProposalParams instance.
func DefaultClaimProposalParams() ClaimProposalParams {
return NewClaimProposalParams(DefaultClaimPeriod, DefaultPayoutPeriod,
DefaultMinClaimProposalDeposit, DefaultClaimProposalDepositRate, DefaultClaimProposalFeesRate)
}
func validateClaimProposalParams(i interface{}) error {
v, ok := i.(ClaimProposalParams)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
claimPeriod := v.ClaimPeriod
payoutPeriod := v.PayoutPeriod
minDeposit := v.MinDeposit
depositRate := v.DepositRate
feesRate := v.FeesRate
if claimPeriod <= 0 {
return fmt.Errorf("claim period must be positive: %s", claimPeriod)
}
if payoutPeriod <= 0 {
return fmt.Errorf("payout period must be positive: %s", payoutPeriod)
}
if !minDeposit.IsValid() {
return fmt.Errorf("minimum deposit amount must be a valid sdk.Coins amount, is %s",
minDeposit.String())
}
if depositRate.IsNegative() || depositRate.GT(sdk.OneDec()) {
return fmt.Errorf("deposit rate should be positive and less or equal to one but is %s",
depositRate.String())
}
if feesRate.IsNegative() || feesRate.GT(sdk.OneDec()) {
return fmt.Errorf("fees rate should be positive and less or equal to one but is %s",
feesRate.String())
}
return nil
}
// DefaultStakingShieldRateParams returns a default DefaultStakingShieldRateParams.
func DefaultStakingShieldRateParams() sdk.Dec {
return sdk.NewDec(2)
}
// NewDistributionParams creates a new DistributionParams instance.
func NewDistributionParams(a, b, l sdk.Dec) DistributionParams {
return DistributionParams{
ModelParamA: a,
ModelParamB: b,
MaxLeverage: l,
}
}
// DefaultDistributionParams returns a default DistributionParams instance.
func DefaultDistributionParams() DistributionParams {
return NewDistributionParams(DefaultA, DefaultB, DefaultL)
}
func validateDistributionParams(i interface{}) error {
v, ok := i.(DistributionParams)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
a := v.ModelParamA
b := v.ModelParamB
L := v.MaxLeverage
if a.LT(sdk.ZeroDec()) || a.GT(sdk.OneDec()) {
return fmt.Errorf("invalid value for a: %s", a.String())
}
if b.LT(sdk.ZeroDec()) || b.GT(sdk.OneDec()) {
return fmt.Errorf("invalid value for b: %s", b.String())
}
if L.LT(sdk.ZeroDec()) || L.GT(sdk.OneDec()) {
return fmt.Errorf("invalid value for L: %s", L.String())
}
if a.GT(b) {
return fmt.Errorf("a (%s) can't be bigger than b (%s)", a, b)
}
return nil
}
func validateStakingShieldRateParams(i interface{}) error {
v, ok := i.(sdk.Dec)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if v.LTE(sdk.ZeroDec()) {
return fmt.Errorf("staking shield rate should be greater than 0")
}
return nil
}