1// Copyright 2021 The go-ethereum Authors
2// This file is part of the go-ethereum library.
3//
4// The go-ethereum library is free software: you can redistribute it and/or modify
5// it under the terms of the GNU Lesser General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// The go-ethereum library is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU Lesser General Public License for more details.
13//
14// You should have received a copy of the GNU Lesser General Public License
15// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
16
17package vm
18
19import (
20	"math/big"
21	"time"
22
23	"github.com/ethereum/go-ethereum/common"
24)
25
26// EVMLogger is used to collect execution traces from an EVM transaction
27// execution. CaptureState is called for each step of the VM with the
28// current VM state.
29// Note that reference types are actual VM data structures; make copies
30// if you need to retain them beyond the current call.
31type EVMLogger interface {
32	CaptureStart(env *EVM, from common.Address, to common.Address, create bool, input []byte, gas uint64, value *big.Int)
33	CaptureState(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, rData []byte, depth int, err error)
34	CaptureEnter(typ OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int)
35	CaptureExit(output []byte, gasUsed uint64, err error)
36	CaptureFault(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, depth int, err error)
37	CaptureEnd(output []byte, gasUsed uint64, t time.Duration, err error)
38}
39