CheckpointDB.md

@ethereumjs/trie / CheckpointDB

Class: CheckpointDB

DB is a thin wrapper around the underlying levelup db, which validates inputs and sets encoding type.

Implements

• DB

Table of contents

Constructors

• constructor

Properties

• _stats
• cacheSize
• checkpoints
• db

Methods

• batch
• checkpoint
• commit
• del
• get
• hasCheckpoints
• open
• put
• revert
• setCheckpoints
• shallowCopy
• stats

Constructors

constructor

• new CheckpointDB(opts)

Initialize a DB instance.

Parameters

Name	Type
opts	CheckpointDBOpts

Defined in

packages/trie/src/db/checkpoint.ts:50

Properties

_stats

• _stats: Object

Type declaration

Name	Type
cache	{ hits: number = 0; reads: number = 0; writes: number = 0 }
cache.hits	number
cache.reads	number
cache.writes	number
db	{ hits: number = 0; reads: number = 0; writes: number = 0 }
db.hits	number
db.reads	number
db.writes	number

Defined in

packages/trie/src/db/checkpoint.ts:34

---

cacheSize

• Readonly cacheSize: number

Defined in

packages/trie/src/db/checkpoint.ts:19

---

checkpoints

• checkpoints: Checkpoint[]

Defined in

packages/trie/src/db/checkpoint.ts:17

---

db

• db: DB<string, string | Uint8Array>

Defined in

packages/trie/src/db/checkpoint.ts:18

Methods

batch

▸ batch(opStack): Promise<void>

Inherit Doc

Parameters

Name	Type
opStack	BatchDBOp<Uint8Array, Uint8Array>[]

Returns

Promise<void>

Implementation of

DB.batch

Defined in

packages/trie/src/db/checkpoint.ts:230

---

checkpoint

▸ checkpoint(root): void

Adds a new checkpoint to the stack

Parameters

Name	Type
root	Uint8Array

Returns

void

Defined in

packages/trie/src/db/checkpoint.ts:92

---

commit

▸ commit(): Promise<void>

Commits the latest checkpoint

Returns

Promise<void>

Defined in

packages/trie/src/db/checkpoint.ts:99

---

del

▸ del(key): Promise<void>

Inherit Doc

Parameters

Name	Type
key	Uint8Array

Returns

Promise<void>

Implementation of

DB.del

Defined in

packages/trie/src/db/checkpoint.ts:208

---

get

▸ get(key): Promise<undefined | Uint8Array>

Inherit Doc

Parameters

Name	Type
key	Uint8Array

Returns

Promise<undefined | Uint8Array>

Implementation of

DB.get

Defined in

packages/trie/src/db/checkpoint.ts:139

---

hasCheckpoints

▸ hasCheckpoints(): boolean

Is the DB during a checkpoint phase?

Returns

boolean

Defined in

packages/trie/src/db/checkpoint.ts:84

---

open

▸ open(): Promise<void>

Returns

Promise<void>

Implementation of

DB.open

Defined in

packages/trie/src/db/checkpoint.ts:291

---

put

▸ put(key, value): Promise<void>

Inherit Doc

Parameters

Name	Type
key	Uint8Array
value	Uint8Array

Returns

Promise<void>

Implementation of

DB.put

Defined in

packages/trie/src/db/checkpoint.ts:184

---

revert

▸ revert(): Promise<Uint8Array>

Reverts the latest checkpoint

Returns

Promise<Uint8Array>

Defined in

packages/trie/src/db/checkpoint.ts:131

---

setCheckpoints

▸ setCheckpoints(checkpoints): void

Flush the checkpoints and use the given checkpoints instead.

Parameters

Name	Type
checkpoints	Checkpoint[]

Returns

void

Defined in

packages/trie/src/db/checkpoint.ts:70

---

shallowCopy

▸ shallowCopy(): CheckpointDB

Inherit Doc

Returns

CheckpointDB

Implementation of

DB.shallowCopy

Defined in

packages/trie/src/db/checkpoint.ts:283

---

stats

▸ stats(reset?): Object

Parameters

Name	Type	Default value
reset	boolean	true

Returns

Object

Name	Type
cache	{ hits: number = 0; reads: number = 0; writes: number = 0 }
cache.hits	number
cache.reads	number
cache.writes	number
db	{ hits: number = 0; reads: number = 0; writes: number = 0 }
db.hits	number
db.reads	number
db.writes	number
size	number

Defined in

packages/trie/src/db/checkpoint.ts:261