github.com/calmw/ethereum@v0.1.1/core/vm/interface.go (about)

     1  // Copyright 2016 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/calmw/ethereum/common"
    23  	"github.com/calmw/ethereum/core/types"
    24  	"github.com/calmw/ethereum/params"
    25  )
    26  
    27  // StateDB is an EVM database for full state querying.
    28  type StateDB interface {
    29  	CreateAccount(common.Address)
    30  
    31  	SubBalance(common.Address, *big.Int)
    32  	AddBalance(common.Address, *big.Int)
    33  	GetBalance(common.Address) *big.Int
    34  
    35  	GetNonce(common.Address) uint64
    36  	SetNonce(common.Address, uint64)
    37  
    38  	GetCodeHash(common.Address) common.Hash
    39  	GetCode(common.Address) []byte
    40  	SetCode(common.Address, []byte)
    41  	GetCodeSize(common.Address) int
    42  
    43  	AddRefund(uint64)
    44  	SubRefund(uint64)
    45  	GetRefund() uint64
    46  
    47  	GetCommittedState(common.Address, common.Hash) common.Hash
    48  	GetState(common.Address, common.Hash) common.Hash
    49  	SetState(common.Address, common.Hash, common.Hash)
    50  
    51  	GetTransientState(addr common.Address, key common.Hash) common.Hash
    52  	SetTransientState(addr common.Address, key, value common.Hash)
    53  
    54  	Suicide(common.Address) bool
    55  	HasSuicided(common.Address) bool
    56  
    57  	// Exist reports whether the given account exists in state.
    58  	// Notably this should also return true for suicided accounts.
    59  	Exist(common.Address) bool
    60  	// Empty returns whether the given account is empty. Empty
    61  	// is defined according to EIP161 (balance = nonce = code = 0).
    62  	Empty(common.Address) bool
    63  
    64  	AddressInAccessList(addr common.Address) bool
    65  	SlotInAccessList(addr common.Address, slot common.Hash) (addressOk bool, slotOk bool)
    66  	// AddAddressToAccessList adds the given address to the access list. This operation is safe to perform
    67  	// even if the feature/fork is not active yet
    68  	AddAddressToAccessList(addr common.Address)
    69  	// AddSlotToAccessList adds the given (address,slot) to the access list. This operation is safe to perform
    70  	// even if the feature/fork is not active yet
    71  	AddSlotToAccessList(addr common.Address, slot common.Hash)
    72  	Prepare(rules params.Rules, sender, coinbase common.Address, dest *common.Address, precompiles []common.Address, txAccesses types.AccessList)
    73  
    74  	RevertToSnapshot(int)
    75  	Snapshot() int
    76  
    77  	AddLog(*types.Log)
    78  	AddPreimage(common.Hash, []byte)
    79  }
    80  
    81  // CallContext provides a basic interface for the EVM calling conventions. The EVM
    82  // depends on this context being implemented for doing subcalls and initialising new EVM contracts.
    83  type CallContext interface {
    84  	// Call calls another contract.
    85  	Call(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    86  	// CallCode takes another contracts code and execute within our own context
    87  	CallCode(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    88  	// DelegateCall is same as CallCode except sender and value is propagated from parent to child scope
    89  	DelegateCall(env *EVM, me ContractRef, addr common.Address, data []byte, gas *big.Int) ([]byte, error)
    90  	// Create creates a new contract
    91  	Create(env *EVM, me ContractRef, data []byte, gas, value *big.Int) ([]byte, common.Address, error)
    92  }