-
Notifications
You must be signed in to change notification settings - Fork 31
/
validation.go
318 lines (280 loc) · 9.84 KB
/
validation.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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
package types
import (
"encoding/hex"
"encoding/json"
"fmt"
"regexp"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
)
const (
// MaxNameLength length of the service name
MaxNameLength = 70
// MaxDescriptionLength length of the service and author description
MaxDescriptionLength = 280
// MaxTagsNum total number of the tags
MaxTagsNum = 10
// MaxTagLength length of the tag
MaxTagLength = 70
// MaxProvidersNum total number of the providers to request
MaxProvidersNum = 10
)
var (
// the service name only accepts alphanumeric characters, _ and -, beginning with alpha character
regexpServiceName = regexp.MustCompile(`^[a-zA-Z][a-zA-Z0-9_-]*$`)
regexpTag = regexp.MustCompile(`^[\S]{1,70}$`)
)
// ValidateAuthor verifies whether the parameters are legal
func ValidateAuthor(author string) error {
if _, err := sdk.AccAddressFromBech32(author); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "invalid author address (%s)", err)
}
return nil
}
// ValidateServiceName validates the service name
func ValidateServiceName(name string) error {
if !regexpServiceName.MatchString(name) || len(name) > MaxNameLength {
return sdkerrors.Wrap(ErrInvalidServiceName, name)
}
return nil
}
// ValidateTags verifies whether the given tags are legal
func ValidateTags(tags []string) error {
if len(tags) > MaxTagsNum {
return sdkerrors.Wrap(ErrInvalidTags, fmt.Sprintf("invalid tags size; got: %d, max: %d", len(tags), MaxTagsNum))
}
if HasDuplicate(tags) {
return sdkerrors.Wrap(ErrInvalidTags, "duplicate tag")
}
for i, tag := range tags {
if !regexpTag.MatchString(tag) {
return sdkerrors.Wrapf(ErrInvalidTags, "tag [%d] is invalid, must match regexp: %s", i, regexpTag.String())
}
}
return nil
}
// ValidateServiceDescription verifies whether the parameters are legal
func ValidateServiceDescription(svcDescription string) error {
if len(svcDescription) > MaxDescriptionLength {
return sdkerrors.Wrap(ErrInvalidDescription, fmt.Sprintf("invalid service description length; got: %d, max: %d", len(svcDescription), MaxDescriptionLength))
}
return nil
}
// ValidateAuthorDescription verifies whether the parameters are legal
func ValidateAuthorDescription(authorDescription string) error {
if len(authorDescription) > MaxDescriptionLength {
return sdkerrors.Wrap(ErrInvalidDescription, fmt.Sprintf("invalid author description length; got: %d, max: %d", len(authorDescription), MaxDescriptionLength))
}
return nil
}
// ValidateProvider verifies whether the parameters are legal
func ValidateProvider(provider string) error {
if _, err := sdk.AccAddressFromBech32(provider); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "invalid provider address (%s)", err)
}
return nil
}
// ValidateOwner verifies whether the parameters are legal
func ValidateOwner(owner string) error {
if _, err := sdk.AccAddressFromBech32(owner); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "invalid owner address (%s)", err)
}
return nil
}
// ValidateServiceDeposit verifies whether the parameters are legal
func ValidateServiceDeposit(deposit sdk.Coins) error {
if !deposit.IsValid() {
return sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, "invalid deposit")
}
if deposit.IsAnyNegative() {
return sdkerrors.Wrap(sdkerrors.ErrInvalidCoins, "invalid deposit")
}
return nil
}
func ValidatePricing(pricing string) error {
if err := ValidateBindingPricing(pricing); err != nil {
return err
}
parsedPricing, err := ParsePricing(pricing)
if err != nil {
return err
}
return CheckPricing(parsedPricing)
}
// ValidateQoS verifies whether the parameters are legal
func ValidateQoS(qos uint64) error {
if qos == 0 {
return sdkerrors.Wrap(ErrInvalidQoS, "qos must be greater than 0")
}
return nil
}
// ValidateOptions verifies whether the parameters are legal
func ValidateOptions(options string) error {
if !json.Valid([]byte(options)) {
return sdkerrors.Wrap(ErrInvalidOptions, "options is not valid JSON")
}
return nil
}
// ValidateWithdrawAddress verifies whether the parameters are legal
func ValidateWithdrawAddress(withdrawAddress string) error {
if _, err := sdk.AccAddressFromBech32(withdrawAddress); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "invalid withdrawal address (%s)", err)
}
return nil
}
// ______________________________________________________________________
// ValidateRequest validates the request params
func ValidateRequest(
serviceName string,
serviceFeeCap sdk.Coins,
providers []sdk.AccAddress,
input string,
timeout int64,
repeated bool,
repeatedFrequency uint64,
repeatedTotal int64,
) error {
if err := ValidateServiceName(serviceName); err != nil {
return err
}
if err := ValidateServiceFeeCap(serviceFeeCap); err != nil {
return err
}
if err := ValidateProviders(providers); err != nil {
return err
}
if err := ValidateInput(input); err != nil {
return err
}
if timeout <= 0 {
return sdkerrors.Wrapf(ErrInvalidTimeout, "timeout [%d] must be greater than 0", timeout)
}
if repeated {
if repeatedFrequency > 0 && repeatedFrequency < uint64(timeout) {
return sdkerrors.Wrapf(ErrInvalidRepeatedFreq, "repeated frequency [%d] must not be less than timeout [%d]", repeatedFrequency, timeout)
}
if repeatedTotal < -1 || repeatedTotal == 0 {
return sdkerrors.Wrapf(ErrInvalidRepeatedTotal, "repeated total number [%d] must be greater than 0 or equal to -1", repeatedTotal)
}
}
return nil
}
// ValidateRequestContextUpdating validates the request context updating operation
func ValidateRequestContextUpdating(
providers []sdk.AccAddress,
serviceFeeCap sdk.Coins,
timeout int64,
repeatedFrequency uint64,
repeatedTotal int64,
) error {
if err := ValidateProvidersCanEmpty(providers); err != nil {
return err
}
if !serviceFeeCap.Empty() {
if err := ValidateServiceFeeCap(serviceFeeCap); err != nil {
return err
}
}
if timeout < 0 {
return sdkerrors.Wrapf(ErrInvalidTimeout, "timeout must not be less than 0: %d", timeout)
}
if timeout != 0 && repeatedFrequency != 0 && repeatedFrequency < uint64(timeout) {
return sdkerrors.Wrapf(ErrInvalidRepeatedFreq, "frequency [%d] must not be less than timeout [%d]", repeatedFrequency, timeout)
}
if repeatedTotal < -1 {
return sdkerrors.Wrapf(ErrInvalidRepeatedFreq, "repeated total number must not be less than -1: %d", repeatedTotal)
}
return nil
}
// ValidateConsumer verifies whether the parameters are legal
func ValidateConsumer(consumer string) error {
if _, err := sdk.AccAddressFromBech32(consumer); err != nil {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidAddress, "invalid consumer address (%s)", err)
}
return nil
}
// ValidateProviders verifies whether the parameters are legal
func ValidateProviders(providers []sdk.AccAddress) error {
if len(providers) == 0 {
return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "providers missing")
}
if len(providers) > MaxProvidersNum {
return sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "total number of the providers must not be greater than %d", MaxProvidersNum)
}
if err := checkDuplicateProviders(providers); err != nil {
return err
}
return nil
}
// ValidateProvidersCanEmpty verifies whether the parameters are legal
func ValidateProvidersCanEmpty(providers []sdk.AccAddress) error {
if len(providers) > MaxProvidersNum {
return sdkerrors.Wrapf(ErrInvalidProviders, "total number of the providers must not be greater than %d", MaxProvidersNum)
}
if len(providers) > 0 {
if err := checkDuplicateProviders(providers); err != nil {
return err
}
}
return nil
}
// ValidateServiceFeeCap verifies whether the parameters are legal
func ValidateServiceFeeCap(serviceFeeCap sdk.Coins) error {
if !serviceFeeCap.IsValid() {
return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, fmt.Sprintf("invalid service fee cap: %s", serviceFeeCap))
}
return nil
}
// ValidateRequestID verifies whether the parameters are legal
func ValidateRequestID(reqID string) error {
if len(reqID) != RequestIDLen {
return sdkerrors.Wrapf(ErrInvalidRequestID, "length of the request ID must be %d", RequestIDLen)
}
if _, err := hex.DecodeString(reqID); err != nil {
return sdkerrors.Wrap(ErrInvalidRequestID, "request ID must be a hex encoded string")
}
return nil
}
// ValidateContextID verifies whether the parameters are legal
func ValidateContextID(contextID string) error {
if len(contextID) != ContextIDLen {
return sdkerrors.Wrapf(ErrInvalidRequestContextID, "length of the request context ID must be %d in bytes", ContextIDLen)
}
if _, err := hex.DecodeString(contextID); err != nil {
return sdkerrors.Wrap(ErrInvalidRequestContextID, "request context ID must be a hex encoded string")
}
return nil
}
// ValidateInput verifies whether the parameters are legal
func ValidateInput(input string) error {
if len(input) == 0 {
return sdkerrors.Wrap(ErrInvalidRequestInput, "input missing")
}
if ValidateRequestInput(input) != nil {
return sdkerrors.Wrap(ErrInvalidRequestInput, "invalid input")
}
return nil
}
// ValidateOutput verifies whether the parameters are legal
func ValidateOutput(code ResultCode, output string) error {
if code == ResultOK && len(output) == 0 {
return sdkerrors.Wrapf(ErrInvalidResponse, "output must be specified when the result code is %v", ResultOK)
}
if code != ResultOK && len(output) != 0 {
return sdkerrors.Wrapf(ErrInvalidResponse, "output should not be specified when the result code is not %v", ResultOK)
}
if len(output) > 0 && ValidateResponseOutput(output) != nil {
return sdkerrors.Wrap(ErrInvalidResponse, "invalid output")
}
return nil
}
func checkDuplicateProviders(providers []sdk.AccAddress) error {
providerArr := make([]string, len(providers))
for i, provider := range providers {
providerArr[i] = provider.String()
}
if HasDuplicate(providerArr) {
return sdkerrors.Wrap(ErrInvalidProviders, "there exists duplicate providers")
}
return nil
}