-
Notifications
You must be signed in to change notification settings - Fork 176
/
transactionInvoker.go
492 lines (414 loc) · 13.1 KB
/
transactionInvoker.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
package fvm
import (
"fmt"
"strconv"
"github.com/onflow/cadence/runtime"
"github.com/onflow/cadence/runtime/common"
"github.com/rs/zerolog"
"go.opentelemetry.io/otel/attribute"
otelTrace "go.opentelemetry.io/otel/trace"
"github.com/onflow/flow-go/fvm/environment"
"github.com/onflow/flow-go/fvm/errors"
"github.com/onflow/flow-go/fvm/evm"
reusableRuntime "github.com/onflow/flow-go/fvm/runtime"
"github.com/onflow/flow-go/fvm/storage"
"github.com/onflow/flow-go/fvm/storage/derived"
"github.com/onflow/flow-go/fvm/storage/snapshot"
"github.com/onflow/flow-go/fvm/storage/state"
"github.com/onflow/flow-go/fvm/systemcontracts"
"github.com/onflow/flow-go/module/trace"
)
type TransactionExecutorParams struct {
AuthorizationChecksEnabled bool
SequenceNumberCheckAndIncrementEnabled bool
// If AccountKeyWeightThreshold is set to a negative number, signature
// verification is skipped during authorization checks.
//
// Note: This is set only by tests
AccountKeyWeightThreshold int
// Note: This is disabled only by tests
TransactionBodyExecutionEnabled bool
}
func DefaultTransactionExecutorParams() TransactionExecutorParams {
return TransactionExecutorParams{
AuthorizationChecksEnabled: true,
SequenceNumberCheckAndIncrementEnabled: true,
AccountKeyWeightThreshold: AccountKeyWeightThreshold,
TransactionBodyExecutionEnabled: true,
}
}
type transactionExecutor struct {
TransactionExecutorParams
TransactionVerifier
TransactionSequenceNumberChecker
TransactionStorageLimiter
TransactionPayerBalanceChecker
ctx Context
proc *TransactionProcedure
txnState storage.TransactionPreparer
span otelTrace.Span
env environment.Environment
errs *errors.ErrorsCollector
startedTransactionBodyExecution bool
nestedTxnId state.NestedTransactionId
cadenceRuntime *reusableRuntime.ReusableCadenceRuntime
txnBodyExecutor runtime.Executor
output ProcedureOutput
}
func newTransactionExecutor(
ctx Context,
proc *TransactionProcedure,
txnState storage.TransactionPreparer,
) *transactionExecutor {
span := ctx.StartChildSpan(trace.FVMExecuteTransaction)
span.SetAttributes(attribute.String("transaction_id", proc.ID.String()))
ctx.TxIndex = proc.TxIndex
ctx.TxId = proc.ID
ctx.TxBody = proc.Transaction
env := environment.NewTransactionEnvironment(
span,
ctx.EnvironmentParams,
txnState)
return &transactionExecutor{
TransactionExecutorParams: ctx.TransactionExecutorParams,
TransactionVerifier: TransactionVerifier{
VerificationConcurrency: 4,
},
ctx: ctx,
proc: proc,
txnState: txnState,
span: span,
env: env,
errs: errors.NewErrorsCollector(),
startedTransactionBodyExecution: false,
cadenceRuntime: env.BorrowCadenceRuntime(),
}
}
func (executor *transactionExecutor) Cleanup() {
executor.env.ReturnCadenceRuntime(executor.cadenceRuntime)
executor.span.End()
}
func (executor *transactionExecutor) Output() ProcedureOutput {
return executor.output
}
func (executor *transactionExecutor) handleError(
err error,
step string,
) error {
txErr, failure := errors.SplitErrorTypes(err)
if failure != nil {
// log the full error path
executor.ctx.Logger.Err(err).
Str("step", step).
Msg("fatal error when handling a transaction")
return failure
}
if txErr != nil {
executor.output.Err = txErr
}
return nil
}
func (executor *transactionExecutor) Preprocess() error {
return executor.handleError(executor.preprocess(), "preprocess")
}
func (executor *transactionExecutor) Execute() error {
return executor.handleError(executor.execute(), "executing")
}
func (executor *transactionExecutor) preprocess() error {
if executor.AuthorizationChecksEnabled {
err := executor.CheckAuthorization(
executor.ctx.TracerSpan,
executor.proc,
executor.txnState,
executor.AccountKeyWeightThreshold)
if err != nil {
executor.errs.Collect(err)
return executor.errs.ErrorOrNil()
}
}
if executor.SequenceNumberCheckAndIncrementEnabled {
err := executor.CheckAndIncrementSequenceNumber(
executor.ctx.TracerSpan,
executor.proc,
executor.txnState)
if err != nil {
executor.errs.Collect(err)
return executor.errs.ErrorOrNil()
}
}
if !executor.TransactionBodyExecutionEnabled {
return nil
}
executor.errs.Collect(executor.preprocessTransactionBody())
if executor.errs.CollectedFailure() {
return executor.errs.ErrorOrNil()
}
return nil
}
// preprocessTransactionBody preprocess parts of a transaction body that are
// infrequently modified and are expensive to compute. For now this includes
// reading meter parameter overrides and parsing programs.
func (executor *transactionExecutor) preprocessTransactionBody() error {
// setup evm
if executor.ctx.EVMEnabled {
chain := executor.ctx.Chain
sc := systemcontracts.SystemContractsForChain(chain.ChainID())
err := evm.SetupEnvironment(
chain.ChainID(),
executor.env,
executor.cadenceRuntime.TxRuntimeEnv,
chain.ServiceAddress(),
sc.FlowToken.Address,
)
if err != nil {
return err
}
}
meterParams, err := getBodyMeterParameters(
executor.ctx,
executor.proc,
executor.txnState)
if err != nil {
return fmt.Errorf("error gettng meter parameters: %w", err)
}
txnId, err := executor.txnState.BeginNestedTransactionWithMeterParams(
meterParams)
if err != nil {
return err
}
executor.startedTransactionBodyExecution = true
executor.nestedTxnId = txnId
executor.txnBodyExecutor = executor.cadenceRuntime.NewTransactionExecutor(
runtime.Script{
Source: executor.proc.Transaction.Script,
Arguments: executor.proc.Transaction.Arguments,
},
common.TransactionLocation(executor.proc.ID))
// This initializes various cadence variables and parses the programs used
// by the transaction body.
err = executor.txnBodyExecutor.Preprocess()
if err != nil {
return fmt.Errorf(
"transaction preprocess failed: %w",
err)
}
return nil
}
func (executor *transactionExecutor) execute() error {
if !executor.startedTransactionBodyExecution {
return executor.errs.ErrorOrNil()
}
return executor.ExecuteTransactionBody()
}
func (executor *transactionExecutor) ExecuteTransactionBody() error {
// setup evm
if executor.ctx.EVMEnabled {
chain := executor.ctx.Chain
sc := systemcontracts.SystemContractsForChain(chain.ChainID())
err := evm.SetupEnvironment(
chain.ChainID(),
executor.env,
executor.cadenceRuntime.TxRuntimeEnv,
chain.ServiceAddress(),
sc.FlowToken.Address,
)
if err != nil {
return err
}
}
var invalidator derived.TransactionInvalidator
if !executor.errs.CollectedError() {
var txError error
invalidator, txError = executor.normalExecution()
if executor.errs.Collect(txError).CollectedFailure() {
return executor.errs.ErrorOrNil()
}
}
if executor.errs.CollectedError() {
invalidator = nil
executor.txnState.RunWithAllLimitsDisabled(executor.errorExecution)
if executor.errs.CollectedFailure() {
return executor.errs.ErrorOrNil()
}
}
// log the execution intensities here, so that they do not contain data
// from transaction fee deduction, because the payer is not charged for that.
executor.logExecutionIntensities()
executor.errs.Collect(executor.commit(invalidator))
return executor.errs.ErrorOrNil()
}
func (executor *transactionExecutor) deductTransactionFees() (err error) {
if !executor.env.TransactionFeesEnabled() {
return nil
}
computationLimit := uint64(executor.txnState.TotalComputationLimit())
computationUsed, err := executor.env.ComputationUsed()
if err != nil {
return errors.NewTransactionFeeDeductionFailedError(
executor.proc.Transaction.Payer,
computationLimit,
err)
}
if computationUsed > computationLimit {
computationUsed = computationLimit
}
_, err = executor.env.DeductTransactionFees(
executor.proc.Transaction.Payer,
executor.proc.Transaction.InclusionEffort(),
computationUsed)
if err != nil {
return errors.NewTransactionFeeDeductionFailedError(
executor.proc.Transaction.Payer,
computationUsed,
err)
}
return nil
}
// logExecutionIntensities logs execution intensities of the transaction
func (executor *transactionExecutor) logExecutionIntensities() {
log := executor.env.Logger()
if !log.Debug().Enabled() {
return
}
computation := zerolog.Dict()
for s, u := range executor.txnState.ComputationIntensities() {
computation.Uint(strconv.FormatUint(uint64(s), 10), u)
}
memory := zerolog.Dict()
for s, u := range executor.txnState.MemoryIntensities() {
memory.Uint(strconv.FormatUint(uint64(s), 10), u)
}
log.Debug().
Uint64("ledgerInteractionUsed", executor.txnState.InteractionUsed()).
Uint64("computationUsed", executor.txnState.TotalComputationUsed()).
Uint64("memoryEstimate", executor.txnState.TotalMemoryEstimate()).
Dict("computationIntensities", computation).
Dict("memoryIntensities", memory).
Msg("transaction execution data")
}
func (executor *transactionExecutor) normalExecution() (
invalidator derived.TransactionInvalidator,
err error,
) {
var maxTxFees uint64
// run with limits disabled since this is a static cost check
// and should be accounted for in the inclusion cost.
executor.txnState.RunWithAllLimitsDisabled(func() {
maxTxFees, err = executor.CheckPayerBalanceAndReturnMaxFees(
executor.proc,
executor.txnState,
executor.env)
})
if err != nil {
return
}
var bodyTxnId state.NestedTransactionId
bodyTxnId, err = executor.txnState.BeginNestedTransaction()
if err != nil {
return
}
err = executor.txnBodyExecutor.Execute()
if err != nil {
err = fmt.Errorf("transaction execute failed: %w", err)
return
}
// Before checking storage limits, we must apply all pending changes
// that may modify storage usage.
var contractUpdates environment.ContractUpdates
contractUpdates, err = executor.env.FlushPendingUpdates()
if err != nil {
err = fmt.Errorf(
"transaction invocation failed to flush pending changes from "+
"environment: %w",
err)
return
}
var bodySnapshot *snapshot.ExecutionSnapshot
bodySnapshot, err = executor.txnState.CommitNestedTransaction(bodyTxnId)
if err != nil {
return
}
invalidator = environment.NewDerivedDataInvalidator(
contractUpdates,
executor.ctx.Chain.ServiceAddress(),
bodySnapshot)
// Check if all account storage limits are ok
//
// disable the computation/memory limit checks on storage checks,
// so we don't error from computation/memory limits on this part.
//
// The storage limit check is performed for all accounts that were touched during the transaction.
// The storage capacity of an account depends on its balance and should be higher than the accounts storage used.
// The payer account is special cased in this check and its balance is considered max_fees lower than its
// actual balance, for the purpose of calculating storage capacity, because the payer will have to pay for this tx.
executor.txnState.RunWithAllLimitsDisabled(func() {
err = executor.CheckStorageLimits(
executor.ctx,
executor.env,
bodySnapshot,
executor.proc.Transaction.Payer,
maxTxFees)
})
if err != nil {
return
}
executor.txnState.RunWithAllLimitsDisabled(func() {
err = executor.deductTransactionFees()
})
return
}
// Clear changes and try to deduct fees again.
func (executor *transactionExecutor) errorExecution() {
// log transaction as failed
log := executor.env.Logger()
log.Info().
Err(executor.errs.ErrorOrNil()).
Msg("transaction executed with error")
executor.env.Reset()
// drop delta since transaction failed
restartErr := executor.txnState.RestartNestedTransaction(executor.nestedTxnId)
if executor.errs.Collect(restartErr).CollectedFailure() {
return
}
// try to deduct fees again, to get the fee deduction events
feesError := executor.deductTransactionFees()
// if fee deduction fails just do clean up and exit
if feesError != nil {
log.Info().
Err(feesError).
Msg("transaction fee deduction executed with error")
if executor.errs.Collect(feesError).CollectedFailure() {
return
}
// drop delta
executor.errs.Collect(
executor.txnState.RestartNestedTransaction(executor.nestedTxnId))
}
}
func (executor *transactionExecutor) commit(
invalidator derived.TransactionInvalidator,
) error {
if executor.txnState.NumNestedTransactions() > 1 {
// This is a fvm internal programming error. We forgot to call Commit
// somewhere in the control flow. We should halt.
return fmt.Errorf(
"successfully executed transaction has unexpected " +
"nested transactions.")
}
err := executor.output.PopulateEnvironmentValues(executor.env)
if err != nil {
return err
}
// Based on various (e.g., contract) updates, we decide
// how to clean up the derived data. For failed transactions we also do
// the same as a successful transaction without any updates.
executor.txnState.AddInvalidator(invalidator)
_, commitErr := executor.txnState.CommitNestedTransaction(
executor.nestedTxnId)
if commitErr != nil {
return fmt.Errorf(
"transaction invocation failed when merging state: %w",
commitErr)
}
return nil
}