state

package
v1.12.0 Latest Latest
Warning

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

 Go to latest Published: Dec 11, 2023 License: GPL-3.0 Imports: 26 Imported by: 90

Documentation

Overview

Package state provides an uppermost caching layer of the Klaytn state trie. This package is used to read/write stateObject from/to StateDB and it also acts as a bridge between the objects and the persistent layer.

Overview of state package

stateObject represents a Klaytn account identified by its address. Once it is loaded from the persistent layer, it is cached and managed by StateDB.

StateDB caches stateObjects and mediates the operations to them.

Source Files

Related functions and variables are defined in the files listed below

  • database.go : Defines Database and other interfaces used in the package
  • dump.go : Functions to dump the contents of StateDB both in raw format and indented format
  • journal.go : journal and state changes to track the list of state modifications since the last state commit
  • state_object.go : Implementation of stateObject
  • state_object_encoder.go : stateObjectEncoder is used to encode stateObject in parallel manner
  • statedb.go : Implementation of StateDB
  • sync.go : Functions to schedule a state trie download

Index

Constants

This section is empty.

Variables

View Source 
var (

	// TODO-Klaytn EnabledExpensive and DBConfig.EnableDBPerfMetrics will be merged
	EnabledExpensive = false
)

Functions

func CheckStateConsistency added in v1.5.0 

func CheckStateConsistency(oldDB Database, newDB Database, root common.Hash, mapSize int, quit chan struct{}) error

CheckStateConsistency checks the consistency of all state/storage trie of given two state database.

func CheckStateConsistencyParallel added in v1.5.0 

func CheckStateConsistencyParallel(oldDB Database, newDB Database, root common.Hash, quitCh chan struct{}) error

CheckStateConsistencyParallel checks the consistency of all state/storage trie of given two state databases in parallel.

func NewStateSync 

func NewStateSync(root common.Hash, database statedb.StateTrieReadDB, bloom *statedb.SyncBloom, lruCache *lru.Cache, onLeaf func(paths [][]byte, leaf []byte) error) *statedb.TrieSync

NewStateSync create a new state trie download scheduler. LRU cache is mendatory when state syncing and block processing are executed simultaneously

Types

type Code 

type Code []byte

func (Code) String 

func (c Code) String() string

type Database 

type Database interface {
	// OpenTrie opens the main account trie.
	OpenTrie(root common.Hash, opts *statedb.TrieOpts) (Trie, error)

	// OpenStorageTrie opens the storage trie of an account.
	OpenStorageTrie(root common.ExtHash, opts *statedb.TrieOpts) (Trie, error)

	// CopyTrie returns an independent copy of the given trie.
	CopyTrie(Trie) Trie

	// ContractCode retrieves a particular contract's code.
	ContractCode(codeHash common.Hash) ([]byte, error)

	// DeleteCode deletes a particular contract's code.
	DeleteCode(codeHash common.Hash)

	// ContractCodeSize retrieves a particular contracts code's size.
	ContractCodeSize(codeHash common.Hash) (int, error)

	// TrieDB retrieves the low level trie database used for data storage.
	TrieDB() *statedb.Database

	// RLockGCCachedNode locks the GC lock of CachedNode.
	RLockGCCachedNode()

	// RUnlockGCCachedNode unlocks the GC lock of CachedNode.
	RUnlockGCCachedNode()
}

Database wraps access to tries and contract code.

func NewDatabase 

func NewDatabase(db database.DBManager) Database

NewDatabase creates a backing store for state. The returned database is safe for concurrent use, but does not retain any recent trie nodes in memory. To keep some historical state in memory, use the NewDatabaseWithNewCache constructor.

func NewDatabaseWithExistingCache added in v1.5.0 

func NewDatabaseWithExistingCache(db database.DBManager, cache statedb.TrieNodeCache) Database

NewDatabaseWithExistingCache creates a backing store for state with given cache. The returned database is safe for concurrent use and retains a lot of collapsed RLP trie nodes in a large memory cache.

func NewDatabaseWithNewCache added in v1.5.0 

func NewDatabaseWithNewCache(db database.DBManager, cacheConfig *statedb.TrieNodeCacheConfig) Database

NewDatabaseWithNewCache creates a backing store for state. The returned database is safe for concurrent use and retains a lot of collapsed RLP trie nodes in a large memory cache.

type Dump 

type Dump struct {
	Root     string                 `json:"root"`
	Accounts map[string]DumpAccount `json:"accounts"`
}

type DumpAccount 

type DumpAccount struct {
	Balance  string            `json:"balance"`
	Nonce    uint64            `json:"nonce"`
	Root     string            `json:"root"`
	CodeHash string            `json:"codeHash"`
	Code     string            `json:"code"`
	Storage  map[string]string `json:"storage"`
}

type NodeIterator added in v1.5.0 

type NodeIterator struct {
	Code []byte // Source code associated with a contract

	Type   string
	Hash   common.Hash // Hash of the current entry being iterated (nil if not standalone)
	Parent common.Hash // Hash of the first full ancestor node (nil if current is the root)
	Path   []byte      // the hex-encoded path to the current node.

	Error error // Failure set in case of an internal error in the iteratord
	// contains filtered or unexported fields
}

NodeIterator is an iterator to traverse the entire state trie post-order, including all of the contract code and contract state tries.

func NewNodeIterator added in v1.5.0 

func NewNodeIterator(state *StateDB) *NodeIterator

NewNodeIterator creates an post-order state node iterator.

func (*NodeIterator) Next added in v1.5.0 

func (it *NodeIterator) Next() bool

Next moves the iterator to the next node, returning whether there are any further nodes. In case of an internal error this method returns false and sets the Error field to the encountered failure.

type StateDB 

type StateDB struct {

	// Measurements gathered during execution for debugging purposes
	AccountReads         time.Duration
	AccountHashes        time.Duration
	AccountUpdates       time.Duration
	AccountCommits       time.Duration
	StorageReads         time.Duration
	StorageHashes        time.Duration
	StorageUpdates       time.Duration
	StorageCommits       time.Duration
	SnapshotAccountReads time.Duration
	SnapshotStorageReads time.Duration
	SnapshotCommits      time.Duration
	// contains filtered or unexported fields
}

StateDBs within the Klaytn protocol are used to cache stateObjects from Merkle Patricia Trie and mediate the operations to them.

func New 

func New(root common.Hash, db Database, snaps *snapshot.Tree, opts *statedb.TrieOpts) (*StateDB, error)

Create a new state from a given trie.

func (*StateDB) AddAddressToAccessList added in v1.10.0 

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 *types.Log)

func (*StateDB) AddPreimage 

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

AddPreimage records a SHA3 preimage seen by the VM.

func (*StateDB) AddRefund 

func (s *StateDB) AddRefund(gas uint64)

AddRefund adds gas to the refund counter

func (*StateDB) AddSlotToAccessList added in v1.10.0 

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

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

func (*StateDB) AddressInAccessList added in v1.10.0 

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(deleteEmptyObjects bool) (root common.Hash, err error)

Commit writes the state to the underlying in-memory trie database.

func (*StateDB) Copy 

func (s *StateDB) Copy() *StateDB

Copy creates a deep, independent copy of the state. Snapshots of the copied state cannot be applied to the copy.

func (*StateDB) CreateAccount 

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

CreateAccount explicitly creates a state object. If a state object with the address already exists, the balance is carried over to the new account. Carrying over the balance ensures that Ether doesn't disappear.

CreateAccount is currently used for test code only. Instead, use CreateEOA, CreateSmartContractAccount, or CreateSmartContractAccountWithKey to create a typed account.

func (*StateDB) CreateEOA 

func (s *StateDB) CreateEOA(addr common.Address, humanReadable bool, key accountkey.AccountKey)

func (*StateDB) CreateSmartContractAccount 

func (s *StateDB) CreateSmartContractAccount(addr common.Address, format params.CodeFormat, r params.Rules)

func (*StateDB) CreateSmartContractAccountWithKey 

func (s *StateDB) CreateSmartContractAccountWithKey(addr common.Address, humanReadable bool, key accountkey.AccountKey, format params.CodeFormat, r params.Rules)

func (*StateDB) Database 

func (s *StateDB) Database() Database

Database retrieves the low level database supporting the lower level trie ops.

func (*StateDB) Dump 

func (self *StateDB) Dump() []byte

func (*StateDB) Empty 

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

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

func (*StateDB) Error 

func (s *StateDB) Error() error

func (*StateDB) Exist 

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

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

func (*StateDB) Finalise 

func (stateDB *StateDB) Finalise(deleteEmptyObjects bool, setStorageRoot bool)

Finalise finalises the state by removing the self destructed objects and clears the journal as well as the refunds.

func (*StateDB) ForEachStorage 

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

func (*StateDB) GetAccount 

func (s *StateDB) GetAccount(addr common.Address) account.Account

func (*StateDB) GetBalance 

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

Retrieve the balance from the given address or 0 if object not found

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 added in v1.7.0 

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) GetContractStorageRoot added in v1.6.0 

func (s *StateDB) GetContractStorageRoot(contractAddr common.Address) (common.ExtHash, error)

func (*StateDB) GetKey 

func (s *StateDB) GetKey(addr common.Address) accountkey.AccountKey

func (*StateDB) GetLogs 

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

func (*StateDB) GetNonce 

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

func (*StateDB) GetOrNewSmartContract 

func (s *StateDB) GetOrNewSmartContract(addr common.Address) *stateObject

Retrieve a state object or create a new state object if nil.

func (*StateDB) GetOrNewStateObject 

func (s *StateDB) GetOrNewStateObject(addr common.Address) *stateObject

Retrieve a state object or create a new state object if nil.

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 added in v1.12.0 

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

GetTransientState gets transient storage for a given account.

func (*StateDB) GetTxHash 

func (s *StateDB) GetTxHash() common.Hash

GetTxHash returns the hash of current running transaction.

func (*StateDB) GetVmVersion added in v1.7.0 

func (s *StateDB) GetVmVersion(addr common.Address) (params.VmVersion, bool)

GetVmVersion return false when getStateObject(addr) or GetProgramAccount(stateObject.account) is failed.

func (*StateDB) HasSelfDestructed added in v1.12.0 

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

func (*StateDB) IncNonce 

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

IncNonce increases the nonce of the account of the given address by one.

func (*StateDB) IntermediateRoot 

func (s *StateDB) IntermediateRoot(deleteEmptyObjects bool) common.Hash

IntermediateRoot computes the current root hash of the state statedb. It is called in between transactions to get the root hash that goes into transaction receipts.

func (*StateDB) IsContractAccount 

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

func (*StateDB) IsContractAvailable 

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

IsContractAvailable returns true if the account corresponding to the given address implements ProgramAccount.

func (*StateDB) IsProgramAccount 

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

IsProgramAccount returns true if the account corresponding to the given address implements ProgramAccount.

func (*StateDB) IsValidCodeFormat 

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

func (*StateDB) LockGCCachedNode added in v1.4.0 

func (s *StateDB) LockGCCachedNode()

RLockGCCachedNode locks the GC lock of CachedNode.

func (*StateDB) Logs 

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

func (*StateDB) Preimages 

func (s *StateDB) Preimages() map[common.Hash][]byte

Preimages returns a list of SHA3 preimages that have been submitted.

func (*StateDB) Prepare 

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

Prepare handles the preparatory steps for executing a state transition with. This method must be invoked before state transition.

Kore fork: - Add sender to access list (2929) - Add feepayer to access list (only for klaytn) - Add destination to access list (2929) - Add precompiles to access list (2929)

Shanghai fork: - Add coinbase to access list (EIP-3651) Potential EIPs: - Reset transient storage(1153)

func (*StateDB) RawDump 

func (self *StateDB) RawDump() Dump

func (*StateDB) Reset 

func (s *StateDB) Reset(root common.Hash) error

Reset clears out all ephemeral state objects from the state db, but keeps the underlying state trie to avoid reloading data for the next operations.

func (*StateDB) RevertToSnapshot 

func (s *StateDB) RevertToSnapshot(revid int)

RevertToSnapshot reverts all state changes made since the given revision.

func (*StateDB) SelfDestruct added in v1.12.0 

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

SelfDestruct marks the given account as self-destructed. This clears the account balance.

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

func (*StateDB) SelfDestruct6780 added in v1.12.0 

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

func (*StateDB) SetBalance 

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

func (*StateDB) SetCode 

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

func (*StateDB) SetNonce 

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

func (*StateDB) SetState 

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

func (*StateDB) SetStorage added in v1.8.0 

func (s *StateDB) SetStorage(addr common.Address, storage map[common.Hash]common.Hash)

SetStorage replaces the entire storage for the specified account with given storage. This function should only be used for debugging.

func (*StateDB) SetTransientState added in v1.12.0 

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

SetTransientState sets transient storage for a given account. It adds the change to the journal so that it can be rolled back to its previous value if there is a revert.

func (*StateDB) SetTxContext added in v1.12.0 

func (s *StateDB) SetTxContext(thash, bhash common.Hash, ti int)

SetTxContext sets the current transaction hash and index and block hash which is used when the EVM emits new state logs.

func (*StateDB) SlotInAccessList added in v1.10.0 

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 state.

func (*StateDB) StorageTrie 

func (s *StateDB) StorageTrie(addr common.Address) Trie

StorageTrie returns the storage trie of an account. The return value is a copy and is nil for non-existent accounts.

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 added in v1.7.0 

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) UnlockGCCachedNode added in v1.4.0 

func (s *StateDB) UnlockGCCachedNode()

RUnlockGCCachedNode unlocks the GC lock of CachedNode.

func (*StateDB) UpdateKey 

func (s *StateDB) UpdateKey(addr common.Address, newKey accountkey.AccountKey, currentBlockNumber uint64) error

UpdateKey updates the account's key with the given key.

type Storage 

type Storage map[common.Hash]common.Hash

func (Storage) Copy 

func (s Storage) Copy() Storage

func (Storage) String 

func (s Storage) String() (str string)

type Trie 

type Trie interface {
	// GetKey returns the sha3 preimage of a hashed key that was previously used
	// to store a value.
	//
	// TODO(fjl): remove this when SecureTrie is removed
	GetKey([]byte) []byte
	// TryGet returns the value for key stored in the trie. The value bytes must
	// not be modified by the caller. If a node was not found in the database, a
	// trie.MissingNodeError is returned.
	TryGet(key []byte) ([]byte, error)
	// TryUpdate associates key with value in the trie. If value has length zero, any
	// existing value is deleted from the trie. The value bytes must not be modified
	// by the caller while they are stored in the trie. If a node was not found in the
	// database, a trie.MissingNodeError is returned.
	TryUpdate(key, value []byte) error
	TryUpdateWithKeys(key, hashKey, hexKey, value []byte) error
	// TryDelete removes any existing value for key from the trie. If a node was not
	// found in the database, a trie.MissingNodeError is returned.
	TryDelete(key []byte) error
	// Hash returns the root hash of the trie. It does not write to the database and
	// can be used even if the trie doesn't have one.
	Hash() common.Hash
	HashExt() common.ExtHash
	// Commit writes all nodes to the trie's memory database, tracking the internal
	// and external (for account tries) references.
	Commit(onleaf statedb.LeafCallback) (common.Hash, error)
	CommitExt(onleaf statedb.LeafCallback) (common.ExtHash, error)
	// NodeIterator returns an iterator that returns nodes of the trie. Iteration
	// starts at the key after the given start key.
	NodeIterator(startKey []byte) statedb.NodeIterator
	// Prove constructs a Merkle proof for key. The result contains all encoded nodes
	// on the path to the value at key. The value itself is also included in the last
	// node and can be retrieved by verifying the proof.
	//
	// If the trie does not contain a value for key, the returned proof contains all
	// nodes of the longest existing prefix of the key (at least the root), ending
	// with the node that proves the absence of the key.
	Prove(key []byte, fromLevel uint, proofDb database.DBManager) error
}

Trie is a Klaytn Merkle Patricia trie.

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.