-
Notifications
You must be signed in to change notification settings - Fork 558
/
params.go
244 lines (206 loc) · 8.19 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
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
package types
import (
"fmt"
"github.com/osmosis-labs/osmosis/osmomath"
appparams "github.com/osmosis-labs/osmosis/v19/app/params"
sdk "github.com/cosmos/cosmos-sdk/types"
paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
)
// Parameter store keys.
var (
KeyPoolCreationFee = []byte("PoolCreationFee")
KeyDefaultTakerFee = []byte("DefaultTakerFee")
KeyOsmoTakerFeeDistribution = []byte("OsmoTakerFeeDistribution")
KeyNonOsmoTakerFeeDistribution = []byte("NonOsmoTakerFeeDistribution")
KeyAdminAddresses = []byte("AdminAddresses")
KeyCommunityPoolDenomToSwapNonWhitelistedAssetsTo = []byte("CommunityPoolDenomToSwapNonWhitelistedAssetsTo")
KeyAuthorizedQuoteDenoms = []byte("AuthorizedQuoteDenoms")
)
// ParamTable for gamm module.
func ParamKeyTable() paramtypes.KeyTable {
return paramtypes.NewKeyTable().RegisterParamSet(&Params{})
}
func NewParams(poolCreationFee sdk.Coins,
defaultTakerFee osmomath.Dec,
osmoTakerFeeDistribution, nonOsmoTakerFeeDistribution TakerFeeDistributionPercentage,
adminAddresses, authorizedQuoteDenoms []string,
communityPoolDenomToSwapNonWhitelistedAssetsTo string) Params {
return Params{
PoolCreationFee: poolCreationFee,
TakerFeeParams: TakerFeeParams{
DefaultTakerFee: defaultTakerFee,
OsmoTakerFeeDistribution: osmoTakerFeeDistribution,
NonOsmoTakerFeeDistribution: nonOsmoTakerFeeDistribution,
AdminAddresses: adminAddresses,
CommunityPoolDenomToSwapNonWhitelistedAssetsTo: communityPoolDenomToSwapNonWhitelistedAssetsTo,
},
AuthorizedQuoteDenoms: authorizedQuoteDenoms,
}
}
// DefaultParams are the default poolmanager module parameters.
func DefaultParams() Params {
return Params{
PoolCreationFee: sdk.Coins{sdk.NewInt64Coin(appparams.BaseCoinUnit, 1000_000_000)}, // 1000 OSMO
TakerFeeParams: TakerFeeParams{
DefaultTakerFee: osmomath.ZeroDec(), // 0%
OsmoTakerFeeDistribution: TakerFeeDistributionPercentage{
StakingRewards: osmomath.MustNewDecFromStr("1"), // 100%
CommunityPool: osmomath.MustNewDecFromStr("0"), // 0%
},
NonOsmoTakerFeeDistribution: TakerFeeDistributionPercentage{
StakingRewards: osmomath.MustNewDecFromStr("0.67"), // 67%
CommunityPool: osmomath.MustNewDecFromStr("0.33"), // 33%
},
AdminAddresses: []string{},
CommunityPoolDenomToSwapNonWhitelistedAssetsTo: "ibc/D189335C6E4A68B513C10AB227BF1C1D38C746766278BA3EEB4FB14124F1D858", // USDC
},
AuthorizedQuoteDenoms: []string{
"uosmo",
"ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2", // ATOM
"ibc/0CD3A0285E1341859B5E86B6AB7682F023D03E97607CCC1DC95706411D866DF7", // DAI
"ibc/D189335C6E4A68B513C10AB227BF1C1D38C746766278BA3EEB4FB14124F1D858", // USDC
},
}
}
// validate params.
func (p Params) Validate() error {
if err := validatePoolCreationFee(p.PoolCreationFee); err != nil {
return err
}
if err := validateDefaultTakerFee(p.TakerFeeParams.DefaultTakerFee); err != nil {
return err
}
if err := validateTakerFeeDistribution(p.TakerFeeParams.OsmoTakerFeeDistribution); err != nil {
return err
}
if err := validateTakerFeeDistribution(p.TakerFeeParams.NonOsmoTakerFeeDistribution); err != nil {
return err
}
if err := validateAdminAddresses(p.TakerFeeParams.AdminAddresses); err != nil {
return err
}
if err := validateCommunityPoolDenomToSwapNonWhitelistedAssetsTo(p.TakerFeeParams.CommunityPoolDenomToSwapNonWhitelistedAssetsTo); err != nil {
return err
}
if err := validateAuthorizedQuoteDenoms(p.AuthorizedQuoteDenoms); err != nil {
return err
}
return nil
}
// Implements params.ParamSet.
func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs {
return paramtypes.ParamSetPairs{
paramtypes.NewParamSetPair(KeyPoolCreationFee, &p.PoolCreationFee, validatePoolCreationFee),
paramtypes.NewParamSetPair(KeyDefaultTakerFee, &p.TakerFeeParams.DefaultTakerFee, validateDefaultTakerFee),
paramtypes.NewParamSetPair(KeyOsmoTakerFeeDistribution, &p.TakerFeeParams.OsmoTakerFeeDistribution, validateTakerFeeDistribution),
paramtypes.NewParamSetPair(KeyNonOsmoTakerFeeDistribution, &p.TakerFeeParams.NonOsmoTakerFeeDistribution, validateTakerFeeDistribution),
paramtypes.NewParamSetPair(KeyAdminAddresses, &p.TakerFeeParams.AdminAddresses, validateAdminAddresses),
paramtypes.NewParamSetPair(KeyCommunityPoolDenomToSwapNonWhitelistedAssetsTo, &p.TakerFeeParams.CommunityPoolDenomToSwapNonWhitelistedAssetsTo, validateCommunityPoolDenomToSwapNonWhitelistedAssetsTo),
paramtypes.NewParamSetPair(KeyAuthorizedQuoteDenoms, &p.AuthorizedQuoteDenoms, validateAuthorizedQuoteDenoms),
}
}
func validatePoolCreationFee(i interface{}) error {
v, ok := i.(sdk.Coins)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if v.Validate() != nil {
return fmt.Errorf("invalid pool creation fee: %+v", i)
}
return nil
}
func validateDefaultTakerFee(i interface{}) error {
// Convert the given parameter to osmomath.Dec.
defaultTakerFee, ok := i.(osmomath.Dec)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
// Ensure that the passed in discount rate is between 0 and 1.
if defaultTakerFee.IsNegative() || defaultTakerFee.GT(osmomath.OneDec()) {
return fmt.Errorf("invalid default taker fee: %s", defaultTakerFee)
}
return nil
}
func validateTakerFeeDistribution(i interface{}) error {
// Convert the given parameter to osmomath.Dec.
takerFeeDistribution, ok := i.(TakerFeeDistributionPercentage)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if takerFeeDistribution.StakingRewards.IsNegative() || takerFeeDistribution.StakingRewards.GT(osmomath.OneDec()) {
return fmt.Errorf("invalid staking rewards distribution: %s", takerFeeDistribution.StakingRewards)
}
if takerFeeDistribution.CommunityPool.IsNegative() || takerFeeDistribution.CommunityPool.GT(osmomath.OneDec()) {
return fmt.Errorf("invalid community pool distribution: %s", takerFeeDistribution.CommunityPool)
}
return nil
}
func validateAdminAddresses(i interface{}) error {
adminAddresses, ok := i.([]string)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if len(adminAddresses) > 0 {
for _, adminAddress := range adminAddresses {
if _, err := sdk.AccAddressFromBech32(adminAddress); err != nil {
return fmt.Errorf("invalid account address: %s", adminAddress)
}
}
}
return nil
}
// validateAuthorizedQuoteDenoms validates a slice of authorized quote denoms.
//
// Parameters:
// - i: The parameter to validate.
//
// Returns:
// - An error if given type is not string slice.
// - An error if given slice is empty.
// - An error if any of the denoms are invalid.
func validateAuthorizedQuoteDenoms(i interface{}) error {
authorizedQuoteDenoms, ok := i.([]string)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if len(authorizedQuoteDenoms) == 0 {
return fmt.Errorf("authorized quote denoms cannot be empty")
}
for _, denom := range authorizedQuoteDenoms {
if err := sdk.ValidateDenom(denom); err != nil {
return err
}
}
return nil
}
func validateCommunityPoolDenomToSwapNonWhitelistedAssetsTo(i interface{}) error {
communityPoolDenomToSwapNonWhitelistedAssetsTo, ok := i.(string)
if !ok {
return fmt.Errorf("invalid parameter type: %T", i)
}
if err := sdk.ValidateDenom(communityPoolDenomToSwapNonWhitelistedAssetsTo); err != nil {
return err
}
return nil
}
func validateDenomPairTakerFees(pairs []DenomPairTakerFee) error {
if len(pairs) == 0 {
return fmt.Errorf("Empty denom pair taker fee")
}
for _, record := range pairs {
if record.Denom0 == record.Denom1 {
return fmt.Errorf("denom0 and denom1 must be different")
}
if sdk.ValidateDenom(record.Denom0) != nil {
return fmt.Errorf("denom0 is invalid: %s", sdk.ValidateDenom(record.Denom0))
}
if sdk.ValidateDenom(record.Denom1) != nil {
return fmt.Errorf("denom1 is invalid: %s", sdk.ValidateDenom(record.Denom1))
}
takerFee := record.TakerFee
if takerFee.IsNegative() || takerFee.GTE(osmomath.OneDec()) {
return fmt.Errorf("taker fee must be between 0 and 1: %s", takerFee.String())
}
}
return nil
}