github.com/bcskill/bcschain/v3@v3.4.9-beta2/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/bcskill/bcschain/v3/common"
    23  	"github.com/bcskill/bcschain/v3/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  	GetBalanceErr(common.Address) (*big.Int, error)
    34  
    35  	GetNonce(common.Address) uint64
    36  	GetNonceErr(common.Address) (uint64, error)
    37  	SetNonce(common.Address, uint64)
    38  
    39  	GetCodeHash(common.Address) common.Hash
    40  	GetCode(common.Address) []byte
    41  	GetCodeErr(common.Address) ([]byte, error)
    42  	SetCode(common.Address, []byte)
    43  	GetCodeSize(common.Address) int
    44  
    45  	AddRefund(uint64)
    46  	SubRefund(uint64)
    47  	GetRefund() uint64
    48  
    49  	GetCommittedState(common.Address, common.Hash) common.Hash
    50  	GetState(common.Address, common.Hash) common.Hash
    51  	GetStateErr(common.Address, common.Hash) (common.Hash, error)
    52  	SetState(common.Address, common.Hash, 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  	RevertToSnapshot(int)
    65  	Snapshot() int
    66  
    67  	AddLog(*types.Log)
    68  	AddPreimage(common.Hash, []byte)
    69  
    70  	ForEachStorage(common.Address, func(common.Hash, common.Hash) bool)
    71  }
    72  
    73  // CallContext provides a basic interface for the EVM calling conventions. The EVM
    74  // depends on this context being implemented for doing subcalls and initialising new EVM contracts.
    75  type CallContext interface {
    76  	// Call another contract
    77  	Call(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    78  	// Take another's contract code and execute within our own context
    79  	CallCode(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    80  	// Same as CallCode except sender and value is propagated from parent to child scope
    81  	DelegateCall(env *EVM, me ContractRef, addr common.Address, data []byte, gas *big.Int) ([]byte, error)
    82  	// Create a new contract
    83  	Create(env *EVM, me ContractRef, data []byte, gas, value *big.Int) ([]byte, common.Address, error)
    84  }