emulator

package
v1.5.0-alpha.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 27, 2024 License: Apache-2.0 Imports: 30 Imported by: 1

Documentation

Overview

Package emulator contains the implementation of the EVMEmulator and subcomponents.

The main components in this package are:

  • EVMEmulator, which is responsible for executing the Ethereum transactions.

    The EVMEmulator relies on the `go-ethereum` implementation of the Ethereum Virtual Machine (EVM). We use a fork that adds support for ISC's magic contract.

  • StateDB, which adapts go-ethereum's vm.StateDB interface to ISC's kv.KVStore interface. In other words, it keeps track of the EVM state (the key-value store, account balances, contract codes, etc), storing it in a subpartition of the `evm` core contract's state.

  • BlockchainDB, which keeps track of the Ethereum blocks and their transactions and receipts.

The emulator package is mostly agnostic about ISC. It depends only on the ethereum and kv packages.

Index

Constants

View Source
const (
	BlockKeepAll = -1
)

Variables

This section is empty.

Functions

func BlockchainDBSubrealm added in v1.0.3

func BlockchainDBSubrealm(store kv.KVStore) kv.KVStore

func BlockchainDBSubrealmR added in v1.0.3

func BlockchainDBSubrealmR(store kv.KVStoreReader) kv.KVStoreReader

func CreateAccount added in v1.0.3

func CreateAccount(kv kv.KVStore, addr common.Address)

func Exist added in v1.4.0

func Exist(addr common.Address, s kv.KVStoreReader) bool

Exist reports whether the given account exists in state. expects s to be the stateDB state partition

func GetChainIDFromBlockChainDBState added in v1.0.3

func GetChainIDFromBlockChainDBState(kv kv.KVStoreReader) uint16

func GetCode added in v1.0.3

func GetCode(s kv.KVStoreReader, addr common.Address) []byte

func GetNonce added in v1.0.3

func GetNonce(s kv.KVStoreReader, addr common.Address) uint64

func GetState added in v1.0.3

func GetState(s kv.KVStoreReader, addr common.Address, key common.Hash) common.Hash

func IncNonce added in v1.0.3

func IncNonce(kv kv.KVStore, addr common.Address)

func Init

func Init(
	emulatorState kv.KVStore,
	chainID uint16,
	gasLimits GasLimits,
	timestamp uint64,
	alloc types.GenesisAlloc,
)

Init initializes the EVM state with the provided genesis allocation parameters

func SetCode added in v1.0.3

func SetCode(kv kv.KVStore, addr common.Address, code []byte)

func SetNonce added in v1.0.3

func SetNonce(kv kv.KVStore, addr common.Address, n uint64)

func SetState added in v1.0.3

func SetState(kv kv.KVStore, addr common.Address, key, value common.Hash)

func StateDBSubrealm added in v1.0.3

func StateDBSubrealm(store kv.KVStore) kv.KVStore

func StateDBSubrealmR added in v1.0.3

func StateDBSubrealmR(store kv.KVStoreReader) kv.KVStoreReader

Types

type BlockchainDB

type BlockchainDB struct {
	// contains filtered or unexported fields
}

BlockchainDB contains logic for storing a fake blockchain (more like a list of blocks), intended for satisfying EVM tools that depend on the concept of a block.

func NewBlockchainDB

func NewBlockchainDB(store kv.KVStore, blockGasLimit uint64, blockKeepAmount int32) *BlockchainDB

func (*BlockchainDB) AddTransaction

func (bc *BlockchainDB) AddTransaction(tx *types.Transaction, receipt *types.Receipt)

func (*BlockchainDB) GetBlockByHash

func (bc *BlockchainDB) GetBlockByHash(hash common.Hash) *types.Block

func (*BlockchainDB) GetBlockByNumber

func (bc *BlockchainDB) GetBlockByNumber(blockNumber uint64) *types.Block

func (*BlockchainDB) GetBlockHashByBlockNumber

func (bc *BlockchainDB) GetBlockHashByBlockNumber(blockNumber uint64) common.Hash

func (*BlockchainDB) GetBlockNumberByBlockHash

func (bc *BlockchainDB) GetBlockNumberByBlockHash(hash common.Hash) (uint64, bool)

func (*BlockchainDB) GetBlockNumberByTxHash

func (bc *BlockchainDB) GetBlockNumberByTxHash(txHash common.Hash) (uint64, bool)

func (*BlockchainDB) GetChainID

func (bc *BlockchainDB) GetChainID() uint16

func (*BlockchainDB) GetCurrentBlock

func (bc *BlockchainDB) GetCurrentBlock() *types.Block

func (*BlockchainDB) GetHeaderByBlockNumber

func (bc *BlockchainDB) GetHeaderByBlockNumber(blockNumber uint64) *types.Header

func (*BlockchainDB) GetHeaderByHash

func (bc *BlockchainDB) GetHeaderByHash(hash common.Hash) *types.Header

func (*BlockchainDB) GetNumber

func (bc *BlockchainDB) GetNumber() uint64

func (*BlockchainDB) GetPendingBlockNumber

func (bc *BlockchainDB) GetPendingBlockNumber() uint64

func (*BlockchainDB) GetPendingCumulativeGasUsed added in v1.0.3

func (bc *BlockchainDB) GetPendingCumulativeGasUsed() uint64

func (*BlockchainDB) GetPendingHeader

func (bc *BlockchainDB) GetPendingHeader(timestamp uint64) *types.Header

func (*BlockchainDB) GetReceiptByTxHash

func (bc *BlockchainDB) GetReceiptByTxHash(txHash common.Hash) *types.Receipt

func (*BlockchainDB) GetReceiptsByBlockNumber

func (bc *BlockchainDB) GetReceiptsByBlockNumber(blockNumber uint64) []*types.Receipt

func (*BlockchainDB) GetTimestampByBlockNumber

func (bc *BlockchainDB) GetTimestampByBlockNumber(blockNumber uint64) uint64

func (*BlockchainDB) GetTransactionByBlockNumberAndIndex

func (bc *BlockchainDB) GetTransactionByBlockNumberAndIndex(blockNumber uint64, i uint32) *types.Transaction

func (*BlockchainDB) GetTransactionByHash

func (bc *BlockchainDB) GetTransactionByHash(txHash common.Hash) (tx *types.Transaction, blockHash common.Hash, blockNumber, index uint64, err error)

func (*BlockchainDB) GetTransactionsByBlockNumber

func (bc *BlockchainDB) GetTransactionsByBlockNumber(blockNumber uint64) []*types.Transaction

func (*BlockchainDB) GetTxIndexInBlockByTxHash added in v1.0.3

func (bc *BlockchainDB) GetTxIndexInBlockByTxHash(txHash common.Hash) uint32

func (*BlockchainDB) Init

func (bc *BlockchainDB) Init(chainID uint16, timestamp uint64)

func (*BlockchainDB) Initialized

func (bc *BlockchainDB) Initialized() bool

func (*BlockchainDB) MintBlock

func (bc *BlockchainDB) MintBlock(timestamp uint64)

func (*BlockchainDB) SetChainID

func (bc *BlockchainDB) SetChainID(chainID uint16)

type Context added in v1.0.3

type Context interface {
	State() kv.KVStore
	Timestamp() uint64
	GasLimits() GasLimits
	BlockKeepAmount() int32
	MagicContracts() map[common.Address]vm.ISCMagicContract

	TakeSnapshot() int
	RevertToSnapshot(int)

	BaseTokensDecimals() uint32
	GetBaseTokensBalance(addr common.Address) *big.Int
	AddBaseTokensBalance(addr common.Address, amount *big.Int)
	SubBaseTokensBalance(addr common.Address, amount *big.Int)

	WithoutGasBurn(f func())
}

type EVMEmulator

type EVMEmulator struct {
	// contains filtered or unexported fields
}

func NewEVMEmulator

func NewEVMEmulator(ctx Context) *EVMEmulator

func (*EVMEmulator) BlockGasLimit added in v1.0.3

func (e *EVMEmulator) BlockGasLimit() uint64

func (*EVMEmulator) BlockchainDB

func (e *EVMEmulator) BlockchainDB() *BlockchainDB

func (*EVMEmulator) CallContract

func (e *EVMEmulator) CallContract(call ethereum.CallMsg, gasEstimateMode bool) (*core.ExecutionResult, error)

CallContract executes a contract call, without committing changes to the state

func (*EVMEmulator) CallGasLimit added in v1.0.3

func (e *EVMEmulator) CallGasLimit() uint64

func (*EVMEmulator) ChainContext

func (e *EVMEmulator) ChainContext() core.ChainContext

func (*EVMEmulator) MintBlock

func (e *EVMEmulator) MintBlock()

func (*EVMEmulator) SendTransaction

func (e *EVMEmulator) SendTransaction(
	tx *types.Transaction,
	tracer *tracing.Hooks,
	addToBlockchain ...bool,
) (receipt *types.Receipt, result *core.ExecutionResult, err error)

func (*EVMEmulator) Signer

func (e *EVMEmulator) Signer() types.Signer

func (*EVMEmulator) StateDB

func (e *EVMEmulator) StateDB() *StateDB

type GasLimits added in v1.0.3

type GasLimits struct {
	Block uint64
	Call  uint64
}

type StateDB

type StateDB struct {
	// contains filtered or unexported fields
}

StateDB implements vm.StateDB with a kv.KVStore as backend. The Ethereum account balance is tied to the L1 balance.

func NewStateDB

func NewStateDB(ctx Context) *StateDB

func NewStateDBFromKVStore added in v1.1.0

func NewStateDBFromKVStore(emulatorState kv.KVStore) *StateDB

NewStateDBFromKVStore Creates a StateDB without any context. Handle with care. Functions requiring the context will crash. It is currently only used for the ERC721 registration using a KVStore which doesn't justify a new class.

func (*StateDB) AddAddressToAccessList

func (s *StateDB) AddAddressToAccessList(addr common.Address)

AddAddressToAccessList adds the given address to the access list. This operation is safe to perform even if the feature/fork is not active yet

func (*StateDB) AddBalance

func (s *StateDB) AddBalance(addr common.Address, amount *uint256.Int, _ tracing.BalanceChangeReason)

func (*StateDB) AddLog

func (s *StateDB) AddLog(log *types.Log)

func (*StateDB) AddPreimage

func (s *StateDB) AddPreimage(common.Hash, []byte)

func (*StateDB) AddRefund

func (s *StateDB) AddRefund(n uint64)

func (*StateDB) AddSlotToAccessList

func (s *StateDB) AddSlotToAccessList(addr common.Address, slot common.Hash)

AddSlotToAccessList adds the given (address,slot) to the access list. This operation is safe to perform even if the feature/fork is not active yet

func (*StateDB) AddressInAccessList

func (s *StateDB) AddressInAccessList(addr common.Address) bool

func (*StateDB) CreateAccount

func (s *StateDB) CreateAccount(addr common.Address)

func (*StateDB) CreateContract added in v1.4.0

func (s *StateDB) CreateContract(addr common.Address)

CreateContract is used whenever a contract is created. This may be preceded by CreateAccount, but that is not required if it already existed in the state due to funds sent beforehand. This operation sets the 'newContract'-flag, which is required in order to correctly handle EIP-6780 'delete-in-same-transaction' logic.

func (*StateDB) Empty

func (s *StateDB) Empty(addr common.Address) bool

Empty returns whether the given account is empty. Empty is defined according to EIP161 (balance = nonce = code = 0).

func (*StateDB) Exist

func (s *StateDB) Exist(addr common.Address) bool

Exist reports whether the given account exists in state. Notably this should also return true for self-destructed accounts.

func (*StateDB) GetBalance

func (s *StateDB) GetBalance(addr common.Address) *uint256.Int

func (*StateDB) GetCode

func (s *StateDB) GetCode(addr common.Address) []byte

func (*StateDB) GetCodeHash

func (s *StateDB) GetCodeHash(addr common.Address) common.Hash

func (*StateDB) GetCodeSize

func (s *StateDB) GetCodeSize(addr common.Address) int

func (*StateDB) GetCommittedState

func (s *StateDB) GetCommittedState(addr common.Address, key common.Hash) common.Hash

func (*StateDB) GetLogs

func (s *StateDB) GetLogs() []*types.Log

func (*StateDB) GetNonce

func (s *StateDB) GetNonce(addr common.Address) uint64

func (*StateDB) GetRefund

func (s *StateDB) GetRefund() uint64

func (*StateDB) GetState

func (s *StateDB) GetState(addr common.Address, key common.Hash) common.Hash

func (*StateDB) GetStorageRoot added in v1.4.0

func (s *StateDB) GetStorageRoot(addr common.Address) common.Hash

GetStorageRoot implements vm.StateDB.

func (*StateDB) GetTransientState added in v1.0.3

func (s *StateDB) GetTransientState(addr common.Address, key common.Hash) common.Hash

GetTransientState implements vm.StateDB

func (*StateDB) HasSelfDestructed added in v1.0.3

func (s *StateDB) HasSelfDestructed(addr common.Address) bool

func (*StateDB) IncNonce added in v1.0.3

func (s *StateDB) IncNonce(addr common.Address)

func (*StateDB) PointCache added in v1.4.0

func (s *StateDB) PointCache() *utils.PointCache

PointCache implements vm.StateDB.

func (*StateDB) Prepare added in v1.0.3

func (s *StateDB) Prepare(rules params.Rules, sender common.Address, coinbase common.Address, dest *common.Address, precompiles []common.Address, txAccesses types.AccessList)

Prepare implements vm.StateDB cleans up refunds, transient storage and "newContract" flags

func (*StateDB) PrepareAccessList

func (s *StateDB) PrepareAccessList(sender common.Address, dest *common.Address, precompiles []common.Address, txAccesses types.AccessList)

func (*StateDB) RevertToSnapshot

func (s *StateDB) RevertToSnapshot(i int)

func (*StateDB) SelfDestruct added in v1.0.3

func (s *StateDB) SelfDestruct(addr common.Address)

func (*StateDB) Selfdestruct6780 added in v1.0.3

func (s *StateDB) Selfdestruct6780(addr common.Address)

func (*StateDB) SetCode

func (s *StateDB) SetCode(addr common.Address, code []byte)

func (*StateDB) SetNonce

func (s *StateDB) SetNonce(addr common.Address, n uint64)

func (*StateDB) SetState

func (s *StateDB) SetState(addr common.Address, key, value common.Hash)

func (*StateDB) SetTransientState added in v1.0.3

func (s *StateDB) SetTransientState(addr common.Address, key common.Hash, value common.Hash)

SetTransientState implements vm.StateDB

func (*StateDB) SlotInAccessList

func (s *StateDB) SlotInAccessList(addr common.Address, slot common.Hash) (addressOk, slotOk bool)

func (*StateDB) Snapshot

func (s *StateDB) Snapshot() int

func (*StateDB) SubBalance

func (s *StateDB) SubBalance(addr common.Address, amount *uint256.Int, _ tracing.BalanceChangeReason)

func (*StateDB) SubRefund

func (s *StateDB) SubRefund(n uint64)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL