github.com/tacshi/go-ethereum@v0.0.0-20230616113857-84a434e20921/core/vm/logger.go (about) 1 // Copyright 2015 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 17 package vm 18 19 import ( 20 "math/big" 21 22 "github.com/tacshi/go-ethereum/common" 23 ) 24 25 // EVMLogger is used to collect execution traces from an EVM transaction 26 // execution. CaptureState is called for each step of the VM with the 27 // current VM state. 28 // Note that reference types are actual VM data structures; make copies 29 // if you need to retain them beyond the current call. 30 type EVMLogger interface { 31 // Arbitrum: capture a transfer, mint, or burn that happens outside of EVM execution 32 CaptureArbitrumTransfer(env *EVM, from, to *common.Address, value *big.Int, before bool, purpose string) 33 CaptureArbitrumStorageGet(key common.Hash, depth int, before bool) 34 CaptureArbitrumStorageSet(key, value common.Hash, depth int, before bool) 35 36 // Transaction level 37 CaptureTxStart(gasLimit uint64) 38 CaptureTxEnd(restGas uint64) 39 // Top call frame 40 CaptureStart(env *EVM, from common.Address, to common.Address, create bool, input []byte, gas uint64, value *big.Int) 41 CaptureEnd(output []byte, gasUsed uint64, err error) 42 // Rest of call frames 43 CaptureEnter(typ OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int) 44 CaptureExit(output []byte, gasUsed uint64, err error) 45 // Opcode level 46 CaptureState(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, rData []byte, depth int, err error) 47 CaptureFault(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, depth int, err error) 48 }