@aztec/archiver 0.23.0 → 0.26.1

package/src/archiver/kv_archiver_store/block_body_store.ts

@@ -0,0 +1,54 @@
+import { Body } from '@aztec/circuit-types';
+import { AztecKVStore, AztecMap } from '@aztec/kv-store';
+
+export class BlockBodyStore {
+  /** Map block body hash to block body */
+  #blockBodies: AztecMap<string, Buffer>;
+
+  constructor(private db: AztecKVStore) {
+    this.#blockBodies = db.openMap('archiver_block_bodies');
+  }
+
+  /**
+   * Append new block bodies to the store's map.
+   * @param blockBodies - The L2 block bodies to be added to the store.
+   * @returns True if the operation is successful.
+   */
+  addBlockBodies(blockBodies: Body[]): Promise<boolean> {
+    return this.db.transaction(() => {
+      for (const body of blockBodies) {
+        void this.#blockBodies.set(body.getCalldataHash().toString('hex'), body.toBuffer());
+      }
+
+      return true;
+    });
+  }
+
+  /**
+   * Gets a list of L2 block bodies with its associated txsHashes
+   * @param txsHashes - The txsHashes list that corresponds to the blockBodies we want to retrieve
+   * @returns The requested L2 block bodies
+   */
+  async getBlockBodies(txsHashes: Buffer[]): Promise<Body[]> {
+    const blockBodiesBuffer = await this.db.transaction(() =>
+      txsHashes.map(txsHash => this.#blockBodies.get(txsHash.toString('hex'))),
+    );
+
+    if (blockBodiesBuffer.some(bodyBuffer => bodyBuffer === undefined)) {
+      throw new Error('Block body buffer is undefined');
+    }
+
+    return blockBodiesBuffer.map(blockBodyBuffer => Body.fromBuffer(blockBodyBuffer!));
+  }
+
+  /**
+   * Gets an L2 block body.
+   * @param txsHash - The txHash of the the block body to return
+   * @returns The requested L2 block body
+   */
+  getBlockBody(txsHash: Buffer): Body | undefined {
+    const blockBody = this.#blockBodies.get(txsHash.toString('hex'));
+
+    return blockBody && Body.fromBuffer(blockBody);
+  }
+}

package/src/archiver/kv_archiver_store/block_store.ts

@@ -0,0 +1,199 @@
+import { L2Block, TxEffect, TxHash, TxReceipt, TxStatus } from '@aztec/circuit-types';
+import { AppendOnlyTreeSnapshot, AztecAddress, Header, INITIAL_L2_BLOCK_NUM } from '@aztec/circuits.js';
+import { createDebugLogger } from '@aztec/foundation/log';
+import { AztecKVStore, AztecMap, Range } from '@aztec/kv-store';
+
+import { BlockBodyStore } from './block_body_store.js';
+
+type BlockIndexValue = [blockNumber: number, index: number];
+
+type BlockStorage = {
+  l1BlockNumber: bigint;
+  header: Buffer;
+  archive: Buffer;
+};
+
+/**
+ * LMDB implementation of the ArchiverDataStore interface.
+ */
+export class BlockStore {
+  /** Map block number to block data */
+  #blocks: AztecMap<number, BlockStorage>;
+
+  /** Index mapping transaction hash (as a string) to its location in a block */
+  #txIndex: AztecMap<string, BlockIndexValue>;
+
+  /** Index mapping a contract's address (as a string) to its location in a block */
+  #contractIndex: AztecMap<string, BlockIndexValue>;
+
+  #log = createDebugLogger('aztec:archiver:block_store');
+
+  #blockBodyStore: BlockBodyStore;
+
+  constructor(private db: AztecKVStore, blockBodyStore: BlockBodyStore) {
+    this.#blockBodyStore = blockBodyStore;
+
+    this.#blocks = db.openMap('archiver_blocks');
+    this.#txIndex = db.openMap('archiver_tx_index');
+    this.#contractIndex = db.openMap('archiver_contract_index');
+  }
+
+  /**
+   * Append new blocks to the store's list.
+   * @param blocks - The L2 blocks to be added to the store.
+   * @returns True if the operation is successful.
+   */
+  addBlocks(blocks: L2Block[]): Promise<boolean> {
+    return this.db.transaction(() => {
+      for (const block of blocks) {
+        void this.#blocks.set(block.number, {
+          header: block.header.toBuffer(),
+          archive: block.archive.toBuffer(),
+          l1BlockNumber: block.getL1BlockNumber(),
+        });
+
+        block.getTxs().forEach((tx, i) => {
+          void this.#txIndex.set(tx.txHash.toString(), [block.number, i]);
+        });
+
+        block.body.txEffects
+          .flatMap(txEffect => txEffect.contractData)
+          .forEach((contractData, i) => {
+            if (contractData.contractAddress.isZero()) {
+              return;
+            }
+
+            void this.#contractIndex.set(contractData.contractAddress.toString(), [block.number, i]);
+          });
+      }
+
+      return true;
+    });
+  }
+
+  /**
+   * Gets up to `limit` amount of L2 blocks starting from `from`.
+   * @param start - Number of the first block to return (inclusive).
+   * @param limit - The number of blocks to return.
+   * @returns The requested L2 blocks
+   */
+  *getBlocks(start: number, limit: number): IterableIterator<L2Block> {
+    for (const blockStorage of this.#blocks.values(this.#computeBlockRange(start, limit))) {
+      yield this.getBlockFromBlockStorage(blockStorage);
+    }
+  }
+
+  /**
+   * Gets an L2 block.
+   * @param blockNumber - The number of the block to return.
+   * @returns The requested L2 block.
+   */
+  getBlock(blockNumber: number): L2Block | undefined {
+    const blockStorage = this.#blocks.get(blockNumber);
+    if (!blockStorage || !blockStorage.header) {
+      return undefined;
+    }
+
+    return this.getBlockFromBlockStorage(blockStorage);
+  }
+
+  private getBlockFromBlockStorage(blockStorage: BlockStorage) {
+    const header = Header.fromBuffer(blockStorage.header);
+    const archive = AppendOnlyTreeSnapshot.fromBuffer(blockStorage.archive);
+    const body = this.#blockBodyStore.getBlockBody(header.contentCommitment.txsHash);
+
+    if (body === undefined) {
+      throw new Error('Body is not able to be retrieved from BodyStore');
+    }
+
+    return L2Block.fromFields({
+      header,
+      archive,
+      body,
+    });
+  }
+
+  /**
+   * Gets a tx effect.
+   * @param txHash - The txHash of the tx corresponding to the tx effect.
+   * @returns The requested tx effect (or undefined if not found).
+   */
+  getTxEffect(txHash: TxHash): TxEffect | undefined {
+    const [blockNumber, txIndex] = this.getTxLocation(txHash) ?? [];
+    if (typeof blockNumber !== 'number' || typeof txIndex !== 'number') {
+      return undefined;
+    }
+
+    const block = this.getBlock(blockNumber);
+    return block?.getTx(txIndex);
+  }
+
+  /**
+   * Gets a receipt of a settled tx.
+   * @param txHash - The hash of a tx we try to get the receipt for.
+   * @returns The requested tx receipt (or undefined if not found).
+   */
+  getSettledTxReceipt(txHash: TxHash): TxReceipt | undefined {
+    const [blockNumber, txIndex] = this.getTxLocation(txHash) ?? [];
+    if (typeof blockNumber !== 'number' || typeof txIndex !== 'number') {
+      return undefined;
+    }
+
+    const block = this.getBlock(blockNumber)!;
+    return new TxReceipt(txHash, TxStatus.MINED, '', block.hash().toBuffer(), block.number);
+  }
+
+  /**
+   * Looks up which block included the requested tx effect.
+   * @param txHash - The txHash of the tx.
+   * @returns The block number and index of the tx.
+   */
+  getTxLocation(txHash: TxHash): [blockNumber: number, txIndex: number] | undefined {
+    return this.#txIndex.get(txHash.toString());
+  }
+
+  /**
+   * Looks up which block deployed a particular contract.
+   * @param contractAddress - The address of the contract to look up.
+   * @returns The block number and index of the contract.
+   */
+  getContractLocation(contractAddress: AztecAddress): [blockNumber: number, index: number] | undefined {
+    return this.#contractIndex.get(contractAddress.toString());
+  }
+
+  /**
+   * Gets the number of the latest L2 block processed.
+   * @returns The number of the latest L2 block processed.
+   */
+  getBlockNumber(): number {
+    const [lastBlockNumber] = this.#blocks.keys({ reverse: true, limit: 1 });
+    return typeof lastBlockNumber === 'number' ? lastBlockNumber : INITIAL_L2_BLOCK_NUM - 1;
+  }
+
+  /**
+   * Gets the most recent L1 block processed.
+   * @returns The L1 block that published the latest L2 block
+   */
+  getL1BlockNumber(): bigint {
+    const [lastBlock] = this.#blocks.values({ reverse: true, limit: 1 });
+    if (!lastBlock) {
+      return 0n;
+    } else {
+      return lastBlock.l1BlockNumber;
+    }
+  }
+
+  #computeBlockRange(start: number, limit: number): Required<Pick<Range<number>, 'start' | 'end'>> {
+    if (limit < 1) {
+      throw new Error(`Invalid limit: ${limit}`);
+    }
+
+    if (start < INITIAL_L2_BLOCK_NUM) {
+      this.#log(`Clamping start block ${start} to ${INITIAL_L2_BLOCK_NUM}`);
+      start = INITIAL_L2_BLOCK_NUM;
+    }
+
+    const end = start + limit;
+    return { start, end };
+  }
+}

package/src/archiver/kv_archiver_store/contract_class_store.ts

@@ -0,0 +1,68 @@
+import { Fr, FunctionSelector } from '@aztec/circuits.js';
+import { BufferReader, numToUInt8, serializeToBuffer } from '@aztec/foundation/serialize';
+import { AztecKVStore, AztecMap } from '@aztec/kv-store';
+import { ContractClassPublic } from '@aztec/types/contracts';
+
+/**
+ * LMDB implementation of the ArchiverDataStore interface.
+ */
+export class ContractClassStore {
+  #contractClasses: AztecMap<string, Buffer>;
+
+  constructor(db: AztecKVStore) {
+    this.#contractClasses = db.openMap('archiver_contract_classes');
+  }
+
+  addContractClass(contractClass: ContractClassPublic): Promise<boolean> {
+    return this.#contractClasses.set(contractClass.id.toString(), serializeContractClassPublic(contractClass));
+  }
+
+  getContractClass(id: Fr): ContractClassPublic | undefined {
+    const contractClass = this.#contractClasses.get(id.toString());
+    return contractClass && { ...deserializeContractClassPublic(contractClass), id };
+  }
+
+  getContractClassIds(): Fr[] {
+    return Array.from(this.#contractClasses.keys()).map(key => Fr.fromString(key));
+  }
+}
+
+export function serializeContractClassPublic(contractClass: ContractClassPublic): Buffer {
+  return serializeToBuffer(
+    numToUInt8(contractClass.version),
+    contractClass.artifactHash,
+    contractClass.privateFunctions?.length ?? 0,
+    contractClass.privateFunctions?.map(f => serializeToBuffer(f.selector, f.vkHash, f.isInternal)) ?? [],
+    contractClass.publicFunctions.length,
+    contractClass.publicFunctions?.map(f =>
+      serializeToBuffer(f.selector, f.bytecode.length, f.bytecode, f.isInternal),
+    ) ?? [],
+    contractClass.packedBytecode.length,
+    contractClass.packedBytecode,
+    contractClass.privateFunctionsRoot,
+  );
+}
+
+export function deserializeContractClassPublic(buffer: Buffer): Omit<ContractClassPublic, 'id'> {
+  const reader = BufferReader.asReader(buffer);
+  return {
+    version: reader.readUInt8() as 1,
+    artifactHash: reader.readObject(Fr),
+    privateFunctions: reader.readVector({
+      fromBuffer: reader => ({
+        selector: reader.readObject(FunctionSelector),
+        vkHash: reader.readObject(Fr),
+        isInternal: reader.readBoolean(),
+      }),
+    }),
+    publicFunctions: reader.readVector({
+      fromBuffer: reader => ({
+        selector: reader.readObject(FunctionSelector),
+        bytecode: reader.readBuffer(),
+        isInternal: reader.readBoolean(),
+      }),
+    }),
+    packedBytecode: reader.readBuffer(),
+    privateFunctionsRoot: reader.readObject(Fr),
+  };
+}

package/src/archiver/kv_archiver_store/contract_instance_store.ts

@@ -0,0 +1,26 @@
+import { AztecAddress } from '@aztec/circuits.js';
+import { AztecKVStore, AztecMap } from '@aztec/kv-store';
+import { ContractInstanceWithAddress, SerializableContractInstance } from '@aztec/types/contracts';
+
+/**
+ * LMDB implementation of the ArchiverDataStore interface.
+ */
+export class ContractInstanceStore {
+  #contractInstances: AztecMap<string, Buffer>;
+
+  constructor(db: AztecKVStore) {
+    this.#contractInstances = db.openMap('archiver_contract_instances');
+  }
+
+  addContractInstance(contractInstance: ContractInstanceWithAddress): Promise<boolean> {
+    return this.#contractInstances.set(
+      contractInstance.address.toString(),
+      new SerializableContractInstance(contractInstance).toBuffer(),
+    );
+  }
+
+  getContractInstance(address: AztecAddress): ContractInstanceWithAddress | undefined {
+    const contractInstance = this.#contractInstances.get(address.toString());
+    return contractInstance && SerializableContractInstance.fromBuffer(contractInstance).withAddress(address);
+  }
+}

package/src/archiver/kv_archiver_store/contract_store.ts

@@ -0,0 +1,98 @@
+import { ContractData, ExtendedContractData } from '@aztec/circuit-types';
+import { AztecAddress } from '@aztec/foundation/aztec-address';
+import { createDebugLogger } from '@aztec/foundation/log';
+import { AztecKVStore, AztecMap } from '@aztec/kv-store';
+
+import { BlockStore } from './block_store.js';
+
+/**
+ * LMDB implementation of the ArchiverDataStore interface.
+ */
+export class ContractStore {
+  #blockStore: BlockStore;
+  #extendedContractData: AztecMap<number, Buffer[]>;
+  #log = createDebugLogger('aztec:archiver:contract_store');
+
+  constructor(private db: AztecKVStore, blockStore: BlockStore) {
+    this.#extendedContractData = db.openMap('archiver_extended_contract_data');
+    this.#blockStore = blockStore;
+  }
+
+  /**
+   * Add new extended contract data from an L2 block to the store's list.
+   * @param data - List of contracts' data to be added.
+   * @param blockNum - Number of the L2 block the contract data was deployed in.
+   * @returns True if the operation is successful.
+   */
+  addExtendedContractData(data: ExtendedContractData[], blockNum: number): Promise<boolean> {
+    return this.#extendedContractData.swap(blockNum, (existingData = []) => {
+      existingData.push(...data.map(d => d.toBuffer()));
+      return existingData;
+    });
+  }
+
+  /**
+   * Get the extended contract data for this contract.
+   * @param contractAddress - The contract data address.
+   * @returns The extended contract data or undefined if not found.
+   */
+  getExtendedContractData(contractAddress: AztecAddress): ExtendedContractData | undefined {
+    const [blockNumber, _] = this.#blockStore.getContractLocation(contractAddress) ?? [];
+
+    if (typeof blockNumber !== 'number') {
+      return undefined;
+    }
+
+    for (const contract of this.#extendedContractData.get(blockNumber) ?? []) {
+      const extendedContractData = ExtendedContractData.fromBuffer(contract);
+      if (extendedContractData.contractData.contractAddress.equals(contractAddress)) {
+        return extendedContractData;
+      }
+    }
+
+    return undefined;
+  }
+
+  /**
+   * Lookup all extended contract data in an L2 block.
+   * @param blockNumber - The block number to get all contract data from.
+   * @returns All extended contract data in the block (if found).
+   */
+  getExtendedContractDataInBlock(blockNumber: number): Array<ExtendedContractData> {
+    return (this.#extendedContractData.get(blockNumber) ?? []).map(contract =>
+      ExtendedContractData.fromBuffer(contract),
+    );
+  }
+
+  /**
+   * Get basic info for an L2 contract.
+   * Contains contract address & the ethereum portal address.
+   * @param contractAddress - The contract data address.
+   * @returns ContractData with the portal address (if we didn't throw an error).
+   */
+  getContractData(contractAddress: AztecAddress): ContractData | undefined {
+    const [blockNumber, index] = this.#blockStore.getContractLocation(contractAddress) ?? [];
+    if (typeof blockNumber !== 'number' || typeof index !== 'number') {
+      return undefined;
+    }
+
+    const block = this.#blockStore.getBlock(blockNumber);
+
+    if (block?.body.txEffects[index].contractData.length !== 1) {
+      throw new Error(`Contract data at block: ${blockNumber}, tx: ${index} does not have length of 1`);
+    }
+
+    return block?.body.txEffects[index].contractData[0];
+  }
+
+  /**
+   * Get basic info for an all L2 contracts deployed in a block.
+   * Contains contract address & the ethereum portal address.
+   * @param blockNumber - Number of the L2 block where contracts were deployed.
+   * @returns ContractData with the portal address (if we didn't throw an error).
+   */
+  getContractDataInBlock(blockNumber: number): ContractData[] {
+    const block = this.#blockStore.getBlock(blockNumber);
+    return block?.body.txEffects.flatMap(txEffect => txEffect.contractData) ?? [];
+  }
+}