github.com/cryptotooltop/go-ethereum@v0.0.0-20231103184714-151d1922f3e5/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/scroll-tech/go-ethereum/common"
    23  	"github.com/scroll-tech/go-ethereum/core/types"
    24  	"github.com/scroll-tech/go-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  	GetKeccakCodeHash(common.Address) common.Hash
    39  	GetCode(common.Address) []byte
    40  	SetCode(common.Address, []byte)
    41  	GetPoseidonCodeHash(common.Address) common.Hash
    42  	GetCodeSize(common.Address) uint64
    43  
    44  	AddRefund(uint64)
    45  	SubRefund(uint64)
    46  	GetRefund() uint64
    47  
    48  	GetCommittedState(common.Address, common.Hash) common.Hash
    49  	GetState(common.Address, common.Hash) common.Hash
    50  	SetState(common.Address, common.Hash, common.Hash)
    51  
    52  	GetRootHash() common.Hash
    53  	GetLiveStateAccount(addr common.Address) *types.StateAccount
    54  	GetProof(addr common.Address) ([][]byte, error)
    55  	GetProofByHash(addrHash common.Hash) ([][]byte, error)
    56  	GetStorageProof(a common.Address, key common.Hash) ([][]byte, error)
    57  
    58  	Suicide(common.Address) bool
    59  	HasSuicided(common.Address) bool
    60  
    61  	// Exist reports whether the given account exists in state.
    62  	// Notably this should also return true for suicided accounts.
    63  	Exist(common.Address) bool
    64  	// Empty returns whether the given account is empty. Empty
    65  	// is defined according to EIP161 (balance = nonce = code = 0).
    66  	Empty(common.Address) bool
    67  
    68  	PrepareAccessList(rules params.Rules, sender, coinbase common.Address, dest *common.Address, precompiles []common.Address, txAccesses types.AccessList)
    69  	AddressInAccessList(addr common.Address) bool
    70  	SlotInAccessList(addr common.Address, slot common.Hash) (addressOk bool, slotOk bool)
    71  	// AddAddressToAccessList adds the given address to the access list. This operation is safe to perform
    72  	// even if the feature/fork is not active yet
    73  	AddAddressToAccessList(addr common.Address)
    74  	// AddSlotToAccessList adds the given (address,slot) to the access list. This operation is safe to perform
    75  	// even if the feature/fork is not active yet
    76  	AddSlotToAccessList(addr common.Address, slot common.Hash)
    77  
    78  	RevertToSnapshot(int)
    79  	Snapshot() int
    80  
    81  	AddLog(*types.Log)
    82  	AddPreimage(common.Hash, []byte)
    83  
    84  	ForEachStorage(common.Address, func(common.Hash, common.Hash) bool) error
    85  }
    86  
    87  // CallContext provides a basic interface for the EVM calling conventions. The EVM
    88  // depends on this context being implemented for doing subcalls and initialising new EVM contracts.
    89  type CallContext interface {
    90  	// Call another contract
    91  	Call(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    92  	// Take another's contract code and execute within our own context
    93  	CallCode(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    94  	// Same as CallCode except sender and value is propagated from parent to child scope
    95  	DelegateCall(env *EVM, me ContractRef, addr common.Address, data []byte, gas *big.Int) ([]byte, error)
    96  	// Create a new contract
    97  	Create(env *EVM, me ContractRef, data []byte, gas, value *big.Int) ([]byte, common.Address, error)
    98  }