Pw/world state sync

.gitmodules

@@ -7,3 +7,9 @@
 [submodule "l1-contracts"]
 	path = l1-contracts
 	url = [email protected]:AztecProtocol/aztec3-l1-contracts.git
+[submodule "barretenberg"]
+	path = barretenberg
+	url = [email protected]:AztecProtocol/barretenberg.git
+[submodule "yarn-project/foundation"]
+	path = yarn-project/foundation
+	url = [email protected]:AztecProtocol/foundation.git

README.md

@@ -11,6 +11,6 @@ The Aztec 3 system consists of the following sub projects.
 - `key-store`
 - `p2p`
 - `prover-client`
-- `public-client`
+- `aztec-node`
 - `sequencer-client`
 - `wallet`

bootstrap.sh

@@ -47,14 +47,17 @@ PROJECTS=(
   # "yarn-project/aztec-cli:yarn build"
   "yarn-project/aztec.js:yarn build"
   "yarn-project/archiver:yarn build"
-  # "yarn-project/ethereum.js:yarn build"
+  "yarn-project/ethereum.js:yarn build"
+  "yarn-project/foundation:yarn build"
   # "yarn-project/kernel-simulator:yarn build"
   "yarn-project/key-store:yarn build"
-  # "yarn-project/p2p:yarn build"
+  "yarn-project/merkle-tree:yarn build"
+  "yarn-project/p2p:yarn build"
   # "yarn-project/prover-client:yarn build"
-  # "yarn-project/public-client:yarn build"
+  "yarn-project/aztec-node:yarn build"
   # "yarn-project/sequencer-client:yarn build"
   # "yarn-project/wallet:yarn build"
+  "yarn-project/world-state:yarn build"
 )
 
 for E in "${PROJECTS[@]}"; do

build_manifest.json

@@ -50,7 +50,7 @@
     "projectDir": "yarn-project/archiver",
     "dockerfile": "archiver/Dockerfile",
     "rebuildPatterns": ["^yarn-project/archiver/"],
-    "dependencies": ["yarn-project-base"]
+    "dependencies": ["yarn-project-base", "ethereum.js"]
   },
   "aztec-cli": {
     "buildDir": "yarn-project",
@@ -94,6 +94,13 @@
     "rebuildPatterns": ["^yarn-project/key-store/"],
     "dependencies": ["yarn-project-base"]
   },
+  "merkle-tree": {
+    "buildDir": "yarn-project",
+    "projectDir": "yarn-project/merkle-tree",
+    "dockerfile": "merkle-tree/Dockerfile",
+    "rebuildPatterns": ["^yarn-project/merkle-tree/"],
+    "dependencies": ["yarn-project-base", "foundation"]
+  },
   "noir-contracts": {
     "buildDir": "yarn-project",
     "projectDir": "yarn-project/noir-contracts",
@@ -106,7 +113,7 @@
     "projectDir": "yarn-project/p2p",
     "dockerfile": "p2p/Dockerfile",
     "rebuildPatterns": ["^yarn-project/p2p/"],
-    "dependencies": ["yarn-project-base"]
+    "dependencies": ["yarn-project-base", "archiver"]
   },
   "prover-client": {
     "buildDir": "yarn-project",
@@ -115,11 +122,11 @@
     "rebuildPatterns": ["^yarn-project/prover-client/"],
     "dependencies": ["yarn-project-base"]
   },
-  "public-client": {
+  "aztec-node": {
     "buildDir": "yarn-project",
-    "projectDir": "yarn-project/public-client",
-    "dockerfile": "public-client/Dockerfile",
-    "rebuildPatterns": ["^yarn-project/public-client/"],
+    "projectDir": "yarn-project/aztec-node",
+    "dockerfile": "aztec-node/Dockerfile",
+    "rebuildPatterns": ["^yarn-project/aztec-node/"],
     "dependencies": ["yarn-project-base"]
   },
   "sequencer-client": {
@@ -135,5 +142,12 @@
     "dockerfile": "wallet/Dockerfile",
     "rebuildPatterns": ["^yarn-project/wallet/"],
     "dependencies": ["yarn-project-base"]
+  },
+  "world-state": {
+    "buildDir": "yarn-project",
+    "projectDir": "yarn-project/world-state",
+    "dockerfile": "world-state/Dockerfile",
+    "rebuildPatterns": ["^yarn-project/world-state/"],
+    "dependencies": ["yarn-project-base", "merkle-tree"]
   }
 }

build_manifest.sh

@@ -19,9 +19,11 @@ PROJECTS=(
   # ethereum.js:yarn-project
   # kernel-simulator:yarn-project
   # key-store:yarn-project
+  # merkle-tree:yarn-project
   # p2p:yarn-project
   # prover-client:yarn-project
-  # public-client:yarn-project
+  # aztec-node:yarn-project
   # sequencer-client:yarn-project
   # wallet:yarn-project
+  # world-state:yarn-project
 )

yarn-project/archiver/README.md

@@ -4,6 +4,3 @@ To run:
 2. in the aztec3-l1-contracts repo check out my branch `janb/archiver-test-data`,
 3. deploy the contracts and generate initial activity with: `forge script --fork-url "http://127.0.0.1:8545/" --ffi GenerateActivityTest --sig "testGenerateActivity()" --private-key 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 --broadcast`
 4. in this repository run `yarn start:dev` (Note: this repo is currently messy and eslint will not allow it to be built with `yarn start`)
-
-Relevant unresolved issues:
-https://stackoverflow.com/questions/75739742/why-is-eslint-complaining-about-inheritdoc-tag

yarn-project/archiver/package.json

@@ -26,6 +26,8 @@
     "rootDir": "./src"
   },
   "dependencies": {
+    "@aztec/ethereum.js": "workspace:^",
+    "@aztec/foundation": "workspace:^",
     "debug": "^4.3.4",
     "tsc-watch": "^6.0.0",
     "tslib": "^2.5.0",

yarn-project/archiver/src/archiver.test.ts → yarn-project/archiver/src/archiver/archiver.test.ts

@@ -1,12 +1,13 @@
+import { EthAddress } from '@aztec/ethereum.js/eth_address';
 import { jest } from '@jest/globals';
-import { getAddress, PublicClient } from 'viem';
+import { PublicClient } from 'viem';
 import { Archiver } from './archiver.js';
 
 jest.mock('viem');
 
 describe('Archiver', () => {
-  const rollupAddress = getAddress('0x0000000000000000000000000000000000000000');
-  const yeeterAddress = getAddress('0x0000000000000000000000000000000000000000');
+  const rollupAddress = '0x0000000000000000000000000000000000000000';
+  const yeeterAddress = '0x0000000000000000000000000000000000000000';
   let publicClient: PublicClient;
 
   beforeEach(() => {
@@ -35,9 +36,13 @@ describe('Archiver', () => {
   });
 
   it('can start, sync and stop', async () => {
-    const archiver = new Archiver(publicClient, rollupAddress, yeeterAddress);
+    const archiver = new Archiver(
+      publicClient,
+      EthAddress.fromString(rollupAddress),
+      EthAddress.fromString(yeeterAddress),
+    );
     let syncStatus = await archiver.getSyncStatus();
-    let latestBlockNum = archiver.getLatestBlockNum();
+    let latestBlockNum = await archiver.getLatestBlockNum();
     expect(syncStatus).toStrictEqual({
       syncedToBlock: -1,
       latestBlock: 2,
@@ -47,13 +52,13 @@ describe('Archiver', () => {
     await archiver.start();
 
     syncStatus = await archiver.getSyncStatus();
-    latestBlockNum = archiver.getLatestBlockNum();
+    latestBlockNum = await archiver.getLatestBlockNum();
     expect(syncStatus).toStrictEqual({
       syncedToBlock: 2,
       latestBlock: 2,
     });
     expect(latestBlockNum).toBe(syncStatus.syncedToBlock);
 
-    archiver.stop();
+    await archiver.stop();
   });
 });

yarn-project/archiver/src/archiver.ts → yarn-project/archiver/src/archiver/archiver.ts

@@ -1,10 +1,12 @@
-import { Address, PublicClient } from 'viem';
-import { rollupAbi } from './abis/rollup.js';
-import { yeeterAbi } from './abis/yeeter.js';
-import { ContractData, L2Block } from './l2_block/l2_block.js';
-import { randomAppendOnlyTreeSnapshot, randomBytes, randomContractData } from './l2_block/mocks.js';
-import { L2BlockSource, SyncStatus } from './l2_block_source.js';
-import { createLogger } from './movetofoundation/log/console.js';
+import { PublicClient, getAddress, http, createPublicClient } from 'viem';
+import { rollupAbi } from '../abis/rollup.js';
+import { yeeterAbi } from '../abis/yeeter.js';
+import { ContractData, L2Block } from '../l2_block/l2_block.js';
+import { randomAppendOnlyTreeSnapshot, randomBytes, randomContractData } from '../l2_block/mocks.js';
+import { L2BlockSource, L2BlockSourceSyncStatus } from '../l2_block/l2_block_source.js';
+import { EthAddress } from '@aztec/ethereum.js/eth_address';
+import { localhost } from 'viem/chains';
+import { createDebugLogger } from '@aztec/foundation';
 
 /**
  * Pulls L2 blocks in a non-blocking manner and provides interface for their retrieval.
@@ -33,23 +35,39 @@ export class Archiver implements L2BlockSource {
    */
   constructor(
     private readonly publicClient: PublicClient,
-    private readonly rollupAddress: Address,
-    private readonly yeeterAddress: Address,
-    private readonly log = createLogger('Archiver'),
+    private readonly rollupAddress: EthAddress,
+    private readonly yeeterAddress: EthAddress,
+    private readonly log = createDebugLogger('aztec:archiver'),
   ) {}
 
   /**
-   * {@inheritDoc L2BlockSource.getSyncStatus}
+   * Creates a new instance of the Archiver.
+   * @param rpcUrl - The RPC url for connecting to an eth node.
+   * @param rollupAddress - Ethereum address of the rollup contract.
+   * @param yeeterAddress - Ethereum address of the yeeter contract.
+   * @returns - An instance of the archiver.
+   */
+  public static new(rpcUrl: string, rollupAddress: EthAddress, yeeterAddress: EthAddress) {
+    const publicClient = createPublicClient({
+      chain: localhost,
+      transport: http(rpcUrl),
+    });
+    return new Archiver(publicClient, rollupAddress, yeeterAddress);
+  }
+
+  /**
+   * Gets the sync status of the L2 block source.
+   * @returns The sync status of the L2 block source.
    */
-  public async getSyncStatus(): Promise<SyncStatus> {
+  public async getSyncStatus(): Promise<L2BlockSourceSyncStatus> {
     const nextBlockNum = await this.publicClient.readContract({
-      address: this.rollupAddress,
+      address: getAddress(this.rollupAddress.toString()),
       abi: rollupAbi,
       functionName: 'nextBlockNum',
     });
 
     return {
-      syncedToBlock: this.getLatestBlockNum(),
+      syncedToBlock: await this.getLatestBlockNum(),
       latestBlock: Number(nextBlockNum) - 1,
     };
   }
@@ -70,13 +88,13 @@ export class Archiver implements L2BlockSource {
    */
   private async runInitialSync() {
     const blockFilter = await this.publicClient.createEventFilter({
-      address: this.rollupAddress,
+      address: getAddress(this.rollupAddress.toString()),
       fromBlock: 0n,
       event: rollupAbi[0],
     });
 
     const yeetFilter = await this.publicClient.createEventFilter({
-      address: this.yeeterAddress,
+      address: getAddress(this.yeeterAddress.toString()),
       event: yeeterAbi[0],
       fromBlock: 0n,
     });
@@ -93,13 +111,13 @@ export class Archiver implements L2BlockSource {
    */
   private startWatchingEvents() {
     this.unwatchBlocks = this.publicClient.watchEvent({
-      address: this.rollupAddress,
+      address: getAddress(this.rollupAddress.toString()),
       event: rollupAbi[0],
       onLogs: logs => this.processBlockLogs(logs),
     });
 
     this.unwatchYeets = this.publicClient.watchEvent({
-      address: this.yeeterAddress,
+      address: getAddress(this.yeeterAddress.toString()),
       event: yeeterAbi[0],
       onLogs: logs => this.processYeetLogs(logs),
     });
@@ -147,9 +165,10 @@ export class Archiver implements L2BlockSource {
   }
 
   /**
-   * Stops the event polling loop.
+   * Stops the archiver.
+   * @returns A promise signalling completion of the stop process.
    */
-  public stop() {
+  public stop(): Promise<void> {
     this.log('Stopping...');
     if (this.unwatchBlocks === undefined || this.unwatchYeets === undefined) {
       throw new Error('Archiver is not running.');
@@ -159,27 +178,32 @@ export class Archiver implements L2BlockSource {
     this.unwatchYeets();
 
     this.log('Stopped.');
+    return Promise.resolve();
   }
 
   /**
-   * {@inheritDoc L2BlockSource.getL2Blocks}
+   * Gets the `take` amount of L2 blocks starting from `from`.
+   * @param from - If of the first rollup to return (inclusive).
+   * @param take - The number of blocks to return.
+   * @returns The requested L2 blocks.
    */
-  public getL2Blocks(from: number, take: number): L2Block[] {
+  public getL2Blocks(from: number, take: number): Promise<L2Block[]> {
     if (from > this.l2Blocks.length) {
-      return [];
+      return Promise.resolve([]);
     }
     if (from + take > this.l2Blocks.length) {
-      return this.l2Blocks.slice(from);
+      return Promise.resolve(this.l2Blocks.slice(from));
     }
 
-    return this.l2Blocks.slice(from, from + take);
+    return Promise.resolve(this.l2Blocks.slice(from, from + take));
   }
 
   /**
-   * {@inheritDoc L2BlockSource.getLatestBlockNum}
+   * Gets the number of the latest L2 block processed by the block source implementation.
+   * @returns The number of the latest L2 block processed by the block source implementation.
    */
-  public getLatestBlockNum(): number {
-    return this.l2Blocks.length - 1;
+  public getLatestBlockNum(): Promise<number> {
+    return Promise.resolve(this.l2Blocks.length - 1);
   }
 }
 

yarn-project/archiver/src/archiver/index.ts

@@ -0,0 +1 @@
+export * from './archiver.js';

yarn-project/archiver/src/block_downloader/index.ts

@@ -0,0 +1 @@
+export * from './l2_block_downloader.js';