common/docs/trie-db/classes/_index_.trie.md

@polkadot/common/trie-db

Overview

name: Trie

summary: Re-implementation of a Patricia Trie

example: See Polkadot-JS Common Trie-DB Examples

Hierarchy

Trie

Implements

• TrieDb

Constructors

constructor

⊕ new Trie(db?: TxDb, rootHash?: Uint8Array, codec?: Codec): Trie

Defined in index.ts:36

Parameters:

Name	Type	Default value
Default value db	TxDb	new MemoryDb()
Optional rootHash	Uint8Array	-
Default value codec	Codec	substrateCodec

Returns: Trie

---

Properties

db

● db: TxDb

Implementation of TrieDb.db

Defined in index.ts:32

---

Methods

close

▸ close(): void

Implementation of TrieDb.close

Defined in index.ts:88

Returns: void

---

del

▸ del(key: Uint8Array): void

Implementation of TrieDb.del

Defined in index.ts:112

Parameters:

Name	Type
key	Uint8Array

Returns: void

---

drop

▸ drop(): void

Implementation of TrieDb.drop

Defined in index.ts:96

Returns: void

---

empty

▸ empty(): void

Implementation of TrieDb.empty

Defined in index.ts:92

Returns: void

---

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of TrieDb.get

Defined in index.ts:123

Parameters:

Name	Type
key	Uint8Array

Returns: Uint8Array | null

---

getNode

▸ getNode(hash?: Uint8Array): Node

Defined in index.ts:154

Parameters:

Name	Type
Optional hash	Uint8Array

Returns: Node

---

getRoot

▸ getRoot(): Uint8Array

Implementation of TrieDb.getRoot

Defined in index.ts:144

Returns: Uint8Array

---

maintain

▸ maintain(fn: ProgressCb): void

Implementation of TrieDb.maintain

Defined in index.ts:100

Parameters:

Name	Type
fn	ProgressCb

Returns: void

---

open

▸ open(): void

Implementation of TrieDb.open

Defined in index.ts:84

Returns: void

---

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of TrieDb.put

Defined in index.ts:132

Parameters:

Name	Type
key	Uint8Array
value	Uint8Array

Returns: void

---

rename

▸ rename(base: string, file: string): void

Implementation of TrieDb.rename

Defined in index.ts:104

Parameters:

Name	Type
base	string
file	string

Returns: void

---

setRoot

▸ setRoot(rootHash: Uint8Array): void

Implementation of TrieDb.setRoot

Defined in index.ts:158

Parameters:

Name	Type
rootHash	Uint8Array

Returns: void

---

size

▸ size(): number

Implementation of TrieDb.size

Defined in index.ts:108

Returns: number

---

snapshot

▸ snapshot(dest: TrieDb, fn: ProgressCb): number

Implementation of TrieDb.snapshot

Defined in index.ts:163

Parameters:

Name	Type
dest	TrieDb
fn	ProgressCb

Returns: number

---

transaction

▸ transaction(fn: function): boolean

Defined in index.ts:64

Parameters:

Name	Type
fn	function

Returns: boolean

---