github.com/amazechain/amc@v0.1.3/internal/vm/logger.go (about)

     1  // Copyright 2023 The AmazeChain Authors
     2  // This file is part of the AmazeChain library.
     3  //
     4  // The AmazeChain 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 AmazeChain 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 AmazeChain library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package vm
    18  
    19  import (
    20  	"github.com/amazechain/amc/common/transaction"
    21  	"github.com/amazechain/amc/common/types"
    22  	"github.com/holiman/uint256"
    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  	// Transaction level
    32  	CaptureTxStart(gasLimit uint64)
    33  	CaptureTxEnd(restGas uint64)
    34  	// Top call frame
    35  	CaptureStart(env VMInterface, from types.Address, to types.Address, create bool, input []byte, gas uint64, value *uint256.Int)
    36  	CaptureEnd(output []byte, usedGas uint64, err error)
    37  	// Rest of the frames
    38  	CaptureEnter(typ OpCode, from types.Address, to types.Address, input []byte, gas uint64, value *uint256.Int)
    39  	CaptureExit(output []byte, usedGas uint64, err error)
    40  	// Opcode level
    41  	CaptureState(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, rData []byte, depth int, err error)
    42  	CaptureFault(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, depth int, err error)
    43  }
    44  
    45  // FlushableTracer is a Tracer extension whose accumulated traces has to be
    46  // flushed once the tracing is completed.
    47  type FlushableTracer interface {
    48  	EVMLogger
    49  	Flush(tx transaction.Transaction)
    50  }