-
Notifications
You must be signed in to change notification settings - Fork 45
/
models_params.go
267 lines (218 loc) · 6.89 KB
/
models_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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
package types
// DONTCOVER
import (
"fmt"
"strings"
"cosmossdk.io/math"
paramstypes "github.com/cosmos/cosmos-sdk/x/params/types"
sdk "github.com/cosmos/cosmos-sdk/types"
)
const (
// DefaultParamsSpace represents the default paramspace for the Params keeper
DefaultParamsSpace = "profiles"
)
// Default profile paramsModule
var (
DefaultMinNicknameLength = sdk.NewInt(2)
DefaultMaxNicknameLength = sdk.NewInt(1000) // Longest name on earth count 954 chars
DefaultRegEx = `^[A-Za-z0-9_]+$`
DefaultMinDTagLength = sdk.NewInt(3)
DefaultMaxDTagLength = sdk.NewInt(30)
DefaultMaxBioLength = sdk.NewInt(1000)
)
// Parameters store keys
var (
NicknameParamsKey = []byte("NicknameParams")
DTagParamsKey = []byte("DTagParams")
BioParamsKey = []byte("MaxBioLen")
OracleParamsKey = []byte("OracleParams")
)
// ___________________________________________________________________________________________________________________
// ParamKeyTable Key declaration for parameters
func ParamKeyTable() paramstypes.KeyTable {
return paramstypes.NewKeyTable().
RegisterParamSet(&Params{})
}
// NewParams creates a new ProfileParams obj
func NewParams(nickname NicknameParams, dTag DTagParams, bio BioParams, oracle OracleParams) Params {
return Params{
Nickname: nickname,
DTag: dTag,
Bio: bio,
Oracle: oracle,
}
}
// DefaultParams return default paramsModule
func DefaultParams() Params {
return Params{
Nickname: DefaultNicknameParams(),
DTag: DefaultDTagParams(),
Bio: DefaultBioParams(),
Oracle: DefaultOracleParams(),
}
}
// ParamSetPairs implements the ParamSet interface and returns the key/value pairs
// of profile module's parameters.
func (params *Params) ParamSetPairs() paramstypes.ParamSetPairs {
return paramstypes.ParamSetPairs{
paramstypes.NewParamSetPair(NicknameParamsKey, ¶ms.Nickname, ValidateNicknameParams),
paramstypes.NewParamSetPair(DTagParamsKey, ¶ms.DTag, ValidateDTagParams),
paramstypes.NewParamSetPair(BioParamsKey, ¶ms.Bio, ValidateBioParams),
paramstypes.NewParamSetPair(OracleParamsKey, ¶ms.Oracle, ValidateOracleParams),
}
}
// Validate perform basic checks on all parameters to ensure they are correct
func (params Params) Validate() error {
if err := ValidateNicknameParams(params.Nickname); err != nil {
return err
}
if err := ValidateDTagParams(params.DTag); err != nil {
return err
}
if err := ValidateBioParams(params.Bio); err != nil {
return err
}
if err := ValidateOracleParams(params.Oracle); err != nil {
return err
}
return nil
}
// ___________________________________________________________________________________________________________________
// NewNicknameParams creates a new NicknameParams obj
func NewNicknameParams(minLen, maxLen math.Int) NicknameParams {
return NicknameParams{
MinLength: minLen,
MaxLength: maxLen,
}
}
// DefaultNicknameParams return default nickname params
func DefaultNicknameParams() NicknameParams {
return NewNicknameParams(
DefaultMinNicknameLength,
DefaultMaxNicknameLength,
)
}
func ValidateNicknameParams(i interface{}) error {
params, areNicknameParams := i.(NicknameParams)
if !areNicknameParams {
return fmt.Errorf("invalid parameters type: %s", i)
}
minLength := params.MinLength
if minLength.IsNil() || minLength.LT(DefaultMinNicknameLength) {
return fmt.Errorf("invalid minimum nickname length param: %s", minLength)
}
// TODO make sense to cap this? I've done this thinking "what's the sense of having names higher that 1000 chars?"
maxLength := params.MaxLength
if maxLength.IsNil() || maxLength.IsNegative() || maxLength.GT(DefaultMaxNicknameLength) {
return fmt.Errorf("invalid max nickname length param: %s", maxLength)
}
return nil
}
// ___________________________________________________________________________________________________________________
// NewDTagParams creates a new DTagParams obj
func NewDTagParams(regEx string, minLen, maxLen math.Int) DTagParams {
return DTagParams{
RegEx: regEx,
MinLength: minLen,
MaxLength: maxLen,
}
}
// DefaultDTagParams return default paramsModule
func DefaultDTagParams() DTagParams {
return NewDTagParams(
DefaultRegEx,
DefaultMinDTagLength,
DefaultMaxDTagLength,
)
}
func ValidateDTagParams(i interface{}) error {
params, isDtagParams := i.(DTagParams)
if !isDtagParams {
return fmt.Errorf("invalid parameters type: %s", i)
}
if len(strings.TrimSpace(params.RegEx)) == 0 {
return fmt.Errorf("empty dTag regEx param")
}
if params.MinLength.IsNegative() || params.MinLength.LT(DefaultMinDTagLength) {
return fmt.Errorf("invalid minimum dTag length param: %s", params.MinLength)
}
if params.MaxLength.IsNegative() {
return fmt.Errorf("invalid max dTag length param: %s", params.MaxLength)
}
return nil
}
// ___________________________________________________________________________________________________________________
// NewBioParams creates a new BioParams obj
func NewBioParams(maxLength math.Int) BioParams {
return BioParams{
MaxLength: maxLength,
}
}
// DefaultBioParams returns default params module
func DefaultBioParams() BioParams {
return NewBioParams(DefaultMaxBioLength)
}
func ValidateBioParams(i interface{}) error {
bioParams, isBioParams := i.(BioParams)
if !isBioParams {
return fmt.Errorf("invalid parameters type: %s", i)
}
if bioParams.MaxLength.IsNegative() {
return fmt.Errorf("invalid max bio length param: %s", bioParams.MaxLength)
}
return nil
}
// ___________________________________________________________________________________________________________________
// NewOracleParams creates a new Oracle Params instance
func NewOracleParams(
scriptID uint64,
askCount,
minCount,
prepareGas,
executeGas uint64,
feeAmount ...sdk.Coin,
) OracleParams {
return OracleParams{
ScriptID: scriptID,
AskCount: askCount,
MinCount: minCount,
PrepareGas: prepareGas,
ExecuteGas: executeGas,
FeeAmount: feeAmount,
}
}
// DefaultOracleParams returns the default instance of OracleParams
func DefaultOracleParams() OracleParams {
return NewOracleParams(
0,
1,
1,
50_000,
200_000,
sdk.NewCoin("band", sdk.NewInt(10)),
)
}
// ValidateOracleParams returns an error if interface does not represent a valid OracleParams instance
func ValidateOracleParams(i interface{}) error {
params, isOracleParams := i.(OracleParams)
if !isOracleParams {
return fmt.Errorf("invalid parameters type: %s", i)
}
if params.AskCount < params.MinCount {
return fmt.Errorf("invalid ask count: %d, min count: %d", params.AskCount, params.MinCount)
}
if params.MinCount <= 0 {
return fmt.Errorf("invalid min count: %d", params.MinCount)
}
if params.PrepareGas <= 0 {
return fmt.Errorf("invalid prepare gas: %d", params.PrepareGas)
}
if params.ExecuteGas <= 0 {
return fmt.Errorf("invalid execute gas: %d", params.ExecuteGas)
}
err := params.FeeAmount.Validate()
if err != nil {
return err
}
return nil
}