@aztec/world-state 0.0.0-test.1 → 0.0.1-commit.017a351

package/dest/synchronizer/server_world_state_synchronizer.js

@@ -1,13 +1,14 @@
-import { L1_TO_L2_MSG_SUBTREE_HEIGHT } from '@aztec/constants';
+import { INITIAL_CHECKPOINT_NUMBER } from '@aztec/constants';
+import { BlockNumber, CheckpointNumber } from '@aztec/foundation/branded-types';
 import { createLogger } from '@aztec/foundation/log';
 import { promiseWithResolvers } from '@aztec/foundation/promise';
 import { elapsed } from '@aztec/foundation/timer';
-import { MerkleTreeCalculator } from '@aztec/foundation/trees';
-import { SHA256Trunc } from '@aztec/merkle-tree';
+import { GENESIS_CHECKPOINT_HEADER_HASH, L2BlockStream } from '@aztec/stdlib/block';
 import { WorldStateRunningState } from '@aztec/stdlib/interfaces/server';
 import { MerkleTreeId } from '@aztec/stdlib/trees';
-import { TraceableL2BlockStream, getTelemetryClient } from '@aztec/telemetry-client';
+import { getTelemetryClient } from '@aztec/telemetry-client';
 import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js';
+import { WorldStateSynchronizerError } from './errors.js';
 /**
  * Synchronizes the world state with the L2 blocks from a L2BlockSource via a block stream.
  * The synchronizer will download the L2 blocks from the L2BlockSource and update the merkle trees.
@@ -22,21 +23,22 @@ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js
     latestBlockNumberAtStart;
     historyToKeep;
     currentState;
-    latestBlockHashQuery;
     syncPromise;
     blockStream;
+    // WorldState doesn't track the proven block number, it only tracks the latest tips of the pending chain and the finalized chain
+    // store the proven block number here, in the synchronizer, so that we don't end up spamming the logs with 'chain-proved' events
+    provenBlockNumber;
     constructor(merkleTreeDb, l2BlockSource, config, instrumentation = new WorldStateInstrumentation(getTelemetryClient()), log = createLogger('world_state')){
         this.merkleTreeDb = merkleTreeDb;
         this.l2BlockSource = l2BlockSource;
         this.config = config;
         this.instrumentation = instrumentation;
         this.log = log;
-        this.latestBlockNumberAtStart = 0;
+        this.latestBlockNumberAtStart = BlockNumber.ZERO;
         this.currentState = WorldStateRunningState.IDLE;
-        this.latestBlockHashQuery = undefined;
         this.syncPromise = promiseWithResolvers();
         this.merkleTreeCommitted = this.merkleTreeDb.getCommitted();
-        this.historyToKeep = config.worldStateBlockHistory < 1 ? undefined : config.worldStateBlockHistory;
+        this.historyToKeep = config.worldStateCheckpointHistory < 1 ? undefined : config.worldStateCheckpointHistory;
         this.log.info(`Created world state synchroniser with block history of ${this.historyToKeep === undefined ? 'infinity' : this.historyToKeep}`);
     }
     getCommitted() {
@@ -45,8 +47,14 @@ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js
     getSnapshot(blockNumber) {
         return this.merkleTreeDb.getSnapshot(blockNumber);
     }
-    fork(blockNumber) {
-        return this.merkleTreeDb.fork(blockNumber);
+    fork(blockNumber, opts) {
+        return this.merkleTreeDb.fork(blockNumber, opts);
+    }
+    backupTo(dstPath, compact) {
+        return this.merkleTreeDb.backupTo(dstPath, compact);
+    }
+    clear() {
+        return this.merkleTreeDb.clear();
     }
     async start() {
         if (this.currentState === WorldStateRunningState.STOPPED) {
@@ -56,7 +64,7 @@ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js
             return this.syncPromise;
         }
         // Get the current latest block number
-        this.latestBlockNumberAtStart = await (this.config.worldStateProvenBlocksOnly ? this.l2BlockSource.getProvenBlockNumber() : this.l2BlockSource.getBlockNumber());
+        this.latestBlockNumberAtStart = BlockNumber(await this.l2BlockSource.getBlockNumber());
         const blockToDownloadFrom = await this.getLatestBlockNumber() + 1;
         if (blockToDownloadFrom <= this.latestBlockNumberAtStart) {
             // If there are blocks to be retrieved, go to a synching state
@@ -74,12 +82,11 @@ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js
         return this.syncPromise.promise;
     }
     createBlockStream() {
-        const tracer = this.instrumentation.telemetry.getTracer('WorldStateL2BlockStream');
         const logger = createLogger('world-state:block_stream');
-        return new TraceableL2BlockStream(this.l2BlockSource, this, this, tracer, 'WorldStateL2BlockStream', logger, {
-            proven: this.config.worldStateProvenBlocksOnly,
+        return new L2BlockStream(this.l2BlockSource, this, this, logger, {
             pollIntervalMS: this.config.worldStateBlockCheckIntervalMS,
-            batchSize: this.config.worldStateBlockRequestBatchSize
+            batchSize: this.config.worldStateBlockRequestBatchSize,
+            ignoreCheckpoints: true
         });
     }
     async stop() {
@@ -93,10 +100,10 @@ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js
     async status() {
         const summary = await this.merkleTreeDb.getStatusSummary();
         const status = {
-            latestBlockNumber: Number(summary.unfinalisedBlockNumber),
-            latestBlockHash: await this.getL2BlockHash(Number(summary.unfinalisedBlockNumber)) ?? '',
-            finalisedBlockNumber: Number(summary.finalisedBlockNumber),
-            oldestHistoricBlockNumber: Number(summary.oldestHistoricalBlock),
+            latestBlockNumber: summary.unfinalizedBlockNumber,
+            latestBlockHash: await this.getL2BlockHash(summary.unfinalizedBlockNumber) ?? '',
+            finalizedBlockNumber: summary.finalizedBlockNumber,
+            oldestHistoricBlockNumber: summary.oldestHistoricalBlock,
             treesAreSynched: summary.treesAreSynched
         };
         return {
@@ -105,80 +112,170 @@ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js
         };
     }
     async getLatestBlockNumber() {
-        return (await this.getL2Tips()).latest.number;
+        return (await this.getL2Tips()).proposed.number;
+    }
+    async stopSync() {
+        this.log.debug('Stopping sync...');
+        await this.blockStream?.stop();
+        this.log.info('Stopped sync');
+    }
+    resumeSync() {
+        if (!this.blockStream) {
+            throw new Error('Cannot resume sync as block stream is not initialized');
+        }
+        this.log.debug('Resuming sync...');
+        this.blockStream.start();
+        this.log.info('Resumed sync');
     }
     /**
    * Forces an immediate sync.
-   * @param targetBlockNumber - The target block number that we must sync to. Will download unproven blocks if needed to reach it. Throws if cannot be reached.
+   * @param targetBlockNumber - The target block number that we must sync to. Will download unproven blocks if needed to reach it.
+   * @param blockHash - If provided, verifies the block at targetBlockNumber matches this hash. On mismatch, triggers a resync (reorg detection).
    * @returns A promise that resolves with the block number the world state was synced to
-   */ async syncImmediate(targetBlockNumber) {
-        if (this.currentState !== WorldStateRunningState.RUNNING || this.blockStream === undefined) {
+   */ async syncImmediate(targetBlockNumber, blockHash) {
+        if (this.currentState !== WorldStateRunningState.RUNNING) {
             throw new Error(`World State is not running. Unable to perform sync.`);
         }
+        if (this.blockStream === undefined) {
+            throw new Error('Block stream is not initialized. Unable to perform sync.');
+        }
         // If we have been given a block number to sync to and we have reached that number then return
         const currentBlockNumber = await this.getLatestBlockNumber();
         if (targetBlockNumber !== undefined && targetBlockNumber <= currentBlockNumber) {
-            return currentBlockNumber;
+            if (blockHash === undefined) {
+                return currentBlockNumber;
+            }
+            // If a block hash was provided, verify we're on the expected fork
+            const currentHash = await this.getL2BlockHash(targetBlockNumber);
+            if (currentHash === blockHash.toString()) {
+                return currentBlockNumber;
+            }
+            // Hash mismatch: a reorg may have occurred, fall through to trigger sync
+            this.log.debug(`World state block hash mismatch at ${targetBlockNumber} (expected ${blockHash}, got ${currentHash}). Triggering resync.`);
         }
         this.log.debug(`World State at ${currentBlockNumber} told to sync to ${targetBlockNumber ?? 'latest'}`);
+        // If the archiver is behind the target block, force an archiver sync
+        if (targetBlockNumber) {
+            const archiverLatestBlock = BlockNumber(await this.l2BlockSource.getBlockNumber());
+            if (archiverLatestBlock < targetBlockNumber) {
+                this.log.debug(`Archiver is at ${archiverLatestBlock} behind target block ${targetBlockNumber}.`);
+                await this.l2BlockSource.syncImmediate();
+            }
+        }
         // Force the block stream to sync against the archiver now
         await this.blockStream.sync();
         // If we have been given a block number to sync to and we have not reached that number then fail
         const updatedBlockNumber = await this.getLatestBlockNumber();
         if (targetBlockNumber !== undefined && targetBlockNumber > updatedBlockNumber) {
-            throw new Error(`Unable to sync to block number ${targetBlockNumber} (last synced is ${updatedBlockNumber})`);
+            throw new WorldStateSynchronizerError(`Unable to sync to block number ${targetBlockNumber} (last synced is ${updatedBlockNumber})`, {
+                cause: {
+                    reason: 'block_not_available',
+                    previousBlockNumber: currentBlockNumber,
+                    updatedBlockNumber,
+                    targetBlockNumber
+                }
+            });
+        }
+        // If a block hash was provided, verify we're on the expected fork after syncing, throw otherwise
+        if (blockHash !== undefined && targetBlockNumber !== undefined) {
+            const updatedHash = await this.getL2BlockHash(targetBlockNumber);
+            if (updatedHash !== blockHash.toString()) {
+                throw new WorldStateSynchronizerError(`Block hash mismatch at block ${targetBlockNumber} (expected ${blockHash} but got ${updatedHash})`, {
+                    cause: {
+                        reason: 'block_hash_mismatch',
+                        targetBlockNumber,
+                        expectedHash: blockHash.toString(),
+                        actualHash: updatedHash
+                    }
+                });
+            }
         }
         return updatedBlockNumber;
     }
     /** Returns the L2 block hash for a given number. Used by the L2BlockStream for detecting reorgs. */ async getL2BlockHash(number) {
-        if (number === 0) {
+        if (number === BlockNumber.ZERO) {
             return (await this.merkleTreeCommitted.getInitialHeader().hash()).toString();
         }
-        if (this.latestBlockHashQuery?.hash === undefined || number !== this.latestBlockHashQuery.blockNumber) {
-            this.latestBlockHashQuery = {
-                hash: await this.merkleTreeCommitted.getLeafValue(MerkleTreeId.ARCHIVE, BigInt(number)).then((leaf)=>leaf?.toString()),
-                blockNumber: number
-            };
-        }
-        return this.latestBlockHashQuery.hash;
+        return this.merkleTreeCommitted.getLeafValue(MerkleTreeId.ARCHIVE, BigInt(number)).then((leaf)=>leaf?.toString());
     }
     /** Returns the latest L2 block number for each tip of the chain (latest, proven, finalized). */ async getL2Tips() {
         const status = await this.merkleTreeDb.getStatusSummary();
-        const unfinalisedBlockHash = await this.getL2BlockHash(Number(status.unfinalisedBlockNumber));
+        const unfinalizedBlockHashPromise = this.getL2BlockHash(status.unfinalizedBlockNumber);
+        const finalizedBlockHashPromise = this.getL2BlockHash(status.finalizedBlockNumber);
+        const provenBlockNumber = this.provenBlockNumber ?? status.finalizedBlockNumber;
+        const provenBlockHashPromise = this.provenBlockNumber === undefined ? finalizedBlockHashPromise : this.getL2BlockHash(this.provenBlockNumber);
+        const [unfinalizedBlockHash, finalizedBlockHash, provenBlockHash] = await Promise.all([
+            unfinalizedBlockHashPromise,
+            finalizedBlockHashPromise,
+            provenBlockHashPromise
+        ]);
         const latestBlockId = {
-            number: Number(status.unfinalisedBlockNumber),
-            hash: unfinalisedBlockHash
+            number: status.unfinalizedBlockNumber,
+            hash: unfinalizedBlockHash
         };
+        // World state doesn't track checkpointed blocks or checkpoints themselves.
+        // but we use a block stream so we need to provide 'local' L2Tips.
+        // We configure the block stream to ignore checkpoints and set checkpoint values to genesis here.
+        const genesisCheckpointHeaderHash = GENESIS_CHECKPOINT_HEADER_HASH.toString();
+        const initialBlockHash = (await this.merkleTreeCommitted.getInitialHeader().hash()).toString();
         return {
-            latest: latestBlockId,
+            proposed: latestBlockId,
+            checkpointed: {
+                block: {
+                    number: BlockNumber.ZERO,
+                    hash: initialBlockHash
+                },
+                checkpoint: {
+                    number: INITIAL_CHECKPOINT_NUMBER,
+                    hash: genesisCheckpointHeaderHash
+                }
+            },
+            proposedCheckpoint: {
+                block: {
+                    number: BlockNumber.ZERO,
+                    hash: initialBlockHash
+                },
+                checkpoint: {
+                    number: INITIAL_CHECKPOINT_NUMBER,
+                    hash: genesisCheckpointHeaderHash
+                }
+            },
             finalized: {
-                number: Number(status.finalisedBlockNumber),
-                hash: ''
+                block: {
+                    number: status.finalizedBlockNumber,
+                    hash: finalizedBlockHash ?? ''
+                },
+                checkpoint: {
+                    number: INITIAL_CHECKPOINT_NUMBER,
+                    hash: genesisCheckpointHeaderHash
+                }
             },
             proven: {
-                number: Number(status.finalisedBlockNumber),
-                hash: ''
+                block: {
+                    number: provenBlockNumber,
+                    hash: provenBlockHash ?? ''
+                },
+                checkpoint: {
+                    number: INITIAL_CHECKPOINT_NUMBER,
+                    hash: genesisCheckpointHeaderHash
+                }
             }
         };
     }
     /** Handles an event emitted by the block stream. */ async handleBlockStreamEvent(event) {
-        try {
-            switch(event.type){
-                case 'blocks-added':
-                    await this.handleL2Blocks(event.blocks);
-                    break;
-                case 'chain-pruned':
-                    await this.handleChainPruned(event.blockNumber);
-                    break;
-                case 'chain-proven':
-                    await this.handleChainProven(event.blockNumber);
-                    break;
-                case 'chain-finalized':
-                    await this.handleChainFinalized(event.blockNumber);
-                    break;
-            }
-        } catch (err) {
-            this.log.error('Error processing block stream', err);
+        switch(event.type){
+            case 'blocks-added':
+                await this.handleL2Blocks(event.blocks);
+                break;
+            case 'chain-pruned':
+                await this.handleChainPruned(event.block.number);
+                break;
+            case 'chain-proven':
+                await this.handleChainProven(event.block.number);
+                break;
+            case 'chain-finalized':
+                await this.handleChainFinalized(event.block.number);
+                break;
         }
     }
     /**
@@ -186,19 +283,23 @@ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js
    * @param l2Blocks - The L2 blocks to handle.
    * @returns Whether the block handled was produced by this same node.
    */ async handleL2Blocks(l2Blocks) {
-        this.log.trace(`Handling L2 blocks ${l2Blocks[0].number} to ${l2Blocks.at(-1).number}`);
-        const messagePromises = l2Blocks.map((block)=>this.l2BlockSource.getL1ToL2Messages(BigInt(block.number)));
-        const l1ToL2Messages = await Promise.all(messagePromises);
+        this.log.debug(`Handling L2 blocks ${l2Blocks[0].number} to ${l2Blocks.at(-1).number}`);
+        // Fetch the L1->L2 messages for the first block in a checkpoint.
+        const messagesForBlocks = new Map();
+        await Promise.all(l2Blocks.filter((b)=>b.indexWithinCheckpoint === 0).map(async (block)=>{
+            const l1ToL2Messages = await this.l2BlockSource.getL1ToL2Messages(block.checkpointNumber);
+            messagesForBlocks.set(block.number, l1ToL2Messages);
+        }));
         let updateStatus = undefined;
-        for(let i = 0; i < l2Blocks.length; i++){
-            const [duration, result] = await elapsed(()=>this.handleL2Block(l2Blocks[i], l1ToL2Messages[i]));
-            this.log.verbose(`World state updated with L2 block ${l2Blocks[i].number}`, {
+        for (const block of l2Blocks){
+            const [duration, result] = await elapsed(()=>this.handleL2Block(block, messagesForBlocks.get(block.number) ?? []));
+            this.log.info(`World state updated with L2 block ${block.number}`, {
                 eventName: 'l2-block-handled',
                 duration,
-                unfinalisedBlockNumber: result.summary.unfinalisedBlockNumber,
-                finalisedBlockNumber: result.summary.finalisedBlockNumber,
-                oldestHistoricBlock: result.summary.oldestHistoricalBlock,
-                ...l2Blocks[i].getStats()
+                unfinalizedBlockNumber: BigInt(result.summary.unfinalizedBlockNumber),
+                finalizedBlockNumber: BigInt(result.summary.finalizedBlockNumber),
+                oldestHistoricBlock: BigInt(result.summary.oldestHistoricalBlock),
+                ...block.getStats()
             });
             updateStatus = result;
         }
@@ -213,16 +314,12 @@ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js
    * @param l1ToL2Messages - The L1 to L2 messages for the block.
    * @returns Whether the block handled was produced by this same node.
    */ async handleL2Block(l2Block, l1ToL2Messages) {
-        // First we check that the L1 to L2 messages hash to the block inHash.
-        // Note that we cannot optimize this check by checking the root of the subtree after inserting the messages
-        // to the real L1_TO_L2_MESSAGE_TREE (like we do in merkleTreeDb.handleL2BlockAndMessages(...)) because that
-        // tree uses pedersen and we don't have access to the converted root.
-        await this.verifyMessagesHashToInHash(l1ToL2Messages, l2Block.header.contentCommitment.inHash);
-        // If the above check succeeds, we can proceed to handle the block.
-        this.log.trace(`Pushing L2 block ${l2Block.number} to merkle tree db `, {
+        this.log.debug(`Pushing L2 block ${l2Block.number} to merkle tree db `, {
             blockNumber: l2Block.number,
             blockHash: await l2Block.hash().then((h)=>h.toString()),
-            l1ToL2Messages: l1ToL2Messages.map((msg)=>msg.toString())
+            l1ToL2Messages: l1ToL2Messages.map((msg)=>msg.toString()),
+            blockHeader: l2Block.header.toInspect(),
+            blockStats: l2Block.getStats()
         });
         const result = await this.merkleTreeDb.handleL2BlockAndMessages(l2Block, l1ToL2Messages);
         if (this.currentState === WorldStateRunningState.SYNCHING && l2Block.number >= this.latestBlockNumberAtStart) {
@@ -233,26 +330,65 @@ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js
     }
     async handleChainFinalized(blockNumber) {
         this.log.verbose(`Finalized chain is now at block ${blockNumber}`);
-        const summary = await this.merkleTreeDb.setFinalised(BigInt(blockNumber));
+        // If the finalized block number is older than the oldest available block in world state,
+        // skip entirely. The finalized block number can jump backwards (e.g. when the finalization
+        // heuristic changes) and try to read block data that has already been pruned. When this
+        // happens, there is nothing useful to do — the native world state is already finalized
+        // past this point and pruning has already happened.
+        const currentSummary = await this.merkleTreeDb.getStatusSummary();
+        if (blockNumber < currentSummary.oldestHistoricalBlock || blockNumber < 1) {
+            this.log.trace(`Finalized block ${blockNumber} is older than the oldest available block ${currentSummary.oldestHistoricalBlock}. Skipping.`);
+            return;
+        }
+        const summary = await this.merkleTreeDb.setFinalized(blockNumber);
         if (this.historyToKeep === undefined) {
             return;
         }
-        const newHistoricBlock = summary.finalisedBlockNumber - BigInt(this.historyToKeep) + 1n;
-        if (newHistoricBlock <= 1) {
+        const finalisedBlockData = await this.l2BlockSource.getBlockData({
+            number: summary.finalizedBlockNumber
+        });
+        if (finalisedBlockData === undefined) {
+            this.log.warn(`Failed to retrieve checkpointed block for finalized block number: ${summary.finalizedBlockNumber}`);
+            return;
+        }
+        // Compute the required historic checkpoint number
+        const newHistoricCheckpointNumber = finalisedBlockData.checkpointNumber - this.historyToKeep + 1;
+        if (newHistoricCheckpointNumber <= 1) {
+            return;
+        }
+        // Retrieve the historic checkpoint
+        const historicCheckpoint = await this.l2BlockSource.getCheckpoint({
+            number: CheckpointNumber(newHistoricCheckpointNumber)
+        });
+        if (!historicCheckpoint) {
+            this.log.warn(`Failed to retrieve checkpoint number ${newHistoricCheckpointNumber} from Archiver`);
+            return;
+        }
+        if (historicCheckpoint.checkpoint.blocks.length === 0 || historicCheckpoint.checkpoint.blocks[0] === undefined) {
+            this.log.warn(`Retrieved checkpoint number ${newHistoricCheckpointNumber} has no blocks!`);
             return;
         }
-        this.log.verbose(`Pruning historic blocks to ${newHistoricBlock}`);
-        const status = await this.merkleTreeDb.removeHistoricalBlocks(newHistoricBlock);
+        // Find the block at the start of the checkpoint and remove blocks up to this one
+        const newHistoricBlock = historicCheckpoint.checkpoint.blocks[0];
+        if (newHistoricBlock.number <= currentSummary.oldestHistoricalBlock) {
+            this.log.debug(`Historic block ${newHistoricBlock.number} is not newer than oldest available ${currentSummary.oldestHistoricalBlock}. Skipping prune.`);
+            return;
+        }
+        this.log.verbose(`Pruning historic blocks to ${newHistoricBlock.number}`);
+        const status = await this.merkleTreeDb.removeHistoricalBlocks(BlockNumber(newHistoricBlock.number));
         this.log.debug(`World state summary `, status.summary);
     }
     handleChainProven(blockNumber) {
+        this.provenBlockNumber = blockNumber;
         this.log.debug(`Proven chain is now at block ${blockNumber}`);
         return Promise.resolve();
     }
     async handleChainPruned(blockNumber) {
-        this.log.warn(`Chain pruned to block ${blockNumber}`);
-        const status = await this.merkleTreeDb.unwindBlocks(BigInt(blockNumber));
-        this.latestBlockHashQuery = undefined;
+        this.log.info(`Chain pruned to block ${blockNumber}`);
+        const status = await this.merkleTreeDb.unwindBlocks(blockNumber);
+        if (this.provenBlockNumber !== undefined && this.provenBlockNumber > blockNumber) {
+            this.provenBlockNumber = undefined;
+        }
         this.instrumentation.updateWorldStateMetrics(status);
     }
     /**
@@ -262,16 +398,4 @@ import { WorldStateInstrumentation } from '../instrumentation/instrumentation.js
         this.currentState = newState;
         this.log.debug(`Moved to state ${WorldStateRunningState[this.currentState]}`);
     }
-    /**
-   * Verifies that the L1 to L2 messages hash to the block inHash.
-   * @param l1ToL2Messages - The L1 to L2 messages for the block.
-   * @param inHash - The inHash of the block.
-   * @throws If the L1 to L2 messages do not hash to the block inHash.
-   */ async verifyMessagesHashToInHash(l1ToL2Messages, inHash) {
-        const treeCalculator = await MerkleTreeCalculator.create(L1_TO_L2_MSG_SUBTREE_HEIGHT, Buffer.alloc(32), (lhs, rhs)=>Promise.resolve(new SHA256Trunc().hash(lhs, rhs)));
-        const root = await treeCalculator.computeTreeRoot(l1ToL2Messages.map((msg)=>msg.toBuffer()));
-        if (!root.equals(inHash)) {
-            throw new Error('Obtained L1 to L2 messages failed to be hashed to the block inHash');
-        }
-    }
 }

package/dest/test/index.d.ts

@@ -1,2 +1,2 @@
 export * from './utils.js';
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy90ZXN0L2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsWUFBWSxDQUFDIn0=

package/dest/test/utils.d.ts

@@ -1,19 +1,26 @@
-import { Fr } from '@aztec/foundation/fields';
+import { BlockNumber, type CheckpointNumber } from '@aztec/foundation/branded-types';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { L2Block } from '@aztec/stdlib/block';
 import type { MerkleTreeReadOperations, MerkleTreeWriteOperations } from '@aztec/stdlib/interfaces/server';
+import { mockCheckpointAndMessages } from '@aztec/stdlib/testing';
 import type { NativeWorldStateService } from '../native/native_world_state.js';
-export declare function mockBlock(blockNum: number, size: number, fork: MerkleTreeWriteOperations): Promise<{
+export declare function updateBlockState(block: L2Block, l1ToL2Messages: Fr[], fork: MerkleTreeWriteOperations): Promise<void>;
+export declare function mockBlock(blockNum: BlockNumber, size: number, fork: MerkleTreeWriteOperations, maxEffects?: number | undefined, numL1ToL2Messages?: number, isFirstBlockInCheckpoint?: boolean): Promise<{
     block: L2Block;
     messages: Fr[];
 }>;
-export declare function mockEmptyBlock(blockNum: number, fork: MerkleTreeWriteOperations): Promise<{
+export declare function mockEmptyBlock(blockNum: BlockNumber, fork: MerkleTreeWriteOperations): Promise<{
     block: L2Block;
     messages: Fr[];
 }>;
-export declare function mockBlocks(from: number, count: number, numTxs: number, worldState: NativeWorldStateService): Promise<{
+export declare function mockBlocks(from: BlockNumber, count: number, numTxs: number, worldState: NativeWorldStateService): Promise<{
     blocks: L2Block[];
     messages: Fr[][];
 }>;
+export declare function mockCheckpoint(checkpointNumber: CheckpointNumber, fork: MerkleTreeWriteOperations, options?: Partial<Parameters<typeof mockCheckpointAndMessages>[1]>): Promise<{
+    checkpoint: import("@aztec/stdlib/checkpoint").Checkpoint;
+    messages: Fr[];
+}>;
 export declare function assertSameState(forkA: MerkleTreeReadOperations, forkB: MerkleTreeReadOperations): Promise<void>;
 export declare function compareChains(left: MerkleTreeReadOperations, right: MerkleTreeReadOperations): Promise<void>;
-//# sourceMappingURL=utils.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy90ZXN0L3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU9BLE9BQU8sRUFBRSxXQUFXLEVBQUUsS0FBSyxnQkFBZ0IsRUFBeUIsTUFBTSxpQ0FBaUMsQ0FBQztBQUU1RyxPQUFPLEVBQUUsRUFBRSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDcEQsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBQzlDLE9BQU8sS0FBSyxFQUVWLHdCQUF3QixFQUN4Qix5QkFBeUIsRUFDMUIsTUFBTSxpQ0FBaUMsQ0FBQztBQUN6QyxPQUFPLEVBQUUseUJBQXlCLEVBQXNCLE1BQU0sdUJBQXVCLENBQUM7QUFJdEYsT0FBTyxLQUFLLEVBQUUsdUJBQXVCLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUUvRSx3QkFBc0IsZ0JBQWdCLENBQUMsS0FBSyxFQUFFLE9BQU8sRUFBRSxjQUFjLEVBQUUsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLHlCQUF5QixpQkE4QzNHO0FBRUQsd0JBQXNCLFNBQVMsQ0FDN0IsUUFBUSxFQUFFLFdBQVcsRUFDckIsSUFBSSxFQUFFLE1BQU0sRUFDWixJQUFJLEVBQUUseUJBQXlCLEVBQy9CLFVBQVUsR0FBRSxNQUFNLEdBQUcsU0FBZ0IsRUFDckMsaUJBQWlCLEdBQUUsTUFBNEMsRUFDL0Qsd0JBQXdCLEdBQUUsT0FBYzs7O0dBZXpDO0FBRUQsd0JBQXNCLGNBQWMsQ0FBQyxRQUFRLEVBQUUsV0FBVyxFQUFFLElBQUksRUFBRSx5QkFBeUI7OztHQVkxRjtBQUVELHdCQUFzQixVQUFVLENBQzlCLElBQUksRUFBRSxXQUFXLEVBQ2pCLEtBQUssRUFBRSxNQUFNLEVBQ2IsTUFBTSxFQUFFLE1BQU0sRUFDZCxVQUFVLEVBQUUsdUJBQXVCOzs7R0FlcEM7QUFFRCx3QkFBc0IsY0FBYyxDQUNsQyxnQkFBZ0IsRUFBRSxnQkFBZ0IsRUFDbEMsSUFBSSxFQUFFLHlCQUF5QixFQUMvQixPQUFPLEdBQUUsT0FBTyxDQUFDLFVBQVUsQ0FBQyxPQUFPLHlCQUF5QixDQUFDLENBQUMsQ0FBQyxDQUFDLENBQU07OztHQU92RTtBQUVELHdCQUFzQixlQUFlLENBQUMsS0FBSyxFQUFFLHdCQUF3QixFQUFFLEtBQUssRUFBRSx3QkFBd0IsaUJBUXJHO0FBRUQsd0JBQXNCLGFBQWEsQ0FBQyxJQUFJLEVBQUUsd0JBQXdCLEVBQUUsS0FBSyxFQUFFLHdCQUF3QixpQkFZbEcifQ==

package/dest/test/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/test/utils.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,KAAK,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAG3G,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAE/E,wBAAsB,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB;;;GA+C9F;AAED,wBAAsB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB;;;GAiDrF;AAED,wBAAsB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,uBAAuB;;;GAchH;AAED,wBAAsB,eAAe,CAAC,KAAK,EAAE,wBAAwB,EAAE,KAAK,EAAE,wBAAwB,iBAQrG;AAED,wBAAsB,aAAa,CAAC,IAAI,EAAE,wBAAwB,EAAE,KAAK,EAAE,wBAAwB,iBAYlG"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/test/utils.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAyB,MAAM,iCAAiC,CAAC;AAE5G,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,KAAK,EAEV,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,yBAAyB,EAAsB,MAAM,uBAAuB,CAAC;AAItF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAE/E,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,yBAAyB,iBA8C3G;AAED,wBAAsB,SAAS,CAC7B,QAAQ,EAAE,WAAW,EACrB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,yBAAyB,EAC/B,UAAU,GAAE,MAAM,GAAG,SAAgB,EACrC,iBAAiB,GAAE,MAA4C,EAC/D,wBAAwB,GAAE,OAAc;;;GAezC;AAED,wBAAsB,cAAc,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,yBAAyB;;;GAY1F;AAED,wBAAsB,UAAU,CAC9B,IAAI,EAAE,WAAW,EACjB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,uBAAuB;;;GAepC;AAED,wBAAsB,cAAc,CAClC,gBAAgB,EAAE,gBAAgB,EAClC,IAAI,EAAE,yBAAyB,EAC/B,OAAO,GAAE,OAAO,CAAC,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAC,CAAC,CAAC,CAAM;;;GAOvE;AAED,wBAAsB,eAAe,CAAC,KAAK,EAAE,wBAAwB,EAAE,KAAK,EAAE,wBAAwB,iBAQrG;AAED,wBAAsB,aAAa,CAAC,IAAI,EAAE,wBAAwB,EAAE,KAAK,EAAE,wBAAwB,iBAYlG"}

package/dest/test/utils.js

@@ -1,73 +1,70 @@
 import { MAX_NOTE_HASHES_PER_TX, MAX_NULLIFIERS_PER_TX, NULLIFIER_SUBTREE_HEIGHT, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP } from '@aztec/constants';
+import { asyncMap } from '@aztec/foundation/async-map';
+import { BlockNumber, IndexWithinCheckpoint } from '@aztec/foundation/branded-types';
 import { padArrayEnd } from '@aztec/foundation/collection';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { L2Block } from '@aztec/stdlib/block';
+import { mockCheckpointAndMessages, mockL1ToL2Messages } from '@aztec/stdlib/testing';
 import { AppendOnlyTreeSnapshot, MerkleTreeId } from '@aztec/stdlib/trees';
-export async function mockBlock(blockNum, size, fork) {
-    const l2Block = await L2Block.random(blockNum, size);
-    const l1ToL2Messages = Array(16).fill(0).map(Fr.random);
-    // Sync the append only trees
-    {
-        const noteHashesPadded = l2Block.body.txEffects.flatMap((txEffect)=>padArrayEnd(txEffect.noteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX));
-        await fork.appendLeaves(MerkleTreeId.NOTE_HASH_TREE, noteHashesPadded);
-        const l1ToL2MessagesPadded = padArrayEnd(l1ToL2Messages, Fr.ZERO, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP);
-        await fork.appendLeaves(MerkleTreeId.L1_TO_L2_MESSAGE_TREE, l1ToL2MessagesPadded);
-    }
-    // Sync the indexed trees
-    {
-        // We insert the public data tree leaves with one batch per tx to avoid updating the same key twice
-        for (const txEffect of l2Block.body.txEffects){
-            await fork.batchInsert(MerkleTreeId.PUBLIC_DATA_TREE, txEffect.publicDataWrites.map((write)=>write.toBuffer()), 0);
-            const nullifiersPadded = padArrayEnd(txEffect.nullifiers, Fr.ZERO, MAX_NULLIFIERS_PER_TX);
-            await fork.batchInsert(MerkleTreeId.NULLIFIER_TREE, nullifiersPadded.map((nullifier)=>nullifier.toBuffer()), NULLIFIER_SUBTREE_HEIGHT);
+import { BlockHeader } from '@aztec/stdlib/tx';
+export async function updateBlockState(block, l1ToL2Messages, fork) {
+    const insertData = async (treeId, data, subTreeHeight, fork)=>{
+        for (const dataBatch of data){
+            await fork.batchInsert(treeId, dataBatch, subTreeHeight);
         }
-    }
+    };
+    const publicDataInsert = insertData(MerkleTreeId.PUBLIC_DATA_TREE, block.body.txEffects.map((txEffect)=>txEffect.publicDataWrites.map((write)=>write.toBuffer())), 0, fork);
+    const nullifierInsert = insertData(MerkleTreeId.NULLIFIER_TREE, block.body.txEffects.map((txEffect)=>padArrayEnd(txEffect.nullifiers, Fr.ZERO, MAX_NULLIFIERS_PER_TX).map((nullifier)=>nullifier.toBuffer())), NULLIFIER_SUBTREE_HEIGHT, fork);
+    const noteHashesPadded = block.body.txEffects.flatMap((txEffect)=>padArrayEnd(txEffect.noteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX));
+    const l1ToL2MessagesPadded = block.indexWithinCheckpoint === 0 ? padArrayEnd(l1ToL2Messages, Fr.ZERO, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP) : l1ToL2Messages;
+    const noteHashInsert = fork.appendLeaves(MerkleTreeId.NOTE_HASH_TREE, noteHashesPadded);
+    const messageInsert = fork.appendLeaves(MerkleTreeId.L1_TO_L2_MESSAGE_TREE, l1ToL2MessagesPadded);
+    await Promise.all([
+        publicDataInsert,
+        nullifierInsert,
+        noteHashInsert,
+        messageInsert
+    ]);
     const state = await fork.getStateReference();
-    l2Block.header.state = state;
-    await fork.updateArchive(l2Block.header);
+    block.header = BlockHeader.from({
+        ...block.header,
+        state
+    });
+    await fork.updateArchive(block.header);
     const archiveState = await fork.getTreeInfo(MerkleTreeId.ARCHIVE);
-    l2Block.archive = new AppendOnlyTreeSnapshot(Fr.fromBuffer(archiveState.root), Number(archiveState.size));
+    block.archive = new AppendOnlyTreeSnapshot(Fr.fromBuffer(archiveState.root), Number(archiveState.size));
+}
+export async function mockBlock(blockNum, size, fork, maxEffects = 1000, numL1ToL2Messages = NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP, isFirstBlockInCheckpoint = true) {
+    const block = await L2Block.random(blockNum, {
+        indexWithinCheckpoint: isFirstBlockInCheckpoint ? IndexWithinCheckpoint(0) : IndexWithinCheckpoint(1),
+        txsPerBlock: size,
+        txOptions: {
+            maxEffects
+        }
+    });
+    const l1ToL2Messages = mockL1ToL2Messages(numL1ToL2Messages);
+    await updateBlockState(block, l1ToL2Messages, fork);
     return {
-        block: l2Block,
+        block,
         messages: l1ToL2Messages
     };
 }
 export async function mockEmptyBlock(blockNum, fork) {
     const l2Block = L2Block.empty();
     const l1ToL2Messages = Array(16).fill(0).map(Fr.zero);
-    l2Block.header.globalVariables.blockNumber = new Fr(blockNum);
-    // Sync the append only trees
-    {
-        const noteHashesPadded = l2Block.body.txEffects.flatMap((txEffect)=>padArrayEnd(txEffect.noteHashes, Fr.ZERO, MAX_NOTE_HASHES_PER_TX));
-        await fork.appendLeaves(MerkleTreeId.NOTE_HASH_TREE, noteHashesPadded);
-        const l1ToL2MessagesPadded = padArrayEnd(l1ToL2Messages, Fr.ZERO, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP);
-        await fork.appendLeaves(MerkleTreeId.L1_TO_L2_MESSAGE_TREE, l1ToL2MessagesPadded);
-    }
-    // Sync the indexed trees
-    {
-        // We insert the public data tree leaves with one batch per tx to avoid updating the same key twice
-        for (const txEffect of l2Block.body.txEffects){
-            await fork.batchInsert(MerkleTreeId.PUBLIC_DATA_TREE, txEffect.publicDataWrites.map((write)=>write.toBuffer()), 0);
-            const nullifiersPadded = padArrayEnd(txEffect.nullifiers, Fr.ZERO, MAX_NULLIFIERS_PER_TX);
-            await fork.batchInsert(MerkleTreeId.NULLIFIER_TREE, nullifiersPadded.map((nullifier)=>nullifier.toBuffer()), NULLIFIER_SUBTREE_HEIGHT);
-        }
-    }
-    const state = await fork.getStateReference();
-    l2Block.header.state = state;
-    await fork.updateArchive(l2Block.header);
-    const archiveState = await fork.getTreeInfo(MerkleTreeId.ARCHIVE);
-    l2Block.archive = new AppendOnlyTreeSnapshot(Fr.fromBuffer(archiveState.root), Number(archiveState.size));
+    l2Block.header.globalVariables.blockNumber = blockNum;
+    await updateBlockState(l2Block, l1ToL2Messages, fork);
     return {
         block: l2Block,
         messages: l1ToL2Messages
     };
 }
 export async function mockBlocks(from, count, numTxs, worldState) {
-    const tempFork = await worldState.fork(from - 1);
+    const tempFork = await worldState.fork(BlockNumber(from - 1));
     const blocks = [];
     const messagesArray = [];
     for(let blockNumber = from; blockNumber < from + count; blockNumber++){
-        const { block, messages } = await mockBlock(blockNumber, numTxs, tempFork);
+        const { block, messages } = await mockBlock(BlockNumber(blockNumber), numTxs, tempFork);
         blocks.push(block);
         messagesArray.push(messages);
     }
@@ -77,6 +74,16 @@ export async function mockBlocks(from, count, numTxs, worldState) {
         messages: messagesArray
     };
 }
+export async function mockCheckpoint(checkpointNumber, fork, options = {}) {
+    const { checkpoint, messages } = await mockCheckpointAndMessages(checkpointNumber, options);
+    await asyncMap(checkpoint.blocks, async (block, i)=>{
+        await updateBlockState(block, i === 0 ? messages : [], fork);
+    });
+    return {
+        checkpoint,
+        messages
+    };
+}
 export async function assertSameState(forkA, forkB) {
     const nativeStateRef = await forkA.getStateReference();
     const nativeArchive = await forkA.getTreeInfo(MerkleTreeId.ARCHIVE);