-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
delegate.go
1741 lines (1555 loc) · 64.5 KB
/
delegate.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 ocr2
import (
"context"
"encoding/hex"
"encoding/json"
"fmt"
"log"
"time"
"github.com/ethereum/go-ethereum/common"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
"google.golang.org/grpc"
"gopkg.in/guregu/null.v4"
"github.com/smartcontractkit/libocr/commontypes"
libocr2 "github.com/smartcontractkit/libocr/offchainreporting2plus"
ocrtypes "github.com/smartcontractkit/libocr/offchainreporting2plus/types"
ocr2keepers20 "github.com/smartcontractkit/chainlink-automation/pkg/v2"
ocr2keepers20config "github.com/smartcontractkit/chainlink-automation/pkg/v2/config"
ocr2keepers20coordinator "github.com/smartcontractkit/chainlink-automation/pkg/v2/coordinator"
ocr2keepers20polling "github.com/smartcontractkit/chainlink-automation/pkg/v2/observer/polling"
ocr2keepers20runner "github.com/smartcontractkit/chainlink-automation/pkg/v2/runner"
ocr2keepers21config "github.com/smartcontractkit/chainlink-automation/pkg/v3/config"
ocr2keepers21 "github.com/smartcontractkit/chainlink-automation/pkg/v3/plugin"
"github.com/smartcontractkit/chainlink-common/pkg/loop"
"github.com/smartcontractkit/chainlink-common/pkg/loop/reportingplugins"
"github.com/smartcontractkit/chainlink-common/pkg/loop/reportingplugins/ocr3"
"github.com/smartcontractkit/chainlink-common/pkg/sqlutil"
"github.com/smartcontractkit/chainlink-common/pkg/types"
"github.com/smartcontractkit/chainlink-common/pkg/types/core"
llotypes "github.com/smartcontractkit/chainlink-common/pkg/types/llo"
"github.com/smartcontractkit/chainlink-common/pkg/utils/mailbox"
"github.com/smartcontractkit/chainlink-vrf/altbn_128"
dkgpkg "github.com/smartcontractkit/chainlink-vrf/dkg"
"github.com/smartcontractkit/chainlink-vrf/ocr2vrf"
"github.com/smartcontractkit/chainlink/v2/core/bridges"
"github.com/smartcontractkit/chainlink/v2/core/chains/legacyevm"
coreconfig "github.com/smartcontractkit/chainlink/v2/core/config"
"github.com/smartcontractkit/chainlink/v2/core/config/env"
"github.com/smartcontractkit/chainlink/v2/core/logger"
"github.com/smartcontractkit/chainlink/v2/core/services/job"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/chaintype"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/ocr2key"
"github.com/smartcontractkit/chainlink/v2/core/services/llo"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/dkg"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/dkg/persistence"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/functions"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/generic"
lloconfig "github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/llo/config"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/median"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/mercury"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/ocr2keeper"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/ocr2keeper/evmregistry/v21/autotelemetry21"
ocr2keeper21core "github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/ocr2keeper/evmregistry/v21/core"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/ocr2keeper/evmregistry/v21/logprovider"
ocr2vrfconfig "github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/ocr2vrf/config"
ocr2coordinator "github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/ocr2vrf/coordinator"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/ocr2vrf/juelsfeecoin"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/ocr2vrf/reasonablegasprice"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/ocr2vrf/reportserializer"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/promwrapper"
"github.com/smartcontractkit/chainlink/v2/core/services/ocr2/validate"
"github.com/smartcontractkit/chainlink/v2/core/services/ocrcommon"
"github.com/smartcontractkit/chainlink/v2/core/services/pipeline"
evmrelay "github.com/smartcontractkit/chainlink/v2/core/services/relay/evm"
functionsRelay "github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/functions"
evmmercury "github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury"
mercuryutils "github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/utils"
evmrelaytypes "github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/types"
"github.com/smartcontractkit/chainlink/v2/core/services/streams"
"github.com/smartcontractkit/chainlink/v2/core/services/synchronization"
"github.com/smartcontractkit/chainlink/v2/core/services/telemetry"
"github.com/smartcontractkit/chainlink/v2/plugins"
)
type ErrJobSpecNoRelayer struct {
PluginName string
Err error
}
func (e ErrJobSpecNoRelayer) Unwrap() error { return e.Err }
func (e ErrJobSpecNoRelayer) Error() string {
return fmt.Sprintf("%s services: OCR2 job spec could not get relayer ID: %s", e.PluginName, e.Err)
}
type ErrRelayNotEnabled struct {
PluginName string
Relay string
Err error
}
func (e ErrRelayNotEnabled) Unwrap() error { return e.Err }
func (e ErrRelayNotEnabled) Error() string {
return fmt.Sprintf("%s services: failed to get relay %s, is it enabled? %s", e.PluginName, e.Relay, e.Err)
}
type RelayGetter interface {
Get(id types.RelayID) (loop.Relayer, error)
GetIDToRelayerMap() (map[types.RelayID]loop.Relayer, error)
}
type Delegate struct {
ds sqlutil.DataSource
jobORM job.ORM
bridgeORM bridges.ORM
mercuryORM evmmercury.ORM
pipelineRunner pipeline.Runner
streamRegistry streams.Getter
peerWrapper *ocrcommon.SingletonPeerWrapper
monitoringEndpointGen telemetry.MonitoringEndpointGenerator
cfg DelegateConfig
lggr logger.Logger
ks keystore.OCR2
dkgSignKs keystore.DKGSign
dkgEncryptKs keystore.DKGEncrypt
ethKs keystore.Eth
RelayGetter
isNewlyCreatedJob bool // Set to true if this is a new job freshly added, false if job was present already on node boot.
mailMon *mailbox.Monitor
legacyChains legacyevm.LegacyChainContainer // legacy: use relayers instead
capabilitiesRegistry core.CapabilitiesRegistry
}
type DelegateConfig interface {
plugins.RegistrarConfig
OCR2() ocr2Config
JobPipeline() jobPipelineConfig
Insecure() insecureConfig
Mercury() coreconfig.Mercury
Threshold() coreconfig.Threshold
}
// concrete implementation of DelegateConfig so it can be explicitly composed
type delegateConfig struct {
plugins.RegistrarConfig
ocr2 ocr2Config
jobPipeline jobPipelineConfig
insecure insecureConfig
mercury mercuryConfig
threshold thresholdConfig
}
func (d *delegateConfig) JobPipeline() jobPipelineConfig {
return d.jobPipeline
}
func (d *delegateConfig) Insecure() insecureConfig {
return d.insecure
}
func (d *delegateConfig) Threshold() coreconfig.Threshold {
return d.threshold
}
func (d *delegateConfig) Mercury() coreconfig.Mercury {
return d.mercury
}
func (d *delegateConfig) OCR2() ocr2Config {
return d.ocr2
}
type ocr2Config interface {
BlockchainTimeout() time.Duration
CaptureEATelemetry() bool
ContractConfirmations() uint16
ContractPollInterval() time.Duration
ContractTransmitterTransmitTimeout() time.Duration
DatabaseTimeout() time.Duration
DefaultTransactionQueueDepth() uint32
KeyBundleID() (string, error)
SimulateTransactions() bool
TraceLogging() bool
CaptureAutomationCustomTelemetry() bool
}
type insecureConfig interface {
OCRDevelopmentMode() bool
}
type jobPipelineConfig interface {
MaxSuccessfulRuns() uint64
ResultWriteQueueDepth() uint64
}
type mercuryConfig interface {
Credentials(credName string) *types.MercuryCredentials
Cache() coreconfig.MercuryCache
TLS() coreconfig.MercuryTLS
Transmitter() coreconfig.MercuryTransmitter
}
type thresholdConfig interface {
ThresholdKeyShare() string
}
func NewDelegateConfig(ocr2Cfg ocr2Config, m coreconfig.Mercury, t coreconfig.Threshold, i insecureConfig, jp jobPipelineConfig, pluginProcessCfg plugins.RegistrarConfig) DelegateConfig {
return &delegateConfig{
ocr2: ocr2Cfg,
RegistrarConfig: pluginProcessCfg,
jobPipeline: jp,
insecure: i,
mercury: m,
threshold: t,
}
}
var _ job.Delegate = (*Delegate)(nil)
func NewDelegate(
ds sqlutil.DataSource,
jobORM job.ORM,
bridgeORM bridges.ORM,
mercuryORM evmmercury.ORM,
pipelineRunner pipeline.Runner,
streamRegistry streams.Getter,
peerWrapper *ocrcommon.SingletonPeerWrapper,
monitoringEndpointGen telemetry.MonitoringEndpointGenerator,
legacyChains legacyevm.LegacyChainContainer,
lggr logger.Logger,
cfg DelegateConfig,
ks keystore.OCR2,
dkgSignKs keystore.DKGSign,
dkgEncryptKs keystore.DKGEncrypt,
ethKs keystore.Eth,
relayers RelayGetter,
mailMon *mailbox.Monitor,
capabilitiesRegistry core.CapabilitiesRegistry,
) *Delegate {
return &Delegate{
ds: ds,
jobORM: jobORM,
bridgeORM: bridgeORM,
mercuryORM: mercuryORM,
pipelineRunner: pipelineRunner,
streamRegistry: streamRegistry,
peerWrapper: peerWrapper,
monitoringEndpointGen: monitoringEndpointGen,
legacyChains: legacyChains,
cfg: cfg,
lggr: lggr.Named("OCR2"),
ks: ks,
dkgSignKs: dkgSignKs,
dkgEncryptKs: dkgEncryptKs,
ethKs: ethKs,
RelayGetter: relayers,
isNewlyCreatedJob: false,
mailMon: mailMon,
capabilitiesRegistry: capabilitiesRegistry,
}
}
func (d *Delegate) JobType() job.Type {
return job.OffchainReporting2
}
func (d *Delegate) BeforeJobCreated(spec job.Job) {
// This is only called first time the job is created
d.isNewlyCreatedJob = true
}
func (d *Delegate) AfterJobCreated(spec job.Job) {}
func (d *Delegate) BeforeJobDeleted(spec job.Job) {}
func (d *Delegate) OnDeleteJob(ctx context.Context, jb job.Job) error {
// If the job spec is malformed in any way, we report the error but return nil so that
// the job deletion itself isn't blocked.
spec := jb.OCR2OracleSpec
if spec == nil {
d.lggr.Errorf("offchainreporting2.Delegate.OnDeleteJob called with wrong job type, ignoring non-OCR2 spec %v", jb)
return nil
}
rid, err := spec.RelayID()
if err != nil {
d.lggr.Errorw("DeleteJob", "err", ErrJobSpecNoRelayer{Err: err, PluginName: string(spec.PluginType)})
return nil
}
// we only have clean to do for the EVM
if rid.Network == types.NetworkEVM {
return d.cleanupEVM(ctx, jb, rid)
}
return nil
}
// cleanupEVM is a helper for clean up EVM specific state when a job is deleted
func (d *Delegate) cleanupEVM(ctx context.Context, jb job.Job, relayID types.RelayID) error {
// If UnregisterFilter returns an
// error, that means it failed to remove a valid active filter from the db. We do abort the job deletion
// in that case, since it should be easy for the user to retry and will avoid leaving the db in
// an inconsistent state. This assumes UnregisterFilter will return nil if the filter wasn't found
// at all (no rows deleted).
spec := jb.OCR2OracleSpec
chain, err := d.legacyChains.Get(relayID.ChainID)
if err != nil {
d.lggr.Error("cleanupEVM: failed to chain get chain %s", "err", relayID.ChainID, err)
return nil
}
lp := chain.LogPoller()
var filters []string
switch spec.PluginType {
case types.OCR2VRF:
filters, err = ocr2coordinator.FilterNamesFromSpec(spec)
if err != nil {
d.lggr.Errorw("failed to derive ocr2vrf filter names from spec", "err", err, "spec", spec)
}
case types.OCR2Keeper:
filters, err = ocr2keeper.FilterNamesFromSpec20(spec)
if err != nil {
d.lggr.Errorw("failed to derive ocr2keeper filter names from spec", "err", err, "spec", spec)
}
default:
return nil
}
rargs := types.RelayArgs{
ExternalJobID: jb.ExternalJobID,
JobID: jb.ID,
ContractID: spec.ContractID,
New: false,
RelayConfig: spec.RelayConfig.Bytes(),
}
relayFilters, err := evmrelay.FilterNamesFromRelayArgs(rargs)
if err != nil {
d.lggr.Errorw("Failed to derive evm relay filter names from relay args", "err", err, "rargs", rargs)
return nil
}
filters = append(filters, relayFilters...)
for _, filter := range filters {
d.lggr.Debugf("Unregistering %s filter", filter)
err = lp.UnregisterFilter(ctx, filter)
if err != nil {
return errors.Wrapf(err, "Failed to unregister filter %s", filter)
}
}
return nil
}
// ServicesForSpec returns the OCR2 services that need to run for this job
func (d *Delegate) ServicesForSpec(ctx context.Context, jb job.Job) ([]job.ServiceCtx, error) {
spec := jb.OCR2OracleSpec
if spec == nil {
return nil, errors.Errorf("offchainreporting2.Delegate expects an *job.OCR2OracleSpec to be present, got %v", jb)
}
transmitterID := spec.TransmitterID.String
effectiveTransmitterID := transmitterID
lggrCtx := loop.ContextValues{
JobID: jb.ID,
JobName: jb.Name.ValueOrZero(),
ContractID: spec.ContractID,
TransmitterID: transmitterID,
}
if spec.FeedID != nil && (*spec.FeedID != (common.Hash{})) {
lggrCtx.FeedID = *spec.FeedID
spec.RelayConfig["feedID"] = spec.FeedID
}
lggr := logger.Sugared(d.lggr.Named(jb.ExternalJobID.String()).With(lggrCtx.Args()...))
kvStore := job.NewKVStore(jb.ID, d.ds, lggr)
rid, err := spec.RelayID()
if err != nil {
return nil, ErrJobSpecNoRelayer{Err: err, PluginName: string(spec.PluginType)}
}
if rid.Network == types.NetworkEVM {
lggr = logger.Sugared(lggr.With("evmChainID", rid.ChainID))
chain, err2 := d.legacyChains.Get(rid.ChainID)
if err2 != nil {
return nil, fmt.Errorf("ServicesForSpec: could not get EVM chain %s: %w", rid.ChainID, err2)
}
effectiveTransmitterID, err2 = GetEVMEffectiveTransmitterID(&jb, chain, lggr)
if err2 != nil {
return nil, fmt.Errorf("ServicesForSpec failed to get evm transmitterID: %w", err2)
}
}
spec.RelayConfig["effectiveTransmitterID"] = effectiveTransmitterID
spec.RelayConfig.ApplyDefaultsOCR2(d.cfg.OCR2())
ocrDB := NewDB(d.ds, spec.ID, 0, lggr)
if d.peerWrapper == nil {
return nil, errors.New("cannot setup OCR2 job service, libp2p peer was missing")
} else if !d.peerWrapper.IsStarted() {
return nil, errors.New("peerWrapper is not started. OCR2 jobs require a started and running p2p v2 peer")
}
lc, err := validate.ToLocalConfig(d.cfg.OCR2(), d.cfg.Insecure(), *spec)
if err != nil {
return nil, err
}
if err = libocr2.SanityCheckLocalConfig(lc); err != nil {
return nil, err
}
lggr.Infow("OCR2 job using local config",
"BlockchainTimeout", lc.BlockchainTimeout,
"ContractConfigConfirmations", lc.ContractConfigConfirmations,
"ContractConfigTrackerPollInterval", lc.ContractConfigTrackerPollInterval,
"ContractTransmitterTransmitTimeout", lc.ContractTransmitterTransmitTimeout,
"DatabaseTimeout", lc.DatabaseTimeout,
)
bootstrapPeers, err := ocrcommon.GetValidatedBootstrapPeers(spec.P2PV2Bootstrappers, d.peerWrapper.P2PConfig().V2().DefaultBootstrappers())
if err != nil {
return nil, err
}
lggr.Debugw("Using bootstrap peers", "peers", bootstrapPeers)
// Fetch the specified OCR2 key bundle
var kbID string
if spec.OCRKeyBundleID.Valid {
kbID = spec.OCRKeyBundleID.String
} else if kbID, err = d.cfg.OCR2().KeyBundleID(); err != nil {
return nil, err
}
kb, err := d.ks.Get(kbID)
if err != nil {
return nil, err
}
spec.CaptureEATelemetry = d.cfg.OCR2().CaptureEATelemetry()
ctx = lggrCtx.ContextWithValues(ctx)
switch spec.PluginType {
case types.Mercury:
return d.newServicesMercury(ctx, lggr, jb, bootstrapPeers, kb, ocrDB, lc)
case types.LLO:
return d.newServicesLLO(ctx, lggr, jb, bootstrapPeers, kb, ocrDB, lc)
case types.Median:
return d.newServicesMedian(ctx, lggr, jb, bootstrapPeers, kb, kvStore, ocrDB, lc)
case types.DKG:
return d.newServicesDKG(lggr, jb, bootstrapPeers, kb, ocrDB, lc)
case types.OCR2VRF:
return d.newServicesOCR2VRF(ctx, lggr, jb, bootstrapPeers, kb, ocrDB, lc)
case types.OCR2Keeper:
return d.newServicesOCR2Keepers(ctx, lggr, jb, bootstrapPeers, kb, ocrDB, lc)
case types.Functions:
const (
_ int32 = iota
thresholdPluginId
s4PluginId
)
thresholdPluginDB := NewDB(d.ds, spec.ID, thresholdPluginId, lggr)
s4PluginDB := NewDB(d.ds, spec.ID, s4PluginId, lggr)
return d.newServicesOCR2Functions(ctx, lggr, jb, bootstrapPeers, kb, ocrDB, thresholdPluginDB, s4PluginDB, lc)
case types.GenericPlugin:
return d.newServicesGenericPlugin(ctx, lggr, jb, bootstrapPeers, kb, ocrDB, lc, d.capabilitiesRegistry,
kvStore)
default:
return nil, errors.Errorf("plugin type %s not supported", spec.PluginType)
}
}
func GetEVMEffectiveTransmitterID(jb *job.Job, chain legacyevm.Chain, lggr logger.SugaredLogger) (string, error) {
spec := jb.OCR2OracleSpec
if spec.PluginType == types.Mercury || spec.PluginType == types.LLO {
return spec.TransmitterID.String, nil
}
if spec.RelayConfig["sendingKeys"] == nil {
spec.RelayConfig["sendingKeys"] = []string{spec.TransmitterID.String}
} else if !spec.TransmitterID.Valid {
sendingKeys, err := job.SendingKeysForJob(jb)
if err != nil {
return "", err
}
if len(sendingKeys) > 1 && spec.PluginType != types.OCR2VRF {
return "", errors.New("only ocr2 vrf should have more than 1 sending key")
}
spec.TransmitterID = null.StringFrom(sendingKeys[0])
}
// effectiveTransmitterID is the transmitter address registered on the ocr contract. This is by default the EOA account on the node.
// In the case of forwarding, the transmitter address is the forwarder contract deployed onchain between EOA and OCR contract.
// ForwardingAllowed cannot be set with Mercury, so this should always be false for mercury jobs
if jb.ForwardingAllowed {
if chain == nil {
return "", fmt.Errorf("job forwarding requires non-nil chain")
}
var err error
var effectiveTransmitterID common.Address
// Median forwarders need special handling because of OCR2Aggregator transmitters whitelist.
if spec.PluginType == types.Median {
effectiveTransmitterID, err = chain.TxManager().GetForwarderForEOAOCR2Feeds(common.HexToAddress(spec.TransmitterID.String), common.HexToAddress(spec.ContractID))
} else {
effectiveTransmitterID, err = chain.TxManager().GetForwarderForEOA(common.HexToAddress(spec.TransmitterID.String))
}
if err == nil {
return effectiveTransmitterID.String(), nil
} else if !spec.TransmitterID.Valid {
return "", errors.New("failed to get forwarder address and transmitterID is not set")
}
lggr.Warnw("Skipping forwarding for job, will fallback to default behavior", "job", jb.Name, "err", err)
}
return spec.TransmitterID.String, nil
}
type connProvider interface {
ClientConn() grpc.ClientConnInterface
}
func (d *Delegate) newServicesGenericPlugin(
ctx context.Context,
lggr logger.SugaredLogger,
jb job.Job,
bootstrapPeers []commontypes.BootstrapperLocator,
kb ocr2key.KeyBundle,
ocrDB *db,
lc ocrtypes.LocalConfig,
capabilitiesRegistry core.CapabilitiesRegistry,
keyValueStore core.KeyValueStore,
) (srvs []job.ServiceCtx, err error) {
spec := jb.OCR2OracleSpec
// NOTE: we don't need to validate this config, since that happens as part of creating the job.
// See: validate/validate.go's `validateSpec`.
pCfg := validate.OCR2GenericPluginConfig{}
err = json.Unmarshal(spec.PluginConfig.Bytes(), &pCfg)
if err != nil {
return nil, err
}
// NOTE: we don't need to validate the strategy, since that happens as part of creating the job.
// See: validate/validate.go's `validateSpec`.
onchainSigningStrategy := validate.OCR2OnchainSigningStrategy{}
err = json.Unmarshal(spec.OnchainSigningStrategy.Bytes(), &onchainSigningStrategy)
if err != nil {
return nil, err
}
plugEnv := env.NewPlugin(pCfg.PluginName)
command := pCfg.Command
if command == "" {
command = plugEnv.Cmd.Get()
}
// Add the default pipeline to the pluginConfig
pCfg.Pipelines = append(
pCfg.Pipelines,
validate.PipelineSpec{Name: "__DEFAULT_PIPELINE__", Spec: jb.Pipeline.Source},
)
rid, err := spec.RelayID()
if err != nil {
return nil, ErrJobSpecNoRelayer{PluginName: pCfg.PluginName, Err: err}
}
relayerSet, err := generic.NewRelayerSet(d.RelayGetter, jb.ExternalJobID, jb.ID, d.isNewlyCreatedJob)
if err != nil {
return nil, fmt.Errorf("failed to create relayer set: %w", err)
}
relayer, err := d.RelayGetter.Get(rid)
if err != nil {
return nil, ErrRelayNotEnabled{Err: err, Relay: spec.Relay, PluginName: pCfg.PluginName}
}
provider, err := relayer.NewPluginProvider(ctx, types.RelayArgs{
ExternalJobID: jb.ExternalJobID,
JobID: spec.ID,
ContractID: spec.ContractID,
New: d.isNewlyCreatedJob,
RelayConfig: spec.RelayConfig.Bytes(),
ProviderType: pCfg.ProviderType,
}, types.PluginArgs{
TransmitterID: spec.TransmitterID.String,
PluginConfig: spec.PluginConfig.Bytes(),
})
if err != nil {
return nil, err
}
srvs = append(srvs, provider)
envVars, err := plugins.ParseEnvFile(plugEnv.Env.Get())
if err != nil {
return nil, fmt.Errorf("failed to parse median env file: %w", err)
}
if len(pCfg.EnvVars) > 0 {
for k, v := range pCfg.EnvVars {
envVars = append(envVars, k+"="+v)
}
}
pluginLggr := lggr.Named(pCfg.PluginName).Named(spec.ContractID).Named(spec.GetID())
cmdFn, grpcOpts, err := d.cfg.RegisterLOOP(plugins.CmdConfig{
ID: fmt.Sprintf("%s-%s-%s", pCfg.PluginName, spec.ContractID, spec.GetID()),
Cmd: command,
Env: envVars,
})
if err != nil {
return nil, fmt.Errorf("failed to register loop: %w", err)
}
errorLog := &errorLog{jobID: jb.ID, recordError: d.jobORM.RecordError}
var providerClientConn grpc.ClientConnInterface
providerConn, ok := provider.(connProvider)
if ok {
providerClientConn = providerConn.ClientConn()
} else {
//We chose to deal with the difference between a LOOP provider and an embedded provider here rather than
//in NewServerAdapter because this has a smaller blast radius, as the scope of this workaround is to
//enable the medianpoc for EVM and not touch the other providers.
//TODO: remove this workaround when the EVM relayer is running inside of an LOOPP
d.lggr.Info("provider is not a LOOPP provider, switching to provider server")
ps, err2 := loop.NewProviderServer(provider, types.OCR2PluginType(pCfg.ProviderType), d.lggr)
if err2 != nil {
return nil, fmt.Errorf("cannot start EVM provider server: %s", err2)
}
providerClientConn, err2 = ps.GetConn()
if err2 != nil {
return nil, fmt.Errorf("cannot connect to EVM provider server: %s", err)
}
srvs = append(srvs, ps)
}
pc, err := json.Marshal(pCfg.Config)
if err != nil {
return nil, fmt.Errorf("cannot dump plugin config to string before sending to plugin: %s", err)
}
pluginConfig := core.ReportingPluginServiceConfig{
PluginName: pCfg.PluginName,
Command: command,
ProviderType: pCfg.ProviderType,
TelemetryType: pCfg.TelemetryType,
PluginConfig: string(pc),
}
pr := generic.NewPipelineRunnerAdapter(pluginLggr, jb, d.pipelineRunner)
ta := generic.NewTelemetryAdapter(d.monitoringEndpointGen)
oracleEndpoint := d.monitoringEndpointGen.GenMonitoringEndpoint(
rid.Network,
rid.ChainID,
spec.ContractID,
synchronization.TelemetryType(pCfg.TelemetryType),
)
ocrLogger := ocrcommon.NewOCRWrapper(lggr, d.cfg.OCR2().TraceLogging(), func(ctx context.Context, msg string) {
lggr.ErrorIf(d.jobORM.RecordError(ctx, jb.ID, msg), "unable to record error")
})
srvs = append(srvs, ocrLogger)
switch pCfg.OCRVersion {
case 2:
plugin := reportingplugins.NewLOOPPService(pluginLggr, grpcOpts, cmdFn, pluginConfig, providerClientConn, pr, ta,
errorLog, keyValueStore, relayerSet)
oracleArgs := libocr2.OCR2OracleArgs{
BinaryNetworkEndpointFactory: d.peerWrapper.Peer2,
V2Bootstrappers: bootstrapPeers,
Database: ocrDB,
LocalConfig: lc,
Logger: ocrLogger,
MonitoringEndpoint: oracleEndpoint,
OffchainKeyring: kb,
OnchainKeyring: kb,
ContractTransmitter: provider.ContractTransmitter(),
ContractConfigTracker: provider.ContractConfigTracker(),
OffchainConfigDigester: provider.OffchainConfigDigester(),
MetricsRegisterer: prometheus.WrapRegistererWith(map[string]string{"job_name": jb.Name.ValueOrZero()}, prometheus.DefaultRegisterer),
}
oracleArgs.ReportingPluginFactory = plugin
srvs = append(srvs, plugin)
oracle, err := libocr2.NewOracle(oracleArgs)
if err != nil {
return nil, err
}
srvs = append(srvs, job.NewServiceAdapter(oracle))
case 3:
//OCR3 with OCR2 OnchainKeyring and ContractTransmitter
plugin := ocr3.NewLOOPPService(pluginLggr, grpcOpts, cmdFn, pluginConfig, providerClientConn, pr, ta, errorLog,
capabilitiesRegistry, keyValueStore, relayerSet)
contractTransmitter := ocrcommon.NewOCR3ContractTransmitterAdapter(provider.ContractTransmitter())
oracleArgs := libocr2.OCR3OracleArgs[[]byte]{
BinaryNetworkEndpointFactory: d.peerWrapper.Peer2,
V2Bootstrappers: bootstrapPeers,
ContractConfigTracker: provider.ContractConfigTracker(),
ContractTransmitter: contractTransmitter,
Database: ocrDB,
LocalConfig: lc,
Logger: ocrLogger,
MonitoringEndpoint: oracleEndpoint,
OffchainConfigDigester: provider.OffchainConfigDigester(),
OffchainKeyring: kb,
OnchainKeyring: ocrcommon.NewOCR3OnchainKeyringAdapter(kb),
MetricsRegisterer: prometheus.WrapRegistererWith(map[string]string{"job_name": jb.Name.ValueOrZero()}, prometheus.DefaultRegisterer),
}
oracleArgs.ReportingPluginFactory = plugin
srvs = append(srvs, plugin)
oracle, err := libocr2.NewOracle(oracleArgs)
if err != nil {
return nil, err
}
srvs = append(srvs, job.NewServiceAdapter(oracle))
default:
return nil, fmt.Errorf("unknown OCR version: %d", pCfg.OCRVersion)
}
return srvs, nil
}
func (d *Delegate) newServicesMercury(
ctx context.Context,
lggr logger.SugaredLogger,
jb job.Job,
bootstrapPeers []commontypes.BootstrapperLocator,
kb ocr2key.KeyBundle,
ocrDB *db,
lc ocrtypes.LocalConfig,
) ([]job.ServiceCtx, error) {
if jb.OCR2OracleSpec.FeedID == nil || (*jb.OCR2OracleSpec.FeedID == (common.Hash{})) {
return nil, errors.Errorf("ServicesForSpec: mercury job type requires feedID")
}
spec := jb.OCR2OracleSpec
transmitterID := spec.TransmitterID.String
if len(transmitterID) != 64 {
return nil, errors.Errorf("ServicesForSpec: mercury job type requires transmitter ID to be a 32-byte hex string, got: %q", transmitterID)
}
if _, err := hex.DecodeString(transmitterID); err != nil {
return nil, errors.Wrapf(err, "ServicesForSpec: mercury job type requires transmitter ID to be a 32-byte hex string, got: %q", transmitterID)
}
rid, err := spec.RelayID()
if err != nil {
return nil, ErrJobSpecNoRelayer{Err: err, PluginName: "mercury"}
}
if rid.Network != types.NetworkEVM {
return nil, fmt.Errorf("mercury services: expected EVM relayer got %s", rid.Network)
}
relayer, err := d.RelayGetter.Get(rid)
if err != nil {
return nil, ErrRelayNotEnabled{Err: err, Relay: spec.Relay, PluginName: "mercury"}
}
provider, err2 := relayer.NewPluginProvider(ctx,
types.RelayArgs{
ExternalJobID: jb.ExternalJobID,
JobID: jb.ID,
ContractID: spec.ContractID,
New: d.isNewlyCreatedJob,
RelayConfig: spec.RelayConfig.Bytes(),
ProviderType: string(spec.PluginType),
}, types.PluginArgs{
TransmitterID: transmitterID,
PluginConfig: spec.PluginConfig.Bytes(),
})
if err2 != nil {
return nil, err2
}
mercuryProvider, ok := provider.(types.MercuryProvider)
if !ok {
return nil, errors.New("could not coerce PluginProvider to MercuryProvider")
}
// HACK: We need fast config switchovers because they create downtime. This
// won't be properly resolved until we implement blue-green deploys:
// https://smartcontract-it.atlassian.net/browse/MERC-3386
lc.ContractConfigTrackerPollInterval = 1 * time.Second // Mercury requires a fast poll interval, this is the fastest that libocr supports. See: https://github.com/smartcontractkit/offchain-reporting/pull/520
ocrLogger := ocrcommon.NewOCRWrapper(lggr, d.cfg.OCR2().TraceLogging(), func(ctx context.Context, msg string) {
lggr.ErrorIf(d.jobORM.RecordError(ctx, jb.ID, msg), "unable to record error")
})
oracleArgsNoPlugin := libocr2.MercuryOracleArgs{
BinaryNetworkEndpointFactory: d.peerWrapper.Peer2,
V2Bootstrappers: bootstrapPeers,
ContractTransmitter: mercuryProvider.ContractTransmitter(),
ContractConfigTracker: mercuryProvider.ContractConfigTracker(),
Database: ocrDB,
LocalConfig: lc,
Logger: ocrLogger,
MonitoringEndpoint: d.monitoringEndpointGen.GenMonitoringEndpoint(rid.Network, rid.ChainID, spec.FeedID.String(), synchronization.OCR3Mercury),
OffchainConfigDigester: mercuryProvider.OffchainConfigDigester(),
OffchainKeyring: kb,
OnchainKeyring: kb,
MetricsRegisterer: prometheus.WrapRegistererWith(map[string]string{"job_name": jb.Name.ValueOrZero()}, prometheus.DefaultRegisterer),
}
chEnhancedTelem := make(chan ocrcommon.EnhancedTelemetryMercuryData, 100)
mCfg := mercury.NewMercuryConfig(d.cfg.JobPipeline().MaxSuccessfulRuns(), d.cfg.JobPipeline().ResultWriteQueueDepth(), d.cfg)
mercuryServices, err2 := mercury.NewServices(jb, mercuryProvider, d.pipelineRunner, lggr, oracleArgsNoPlugin, mCfg, chEnhancedTelem, d.mercuryORM, (mercuryutils.FeedID)(*spec.FeedID))
if ocrcommon.ShouldCollectEnhancedTelemetryMercury(jb) {
enhancedTelemService := ocrcommon.NewEnhancedTelemetryService(&jb, chEnhancedTelem, make(chan struct{}), d.monitoringEndpointGen.GenMonitoringEndpoint(rid.Network, rid.ChainID, spec.FeedID.String(), synchronization.EnhancedEAMercury), lggr.Named("EnhancedTelemetryMercury"))
mercuryServices = append(mercuryServices, enhancedTelemService)
} else {
lggr.Infow("Enhanced telemetry is disabled for mercury job", "job", jb.Name)
}
mercuryServices = append(mercuryServices, ocrLogger)
return mercuryServices, err2
}
func (d *Delegate) newServicesLLO(
ctx context.Context,
lggr logger.SugaredLogger,
jb job.Job,
bootstrapPeers []commontypes.BootstrapperLocator,
kb ocr2key.KeyBundle,
ocrDB *db,
lc ocrtypes.LocalConfig,
) ([]job.ServiceCtx, error) {
lggr = logger.Sugared(lggr.Named("LLO"))
spec := jb.OCR2OracleSpec
transmitterID := spec.TransmitterID.String
if len(transmitterID) != 64 {
return nil, errors.Errorf("ServicesForSpec: streams job type requires transmitter ID to be a 32-byte hex string, got: %q", transmitterID)
}
if _, err := hex.DecodeString(transmitterID); err != nil {
return nil, errors.Wrapf(err, "ServicesForSpec: streams job type requires transmitter ID to be a 32-byte hex string, got: %q", transmitterID)
}
rid, err := spec.RelayID()
if err != nil {
return nil, ErrJobSpecNoRelayer{Err: err, PluginName: "streams"}
}
if rid.Network != types.NetworkEVM {
return nil, fmt.Errorf("streams services: expected EVM relayer got %s", rid.Network)
}
relayer, err := d.RelayGetter.Get(rid)
if err != nil {
return nil, ErrRelayNotEnabled{Err: err, Relay: spec.Relay, PluginName: "streams"}
}
provider, err2 := relayer.NewLLOProvider(ctx,
types.RelayArgs{
ExternalJobID: jb.ExternalJobID,
JobID: jb.ID,
ContractID: spec.ContractID,
New: d.isNewlyCreatedJob,
RelayConfig: spec.RelayConfig.Bytes(),
ProviderType: string(spec.PluginType),
}, types.PluginArgs{
TransmitterID: transmitterID,
PluginConfig: spec.PluginConfig.Bytes(),
})
if err2 != nil {
return nil, err2
}
var pluginCfg lloconfig.PluginConfig
if err = json.Unmarshal(spec.PluginConfig.Bytes(), &pluginCfg); err != nil {
return nil, err
}
kbm := make(map[llotypes.ReportFormat]llo.Key)
for rfStr, kbid := range pluginCfg.KeyBundleIDs {
k, err3 := d.ks.Get(kbid)
if err3 != nil {
return nil, fmt.Errorf("job %d (%s) specified key bundle ID %q for report format %s, but got error trying to load it: %w", jb.ID, jb.Name.ValueOrZero(), kbid, rfStr, err3)
}
rf, err4 := llotypes.ReportFormatFromString(rfStr)
if err4 != nil {
return nil, fmt.Errorf("job %d (%s) specified key bundle ID %q for report format %s, but it is not a recognized report format: %w", jb.ID, jb.Name.ValueOrZero(), kbid, rfStr, err4)
}
kbm[rf] = k
}
// NOTE: This is a bit messy because we assume chain type matches report
// format, and it may not in all cases. We don't yet know what report
// formats we need or how they correspond to chain types, so assume it's
// 1:1 for now but will change in future
//
// https://smartcontract-it.atlassian.net/browse/MERC-3722
for _, s := range chaintype.SupportedChainTypes {
rf, err3 := llotypes.ReportFormatFromString(string(s))
if err3 != nil {
return nil, fmt.Errorf("job %d (%s) has a chain type with no matching report format %s: %w", jb.ID, jb.Name.ValueOrZero(), s, err3)
}
if _, exists := kbm[rf]; !exists {
// Use the first if unspecified
kbs, err4 := d.ks.GetAllOfType(s)
if err4 != nil {
return nil, err4
}
if len(kbs) == 0 {
// unsupported key type
continue
} else if len(kbs) > 1 {
lggr.Debugf("Multiple on-chain signing keys found for report format %s, using the first", rf.String())
}
kbm[rf] = kbs[0]
}
}
// FIXME: This is a bit confusing because the OCR2 key bundle actually
// includes an EVM on-chain key... but LLO only uses the key bundle for the
// offchain keys and the suppoprted onchain keys are defined in the plugin
// config on the job spec instead.
// https://smartcontract-it.atlassian.net/browse/MERC-3594
lggr.Infof("Using on-chain signing keys for LLO job %d (%s): %v", jb.ID, jb.Name.ValueOrZero(), kbm)
kr := llo.NewOnchainKeyring(lggr, kbm)
ocrLogger := ocrcommon.NewOCRWrapper(lggr, d.cfg.OCR2().TraceLogging(), func(ctx context.Context, msg string) {
lggr.ErrorIf(d.jobORM.RecordError(ctx, jb.ID, msg), "unable to record error")
})
cfg := llo.DelegateConfig{
Logger: lggr,
DataSource: d.ds,
Runner: d.pipelineRunner,
Registry: d.streamRegistry,
JobName: jb.Name,
ChannelDefinitionCache: provider.ChannelDefinitionCache(),
BinaryNetworkEndpointFactory: d.peerWrapper.Peer2,
V2Bootstrappers: bootstrapPeers,
ContractTransmitter: provider.ContractTransmitter(),
ContractConfigTracker: provider.ContractConfigTracker(),
Database: ocrDB,
LocalConfig: lc,
// TODO: Telemetry for llo
// https://smartcontract-it.atlassian.net/browse/MERC-3603
MonitoringEndpoint: nil,
OffchainConfigDigester: provider.OffchainConfigDigester(),
OffchainKeyring: kb,
OnchainKeyring: kr,
OCRLogger: ocrLogger,
}
oracle, err := llo.NewDelegate(cfg)
if err != nil {
return nil, err
}
return []job.ServiceCtx{provider, ocrLogger, oracle}, nil
}
func (d *Delegate) newServicesMedian(
ctx context.Context,
lggr logger.SugaredLogger,
jb job.Job,
bootstrapPeers []commontypes.BootstrapperLocator,
kb ocr2key.KeyBundle,
kvStore job.KVStore,
ocrDB *db,
lc ocrtypes.LocalConfig,
) ([]job.ServiceCtx, error) {
spec := jb.OCR2OracleSpec
rid, err := spec.RelayID()
if err != nil {
return nil, ErrJobSpecNoRelayer{Err: err, PluginName: "median"}
}
ocrLogger := ocrcommon.NewOCRWrapper(lggr, d.cfg.OCR2().TraceLogging(), func(ctx context.Context, msg string) {
lggr.ErrorIf(d.jobORM.RecordError(ctx, jb.ID, msg), "unable to record error")
})
oracleArgsNoPlugin := libocr2.OCR2OracleArgs{
BinaryNetworkEndpointFactory: d.peerWrapper.Peer2,
V2Bootstrappers: bootstrapPeers,
Database: ocrDB,
LocalConfig: lc,
Logger: ocrLogger,
MonitoringEndpoint: d.monitoringEndpointGen.GenMonitoringEndpoint(rid.Network, rid.ChainID, spec.ContractID, synchronization.OCR2Median),
OffchainKeyring: kb,
OnchainKeyring: kb,
MetricsRegisterer: prometheus.WrapRegistererWith(map[string]string{"job_name": jb.Name.ValueOrZero()}, prometheus.DefaultRegisterer),
}
errorLog := &errorLog{jobID: jb.ID, recordError: d.jobORM.RecordError}
enhancedTelemChan := make(chan ocrcommon.EnhancedTelemetryData, 100)
mConfig := median.NewMedianConfig(
d.cfg.JobPipeline().MaxSuccessfulRuns(),
d.cfg.JobPipeline().ResultWriteQueueDepth(),
d.cfg,
)
relayer, err := d.RelayGetter.Get(rid)
if err != nil {
return nil, ErrRelayNotEnabled{Err: err, PluginName: "median", Relay: spec.Relay}
}
medianServices, err2 := median.NewMedianServices(ctx, jb, d.isNewlyCreatedJob, relayer, kvStore, d.pipelineRunner, lggr, oracleArgsNoPlugin, mConfig, enhancedTelemChan, errorLog)