vm

package
v1.8.0-beta.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 22, 2023 License: GPL-3.0 Imports: 35 Imported by: 0

Documentation

Overview

Package vm implements the Ethereum Virtual Machine.

The vm package implements one EVM, a byte code VM. The BC (Byte Code) VM loops over a set of bytes and executes them according to the set of rules defined in the Ethereum yellow paper.

Index

Constants

View Source 
const (
	GasQuickStep   uint64 = 2
	GasFastestStep uint64 = 3
	GasFastStep    uint64 = 5
	GasMidStep     uint64 = 8
	GasSlowStep    uint64 = 10
	GasExtStep     uint64 = 20
)

Gas costs

Variables

View Source 
var (
	PrecompiledAddressesGingerbreadP2 []common.Address
	PrecompiledAddressesEspresso      []common.Address
	PrecompiledAddressesDonut         []common.Address
	PrecompiledAddressesIstanbul      []common.Address
	PrecompiledAddressesByzantium     []common.Address
	PrecompiledAddressesHomestead     []common.Address
)
View Source 
var (
	ErrOutOfGas                 = errors.New("out of gas")
	ErrCodeStoreOutOfGas        = errors.New("contract creation code storage out of gas")
	ErrDepth                    = errors.New("max call depth exceeded")
	ErrTraceLimitReached        = errors.New("the number of logs reached the specified limit")
	ErrInsufficientBalance      = errors.New("insufficient balance for transfer")
	ErrContractAddressCollision = errors.New("contract address collision")
	ErrNoCompatibleInterpreter  = errors.New("no compatible interpreter")
	ErrValidatorsOutOfBounds    = errors.New("validator index out of bounds")
	ErrBlockNumberOutOfBounds   = errors.New("block number out of bounds")
	ErrInputLength              = errors.New("invalid input length")
	ErrInputDecode              = errors.New("unable to decode input")
	ErrInputVerification        = errors.New("unable to verify header")
	ErrEngineIncompatible       = errors.New("blockchain engine incompatible with request")
	ErrUnexpected               = errors.New("unexpected execution error")
	ErrExecutionReverted        = errors.New("execution reverted")
	ErrMaxCodeSizeExceeded      = errors.New("max code size exceeded")
	ErrInvalidJump              = errors.New("invalid jump destination")
	ErrWriteProtection          = errors.New("write protection")
	ErrReturnDataOutOfBounds    = errors.New("return data out of bounds")
	ErrGasUintOverflow          = errors.New("gas uint64 overflow")
	ErrInvalidCode              = errors.New("invalid code: must not begin with 0xef")
)

List evm execution errors

View Source 
var Cip20HashesDonut = map[uint8]Cip20Hash{
	0:    &Sha3_256{},
	1:    &Sha3_512{},
	2:    &Keccak512{},
	3:    &Sha2_512{},
	0x10: &Blake2s{},
}

Cip20HashesDonut is the set of hashes active in the Donut hard fork.

View Source 
var PrecompiledContractsByzantium = map[common.Address]CeloPrecompiledContract{
	common.BytesToAddress([]byte{1}): &wrap{&ecrecover{}},
	common.BytesToAddress([]byte{2}): &wrap{&sha256hash{}},
	common.BytesToAddress([]byte{3}): &wrap{&ripemd160hash{}},
	common.BytesToAddress([]byte{4}): &wrap{&dataCopy{}},
	common.BytesToAddress([]byte{5}): &wrap{&bigModExp{eip2565: false}},
	common.BytesToAddress([]byte{6}): &wrap{&bn256AddByzantium{}},
	common.BytesToAddress([]byte{7}): &wrap{&bn256ScalarMulByzantium{}},
	common.BytesToAddress([]byte{8}): &wrap{&bn256PairingByzantium{}},

	celoPrecompileAddress(2):  &transfer{},
	celoPrecompileAddress(3):  &fractionMulExp{},
	celoPrecompileAddress(4):  &wrap{&proofOfPossession{}},
	celoPrecompileAddress(5):  &getValidator{},
	celoPrecompileAddress(6):  &numberValidators{},
	celoPrecompileAddress(7):  &epochSize{},
	celoPrecompileAddress(8):  &wrap{&blockNumberFromHeader{}},
	celoPrecompileAddress(9):  &wrap{&hashHeader{}},
	celoPrecompileAddress(10): &getParentSealBitmap{},
	celoPrecompileAddress(11): &getVerifiedSealBitmap{},
}

PrecompiledContractsByzantium contains the default set of pre-compiled Ethereum contracts used in the Byzantium release.

View Source 
var PrecompiledContractsDonut = map[common.Address]CeloPrecompiledContract{
	common.BytesToAddress([]byte{1}): &wrap{&ecrecover{}},
	common.BytesToAddress([]byte{2}): &wrap{&sha256hash{}},
	common.BytesToAddress([]byte{3}): &wrap{&ripemd160hash{}},
	common.BytesToAddress([]byte{4}): &wrap{&dataCopy{}},
	common.BytesToAddress([]byte{5}): &wrap{&bigModExp{eip2565: false}},
	common.BytesToAddress([]byte{6}): &wrap{&bn256AddIstanbul{}},
	common.BytesToAddress([]byte{7}): &wrap{&bn256ScalarMulIstanbul{}},
	common.BytesToAddress([]byte{8}): &wrap{&bn256PairingIstanbul{}},
	common.BytesToAddress([]byte{9}): &wrap{&blake2F{}},

	celoPrecompileAddress(2):  &transfer{},
	celoPrecompileAddress(3):  &fractionMulExp{},
	celoPrecompileAddress(4):  &wrap{&proofOfPossession{}},
	celoPrecompileAddress(5):  &getValidator{},
	celoPrecompileAddress(6):  &numberValidators{},
	celoPrecompileAddress(7):  &epochSize{},
	celoPrecompileAddress(8):  &wrap{&blockNumberFromHeader{}},
	celoPrecompileAddress(9):  &wrap{&hashHeader{}},
	celoPrecompileAddress(10): &getParentSealBitmap{},
	celoPrecompileAddress(11): &getVerifiedSealBitmap{},

	celoPrecompileAddress(12): &ed25519Verify{},
	celoPrecompileAddress(13): &wrap{&bls12381G1Add{}},
	celoPrecompileAddress(14): &wrap{&bls12381G1Mul{}},
	celoPrecompileAddress(15): &wrap{&bls12381G1MultiExp{}},
	celoPrecompileAddress(16): &wrap{&bls12381G2Add{}},
	celoPrecompileAddress(17): &wrap{&bls12381G2Mul{}},
	celoPrecompileAddress(18): &wrap{&bls12381G2MultiExp{}},
	celoPrecompileAddress(19): &wrap{&bls12381Pairing{}},
	celoPrecompileAddress(20): &wrap{&bls12381MapG1{}},
	celoPrecompileAddress(21): &wrap{&bls12381MapG2{}},
	celoPrecompileAddress(22): &wrap{&bls12377G1Add{}},
	celoPrecompileAddress(23): &wrap{&bls12377G1Mul{}},
	celoPrecompileAddress(24): &wrap{&bls12377G1MultiExp{}},
	celoPrecompileAddress(25): &wrap{&bls12377G2Add{}},
	celoPrecompileAddress(26): &wrap{&bls12377G2Mul{}},
	celoPrecompileAddress(27): &wrap{&bls12377G2MultiExp{}},
	celoPrecompileAddress(28): &wrap{&bls12377Pairing{}},
	celoPrecompileAddress(29): &wrap{&cip20HashFunctions{Cip20HashesDonut}},
	celoPrecompileAddress(30): &getValidatorBLS{},
}

PrecompiledContractsDonut contains the default set of pre-compiled Ethereum contracts used in the Donut release.

View Source 
var PrecompiledContractsEspresso = map[common.Address]CeloPrecompiledContract{
	common.BytesToAddress([]byte{1}): &wrap{&ecrecover{}},
	common.BytesToAddress([]byte{2}): &wrap{&sha256hash{}},
	common.BytesToAddress([]byte{3}): &wrap{&ripemd160hash{}},
	common.BytesToAddress([]byte{4}): &wrap{&dataCopy{}},
	common.BytesToAddress([]byte{5}): &wrap{&bigModExp{eip2565: true}},
	common.BytesToAddress([]byte{6}): &wrap{&bn256AddIstanbul{}},
	common.BytesToAddress([]byte{7}): &wrap{&bn256ScalarMulIstanbul{}},
	common.BytesToAddress([]byte{8}): &wrap{&bn256PairingIstanbul{}},
	common.BytesToAddress([]byte{9}): &wrap{&blake2F{}},

	celoPrecompileAddress(2):  &transfer{},
	celoPrecompileAddress(3):  &fractionMulExp{},
	celoPrecompileAddress(4):  &wrap{&proofOfPossession{}},
	celoPrecompileAddress(5):  &getValidator{},
	celoPrecompileAddress(6):  &numberValidators{},
	celoPrecompileAddress(7):  &epochSize{},
	celoPrecompileAddress(8):  &wrap{&blockNumberFromHeader{}},
	celoPrecompileAddress(9):  &wrap{&hashHeader{}},
	celoPrecompileAddress(10): &getParentSealBitmap{},
	celoPrecompileAddress(11): &getVerifiedSealBitmap{},

	celoPrecompileAddress(12): &ed25519Verify{},
	celoPrecompileAddress(13): &wrap{&bls12381G1Add{}},
	celoPrecompileAddress(14): &wrap{&bls12381G1Mul{}},
	celoPrecompileAddress(15): &wrap{&bls12381G1MultiExp{}},
	celoPrecompileAddress(16): &wrap{&bls12381G2Add{}},
	celoPrecompileAddress(17): &wrap{&bls12381G2Mul{}},
	celoPrecompileAddress(18): &wrap{&bls12381G2MultiExp{}},
	celoPrecompileAddress(19): &wrap{&bls12381Pairing{}},
	celoPrecompileAddress(20): &wrap{&bls12381MapG1{}},
	celoPrecompileAddress(21): &wrap{&bls12381MapG2{}},
	celoPrecompileAddress(22): &wrap{&bls12377G1Add{}},
	celoPrecompileAddress(23): &wrap{&bls12377G1Mul{}},
	celoPrecompileAddress(24): &wrap{&bls12377G1MultiExp{}},
	celoPrecompileAddress(25): &wrap{&bls12377G2Add{}},
	celoPrecompileAddress(26): &wrap{&bls12377G2Mul{}},
	celoPrecompileAddress(27): &wrap{&bls12377G2MultiExp{}},
	celoPrecompileAddress(28): &wrap{&bls12377Pairing{}},
	celoPrecompileAddress(29): &wrap{&cip20HashFunctions{Cip20HashesDonut}},
	celoPrecompileAddress(30): &getValidatorBLS{},
}

PrecompiledContractsEspresso contains the default set of pre-compiled Ethereum contracts used in the Espresso release.

View Source 
var PrecompiledContractsGingerbreadP2 = map[common.Address]CeloPrecompiledContract{
	common.BytesToAddress([]byte{1}): &wrap{&ecrecover{}},
	common.BytesToAddress([]byte{2}): &wrap{&sha256hash{}},
	common.BytesToAddress([]byte{3}): &wrap{&ripemd160hash{}},
	common.BytesToAddress([]byte{4}): &wrap{&dataCopy{}},
	common.BytesToAddress([]byte{5}): &wrap{&bigModExp{eip2565: true}},
	common.BytesToAddress([]byte{6}): &wrap{&bn256AddIstanbul{}},
	common.BytesToAddress([]byte{7}): &wrap{&bn256ScalarMulIstanbul{}},
	common.BytesToAddress([]byte{8}): &wrap{&bn256PairingIstanbul{}},
	common.BytesToAddress([]byte{9}): &wrap{&blake2F{}},

	celoPrecompileAddress(2):  &transfer{},
	celoPrecompileAddress(3):  &fractionMulExp{},
	celoPrecompileAddress(4):  &wrap{&proofOfPossession{}},
	celoPrecompileAddress(5):  &getValidator{},
	celoPrecompileAddress(6):  &numberValidators{},
	celoPrecompileAddress(7):  &epochSize{},
	celoPrecompileAddress(8):  &wrap{&blockNumberFromHeader{}},
	celoPrecompileAddress(9):  &wrap{&hashHeader{}},
	celoPrecompileAddress(10): &getParentSealBitmap{},
	celoPrecompileAddress(11): &getVerifiedSealBitmap{},

	celoPrecompileAddress(30): &getValidatorBLS{},
}

PrecompiledContractsGingerbread contains the default set of pre-compiled Ethereum contracts used in the Gingerbread release.

View Source 
var PrecompiledContractsHomestead = map[common.Address]CeloPrecompiledContract{
	common.BytesToAddress([]byte{1}): &wrap{&ecrecover{}},
	common.BytesToAddress([]byte{2}): &wrap{&sha256hash{}},
	common.BytesToAddress([]byte{3}): &wrap{&ripemd160hash{}},
	common.BytesToAddress([]byte{4}): &wrap{&dataCopy{}},
}

PrecompiledContractsHomestead contains the default set of pre-compiled Ethereum contracts used in the Frontier and Homestead releases.

View Source 
var PrecompiledContractsIstanbul = map[common.Address]CeloPrecompiledContract{
	common.BytesToAddress([]byte{1}): &wrap{&ecrecover{}},
	common.BytesToAddress([]byte{2}): &wrap{&sha256hash{}},
	common.BytesToAddress([]byte{3}): &wrap{&ripemd160hash{}},
	common.BytesToAddress([]byte{4}): &wrap{&dataCopy{}},
	common.BytesToAddress([]byte{5}): &wrap{&bigModExp{eip2565: false}},
	common.BytesToAddress([]byte{6}): &wrap{&bn256AddIstanbul{}},
	common.BytesToAddress([]byte{7}): &wrap{&bn256ScalarMulIstanbul{}},
	common.BytesToAddress([]byte{8}): &wrap{&bn256PairingIstanbul{}},
	common.BytesToAddress([]byte{9}): &wrap{&blake2F{}},

	celoPrecompileAddress(2):  &transfer{},
	celoPrecompileAddress(3):  &fractionMulExp{},
	celoPrecompileAddress(4):  &wrap{&proofOfPossession{}},
	celoPrecompileAddress(5):  &getValidator{},
	celoPrecompileAddress(6):  &numberValidators{},
	celoPrecompileAddress(7):  &epochSize{},
	celoPrecompileAddress(8):  &wrap{&blockNumberFromHeader{}},
	celoPrecompileAddress(9):  &wrap{&hashHeader{}},
	celoPrecompileAddress(10): &getParentSealBitmap{},
	celoPrecompileAddress(11): &getVerifiedSealBitmap{},
}

PrecompiledContractsIstanbul contains the default set of pre-compiled Ethereum contracts used in the Istanbul release.

Functions

func ActivateableEips added in v1.4.0 

func ActivateableEips() []string

func ActivePrecompiles added in v1.5.0 

func ActivePrecompiles(rules params.Rules) []common.Address

ActivePrecompiles returns the precompiles enabled with the current configuration.

func EnableEIP 

func EnableEIP(eipNum int, jt *JumpTable) error

EnableEIP enables the given EIP on the config. This operation writes in-place, and callers need to ensure that the globally defined jump tables are not polluted.

func NewContext added in v1.8.0 

func NewContext(caller common.Address, evm *EVM) *celoPrecompileContext

func NewMarkdownLogger added in v1.4.0 

func NewMarkdownLogger(cfg *LogConfig, writer io.Writer) *mdLogger

NewMarkdownLogger creates a logger which outputs information in a format adapted for human readability, and is also a valid markdown table

func RunPrecompiledContract 

func RunPrecompiledContract(p CeloPrecompiledContract, input []byte, suppliedGas uint64, ctx *celoPrecompileContext) (ret []byte, remainingGas uint64, err error)

RunPrecompiledContract runs and evaluates the output of a precompiled contract. It returns - the returned bytes, - the _remaining_ gas, - any error that occurred

func ValidEip added in v1.4.0 

func ValidEip(eipNum int) bool

func WriteLogs 

func WriteLogs(writer io.Writer, logs []*types.Log)

WriteLogs writes vm logs in a readable format to the given writer

func WriteTrace 

func WriteTrace(writer io.Writer, logs []StructLog)

WriteTrace writes a formatted trace to the given writer

Types

type AccessListTracer added in v1.5.0 

type AccessListTracer struct {
	// contains filtered or unexported fields
}

AccessListTracer is a tracer that accumulates touched accounts and storage slots into an internal set.

func NewAccessListTracer added in v1.5.0 

func NewAccessListTracer(acl types.AccessList, from, to common.Address, precompiles []common.Address) *AccessListTracer

NewAccessListTracer creates a new tracer that can generate AccessLists. An optional AccessList can be specified to occupy slots and addresses in the resulting accesslist.

func (*AccessListTracer) AccessList added in v1.5.0 

func (a *AccessListTracer) AccessList() types.AccessList

AccessList returns the current accesslist maintained by the tracer.

func (*AccessListTracer) CaptureEnd added in v1.5.0 

func (*AccessListTracer) CaptureEnd(output []byte, gasUsed uint64, t time.Duration, err error)

func (*AccessListTracer) CaptureEnter added in v1.6.0 

func (*AccessListTracer) CaptureEnter(typ OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int)

func (*AccessListTracer) CaptureExit added in v1.6.0 

func (*AccessListTracer) CaptureExit(output []byte, gasUsed uint64, err error)

func (*AccessListTracer) CaptureFault added in v1.5.0 

func (*AccessListTracer) CaptureFault(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, depth int, err error)

func (*AccessListTracer) CaptureStart added in v1.5.0 

func (a *AccessListTracer) CaptureStart(env *EVM, from common.Address, to common.Address, create bool, input []byte, gas uint64, value *big.Int)

func (*AccessListTracer) CaptureState added in v1.5.0 

func (a *AccessListTracer) CaptureState(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, rData []byte, depth int, err error)

CaptureState captures all opcodes that touch storage or addresses and adds them to the accesslist.

func (*AccessListTracer) Equal added in v1.5.0 

func (a *AccessListTracer) Equal(other *AccessListTracer) bool

Equal returns if the content of two access list traces are equal.

type AccountRef 

type AccountRef common.Address

AccountRef implements ContractRef.

Account references are used during EVM initialisation and it's primary use is to fetch addresses. Removing this object proves difficult because of the cached jump destinations which are fetched from the parent contract (i.e. the caller), which is a ContractRef.

func (AccountRef) Address 

func (ar AccountRef) Address() common.Address

Address casts AccountRef to a Address

type Blake2s 

type Blake2s struct{}

The Blake2s hash function

func (*Blake2s) RequiredGas 

func (c *Blake2s) RequiredGas(input []byte) uint64

RequiredGas for Blake2s

func (*Blake2s) Run 

func (c *Blake2s) Run(input []byte) ([]byte, error)

Run function for Blake2s

type BlockContext added in v1.5.0 

type BlockContext struct {
	// CanTransfer returns whether the account contains
	// sufficient ether to transfer the value
	CanTransfer CanTransferFunc
	// Transfer transfers ether from one account to the other
	Transfer TransferFunc
	// GetHash returns the hash corresponding to n
	GetHash GetHashFunc
	// GetParentSealBitmap returns the parent seal bitmap corresponding to n
	GetHeaderByNumber GetHeaderByNumberFunc
	// VerifySeal verifies or returns an error for the given header
	VerifySeal VerifySealFunc

	// Block information
	Coinbase    common.Address // Provides information for COINBASE
	GasLimit    uint64         // Provides information for GASLIMIT
	BlockNumber *big.Int       // Provides information for NUMBER
	Time        *big.Int       // Provides information for TIME

	EpochSize          uint64
	GetValidators      GetValidatorsFunc
	IsGoldTokenAddress IsGoldTokenAddressFunc
	BaseFee            *big.Int // Provides information for BASEFEE
}

BlockContext provides the EVM with auxiliary information. Once provided it shouldn't be modified.

type CallContext 

type CallContext interface {
	// Call another contract
	Call(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
	// Take another's contract code and execute within our own context
	CallCode(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
	// Same as CallCode except sender and value is propagated from parent to child scope
	DelegateCall(env *EVM, me ContractRef, addr common.Address, data []byte, gas *big.Int) ([]byte, error)
	// Create a new contract
	Create(env *EVM, me ContractRef, data []byte, gas, value *big.Int) ([]byte, common.Address, error)
}

CallContext provides a basic interface for the EVM calling conventions. The EVM depends on this context being implemented for doing subcalls and initialising new EVM contracts.

type CanTransferFunc 

type CanTransferFunc func(StateDB, common.Address, *big.Int) bool

CanTransferFunc is the signature of a transfer guard function

type CeloPrecompiledContract added in v1.8.0 

type CeloPrecompiledContract interface {
	RequiredGas(input []byte) uint64                              // RequiredGas calculates the contract gas use
	Run(input []byte, ctx *celoPrecompileContext) ([]byte, error) // Run runs the precompiled contract
}

type Cip20Hash 

type Cip20Hash interface {
	RequiredGas(input []byte) uint64  // RequiredGas calculates the contract gas use
	Run(input []byte) ([]byte, error) // Run runs the precompiled contract
}

Cip20Hash is an interface for CIP20 hash functions. It is a trimmed down version of the Precompile interface.

type Config 

type Config struct {
	Debug                   bool      // Enables debugging
	Tracer                  EVMLogger // Opcode logger
	NoRecursion             bool      // Disables call, callcode, delegate call and create
	NoBaseFee               bool      // Forces the EIP-1559 baseFee to 0 (needed for 0 price calls)
	EnablePreimageRecording bool      // Enables recording of SHA3/keccak preimages

	JumpTable [256]*operation // EVM instruction table, automatically populated if unset

	ExtraEips []int // Additional EIPS that are to be enabled
}

Config are the configuration options for the Interpreter

type Contract 

type Contract struct {
	// CallerAddress is the result of the caller which initialised this
	// contract. However when the "call method" is delegated this value
	// needs to be initialised to that of the caller's caller.
	CallerAddress common.Address

	Code     []byte
	CodeHash common.Hash
	CodeAddr *common.Address
	Input    []byte

	Gas uint64
	// contains filtered or unexported fields
}

Contract represents an ethereum contract in the state database. It contains the contract code, calling arguments. Contract implements ContractRef

func NewContract 

func NewContract(caller ContractRef, object ContractRef, value *big.Int, gas uint64) *Contract

NewContract returns a new contract environment for the execution of EVM.

func (*Contract) Address 

func (c *Contract) Address() common.Address

Address returns the contracts address

func (*Contract) AsDelegate 

func (c *Contract) AsDelegate() *Contract

AsDelegate sets the contract to be a delegate call and returns the current contract (for chaining calls)

func (*Contract) Caller 

func (c *Contract) Caller() common.Address

Caller returns the caller of the contract.

Caller will recursively call caller when the contract is a delegate call, including that of caller's caller.

func (*Contract) GetByte 

func (c *Contract) GetByte(n uint64) byte

GetByte returns the n'th byte in the contract's byte array

func (*Contract) GetOp 

func (c *Contract) GetOp(n uint64) OpCode

GetOp returns the n'th element in the contract's byte array

func (*Contract) SetCallCode 

func (c *Contract) SetCallCode(addr *common.Address, hash common.Hash, code []byte)

SetCallCode sets the code of the contract and address of the backing data object

func (*Contract) SetCodeOptionalHash 

func (c *Contract) SetCodeOptionalHash(addr *common.Address, codeAndHash *codeAndHash)

SetCodeOptionalHash can be used to provide code, but it's optional to provide hash. In case hash is not provided, the jumpdest analysis will not be saved to the parent context

func (*Contract) UseGas 

func (c *Contract) UseGas(gas uint64) (ok bool)

UseGas attempts the use gas and subtracts it and returns true on success

func (*Contract) Value 

func (c *Contract) Value() *big.Int

Value returns the contract's value (sent to it from it's caller)

type ContractRef 

type ContractRef interface {
	Address() common.Address
}

ContractRef is a reference to the contract's backing object

type EVM 

type EVM struct {
	// Context provides auxiliary blockchain related information
	Context BlockContext
	TxContext
	// StateDB gives access to the underlying state
	StateDB StateDB

	// virtual machine configuration options used to initialise the
	// evm.
	Config Config
	// contains filtered or unexported fields
}

EVM is the Ethereum Virtual Machine base object and provides the necessary tools to run a contract on the given state with the provided context. It should be noted that any error generated through any of the calls should be considered a revert-state-and-consume-all-gas operation, no checks on specific errors should ever be performed. The interpreter makes sure that any errors generated are to be considered faulty code.

The EVM should never be reused and is not thread safe.

func NewEVM 

func NewEVM(blockCtx BlockContext, txCtx TxContext, statedb StateDB, chainConfig *params.ChainConfig, config Config) *EVM

NewEVM returns a new EVM. The returned EVM is not thread safe and should only ever be used *once*.

func (*EVM) Call 

func (evm *EVM) Call(caller ContractRef, addr common.Address, input []byte, gas uint64, value *big.Int) (ret []byte, leftOverGas uint64, err error)

Call executes the contract associated with the addr with the given input as parameters. It also handles any necessary value transfer required and takes the necessary steps to create accounts and reverses the state in case of an execution error or failed value transfer.

func (*EVM) CallCode 

func (evm *EVM) CallCode(caller ContractRef, addr common.Address, input []byte, gas uint64, value *big.Int) (ret []byte, leftOverGas uint64, err error)

CallCode executes the contract associated with the addr with the given input as parameters. It also handles any necessary value transfer required and takes the necessary steps to create accounts and reverses the state in case of an execution error or failed value transfer.

CallCode differs from Call in the sense that it executes the given address' code with the caller as context.

func (*EVM) Cancel 

func (evm *EVM) Cancel()

Cancel cancels any running EVM operation. This may be called concurrently and it's safe to be called multiple times.

func (*EVM) Cancelled 

func (evm *EVM) Cancelled() bool

Cancelled returns true if Cancel has been called

func (*EVM) ChainConfig 

func (evm *EVM) ChainConfig() *params.ChainConfig

ChainConfig returns the environment's chain configuration

func (*EVM) Create 

func (evm *EVM) Create(caller ContractRef, code []byte, gas uint64, value *big.Int) (ret []byte, contractAddr common.Address, leftOverGas uint64, err error)

Create creates a new contract using code as deployment code.

func (*EVM) Create2 

func (evm *EVM) Create2(caller ContractRef, code []byte, gas uint64, endowment *big.Int, salt *uint256.Int) (ret []byte, contractAddr common.Address, leftOverGas uint64, err error)

Create2 creates a new contract using code as deployment code.

The different between Create2 with Create is Create2 uses sha3(0xff ++ msg.sender ++ salt ++ sha3(init_code))[12:] instead of the usual sender-and-nonce-hash as the address where the contract is initialized at.

func (*EVM) DelegateCall 

func (evm *EVM) DelegateCall(caller ContractRef, addr common.Address, input []byte, gas uint64) (ret []byte, leftOverGas uint64, err error)

DelegateCall executes the contract associated with the addr with the given input as parameters. It reverses the state in case of an execution error.

DelegateCall differs from CallCode in the sense that it executes the given address' code with the caller as context and the caller is set to the caller of the caller.

func (*EVM) GetDebug 

func (evm *EVM) GetDebug() bool

func (*EVM) GetStateDB 

func (evm *EVM) GetStateDB() StateDB

func (*EVM) Interpreter 

func (evm *EVM) Interpreter() *EVMInterpreter

Interpreter returns the current interpreter

func (*EVM) Reset added in v1.5.0 

func (evm *EVM) Reset(txCtx TxContext, statedb StateDB)

Reset resets the EVM with a new transaction context.Reset This is not threadsafe and should only be done very cautiously.

func (*EVM) SetDebug 

func (evm *EVM) SetDebug(value bool)

func (*EVM) StartGasMetering added in v1.4.0 

func (evm *EVM) StartGasMetering()

func (*EVM) StaticCall 

func (evm *EVM) StaticCall(caller ContractRef, addr common.Address, input []byte, gas uint64) (ret []byte, leftOverGas uint64, err error)

StaticCall executes the contract associated with the addr with the given input as parameters while disallowing any modifications to the state during the call. Opcodes that attempt to perform such modifications will result in exceptions instead of performing the modifications.

func (*EVM) StopGasMetering added in v1.4.0 

func (evm *EVM) StopGasMetering()

type EVMInterpreter 

type EVMInterpreter struct {
	// contains filtered or unexported fields
}

EVMInterpreter represents an EVM interpreter

func NewEVMInterpreter 

func NewEVMInterpreter(evm *EVM, cfg Config) *EVMInterpreter

NewEVMInterpreter returns a new instance of the Interpreter.

func (*EVMInterpreter) Run 

func (in *EVMInterpreter) Run(contract *Contract, input []byte, readOnly bool) (ret []byte, err error)

Run loops and evaluates the contract's code with the given input data and returns the return byte-slice and an error if one occurred.

It's important to note that any errors returned by the interpreter should be considered a revert-and-consume-all-gas operation except for ErrExecutionReverted which means revert-and-keep-gas-left.

type EVMLogger added in v1.8.0 

type EVMLogger interface {
	CaptureStart(env *EVM, from common.Address, to common.Address, create bool, input []byte, gas uint64, value *big.Int)
	CaptureState(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, rData []byte, depth int, err error)
	CaptureEnter(typ OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int)
	CaptureExit(output []byte, gasUsed uint64, err error)
	CaptureFault(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, depth int, err error)
	CaptureEnd(output []byte, gasUsed uint64, t time.Duration, err error)
}

EVMLogger is used to collect execution traces from an EVM transaction execution. CaptureState is called for each step of the VM with the current VM state. Note that reference types are actual VM data structures; make copies if you need to retain them beyond the current call.

type EVMRunner added in v1.4.0 

type EVMRunner interface {
	// Execute performs a potentially write operation over the runner's state
	// It can be seen as a message (input,value) from sender to recipient that returns `ret`
	Execute(recipient common.Address, input []byte, gas uint64, value *big.Int) (ret []byte, err error)

	// ExecuteFrom is like Execute, but lets you specify the sender to use for the EVM call.
	// It exists only for use in the Tobin tax calculation done as part of TobinTransfer, because that
	// originally used the transaction's sender instead of the zero address.
	ExecuteFrom(sender, recipient common.Address, input []byte, gas uint64, value *big.Int) (ret []byte, err error)

	// Query performs a read operation over the runner's state
	// It can be seen as a message (input,value) from sender to recipient that returns `ret`
	Query(recipient common.Address, input []byte, gas uint64) (ret []byte, err error)

	// StopGasMetering backward compatibility method to stop gas metering
	// Deprecated. DO NOT USE
	StopGasMetering()

	// StartGasMetering backward compatibility method to start gas metering
	// Deprecated. DO NOT USE
	StartGasMetering()
}

EVMRunner provides a simplified API to run EVM calls EVM's sender, gasPrice, txFeeRecipient and state are set by the runner on each call This object can be re-used many times in contrast to the EVM's single use behaviour.

type ErrInvalidOpCode 

type ErrInvalidOpCode struct {
	// contains filtered or unexported fields
}

ErrInvalidOpCode wraps an evm error when an invalid opcode is encountered.

func (*ErrInvalidOpCode) Error 

func (e *ErrInvalidOpCode) Error() string

type ErrStackOverflow 

type ErrStackOverflow struct {
	// contains filtered or unexported fields
}

ErrStackOverflow wraps an evm error when the items on the stack exceeds the maximum allowance.

func (*ErrStackOverflow) Error 

func (e *ErrStackOverflow) Error() string

type ErrStackUnderflow 

type ErrStackUnderflow struct {
	// contains filtered or unexported fields
}

ErrStackUnderflow wraps an evm error when the items on the stack less than the minimal requirement.

func (*ErrStackUnderflow) Error 

func (e *ErrStackUnderflow) Error() string

type GetHashFunc 

type GetHashFunc func(uint64) common.Hash

GetHashFunc returns the n'th block hash in the blockchain and is used by the BLOCKHASH EVM op code.

type GetHeaderByNumberFunc 

type GetHeaderByNumberFunc func(uint64) *types.Header

GetHeaderByNumberFunc returns the header of the nth block in the chain.

type GetValidatorsFunc 

type GetValidatorsFunc func(blockNumber *big.Int, headerHash common.Hash) []istanbul.Validator

GetValidatorsFunc is the signature for the GetValidators function

type IsGoldTokenAddressFunc added in v1.8.0 

type IsGoldTokenAddressFunc func(evm *EVM, address common.Address) (bool, error)

IsGoldTokenAddressFunc indicates if an address correspond to the GoldToken contract address

type JSONLogger 

type JSONLogger struct {
	// contains filtered or unexported fields
}

func NewJSONLogger 

func NewJSONLogger(cfg *LogConfig, writer io.Writer) *JSONLogger

NewJSONLogger creates a new EVM tracer that prints execution steps as JSON objects into the provided stream.

func (*JSONLogger) CaptureEnd 

func (l *JSONLogger) CaptureEnd(output []byte, gasUsed uint64, t time.Duration, err error)

CaptureEnd is triggered at end of execution.

func (*JSONLogger) CaptureEnter added in v1.6.0 

func (l *JSONLogger) CaptureEnter(typ OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int)

func (*JSONLogger) CaptureExit added in v1.6.0 

func (l *JSONLogger) CaptureExit(output []byte, gasUsed uint64, err error)

func (*JSONLogger) CaptureFault 

func (l *JSONLogger) CaptureFault(uint64, OpCode, uint64, uint64, *ScopeContext, int, error)

func (*JSONLogger) CaptureStart 

func (l *JSONLogger) CaptureStart(env *EVM, from, to common.Address, create bool, input []byte, gas uint64, value *big.Int)

func (*JSONLogger) CaptureState 

func (l *JSONLogger) CaptureState(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, rData []byte, depth int, err error)

CaptureState outputs state information on the logger.

type JumpTable 

type JumpTable [256]*operation

JumpTable contains the EVM opcodes supported at a given fork.

type Keccak512 

type Keccak512 struct{}

The Keccak512 hash function

func (*Keccak512) RequiredGas 

func (c *Keccak512) RequiredGas(input []byte) uint64

RequiredGas for Keccak512

func (*Keccak512) Run 

func (c *Keccak512) Run(input []byte) ([]byte, error)

Run function for Keccak512

type LogConfig 

type LogConfig struct {
	EnableMemory     bool // enable memory capture
	DisableStack     bool // disable stack capture
	DisableStorage   bool // disable storage capture
	EnableReturnData bool // enable return data capture
	Debug            bool // print output during capture end
	Limit            int  // maximum length of output, but zero means unlimited
	// Chain overrides, can be used to execute a trace using future fork rules
	Overrides *params.ChainConfig `json:"overrides,omitempty"`
}

LogConfig are the configuration options for structured logger the EVM

type Memory 

type Memory struct {
	// contains filtered or unexported fields
}

Memory implements a simple memory model for the ethereum virtual machine.

func NewMemory 

func NewMemory() *Memory

NewMemory returns a new memory model.

func (*Memory) Data 

func (m *Memory) Data() []byte

Data returns the backing slice

func (*Memory) GetCopy 

func (m *Memory) GetCopy(offset, size int64) (cpy []byte)

Get returns offset + size as a new slice

func (*Memory) GetPtr 

func (m *Memory) GetPtr(offset, size int64) []byte

GetPtr returns the offset + size

func (*Memory) Len 

func (m *Memory) Len() int

Len returns the length of the backing slice

func (*Memory) Print 

func (m *Memory) Print()

Print dumps the content of the memory.

func (*Memory) Resize 

func (m *Memory) Resize(size uint64)

Resize resizes the memory to size

func (*Memory) Set 

func (m *Memory) Set(offset, size uint64, value []byte)

Set sets offset + size to value

func (*Memory) Set32 

func (m *Memory) Set32(offset uint64, val *uint256.Int)

Set32 sets the 32 bytes starting at offset to the value of val, left-padded with zeroes to 32 bytes.

type OpCode 

type OpCode byte

OpCode is an EVM opcode 

const (
	STOP OpCode = iota
	ADD
	MUL
	SUB
	DIV
	SDIV
	MOD
	SMOD
	ADDMOD
	MULMOD
	EXP
	SIGNEXTEND
)

0x0 range - arithmetic ops. 

const (
	LT OpCode = iota + 0x10
	GT
	SLT
	SGT
	EQ
	ISZERO
	AND
	OR
	XOR
	NOT
	BYTE
	SHL
	SHR
	SAR

	SHA3 OpCode = 0x20
)

0x10 range - comparison ops. 

const (
	ADDRESS OpCode = 0x30 + iota
	BALANCE
	ORIGIN
	CALLER
	CALLVALUE
	CALLDATALOAD
	CALLDATASIZE
	CALLDATACOPY
	CODESIZE
	CODECOPY
	GASPRICE
	EXTCODESIZE
	EXTCODECOPY
	RETURNDATASIZE
	RETURNDATACOPY
	EXTCODEHASH
)

0x30 range - closure state. 

const (
	BLOCKHASH OpCode = 0x40 + iota
	COINBASE
	TIMESTAMP
	NUMBER
	GASLIMIT    OpCode = 0x45
	CHAINID     OpCode = 0x46
	SELFBALANCE OpCode = 0x47
	BASEFEE     OpCode = 0x48
)

0x40 range - block operations. 

const (
	POP      OpCode = 0x50
	MLOAD    OpCode = 0x51
	MSTORE   OpCode = 0x52
	MSTORE8  OpCode = 0x53
	SLOAD    OpCode = 0x54
	SSTORE   OpCode = 0x55
	JUMP     OpCode = 0x56
	JUMPI    OpCode = 0x57
	PC       OpCode = 0x58
	MSIZE    OpCode = 0x59
	GAS      OpCode = 0x5a
	JUMPDEST OpCode = 0x5b
)

0x50 range - 'storage' and execution. 

const (
	PUSH1 OpCode = 0x60 + iota
	PUSH2
	PUSH3
	PUSH4
	PUSH5
	PUSH6
	PUSH7
	PUSH8
	PUSH9
	PUSH10
	PUSH11
	PUSH12
	PUSH13
	PUSH14
	PUSH15
	PUSH16
	PUSH17
	PUSH18
	PUSH19
	PUSH20
	PUSH21
	PUSH22
	PUSH23
	PUSH24
	PUSH25
	PUSH26
	PUSH27
	PUSH28
	PUSH29
	PUSH30
	PUSH31
	PUSH32
	DUP1
	DUP2
	DUP3
	DUP4
	DUP5
	DUP6
	DUP7
	DUP8
	DUP9
	DUP10
	DUP11
	DUP12
	DUP13
	DUP14
	DUP15
	DUP16
	SWAP1
	SWAP2
	SWAP3
	SWAP4
	SWAP5
	SWAP6
	SWAP7
	SWAP8
	SWAP9
	SWAP10
	SWAP11
	SWAP12
	SWAP13
	SWAP14
	SWAP15
	SWAP16
)

0x60 range. 

const (
	LOG0 OpCode = 0xa0 + iota
	LOG1
	LOG2
	LOG3
	LOG4
)

0xa0 range - logging ops. 

const (
	PUSH OpCode = 0xb0 + iota
	DUP
	SWAP
)

unofficial opcodes used for parsing. 

const (
	CREATE OpCode = 0xf0 + iota
	CALL
	CALLCODE
	RETURN
	DELEGATECALL
	CREATE2
	STATICCALL   OpCode = 0xfa
	REVERT       OpCode = 0xfd
	SELFDESTRUCT OpCode = 0xff
)

0xf0 range - closures.

func StringToOp 

func StringToOp(str string) OpCode

StringToOp finds the opcode whose name is stored in `str`.

func (OpCode) IsPush 

func (op OpCode) IsPush() bool

IsPush specifies if an opcode is a PUSH opcode.

func (OpCode) IsStaticJump 

func (op OpCode) IsStaticJump() bool

IsStaticJump specifies if an opcode is JUMP.

func (OpCode) String 

func (op OpCode) String() string

type PrecompiledContract 

type PrecompiledContract interface {
	RequiredGas(input []byte) uint64  // RequiredGas calculates the contract gas use
	Run(input []byte) ([]byte, error) // Run runs the precompiled contract
}

PrecompiledContract is the basic interface for native Go contracts. The implementation requires a deterministic gas count based on the input size of the Run method of the contract.

type ScopeContext added in v1.5.0 

type ScopeContext struct {
	Memory   *Memory
	Stack    *Stack
	Contract *Contract
}

ScopeContext contains the things that are per-call, such as stack and memory, but not transients like pc and gas

type Sha2_512 

type Sha2_512 struct{}

The Sha2_512 hash function

func (*Sha2_512) RequiredGas 

func (c *Sha2_512) RequiredGas(input []byte) uint64

RequiredGas for Sha2_512

func (*Sha2_512) Run 

func (c *Sha2_512) Run(input []byte) ([]byte, error)

Run function for Sha2_512

type Sha3_256 

type Sha3_256 struct{}

The Sha3_256 hash function

func (*Sha3_256) RequiredGas 

func (c *Sha3_256) RequiredGas(input []byte) uint64

RequiredGas for Sha3_256

func (*Sha3_256) Run 

func (c *Sha3_256) Run(input []byte) ([]byte, error)

Run function for Sha3_256

type Sha3_512 

type Sha3_512 struct{}

The Sha3_512 hash function

func (*Sha3_512) RequiredGas 

func (c *Sha3_512) RequiredGas(input []byte) uint64

RequiredGas for Sha3_512

func (*Sha3_512) Run 

func (c *Sha3_512) Run(input []byte) ([]byte, error)

Run function for Sha3_512

type Stack 

type Stack struct {
	// contains filtered or unexported fields
}

Stack is an object for basic stack operations. Items popped to the stack are expected to be changed and modified. stack does not take care of adding newly initialised objects.

func (*Stack) Back 

func (st *Stack) Back(n int) *uint256.Int

Back returns the n'th item in stack

func (*Stack) Data 

func (st *Stack) Data() []uint256.Int

Data returns the underlying uint256.Int array.

func (*Stack) Print 

func (st *Stack) Print()

Print dumps the content of the stack

type StateDB 

type StateDB interface {
	CreateAccount(common.Address)

	SubBalance(common.Address, *big.Int)
	AddBalance(common.Address, *big.Int)
	GetBalance(common.Address) *big.Int

	GetNonce(common.Address) uint64
	SetNonce(common.Address, uint64)

	GetCodeHash(common.Address) common.Hash
	GetCode(common.Address) []byte
	SetCode(common.Address, []byte)
	GetCodeSize(common.Address) int

	AddRefund(uint64)
	SubRefund(uint64)
	GetRefund() uint64

	GetCommittedState(common.Address, common.Hash) common.Hash
	GetState(common.Address, common.Hash) common.Hash
	SetState(common.Address, common.Hash, common.Hash)

	Suicide(common.Address) bool
	HasSuicided(common.Address) bool

	// Exist reports whether the given account exists in state.
	// Notably this should also return true for suicided accounts.
	Exist(common.Address) bool
	// Empty returns whether the given account is empty. Empty
	// is defined according to EIP161 (balance = nonce = code = 0).
	Empty(common.Address) bool

	PrepareAccessList(sender common.Address, dest *common.Address, precompiles []common.Address, txAccesses types.AccessList)
	AddressInAccessList(addr common.Address) bool
	SlotInAccessList(addr common.Address, slot common.Hash) (addressOk bool, slotOk bool)
	// AddAddressToAccessList adds the given address to the access list. This operation is safe to perform
	// even if the feature/fork is not active yet
	AddAddressToAccessList(addr common.Address)
	// AddSlotToAccessList adds the given (address,slot) to the access list. This operation is safe to perform
	// even if the feature/fork is not active yet
	AddSlotToAccessList(addr common.Address, slot common.Hash)

	RevertToSnapshot(int)
	Snapshot() int

	AddLog(*types.Log)
	AddPreimage(common.Hash, []byte)

	ForEachStorage(common.Address, func(common.Hash, common.Hash) bool) error

	Finalise(bool)
}

StateDB is an EVM database for full state querying.

type Storage 

type Storage map[common.Hash]common.Hash

Storage represents a contract's storage.

func (Storage) Copy 

func (s Storage) Copy() Storage

Copy duplicates the current storage.

type StructLog 

type StructLog struct {
	Pc            uint64                      `json:"pc"`
	Op            OpCode                      `json:"op"`
	Gas           uint64                      `json:"gas"`
	GasCost       uint64                      `json:"gasCost"`
	Memory        []byte                      `json:"memory"`
	MemorySize    int                         `json:"memSize"`
	Stack         []uint256.Int               `json:"stack"`
	ReturnData    []byte                      `json:"returnData"`
	Storage       map[common.Hash]common.Hash `json:"-"`
	Depth         int                         `json:"depth"`
	RefundCounter uint64                      `json:"refund"`
	Err           error                       `json:"-"`
}

StructLog is emitted to the EVM each cycle and lists information about the current internal state prior to the execution of the statement.

func (*StructLog) ErrorString 

func (s *StructLog) ErrorString() string

ErrorString formats the log's error as a string.

func (StructLog) MarshalJSON 

func (s StructLog) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*StructLog) OpName 

func (s *StructLog) OpName() string

OpName formats the operand name in a human-readable format.

func (*StructLog) UnmarshalJSON 

func (s *StructLog) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

type StructLogger 

type StructLogger struct {
	// contains filtered or unexported fields
}

StructLogger is an EVM state logger and implements EVMLogger.

StructLogger can capture state based on the given Log configuration and also keeps a track record of modified storage which is used in reporting snapshots of the contract their storage.

func NewStructLogger 

func NewStructLogger(cfg *LogConfig) *StructLogger

NewStructLogger returns a new logger

func (*StructLogger) CaptureEnd 

func (l *StructLogger) CaptureEnd(output []byte, gasUsed uint64, t time.Duration, err error)

CaptureEnd is called after the call finishes to finalize the tracing.

func (*StructLogger) CaptureEnter added in v1.6.0 

func (l *StructLogger) CaptureEnter(typ OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int)

func (*StructLogger) CaptureExit added in v1.6.0 

func (l *StructLogger) CaptureExit(output []byte, gasUsed uint64, err error)

func (*StructLogger) CaptureFault 

func (l *StructLogger) CaptureFault(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, depth int, err error)

CaptureFault implements the EVMLogger interface to trace an execution fault while running an opcode.

func (*StructLogger) CaptureStart 

func (l *StructLogger) CaptureStart(env *EVM, from common.Address, to common.Address, create bool, input []byte, gas uint64, value *big.Int)

CaptureStart implements the EVMLogger interface to initialize the tracing operation.

func (*StructLogger) CaptureState 

func (l *StructLogger) CaptureState(pc uint64, op OpCode, gas, cost uint64, scope *ScopeContext, rData []byte, depth int, err error)

CaptureState logs a new structured log message and pushes it out to the environment

CaptureState also tracks SLOAD/SSTORE ops to track storage change.

func (*StructLogger) Error 

func (l *StructLogger) Error() error

Error returns the VM error captured by the trace.

func (*StructLogger) Output 

func (l *StructLogger) Output() []byte

Output returns the VM return value captured by the trace.

func (*StructLogger) Reset added in v1.5.0 

func (l *StructLogger) Reset()

Reset clears the data held by the logger.

func (*StructLogger) StructLogs 

func (l *StructLogger) StructLogs() []StructLog

StructLogs returns the captured log entries.

type TransferFunc 

type TransferFunc func(*EVM, common.Address, common.Address, *big.Int)

TransferFunc is the signature of a transfer function

type TxContext added in v1.5.0 

type TxContext struct {
	// Message information
	Origin   common.Address // Provides information for ORIGIN
	GasPrice *big.Int       // Provides information for GASPRICE
}

TxContext provides the EVM with information about a transaction. All fields can change between transactions.

type VerifySealFunc 

type VerifySealFunc func(*types.Header) bool

VerifySealFunc returns true if the given header contains a valid seal according to the engine's consensus rules.

Source Files

View all Source files

Directories

Path Synopsis
Package runtime provides a basic execution model for executing EVM code.
 Package runtime provides a basic execution model for executing EVM code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.