github.com/aaa256/atlantis@v0.0.0-20210707112435-42ee889287a2/core/vm/interface.go (about)

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