-
Notifications
You must be signed in to change notification settings - Fork 46
/
params.go
215 lines (177 loc) · 5.88 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
package types
import (
"fmt"
"strings"
sdk "github.com/cosmos/cosmos-sdk/types"
paramsModule "github.com/cosmos/cosmos-sdk/x/params/subspace"
)
const (
// default paramspace for paramsModule keeper
DefaultParamspace = ModuleName
)
// Default profile paramsModule
var (
DefaultMinMonikerLength = sdk.NewInt(2)
DefaultMaxMonikerLength = 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 (
MonikerLenParamsKey = []byte("MonikerParams")
DtagLenParamsKey = []byte("DtagParams")
MaxBioLenParamsKey = []byte("MaxBioLen")
)
// ParamKeyTable Key declaration for parameters
func ParamKeyTable() paramsModule.KeyTable {
return paramsModule.NewKeyTable().RegisterParamSet(&Params{})
}
type Params struct {
MonikerParams MonikerParams `json:"moniker_params" yaml:"moniker_params"`
DtagParams DtagParams `json:"dtag_params" yaml:"dtag_params"`
MaxBioLen sdk.Int `json:"max_bio_length" yaml:"max_bio_length"`
}
// NewParams creates a new ProfileParams obj
func NewParams(monikerLen MonikerParams, dtagLen DtagParams, maxBioLen sdk.Int) Params {
return Params{
MonikerParams: monikerLen,
DtagParams: dtagLen,
MaxBioLen: maxBioLen,
}
}
// DefaultParams return default paramsModule
func DefaultParams() Params {
return Params{
MonikerParams: DefaultMonikerParams(),
DtagParams: DefaultDtagParams(),
MaxBioLen: DefaultMaxBioLength,
}
}
func (params Params) String() string {
out := "Profiles parameters:\n"
out += fmt.Sprintf("%s\n%s\nBiography params lengths:\nMax accepted length: %s\n",
params.MonikerParams.String(),
params.DtagParams.String(),
params.MaxBioLen,
)
return strings.TrimSpace(out)
}
// ParamSetPairs implements the ParamSet interface and returns the key/value pairs
// of profile module's parameters.
func (params *Params) ParamSetPairs() paramsModule.ParamSetPairs {
return paramsModule.ParamSetPairs{
paramsModule.NewParamSetPair(MonikerLenParamsKey, ¶ms.MonikerParams, ValidateMonikerParams),
paramsModule.NewParamSetPair(DtagLenParamsKey, ¶ms.DtagParams, ValidateDtagParams),
paramsModule.NewParamSetPair(MaxBioLenParamsKey, ¶ms.MaxBioLen, ValidateBioParams),
}
}
// Validate perform basic checks on all parameters to ensure they are correct
func (params Params) Validate() error {
if err := ValidateMonikerParams(params.MonikerParams); err != nil {
return err
}
if err := ValidateDtagParams(params.DtagParams); err != nil {
return err
}
return ValidateBioParams(params.MaxBioLen)
}
// MonikerParams defines the paramsModule around moniker len
type MonikerParams struct {
MinMonikerLen sdk.Int `json:"min_length" yaml:"min_length"`
MaxMonikerLen sdk.Int `json:"max_length" yaml:"max_length"`
}
// NewMonikerParams creates a new MonikerParams obj
func NewMonikerParams(minLen, maxLen sdk.Int) MonikerParams {
return MonikerParams{
MinMonikerLen: minLen,
MaxMonikerLen: maxLen,
}
}
// DefaultMonikerParams return default moniker params
func DefaultMonikerParams() MonikerParams {
return NewMonikerParams(DefaultMinMonikerLength,
DefaultMaxMonikerLength)
}
// String implements stringer interface
func (params MonikerParams) String() string {
out := "Moniker params lengths:\n"
out += fmt.Sprintf("Min accepted length: %s\nMax accepted length: %s",
params.MinMonikerLen,
params.MaxMonikerLen,
)
return strings.TrimSpace(out)
}
func ValidateMonikerParams(i interface{}) error {
params, isNameSurnParams := i.(MonikerParams)
if !isNameSurnParams {
return fmt.Errorf("invalid parameters type: %s", i)
}
if params.MinMonikerLen.IsNegative() || params.MinMonikerLen.LT(DefaultMinMonikerLength) {
return fmt.Errorf("invalid minimum moniker length param: %s", params.MinMonikerLen)
}
// TODO make sense to cap this? I've done this thinking "what's the sense of having names higher that 1000 chars?"
if params.MaxMonikerLen.IsNegative() || params.MaxMonikerLen.GT(DefaultMaxMonikerLength) {
return fmt.Errorf("invalid max moniker length param: %s", params.MaxMonikerLen)
}
return nil
}
// DtagParams defines the paramsModule around profiles' dtag
type DtagParams struct {
RegEx string `json:"reg_ex" yaml:"reg_ex"`
MinDtagLen sdk.Int `json:"min_length" yaml:"min_length"`
MaxDtagLen sdk.Int `json:"max_length" yaml:"max_length"`
}
// NewDtagParams creates a new DtagParams obj
func NewDtagParams(regEx string, minLen, maxLen sdk.Int) DtagParams {
return DtagParams{
RegEx: regEx,
MinDtagLen: minLen,
MaxDtagLen: maxLen,
}
}
// DefaultDtagParams return default paramsModule
func DefaultDtagParams() DtagParams {
return NewDtagParams(
DefaultRegEx,
DefaultMinDTagLength,
DefaultMaxDTagLength,
)
}
// String implements stringer interface
func (params DtagParams) String() string {
out := "Dtag params:\n"
out += fmt.Sprintf("RegEx: %s\nMin accepted length: %s\nMax accepted length: %s",
params.RegEx,
params.MinDtagLen,
params.MaxDtagLen,
)
return strings.TrimSpace(out)
}
func ValidateDtagParams(i interface{}) error {
params, isMonikerParams := i.(DtagParams)
if !isMonikerParams {
return fmt.Errorf("invalid parameters type: %s", i)
}
if len(strings.TrimSpace(params.RegEx)) == 0 {
return fmt.Errorf("empty dTag regEx param")
}
if params.MinDtagLen.IsNegative() || params.MinDtagLen.LT(DefaultMinDTagLength) {
return fmt.Errorf("invalid minimum dTag length param: %s", params.MinDtagLen)
}
if params.MaxDtagLen.IsNegative() {
return fmt.Errorf("invalid max dTag length param: %s", params.MaxDtagLen)
}
return nil
}
func ValidateBioParams(i interface{}) error {
bioLen, isBioLenParams := i.(sdk.Int)
if !isBioLenParams {
return fmt.Errorf("invalid parameters type: %s", i)
}
if bioLen.IsNegative() {
return fmt.Errorf("invalid max bio length param: %s", bioLen)
}
return nil
}