Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Trie checkpoint test expansion #3705

Merged
merged 7 commits into from
Oct 1, 2024
Merged

Trie checkpoint test expansion #3705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a742276
Expand trie checkpointing tests to include more exhaustive cases
scorbajio Sep 26, 2024
4896ef1
Fix async usage of test functions
scorbajio Sep 26, 2024
cafde6a
Separate checkpointing scenerio tests from preexisting checkpoint tests
scorbajio Sep 27, 2024
823a5fa
Update description string
scorbajio Sep 27, 2024
613ea20
Remove redundant tests
scorbajio Sep 27, 2024
66e2a8a
Merge branch 'master' into trie-checkpoint-test-expansion
scorbajio Sep 30, 2024
737f02b
Fix lint issues
scorbajio Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 0 additions & 116 deletions packages/trie/test/trie/checkpoint.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ import { assert, describe, it } from 'vitest'

import { ROOT_DB_KEY, Trie, createTrie } from '../../src/index.js'

import type { BatchDBOp } from '@ethereumjs/util'

describe('testing checkpoints', () => {
let trie: Trie
let trieCopy: Trie
Expand Down Expand Up @@ -51,16 +49,6 @@ describe('testing checkpoints', () => {
postRoot = bytesToHex(trie.root())
})

it('should get values from before checkpoint', async () => {
const res = await trie.get(utf8ToBytes('doge'))
assert.ok(equalsBytes(utf8ToBytes('coin'), res!))
})

it('should get values from cache', async () => {
const res = await trie.get(utf8ToBytes('love'))
assert.ok(equalsBytes(utf8ToBytes('emotion'), res!))
})

it('should copy trie and get upstream and cache values after checkpoint', async () => {
trieCopy = trie.shallowCopy()
assert.equal(bytesToHex(trieCopy.root()), postRoot)
Expand All @@ -87,110 +75,6 @@ describe('testing checkpoints', () => {
assert.equal(bytesToUtf8(value!), 'value1')
})

it('should revert to the original root', async () => {
assert.ok(trie.hasCheckpoints())
await trie.revert()
assert.equal(bytesToHex(trie.root()), preRoot)
assert.notOk(trie.hasCheckpoints())
})

it('should not get values from cache after revert', async () => {
const res = await trie.get(utf8ToBytes('love'))
assert.notOk(res)
})

it('should commit a checkpoint', async () => {
trie.checkpoint()
await trie.put(utf8ToBytes('test'), utf8ToBytes('something'))
await trie.put(utf8ToBytes('love'), utf8ToBytes('emotion'))
await trie.commit()
assert.equal(trie.hasCheckpoints(), false)
assert.equal(bytesToHex(trie.root()), postRoot)
})

it('should get new values after commit', async () => {
const res = await trie.get(utf8ToBytes('love'))
assert.ok(equalsBytes(utf8ToBytes('emotion'), res!))
})

it('should commit a nested checkpoint', async () => {
trie.checkpoint()
await trie.put(utf8ToBytes('test'), utf8ToBytes('something else'))
const root = trie.root()
trie.checkpoint()
await trie.put(utf8ToBytes('the feels'), utf8ToBytes('emotion'))
await trie.revert()
await trie.commit()
assert.equal(trie.hasCheckpoints(), false)
assert.equal(trie.root(), root)
})

const k1 = utf8ToBytes('k1')
const v1 = utf8ToBytes('v1')
const v12 = utf8ToBytes('v12')
const v123 = utf8ToBytes('v123')

it('revert -> put', async () => {
trie = new Trie()

trie.checkpoint()
await trie.put(k1, v1)
assert.deepEqual(await trie.get(k1), v1, 'before revert: v1 in trie')
await trie.revert()
assert.deepEqual(await trie.get(k1), null, 'after revert: v1 removed')
})

it('revert -> put (update)', async () => {
trie = new Trie()

await trie.put(k1, v1)
assert.deepEqual(await trie.get(k1), v1, 'before CP: v1')
trie.checkpoint()
await trie.put(k1, v12)
await trie.put(k1, v123)
await trie.revert()
assert.deepEqual(await trie.get(k1), v1, 'after revert: v1')
})

it('revert -> put (update) batched', async () => {
const trie = new Trie()
await trie.put(k1, v1)
assert.deepEqual(await trie.get(k1), v1, 'before CP: v1')
trie.checkpoint()
const ops = [
{ type: 'put', key: k1, value: v12 },
{ type: 'put', key: k1, value: v123 },
] as BatchDBOp[]
await trie.batch(ops)
await trie.revert()
assert.deepEqual(await trie.get(k1), v1, 'after revert: v1')
})

it('Checkpointing: revert -> del', async () => {
const trie = new Trie()
await trie.put(k1, v1)
assert.deepEqual(await trie.get(k1), v1, 'before CP: v1')
trie.checkpoint()
await trie.del(k1)
assert.deepEqual(await trie.get(k1), null, 'before revert: null')
await trie.revert()
assert.deepEqual(await trie.get(k1), v1, 'after revert: v1')
})

it('Checkpointing: nested checkpoints -> commit -> revert', async () => {
const trie = new Trie()
await trie.put(k1, v1)
assert.deepEqual(await trie.get(k1), v1, 'before CP: v1')
trie.checkpoint()
await trie.put(k1, v12)
trie.checkpoint()
await trie.put(k1, v123)
await trie.commit()
assert.deepEqual(await trie.get(k1), v123, 'after commit (second CP): v123')
await trie.revert()
assert.deepEqual(await trie.get(k1), v1, 'after revert (first CP): v1')
})

/*
In this educational example, it is shown how operations on a clone of a trie
can be copied into the original trie. This also includes pruning.
Expand Down
Loading
Loading