github.com/Cleverse/go-ethereum@v0.0.0-20220927095127-45113064e7f2/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/ethereum/go-ethereum/common"
    23  	"github.com/ethereum/go-ethereum/core/types"
    24  )
    25  
    26  // StateDB is an EVM database for full state querying.
    27  type StateDB interface {
    28  	CreateAccount(common.Address)
    29  
    30  	SubBalance(common.Address, *big.Int)
    31  	AddBalance(common.Address, *big.Int)
    32  	GetBalance(common.Address) *big.Int
    33  	ExpectBalanceBurn(*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  	Suicide(common.Address) bool
    52  	HasSuicided(common.Address) bool
    53  	GetSuicides() []common.Address
    54  
    55  	// Exist reports whether the given account exists in state.
    56  	// Notably this should also return true for suicided accounts.
    57  	Exist(common.Address) bool
    58  	// Empty returns whether the given account is empty. Empty
    59  	// is defined according to EIP161 (balance = nonce = code = 0).
    60  	Empty(common.Address) bool
    61  
    62  	PrepareAccessList(sender common.Address, dest *common.Address, precompiles []common.Address, txAccesses types.AccessList)
    63  	AddressInAccessList(addr common.Address) bool
    64  	SlotInAccessList(addr common.Address, slot common.Hash) (addressOk bool, slotOk bool)
    65  	// AddAddressToAccessList adds the given address to the access list. This operation is safe to perform
    66  	// even if the feature/fork is not active yet
    67  	AddAddressToAccessList(addr common.Address)
    68  	// AddSlotToAccessList adds the given (address,slot) to the access list. This operation is safe to perform
    69  	// even if the feature/fork is not active yet
    70  	AddSlotToAccessList(addr common.Address, slot common.Hash)
    71  
    72  	RevertToSnapshot(int)
    73  	Snapshot() int
    74  
    75  	AddLog(*types.Log)
    76  	AddPreimage(common.Hash, []byte)
    77  	GetCurrentTxLogs() []*types.Log
    78  
    79  	ForEachStorage(common.Address, func(common.Hash, common.Hash) bool) error
    80  }
    81  
    82  // CallContext provides a basic interface for the EVM calling conventions. The EVM
    83  // depends on this context being implemented for doing subcalls and initialising new EVM contracts.
    84  type CallContext interface {
    85  	// Call another contract
    86  	Call(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    87  	// Take another's contract code and execute within our own context
    88  	CallCode(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    89  	// Same as CallCode except sender and value is propagated from parent to child scope
    90  	DelegateCall(env *EVM, me ContractRef, addr common.Address, data []byte, gas *big.Int) ([]byte, error)
    91  	// Create a new contract
    92  	Create(env *EVM, me ContractRef, data []byte, gas, value *big.Int) ([]byte, common.Address, error)
    93  }