/
keeper_deployer.go
371 lines (319 loc) · 15.7 KB
/
keeper_deployer.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
package handler
import (
"context"
"crypto/ed25519"
"encoding/hex"
"encoding/json"
"fmt"
"math/big"
"strings"
"sync"
"time"
"github.com/ethereum/go-ethereum/accounts/abi/bind"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core/types"
"github.com/umbracle/ethgo/abi"
ocr2config "github.com/smartcontractkit/libocr/offchainreporting2plus/confighelper"
"github.com/smartcontractkit/libocr/offchainreporting2plus/ocr3confighelper"
ocr2types "github.com/smartcontractkit/libocr/offchainreporting2plus/types"
"github.com/smartcontractkit/chainlink/core/scripts/chaincli/config"
offchain20config "github.com/smartcontractkit/chainlink-automation/pkg/v2/config"
"github.com/smartcontractkit/chainlink/v2/core/cmd"
iregistry21 "github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/i_keeper_registry_master_wrapper_2_1"
registry11 "github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/keeper_registry_wrapper1_1"
registry12 "github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/keeper_registry_wrapper1_2"
registry20 "github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/keeper_registry_wrapper2_0"
)
// canceller describes the behavior to cancel upkeeps
type canceller interface {
CancelUpkeep(opts *bind.TransactOpts, id *big.Int) (*types.Transaction, error)
WithdrawFunds(opts *bind.TransactOpts, id *big.Int, to common.Address) (*types.Transaction, error)
RecoverFunds(opts *bind.TransactOpts) (*types.Transaction, error)
}
// upkeepDeployer contains functions needed to deploy an upkeep
type upkeepDeployer interface {
RegisterUpkeep(opts *bind.TransactOpts, target common.Address, gasLimit uint32, admin common.Address, checkData []byte, offchainConfig []byte) (*types.Transaction, error)
RegisterUpkeepV2(opts *bind.TransactOpts, target common.Address, gasLimit uint32, admin common.Address, triggerType uint8, pipelineData []byte, triggerConfig []byte, offchainConfig []byte) (*types.Transaction, error)
AddFunds(opts *bind.TransactOpts, id *big.Int, amount *big.Int) (*types.Transaction, error)
}
// keepersDeployer contains functions needed to deploy keepers
type keepersDeployer interface {
canceller
upkeepDeployer
SetKeepers(ctx context.Context, opts *bind.TransactOpts, _ []cmd.HTTPClient, keepers []common.Address, payees []common.Address) (*types.Transaction, error)
}
type v11KeeperDeployer struct {
registry11.KeeperRegistryInterface
}
func (d *v11KeeperDeployer) SetKeepers(ctx context.Context, opts *bind.TransactOpts, _ []cmd.HTTPClient, keepers []common.Address, payees []common.Address) (*types.Transaction, error) {
return d.KeeperRegistryInterface.SetKeepers(opts, keepers, payees)
}
func (d *v11KeeperDeployer) RegisterUpkeep(opts *bind.TransactOpts, target common.Address, gasLimit uint32, admin common.Address, checkData []byte, offchainConfig []byte) (*types.Transaction, error) {
return d.KeeperRegistryInterface.RegisterUpkeep(opts, target, gasLimit, admin, checkData)
}
func (d *v11KeeperDeployer) RegisterUpkeepV2(opts *bind.TransactOpts, target common.Address, gasLimit uint32, admin common.Address, triggerType uint8, pipelineData []byte, triggerConfig []byte, offchainConfig []byte) (*types.Transaction, error) {
panic("not implemented")
}
type v12KeeperDeployer struct {
registry12.KeeperRegistryInterface
}
func (d *v12KeeperDeployer) SetKeepers(ctx context.Context, opts *bind.TransactOpts, _ []cmd.HTTPClient, keepers []common.Address, payees []common.Address) (*types.Transaction, error) {
return d.KeeperRegistryInterface.SetKeepers(opts, keepers, payees)
}
func (d *v12KeeperDeployer) RegisterUpkeep(opts *bind.TransactOpts, target common.Address, gasLimit uint32, admin common.Address, checkData []byte, offchainConfig []byte) (*types.Transaction, error) {
return d.KeeperRegistryInterface.RegisterUpkeep(opts, target, gasLimit, admin, checkData)
}
func (d *v12KeeperDeployer) RegisterUpkeepV2(opts *bind.TransactOpts, target common.Address, gasLimit uint32, admin common.Address, triggerType uint8, pipelineData []byte, triggerConfig []byte, offchainConfig []byte) (*types.Transaction, error) {
panic("not implemented")
}
type v20KeeperDeployer struct {
registry20.KeeperRegistryInterface
cfg *config.Config
}
func (d *v20KeeperDeployer) SetKeepers(ctx context.Context, opts *bind.TransactOpts, cls []cmd.HTTPClient, keepers []common.Address, _ []common.Address) (*types.Transaction, error) {
S := make([]int, len(cls))
oracleIdentities := make([]ocr2config.OracleIdentityExtra, len(cls))
sharedSecretEncryptionPublicKeys := make([]ocr2types.ConfigEncryptionPublicKey, len(cls))
var wg sync.WaitGroup
for i, cl := range cls {
wg.Add(1)
go func(i int, cl cmd.HTTPClient) {
defer wg.Done()
ocr2Config, err := getNodeOCR2Config(ctx, cl)
if err != nil {
panic(err)
}
p2pKeyID, err := getP2PKeyID(ctx, cl)
if err != nil {
panic(err)
}
offchainPkBytes, err := hex.DecodeString(strings.TrimPrefix(ocr2Config.OffChainPublicKey, "ocr2off_evm_"))
if err != nil {
panic(fmt.Errorf("failed to decode %s: %v", ocr2Config.OffChainPublicKey, err))
}
offchainPkBytesFixed := [ed25519.PublicKeySize]byte{}
n := copy(offchainPkBytesFixed[:], offchainPkBytes)
if n != ed25519.PublicKeySize {
panic(fmt.Errorf("wrong num elements copied"))
}
configPkBytes, err := hex.DecodeString(strings.TrimPrefix(ocr2Config.ConfigPublicKey, "ocr2cfg_evm_"))
if err != nil {
panic(fmt.Errorf("failed to decode %s: %v", ocr2Config.ConfigPublicKey, err))
}
configPkBytesFixed := [ed25519.PublicKeySize]byte{}
n = copy(configPkBytesFixed[:], configPkBytes)
if n != ed25519.PublicKeySize {
panic(fmt.Errorf("wrong num elements copied"))
}
onchainPkBytes, err := hex.DecodeString(strings.TrimPrefix(ocr2Config.OnchainPublicKey, "ocr2on_evm_"))
if err != nil {
panic(fmt.Errorf("failed to decode %s: %v", ocr2Config.OnchainPublicKey, err))
}
sharedSecretEncryptionPublicKeys[i] = configPkBytesFixed
oracleIdentities[i] = ocr2config.OracleIdentityExtra{
OracleIdentity: ocr2config.OracleIdentity{
OnchainPublicKey: onchainPkBytes,
OffchainPublicKey: offchainPkBytesFixed,
PeerID: p2pKeyID,
TransmitAccount: ocr2types.Account(keepers[i].String()),
},
ConfigEncryptionPublicKey: configPkBytesFixed,
}
S[i] = 1
}(i, cl)
}
wg.Wait()
offC, err := json.Marshal(offchain20config.OffchainConfig{
PerformLockoutWindow: 100 * 3 * 1000, // ~100 block lockout (on mumbai)
MinConfirmations: 1,
})
if err != nil {
panic(err)
}
signerOnchainPublicKeys, transmitterAccounts, f, _, offchainConfigVersion, offchainConfig, err := ocr2config.ContractSetConfigArgsForTests(
5*time.Second, // deltaProgress time.Duration,
10*time.Second, // deltaResend time.Duration,
2500*time.Millisecond, // deltaRound time.Duration,
40*time.Millisecond, // deltaGrace time.Duration,
30*time.Second, // deltaStage time.Duration,
50, // rMax uint8,
S, // s []int,
oracleIdentities, // oracles []OracleIdentityExtra,
offC, // reportingPluginConfig []byte,
20*time.Millisecond, // maxDurationQuery time.Duration,
1600*time.Millisecond, // maxDurationObservation time.Duration,
800*time.Millisecond, // maxDurationReport time.Duration, sum of MaxDurationQuery/Observation/Report must be less than DeltaProgress
20*time.Millisecond, // maxDurationShouldAcceptFinalizedReport time.Duration,
20*time.Millisecond, // maxDurationShouldTransmitAcceptedReport time.Duration,
1, // f int,
nil, // onchainConfig []byte,
)
if err != nil {
return nil, err
}
var signers []common.Address
for _, signer := range signerOnchainPublicKeys {
if len(signer) != 20 {
return nil, fmt.Errorf("OnChainPublicKey has wrong length for address")
}
signers = append(signers, common.BytesToAddress(signer))
}
var transmitters []common.Address
for _, transmitter := range transmitterAccounts {
if !common.IsHexAddress(string(transmitter)) {
return nil, fmt.Errorf("TransmitAccount is not a valid Ethereum address")
}
transmitters = append(transmitters, common.HexToAddress(string(transmitter)))
}
configType := abi.MustNewType("tuple(uint32 paymentPremiumPPB,uint32 flatFeeMicroLink,uint32 checkGasLimit,uint24 stalenessSeconds,uint16 gasCeilingMultiplier,uint96 minUpkeepSpend,uint32 maxPerformGas,uint32 maxCheckDataSize,uint32 maxPerformDataSize,uint256 fallbackGasPrice,uint256 fallbackLinkPrice,address transcoder,address registrar)")
onchainConfig, err := abi.Encode(map[string]interface{}{
"paymentPremiumPPB": d.cfg.PaymentPremiumPBB,
"flatFeeMicroLink": d.cfg.FlatFeeMicroLink,
"checkGasLimit": d.cfg.CheckGasLimit,
"stalenessSeconds": d.cfg.StalenessSeconds,
"gasCeilingMultiplier": d.cfg.GasCeilingMultiplier,
"minUpkeepSpend": d.cfg.MinUpkeepSpend,
"maxPerformGas": d.cfg.MaxPerformGas,
"maxCheckDataSize": d.cfg.MaxCheckDataSize,
"maxPerformDataSize": d.cfg.MaxPerformDataSize,
"fallbackGasPrice": big.NewInt(d.cfg.FallbackGasPrice),
"fallbackLinkPrice": big.NewInt(d.cfg.FallbackLinkPrice),
"transcoder": common.HexToAddress(d.cfg.Transcoder),
"registrar": common.HexToAddress(d.cfg.Registrar),
}, configType)
if err != nil {
return nil, err
}
return d.KeeperRegistryInterface.SetConfig(opts, signers, transmitters, f, onchainConfig, offchainConfigVersion, offchainConfig)
}
func (d *v20KeeperDeployer) RegisterUpkeepV2(opts *bind.TransactOpts, target common.Address, gasLimit uint32, admin common.Address, triggerType uint8, pipelineData []byte, triggerConfig []byte, offchainConfig []byte) (*types.Transaction, error) {
panic("not implemented")
}
type v21KeeperDeployer struct {
iregistry21.IKeeperRegistryMasterInterface
cfg *config.Config
}
func (d *v21KeeperDeployer) SetKeepers(ctx context.Context, opts *bind.TransactOpts, cls []cmd.HTTPClient, keepers []common.Address, _ []common.Address) (*types.Transaction, error) {
S := make([]int, len(cls))
oracleIdentities := make([]ocr2config.OracleIdentityExtra, len(cls))
sharedSecretEncryptionPublicKeys := make([]ocr2types.ConfigEncryptionPublicKey, len(cls))
var wg sync.WaitGroup
for i, cl := range cls {
wg.Add(1)
go func(i int, cl cmd.HTTPClient) {
defer wg.Done()
ocr2Config, err := getNodeOCR2Config(ctx, cl)
if err != nil {
panic(err)
}
p2pKeyID, err := getP2PKeyID(ctx, cl)
if err != nil {
panic(err)
}
offchainPkBytes, err := hex.DecodeString(strings.TrimPrefix(ocr2Config.OffChainPublicKey, "ocr2off_evm_"))
if err != nil {
panic(fmt.Errorf("failed to decode %s: %v", ocr2Config.OffChainPublicKey, err))
}
offchainPkBytesFixed := [ed25519.PublicKeySize]byte{}
n := copy(offchainPkBytesFixed[:], offchainPkBytes)
if n != ed25519.PublicKeySize {
panic(fmt.Errorf("wrong num elements copied"))
}
configPkBytes, err := hex.DecodeString(strings.TrimPrefix(ocr2Config.ConfigPublicKey, "ocr2cfg_evm_"))
if err != nil {
panic(fmt.Errorf("failed to decode %s: %v", ocr2Config.ConfigPublicKey, err))
}
configPkBytesFixed := [ed25519.PublicKeySize]byte{}
n = copy(configPkBytesFixed[:], configPkBytes)
if n != ed25519.PublicKeySize {
panic(fmt.Errorf("wrong num elements copied"))
}
onchainPkBytes, err := hex.DecodeString(strings.TrimPrefix(ocr2Config.OnchainPublicKey, "ocr2on_evm_"))
if err != nil {
panic(fmt.Errorf("failed to decode %s: %v", ocr2Config.OnchainPublicKey, err))
}
sharedSecretEncryptionPublicKeys[i] = configPkBytesFixed
oracleIdentities[i] = ocr2config.OracleIdentityExtra{
OracleIdentity: ocr2config.OracleIdentity{
OnchainPublicKey: onchainPkBytes,
OffchainPublicKey: offchainPkBytesFixed,
PeerID: p2pKeyID,
TransmitAccount: ocr2types.Account(keepers[i].String()),
},
ConfigEncryptionPublicKey: configPkBytesFixed,
}
S[i] = 1
}(i, cl)
}
wg.Wait()
offC, err := json.Marshal(offchain20config.OffchainConfig{
PerformLockoutWindow: 100 * 3 * 1000, // ~100 block lockout (on mumbai)
MinConfirmations: 1,
MercuryLookup: d.cfg.UpkeepType == config.Mercury || d.cfg.UpkeepType == config.LogTriggeredFeedLookup,
})
if err != nil {
panic(err)
}
signerOnchainPublicKeys, transmitterAccounts, f, _, offchainConfigVersion, offchainConfig, err := ocr3confighelper.ContractSetConfigArgsForTests(
5*time.Second, // deltaProgress time.Duration,
10*time.Second, // deltaResend time.Duration,
400*time.Millisecond, // deltaInitial time.Duration,
2500*time.Millisecond, // deltaRound time.Duration,
40*time.Millisecond, // deltaGrace time.Duration,
300*time.Millisecond, // deltaCertifiedCommitRequest time.Duration,
30*time.Second, // deltaStage time.Duration,
50, // rMax uint8,
S, // s []int,
oracleIdentities, // oracles []OracleIdentityExtra,
offC, // reportingPluginConfig []byte,
20*time.Millisecond, // maxDurationQuery time.Duration,
1600*time.Millisecond, // maxDurationObservation time.Duration,
20*time.Millisecond, // maxDurationShouldAcceptFinalizedReport time.Duration,
20*time.Millisecond, // maxDurationShouldTransmitAcceptedReport time.Duration,
1, // f int,
nil, // onchainConfig []byte,
)
if err != nil {
return nil, err
}
var signers []common.Address
for _, signer := range signerOnchainPublicKeys {
if len(signer) != 20 {
return nil, fmt.Errorf("OnChainPublicKey has wrong length for address")
}
signers = append(signers, common.BytesToAddress(signer))
}
var transmitters []common.Address
for _, transmitter := range transmitterAccounts {
if !common.IsHexAddress(string(transmitter)) {
return nil, fmt.Errorf("TransmitAccount is not a valid Ethereum address")
}
transmitters = append(transmitters, common.HexToAddress(string(transmitter)))
}
onchainConfig := iregistry21.IAutomationV21PlusCommonOnchainConfigLegacy{
PaymentPremiumPPB: d.cfg.PaymentPremiumPBB,
FlatFeeMicroLink: d.cfg.FlatFeeMicroLink,
CheckGasLimit: d.cfg.CheckGasLimit,
StalenessSeconds: big.NewInt(d.cfg.StalenessSeconds),
GasCeilingMultiplier: d.cfg.GasCeilingMultiplier,
MinUpkeepSpend: big.NewInt(d.cfg.MinUpkeepSpend),
MaxPerformGas: d.cfg.MaxPerformGas,
MaxCheckDataSize: d.cfg.MaxCheckDataSize,
MaxPerformDataSize: d.cfg.MaxPerformDataSize,
MaxRevertDataSize: d.cfg.MaxRevertDataSize,
FallbackGasPrice: big.NewInt(d.cfg.FallbackGasPrice),
FallbackLinkPrice: big.NewInt(d.cfg.FallbackLinkPrice),
Transcoder: common.HexToAddress(d.cfg.Transcoder),
Registrars: []common.Address{common.HexToAddress(d.cfg.Registrar)},
UpkeepPrivilegeManager: common.HexToAddress(d.cfg.UpkeepPrivilegeManager),
}
return d.IKeeperRegistryMasterInterface.SetConfigTypeSafe(opts, signers, transmitters, f, onchainConfig, offchainConfigVersion, offchainConfig)
}
// legacy support function
func (d *v21KeeperDeployer) RegisterUpkeep(opts *bind.TransactOpts, target common.Address, gasLimit uint32, admin common.Address, checkData []byte, offchainConfig []byte) (*types.Transaction, error) {
return d.IKeeperRegistryMasterInterface.RegisterUpkeep0(opts, target, gasLimit, admin, checkData, offchainConfig)
}
// the new registerUpkeep function only available on version 2.1 and above
func (d *v21KeeperDeployer) RegisterUpkeepV2(opts *bind.TransactOpts, target common.Address, gasLimit uint32, admin common.Address, triggerType uint8, pipelineData []byte, triggerConfig []byte, offchainConfig []byte) (*types.Transaction, error) {
return d.IKeeperRegistryMasterInterface.RegisterUpkeep(opts, target, gasLimit, admin, triggerType, pipelineData, triggerConfig, offchainConfig)
}