781915f183
This CL makes several refactors: - Define a Tracer interface, implementing the `CaptureState` method - Add the VM environment as the first argument of `Tracer.CaptureState` - Rename existing functionality `StructLogger` an make it an implementation of `Tracer` - Delete `StructLogCollector` and make `StructLogger` collect the logs directly - Change all callers to use the new `StructLogger` where necessary and extract logs from that. - Deletes the apparently obsolete and likely nonfunctional 'TraceCall' from the eth API. Callers that only wish accumulated logs can use the `StructLogger` implementation straightforwardly. Callers that wish to efficiently capture VM traces and operate on them without excessive copying can now implement the `Tracer` interface to receive VM state at each step and do with it as they wish. This CL also removes the accumulation of logs from the vm.Environment; this was necessary as part of the refactor, but also simplifies it by removing a responsibility that doesn't directly belong to the Environment.
124 lines
4.0 KiB
Go
124 lines
4.0 KiB
Go
// Copyright 2014 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package vm
|
|
|
|
import (
|
|
"math/big"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
)
|
|
|
|
// RuleSet is an interface that defines the current rule set during the
|
|
// execution of the EVM instructions (e.g. whether it's homestead)
|
|
type RuleSet interface {
|
|
IsHomestead(*big.Int) bool
|
|
}
|
|
|
|
// Environment is an EVM requirement and helper which allows access to outside
|
|
// information such as states.
|
|
type Environment interface {
|
|
// The current ruleset
|
|
RuleSet() RuleSet
|
|
// The state database
|
|
Db() Database
|
|
// Creates a restorable snapshot
|
|
MakeSnapshot() Database
|
|
// Set database to previous snapshot
|
|
SetSnapshot(Database)
|
|
// Address of the original invoker (first occurrence of the VM invoker)
|
|
Origin() common.Address
|
|
// The block number this VM is invoked on
|
|
BlockNumber() *big.Int
|
|
// The n'th hash ago from this block number
|
|
GetHash(uint64) common.Hash
|
|
// The handler's address
|
|
Coinbase() common.Address
|
|
// The current time (block time)
|
|
Time() *big.Int
|
|
// Difficulty set on the current block
|
|
Difficulty() *big.Int
|
|
// The gas limit of the block
|
|
GasLimit() *big.Int
|
|
// Determines whether it's possible to transact
|
|
CanTransfer(from common.Address, balance *big.Int) bool
|
|
// Transfers amount from one account to the other
|
|
Transfer(from, to Account, amount *big.Int)
|
|
// Adds a LOG to the state
|
|
AddLog(*Log)
|
|
// Type of the VM
|
|
Vm() Vm
|
|
// Get the curret calling depth
|
|
Depth() int
|
|
// Set the current calling depth
|
|
SetDepth(i int)
|
|
// Call another contract
|
|
Call(me ContractRef, addr common.Address, data []byte, gas, price, value *big.Int) ([]byte, error)
|
|
// Take another's contract code and execute within our own context
|
|
CallCode(me ContractRef, addr common.Address, data []byte, gas, price, value *big.Int) ([]byte, error)
|
|
// Same as CallCode except sender and value is propagated from parent to child scope
|
|
DelegateCall(me ContractRef, addr common.Address, data []byte, gas, price *big.Int) ([]byte, error)
|
|
// Create a new contract
|
|
Create(me ContractRef, data []byte, gas, price, value *big.Int) ([]byte, common.Address, error)
|
|
}
|
|
|
|
// Vm is the basic interface for an implementation of the EVM.
|
|
type Vm interface {
|
|
// Run should execute the given contract with the input given in in
|
|
// and return the contract execution return bytes or an error if it
|
|
// failed.
|
|
Run(c *Contract, in []byte) ([]byte, error)
|
|
}
|
|
|
|
// Database is a EVM database for full state querying.
|
|
type Database interface {
|
|
GetAccount(common.Address) Account
|
|
CreateAccount(common.Address) Account
|
|
|
|
AddBalance(common.Address, *big.Int)
|
|
GetBalance(common.Address) *big.Int
|
|
|
|
GetNonce(common.Address) uint64
|
|
SetNonce(common.Address, uint64)
|
|
|
|
GetCode(common.Address) []byte
|
|
SetCode(common.Address, []byte)
|
|
|
|
AddRefund(*big.Int)
|
|
GetRefund() *big.Int
|
|
|
|
GetState(common.Address, common.Hash) common.Hash
|
|
SetState(common.Address, common.Hash, common.Hash)
|
|
|
|
Delete(common.Address) bool
|
|
Exist(common.Address) bool
|
|
IsDeleted(common.Address) bool
|
|
}
|
|
|
|
// Account represents a contract or basic ethereum account.
|
|
type Account interface {
|
|
SubBalance(amount *big.Int)
|
|
AddBalance(amount *big.Int)
|
|
SetBalance(*big.Int)
|
|
SetNonce(uint64)
|
|
Balance() *big.Int
|
|
Address() common.Address
|
|
ReturnGas(*big.Int, *big.Int)
|
|
SetCode([]byte)
|
|
ForEachStorage(cb func(key, value common.Hash) bool)
|
|
Value() *big.Int
|
|
}
|