-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
evm.go
801 lines (691 loc) · 27.2 KB
/
evm.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
package evm
import (
"context"
"encoding/json"
"errors"
"fmt"
"strings"
"sync"
"time"
"github.com/ethereum/go-ethereum/accounts/abi"
"github.com/ethereum/go-ethereum/common"
"github.com/google/uuid"
pkgerrors "github.com/pkg/errors"
"golang.org/x/exp/maps"
"github.com/smartcontractkit/libocr/gethwrappers2/ocr2aggregator"
"github.com/smartcontractkit/libocr/offchainreporting2/reportingplugin/median"
"github.com/smartcontractkit/libocr/offchainreporting2/reportingplugin/median/evmreportcodec"
ocrtypes "github.com/smartcontractkit/libocr/offchainreporting2plus/types"
ocr3capability "github.com/smartcontractkit/chainlink-common/pkg/capabilities/consensus/ocr3"
"github.com/smartcontractkit/chainlink-common/pkg/capabilities/triggers"
"github.com/smartcontractkit/chainlink-common/pkg/services"
"github.com/smartcontractkit/chainlink-common/pkg/sqlutil"
commontypes "github.com/smartcontractkit/chainlink-common/pkg/types"
coretypes "github.com/smartcontractkit/chainlink-common/pkg/types/core"
txmgrcommon "github.com/smartcontractkit/chainlink/v2/common/txmgr"
txm "github.com/smartcontractkit/chainlink/v2/core/chains/evm/txmgr"
evmtypes "github.com/smartcontractkit/chainlink/v2/core/chains/evm/types"
"github.com/smartcontractkit/chainlink/v2/core/chains/legacyevm"
"github.com/smartcontractkit/chainlink/v2/core/logger"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore"
"github.com/smartcontractkit/chainlink/v2/core/services/llo"
"github.com/smartcontractkit/chainlink/v2/core/services/llo/bm"
lloconfig "github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/llo/config"
mercuryconfig "github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/mercury/config"
"github.com/smartcontractkit/chainlink/v2/core/services/ocrcommon"
"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/functions"
"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury"
mercuryutils "github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/utils"
reportcodecv1 "github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/v1/reportcodec"
reportcodecv2 "github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/v2/reportcodec"
reportcodecv3 "github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/v3/reportcodec"
"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/wsrpc"
"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/types"
)
var (
OCR2AggregatorTransmissionContractABI abi.ABI
OCR2AggregatorLogDecoder LogDecoder
ChannelVerifierLogDecoder LogDecoder
)
func init() {
var err error
OCR2AggregatorTransmissionContractABI, err = abi.JSON(strings.NewReader(ocr2aggregator.OCR2AggregatorMetaData.ABI))
if err != nil {
panic(err)
}
OCR2AggregatorLogDecoder, err = newOCR2AggregatorLogDecoder()
if err != nil {
panic(err)
}
ChannelVerifierLogDecoder, err = newChannelVerifierLogDecoder()
if err != nil {
panic(err)
}
}
var _ commontypes.Relayer = &Relayer{} //nolint:staticcheck
type Relayer struct {
ds sqlutil.DataSource
chain legacyevm.Chain
lggr logger.Logger
ks CSAETHKeystore
mercuryPool wsrpc.Pool
chainReader commontypes.ContractReader
codec commontypes.Codec
capabilitiesRegistry coretypes.CapabilitiesRegistry
// Mercury
mercuryORM mercury.ORM
transmitterCfg mercury.TransmitterConfig
triggerCapability *triggers.MercuryTriggerService
// LLO/data streams
cdcFactory llo.ChannelDefinitionCacheFactory
lloORM llo.ORM
}
type CSAETHKeystore interface {
CSA() keystore.CSA
Eth() keystore.Eth
}
type RelayerOpts struct {
DS sqlutil.DataSource
CSAETHKeystore
MercuryPool wsrpc.Pool
TransmitterConfig mercury.TransmitterConfig
CapabilitiesRegistry coretypes.CapabilitiesRegistry
}
func (c RelayerOpts) Validate() error {
var err error
if c.DS == nil {
err = errors.Join(err, errors.New("nil DataSource"))
}
if c.CSAETHKeystore == nil {
err = errors.Join(err, errors.New("nil Keystore"))
}
if c.CapabilitiesRegistry == nil {
err = errors.Join(err, errors.New("nil CapabilitiesRegistry"))
}
if err != nil {
err = fmt.Errorf("invalid RelayerOpts: %w", err)
}
return err
}
func NewRelayer(lggr logger.Logger, chain legacyevm.Chain, opts RelayerOpts) (*Relayer, error) {
err := opts.Validate()
if err != nil {
return nil, fmt.Errorf("cannot create evm relayer: %w", err)
}
lggr = lggr.Named("Relayer")
mercuryORM := mercury.NewORM(opts.DS)
lloORM := llo.NewORM(opts.DS, chain.ID())
cdcFactory := llo.NewChannelDefinitionCacheFactory(lggr, lloORM, chain.LogPoller())
relayer := &Relayer{
ds: opts.DS,
chain: chain,
lggr: lggr,
ks: opts.CSAETHKeystore,
mercuryPool: opts.MercuryPool,
cdcFactory: cdcFactory,
lloORM: lloORM,
mercuryORM: mercuryORM,
transmitterCfg: opts.TransmitterConfig,
capabilitiesRegistry: opts.CapabilitiesRegistry,
}
// Initialize write target capability if configuration is defined
if chain.Config().EVM().Workflow().ForwarderAddress() != nil {
ctx := context.Background()
capability, err := NewWriteTarget(ctx, relayer, chain, lggr)
if err != nil {
return nil, fmt.Errorf("failed to initialize write target: %w", err)
}
if err := relayer.capabilitiesRegistry.Add(ctx, capability); err != nil {
return nil, err
}
lggr.Infow("Registered write target", "chain_id", chain.ID())
}
return relayer, nil
}
func (r *Relayer) Name() string {
return r.lggr.Name()
}
// Start does noop: no subservices started on relay start, but when the first job is started
func (r *Relayer) Start(context.Context) error {
return nil
}
func (r *Relayer) Close() error {
if r.triggerCapability != nil {
return r.triggerCapability.Close()
}
return nil
}
// Ready does noop: always ready
func (r *Relayer) Ready() error {
return r.chain.Ready()
}
func (r *Relayer) HealthReport() (report map[string]error) {
report = make(map[string]error)
maps.Copy(report, r.chain.HealthReport())
return
}
func (r *Relayer) NewOCR3CapabilityProvider(rargs commontypes.RelayArgs, pargs commontypes.PluginArgs) (commontypes.OCR3CapabilityProvider, error) {
pp, err := r.NewPluginProvider(rargs, pargs)
if err != nil {
return nil, err
}
fromAccount, err := pp.ContractTransmitter().FromAccount()
if err != nil {
return nil, err
}
return &ocr3CapabilityProvider{
PluginProvider: pp,
transmitter: ocr3capability.NewContractTransmitter(r.lggr, r.capabilitiesRegistry, string(fromAccount)),
}, nil
}
func (r *Relayer) NewPluginProvider(rargs commontypes.RelayArgs, pargs commontypes.PluginArgs) (commontypes.PluginProvider, error) {
// TODO https://smartcontract-it.atlassian.net/browse/BCF-2887
ctx := context.Background()
lggr := r.lggr.Named("PluginProvider").Named(rargs.ExternalJobID.String())
configWatcher, err := newStandardConfigProvider(ctx, r.lggr, r.chain, types.NewRelayOpts(rargs))
if err != nil {
return nil, err
}
transmitter, err := newOnChainContractTransmitter(ctx, r.lggr, rargs, pargs.TransmitterID, r.ks.Eth(), configWatcher, configTransmitterOpts{}, OCR2AggregatorTransmissionContractABI, 0)
if err != nil {
return nil, err
}
return NewPluginProvider(
r.chainReader,
r.codec,
transmitter,
configWatcher,
lggr,
), nil
}
func (r *Relayer) NewMercuryProvider(rargs commontypes.RelayArgs, pargs commontypes.PluginArgs) (commontypes.MercuryProvider, error) {
// TODO https://smartcontract-it.atlassian.net/browse/BCF-2887
ctx := context.Background()
lggr := r.lggr.Named("MercuryProvider").Named(rargs.ExternalJobID.String())
relayOpts := types.NewRelayOpts(rargs)
relayConfig, err := relayOpts.RelayConfig()
if err != nil {
return nil, fmt.Errorf("failed to get relay config: %w", err)
}
var mercuryConfig mercuryconfig.PluginConfig
if err = json.Unmarshal(pargs.PluginConfig, &mercuryConfig); err != nil {
return nil, pkgerrors.WithStack(err)
}
if relayConfig.FeedID == nil {
return nil, pkgerrors.New("FeedID must be specified")
}
feedID := mercuryutils.FeedID(*relayConfig.FeedID)
if relayConfig.ChainID.String() != r.chain.ID().String() {
return nil, fmt.Errorf("internal error: chain id in spec does not match this relayer's chain: have %s expected %s", relayConfig.ChainID.String(), r.chain.ID().String())
}
cp, err := newMercuryConfigProvider(ctx, lggr, r.chain, relayOpts)
if err != nil {
return nil, pkgerrors.WithStack(err)
}
if !relayConfig.EffectiveTransmitterID.Valid {
return nil, pkgerrors.New("EffectiveTransmitterID must be specified")
}
privKey, err := r.ks.CSA().Get(relayConfig.EffectiveTransmitterID.String)
if err != nil {
return nil, pkgerrors.Wrap(err, "failed to get CSA key for mercury connection")
}
clients := make(map[string]wsrpc.Client)
for _, server := range mercuryConfig.GetServers() {
client, err := r.mercuryPool.Checkout(context.Background(), privKey, server.PubKey, server.URL)
if err != nil {
return nil, err
}
clients[server.URL] = client
}
// initialize trigger capability service lazily
if relayConfig.EnableTriggerCapability && r.triggerCapability == nil {
if r.capabilitiesRegistry == nil {
lggr.Errorw("trigger capability is enabled but capabilities registry is not set")
} else {
r.triggerCapability = triggers.NewMercuryTriggerService(0, lggr)
if err := r.triggerCapability.Start(ctx); err != nil {
return nil, err
}
if err := r.capabilitiesRegistry.Add(ctx, r.triggerCapability); err != nil {
return nil, err
}
lggr.Infow("successfully added trigger service to the Registry")
}
}
// FIXME: We actually know the version here since it's in the feed ID, can
// we use generics to avoid passing three of this?
// https://smartcontract-it.atlassian.net/browse/MERC-1414
reportCodecV1 := reportcodecv1.NewReportCodec(*relayConfig.FeedID, lggr.Named("ReportCodecV1"))
reportCodecV2 := reportcodecv2.NewReportCodec(*relayConfig.FeedID, lggr.Named("ReportCodecV2"))
reportCodecV3 := reportcodecv3.NewReportCodec(*relayConfig.FeedID, lggr.Named("ReportCodecV3"))
var transmitterCodec mercury.TransmitterReportDecoder
switch feedID.Version() {
case 1:
transmitterCodec = reportCodecV1
case 2:
transmitterCodec = reportCodecV2
case 3:
transmitterCodec = reportCodecV3
default:
return nil, fmt.Errorf("invalid feed version %d", feedID.Version())
}
transmitter := mercury.NewTransmitter(lggr, r.transmitterCfg, clients, privKey.PublicKey, rargs.JobID, *relayConfig.FeedID, r.mercuryORM, transmitterCodec, r.triggerCapability)
return NewMercuryProvider(cp, r.chainReader, r.codec, NewMercuryChainReader(r.chain.HeadTracker()), transmitter, reportCodecV1, reportCodecV2, reportCodecV3, lggr), nil
}
func (r *Relayer) NewLLOProvider(rargs commontypes.RelayArgs, pargs commontypes.PluginArgs) (commontypes.LLOProvider, error) {
// TODO https://smartcontract-it.atlassian.net/browse/BCF-2887
ctx := context.Background()
relayOpts := types.NewRelayOpts(rargs)
var relayConfig types.RelayConfig
{
var err error
relayConfig, err = relayOpts.RelayConfig()
if err != nil {
return nil, fmt.Errorf("failed to get relay config: %w", err)
}
}
var lloCfg lloconfig.PluginConfig
if err := json.Unmarshal(pargs.PluginConfig, &lloCfg); err != nil {
return nil, pkgerrors.WithStack(err)
}
if err := lloCfg.Validate(); err != nil {
return nil, err
}
if relayConfig.ChainID.String() != r.chain.ID().String() {
return nil, fmt.Errorf("internal error: chain id in spec does not match this relayer's chain: have %s expected %s", relayConfig.ChainID.String(), r.chain.ID().String())
}
cp, err := newLLOConfigProvider(ctx, r.lggr, r.chain, relayOpts)
if err != nil {
return nil, pkgerrors.WithStack(err)
}
if !relayConfig.EffectiveTransmitterID.Valid {
return nil, pkgerrors.New("EffectiveTransmitterID must be specified")
}
privKey, err := r.ks.CSA().Get(relayConfig.EffectiveTransmitterID.String)
if err != nil {
return nil, pkgerrors.Wrap(err, "failed to get CSA key for mercury connection")
}
// FIXME: Remove after benchmarking is done
// https://smartcontract-it.atlassian.net/browse/MERC-3487
var transmitter llo.Transmitter
if lloCfg.BenchmarkMode {
r.lggr.Info("Benchmark mode enabled, using dummy transmitter. NOTE: THIS WILL NOT TRANSMIT ANYTHING")
transmitter = bm.NewTransmitter(r.lggr, fmt.Sprintf("%x", privKey.PublicKey))
} else {
var client wsrpc.Client
client, err = r.mercuryPool.Checkout(context.Background(), privKey, lloCfg.ServerPubKey, lloCfg.ServerURL())
if err != nil {
return nil, err
}
transmitter = llo.NewTransmitter(r.lggr, client, privKey.PublicKey)
}
cdc, err := r.cdcFactory.NewCache(lloCfg)
if err != nil {
return nil, err
}
return NewLLOProvider(cp, transmitter, r.lggr, cdc), nil
}
func (r *Relayer) NewFunctionsProvider(rargs commontypes.RelayArgs, pargs commontypes.PluginArgs) (commontypes.FunctionsProvider, error) {
// TODO https://smartcontract-it.atlassian.net/browse/BCF-2887
ctx := context.Background()
lggr := r.lggr.Named("FunctionsProvider").Named(rargs.ExternalJobID.String())
// TODO(FUN-668): Not ready yet (doesn't implement FunctionsEvents() properly)
return NewFunctionsProvider(ctx, r.chain, rargs, pargs, lggr, r.ks.Eth(), functions.FunctionsPlugin)
}
// NewConfigProvider is called by bootstrap jobs
func (r *Relayer) NewConfigProvider(args commontypes.RelayArgs) (configProvider commontypes.ConfigProvider, err error) {
// TODO https://smartcontract-it.atlassian.net/browse/BCF-2887
ctx := context.Background()
lggr := r.lggr.Named("ConfigProvider").Named(args.ExternalJobID.String())
relayOpts := types.NewRelayOpts(args)
relayConfig, err := relayOpts.RelayConfig()
if err != nil {
return nil, fmt.Errorf("failed to get relay config: %w", err)
}
expectedChainID := relayConfig.ChainID.String()
if expectedChainID != r.chain.ID().String() {
return nil, fmt.Errorf("internal error: chain id in spec does not match this relayer's chain: have %s expected %s", relayConfig.ChainID.String(), r.chain.ID().String())
}
// Handle legacy jobs which did not yet specify provider type and
// switched between median/mercury based on presence of feed ID
if args.ProviderType == "" {
if relayConfig.FeedID == nil {
args.ProviderType = "median"
} else {
args.ProviderType = "mercury"
}
}
switch args.ProviderType {
case "median":
configProvider, err = newStandardConfigProvider(ctx, lggr, r.chain, relayOpts)
case "mercury":
configProvider, err = newMercuryConfigProvider(ctx, lggr, r.chain, relayOpts)
case "llo":
configProvider, err = newLLOConfigProvider(ctx, lggr, r.chain, relayOpts)
default:
return nil, fmt.Errorf("unrecognized provider type: %q", args.ProviderType)
}
if err != nil {
// Never return (*configProvider)(nil)
return nil, err
}
return configProvider, err
}
func FilterNamesFromRelayArgs(args commontypes.RelayArgs) (filterNames []string, err error) {
var addr evmtypes.EIP55Address
if addr, err = evmtypes.NewEIP55Address(args.ContractID); err != nil {
return nil, err
}
var relayConfig types.RelayConfig
if err = json.Unmarshal(args.RelayConfig, &relayConfig); err != nil {
return nil, pkgerrors.WithStack(err)
}
if relayConfig.FeedID != nil {
filterNames = []string{mercury.FilterName(addr.Address(), *relayConfig.FeedID)}
} else {
filterNames = []string{configPollerFilterName(addr.Address()), transmitterFilterName(addr.Address())}
}
return filterNames, err
}
type configWatcher struct {
services.StateMachine
lggr logger.Logger
contractAddress common.Address
offchainDigester ocrtypes.OffchainConfigDigester
configPoller types.ConfigPoller
chain legacyevm.Chain
runReplay bool
fromBlock uint64
stopCh services.StopChan
wg sync.WaitGroup
}
func newConfigWatcher(lggr logger.Logger,
contractAddress common.Address,
offchainDigester ocrtypes.OffchainConfigDigester,
configPoller types.ConfigPoller,
chain legacyevm.Chain,
fromBlock uint64,
runReplay bool,
) *configWatcher {
return &configWatcher{
lggr: lggr.Named("ConfigWatcher").Named(contractAddress.String()),
contractAddress: contractAddress,
offchainDigester: offchainDigester,
configPoller: configPoller,
chain: chain,
runReplay: runReplay,
fromBlock: fromBlock,
stopCh: make(chan struct{}),
}
}
func (c *configWatcher) Name() string {
return c.lggr.Name()
}
func (c *configWatcher) Start(ctx context.Context) error {
return c.StartOnce(fmt.Sprintf("configWatcher %x", c.contractAddress), func() error {
if c.runReplay && c.fromBlock != 0 {
// Only replay if it's a brand runReplay job.
c.wg.Add(1)
go func() {
defer c.wg.Done()
ctx, cancel := c.stopCh.NewCtx()
defer cancel()
c.lggr.Infow("starting replay for config", "fromBlock", c.fromBlock)
if err := c.configPoller.Replay(ctx, int64(c.fromBlock)); err != nil {
c.lggr.Errorw("error replaying for config", "err", err)
} else {
c.lggr.Infow("completed replaying for config", "fromBlock", c.fromBlock)
}
}()
}
c.configPoller.Start()
return nil
})
}
func (c *configWatcher) Close() error {
return c.StopOnce(fmt.Sprintf("configWatcher %x", c.contractAddress), func() error {
close(c.stopCh)
c.wg.Wait()
return c.configPoller.Close()
})
}
func (c *configWatcher) HealthReport() map[string]error {
return map[string]error{c.Name(): c.Healthy()}
}
func (c *configWatcher) OffchainConfigDigester() ocrtypes.OffchainConfigDigester {
return c.offchainDigester
}
func (c *configWatcher) ContractConfigTracker() ocrtypes.ContractConfigTracker {
return c.configPoller
}
type configTransmitterOpts struct {
// pluginGasLimit overrides the gas limit default provided in the config watcher.
pluginGasLimit *uint32
// subjectID overrides the queueing subject id (the job external id will be used by default).
subjectID *uuid.UUID
}
// newOnChainContractTransmitter creates a new contract transmitter.
func newOnChainContractTransmitter(ctx context.Context, lggr logger.Logger, rargs commontypes.RelayArgs, transmitterID string, ethKeystore keystore.Eth, configWatcher *configWatcher, opts configTransmitterOpts, transmissionContractABI abi.ABI, transmissionContractRetention time.Duration) (*contractTransmitter, error) {
var relayConfig types.RelayConfig
if err := json.Unmarshal(rargs.RelayConfig, &relayConfig); err != nil {
return nil, err
}
var fromAddresses []common.Address
sendingKeys := relayConfig.SendingKeys
if !relayConfig.EffectiveTransmitterID.Valid {
return nil, pkgerrors.New("EffectiveTransmitterID must be specified")
}
effectiveTransmitterAddress := common.HexToAddress(relayConfig.EffectiveTransmitterID.String)
sendingKeysLength := len(sendingKeys)
if sendingKeysLength == 0 {
return nil, pkgerrors.New("no sending keys provided")
}
// If we are using multiple sending keys, then a forwarder is needed to rotate transmissions.
// Ensure that this forwarder is not set to a local sending key, and ensure our sending keys are enabled.
for _, s := range sendingKeys {
if sendingKeysLength > 1 && s == effectiveTransmitterAddress.String() {
return nil, pkgerrors.New("the transmitter is a local sending key with transaction forwarding enabled")
}
if err := ethKeystore.CheckEnabled(ctx, common.HexToAddress(s), configWatcher.chain.Config().EVM().ChainID()); err != nil {
return nil, pkgerrors.Wrap(err, "one of the sending keys given is not enabled")
}
fromAddresses = append(fromAddresses, common.HexToAddress(s))
}
subject := rargs.ExternalJobID
if opts.subjectID != nil {
subject = *opts.subjectID
}
strategy := txmgrcommon.NewQueueingTxStrategy(subject, relayConfig.DefaultTransactionQueueDepth)
var checker txm.TransmitCheckerSpec
if relayConfig.SimulateTransactions {
checker.CheckerType = txm.TransmitCheckerTypeSimulate
}
gasLimit := configWatcher.chain.Config().EVM().GasEstimator().LimitDefault()
ocr2Limit := configWatcher.chain.Config().EVM().GasEstimator().LimitJobType().OCR2()
if ocr2Limit != nil {
gasLimit = uint64(*ocr2Limit)
}
if opts.pluginGasLimit != nil {
gasLimit = uint64(*opts.pluginGasLimit)
}
var transmitter Transmitter
var err error
switch commontypes.OCR2PluginType(rargs.ProviderType) {
case commontypes.Median:
transmitter, err = ocrcommon.NewOCR2FeedsTransmitter(
configWatcher.chain.TxManager(),
fromAddresses,
common.HexToAddress(rargs.ContractID),
gasLimit,
effectiveTransmitterAddress,
strategy,
checker,
configWatcher.chain.ID(),
ethKeystore,
)
default:
transmitter, err = ocrcommon.NewTransmitter(
configWatcher.chain.TxManager(),
fromAddresses,
gasLimit,
effectiveTransmitterAddress,
strategy,
checker,
configWatcher.chain.ID(),
ethKeystore,
)
}
if err != nil {
return nil, pkgerrors.Wrap(err, "failed to create transmitter")
}
return NewOCRContractTransmitterWithRetention(
ctx,
configWatcher.contractAddress,
configWatcher.chain.Client(),
transmissionContractABI,
transmitter,
configWatcher.chain.LogPoller(),
lggr,
nil,
transmissionContractRetention,
)
}
func (r *Relayer) NewChainWriter(_ context.Context, config []byte) (commontypes.ChainWriter, error) {
var cfg types.ChainWriterConfig
if err := json.Unmarshal(config, &cfg); err != nil {
return nil, fmt.Errorf("failed to unmarshall chain writer config err: %s", err)
}
return NewChainWriterService(r.lggr, r.chain.Client(), r.chain.TxManager(), r.chain.GasEstimator(), cfg)
}
func (r *Relayer) NewContractReader(chainReaderConfig []byte) (commontypes.ContractReader, error) {
ctx := context.Background()
cfg := &types.ChainReaderConfig{}
if err := json.Unmarshal(chainReaderConfig, cfg); err != nil {
return nil, fmt.Errorf("failed to unmarshall chain reader config err: %s", err)
}
return NewChainReaderService(ctx, r.lggr, r.chain.LogPoller(), r.chain.Client(), *cfg)
}
func (r *Relayer) NewMedianProvider(rargs commontypes.RelayArgs, pargs commontypes.PluginArgs) (commontypes.MedianProvider, error) {
// TODO https://smartcontract-it.atlassian.net/browse/BCF-2887
ctx := context.Background()
lggr := r.lggr.Named("MedianProvider").Named(rargs.ExternalJobID.String())
relayOpts := types.NewRelayOpts(rargs)
relayConfig, err := relayOpts.RelayConfig()
if err != nil {
return nil, fmt.Errorf("failed to get relay config: %w", err)
}
expectedChainID := relayConfig.ChainID.String()
if expectedChainID != r.chain.ID().String() {
return nil, fmt.Errorf("internal error: chain id in spec does not match this relayer's chain: have %s expected %s", relayConfig.ChainID.String(), r.chain.ID().String())
}
if !common.IsHexAddress(relayOpts.ContractID) {
return nil, fmt.Errorf("invalid contractID %s, expected hex address", relayOpts.ContractID)
}
contractID := common.HexToAddress(relayOpts.ContractID)
configWatcher, err := newStandardConfigProvider(ctx, lggr, r.chain, relayOpts)
if err != nil {
return nil, err
}
reportCodec := evmreportcodec.ReportCodec{}
contractTransmitter, err := newOnChainContractTransmitter(ctx, lggr, rargs, pargs.TransmitterID, r.ks.Eth(), configWatcher, configTransmitterOpts{}, OCR2AggregatorTransmissionContractABI, 0)
if err != nil {
return nil, err
}
medianContract, err := newMedianContract(configWatcher.ContractConfigTracker(), configWatcher.contractAddress, configWatcher.chain, rargs.JobID, r.ds, lggr)
if err != nil {
return nil, err
}
medianProvider := medianProvider{
lggr: lggr.Named("MedianProvider"),
configWatcher: configWatcher,
reportCodec: reportCodec,
contractTransmitter: contractTransmitter,
medianContract: medianContract,
}
// allow fallback until chain reader is default and median contract is removed, but still log just in case
var chainReaderService ChainReaderService
if relayConfig.ChainReader != nil {
if chainReaderService, err = NewChainReaderService(ctx, lggr, r.chain.LogPoller(), r.chain.Client(), *relayConfig.ChainReader); err != nil {
return nil, err
}
boundContracts := []commontypes.BoundContract{{Name: "median", Pending: true, Address: contractID.String()}}
if err = chainReaderService.Bind(context.Background(), boundContracts); err != nil {
return nil, err
}
} else {
lggr.Info("ChainReader missing from RelayConfig; falling back to internal MedianContract")
}
medianProvider.chainReader = chainReaderService
if relayConfig.Codec != nil {
medianProvider.codec, err = NewCodec(*relayConfig.Codec)
if err != nil {
return nil, err
}
} else {
lggr.Info("Codec missing from RelayConfig; falling back to internal MedianContract")
}
return &medianProvider, nil
}
func (r *Relayer) NewAutomationProvider(rargs commontypes.RelayArgs, pargs commontypes.PluginArgs) (commontypes.AutomationProvider, error) {
lggr := r.lggr.Named("AutomationProvider").Named(rargs.ExternalJobID.String())
ocr2keeperRelayer := NewOCR2KeeperRelayer(r.ds, r.chain, lggr.Named("OCR2KeeperRelayer"), r.ks.Eth())
return ocr2keeperRelayer.NewOCR2KeeperProvider(rargs, pargs)
}
func (r *Relayer) NewCCIPCommitProvider(_ commontypes.RelayArgs, _ commontypes.PluginArgs) (commontypes.CCIPCommitProvider, error) {
return nil, errors.New("ccip.commit is not supported for evm")
}
func (r *Relayer) NewCCIPExecProvider(_ commontypes.RelayArgs, _ commontypes.PluginArgs) (commontypes.CCIPExecProvider, error) {
return nil, errors.New("ccip.exec is not supported for evm")
}
var _ commontypes.MedianProvider = (*medianProvider)(nil)
type medianProvider struct {
lggr logger.Logger
configWatcher *configWatcher
contractTransmitter ContractTransmitter
reportCodec median.ReportCodec
medianContract *medianContract
chainReader ChainReaderService
codec commontypes.Codec
ms services.MultiStart
}
func (p *medianProvider) Name() string { return p.lggr.Name() }
func (p *medianProvider) Start(ctx context.Context) error {
srvcs := []services.StartClose{p.configWatcher, p.contractTransmitter, p.medianContract}
if p.chainReader != nil {
srvcs = append(srvcs, p.chainReader)
}
return p.ms.Start(ctx, srvcs...)
}
func (p *medianProvider) Close() error { return p.ms.Close() }
func (p *medianProvider) Ready() error { return nil }
func (p *medianProvider) HealthReport() map[string]error {
hp := map[string]error{p.Name(): p.Ready()}
services.CopyHealth(hp, p.configWatcher.HealthReport())
services.CopyHealth(hp, p.contractTransmitter.HealthReport())
services.CopyHealth(hp, p.medianContract.HealthReport())
return hp
}
func (p *medianProvider) ContractTransmitter() ocrtypes.ContractTransmitter {
return p.contractTransmitter
}
func (p *medianProvider) ReportCodec() median.ReportCodec {
return p.reportCodec
}
func (p *medianProvider) MedianContract() median.MedianContract {
return p.medianContract
}
func (p *medianProvider) OnchainConfigCodec() median.OnchainConfigCodec {
return median.StandardOnchainConfigCodec{}
}
func (p *medianProvider) OffchainConfigDigester() ocrtypes.OffchainConfigDigester {
return p.configWatcher.OffchainConfigDigester()
}
func (p *medianProvider) ContractConfigTracker() ocrtypes.ContractConfigTracker {
return p.configWatcher.ContractConfigTracker()
}
func (p *medianProvider) ChainReader() commontypes.ContractReader {
return p.chainReader
}
func (p *medianProvider) Codec() commontypes.Codec {
return p.codec
}