github.com/SmartMeshFoundation/Spectrum@v0.0.0-20220621030607-452a266fee1e/core/vm/interface.go (about)

     1  // Copyright 2016 The Spectrum Authors
     2  // This file is part of the Spectrum library.
     3  //
     4  // The Spectrum 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 Spectrum 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 Spectrum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package vm
    18  
    19  import (
    20  	"math/big"
    21  
    22  	"github.com/SmartMeshFoundation/Spectrum/common"
    23  	"github.com/SmartMeshFoundation/Spectrum/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  
    34  	GetNonce(common.Address) uint64
    35  	SetNonce(common.Address, uint64)
    36  
    37  	GetCodeHash(common.Address) common.Hash
    38  	GetCode(common.Address) []byte
    39  	SetCode(common.Address, []byte)
    40  	GetCodeSize(common.Address) int
    41  
    42  	AddRefund(uint64)
    43  	SubRefund(uint64)
    44  	GetRefund() uint64
    45  
    46  	GetState(common.Address, common.Hash) common.Hash
    47  	SetState(common.Address, common.Hash, common.Hash)
    48  
    49  	Suicide(common.Address) bool
    50  	HasSuicided(common.Address) bool
    51  
    52  	// Exist reports whether the given account exists in state.
    53  	// Notably this should also return true for suicided accounts.
    54  	Exist(common.Address) bool
    55  	// Empty returns whether the given account is empty. Empty
    56  	// is defined according to EIP161 (balance = nonce = code = 0).
    57  	Empty(common.Address) bool
    58  
    59  	RevertToSnapshot(int)
    60  	Snapshot() int
    61  
    62  	AddLog(*types.Log)
    63  	AddPreimage(common.Hash, []byte)
    64  
    65  	ForEachStorage(common.Address, func(common.Hash, common.Hash) bool)
    66  }
    67  
    68  // CallContext provides a basic interface for the EVM calling conventions. The EVM EVM
    69  // depends on this context being implemented for doing subcalls and initialising new EVM contracts.
    70  type CallContext interface {
    71  	// Call another contract
    72  	Call(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    73  	// Take another's contract code and execute within our own context
    74  	CallCode(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    75  	// Same as CallCode except sender and value is propagated from parent to child scope
    76  	DelegateCall(env *EVM, me ContractRef, addr common.Address, data []byte, gas *big.Int) ([]byte, error)
    77  	// Create a new contract
    78  	Create(env *EVM, me ContractRef, data []byte, gas, value *big.Int) ([]byte, common.Address, error)
    79  }