-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
delegate.go
322 lines (297 loc) · 11.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
package vrf
import (
"context"
"encoding/json"
"fmt"
"time"
"github.com/avast/retry-go/v4"
"github.com/ethereum/go-ethereum/common"
"github.com/pkg/errors"
"github.com/theodesp/go-heaps/pairing"
"go.uber.org/multierr"
"github.com/smartcontractkit/chainlink-common/pkg/sqlutil"
"github.com/smartcontractkit/chainlink-common/pkg/utils/mailbox"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/assets"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/log"
"github.com/smartcontractkit/chainlink/v2/core/chains/legacyevm"
"github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/aggregator_v3_interface"
"github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/batch_vrf_coordinator_v2"
"github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/solidity_vrf_coordinator_interface"
"github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/vrf_coordinator_v2"
"github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/vrf_coordinator_v2_5"
"github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/vrf_owner"
"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/pipeline"
v1 "github.com/smartcontractkit/chainlink/v2/core/services/vrf/v1"
v2 "github.com/smartcontractkit/chainlink/v2/core/services/vrf/v2"
"github.com/smartcontractkit/chainlink/v2/core/services/vrf/vrfcommon"
)
type Delegate struct {
ds sqlutil.DataSource
pr pipeline.Runner
porm pipeline.ORM
ks keystore.Master
legacyChains legacyevm.LegacyChainContainer
lggr logger.Logger
mailMon *mailbox.Monitor
}
func NewDelegate(
ds sqlutil.DataSource,
ks keystore.Master,
pr pipeline.Runner,
porm pipeline.ORM,
legacyChains legacyevm.LegacyChainContainer,
lggr logger.Logger,
mailMon *mailbox.Monitor) *Delegate {
return &Delegate{
ds: ds,
ks: ks,
pr: pr,
porm: porm,
legacyChains: legacyChains,
lggr: lggr.Named("VRF"),
mailMon: mailMon,
}
}
func (d *Delegate) JobType() job.Type {
return job.VRF
}
func (d *Delegate) BeforeJobCreated(job.Job) {}
func (d *Delegate) AfterJobCreated(job.Job) {}
func (d *Delegate) BeforeJobDeleted(job.Job) {}
func (d *Delegate) OnDeleteJob(context.Context, job.Job) error { return nil }
// ServicesForSpec satisfies the job.Delegate interface.
func (d *Delegate) ServicesForSpec(ctx context.Context, jb job.Job) ([]job.ServiceCtx, error) {
if jb.VRFSpec == nil || jb.PipelineSpec == nil {
return nil, errors.Errorf("vrf.Delegate expects a VRFSpec and PipelineSpec to be present, got %+v", jb)
}
marshalledVRFSpec, err := json.MarshalIndent(jb.VRFSpec, "", " ")
if err != nil {
return nil, err
}
marshalledPipelineSpec, err := json.MarshalIndent(jb.PipelineSpec, "", " ")
if err != nil {
return nil, err
}
d.lggr.Debugw("Creating services for job spec",
"vrfSpec", string(marshalledVRFSpec),
"pipelineSpec", string(marshalledPipelineSpec),
"keyHash", jb.VRFSpec.PublicKey.MustHash(),
)
pl, err := jb.PipelineSpec.ParsePipeline()
if err != nil {
return nil, err
}
chain, err := d.legacyChains.Get(jb.VRFSpec.EVMChainID.String())
if err != nil {
return nil, err
}
coordinator, err := solidity_vrf_coordinator_interface.NewVRFCoordinator(jb.VRFSpec.CoordinatorAddress.Address(), chain.Client())
if err != nil {
return nil, err
}
coordinatorV2, err := vrf_coordinator_v2.NewVRFCoordinatorV2(jb.VRFSpec.CoordinatorAddress.Address(), chain.Client())
if err != nil {
return nil, err
}
coordinatorV2Plus, err := vrf_coordinator_v2_5.NewVRFCoordinatorV25(jb.VRFSpec.CoordinatorAddress.Address(), chain.Client())
if err != nil {
return nil, err
}
// If the batch coordinator address is not provided, we will fall back to non-batched
var batchCoordinatorV2 *batch_vrf_coordinator_v2.BatchVRFCoordinatorV2
if jb.VRFSpec.BatchCoordinatorAddress != nil {
batchCoordinatorV2, err = batch_vrf_coordinator_v2.NewBatchVRFCoordinatorV2(
jb.VRFSpec.BatchCoordinatorAddress.Address(), chain.Client())
if err != nil {
return nil, errors.Wrap(err, "create batch coordinator wrapper")
}
}
var vrfOwner *vrf_owner.VRFOwner
if jb.VRFSpec.VRFOwnerAddress != nil {
vrfOwner, err = vrf_owner.NewVRFOwner(
jb.VRFSpec.VRFOwnerAddress.Address(), chain.Client(),
)
if err != nil {
return nil, errors.Wrap(err, "create vrf owner wrapper")
}
}
l := d.lggr.Named(jb.ExternalJobID.String()).With(
"jobID", jb.ID,
"externalJobID", jb.ExternalJobID,
"coordinatorAddress", jb.VRFSpec.CoordinatorAddress,
)
lV1 := l.Named("VRFListener")
lV2 := l.Named("VRFListenerV2")
lV2Plus := l.Named("VRFListenerV2Plus")
for _, task := range pl.Tasks {
if _, ok := task.(*pipeline.VRFTaskV2Plus); ok {
if err2 := CheckFromAddressesExist(ctx, jb, d.ks.Eth()); err != nil {
return nil, err2
}
if !FromAddressMaxGasPricesAllEqual(jb, chain.Config().EVM().GasEstimator().PriceMaxKey) {
return nil, errors.New("key-specific max gas prices of all fromAddresses are not equal, please set them to equal values")
}
if err2 := CheckFromAddressMaxGasPrices(jb, chain.Config().EVM().GasEstimator().PriceMaxKey); err != nil {
return nil, err2
}
if vrfOwner != nil {
return nil, errors.New("VRF Owner is not supported for VRF V2 Plus")
}
if jb.VRFSpec.CustomRevertsPipelineEnabled {
return nil, errors.New("Custom Reverted Txns Pipeline is not supported for VRF V2 Plus")
}
// Get the LINKNATIVEFEED address with retries
// This is needed because the RPC endpoint may be down so we need to
// switch over to another one.
var linkNativeFeedAddress common.Address
err = retry.Do(func() error {
linkNativeFeedAddress, err = coordinatorV2Plus.LINKNATIVEFEED(nil)
return err
}, retry.Attempts(10), retry.Delay(500*time.Millisecond))
if err != nil {
return nil, errors.Wrap(err, "can't call LINKNATIVEFEED")
}
aggregator, err2 := aggregator_v3_interface.NewAggregatorV3Interface(linkNativeFeedAddress, chain.Client())
if err2 != nil {
return nil, errors.Wrap(err2, "NewAggregatorV3Interface")
}
return []job.ServiceCtx{
v2.New(
chain.Config().EVM(),
chain.Config().EVM().GasEstimator(),
lV2Plus,
chain,
chain.ID(),
d.ds,
v2.NewCoordinatorV2_5(coordinatorV2Plus),
batchCoordinatorV2,
vrfOwner,
aggregator,
d.pr,
d.ks.Eth(),
jb,
func() {},
// the lookback in the deduper must be >= the lookback specified for the log poller
// otherwise we will end up re-delivering logs that were already delivered.
vrfcommon.NewInflightCache(int(chain.Config().EVM().FinalityDepth())),
vrfcommon.NewLogDeduper(int(chain.Config().EVM().FinalityDepth())),
),
}, nil
}
if _, ok := task.(*pipeline.VRFTaskV2); ok {
if err2 := CheckFromAddressesExist(ctx, jb, d.ks.Eth()); err != nil {
return nil, err2
}
if !FromAddressMaxGasPricesAllEqual(jb, chain.Config().EVM().GasEstimator().PriceMaxKey) {
return nil, errors.New("key-specific max gas prices of all fromAddresses are not equal, please set them to equal values")
}
if err2 := CheckFromAddressMaxGasPrices(jb, chain.Config().EVM().GasEstimator().PriceMaxKey); err != nil {
return nil, err2
}
// Get the LINKETHFEED address with retries
// This is needed because the RPC endpoint may be down so we need to
// switch over to another one.
var linkEthFeedAddress common.Address
err = retry.Do(func() error {
linkEthFeedAddress, err = coordinatorV2.LINKETHFEED(nil)
return err
}, retry.Attempts(10), retry.Delay(500*time.Millisecond))
if err != nil {
return nil, errors.Wrap(err, "LINKETHFEED")
}
aggregator, err := aggregator_v3_interface.NewAggregatorV3Interface(linkEthFeedAddress, chain.Client())
if err != nil {
return nil, errors.Wrap(err, "NewAggregatorV3Interface")
}
if vrfOwner == nil {
lV2.Infow("Running without VRFOwnerAddress set on the spec")
}
return []job.ServiceCtx{v2.New(
chain.Config().EVM(),
chain.Config().EVM().GasEstimator(),
lV2,
chain,
chain.ID(),
d.ds,
v2.NewCoordinatorV2(coordinatorV2),
batchCoordinatorV2,
vrfOwner,
aggregator,
d.pr,
d.ks.Eth(),
jb,
func() {},
// the lookback in the deduper must be >= the lookback specified for the log poller
// otherwise we will end up re-delivering logs that were already delivered.
vrfcommon.NewInflightCache(int(chain.Config().EVM().FinalityDepth())),
vrfcommon.NewLogDeduper(int(chain.Config().EVM().FinalityDepth())),
),
}, nil
}
if _, ok := task.(*pipeline.VRFTask); ok {
return []job.ServiceCtx{&v1.Listener{
Cfg: chain.Config().EVM(),
FeeCfg: chain.Config().EVM().GasEstimator(),
L: logger.Sugared(lV1),
Coordinator: coordinator,
PipelineRunner: d.pr,
GethKs: d.ks.Eth(),
Job: jb,
MailMon: d.mailMon,
// Note the mailbox size effectively sets a limit on how many logs we can replay
// in the event of a VRF outage.
ReqLogs: mailbox.NewHighCapacity[log.Broadcast](),
ChStop: make(chan struct{}),
WaitOnStop: make(chan struct{}),
NewHead: make(chan struct{}, 1),
BlockNumberToReqID: pairing.New(),
ReqAdded: func() {},
Deduper: vrfcommon.NewLogDeduper(int(chain.Config().EVM().FinalityDepth())),
Chain: chain,
}}, nil
}
}
return nil, errors.New("invalid job spec expected a vrf task")
}
// CheckFromAddressesExist returns an error if and only if one of the addresses
// in the VRF spec's fromAddresses field does not exist in the keystore.
func CheckFromAddressesExist(ctx context.Context, jb job.Job, gethks keystore.Eth) (err error) {
for _, a := range jb.VRFSpec.FromAddresses {
_, err2 := gethks.Get(ctx, a.Hex())
err = multierr.Append(err, err2)
}
return
}
// CheckFromAddressMaxGasPrices checks if the provided gas price in the job spec gas lane parameter
// matches what is set for the provided from addresses.
// If they don't match, this is a configuration error. An error is returned with all the keys that do
// not match the provided gas lane price.
func CheckFromAddressMaxGasPrices(jb job.Job, keySpecificMaxGas keySpecificMaxGasFn) (err error) {
if jb.VRFSpec.GasLanePrice != nil {
for _, a := range jb.VRFSpec.FromAddresses {
if keySpecific := keySpecificMaxGas(a.Address()); !keySpecific.Equal(jb.VRFSpec.GasLanePrice) {
err = multierr.Append(err,
fmt.Errorf(
"key-specific max gas price of from address %s (%s) does not match gasLanePriceGWei (%s) specified in job spec",
a.Hex(), keySpecific.String(), jb.VRFSpec.GasLanePrice.String()))
}
}
}
return
}
type keySpecificMaxGasFn func(common.Address) *assets.Wei
// FromAddressMaxGasPricesAllEqual returns true if and only if all the specified from
// addresses in the fromAddresses field of the VRF v2 job have the same key-specific max
// gas price.
func FromAddressMaxGasPricesAllEqual(jb job.Job, keySpecificMaxGasPriceWei keySpecificMaxGasFn) (allEqual bool) {
allEqual = true
for i := range jb.VRFSpec.FromAddresses {
allEqual = allEqual && keySpecificMaxGasPriceWei(jb.VRFSpec.FromAddresses[i].Address()).Equal(
keySpecificMaxGasPriceWei(jb.VRFSpec.FromAddresses[0].Address()),
)
}
return
}