-
Notifications
You must be signed in to change notification settings - Fork 294
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(avm-simulator): pull out public storage caching and merging fro…
…m the state journal (#4730)
- Loading branch information
Showing
4 changed files
with
289 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
116 changes: 116 additions & 0 deletions
116
yarn-project/simulator/src/avm/journal/public_storage.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import { Fr } from '@aztec/foundation/fields'; | ||
|
|
||
| import { MockProxy, mock } from 'jest-mock-extended'; | ||
|
|
||
| import { PublicStateDB } from '../../index.js'; | ||
| import { PublicStorage } from './public_storage.js'; | ||
|
|
||
| describe('avm public storage', () => { | ||
| let publicDb: MockProxy<PublicStateDB>; | ||
| let publicStorage: PublicStorage; | ||
|
|
||
| beforeEach(() => { | ||
| publicDb = mock<PublicStateDB>(); | ||
| publicStorage = new PublicStorage(publicDb); | ||
| }); | ||
|
|
||
| describe('AVM Public Storage', () => { | ||
| it('Reading an unwritten slot works (gets zero & DNE)', async () => { | ||
| const contractAddress = new Fr(1); | ||
| const slot = new Fr(2); | ||
| // never written! | ||
| const [exists, gotValue] = await publicStorage.read(contractAddress, slot); | ||
| // doesn't exist, value is zero | ||
| expect(exists).toEqual(false); | ||
| expect(gotValue).toEqual(Fr.ZERO); | ||
| }); | ||
| it('Should cache storage write, reading works after write', async () => { | ||
| const contractAddress = new Fr(1); | ||
| const slot = new Fr(2); | ||
| const value = new Fr(3); | ||
| // Write to cache | ||
| publicStorage.write(contractAddress, slot, value); | ||
| const [exists, gotValue] = await publicStorage.read(contractAddress, slot); | ||
| // exists because it was previously written | ||
| expect(exists).toEqual(true); | ||
| expect(gotValue).toEqual(value); | ||
| }); | ||
| it('Reading works on fallback to host (gets value & exists)', async () => { | ||
| const contractAddress = new Fr(1); | ||
| const slot = new Fr(2); | ||
| const storedValue = new Fr(420); | ||
| // ensure that fallback to host gets a value | ||
| publicDb.storageRead.mockResolvedValue(Promise.resolve(storedValue)); | ||
|
|
||
| const [exists, gotValue] = await publicStorage.read(contractAddress, slot); | ||
| // it exists in the host, so it must've been written before | ||
| expect(exists).toEqual(true); | ||
| expect(gotValue).toEqual(storedValue); | ||
| }); | ||
| it('Reading works on fallback to parent (gets value & exists)', async () => { | ||
| const contractAddress = new Fr(1); | ||
| const slot = new Fr(2); | ||
| const value = new Fr(3); | ||
| const childStorage = new PublicStorage(publicDb, publicStorage); | ||
|
|
||
| publicStorage.write(contractAddress, slot, value); | ||
| const [exists, gotValue] = await childStorage.read(contractAddress, slot); | ||
| // exists because it was previously written! | ||
| expect(exists).toEqual(true); | ||
| expect(gotValue).toEqual(value); | ||
| }); | ||
| it('When reading from storage, should check cache, then parent, then host', async () => { | ||
| // Store a different value in storage vs the cache, and make sure the cache is returned | ||
| const contractAddress = new Fr(1); | ||
| const slot = new Fr(2); | ||
| const storedValue = new Fr(420); | ||
| const parentValue = new Fr(69); | ||
| const cachedValue = new Fr(1337); | ||
|
|
||
| publicDb.storageRead.mockResolvedValue(Promise.resolve(storedValue)); | ||
| const childStorage = new PublicStorage(publicDb, publicStorage); | ||
|
|
||
| // Cache miss falls back to host | ||
| const [, cacheMissResult] = await childStorage.read(contractAddress, slot); | ||
| expect(cacheMissResult).toEqual(storedValue); | ||
|
|
||
| // Write to storage | ||
| publicStorage.write(contractAddress, slot, parentValue); | ||
| // Reading from child should give value written in parent | ||
| const [, valueFromParent] = await childStorage.read(contractAddress, slot); | ||
| expect(valueFromParent).toEqual(parentValue); | ||
|
|
||
| // Now write a value directly in child | ||
| childStorage.write(contractAddress, slot, cachedValue); | ||
|
|
||
| // Reading should now give the value written in child | ||
| const [, cachedResult] = await childStorage.read(contractAddress, slot); | ||
| expect(cachedResult).toEqual(cachedValue); | ||
| }); | ||
| }); | ||
|
|
||
| it('Should be able to merge two public storages together', async () => { | ||
| // Checking that child's writes take precedence on marge | ||
| const contractAddress = new Fr(1); | ||
| const slot = new Fr(2); | ||
| // value written initially in parent | ||
| const value = new Fr(1); | ||
| // value overwritten in child and later merged into parent | ||
| const valueT1 = new Fr(2); | ||
|
|
||
| // Write initial value to parent | ||
| publicStorage.write(contractAddress, slot, value); | ||
|
|
||
| const childStorage = new PublicStorage(publicDb, publicStorage); | ||
| // Write valueT1 to child | ||
| childStorage.write(contractAddress, slot, valueT1); | ||
|
|
||
| // Parent accepts child's staged writes | ||
| publicStorage.acceptAndMerge(childStorage); | ||
|
|
||
| // Read from parent gives latest value written in child before merge (valueT1) | ||
| const [exists, result] = await publicStorage.read(contractAddress, slot); | ||
| expect(exists).toEqual(true); | ||
| expect(result).toEqual(valueT1); | ||
| }); | ||
| }); |
Oops, something went wrong.