-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
delegate.go
337 lines (298 loc) · 12.4 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
package ocr
import (
"context"
"fmt"
"strings"
"time"
"github.com/ethereum/go-ethereum/accounts/abi"
"github.com/ethereum/go-ethereum/common"
"github.com/pkg/errors"
"github.com/smartcontractkit/libocr/gethwrappers/offchainaggregator"
ocr "github.com/smartcontractkit/libocr/offchainreporting"
ocrtypes "github.com/smartcontractkit/libocr/offchainreporting/types"
"github.com/smartcontractkit/chainlink-common/pkg/sqlutil"
"github.com/smartcontractkit/chainlink-common/pkg/utils/mailbox"
txmgrcommon "github.com/smartcontractkit/chainlink/v2/common/txmgr"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/txmgr"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/types"
"github.com/smartcontractkit/chainlink/v2/core/chains/legacyevm"
"github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/offchain_aggregator_wrapper"
"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/ocrcommon"
"github.com/smartcontractkit/chainlink/v2/core/services/pipeline"
"github.com/smartcontractkit/chainlink/v2/core/services/synchronization"
"github.com/smartcontractkit/chainlink/v2/core/services/telemetry"
"github.com/smartcontractkit/chainlink/v2/core/utils"
)
type Delegate struct {
ds sqlutil.DataSource
jobORM job.ORM
keyStore keystore.Master
pipelineRunner pipeline.Runner
peerWrapper *ocrcommon.SingletonPeerWrapper
monitoringEndpointGen telemetry.MonitoringEndpointGenerator
legacyChains legacyevm.LegacyChainContainer
lggr logger.Logger
cfg Config
mailMon *mailbox.Monitor
}
var _ job.Delegate = (*Delegate)(nil)
const ConfigOverriderPollInterval = 30 * time.Second
func NewDelegate(
ds sqlutil.DataSource,
jobORM job.ORM,
keyStore keystore.Master,
pipelineRunner pipeline.Runner,
peerWrapper *ocrcommon.SingletonPeerWrapper,
monitoringEndpointGen telemetry.MonitoringEndpointGenerator,
legacyChains legacyevm.LegacyChainContainer,
lggr logger.Logger,
cfg Config,
mailMon *mailbox.Monitor,
) *Delegate {
return &Delegate{
ds: ds,
jobORM: jobORM,
keyStore: keyStore,
pipelineRunner: pipelineRunner,
peerWrapper: peerWrapper,
monitoringEndpointGen: monitoringEndpointGen,
legacyChains: legacyChains,
lggr: lggr.Named("OCR"),
cfg: cfg,
mailMon: mailMon,
}
}
func (d *Delegate) JobType() job.Type {
return job.OffchainReporting
}
func (d *Delegate) BeforeJobCreated(spec job.Job) {}
func (d *Delegate) AfterJobCreated(spec job.Job) {}
func (d *Delegate) BeforeJobDeleted(spec job.Job) {}
func (d *Delegate) OnDeleteJob(context.Context, job.Job) error { return nil }
// ServicesForSpec returns the OCR services that need to run for this job
func (d *Delegate) ServicesForSpec(ctx context.Context, jb job.Job) (services []job.ServiceCtx, err error) {
if jb.OCROracleSpec == nil {
return nil, errors.Errorf("offchainreporting.Delegate expects an *job.OffchainreportingOracleSpec to be present, got %v", jb)
}
chain, err := d.legacyChains.Get(jb.OCROracleSpec.EVMChainID.String())
if err != nil {
return nil, err
}
concreteSpec, err := job.LoadConfigVarsOCR(chain.Config().EVM().OCR(), d.cfg.OCR(), *jb.OCROracleSpec)
if err != nil {
return nil, err
}
lggr := d.lggr.With(
"contractAddress", concreteSpec.ContractAddress,
"jobName", jb.Name.ValueOrZero(),
"jobID", jb.ID,
"externalJobID", jb.ExternalJobID)
contract, err := offchain_aggregator_wrapper.NewOffchainAggregator(concreteSpec.ContractAddress.Address(), chain.Client())
if err != nil {
return nil, errors.Wrap(err, "could not instantiate NewOffchainAggregator")
}
contractFilterer, err := offchainaggregator.NewOffchainAggregatorFilterer(concreteSpec.ContractAddress.Address(), chain.Client())
if err != nil {
return nil, errors.Wrap(err, "could not instantiate NewOffchainAggregatorFilterer")
}
contractCaller, err := offchainaggregator.NewOffchainAggregatorCaller(concreteSpec.ContractAddress.Address(), chain.Client())
if err != nil {
return nil, errors.Wrap(err, "could not instantiate NewOffchainAggregatorCaller")
}
ocrDB := NewDB(d.ds, concreteSpec.ID, lggr)
tracker := NewOCRContractTracker(
contract,
contractFilterer,
contractCaller,
chain.Client(),
chain.LogBroadcaster(),
jb.ID,
lggr,
d.ds,
ocrDB,
chain.Config().EVM(),
chain.HeadBroadcaster(),
d.mailMon,
)
services = append(services, tracker)
peerWrapper := d.peerWrapper
if peerWrapper == nil {
return nil, errors.New("cannot setup OCR job service, libp2p peer was missing")
} else if !peerWrapper.IsStarted() {
return nil, errors.New("peerWrapper is not started. OCR jobs require a started and running p2p peer")
}
v2Bootstrappers, err := ocrcommon.ParseBootstrapPeers(concreteSpec.P2PV2Bootstrappers)
if err != nil {
return nil, err
} else if len(v2Bootstrappers) == 0 {
// ParseBootstrapPeers() does not distinguish between no p2pv2Bootstrappers field
// present in job spec, and p2pv2Bootstrappers = []. So even if an empty list is
// passed explicitly, this will still fall back to using the V2 bootstappers defined
// in P2P.V2.DefaultBootstrappers config var. Only a non-empty list will override the default list.
v2Bootstrappers = peerWrapper.P2PConfig().V2().DefaultBootstrappers()
}
ocrLogger := ocrcommon.NewOCRWrapper(lggr, d.cfg.OCR().TraceLogging(), func(ctx context.Context, msg string) {
d.jobORM.TryRecordError(ctx, jb.ID, msg)
})
services = append(services, ocrLogger)
lc := toLocalConfig(chain.Config().EVM(), chain.Config().EVM().OCR(), d.cfg.Insecure(), *concreteSpec, d.cfg.OCR())
if err = ocr.SanityCheckLocalConfig(lc); err != nil {
return nil, err
}
lggr.Info(fmt.Sprintf("OCR job using local config %+v", lc))
if concreteSpec.IsBootstrapPeer {
var bootstrapper *ocr.BootstrapNode
bootstrapper, err = ocr.NewBootstrapNode(ocr.BootstrapNodeArgs{
BootstrapperFactory: peerWrapper.Peer1,
V2Bootstrappers: v2Bootstrappers,
ContractConfigTracker: tracker,
Database: ocrDB,
LocalConfig: lc,
Logger: ocrLogger,
})
if err != nil {
return nil, errors.Wrap(err, "error calling NewBootstrapNode")
}
bootstrapperCtx := job.NewServiceAdapter(bootstrapper)
services = append(services, bootstrapperCtx)
} else {
// p2pv2Bootstrappers must be defined either in node config or in job spec
if len(v2Bootstrappers) < 1 {
return nil, errors.New("Need at least one v2 bootstrap peer defined")
}
ocrkey, err := d.keyStore.OCR().Get(concreteSpec.EncryptedOCRKeyBundleID.String())
if err != nil {
return nil, err
}
contractABI, err := abi.JSON(strings.NewReader(offchainaggregator.OffchainAggregatorABI))
if err != nil {
return nil, errors.Wrap(err, "could not get contract ABI JSON")
}
strategy := txmgrcommon.NewQueueingTxStrategy(jb.ExternalJobID, d.cfg.OCR().DefaultTransactionQueueDepth())
var checker txmgr.TransmitCheckerSpec
if d.cfg.OCR().SimulateTransactions() {
checker.CheckerType = txmgr.TransmitCheckerTypeSimulate
}
if concreteSpec.TransmitterAddress == nil {
return nil, errors.New("TransmitterAddress is missing")
}
var jsGasLimit *uint32
if jb.GasLimit.Valid {
jsGasLimit = &jb.GasLimit.Uint32
}
gasLimit := pipeline.SelectGasLimit(chain.Config().EVM().GasEstimator(), jb.Type.String(), jsGasLimit)
// effectiveTransmitterAddress 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.
effectiveTransmitterAddress := concreteSpec.TransmitterAddress.Address()
if jb.ForwardingAllowed {
fwdrAddress, fwderr := chain.TxManager().GetForwarderForEOA(ctx, effectiveTransmitterAddress)
if fwderr == nil {
effectiveTransmitterAddress = fwdrAddress
} else {
lggr.Warnw("Skipping forwarding for job, will fallback to default behavior", "job", jb.Name, "err", fwderr)
}
}
transmitter, err := ocrcommon.NewTransmitter(
chain.TxManager(),
[]common.Address{concreteSpec.TransmitterAddress.Address()},
gasLimit,
effectiveTransmitterAddress,
strategy,
checker,
chain.ID(),
d.keyStore.Eth(),
)
if err != nil {
return nil, errors.Wrap(err, "failed to create transmitter")
}
contractTransmitter := NewOCRContractTransmitter(
concreteSpec.ContractAddress.Address(),
contractCaller,
contractABI,
transmitter,
chain.LogBroadcaster(),
tracker,
chain.ID(),
effectiveTransmitterAddress,
)
saver := ocrcommon.NewResultRunSaver(
d.pipelineRunner,
lggr,
d.cfg.JobPipeline().MaxSuccessfulRuns(),
d.cfg.JobPipeline().ResultWriteQueueDepth(),
)
var configOverrider ocrtypes.ConfigOverrider
configOverriderService, err := d.maybeCreateConfigOverrider(lggr, chain, concreteSpec.ContractAddress)
if err != nil {
return nil, errors.Wrap(err, "Failed to create ConfigOverrider")
}
// NOTE: conditional assigning to `configOverrider` is necessary due to the unfortunate fact that assigning `nil` to an
// interface variable causes `x == nil` checks to always return false, so methods on the interface cannot be safely called then.
//
// the problematic case would be:
// configOverriderService, err := d.maybeCreateConfigOverrider(...)
// if err != nil { return ... }
// configOverrider = configOverriderService // contract might be `nil`
// assert.False(configOverrider != nil) // even if 'contract' was nil, this check will return true, unexpectedly
if configOverriderService != nil {
services = append(services, configOverriderService)
configOverrider = configOverriderService
}
jb.OCROracleSpec.CaptureEATelemetry = d.cfg.OCR().CaptureEATelemetry()
enhancedTelemChan := make(chan ocrcommon.EnhancedTelemetryData, 100)
if ocrcommon.ShouldCollectEnhancedTelemetry(&jb) {
enhancedTelemService := ocrcommon.NewEnhancedTelemetryService(&jb, enhancedTelemChan, make(chan struct{}), d.monitoringEndpointGen.GenMonitoringEndpoint("EVM", chain.ID().String(), concreteSpec.ContractAddress.String(), synchronization.EnhancedEA), lggr.Named("EnhancedTelemetry"))
services = append(services, enhancedTelemService)
} else {
lggr.Infow("Enhanced telemetry is disabled for job", "job", jb.Name)
}
oracle, err := ocr.NewOracle(ocr.OracleArgs{
Database: ocrDB,
Datasource: ocrcommon.NewDataSourceV1(
d.pipelineRunner,
jb,
*jb.PipelineSpec,
lggr,
saver,
enhancedTelemChan,
),
LocalConfig: lc,
ContractTransmitter: contractTransmitter,
ContractConfigTracker: tracker,
PrivateKeys: ocrkey,
BinaryNetworkEndpointFactory: peerWrapper.Peer1,
Logger: ocrLogger,
V2Bootstrappers: v2Bootstrappers,
MonitoringEndpoint: d.monitoringEndpointGen.GenMonitoringEndpoint("EVM", chain.ID().String(), concreteSpec.ContractAddress.String(), synchronization.OCR),
ConfigOverrider: configOverrider,
})
if err != nil {
return nil, errors.Wrap(err, "error calling NewOracle")
}
oracleCtx := job.NewServiceAdapter(oracle)
services = append(services, oracleCtx)
// RunResultSaver needs to be started first so its available
// to read db writes. It is stopped last after the Oracle is shut down
// so no further runs are enqueued and we can drain the queue.
services = append([]job.ServiceCtx{saver}, services...)
}
return services, nil
}
func (d *Delegate) maybeCreateConfigOverrider(logger logger.Logger, chain legacyevm.Chain, contractAddress types.EIP55Address) (*ConfigOverriderImpl, error) {
flagsContractAddress := chain.Config().EVM().FlagsContractAddress()
if flagsContractAddress != "" {
flags, err := NewFlags(flagsContractAddress, chain.Client())
if err != nil {
return nil, errors.Wrapf(err,
"OCR: unable to create Flags contract instance, check address: %s or remove EVM.FlagsContractAddress configuration variable",
flagsContractAddress,
)
}
ticker := utils.NewPausableTicker(ConfigOverriderPollInterval)
return NewConfigOverriderImpl(logger, chain.Config().EVM().OCR(), contractAddress, flags, &ticker)
}
return nil, nil
}