-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
task.eth_tx.go
246 lines (219 loc) · 7.96 KB
/
task.eth_tx.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
package pipeline
import (
"context"
"math/big"
"reflect"
"strconv"
"github.com/ethereum/go-ethereum/common"
"github.com/mitchellh/mapstructure"
"github.com/pkg/errors"
"go.uber.org/multierr"
"gopkg.in/guregu/null.v4"
txmgrcommon "github.com/smartcontractkit/chainlink/v2/common/txmgr"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/txmgr"
"github.com/smartcontractkit/chainlink/v2/core/logger"
clnull "github.com/smartcontractkit/chainlink/v2/core/null"
"github.com/smartcontractkit/chainlink/v2/core/utils"
)
// Return types:
//
// nil
type ETHTxTask struct {
BaseTask `mapstructure:",squash"`
From string `json:"from"`
To string `json:"to"`
Data string `json:"data"`
GasLimit string `json:"gasLimit"`
TxMeta string `json:"txMeta"`
MinConfirmations string `json:"minConfirmations"`
// FailOnRevert, if set, will error the task if the transaction reverted on-chain
// If unset, the receipt will be passed as output
// It has no effect if minConfirmations == 0
FailOnRevert string `json:"failOnRevert"`
EVMChainID string `json:"evmChainID" mapstructure:"evmChainID"`
TransmitChecker string `json:"transmitChecker"`
forwardingAllowed bool
specGasLimit *uint32
keyStore ETHKeyStore
chainSet evm.ChainSet
jobType string
}
type ETHKeyStore interface {
GetRoundRobinAddress(chainID *big.Int, addrs ...common.Address) (common.Address, error)
}
var _ Task = (*ETHTxTask)(nil)
func (t *ETHTxTask) Type() TaskType {
return TaskTypeETHTx
}
func (t *ETHTxTask) Run(_ context.Context, lggr logger.Logger, vars Vars, inputs []Result) (result Result, runInfo RunInfo) {
var chainID StringParam
err := errors.Wrap(ResolveParam(&chainID, From(VarExpr(t.EVMChainID, vars), NonemptyString(t.EVMChainID), "")), "evmChainID")
if err != nil {
return Result{Error: err}, runInfo
}
chain, err := getChainByString(t.chainSet, string(chainID))
if err != nil {
return Result{Error: errors.Wrapf(err, "failed to get chain by id: %v", t.EVMChainID)}, retryableRunInfo()
}
cfg := chain.Config()
txManager := chain.TxManager()
_, err = CheckInputs(inputs, -1, -1, 0)
if err != nil {
return Result{Error: errors.Wrap(err, "task inputs")}, runInfo
}
maximumGasLimit := SelectGasLimit(cfg, t.jobType, t.specGasLimit)
var (
fromAddrs AddressSliceParam
toAddr AddressParam
data BytesParam
gasLimit Uint64Param
txMetaMap MapParam
maybeMinConfirmations MaybeUint64Param
transmitCheckerMap MapParam
failOnRevert BoolParam
)
err = multierr.Combine(
errors.Wrap(ResolveParam(&fromAddrs, From(VarExpr(t.From, vars), JSONWithVarExprs(t.From, vars, false), NonemptyString(t.From), nil)), "from"),
errors.Wrap(ResolveParam(&toAddr, From(VarExpr(t.To, vars), NonemptyString(t.To))), "to"),
errors.Wrap(ResolveParam(&data, From(VarExpr(t.Data, vars), NonemptyString(t.Data))), "data"),
errors.Wrap(ResolveParam(&gasLimit, From(VarExpr(t.GasLimit, vars), NonemptyString(t.GasLimit), maximumGasLimit)), "gasLimit"),
errors.Wrap(ResolveParam(&txMetaMap, From(VarExpr(t.TxMeta, vars), JSONWithVarExprs(t.TxMeta, vars, false), MapParam{})), "txMeta"),
errors.Wrap(ResolveParam(&maybeMinConfirmations, From(VarExpr(t.MinConfirmations, vars), NonemptyString(t.MinConfirmations), "")), "minConfirmations"),
errors.Wrap(ResolveParam(&transmitCheckerMap, From(VarExpr(t.TransmitChecker, vars), JSONWithVarExprs(t.TransmitChecker, vars, false), MapParam{})), "transmitChecker"),
errors.Wrap(ResolveParam(&failOnRevert, From(NonemptyString(t.FailOnRevert), false)), "failOnRevert"),
)
if err != nil {
return Result{Error: err}, runInfo
}
var minOutgoingConfirmations uint64
if min, isSet := maybeMinConfirmations.Uint64(); isSet {
minOutgoingConfirmations = min
} else {
minOutgoingConfirmations = uint64(cfg.EVM().FinalityDepth())
}
txMeta, err := decodeMeta(txMetaMap)
if err != nil {
return Result{Error: err}, runInfo
}
txMeta.FailOnRevert = null.BoolFrom(bool(failOnRevert))
setJobIDOnMeta(lggr, vars, txMeta)
transmitChecker, err := decodeTransmitChecker(transmitCheckerMap)
if err != nil {
return Result{Error: err}, runInfo
}
fromAddr, err := t.keyStore.GetRoundRobinAddress(chain.ID(), fromAddrs...)
if err != nil {
err = errors.Wrap(err, "ETHTxTask failed to get fromAddress")
lggr.Error(err)
return Result{Error: errors.Wrapf(ErrTaskRunFailed, "while querying keystore: %v", err)}, retryableRunInfo()
}
// TODO(sc-55115): Allow job specs to pass in the strategy that they want
strategy := txmgrcommon.NewSendEveryStrategy()
var forwarderAddress common.Address
if t.forwardingAllowed {
var fwderr error
forwarderAddress, fwderr = chain.TxManager().GetForwarderForEOA(fromAddr)
if fwderr != nil {
lggr.Warnw("Skipping forwarding for job, will fallback to default behavior", "err", fwderr)
}
}
txRequest := txmgr.TxRequest{
FromAddress: fromAddr,
ToAddress: common.Address(toAddr),
EncodedPayload: []byte(data),
FeeLimit: uint32(gasLimit),
Meta: txMeta,
ForwarderAddress: forwarderAddress,
Strategy: strategy,
Checker: transmitChecker,
}
if minOutgoingConfirmations > 0 {
// Store the task run ID, so we can resume the pipeline when tx is confirmed
txRequest.PipelineTaskRunID = &t.uuid
txRequest.MinConfirmations = clnull.Uint32From(uint32(minOutgoingConfirmations))
}
_, err = txManager.CreateTransaction(txRequest)
if err != nil {
return Result{Error: errors.Wrapf(ErrTaskRunFailed, "while creating transaction: %v", err)}, retryableRunInfo()
}
if minOutgoingConfirmations > 0 {
return Result{}, pendingRunInfo()
}
return Result{Value: nil}, runInfo
}
func decodeMeta(metaMap MapParam) (*txmgr.TxMeta, error) {
var txMeta txmgr.TxMeta
metaDecoder, err := mapstructure.NewDecoder(&mapstructure.DecoderConfig{
Result: &txMeta,
ErrorUnused: true,
DecodeHook: func(from reflect.Type, to reflect.Type, data interface{}) (interface{}, error) {
switch from {
case stringType:
switch to {
case int32Type:
i, err2 := strconv.ParseInt(data.(string), 10, 32)
return int32(i), err2
case reflect.TypeOf(common.Hash{}):
hb, err := utils.TryParseHex(data.(string))
if err != nil {
return nil, err
}
return common.BytesToHash(hb), nil
}
}
return data, nil
},
})
if err != nil {
return &txMeta, errors.Wrapf(ErrBadInput, "txMeta: %v", err)
}
err = metaDecoder.Decode(metaMap)
if err != nil {
return &txMeta, errors.Wrapf(ErrBadInput, "txMeta: %v", err)
}
return &txMeta, nil
}
func decodeTransmitChecker(checkerMap MapParam) (txmgr.TransmitCheckerSpec, error) {
var transmitChecker txmgr.TransmitCheckerSpec
checkerDecoder, err := mapstructure.NewDecoder(&mapstructure.DecoderConfig{
Result: &transmitChecker,
ErrorUnused: true,
DecodeHook: func(from reflect.Type, to reflect.Type, data interface{}) (interface{}, error) {
switch from {
case stringType:
switch to {
case reflect.TypeOf(common.Address{}):
ab, err := utils.TryParseHex(data.(string))
if err != nil {
return nil, err
}
return common.BytesToAddress(ab), nil
}
}
return data, nil
},
})
if err != nil {
return transmitChecker, errors.Wrapf(ErrBadInput, "transmitChecker: %v", err)
}
err = checkerDecoder.Decode(checkerMap)
if err != nil {
return transmitChecker, errors.Wrapf(ErrBadInput, "transmitChecker: %v", err)
}
return transmitChecker, nil
}
// txMeta is really only used for logging, so this is best-effort
func setJobIDOnMeta(lggr logger.Logger, vars Vars, meta *txmgr.TxMeta) {
jobID, err := vars.Get("jobSpec.databaseID")
if err != nil {
return
}
switch v := jobID.(type) {
case int64:
vv := int32(v)
meta.JobID = &vv
default:
logger.Sugared(lggr).AssumptionViolationf("expected type int32 for vars.jobSpec.databaseID; got: %T (value: %v)", jobID, jobID)
}
}