Class MerklePatriciaTree<K, V>

A Merkle Patricia Tree, as defined in the Ethereum Yellow Paper.

Type parameters

K
V

Hierarchy

MerklePatriciaTree
- CachedMerklePatriciaTree

Implements

MerkleTree<K, V>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MerklePatriciaTree(options?: MerklePatriciaTreeOptions<K, V>): MerklePatriciaTree

- Defined in index.ts:769
Construct a new Merkle Patricia Tree.

Parameters
- Default value options: MerklePatriciaTreeOptions<K, V> = {putCanDelete: true}
Returns MerklePatriciaTree

Properties

options

options: MerklePatriciaTreeOptions<K, V>

rootNode

rootNode: MerklePatriciaTreeNode<V>

The root node of the tree.

Accessors

root

get root(): Buffer

- Defined in index.ts:755
A Buffer representing the root hash of the tree. Always 256-bits (32 bytes).

Returns Buffer

rootHash

get rootHash(): bigint

- Defined in index.ts:766
The root hash of the tree, as a bigint. Reading this property is more efficient than obtaining a buffer.

Returns bigint

Methods

batch

batch(putOps: Array<BatchPut<K, V>>, delOps?: K[]): Buffer

- Defined in index.ts:1228
Execute a batch of put and delete operations. The execution is batched, so calling this function with multiple updates provides more opportunities for optimization and can be faster than call put() and del() multiple times.

Parameters
- putOps: Array<BatchPut<K, V>>
  
  An array of put operations on the tree, of type BatchPut.
- Default value delOps: K[] = []
  
  An optional array of keys to delete from the tree.
Returns Buffer

The root that results from this set of operations.

batchCOW

batchCOW(putOps: Array<BatchPut<K, V>>, delOps?: K[]): MerklePatriciaTree<K, V>

- Defined in index.ts:1248
Execute a batch of put and delete operations. The execution of batch operations are performed in a copy on write (cow) fashion.

Parameters
- putOps: Array<BatchPut<K, V>>
  
  An array of put operations on the tree, of type BatchPut.
- Default value delOps: K[] = []
  
  An optional array of keys to delete from the tree.
Returns MerklePatriciaTree<K, V>

A new MerklePatriciaTree updated in a cow manner.

batchGet

batchGet(keys: K[]): Array<Witness<V>>

- Defined in index.ts:1100
Reads multiple keys and returns a concise reply of witnesses

Parameters
- keys: K[]
  
  : bulk keys to be read
Returns Array<Witness<V>>

: Array of witnesses

copyTreePaths

copyTreePaths(node1: MerklePatriciaTreeNode<V>, node2: MerklePatriciaTreeNode<V>): MerklePatriciaTreeNode<V>

- Defined in index.ts:861
CopyTreePaths Copies paths that are marked for copy

Parameters
- node1: MerklePatriciaTreeNode<V>
- node2: MerklePatriciaTreeNode<V>
Returns MerklePatriciaTreeNode<V>

del

del(key: K): void

- Defined in index.ts:1114
Given a key, delete any mapping that exists for that key.

Parameters
- key: K
  
  The key to unmap.
Returns void

get

get(key: K): Witness<V>

- Defined in index.ts:1087
Given a key, retrieve a Witness for the mapping.

Parameters
- key: K
  
  The key to retrieve the Witness for.
Returns Witness<V>

A Witness, with a proof of the value read (or a null value, with a proof of the value's nonexistence).

getNodeCopy

getNodeCopy(node: MerklePatriciaTreeNode<V>): MerklePatriciaTreeNode<V>

- Defined in index.ts:829
Copies only the node; leaving its successors the same

Parameters
- node: MerklePatriciaTreeNode<V>
  
  : Node for copy
Returns MerklePatriciaTreeNode<V>

insert

insert(stack: Array<MerklePatriciaTreeNode<V>>, remainder: number[], value: V): void

- Defined in index.ts:910
Insert a node with the given value after a search.

Parameters
- stack: Array<MerklePatriciaTreeNode<V>>
  
  The stack as a result of the search
- remainder: number[]
  
  The remainder as a result of the search
- value: V
  
  The value to insert.
Returns void

multiSearch

multiSearch(putOps: Array<BatchPut<K, V>>, delOps: K[], flag: boolean): void

- Defined in index.ts:895
multiSearch searches the tree for all keys and marks nodes for copy

Parameters
- putOps: Array<BatchPut<K, V>>
  
  : List of key, value pairs
- delOps: K[]
  
  : List of keys
- flag: boolean
  
  : True if we want to mark the nodes for copy
Returns void

nodeCount

nodeCount(count?: number): number

- Defined in index.ts:1327
Counts the number of nodes in the tree

Parameters
- Default value count: number = 0
Returns number

put

put(key: K, val: V): void

- Defined in index.ts:792
Insert a new mapping into the tree. If the key is already mapped in the tree, it is updated with the new value.

Parameters
- key: K
  
  The key to insert.
- val: V
  
  A Buffer representing the value.
Returns void

rlpSerializeWitness

rlpSerializeWitness(witness: Witness<V>): RlpWitness

- Defined in index.ts:1309
Serialize a witness into RLP format.

Parameters
- witness: Witness<V>
  
  A witness returned from a get() operation on a Merkle Patricia Tree
Returns RlpWitness

An RLP serialized witness, with non-essential nodes removed.

search

search(key: K, markForCopy?: boolean): SearchResult<V>

- Defined in index.ts:1275
Search for the given key, returning a SearchResult which contains the path traversed to search for the key.

Parameters
- key: K
  
  The key to search for.
- Default value markForCopy: boolean = false
Returns SearchResult<V>

A SearchResult containing the path to the key, and the value if it was present.

size

size(): number

- Defined in index.ts:1334
Returns the sum of lengths of rlpEncodings of all the nodes in the tree

Returns number

Generated using TypeDoc