-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
service.go
1080 lines (911 loc) · 30 KB
/
service.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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package feeds
import (
"context"
"database/sql"
"encoding/hex"
"fmt"
"github.com/ethereum/go-ethereum/common"
"github.com/lib/pq"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
uuid "github.com/satori/go.uuid"
"github.com/smartcontractkit/chainlink/core/services/keystore/keys/ethkey"
"github.com/smartcontractkit/chainlink/core/services/keystore/keys/ocrkey"
"github.com/smartcontractkit/chainlink/core/services/keystore/keys/p2pkey"
"github.com/smartcontractkit/chainlink/core/utils/crypto"
"github.com/smartcontractkit/chainlink/core/chains/evm"
"github.com/smartcontractkit/chainlink/core/logger"
pb "github.com/smartcontractkit/chainlink/core/services/feeds/proto"
"github.com/smartcontractkit/chainlink/core/services/fluxmonitorv2"
"github.com/smartcontractkit/chainlink/core/services/job"
"github.com/smartcontractkit/chainlink/core/services/keystore"
"github.com/smartcontractkit/chainlink/core/services/ocr"
"github.com/smartcontractkit/chainlink/core/services/pg"
"github.com/smartcontractkit/chainlink/core/utils"
"github.com/smartcontractkit/sqlx"
)
//go:generate mockery --name Service --output ./mocks/ --case=underscore
//go:generate mockery --dir ./proto --name FeedsManagerClient --output ./mocks/ --case=underscore
var (
ErrOCRDisabled = errors.New("ocr is disabled")
ErrSingleFeedsManager = errors.New("only a single feeds manager is supported")
ErrJobAlreadyExists = errors.New("a job for this contract address already exists - please use the 'force' option to replace it")
ErrFeedsManagerDisabled = errors.New("feeds manager is disabled")
promJobProposalRequest = promauto.NewCounter(prometheus.CounterOpts{
Name: "feeds_job_proposal_requests",
Help: "Metric to track job proposal requests",
})
)
// Service represents a behavior of the feeds service
type Service interface {
Start() error
Close() error
CountManagers() (int64, error)
GetManager(id int64) (*FeedsManager, error)
ListManagersByIDs(ids []int64) ([]FeedsManager, error)
ListManagers() ([]FeedsManager, error)
RegisterManager(params RegisterManagerParams) (int64, error)
UpdateManager(ctx context.Context, mgr FeedsManager) error
GetChainConfig(id int64) (*ChainConfig, error)
CreateChainConfig(cfg ChainConfig) (int64, error)
DeleteChainConfig(id int64) (int64, error)
ListChainConfigsByManagerIDs(mgrIDs []int64) ([]ChainConfig, error)
UpdateChainConfig(cfg ChainConfig) (int64, error)
ProposeJob(ctx context.Context, args *ProposeJobArgs) (int64, error)
SyncNodeInfo(id int64) error
IsJobManaged(ctx context.Context, jobID int64) (bool, error)
GetJobProposal(id int64) (*JobProposal, error)
ListJobProposalsByManagersIDs(ids []int64) ([]JobProposal, error)
ListJobProposals() ([]JobProposal, error)
ApproveSpec(ctx context.Context, id int64, force bool) error
CancelSpec(ctx context.Context, id int64) error
GetSpec(id int64) (*JobProposalSpec, error)
ListSpecsByJobProposalIDs(ids []int64) ([]JobProposalSpec, error)
RejectSpec(ctx context.Context, id int64) error
UpdateSpecDefinition(ctx context.Context, id int64, spec string) error
Unsafe_SetConnectionsManager(ConnectionsManager)
}
type service struct {
utils.StartStopOnce
orm ORM
jobORM job.ORM
q pg.Q
csaKeyStore keystore.CSA
p2pKeyStore keystore.P2P
ocr1KeyStore keystore.OCR
ocr2KeyStore keystore.OCR2
jobSpawner job.Spawner
cfg Config
connMgr ConnectionsManager
chainSet evm.ChainSet
lggr logger.Logger
version string
}
// NewService constructs a new feeds service
func NewService(
orm ORM,
jobORM job.ORM,
db *sqlx.DB,
jobSpawner job.Spawner,
keyStore keystore.Master,
cfg Config,
chainSet evm.ChainSet,
lggr logger.Logger,
version string,
) *service {
lggr = lggr.Named("Feeds")
svc := &service{
orm: orm,
jobORM: jobORM,
q: pg.NewQ(db, lggr, cfg),
jobSpawner: jobSpawner,
p2pKeyStore: keyStore.P2P(),
csaKeyStore: keyStore.CSA(),
ocr1KeyStore: keyStore.OCR(),
ocr2KeyStore: keyStore.OCR2(),
cfg: cfg,
connMgr: newConnectionsManager(lggr),
chainSet: chainSet,
lggr: lggr,
version: version,
}
return svc
}
type RegisterManagerParams struct {
Name string
URI string
PublicKey crypto.PublicKey
ChainConfigs []ChainConfig
}
// RegisterManager registers a new ManagerService and attempts to establish a
// connection.
//
// Only a single feeds manager is currently supported.
func (s *service) RegisterManager(params RegisterManagerParams) (int64, error) {
count, err := s.CountManagers()
if err != nil {
return 0, err
}
if count >= 1 {
return 0, ErrSingleFeedsManager
}
mgr := FeedsManager{
Name: params.Name,
URI: params.URI,
PublicKey: params.PublicKey,
}
var id int64
q := s.q.WithOpts(pg.WithParentCtx(context.Background()))
err = q.Transaction(func(tx pg.Queryer) error {
var txerr error
id, txerr = s.orm.CreateManager(&mgr, pg.WithQueryer(tx))
if err != nil {
return txerr
}
if _, txerr = s.orm.CreateBatchChainConfig(params.ChainConfigs, pg.WithQueryer(tx)); txerr != nil {
return txerr
}
return nil
})
privkey, err := s.getCSAPrivateKey()
if err != nil {
return 0, err
}
// Establish a connection
mgr.ID = id
s.connectFeedManager(mgr, privkey)
return id, nil
}
// SyncNodeInfo syncs the node's information with FMS
func (s *service) SyncNodeInfo(id int64) error {
// Get the FMS RPC client
fmsClient, err := s.connMgr.GetClient(id)
if err != nil {
return errors.Wrap(err, "could not fetch client")
}
cfgs, err := s.orm.ListChainConfigsByManagerIDs([]int64{id})
if err != nil {
return errors.Wrap(err, "could not fetch chain configs")
}
cfgMsgs := make([]*pb.ChainConfig, 0, len(cfgs))
for _, cfg := range cfgs {
cfgMsg, msgErr := s.newChainConfigMsg(cfg)
if msgErr != nil {
s.lggr.Errorf("SyncNodeInfo: %v", msgErr)
continue
}
cfgMsgs = append(cfgMsgs, cfgMsg)
}
if _, err = fmsClient.UpdateNode(context.Background(), &pb.UpdateNodeRequest{
Version: s.version,
ChainConfigs: cfgMsgs,
}); err != nil {
return err
}
return nil
}
// UpdateManager updates the feed manager details, takes down the
// connection and reestablishes a new connection with the updated public key.
func (s *service) UpdateManager(ctx context.Context, mgr FeedsManager) error {
q := s.q.WithOpts(pg.WithParentCtx(ctx))
err := q.Transaction(func(tx pg.Queryer) error {
txerr := s.orm.UpdateManager(mgr, pg.WithQueryer(tx))
if txerr != nil {
return errors.Wrap(txerr, "could not update manager")
}
return nil
})
if err != nil {
return err
}
if err := s.restartConnection(mgr); err != nil {
s.lggr.Errorf("could not restart FMS connection: %w", err)
}
return nil
}
// ListManagerServices lists all the manager services.
func (s *service) ListManagers() ([]FeedsManager, error) {
managers, err := s.orm.ListManagers()
if err != nil {
return nil, errors.Wrap(err, "failed to get a list of managers")
}
for i := range managers {
managers[i].IsConnectionActive = s.connMgr.IsConnected(managers[i].ID)
}
return managers, nil
}
// GetManager gets a manager service by id.
func (s *service) GetManager(id int64) (*FeedsManager, error) {
manager, err := s.orm.GetManager(id)
if err != nil {
return nil, errors.Wrap(err, "failed to get manager by ID")
}
manager.IsConnectionActive = s.connMgr.IsConnected(manager.ID)
return manager, nil
}
// ListManagersByIDs get managers services by ids.
func (s *service) ListManagersByIDs(ids []int64) ([]FeedsManager, error) {
managers, err := s.orm.ListManagersByIDs(ids)
if err != nil {
return nil, errors.Wrap(err, "failed to list managers by IDs")
}
for _, manager := range managers {
manager.IsConnectionActive = s.connMgr.IsConnected(manager.ID)
}
return managers, nil
}
// CountManagers gets the total number of manager services
func (s *service) CountManagers() (int64, error) {
return s.orm.CountManagers()
}
// CreateChainConfig creates a chain config.
func (s *service) CreateChainConfig(cfg ChainConfig) (int64, error) {
var err error
if cfg.AdminAddress != "" {
_, err = common.NewMixedcaseAddressFromString(cfg.AdminAddress)
if err != nil {
return 0, fmt.Errorf("invalid admin address: %v", cfg.AdminAddress)
}
}
id, err := s.orm.CreateChainConfig(cfg)
if err != nil {
return 0, errors.Wrap(err, "CreateChainConfig failed")
}
mgr, err := s.orm.GetManager(cfg.FeedsManagerID)
if err != nil {
return 0, errors.Wrap(err, "CreateChainConfig: failed to fetch manager")
}
if err := s.SyncNodeInfo(mgr.ID); err != nil {
s.lggr.Infof("FMS: Unable to sync node info: %w", err)
}
return id, nil
}
// DeleteChainConfig deletes the chain config by id.
func (s *service) DeleteChainConfig(id int64) (int64, error) {
cfg, err := s.orm.GetChainConfig(id)
if err != nil {
return 0, errors.Wrap(err, "DeleteChainConfig failed: could not get chain config")
}
_, err = s.orm.DeleteChainConfig(id)
if err != nil {
return 0, errors.Wrap(err, "DeleteChainConfig failed")
}
mgr, err := s.orm.GetManager(cfg.FeedsManagerID)
if err != nil {
return 0, errors.Wrap(err, "DeleteChainConfig: failed to fetch manager")
}
if err := s.SyncNodeInfo(mgr.ID); err != nil {
s.lggr.Infof("FMS: Unable to sync node info: %w", err)
}
return id, nil
}
func (s *service) GetChainConfig(id int64) (*ChainConfig, error) {
cfg, err := s.orm.GetChainConfig(id)
if err != nil {
return nil, errors.Wrap(err, "GetChainConfig failed")
}
return cfg, nil
}
func (s *service) ListChainConfigsByManagerIDs(mgrIDs []int64) ([]ChainConfig, error) {
cfgs, err := s.orm.ListChainConfigsByManagerIDs(mgrIDs)
return cfgs, errors.Wrap(err, "ListChainConfigsByManagerIDs failed")
}
func (s *service) UpdateChainConfig(cfg ChainConfig) (int64, error) {
var err error
if cfg.AdminAddress != "" {
_, err = common.NewMixedcaseAddressFromString(cfg.AdminAddress)
if err != nil {
return 0, fmt.Errorf("invalid admin address: %v", cfg.AdminAddress)
}
}
id, err := s.orm.UpdateChainConfig(cfg)
if err != nil {
return 0, errors.Wrap(err, "UpdateChainConfig failed")
}
ccfg, err := s.orm.GetChainConfig(cfg.ID)
if err != nil {
return 0, errors.Wrap(err, "UpdateChainConfig failed: could not get chain config")
}
if err := s.SyncNodeInfo(ccfg.FeedsManagerID); err != nil {
s.lggr.Infof("FMS: Unable to sync node info: %w", err)
}
return id, nil
}
// Lists all JobProposals
//
// When we support multiple feed managers, we will need to change this to filter
// by feeds manager
func (s *service) ListJobProposals() ([]JobProposal, error) {
return s.orm.ListJobProposals()
}
// ListJobProposalsByManagersIDs gets job proposals by feeds managers IDs
func (s *service) ListJobProposalsByManagersIDs(ids []int64) ([]JobProposal, error) {
return s.orm.ListJobProposalsByManagersIDs(ids)
}
// ProposeJobArgs are the arguments to provide to the ProposeJob method.
type ProposeJobArgs struct {
FeedsManagerID int64
RemoteUUID uuid.UUID
Multiaddrs pq.StringArray
Version int32
Spec string
}
// ProposeJob creates a job proposal if it does not exist. If it already exists
// and a new version is provided, a new spec is created.
//
// The feeds manager id check exists for support of multiple feeds managers in
// the future so that in the (very slim) off chance that the same uuid is
// generated by another feeds manager or they maliciously send an existing uuid
// belonging to another feeds manager, we do not update it.
func (s *service) ProposeJob(ctx context.Context, args *ProposeJobArgs) (int64, error) {
// Track the given job proposal request
promJobProposalRequest.Inc()
// Validate the args
if err := s.validateProposeJobArgs(*args); err != nil {
return 0, err
}
existing, err := s.orm.GetJobProposalByRemoteUUID(args.RemoteUUID)
if err != nil {
if !errors.Is(err, sql.ErrNoRows) {
return 0, errors.Wrap(err, "failed to check existence of job proposal")
}
}
// Validation for existing job proposals
if err == nil {
// Ensure that if the job proposal exists, that it belongs to the feeds
// manager which previously proposed a job using the remote UUID.
if args.FeedsManagerID != existing.FeedsManagerID {
return 0, errors.New("cannot update a job proposal belonging to another feeds manager")
}
// Check the version being proposed has not been previously proposed.
var exists bool
exists, err = s.orm.ExistsSpecByJobProposalIDAndVersion(existing.ID, args.Version)
if err != nil {
return 0, errors.Wrap(err, "failed to check existence of spec")
}
if exists {
return 0, errors.New("proposed job spec version already exists")
}
}
// TODO - Use parent context
var id int64
q := s.q.WithOpts(pg.WithParentCtx(context.Background()))
err = q.Transaction(func(tx pg.Queryer) error {
var txerr error
// Upsert job proposal
id, txerr = s.orm.UpsertJobProposal(&JobProposal{
RemoteUUID: args.RemoteUUID,
Status: JobProposalStatusPending,
FeedsManagerID: args.FeedsManagerID,
Multiaddrs: args.Multiaddrs,
}, pg.WithQueryer(tx))
if txerr != nil {
return errors.Wrap(txerr, "failed to upsert job proposal")
}
// Create the spec version
_, txerr = s.orm.CreateSpec(JobProposalSpec{
Definition: args.Spec,
Status: SpecStatusPending,
Version: args.Version,
JobProposalID: id,
}, pg.WithQueryer(tx))
if txerr != nil {
return errors.Wrap(txerr, "failed to create spec")
}
return nil
})
if err != nil {
return 0, err
}
return id, nil
}
// GetJobProposal gets a job proposal by id.
func (s *service) GetJobProposal(id int64) (*JobProposal, error) {
return s.orm.GetJobProposal(id)
}
// RejectSpec rejects a spec.
func (s *service) RejectSpec(ctx context.Context, id int64) error {
pctx := pg.WithParentCtx(ctx)
spec, err := s.orm.GetSpec(id, pctx)
if err != nil {
return errors.Wrap(err, "orm: job proposal spec")
}
// Validate
if spec.Status != SpecStatusPending {
return errors.New("must be a pending job proposal spec")
}
proposal, err := s.orm.GetJobProposal(spec.JobProposalID, pctx)
if err != nil {
return errors.Wrap(err, "orm: job proposal")
}
fmsClient, err := s.connMgr.GetClient(proposal.FeedsManagerID)
if err != nil {
return errors.Wrap(err, "fms rpc client is not connected")
}
q := s.q.WithOpts(pctx)
err = q.Transaction(func(tx pg.Queryer) error {
if err = s.orm.RejectSpec(id, pg.WithQueryer(tx)); err != nil {
return err
}
if _, err = fmsClient.RejectedJob(ctx, &pb.RejectedJobRequest{
Uuid: proposal.RemoteUUID.String(),
Version: int64(spec.Version),
}); err != nil {
return err
}
return nil
})
if err != nil {
return errors.Wrap(err, "could not reject job proposal")
}
return nil
}
// IsJobManaged determines is a job is managed by the Feeds Manager.
func (s *service) IsJobManaged(ctx context.Context, jobID int64) (bool, error) {
return s.orm.IsJobManaged(jobID, pg.WithParentCtx(ctx))
}
// ApproveSpec approves a spec for a job proposal and creates a job with the
// spec.
func (s *service) ApproveSpec(ctx context.Context, id int64, force bool) error {
pctx := pg.WithParentCtx(ctx)
spec, err := s.orm.GetSpec(id, pctx)
if err != nil {
return errors.Wrap(err, "orm: job proposal spec")
}
switch spec.Status {
case SpecStatusApproved:
return errors.New("cannot approve an approved spec")
case SpecStatusRejected:
return errors.New("cannot approve a rejected spec")
case SpecStatusCancelled:
// Allowed to approve a cancelled job if it is the latest job
latest, serr := s.orm.GetLatestSpec(spec.JobProposalID)
if serr != nil {
return errors.Wrap(err, "failed to get latest spec")
}
if latest.ID != spec.ID {
return errors.New("cannot approve a cancelled spec")
}
case SpecStatusPending:
// NOOP - pending jobs are allowed to be approved
default:
return errors.New("invalid status")
}
proposal, err := s.orm.GetJobProposal(spec.JobProposalID, pctx)
if err != nil {
return errors.Wrap(err, "orm: job proposal")
}
fmsClient, err := s.connMgr.GetClient(proposal.FeedsManagerID)
if err != nil {
return errors.Wrap(err, "fms rpc client")
}
j, err := s.generateJob(spec.Definition)
if err != nil {
return errors.Wrap(err, "could not generate job from spec")
}
var address ethkey.EIP55Address
switch j.Type {
case job.OffchainReporting:
address = j.OCROracleSpec.ContractAddress
case job.FluxMonitor:
address = j.FluxMonitorSpec.ContractAddress
default:
return errors.Errorf("unsupported job type when approving job proposal specs: %s", j.Type)
}
q := s.q.WithOpts(pctx)
err = q.Transaction(func(tx pg.Queryer) error {
existingJobID, txerr := s.jobORM.FindJobIDByAddress(address, pg.WithQueryer(tx))
if txerr == nil {
if force {
if txerr = s.jobSpawner.DeleteJob(existingJobID, pg.WithQueryer(tx)); txerr != nil {
return errors.Wrap(txerr, "DeleteJob failed")
}
} else {
return ErrJobAlreadyExists
}
} else if !errors.Is(txerr, sql.ErrNoRows) {
return errors.Wrap(txerr, "FindJobIDByAddress failed")
}
// Create the job
if txerr = s.jobSpawner.CreateJob(j, pg.WithQueryer(tx)); txerr != nil {
return txerr
}
// Approve the job proposal spec
if txerr = s.orm.ApproveSpec(id, j.ExternalJobID, pg.WithQueryer(tx)); txerr != nil {
return txerr
}
// Send to FMS Client
if _, txerr = fmsClient.ApprovedJob(ctx, &pb.ApprovedJobRequest{
Uuid: proposal.RemoteUUID.String(),
Version: int64(spec.Version),
}); txerr != nil {
return txerr
}
return nil
})
if err != nil {
return errors.Wrap(err, "could not approve job proposal")
}
return nil
}
// CancelSpec cancels a spec for a job proposal.
func (s *service) CancelSpec(ctx context.Context, id int64) error {
pctx := pg.WithParentCtx(ctx)
spec, err := s.orm.GetSpec(id, pctx)
if err != nil {
return errors.Wrap(err, "orm: job proposal spec")
}
if spec.Status != SpecStatusApproved {
return errors.New("must be an approved job proposal spec")
}
jp, err := s.orm.GetJobProposal(spec.JobProposalID, pg.WithParentCtx(ctx))
if err != nil {
return errors.Wrap(err, "orm: job proposal")
}
fmsClient, err := s.connMgr.GetClient(jp.FeedsManagerID)
if err != nil {
return errors.Wrap(err, "fms rpc client")
}
q := s.q.WithOpts(pctx)
err = q.Transaction(func(tx pg.Queryer) error {
if err = s.orm.CancelSpec(id, pg.WithQueryer(tx)); err != nil {
return err
}
// Delete the job
var j job.Job
j, err = s.jobORM.FindJobByExternalJobID(jp.ExternalJobID.UUID, pg.WithQueryer(tx))
if err != nil {
return errors.Wrap(err, "FindJobByExternalJobID failed")
}
if err = s.jobSpawner.DeleteJob(j.ID, pg.WithQueryer(tx)); err != nil {
return errors.Wrap(err, "DeleteJob failed")
}
// Send to FMS Client
if _, err = fmsClient.CancelledJob(ctx, &pb.CancelledJobRequest{
Uuid: jp.RemoteUUID.String(),
Version: int64(spec.Version),
}); err != nil {
return err
}
return nil
})
if err != nil {
return err
}
return err
}
// ListSpecsByJobProposalIDs gets the specs which belong to the job proposal ids.
func (s *service) ListSpecsByJobProposalIDs(ids []int64) ([]JobProposalSpec, error) {
return s.orm.ListSpecsByJobProposalIDs(ids)
}
// GetSpec gets the spec details by id.
func (s *service) GetSpec(id int64) (*JobProposalSpec, error) {
return s.orm.GetSpec(id)
}
// UpdateSpecDefinition updates the spec's TOML definition.
func (s *service) UpdateSpecDefinition(ctx context.Context, id int64, defn string) error {
pctx := pg.WithParentCtx(ctx)
spec, err := s.orm.GetSpec(id, pctx)
if err != nil {
if errors.Is(err, sql.ErrNoRows) {
return errors.Wrap(err, "job proposal spec does not exist")
}
return errors.Wrap(err, "database error")
}
if !spec.CanEditDefinition() {
return errors.New("must be a pending or cancelled spec")
}
// Update the spec definition
if err = s.orm.UpdateSpecDefinition(id, defn, pctx); err != nil {
return errors.Wrap(err, "could not update job proposal")
}
return nil
}
// Start starts the service.
func (s *service) Start() error {
return s.StartOnce("FeedsService", func() error {
privkey, err := s.getCSAPrivateKey()
if err != nil {
return err
}
// We only support a single feeds manager right now
mgrs, err := s.ListManagers()
if err != nil {
return err
}
if len(mgrs) < 1 {
return errors.New("no feeds managers registered")
}
mgr := mgrs[0]
s.connectFeedManager(mgr, privkey)
return nil
})
}
// Close shuts down the service
func (s *service) Close() error {
return s.StopOnce("FeedsService", func() error {
// This blocks until it finishes
s.connMgr.Close()
return nil
})
}
// connectFeedManager connects to a feeds manager
func (s *service) connectFeedManager(mgr FeedsManager, privkey []byte) {
s.connMgr.Connect(ConnectOpts{
FeedsManagerID: mgr.ID,
URI: mgr.URI,
Privkey: privkey,
Pubkey: mgr.PublicKey,
Handlers: &RPCHandlers{
feedsManagerID: mgr.ID,
svc: s,
},
OnConnect: func(pb.FeedsManagerClient) {
// Sync the node's information with FMS once connected
err := s.SyncNodeInfo(mgr.ID)
if err != nil {
s.lggr.Infof("Error syncing node info: %v", err)
}
},
})
}
// getCSAPrivateKey gets the server's CSA private key
func (s *service) getCSAPrivateKey() (privkey []byte, err error) {
// Fetch the server's public key
keys, err := s.csaKeyStore.GetAll()
if err != nil {
return privkey, err
}
if len(keys) < 1 {
return privkey, errors.New("CSA key does not exist")
}
return keys[0].Raw(), nil
}
// Unsafe_SetConnectionsManager sets the ConnectionsManager on the service.
//
// We need to be able to inject a mock for the client to facilitate integration
// tests.
//
// ONLY TO BE USED FOR TESTING.
func (s *service) Unsafe_SetConnectionsManager(connMgr ConnectionsManager) {
s.connMgr = connMgr
}
func (s *service) generateJob(spec string) (*job.Job, error) {
jobType, err := job.ValidateSpec(spec)
if err != nil {
return nil, errors.Wrap(err, "failed to parse job spec TOML")
}
var js job.Job
switch jobType {
case job.OffchainReporting:
if !s.cfg.Dev() && !s.cfg.FeatureOffchainReporting() {
return nil, ErrOCRDisabled
}
js, err = ocr.ValidatedOracleSpecToml(s.chainSet, spec)
case job.FluxMonitor:
js, err = fluxmonitorv2.ValidatedFluxMonitorSpec(s.cfg, spec)
default:
return nil, errors.Errorf("unknown job type: %s", jobType)
}
if err != nil {
return nil, err
}
return &js, nil
}
// newChainConfigMsg generates a chain config protobuf message.
func (s *service) newChainConfigMsg(cfg ChainConfig) (*pb.ChainConfig, error) {
// Only supports EVM Chains
if cfg.ChainType != "EVM" {
return nil, errors.New("unsupported chain type")
}
ocr1Cfg, err := s.newOCR1ConfigMsg(cfg.OCR1Config)
if err != nil {
return nil, err
}
ocr2Cfg, err := s.newOCR2ConfigMsg(cfg.OCR2Config)
if err != nil {
return nil, err
}
return &pb.ChainConfig{
Chain: &pb.Chain{
Id: cfg.ChainID,
Type: pb.ChainType_CHAIN_TYPE_EVM,
},
AccountAddress: cfg.AccountAddress,
AdminAddress: cfg.AdminAddress,
FluxMonitorConfig: s.newFluxMonitorConfigMsg(cfg.FluxMonitorConfig),
Ocr1Config: ocr1Cfg,
Ocr2Config: ocr2Cfg,
}, nil
}
// newFMConfigMsg generates a FMConfig protobuf message. Flux Monitor does not
// have any configuration but this is here for consistency.
func (*service) newFluxMonitorConfigMsg(cfg FluxMonitorConfig) *pb.FluxMonitorConfig {
return &pb.FluxMonitorConfig{Enabled: cfg.Enabled}
}
// newOCR1ConfigMsg generates a OCR1Config protobuf message.
func (s *service) newOCR1ConfigMsg(cfg OCR1Config) (*pb.OCR1Config, error) {
if !cfg.Enabled {
return &pb.OCR1Config{Enabled: false}, nil
}
msg := &pb.OCR1Config{
Enabled: true,
IsBootstrap: cfg.IsBootstrap,
Multiaddr: cfg.Multiaddr.ValueOrZero(),
}
// Fetch the P2P key bundle
if cfg.P2PPeerID.Valid {
peerID, err := p2pkey.MakePeerID(cfg.P2PPeerID.String)
if err != nil {
return nil, errors.Wrapf(err, "invalid peer id: %s", cfg.P2PPeerID.String)
}
p2pKey, err := s.p2pKeyStore.Get(peerID)
if err != nil {
return nil, errors.Wrapf(err, "p2p key not found: %s", cfg.P2PPeerID.String)
}
msg.P2PKeyBundle = &pb.OCR1Config_P2PKeyBundle{
PeerId: p2pKey.PeerID().String(),
PublicKey: p2pKey.PublicKeyHex(),
}
}
if cfg.KeyBundleID.Valid {
ocrKey, err := s.ocr1KeyStore.Get(cfg.KeyBundleID.String)
if err != nil {
return nil, errors.Wrapf(err, "ocr key not found: %s", cfg.KeyBundleID.String)
}
msg.OcrKeyBundle = &pb.OCR1Config_OCRKeyBundle{
BundleId: ocrKey.GetID(),
ConfigPublicKey: ocrkey.ConfigPublicKey(ocrKey.PublicKeyConfig()).String(),
OffchainPublicKey: ocrKey.OffChainSigning.PublicKey().String(),
OnchainSigningAddress: ocrKey.OnChainSigning.Address().String(),
}
}
return msg, nil
}
// newOCR2ConfigMsg generates a OCR2Config protobuf message.
func (s *service) newOCR2ConfigMsg(cfg OCR2Config) (*pb.OCR2Config, error) {
if !cfg.Enabled {
return &pb.OCR2Config{Enabled: false}, nil
}
msg := &pb.OCR2Config{
Enabled: true,
IsBootstrap: cfg.IsBootstrap,
Multiaddr: cfg.Multiaddr.ValueOrZero(),
}
// Fetch the P2P key bundle
if cfg.P2PPeerID.Valid {
peerID, err := p2pkey.MakePeerID(cfg.P2PPeerID.String)
if err != nil {
return nil, errors.Wrapf(err, "invalid peer id: %s", cfg.P2PPeerID.String)
}
p2pKey, err := s.p2pKeyStore.Get(peerID)
if err != nil {
return nil, errors.Wrapf(err, "p2p key not found: %s", cfg.P2PPeerID.String)
}
msg.P2PKeyBundle = &pb.OCR2Config_P2PKeyBundle{
PeerId: p2pKey.PeerID().String(),
PublicKey: p2pKey.PublicKeyHex(),
}
}
// Fetch the OCR Key Bundle
if cfg.KeyBundleID.Valid {
ocrKey, err := s.ocr2KeyStore.Get(cfg.KeyBundleID.String)
if err != nil {
return nil, errors.Wrapf(err, "ocr key not found: %s", cfg.KeyBundleID.String)
}
ocrConfigPublicKey := ocrKey.ConfigEncryptionPublicKey()
ocrOffChainPublicKey := ocrKey.OffchainPublicKey()
msg.OcrKeyBundle = &pb.OCR2Config_OCRKeyBundle{
BundleId: ocrKey.ID(),
ConfigPublicKey: hex.EncodeToString(ocrConfigPublicKey[:]),
OffchainPublicKey: hex.EncodeToString(ocrOffChainPublicKey[:]),
OnchainSigningAddress: ocrKey.OnChainPublicKey(),
}
}
return msg, nil
}
func (s *service) validateProposeJobArgs(args ProposeJobArgs) error {
// Validate the job spec
j, err := s.generateJob(args.Spec)
if err != nil {
return errors.Wrap(err, "failed to generate a job based on spec")
}
// Validate bootstrap multiaddrs which are only allowed for OCR jobs
if len(args.Multiaddrs) > 0 && j.Type != job.OffchainReporting {
return errors.New("only OCR job type supports multiaddr")
}
return nil
}
func (s *service) restartConnection(mgr FeedsManager) error {
s.lggr.Infof("Restarting connection")
if err := s.connMgr.Disconnect(mgr.ID); err != nil {
s.lggr.Info("Feeds Manager not connected, attempting to connect")
}
// Establish a new connection
privkey, err := s.getCSAPrivateKey()
if err != nil {
return err
}
s.connectFeedManager(mgr, privkey)
return nil
}
var _ Service = &NullService{}
// NullService defines an implementation of the Feeds Service that is used