ethereumjs-monorepo

@ethereumjs/binarytree

---

@ethereumjs/binarytree / CheckpointDB

Class: CheckpointDB

Defined in: db/checkpoint.ts:15

Checkpoint-aware DB wrapper with optional LRU node cache for binary trees.

Implements

• DB

Constructors

Constructor

new CheckpointDB(opts): CheckpointDB

Defined in: db/checkpoint.ts:49

Initialize a DB instance.

Parameters

opts

CheckpointDBOpts

Returns

CheckpointDB

Properties

_stats

_stats: object

Defined in: db/checkpoint.ts:33

cache

cache: object

cache.hits

hits: number = 0

cache.reads

reads: number = 0

cache.writes

writes: number = 0

db

db: object

db.hits

hits: number = 0

db.reads

reads: number = 0

db.writes

writes: number = 0

---

cacheSize

readonly cacheSize: number

Defined in: db/checkpoint.ts:18

---

checkpoints

checkpoints: Checkpoint[]

Defined in: db/checkpoint.ts:16

---

db

db: DB<string, string | Uint8Array<ArrayBufferLike>>

Defined in: db/checkpoint.ts:17

Methods

batch()

batch(opStack): Promise<void>

Defined in: db/checkpoint.ts:241

Parameters

opStack

BatchDBOp[]

Returns

Promise<void>

Inherit Doc

Implementation of

DB.batch

---

checkpoint()

checkpoint(root): void

Defined in: db/checkpoint.ts:92

Push a new checkpoint onto the stack.

Parameters

root

Uint8Array

Tree root hash at this checkpoint boundary

Returns

void

---

commit()

commit(): Promise<void>

Defined in: db/checkpoint.ts:99

Commits the latest checkpoint

Returns

Promise<void>

---

del()

del(key): Promise<void>

Defined in: db/checkpoint.ts:218

Parameters

key

Uint8Array

Returns

Promise<void>

Inherit Doc

Implementation of

DB.del

---

get()

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

Defined in: db/checkpoint.ts:139

Parameters

key

Uint8Array

Returns

Promise<Uint8Array<ArrayBufferLike> | undefined>

Inherit Doc

Implementation of

DB.get

---

hasCheckpoints()

hasCheckpoints(): boolean

Defined in: db/checkpoint.ts:83

Is the DB during a checkpoint phase?

Returns

boolean

---

open()

open(): Promise<void>

Defined in: db/checkpoint.ts:303

Opens the database – if applicable

Returns

Promise<void>

Implementation of

DB.open

---

put()

put(key, value): Promise<void>

Defined in: db/checkpoint.ts:193

Parameters

key

Uint8Array

value

Uint8Array

Returns

Promise<void>

Inherit Doc

Implementation of

DB.put

---

revert()

revert(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: db/checkpoint.ts:131

Reverts the latest checkpoint

Returns

Promise<Uint8Array<ArrayBufferLike>>

---

setCheckpoints()

setCheckpoints(checkpoints): void

Defined in: db/checkpoint.ts:69

Replace the checkpoint stack with a copy of the given checkpoints.

Parameters

checkpoints

Checkpoint[]

Checkpoints to adopt (maps are cloned)

Returns

void

---

shallowCopy()

shallowCopy(): CheckpointDB

Defined in: db/checkpoint.ts:295

Returns

CheckpointDB

Inherit Doc

Implementation of

DB.shallowCopy

---

stats()

stats(reset?): object

Defined in: db/checkpoint.ts:273

Parameters

reset?

boolean = true

Returns

object

cache

cache: object

cache.hits

hits: number = 0

cache.reads

reads: number = 0

cache.writes

writes: number = 0

db

db: object

db.hits

hits: number = 0

db.reads

reads: number = 0

db.writes

writes: number = 0

size

size: number