states

package
v0.4.7-rc7 Latest Latest
Warning

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

 Go to latest Published: May 7, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EVMConfig 

type EVMConfig struct {
	Params      support.Params
	ChainConfig *params.ChainConfig
	CoinBase    common.Address
	BaseFee     *big.Int
}

EVMConfig encapsulates common parameters needed to create an EVM to execute a message It's mainly to reduce the number of method parameters

type ExtStateDB 

type ExtStateDB interface {
	vm.StateDB
	AppendJournalEntry(JournalEntry)
}

ExtStateDB defines an extension to the interface provided by the go-ethereum codebase to support additional states transition functionalities. In particular it supports appending a new entry to the states journal through AppendJournalEntry so that the states can be reverted after running stateful precompiled contracts.

type JournalEntry 

type JournalEntry interface {
	// Revert undoes the changes introduced by this journal entry.
	Revert(*StateDB)

	// Dirtied returns the Ethereum address modified by this journal entry.
	Dirtied() *common.Address
}

JournalEntry is a modification entry in the states change journal that can be Reverted on demand.

type Keeper 

type Keeper interface {
	// Read methods
	GetAccount(ctx cosmos.Context, addr common.Address) *StateAccount
	GetState(ctx cosmos.Context, addr common.Address, key common.Hash) common.Hash
	GetCode(ctx cosmos.Context, codeHash common.Hash) []byte
	// the callback returns false to break early
	ForEachStorage(ctx cosmos.Context, addr common.Address, cb func(key, value common.Hash) bool)

	// Write methods, only called by `StateDB.Commit()`
	SetAccount(ctx cosmos.Context, addr common.Address, account StateAccount) error
	SetState(ctx cosmos.Context, addr common.Address, key common.Hash, value []byte)
	SetCode(ctx cosmos.Context, codeHash []byte, code []byte)
	DeleteAccount(ctx cosmos.Context, addr common.Address) error
}

Keeper provide underlying storage of StateDB

type StateAccount 

type StateAccount struct {
	Nonce    uint64
	Balance  *big.Int
	CodeHash []byte
}

StateAccount is the Ethereum consensus representation of accounts. These objects are stored in the storage of auth module.

func NewEmptyAccount 

func NewEmptyAccount() *StateAccount

NewEmptyAccount returns an empty account.

func (StateAccount) IsContract 

func (acct StateAccount) IsContract() bool

IsContract returns if the account contains contract code.

type StateDB 

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

StateDB structs within the ethereum protocol are used to store anything within the merkle trie. StateDBs take care of caching and storing nested states. It's the general query interface to retrieve: * Contracts * Accounts

func New 

func New(ctx cosmos.Context, keeper Keeper, txConfig TxConfig) *StateDB

New creates a new states from a given trie.

func (*StateDB) AddAddressToAccessList 

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

AddAddressToAccessList adds the given address to the access list

func (*StateDB) AddBalance 

func (s *StateDB) AddBalance(addr common.Address, amount *big.Int)

AddBalance adds amount to the account associated with addr.

func (*StateDB) AddLog 

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

AddLog adds a log, called by evm.

func (*StateDB) AddPreimage 

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

AddPreimage records a SHA3 preimage seen by the VM. AddPreimage performs a no-op since the EnablePreimageRecording flag is disabled on the vm.Config during states transitions. No store trie preimages are written to the database.

func (*StateDB) AddRefund 

func (s *StateDB) AddRefund(gas uint64)

AddRefund adds gas to the refund counter

func (*StateDB) AddSlotToAccessList 

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

AddSlotToAccessList adds the given (address, slot)-tuple to the access list

func (*StateDB) AddressInAccessList 

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

AddressInAccessList returns true if the given address is in the access list.

func (*StateDB) Commit 

func (s *StateDB) Commit() error

Commit writes the dirty states to keeper the StateDB object should be discarded after committed.

func (*StateDB) Context 

func (s *StateDB) Context() cosmos.Context

Context returns the txs Context.

func (*StateDB) CreateAccount 

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

CreateAccount explicitly creates a states object. If a states object with the address already exists the balance is carried over to the new account.

CreateAccount is called during the EVM CREATE operation. The situation might arise that a contract does the following:

1. sends funds to sha(account ++ (nonce + 1)) 2. tx_create(sha(account ++ nonce)) (note that this gets the address of 1)

Carrying over the balance ensures that Ether doesn't disappear.

func (*StateDB) Empty 

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

Empty returns whether the states object is either non-existent or empty according to the EIP161 specification (balance = nonce = code = 0)

func (*StateDB) Exist 

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

Exist reports whether the given account address exists in the states. Notably this also returns true for suicided accounts.

func (*StateDB) ForEachStorage 

func (s *StateDB) ForEachStorage(addr common.Address, cb func(key, value common.Hash) bool) error

ForEachStorage iterate the contract storage, the iteration order is not defined.

func (*StateDB) GetBalance 

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

GetBalance retrieves the balance from the given address or 0 if object not found

func (*StateDB) GetCode 

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

GetCode returns the code of account, nil if not exists.

func (*StateDB) GetCodeHash 

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

GetCodeHash returns the code hash of account.

func (*StateDB) GetCodeSize 

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

GetCodeSize returns the code size of account.

func (*StateDB) GetCommittedState 

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

GetCommittedState retrieves a value from the given account's committed storage trie.

func (*StateDB) GetNonce 

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

GetNonce returns the nonce of account, 0 if not exists.

func (*StateDB) GetRefund 

func (s *StateDB) GetRefund() uint64

GetRefund returns the current value of the refund counter.

func (*StateDB) GetState 

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

GetState retrieves a value from the given account's storage trie.

func (*StateDB) GetTransientState 

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

func (*StateDB) HasSuicided 

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

HasSuicided returns if the contract is suicided in current txs.

func (*StateDB) Keeper 

func (s *StateDB) Keeper() Keeper

Keeper returns the underlying `Keeper`

func (*StateDB) Logs 

func (s *StateDB) Logs() []*ethereum.Log

Logs returns the logs of current txs.

func (*StateDB) Prepare 

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

func (*StateDB) PrepareAccessList 

func (s *StateDB) PrepareAccessList(sender common.Address, dst *common.Address, precompiles []common.Address, list ethereum.AccessList)

PrepareAccessList handles the preparatory steps for executing a states transition with regards both EIP-2929 and EIP-2930:

- Add sender to access list (2929) - Add destination to access list (2929) - Add precompiles to access list (2929) - Add the contents of the optional txs access list (2930)

This method should only be called if Yolov3/Berlin/2929+2930 is applicable at the current number.

func (*StateDB) RevertToSnapshot 

func (s *StateDB) RevertToSnapshot(revid int)

RevertToSnapshot reverts all states changes made since the given revision.

func (*StateDB) SetCode 

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

SetCode sets the code of account.

func (*StateDB) SetNonce 

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

SetNonce sets the nonce of account.

func (*StateDB) SetState 

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

SetState sets the contract states.

func (*StateDB) SetTransientState 

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

func (*StateDB) SlotInAccessList 

func (s *StateDB) SlotInAccessList(addr common.Address, slot common.Hash) (addressPresent bool, slotPresent bool)

SlotInAccessList returns true if the given (address, slot)-tuple is in the access list.

func (*StateDB) Snapshot 

func (s *StateDB) Snapshot() int

Snapshot returns an identifier for the current revision of the states.

func (*StateDB) SubBalance 

func (s *StateDB) SubBalance(addr common.Address, amount *big.Int)

SubBalance subtracts amount from the account associated with addr.

func (*StateDB) SubRefund 

func (s *StateDB) SubRefund(gas uint64)

SubRefund removes gas from the refund counter. This method will panic if the refund counter goes below zero

func (*StateDB) Suicide 

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

Suicide marks the given account as suicided. This clears the account balance.

The account's states object is still available until the states is committed, getStateObject will return a non-nil account after Suicide.

type Storage 

type Storage map[common.Hash]common.Hash

Storage represents in-memory cache/buffer of contract storage.

func (Storage) SortedKeys 

func (s Storage) SortedKeys() []common.Hash

SortedKeys sort the keys for deterministic iteration

type TxConfig 

type TxConfig struct {
	BlockHash common.Hash // hash of current block
	TxHash    common.Hash // hash of current txs
	TxIndex   uint        // the index of current txs
	LogIndex  uint        // the index of next log within current block
	TxType    uint        // the index of next log within current block
}

TxConfig encapulates the readonly information of current txs for `StateDB`.

func NewEmptyTxConfig 

func NewEmptyTxConfig(blockHash common.Hash) TxConfig

NewEmptyTxConfig construct an empty TxConfig, used in context where there's no txs, e.g. `eth_call`/`eth_estimateGas`.

func NewTxConfig 

func NewTxConfig(blockHash, txHash common.Hash, txIndex, logIndex uint, txType uint) TxConfig

NewTxConfig returns a TxConfig

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.