/
validators.go
377 lines (340 loc) · 12.4 KB
/
validators.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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
package services
import (
"encoding/json"
"fmt"
"net/url"
"strings"
"time"
"github.com/jinzhu/gorm"
"github.com/smartcontractkit/chainlink/core/adapters"
"github.com/smartcontractkit/chainlink/core/assets"
"github.com/smartcontractkit/chainlink/core/store"
"github.com/smartcontractkit/chainlink/core/store/models"
"github.com/smartcontractkit/chainlink/core/store/orm"
"github.com/smartcontractkit/chainlink/core/utils"
"github.com/asaskevich/govalidator"
"github.com/ethereum/go-ethereum/common/hexutil"
"github.com/pkg/errors"
"github.com/tidwall/gjson"
)
// ValidateJob checks the job and its associated Initiators and Tasks for any
// application logic errors.
func ValidateJob(j models.JobSpec, store *store.Store) error {
fe := models.NewJSONAPIErrors()
if j.StartAt.Valid && j.EndAt.Valid && j.StartAt.Time.After(j.EndAt.Time) {
fe.Add("StartAt cannot be before EndAt")
}
if len(j.Initiators) < 1 || len(j.Tasks) < 1 {
fe.Add("Must have at least one Initiator and one Task")
}
for _, i := range j.Initiators {
if err := ValidateInitiator(i, j, store); err != nil {
fe.Merge(err)
}
}
for _, task := range j.Tasks {
if err := validateTask(task, store); err != nil {
fe.Merge(err)
}
}
return fe.CoerceEmptyToNil()
}
// ValidateBridgeTypeNotExist checks that a bridge has not already been created
func ValidateBridgeTypeNotExist(bt *models.BridgeTypeRequest, store *store.Store) error {
fe := models.NewJSONAPIErrors()
bridge, err := store.ORM.FindBridge(bt.Name)
if err != nil && err != gorm.ErrRecordNotFound {
fe.Add(fmt.Sprintf("Error determining if bridge type %v already exists", bt.Name))
} else if (bridge != models.BridgeType{}) {
fe.Add(fmt.Sprintf("Bridge Type %v already exists", bt.Name))
}
return fe.CoerceEmptyToNil()
}
// ValidateBridgeType checks that the bridge type doesn't have a duplicate
// or invalid name or invalid url
func ValidateBridgeType(bt *models.BridgeTypeRequest, store *store.Store) error {
fe := models.NewJSONAPIErrors()
if len(bt.Name.String()) < 1 {
fe.Add("No name specified")
}
if _, err := models.NewTaskType(bt.Name.String()); err != nil {
fe.Merge(err)
}
u := bt.URL.String()
if len(strings.TrimSpace(u)) == 0 {
fe.Add("URL must be present")
}
if bt.MinimumContractPayment != nil &&
bt.MinimumContractPayment.Cmp(assets.NewLink(0)) < 0 {
fe.Add("MinimumContractPayment must be positive")
}
ts := models.TaskSpec{Type: bt.Name}
if a := adapters.FindNativeAdapterFor(ts); a != nil {
fe.Add(fmt.Sprintf("Bridge Type %v is a native adapter", bt.Name))
}
return fe.CoerceEmptyToNil()
}
// ValidateExternalInitiator checks whether External Initiator parameters are
// safe for processing.
func ValidateExternalInitiator(
exi *models.ExternalInitiatorRequest,
store *store.Store,
) error {
fe := models.NewJSONAPIErrors()
if len([]rune(exi.Name)) == 0 {
fe.Add("No name specified")
} else if onlyValidRunes := govalidator.StringMatches(exi.Name, "^[a-zA-Z0-9-_]*$"); !onlyValidRunes {
fe.Add("Name must be alphanumeric and may contain '_' or '-'")
} else if _, err := store.FindExternalInitiatorByName(exi.Name); err == nil {
fe.Add(fmt.Sprintf("Name %v already exists", exi.Name))
} else if err != orm.ErrorNotFound {
return errors.Wrap(err, "validating external initiator")
}
return fe.CoerceEmptyToNil()
}
// ValidateInitiator checks the Initiator for any application logic errors.
func ValidateInitiator(i models.Initiator, j models.JobSpec, store *store.Store) error {
switch strings.ToLower(i.Type) {
case models.InitiatorRunAt:
return validateRunAtInitiator(i, j)
case models.InitiatorCron:
return validateCronInitiator(i)
case models.InitiatorExternal:
return validateExternalInitiator(i)
case models.InitiatorServiceAgreementExecutionLog:
return validateServiceAgreementInitiator(i, j)
case models.InitiatorRunLog:
return validateRunLogInitiator(i, j, store)
case models.InitiatorFluxMonitor:
return validateFluxMonitor(i, j, store)
case models.InitiatorWeb:
return nil
case models.InitiatorEthLog:
return nil
case models.InitiatorRandomnessLog:
return validateRandomnessLogInitiator(i, j)
default:
return models.NewJSONAPIErrorsWith(fmt.Sprintf("type %v does not exist", i.Type))
}
}
func validateFluxMonitor(i models.Initiator, j models.JobSpec, store *store.Store) error {
fe := models.NewJSONAPIErrors()
if store.Config.EthereumDisabled() {
fe.Add("cannot add flux monitor jobs when ethereum is disabled")
}
if i.Address == utils.ZeroAddress {
fe.Add("no address")
}
if i.RequestData.String() == "" {
fe.Add("no requestdata")
}
if i.Threshold <= 0 {
fe.Add("bad 'threshold' parameter; this is the maximum relative change " +
"allowed in the monitored value, before a new report should be made; " +
"it must be positive, and appear in the job initiator parameters; e.g." +
`{"initiators": [{"type":"fluxmonitor", "params":{"threshold": 0.5}}]} ` +
"means that the value can change by up to half its last-reported value " +
"before a new report is made")
}
if i.AbsoluteThreshold < 0 {
fe.Add("bad 'absoluteThreshold' value; this is the maximum absolute " +
"change allowed in the monitored value, before a new report should be " +
"made; it must be nonnegative and appear in the job initiator parameters; e.g." +
`{"initiators":[{"type":"fluxmonitor","params":{"absoluteThreshold":0.01}}]} ` +
"means that the value can change by up to 0.01 units " +
"before a new report is made")
}
if i.PollTimer.Disabled && i.IdleTimer.Disabled {
fe.Add("must enable pollTimer, idleTimer, or both")
}
if i.PollTimer.Disabled {
if !i.PollTimer.Period.IsInstant() {
fe.Add("pollTimer disabled, period must be 0")
}
} else {
minimumPollPeriod := models.Duration(store.Config.DefaultHTTPTimeout())
if i.PollTimer.Period.IsInstant() {
fe.Add("pollTimer enabled, but no period specified")
} else if i.PollTimer.Period.Shorter(minimumPollPeriod) {
fe.Add("pollTimer enabled, period must be equal or greater than " + minimumPollPeriod.String())
}
}
if i.IdleTimer.Disabled {
if !i.IdleTimer.Duration.IsInstant() {
fe.Add("idleTimer disabled, duration must be 0")
}
} else {
if i.IdleTimer.Duration.IsInstant() {
fe.Add("idleTimer enabled, duration must be > 0")
} else if !i.PollTimer.Disabled && i.IdleTimer.Duration.Shorter(i.PollTimer.Period) {
fe.Add("idleTimer and pollTimer enabled, idleTimer.duration must be >= than pollTimer.period")
}
}
if err := validateFeeds(i.Feeds, store); err != nil {
fe.Add(err.Error())
}
return fe.CoerceEmptyToNil()
}
func validateFeeds(feeds models.Feeds, store *store.Store) error {
var feedsData []interface{}
if err := json.Unmarshal(feeds.Bytes(), &feedsData); err != nil {
return errors.New("invalid json for feeds parameter")
}
if len(feedsData) == 0 {
return errors.New("feeds field is empty")
}
var bridgeNames []string
for _, entry := range feedsData {
switch feed := entry.(type) {
case string:
if _, err := url.ParseRequestURI(feed); err != nil {
return err
}
case map[string]interface{}: // named feed - ex: {"bridge": "bridgeName"}
bridgeName := feed["bridge"]
bridgeNameString, ok := bridgeName.(string)
if bridgeName == nil {
return errors.New("Feeds object missing bridge key")
} else if len(feed) != 1 {
return errors.New("Unsupported keys in feed JSON")
} else if !ok {
return errors.New("Unsupported bridge name type in feed JSON")
}
bridgeNames = append(bridgeNames, bridgeNameString)
default:
return errors.New("Unknown feed type")
}
}
if _, err := store.ORM.FindBridgesByNames(bridgeNames); err != nil {
return err
}
return nil
}
func validateRunLogInitiator(i models.Initiator, j models.JobSpec, s *store.Store) error {
fe := models.NewJSONAPIErrors()
ethTxCount := 0
for _, task := range j.Tasks {
if task.Type == adapters.TaskTypeEthTx {
ethTxCount++
task.Params.ForEach(func(k, v gjson.Result) bool {
key := strings.ToLower(k.String())
if key == "functionselector" {
fe.Add("Cannot set EthTx Task's function selector parameter with a RunLog Initiator")
} else if key == "address" {
fe.Add("Cannot set EthTx Task's address parameter with a RunLog Initiator")
} else if key == "fromaddress" {
address, err := hexutil.Decode(v.String())
if err != nil {
fe.Add(fmt.Sprintf("Cannot set EthTx Task's fromAddress parameter: %s", err.Error()))
} else {
exists, err := s.KeyExists(address)
if err != nil || !exists {
fe.Add("Cannot set EthTx Task's fromAddress parameter: the node does not have this private key in the database")
}
}
}
return true
})
}
}
if ethTxCount > 1 {
fe.Add("Cannot RunLog initiated jobs cannot have more than one EthTx Task")
}
return fe.CoerceEmptyToNil()
}
func validateRunAtInitiator(i models.Initiator, j models.JobSpec) error {
fe := models.NewJSONAPIErrors()
if !i.Time.Valid {
fe.Add("RunAt must have a time")
} else if j.StartAt.Valid && i.Time.Time.Unix() < j.StartAt.Time.Unix() {
fe.Add("RunAt time must be after job's StartAt")
} else if j.EndAt.Valid && i.Time.Time.Unix() > j.EndAt.Time.Unix() {
fe.Add("RunAt time must be before job's EndAt")
}
return fe.CoerceEmptyToNil()
}
func validateCronInitiator(i models.Initiator) error {
if i.Schedule == "" {
return models.NewJSONAPIErrorsWith("Schedule must have a cron")
}
return nil
}
func validateExternalInitiator(i models.Initiator) error {
if len([]rune(i.Name)) == 0 {
return models.NewJSONAPIErrorsWith("External must have a name")
}
return nil
}
func validateServiceAgreementInitiator(i models.Initiator, j models.JobSpec) error {
fe := models.NewJSONAPIErrors()
if len(j.Initiators) != 1 {
fe.Add("ServiceAgreement should have at most one initiator")
}
return fe.CoerceEmptyToNil()
}
func validateRandomnessLogInitiator(i models.Initiator, j models.JobSpec) error {
fe := models.NewJSONAPIErrors()
if len(j.Initiators) != 1 {
fe.Add("randomness log must have exactly one initiator")
}
if i.Address == utils.ZeroAddress {
fe.Add("randomness log must specify address of expected emmitter")
}
return fe.CoerceEmptyToNil()
}
func validateTask(task models.TaskSpec, store *store.Store) error {
adapter, err := adapters.For(task, store.Config, store.ORM)
if err != nil {
return err
}
if !store.Config.EnableExperimentalAdapters() {
if _, ok := adapter.BaseAdapter.(*adapters.Sleep); ok {
return errors.New("Sleep Adapter is not implemented yet")
}
if _, ok := adapter.BaseAdapter.(*adapters.EthTxABIEncode); ok {
return errors.New("EthTxABIEncode Adapter is not implemented yet")
}
}
return nil
}
// ValidateServiceAgreement checks the ServiceAgreement for any application logic errors.
func ValidateServiceAgreement(sa models.ServiceAgreement, store *store.Store) error {
fe := models.NewJSONAPIErrors()
config := store.Config
if sa.Encumbrance.Payment == nil {
fe.Add("Service agreement encumbrance error: No payment amount set")
} else if sa.Encumbrance.Payment.Cmp(config.MinimumContractPayment()) == -1 {
fe.Add(fmt.Sprintf("Service agreement encumbrance error: Payment amount is below minimum %v", config.MinimumContractPayment().String()))
}
if sa.Encumbrance.Expiration < config.MinimumRequestExpiration() {
fe.Add(fmt.Sprintf("Service agreement encumbrance error: Expiration is below minimum %v", config.MinimumRequestExpiration()))
}
account, err := store.KeyStore.GetFirstAccount()
if err != nil {
return err // 500
}
found := false
for _, oracle := range sa.Encumbrance.Oracles {
if oracle.Address() == account.Address {
found = true
}
}
if !found {
fe.Add("Service agreement encumbrance error: This node must be listed in the participating oracles")
}
if err := ValidateJob(sa.JobSpec, store); err != nil {
fe.Add(fmt.Sprintf("Service agreement job spec error: Job spec validation: %v", err))
}
untilEndAt := time.Until(sa.Encumbrance.EndAt.Time)
if untilEndAt > config.MaximumServiceDuration().Duration() {
fe.Add(fmt.Sprintf("Service agreement encumbrance error: endAt value of %v is too far in the future. Furthest allowed date is %v",
sa.Encumbrance.EndAt,
time.Now().Add(config.MaximumServiceDuration().Duration())))
}
if untilEndAt < config.MinimumServiceDuration().Duration() {
fe.Add(fmt.Sprintf("Service agreement encumbrance error: endAt value of %v is too soon. Earliest allowed date is %v",
sa.Encumbrance.EndAt,
time.Now().Add(config.MinimumServiceDuration().Duration())))
}
return fe.CoerceEmptyToNil()
}