github.com/theQRL/go-zond@v0.2.1/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/theQRL/go-zond/common"
    23  	"github.com/theQRL/go-zond/core/types"
    24  	"github.com/theQRL/go-zond/params"
    25  )
    26  
    27  // StateDB is an ZVM 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  	GetCodeHash(common.Address) common.Hash
    39  	GetCode(common.Address) []byte
    40  	SetCode(common.Address, []byte)
    41  	GetCodeSize(common.Address) int
    42  
    43  	AddRefund(uint64)
    44  	SubRefund(uint64)
    45  	GetRefund() uint64
    46  
    47  	GetCommittedState(common.Address, common.Hash) common.Hash
    48  	GetState(common.Address, common.Hash) common.Hash
    49  	SetState(common.Address, common.Hash, common.Hash)
    50  
    51  	// Exist reports whether the given account exists in state.
    52  	// Notably this should also return true for self-destructed accounts.
    53  	Exist(common.Address) bool
    54  	// Empty returns whether the given account is empty. Empty
    55  	// is defined according to EIP161 (balance = nonce = code = 0).
    56  	Empty(common.Address) bool
    57  
    58  	AddressInAccessList(addr common.Address) bool
    59  	SlotInAccessList(addr common.Address, slot common.Hash) (addressOk bool, slotOk bool)
    60  	// AddAddressToAccessList adds the given address to the access list. This operation is safe to perform
    61  	// even if the feature/fork is not active yet
    62  	AddAddressToAccessList(addr common.Address)
    63  	// AddSlotToAccessList adds the given (address,slot) to the access list. This operation is safe to perform
    64  	// even if the feature/fork is not active yet
    65  	AddSlotToAccessList(addr common.Address, slot common.Hash)
    66  	Prepare(rules params.Rules, sender, coinbase common.Address, dest *common.Address, precompiles []common.Address, txAccesses types.AccessList)
    67  
    68  	RevertToSnapshot(int)
    69  	Snapshot() int
    70  
    71  	AddLog(*types.Log)
    72  	AddPreimage(common.Hash, []byte)
    73  }
    74  
    75  // CallContext provides a basic interface for the ZVM calling conventions. The ZVM
    76  // depends on this context being implemented for doing subcalls and initialising new ZVM contracts.
    77  type CallContext interface {
    78  	// Call calls another contract.
    79  	Call(env *ZVM, me ContractRef, addr common.Address, data []byte, gas, value *big.Int) ([]byte, error)
    80  	// DelegateCall takes another contracts code and execute within our own context.
    81  	// Sender and value are propagated from parent to child scope.
    82  	DelegateCall(env *ZVM, me ContractRef, addr common.Address, data []byte, gas *big.Int) ([]byte, error)
    83  	// Create creates a new contract
    84  	Create(env *ZVM, me ContractRef, data []byte, gas, value *big.Int) ([]byte, common.Address, error)
    85  }