github.com/pfcoder/quorum@v2.0.3-0.20180501191142-d4a1b0958135+incompatible/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  // Quorum uses a cut-down StateDB, MinimalApiState. We leave the methods in StateDB commented out so they'll produce a
    27  // conflict when upstream changes.
    28  type MinimalApiState interface {
    29  	GetBalance(addr common.Address) *big.Int
    30  	GetCode(addr common.Address) []byte
    31  	GetState(a common.Address, b common.Hash) common.Hash
    32  	GetNonce(addr common.Address) uint64
    33  }
    34  
    35  // StateDB is an EVM database for full state querying.
    36  type StateDB interface {
    37  	MinimalApiState
    38  	CreateAccount(common.Address)
    39  
    40  	SubBalance(common.Address, *big.Int)
    41  	AddBalance(common.Address, *big.Int)
    42  	//GetBalance(common.Address) *big.Int
    43  
    44  	//GetNonce(common.Address) uint64
    45  	SetNonce(common.Address, uint64)
    46  
    47  	GetCodeHash(common.Address) common.Hash
    48  	//GetCode(common.Address) []byte
    49  	SetCode(common.Address, []byte)
    50  	GetCodeSize(common.Address) int
    51  
    52  	AddRefund(*big.Int)
    53  	GetRefund() *big.Int
    54  
    55  	//GetState(common.Address, common.Hash) common.Hash
    56  	SetState(common.Address, common.Hash, common.Hash)
    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  	RevertToSnapshot(int)
    69  	Snapshot() int
    70  
    71  	AddLog(*types.Log)
    72  	AddPreimage(common.Hash, []byte)
    73  
    74  	ForEachStorage(common.Address, func(common.Hash, common.Hash) bool)
    75  }
    76  
    77  // CallContext provides a basic interface for the EVM calling conventions. The EVM EVM
    78  // depends on this context being implemented for doing subcalls and initialising new EVM contracts.
    79  type CallContext interface {
    80  	// Call another contract
    81  	Call(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    82  	// Take another's contract code and execute within our own context
    83  	CallCode(env *EVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    84  	// Same as CallCode except sender and value is propagated from parent to child scope
    85  	DelegateCall(env *EVM, me ContractRef, addr common.Address, data []byte, gas *big.Int) ([]byte, error)
    86  	// Create a new contract
    87  	Create(env *EVM, me ContractRef, data []byte, gas, value *big.Int) ([]byte, common.Address, error)
    88  }