@aztec/archiver 4.0.0-nightly.20260113 → 4.0.0-nightly.20260114

package/src/archiver/archiver_store_updates.ts

@@ -0,0 +1,321 @@
+import type { BlockNumber, CheckpointNumber } from '@aztec/foundation/branded-types';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { createLogger } from '@aztec/foundation/log';
+import {
+  ContractClassPublishedEvent,
+  PrivateFunctionBroadcastedEvent,
+  UtilityFunctionBroadcastedEvent,
+} from '@aztec/protocol-contracts/class-registry';
+import {
+  ContractInstancePublishedEvent,
+  ContractInstanceUpdatedEvent,
+} from '@aztec/protocol-contracts/instance-registry';
+import type { L2BlockNew, ValidateCheckpointResult } from '@aztec/stdlib/block';
+import type { PublishedCheckpoint } from '@aztec/stdlib/checkpoint';
+import {
+  type ExecutablePrivateFunctionWithMembershipProof,
+  type UtilityFunctionWithMembershipProof,
+  computePublicBytecodeCommitment,
+  isValidPrivateFunctionMembershipProof,
+  isValidUtilityFunctionMembershipProof,
+} from '@aztec/stdlib/contract';
+import type { ContractClassLog, PrivateLog, PublicLog } from '@aztec/stdlib/logs';
+import type { UInt64 } from '@aztec/stdlib/types';
+
+import groupBy from 'lodash.groupby';
+
+import type { KVArchiverDataStore } from './kv_archiver_store/kv_archiver_store.js';
+
+const log = createLogger('archiver:store-updates');
+
+/** Operation type for contract data updates. */
+enum Operation {
+  Store,
+  Delete,
+}
+
+/**
+ * Adds blocks to the store with contract class/instance extraction from logs.
+ * Extracts ContractClassPublished, ContractInstancePublished, ContractInstanceUpdated events,
+ * and individually broadcasted functions from the block logs.
+ *
+ * @param store - The archiver data store.
+ * @param blocks - The L2 blocks to add.
+ * @param pendingChainValidationStatus - Optional validation status to set.
+ * @returns True if the operation is successful.
+ */
+export function addBlocksWithContractData(
+  store: KVArchiverDataStore,
+  blocks: L2BlockNew[],
+  pendingChainValidationStatus?: ValidateCheckpointResult,
+): Promise<boolean> {
+  return store.transactionAsync(async () => {
+    await store.addBlocks(blocks);
+
+    const opResults = await Promise.all([
+      // Update the pending chain validation status if provided
+      pendingChainValidationStatus && store.setPendingChainValidationStatus(pendingChainValidationStatus),
+      // Add any logs emitted during the retrieved blocks
+      store.addLogs(blocks),
+      // Unroll all logs emitted during the retrieved blocks and extract any contract classes and instances from them
+      ...blocks.map(block => addBlockDataToDB(store, block)),
+    ]);
+
+    return opResults.every(Boolean);
+  });
+}
+
+/**
+ * Adds checkpoints to the store with contract class/instance extraction from logs.
+ * Extracts ContractClassPublished, ContractInstancePublished, ContractInstanceUpdated events,
+ * and individually broadcasted functions from the checkpoint block logs.
+ *
+ * @param store - The archiver data store.
+ * @param checkpoints - The published checkpoints to add.
+ * @param pendingChainValidationStatus - Optional validation status to set.
+ * @returns True if the operation is successful.
+ */
+export function addCheckpointsWithContractData(
+  store: KVArchiverDataStore,
+  checkpoints: PublishedCheckpoint[],
+  pendingChainValidationStatus?: ValidateCheckpointResult,
+): Promise<boolean> {
+  return store.transactionAsync(async () => {
+    await store.addCheckpoints(checkpoints);
+    const allBlocks = checkpoints.flatMap((ch: PublishedCheckpoint) => ch.checkpoint.blocks);
+
+    const opResults = await Promise.all([
+      // Update the pending chain validation status if provided
+      pendingChainValidationStatus && store.setPendingChainValidationStatus(pendingChainValidationStatus),
+      // Add any logs emitted during the retrieved blocks
+      store.addLogs(allBlocks),
+      // Unroll all logs emitted during the retrieved blocks and extract any contract classes and instances from them
+      ...allBlocks.map(block => addBlockDataToDB(store, block)),
+    ]);
+
+    return opResults.every(Boolean);
+  });
+}
+
+/**
+ * Unwinds checkpoints from the store with reverse contract extraction.
+ * Deletes ContractClassPublished, ContractInstancePublished, ContractInstanceUpdated data
+ * that was stored for the unwound checkpoints.
+ *
+ * @param store - The archiver data store.
+ * @param from - The checkpoint number to unwind from (must be the current tip).
+ * @param checkpointsToUnwind - The number of checkpoints to unwind.
+ * @returns True if the operation is successful.
+ */
+export async function unwindCheckpointsWithContractData(
+  store: KVArchiverDataStore,
+  from: CheckpointNumber,
+  checkpointsToUnwind: number,
+): Promise<boolean> {
+  if (checkpointsToUnwind <= 0) {
+    throw new Error(`Cannot unwind ${checkpointsToUnwind} blocks`);
+  }
+
+  const last = await store.getSynchedCheckpointNumber();
+  if (from != last) {
+    throw new Error(`Cannot unwind checkpoints from checkpoint ${from} when the last checkpoint is ${last}`);
+  }
+
+  const blocks = [];
+  const lastCheckpointNumber = from + checkpointsToUnwind - 1;
+  for (let checkpointNumber = from; checkpointNumber <= lastCheckpointNumber; checkpointNumber++) {
+    const blocksForCheckpoint = await store.getBlocksForCheckpoint(checkpointNumber);
+    if (!blocksForCheckpoint) {
+      continue;
+    }
+    blocks.push(...blocksForCheckpoint);
+  }
+
+  const opResults = await Promise.all([
+    // Prune rolls back to the last proven block, which is by definition valid
+    store.setPendingChainValidationStatus({ valid: true }),
+    // Unroll all logs emitted during the retrieved blocks and extract any contract classes and instances from them
+    ...blocks.map(async block => {
+      const contractClassLogs = block.body.txEffects.flatMap(txEffect => txEffect.contractClassLogs);
+      // ContractInstancePublished event logs are broadcast in privateLogs.
+      const privateLogs = block.body.txEffects.flatMap(txEffect => txEffect.privateLogs);
+      const publicLogs = block.body.txEffects.flatMap(txEffect => txEffect.publicLogs);
+
+      return (
+        await Promise.all([
+          updatePublishedContractClasses(store, contractClassLogs, block.number, Operation.Delete),
+          updateDeployedContractInstances(store, privateLogs, block.number, Operation.Delete),
+          updateUpdatedContractInstances(store, publicLogs, block.header.globalVariables.timestamp, Operation.Delete),
+        ])
+      ).every(Boolean);
+    }),
+
+    store.deleteLogs(blocks),
+    store.unwindCheckpoints(from, checkpointsToUnwind),
+  ]);
+
+  return opResults.every(Boolean);
+}
+
+/**
+ * Extracts and stores contract data from a single block.
+ */
+async function addBlockDataToDB(store: KVArchiverDataStore, block: L2BlockNew): Promise<boolean> {
+  const contractClassLogs = block.body.txEffects.flatMap(txEffect => txEffect.contractClassLogs);
+  // ContractInstancePublished event logs are broadcast in privateLogs.
+  const privateLogs = block.body.txEffects.flatMap(txEffect => txEffect.privateLogs);
+  const publicLogs = block.body.txEffects.flatMap(txEffect => txEffect.publicLogs);
+
+  return (
+    await Promise.all([
+      updatePublishedContractClasses(store, contractClassLogs, block.number, Operation.Store),
+      updateDeployedContractInstances(store, privateLogs, block.number, Operation.Store),
+      updateUpdatedContractInstances(store, publicLogs, block.header.globalVariables.timestamp, Operation.Store),
+      storeBroadcastedIndividualFunctions(store, contractClassLogs, block.number),
+    ])
+  ).every(Boolean);
+}
+
+/**
+ * Extracts and stores contract classes out of ContractClassPublished events emitted by the class registry contract.
+ */
+async function updatePublishedContractClasses(
+  store: KVArchiverDataStore,
+  allLogs: ContractClassLog[],
+  blockNum: BlockNumber,
+  operation: Operation,
+): Promise<boolean> {
+  const contractClassPublishedEvents = allLogs
+    .filter(log => ContractClassPublishedEvent.isContractClassPublishedEvent(log))
+    .map(log => ContractClassPublishedEvent.fromLog(log));
+
+  const contractClasses = await Promise.all(contractClassPublishedEvents.map(e => e.toContractClassPublic()));
+  if (contractClasses.length > 0) {
+    contractClasses.forEach(c => log.verbose(`${Operation[operation]} contract class ${c.id.toString()}`));
+    if (operation == Operation.Store) {
+      // TODO: Will probably want to create some worker threads to compute these bytecode commitments as they are expensive
+      const commitments = await Promise.all(
+        contractClasses.map(c => computePublicBytecodeCommitment(c.packedBytecode)),
+      );
+      return await store.addContractClasses(contractClasses, commitments, blockNum);
+    } else if (operation == Operation.Delete) {
+      return await store.deleteContractClasses(contractClasses, blockNum);
+    }
+  }
+  return true;
+}
+
+/**
+ * Extracts and stores contract instances out of ContractInstancePublished events emitted by the canonical deployer contract.
+ */
+async function updateDeployedContractInstances(
+  store: KVArchiverDataStore,
+  allLogs: PrivateLog[],
+  blockNum: BlockNumber,
+  operation: Operation,
+): Promise<boolean> {
+  const contractInstances = allLogs
+    .filter(log => ContractInstancePublishedEvent.isContractInstancePublishedEvent(log))
+    .map(log => ContractInstancePublishedEvent.fromLog(log))
+    .map(e => e.toContractInstance());
+  if (contractInstances.length > 0) {
+    contractInstances.forEach(c => log.verbose(`${Operation[operation]} contract instance at ${c.address.toString()}`));
+    if (operation == Operation.Store) {
+      return await store.addContractInstances(contractInstances, blockNum);
+    } else if (operation == Operation.Delete) {
+      return await store.deleteContractInstances(contractInstances, blockNum);
+    }
+  }
+  return true;
+}
+
+/**
+ * Extracts and stores contract instance updates out of ContractInstanceUpdated events.
+ */
+async function updateUpdatedContractInstances(
+  store: KVArchiverDataStore,
+  allLogs: PublicLog[],
+  timestamp: UInt64,
+  operation: Operation,
+): Promise<boolean> {
+  const contractUpdates = allLogs
+    .filter(log => ContractInstanceUpdatedEvent.isContractInstanceUpdatedEvent(log))
+    .map(log => ContractInstanceUpdatedEvent.fromLog(log))
+    .map(e => e.toContractInstanceUpdate());
+
+  if (contractUpdates.length > 0) {
+    contractUpdates.forEach(c =>
+      log.verbose(`${Operation[operation]} contract instance update at ${c.address.toString()}`),
+    );
+    if (operation == Operation.Store) {
+      return await store.addContractInstanceUpdates(contractUpdates, timestamp);
+    } else if (operation == Operation.Delete) {
+      return await store.deleteContractInstanceUpdates(contractUpdates, timestamp);
+    }
+  }
+  return true;
+}
+
+/**
+ * Stores the functions that were broadcasted individually.
+ *
+ * @dev Beware that there is not a delete variant of this, since they are added to contract classes
+ *      and will be deleted as part of the class if needed.
+ */
+async function storeBroadcastedIndividualFunctions(
+  store: KVArchiverDataStore,
+  allLogs: ContractClassLog[],
+  _blockNum: BlockNumber,
+): Promise<boolean> {
+  // Filter out private and utility function broadcast events
+  const privateFnEvents = allLogs
+    .filter(log => PrivateFunctionBroadcastedEvent.isPrivateFunctionBroadcastedEvent(log))
+    .map(log => PrivateFunctionBroadcastedEvent.fromLog(log));
+  const utilityFnEvents = allLogs
+    .filter(log => UtilityFunctionBroadcastedEvent.isUtilityFunctionBroadcastedEvent(log))
+    .map(log => UtilityFunctionBroadcastedEvent.fromLog(log));
+
+  // Group all events by contract class id
+  for (const [classIdString, classEvents] of Object.entries(
+    groupBy([...privateFnEvents, ...utilityFnEvents], e => e.contractClassId.toString()),
+  )) {
+    const contractClassId = Fr.fromHexString(classIdString);
+    const contractClass = await store.getContractClass(contractClassId);
+    if (!contractClass) {
+      log.warn(`Skipping broadcasted functions as contract class ${contractClassId.toString()} was not found`);
+      continue;
+    }
+
+    // Split private and utility functions, and filter out invalid ones
+    const allFns = classEvents.map(e => e.toFunctionWithMembershipProof());
+    const privateFns = allFns.filter(
+      (fn): fn is ExecutablePrivateFunctionWithMembershipProof => 'utilityFunctionsTreeRoot' in fn,
+    );
+    const utilityFns = allFns.filter(
+      (fn): fn is UtilityFunctionWithMembershipProof => 'privateFunctionsArtifactTreeRoot' in fn,
+    );
+
+    const privateFunctionsWithValidity = await Promise.all(
+      privateFns.map(async fn => ({ fn, valid: await isValidPrivateFunctionMembershipProof(fn, contractClass) })),
+    );
+    const validPrivateFns = privateFunctionsWithValidity.filter(({ valid }) => valid).map(({ fn }) => fn);
+    const utilityFunctionsWithValidity = await Promise.all(
+      utilityFns.map(async fn => ({
+        fn,
+        valid: await isValidUtilityFunctionMembershipProof(fn, contractClass),
+      })),
+    );
+    const validUtilityFns = utilityFunctionsWithValidity.filter(({ valid }) => valid).map(({ fn }) => fn);
+    const validFnCount = validPrivateFns.length + validUtilityFns.length;
+    if (validFnCount !== allFns.length) {
+      log.warn(`Skipping ${allFns.length - validFnCount} invalid functions`);
+    }
+
+    // Store the functions in the contract class in a single operation
+    if (validFnCount > 0) {
+      log.verbose(`Storing ${validFnCount} functions for contract class ${contractClassId.toString()}`);
+    }
+    return await store.addFunctions(contractClassId, validPrivateFns, validUtilityFns);
+  }
+  return true;
+}

package/src/archiver/index.ts

@@ -1,6 +1,7 @@
 export * from './archiver.js';
+export * from './archive_source_base.js';
+export * from './archiver_store_updates.js';
 export * from './config.js';
 export { type L1PublishedData } from './structs/published.js';
-export type { ArchiverDataStore } from './archiver_store.js';
 export { KVArchiverDataStore, ARCHIVER_DB_VERSION } from './kv_archiver_store/kv_archiver_store.js';
 export { ContractInstanceStore } from './kv_archiver_store/contract_instance_store.js';

package/src/archiver/kv_archiver_store/block_store.ts

@@ -76,7 +76,7 @@ export type CheckpointData = {
 };
 
 /**
- * LMDB implementation of the ArchiverDataStore interface.
+ * LMDB-based block storage for the archiver.
  */
 export class BlockStore {
   /** Map block number to block data */

package/src/archiver/kv_archiver_store/contract_class_store.ts

@@ -12,7 +12,7 @@ import type {
 import { Vector } from '@aztec/stdlib/types';
 
 /**
- * LMDB implementation of the ArchiverDataStore interface.
+ * LMDB-based contract class storage for the archiver.
  */
 export class ContractClassStore {
   #contractClasses: AztecAsyncMap<string, Buffer>;

package/src/archiver/kv_archiver_store/contract_instance_store.ts

@@ -12,7 +12,7 @@ import type { UInt64 } from '@aztec/stdlib/types';
 type ContractInstanceUpdateKey = [string, string] | [string, string, number];
 
 /**
- * LMDB implementation of the ArchiverDataStore interface.
+ * LMDB-based contract instance storage for the archiver.
  */
 export class ContractInstanceStore {
   #contractInstances: AztecAsyncMap<string, Buffer>;