-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
evm.go
582 lines (507 loc) · 19.1 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
package evm
import (
"context"
"encoding/json"
"errors"
"fmt"
"strings"
"sync"
"github.com/ethereum/go-ethereum/accounts/abi"
"github.com/ethereum/go-ethereum/common"
pkgerrors "github.com/pkg/errors"
"github.com/smartcontractkit/libocr/gethwrappers2/ocr2aggregator"
"github.com/smartcontractkit/libocr/offchainreporting2/reportingplugin/median"
"github.com/smartcontractkit/libocr/offchainreporting2/reportingplugin/median/evmreportcodec"
"github.com/smartcontractkit/libocr/offchainreporting2plus/chains/evmutil"
ocrtypes "github.com/smartcontractkit/libocr/offchainreporting2plus/types"
"github.com/smartcontractkit/sqlx"
"go.uber.org/multierr"
"golang.org/x/exp/maps"
relaytypes "github.com/smartcontractkit/chainlink-relay/pkg/types"
txmgrcommon "github.com/smartcontractkit/chainlink/v2/common/txmgr"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm"
txm "github.com/smartcontractkit/chainlink/v2/core/chains/evm/txmgr"
"github.com/smartcontractkit/chainlink/v2/core/logger"
"github.com/smartcontractkit/chainlink/v2/core/services"
"github.com/smartcontractkit/chainlink/v2/core/services/job"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/ethkey"
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/pg"
"github.com/smartcontractkit/chainlink/v2/core/services/pipeline"
"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"
"github.com/smartcontractkit/chainlink/v2/core/utils"
)
var _ relaytypes.Relayer = &Relayer{}
type Relayer struct {
db *sqlx.DB
chain evm.Chain
lggr logger.Logger
ks CSAETHKeystore
mercuryPool wsrpc.Pool
eventBroadcaster pg.EventBroadcaster
pgCfg pg.QConfig
}
type CSAETHKeystore interface {
CSA() keystore.CSA
Eth() keystore.Eth
}
type RelayerOpts struct {
*sqlx.DB
pg.QConfig
CSAETHKeystore
pg.EventBroadcaster
}
func (c RelayerOpts) Validate() error {
var err error
if c.DB == nil {
err = errors.Join(err, errors.New("nil DB"))
}
if c.QConfig == nil {
err = errors.Join(err, errors.New("nil QConfig"))
}
if c.CSAETHKeystore == nil {
err = errors.Join(err, errors.New("nil Keystore"))
}
if c.EventBroadcaster == nil {
err = errors.Join(err, errors.New("nil Eventbroadcaster"))
}
if err != nil {
err = fmt.Errorf("invalid RelayerOpts: %w", err)
}
return err
}
func NewRelayer(lggr logger.Logger, chain evm.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")
return &Relayer{
db: opts.DB,
chain: chain,
lggr: lggr,
ks: opts.CSAETHKeystore,
mercuryPool: wsrpc.NewPool(lggr),
eventBroadcaster: opts.EventBroadcaster,
pgCfg: opts.QConfig,
}, 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 {
return r.mercuryPool.Close()
}
// Ready does noop: always ready
func (r *Relayer) Ready() error {
return r.mercuryPool.Ready()
}
func (r *Relayer) HealthReport() (report map[string]error) {
report = make(map[string]error)
maps.Copy(report, r.mercuryPool.HealthReport())
return
}
func (r *Relayer) NewMercuryProvider(rargs relaytypes.RelayArgs, pargs relaytypes.PluginArgs) (relaytypes.MercuryProvider, error) {
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())
}
configWatcher, err := newConfigProvider(r.lggr, r.chain, relayOpts, r.eventBroadcaster)
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")
}
client, err := r.mercuryPool.Checkout(context.Background(), privKey, mercuryConfig.ServerPubKey, mercuryConfig.ServerURL())
if err != nil {
return nil, err
}
// 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, r.lggr.Named("ReportCodecV1"))
reportCodecV2 := reportcodecv2.NewReportCodec(*relayConfig.FeedID, r.lggr.Named("ReportCodecV2"))
reportCodecV3 := reportcodecv3.NewReportCodec(*relayConfig.FeedID, r.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(r.lggr, configWatcher.ContractConfigTracker(), client, privKey.PublicKey, rargs.JobID, *relayConfig.FeedID, r.db, r.pgCfg, transmitterCodec)
return NewMercuryProvider(configWatcher, transmitter, reportCodecV1, reportCodecV2, reportCodecV3, r.lggr), nil
}
func (r *Relayer) NewFunctionsProvider(rargs relaytypes.RelayArgs, pargs relaytypes.PluginArgs) (relaytypes.FunctionsProvider, error) {
// TODO(FUN-668): Not ready yet (doesn't implement FunctionsEvents() properly)
return NewFunctionsProvider(r.chain, rargs, pargs, r.lggr, r.ks.Eth(), functions.FunctionsPlugin)
}
func (r *Relayer) NewConfigProvider(args relaytypes.RelayArgs) (relaytypes.ConfigProvider, error) {
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())
}
configProvider, err := newConfigProvider(r.lggr, r.chain, relayOpts, r.eventBroadcaster)
if err != nil {
// Never return (*configProvider)(nil)
return nil, err
}
return configProvider, err
}
func FilterNamesFromRelayArgs(args relaytypes.RelayArgs) (filterNames []string, err error) {
var addr ethkey.EIP55Address
if addr, err = ethkey.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 {
utils.StartStopOnce
lggr logger.Logger
contractAddress common.Address
contractABI abi.ABI
offchainDigester ocrtypes.OffchainConfigDigester
configPoller types.ConfigPoller
chain evm.Chain
runReplay bool
fromBlock uint64
replayCtx context.Context
replayCancel context.CancelFunc
wg sync.WaitGroup
}
func newConfigWatcher(lggr logger.Logger,
contractAddress common.Address,
contractABI abi.ABI,
offchainDigester ocrtypes.OffchainConfigDigester,
configPoller types.ConfigPoller,
chain evm.Chain,
fromBlock uint64,
runReplay bool,
) *configWatcher {
replayCtx, replayCancel := context.WithCancel(context.Background())
return &configWatcher{
StartStopOnce: utils.StartStopOnce{},
lggr: lggr,
contractAddress: contractAddress,
contractABI: contractABI,
offchainDigester: offchainDigester,
configPoller: configPoller,
chain: chain,
runReplay: runReplay,
fromBlock: fromBlock,
replayCtx: replayCtx,
replayCancel: replayCancel,
wg: sync.WaitGroup{},
}
}
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()
c.lggr.Infow("starting replay for config", "fromBlock", c.fromBlock)
if err := c.configPoller.Replay(c.replayCtx, int64(c.fromBlock)); err != nil {
c.lggr.Errorf("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 {
c.replayCancel()
c.wg.Wait()
return c.configPoller.Close()
})
}
func (c *configWatcher) HealthReport() map[string]error {
return map[string]error{c.Name(): c.StartStopOnce.Healthy()}
}
func (c *configWatcher) OffchainConfigDigester() ocrtypes.OffchainConfigDigester {
return c.offchainDigester
}
func (c *configWatcher) ContractConfigTracker() ocrtypes.ContractConfigTracker {
return c.configPoller
}
func newConfigProvider(lggr logger.Logger, chain evm.Chain, opts *types.RelayOpts, eventBroadcaster pg.EventBroadcaster) (*configWatcher, error) {
if !common.IsHexAddress(opts.ContractID) {
return nil, pkgerrors.Errorf("invalid contractID, expected hex address")
}
aggregatorAddress := common.HexToAddress(opts.ContractID)
contractABI, err := abi.JSON(strings.NewReader(ocr2aggregator.OCR2AggregatorMetaData.ABI))
if err != nil {
return nil, pkgerrors.Wrap(err, "could not get contract ABI JSON")
}
var cp types.ConfigPoller
relayConfig, err := opts.RelayConfig()
if err != nil {
return nil, fmt.Errorf("failed to get relay config: %w", err)
}
if relayConfig.FeedID != nil {
cp, err = mercury.NewConfigPoller(
lggr,
chain.LogPoller(),
aggregatorAddress,
*relayConfig.FeedID,
eventBroadcaster,
// TODO: Does mercury need to support config contract? DF-19182
)
} else {
cp, err = NewConfigPoller(
lggr,
chain.Client(),
chain.LogPoller(),
aggregatorAddress,
relayConfig.ConfigContractAddress,
)
}
if err != nil {
return nil, err
}
var offchainConfigDigester ocrtypes.OffchainConfigDigester
if relayConfig.FeedID != nil {
// Mercury
offchainConfigDigester = mercury.NewOffchainConfigDigester(*relayConfig.FeedID, chain.Config().EVM().ChainID(), aggregatorAddress)
} else {
// Non-mercury
offchainConfigDigester = evmutil.EVMOffchainConfigDigester{
ChainID: chain.Config().EVM().ChainID().Uint64(),
ContractAddress: aggregatorAddress,
}
}
return newConfigWatcher(lggr, aggregatorAddress, contractABI, offchainConfigDigester, cp, chain, relayConfig.FromBlock, opts.New), nil
}
func newContractTransmitter(lggr logger.Logger, rargs relaytypes.RelayArgs, transmitterID string, configWatcher *configWatcher, ethKeystore keystore.Eth) (*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(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))
}
scoped := configWatcher.chain.Config()
strategy := txmgrcommon.NewQueueingTxStrategy(rargs.ExternalJobID, scoped.OCR2().DefaultTransactionQueueDepth(), scoped.Database().DefaultQueryTimeout())
var checker txm.TransmitCheckerSpec
if configWatcher.chain.Config().OCR2().SimulateTransactions() {
checker.CheckerType = txm.TransmitCheckerTypeSimulate
}
gasLimit := configWatcher.chain.Config().EVM().GasEstimator().LimitDefault()
ocr2Limit := configWatcher.chain.Config().EVM().GasEstimator().LimitJobType().OCR2()
if ocr2Limit != nil {
gasLimit = *ocr2Limit
}
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 NewOCRContractTransmitter(
configWatcher.contractAddress,
configWatcher.chain.Client(),
configWatcher.contractABI,
transmitter,
configWatcher.chain.LogPoller(),
lggr,
nil,
)
}
func newPipelineContractTransmitter(lggr logger.Logger, rargs relaytypes.RelayArgs, transmitterID string, pluginGasLimit *uint32, configWatcher *configWatcher, spec job.Job, pr pipeline.Runner) (*contractTransmitter, error) {
var relayConfig types.RelayConfig
if err := json.Unmarshal(rargs.RelayConfig, &relayConfig); err != nil {
return nil, err
}
if !relayConfig.EffectiveTransmitterID.Valid {
return nil, pkgerrors.New("EffectiveTransmitterID must be specified")
}
effectiveTransmitterAddress := common.HexToAddress(relayConfig.EffectiveTransmitterID.String)
transmitterAddress := common.HexToAddress(transmitterID)
scoped := configWatcher.chain.Config()
strategy := txmgrcommon.NewQueueingTxStrategy(rargs.ExternalJobID, scoped.OCR2().DefaultTransactionQueueDepth(), scoped.Database().DefaultQueryTimeout())
var checker txm.TransmitCheckerSpec
if configWatcher.chain.Config().OCR2().SimulateTransactions() {
checker.CheckerType = txm.TransmitCheckerTypeSimulate
}
gasLimit := configWatcher.chain.Config().EVM().GasEstimator().LimitDefault()
ocr2Limit := configWatcher.chain.Config().EVM().GasEstimator().LimitJobType().OCR2()
if ocr2Limit != nil {
gasLimit = *ocr2Limit
}
if pluginGasLimit != nil {
gasLimit = *pluginGasLimit
}
return NewOCRContractTransmitter(
configWatcher.contractAddress,
configWatcher.chain.Client(),
configWatcher.contractABI,
ocrcommon.NewPipelineTransmitter(
lggr,
transmitterAddress,
gasLimit,
effectiveTransmitterAddress,
strategy,
checker,
pr,
spec,
configWatcher.chain.ID().String(),
),
configWatcher.chain.LogPoller(),
lggr,
nil,
)
}
func (r *Relayer) NewMedianProvider(rargs relaytypes.RelayArgs, pargs relaytypes.PluginArgs) (relaytypes.MedianProvider, error) {
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())
}
configWatcher, err := newConfigProvider(r.lggr, r.chain, relayOpts, r.eventBroadcaster)
if err != nil {
return nil, err
}
reportCodec := evmreportcodec.ReportCodec{}
contractTransmitter, err := newContractTransmitter(r.lggr, rargs, pargs.TransmitterID, configWatcher, r.ks.Eth())
if err != nil {
return nil, err
}
medianContract, err := newMedianContract(configWatcher.ContractConfigTracker(), configWatcher.contractAddress, configWatcher.chain, rargs.JobID, r.db, r.lggr)
if err != nil {
return nil, err
}
return &medianProvider{
configWatcher: configWatcher,
reportCodec: reportCodec,
contractTransmitter: contractTransmitter,
medianContract: medianContract,
}, nil
}
var _ relaytypes.MedianProvider = (*medianProvider)(nil)
type medianProvider struct {
configWatcher *configWatcher
contractTransmitter ContractTransmitter
reportCodec median.ReportCodec
medianContract *medianContract
ms services.MultiStart
}
func (p *medianProvider) Name() string {
return "EVM.MedianProvider"
}
func (p *medianProvider) Start(ctx context.Context) error {
return p.ms.Start(ctx, p.configWatcher, p.contractTransmitter)
}
func (p *medianProvider) Close() error {
return p.ms.Close()
}
func (p *medianProvider) Ready() error {
return multierr.Combine(p.configWatcher.Ready(), p.contractTransmitter.Ready())
}
func (p *medianProvider) HealthReport() map[string]error {
report := p.configWatcher.HealthReport()
maps.Copy(report, p.contractTransmitter.HealthReport())
return report
}
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()
}