trie

package
v1.4.9-beta Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2023 License: GPL-3.0 Imports: 24 Imported by: 0

Documentation

Overview

Package trie implements Merkle Patricia Tries.

Index

Constants

This section is empty.

Variables

View Source 
var ErrAlreadyProcessed = errors.New("already processed")

ErrAlreadyProcessed is returned by the trie sync when it's requested to process a Node it already processed previously.

View Source 
var ErrNotRequested = errors.New("not requested")

ErrNotRequested is returned by the trie sync when it's requested to process a Node it did not request.

Functions

func VerifyProof 

func VerifyProof(rootHash common.Hash, key []byte, proofDb ethdb.KeyValueReader) (value []byte, err error)

VerifyProof checks merkle proofs. The given proof must contain the value for key in a trie with the given root hash. VerifyProof returns an error if the proof contains invalid trie nodes or the wrong value.

func VerifyRangeProof 

func VerifyRangeProof(rootHash common.Hash, firstKey []byte, keys [][]byte, values [][]byte, firstProof ethdb.KeyValueReader, lastProof ethdb.KeyValueReader) (error, bool)

VerifyRangeProof checks whether the given leaf nodes and edge proofs can prove the given trie leaves range is matched with given root hash and the range is consecutive(no gap inside) and monotonic increasing.

Note the given first edge proof can be non-existing proof. For example the first proof is for an non-existent values 0x03. The given batch leaves are [0x04, 0x05, .. 0x09]. It's still feasible to prove. But the last edge proof should always be an existent proof.

The firstKey is paired with firstProof, not necessarily the same as keys[0] (unless firstProof is an existent proof).

Expect the normal case, this function can also be used to verify the following range proofs(note this function doesn't accept zero element proof):

  • All elements proof. In this case the left and right proof can be nil, but the range should be all the leaves in the trie.
  • One element proof. In this case no matter the left edge proof is a non-existent proof or not, we can always verify the correctness of the proof.

Except returning the error to indicate the proof is valid or not, the function will also return a flag to indicate whether there exists more accounts/slots in the trie.

Types

type Database 

type Database struct {
	Lock sync.RWMutex
	// contains filtered or unexported fields
}

Database is an intermediate write layer between the trie data structures and the disk database. The aim is to accumulate trie writes in-memory and only periodically flush a couple tries to disk, garbage collecting the remainder.

Note, the trie Database is **not** thread safe in its mutations, but it **is** thread safe in providing individual, independent Node access. The rationale behind this split design is to provide read access to RPC handlers and sync servers even while the trie is executing expensive garbage collection.

func NewDatabase 

func NewDatabase(diskdb ethdb.KeyValueStore) *Database

NewDatabase creates a new trie database to store ephemeral trie content before its written out to disk or garbage collected. No read Cache is created, so all data retrievals will hit the underlying disk database.

func NewDatabaseWithCache 

func NewDatabaseWithCache(diskdb ethdb.KeyValueStore, cache int) *Database

NewDatabaseWithCache creates a new trie database to store ephemeral trie content before its written out to disk or garbage collected. It also acts as a read Cache for nodes loaded from disk.

func (*Database) Cap 

func (db *Database) Cap(limit common.StorageSize) error

Cap iteratively flushes old but still referenced trie nodes until the total memory usage goes below the given threshold.

Note, this method is a non-synchronized mutator. It is unsafe to call this concurrently with other mutators.

func (*Database) Commit 

func (db *Database) Commit(node common.Hash, report bool) error

Commit iterates over all the children of a particular Node, writes them out to disk, forcefully tearing down all references in both directions. As a side effect, all pre-images accumulated up to this point are also written.

Note, this method is a non-synchronized mutator. It is unsafe to call this concurrently with other mutators.

func (*Database) Dereference 

func (db *Database) Dereference(root common.Hash)

Dereference removes an existing reference from a root Node.

func (*Database) DiskDB 

func (db *Database) DiskDB() ethdb.KeyValueReader

DiskDB retrieves the persistent storage backing the trie database.

func (*Database) InsertBlob 

func (db *Database) InsertBlob(hash common.Hash, blob []byte)

InsertBlob writes a new reference tracked blob to the memory database if it's yet unknown. This method should only be used for non-trie nodes that require reference counting, since trie nodes are garbage collected directly through their embedded children.

func (*Database) InsertPreimage 

func (db *Database) InsertPreimage(hash common.Hash, preimage []byte)

InsertPreimage writes a new trie Node pre-image to the memory database if it's yet unknown. The method will make a copy of the slice.

Note, this method assumes that the database's Lock is held!

func (*Database) Node 

func (db *Database) Node(hash common.Hash) ([]byte, error)

Node retrieves an encoded cached trie Node from memory. If it cannot be found cached, the method queries the persistent database for the content.

func (*Database) Nodes 

func (db *Database) Nodes() []common.Hash

Nodes retrieves the hashes of all the nodes cached within the memory database. This method is extremely expensive and should only be used to validate internal states in test code.

func (*Database) Preimage 

func (db *Database) Preimage(hash common.Hash) ([]byte, error)

Preimage retrieves a cached trie Node pre-image from memory. If it cannot be found cached, the method queries the persistent database for the content.

func (*Database) Reference 

func (db *Database) Reference(child common.Hash, parent common.Hash)

Reference adds a new reference from a parent Node to a child Node.

func (*Database) Size 

func (db *Database) Size() (common.StorageSize, common.StorageSize)

Size returns the current storage size of the memory Cache in front of the persistent database layer.

type FullNode 

type FullNode struct {
	Children [17]Node // Actual trie Node data to encode/decode (needs custom encoder)
	// contains filtered or unexported fields
}

func (*FullNode) Cache 

func (n *FullNode) Cache() (HashNode, bool)

func (*FullNode) EncodeRLP 

func (n *FullNode) EncodeRLP(w io.Writer) error

EncodeRLP encodes a full Node into the consensus RLP format.

func (*FullNode) String 

func (n *FullNode) String() string

Pretty printing.

type HashNode 

type HashNode []byte

func (HashNode) Cache 

func (n HashNode) Cache() (HashNode, bool)

func (HashNode) String 

func (n HashNode) String() string

type Iterator 

type Iterator struct {
	Key   []byte // Current data key on which the iterator is positioned on
	Value []byte // Current data value on which the iterator is positioned on
	Err   error
	// contains filtered or unexported fields
}

Iterator is a key-value trie iterator that traverses a Trie.

func NewIterator 

func NewIterator(it NodeIterator) *Iterator

NewIterator creates a new key-value iterator from a Node iterator. Note that the value returned by the iterator is raw. If the content is encoded (e.g. storage value is RLP-encoded), it's caller's duty to decode it.

func (*Iterator) Next 

func (it *Iterator) Next() bool

Next moves the iterator forward one key-value entry.

func (*Iterator) Prove 

func (it *Iterator) Prove() [][]byte

Prove generates the Merkle proof for the leaf Node the iterator is currently positioned on.

type LeafCallback 

type LeafCallback func(leaf []byte, parent common.Hash) error

LeafCallback is a callback type invoked when a trie operation reaches a leaf Node. It's used by state sync and commit to allow handling external references between account and storage tries.

type MissingNodeError 

type MissingNodeError struct {
	NodeHash common.Hash // hash of the missing Node
	Path     []byte      // hex-encoded path to the missing Node
}

MissingNodeError is returned by the trie functions (TryGet, TryUpdate, TryDelete) in the case where a trie Node is not present in the local database. It contains information necessary for retrieving the missing Node.

func (*MissingNodeError) Error 

func (err *MissingNodeError) Error() string

type Node 

type Node interface {
	Cache() (HashNode, bool)
	// contains filtered or unexported methods
}

func MustDecodeNode 

func MustDecodeNode(hash, buf []byte) Node

type NodeFlag 

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

NodeFlag contains caching-related metadata about a Node.

type NodeIterator 

type NodeIterator interface {
	// Next moves the iterator to the next Node. If the parameter is false, any child
	// nodes will be skipped.
	Next(bool) bool

	// Error returns the error status of the iterator.
	Error() error

	// Hash returns the hash of the current Node.
	Hash() common.Hash

	// Parent returns the hash of the parent of the current Node. The hash may be the one
	// grandparent if the immediate parent is an internal Node with no hash.
	Parent() common.Hash

	// Path returns the hex-encoded path to the current Node.
	// Callers must not retain references to the return value after calling Next.
	// For leaf nodes, the last element of the path is the 'terminator symbol' 0x10.
	Path() []byte

	// Leaf returns true iff the current Node is a leaf Node.
	Leaf() bool

	// LeafKey returns the key of the leaf. The method panics if the iterator is not
	// positioned at a leaf. Callers must not retain references to the value after
	// calling Next.
	LeafKey() []byte

	// LeafBlob returns the content of the leaf. The method panics if the iterator
	// is not positioned at a leaf. Callers must not retain references to the value
	// after calling Next.
	LeafBlob() []byte

	// LeafProof returns the Merkle proof of the leaf. The method panics if the
	// iterator is not positioned at a leaf. Callers must not retain references
	// to the value after calling Next.
	LeafProof() [][]byte
}

NodeIterator is an iterator to traverse the trie pre-order.

func NewDifferenceIterator 

func NewDifferenceIterator(a, b NodeIterator) (NodeIterator, *int)

NewDifferenceIterator constructs a NodeIterator that iterates over elements in b that are not in a. Returns the iterator, and a pointer to an integer recording the number of nodes seen.

func NewUnionIterator 

func NewUnionIterator(iters []NodeIterator) (NodeIterator, *int)

NewUnionIterator constructs a NodeIterator that iterates over elements in the union of the provided NodeIterators. Returns the iterator, and a pointer to an integer recording the number of nodes visited.

type SecureTrie 

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

SecureTrie wraps a trie with key hashing. In a secure trie, all access operations hash the key using keccak256. This prevents calling code from creating long chains of nodes that increase the access time.

Contrary to a regular trie, a SecureTrie can only be created with New and must have an attached database. The database also stores the Preimage of each key.

SecureTrie is not safe for concurrent use.

func NewSecure 

func NewSecure(root common.Hash, db *Database) (*SecureTrie, error)

NewSecure creates a trie with an existing root Node from a backing database and optional intermediate in-memory Node pool.

If root is the zero hash or the sha3 hash of an empty string, the trie is initially empty. Otherwise, New will panic if Db is nil and returns MissingNodeError if the root Node cannot be found.

Accessing the trie loads nodes from the database or Node pool on demand. Loaded nodes are kept around until their 'Cache generation' expires. A new Cache generation is created by each call to Commit. cachelimit sets the number of past Cache generations to keep.

func (*SecureTrie) Commit 

func (t *SecureTrie) Commit(onleaf LeafCallback) (root common.Hash, err error)

Commit writes all nodes and the secure hash pre-images to the trie's database. Nodes are stored with their sha3 hash as the key.

Committing flushes nodes from memory. Subsequent Get calls will load nodes from the database.

func (*SecureTrie) Copy 

func (t *SecureTrie) Copy() *SecureTrie

Copy returns a copy of SecureTrie.

func (*SecureTrie) Delete 

func (t *SecureTrie) Delete(key []byte)

Delete removes any existing value for key from the trie.

func (*SecureTrie) Get 

func (t *SecureTrie) Get(key []byte) []byte

Get returns the value for key stored in the trie. The value bytes must not be modified by the caller.

func (*SecureTrie) GetKey 

func (t *SecureTrie) GetKey(shaKey []byte) []byte

GetKey returns the sha3 Preimage of a hashed key that was previously used to store a value.

func (*SecureTrie) Hash 

func (t *SecureTrie) Hash() common.Hash

Hash returns the root hash of SecureTrie. It does not write to the database and can be used even if the trie doesn't have one.

func (*SecureTrie) NodeIterator 

func (t *SecureTrie) NodeIterator(start []byte) NodeIterator

NodeIterator returns an iterator that returns nodes of the underlying trie. Iteration starts at the key after the given start key.

func (*SecureTrie) Prove 

func (t *SecureTrie) Prove(key []byte, fromLevel uint, proofDb ethdb.KeyValueWriter) error

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 Node), ending with the Node that proves the absence of the key.

func (*SecureTrie) TryDelete 

func (t *SecureTrie) TryDelete(key []byte) error

TryDelete removes any existing value for key from the trie. If a Node was not found in the database, a MissingNodeError is returned.

func (*SecureTrie) TryGet 

func (t *SecureTrie) TryGet(key []byte) ([]byte, error)

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 MissingNodeError is returned.

func (*SecureTrie) TryUpdate 

func (t *SecureTrie) TryUpdate(key, value []byte) error

TryUpdate associates key with value in the trie. Subsequent calls to Get will return value. If value has length zero, any existing value is deleted from the trie and calls to Get will return nil.

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 MissingNodeError is returned.

func (*SecureTrie) Update 

func (t *SecureTrie) Update(key, value []byte)

Update associates key with value in the trie. Subsequent calls to Get will return value. If value has length zero, any existing value is deleted from the trie and calls to Get will return nil.

The value bytes must not be modified by the caller while they are stored in the trie.

type ShortNode 

type ShortNode struct {
	Key []byte
	Val Node
	// contains filtered or unexported fields
}

func (*ShortNode) Cache 

func (n *ShortNode) Cache() (HashNode, bool)

func (*ShortNode) String 

func (n *ShortNode) String() string

type Sync 

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

Sync is the main state trie synchronisation scheduler, which provides yet unknown trie hashes to retrieve, accepts Node data associated with said hashes and reconstructs the trie step by step until all is done.

func NewSync 

func NewSync(root common.Hash, database ethdb.KeyValueReader, callback LeafCallback, bloom *SyncBloom) *Sync

NewSync creates a new trie data download scheduler.

func (*Sync) AddRawEntry 

func (s *Sync) AddRawEntry(hash common.Hash, depth int, parent common.Hash)

AddRawEntry schedules the direct retrieval of a state entry that should not be interpreted as a trie Node, but rather accepted and stored into the database as is. This method's goal is to support misc state metadata retrievals (e.g. contract code).

func (*Sync) AddSubTrie 

func (s *Sync) AddSubTrie(root common.Hash, depth int, parent common.Hash, callback LeafCallback)

AddSubTrie registers a new trie to the sync code, rooted at the designated parent.

func (*Sync) Commit 

func (s *Sync) Commit(dbw ethdb.Batch) error

Commit flushes the data stored in the internal membatch out to persistent storage, returning any occurred error.

func (*Sync) Missing 

func (s *Sync) Missing(max int) []common.Hash

Missing retrieves the known missing nodes from the trie for retrieval.

func (*Sync) Pending 

func (s *Sync) Pending() int

Pending returns the number of state entries currently pending for download.

func (*Sync) Process 

func (s *Sync) Process(results []SyncResult) (bool, int, error)

Process injects a batch of retrieved trie nodes data, returning if something was committed to the database and also the index of an entry if its processing failed.

type SyncBloom 

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

SyncBloom is a bloom filter used during fast sync to quickly decide if a trie Node already exists on disk or not. It self populates from the provided disk database on creation in a background thread and will only start returning live results once that's finished.

func NewSyncBloom 

func NewSyncBloom(memory uint64, database ethdb.Iteratee) *SyncBloom

NewSyncBloom creates a new bloom filter of the given size (in megabytes) and initializes it from the database. The bloom is hard coded to use 3 filters.

func (*SyncBloom) Add 

func (b *SyncBloom) Add(hash []byte)

Add inserts a new trie Node hash into the bloom filter.

func (*SyncBloom) Close 

func (b *SyncBloom) Close() error

Close terminates any background initializer still running and releases all the memory allocated for the bloom.

func (*SyncBloom) Contains 

func (b *SyncBloom) Contains(hash []byte) bool

Contains tests if the bloom filter contains the given hash:

  • false: the bloom definitely does not contain hash
  • true: the bloom maybe contains hash

While the bloom is being initialized, any query will return true.

type SyncResult 

type SyncResult struct {
	Hash common.Hash // Hash of the originally unknown trie Node
	Data []byte      // Data content of the retrieved Node
}

SyncResult is a simple list to return missing nodes along with their request hashes.

type Trie 

type Trie struct {
	Db *Database
	// contains filtered or unexported fields
}

Trie is a Merkle Patricia Trie. The zero value is an empty trie with no database. Use New to create a trie that sits on top of a database.

Trie is not safe for concurrent use.

func New 

func New(root common.Hash, db *Database) (*Trie, error)

New creates a trie with an existing root Node from Db.

If root is the zero hash or the sha3 hash of an empty string, the trie is initially empty and does not require a database. Otherwise, New will panic if Db is nil and returns a MissingNodeError if root does not exist in the database. Accessing the trie loads nodes from Db on demand.

func (*Trie) Commit 

func (t *Trie) Commit(onleaf LeafCallback) (root common.Hash, err error)

Commit writes all nodes to the trie's memory database, tracking the internal and external (for account tries) references.

func (*Trie) Delete 

func (t *Trie) Delete(key []byte)

Delete removes any existing value for key from the trie.

func (*Trie) Get 

func (t *Trie) Get(key []byte) []byte

Get returns the value for key stored in the trie. The value bytes must not be modified by the caller.

func (*Trie) Hash 

func (t *Trie) Hash() common.Hash

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.

func (*Trie) NodeIterator 

func (t *Trie) NodeIterator(start []byte) NodeIterator

NodeIterator returns an iterator that returns nodes of the trie. Iteration starts at the key after the given start key.

func (*Trie) Prove 

func (t *Trie) Prove(key []byte, fromLevel uint, proofDb ethdb.KeyValueWriter) error

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 Node), ending with the Node that proves the absence of the key.

func (*Trie) TryDelete 

func (t *Trie) TryDelete(key []byte) error

TryDelete removes any existing value for key from the trie. If a Node was not found in the database, a MissingNodeError is returned.

func (*Trie) TryGet 

func (t *Trie) TryGet(key []byte) ([]byte, error)

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 MissingNodeError is returned.

func (*Trie) TryGetAllLeftKeyAndValue 

func (t *Trie) TryGetAllLeftKeyAndValue(limit []byte) ([][]byte, [][]byte, error)

func (*Trie) TryGetBestLeftKeyAndValue 

func (t *Trie) TryGetBestLeftKeyAndValue() ([]byte, []byte, error)

func (*Trie) TryGetBestRightKeyAndValue 

func (t *Trie) TryGetBestRightKeyAndValue() ([]byte, []byte, error)

func (*Trie) TryUpdate 

func (t *Trie) TryUpdate(key, value []byte) error

TryUpdate associates key with value in the trie. Subsequent calls to Get will return value. If value has length zero, any existing value is deleted from the trie and calls to Get will return nil.

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 MissingNodeError is returned.

func (*Trie) Update 

func (t *Trie) Update(key, value []byte)

Update associates key with value in the trie. Subsequent calls to Get will return value. If value has length zero, any existing value is deleted from the trie and calls to Get will return nil.

The value bytes must not be modified by the caller while they are stored in the trie.

type ValueNode 

type ValueNode []byte

func (ValueNode) Cache 

func (n ValueNode) Cache() (HashNode, bool)

func (ValueNode) String 

func (n ValueNode) String() string

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.