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