@aztec/pxe 0.0.1-commit.d3ec352c → 0.0.1-commit.d58ff9d0

package/src/storage/tagging_data_provider/tagging_data_provider.ts

@@ -1,120 +0,0 @@
-import { toArray } from '@aztec/foundation/iterable';
-import type { AztecAsyncKVStore, AztecAsyncMap } from '@aztec/kv-store';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { DirectionalAppTaggingSecret, PreTag } from '@aztec/stdlib/logs';
-
-export class TaggingDataProvider {
-  #store: AztecAsyncKVStore;
-  #addressBook: AztecAsyncMap<string, true>;
-
-  // Stores the last used index for each directional app tagging secret. Taking into account whether we are
-  // requesting the index as a sender or as a recipient because the sender and recipient can be in the same PXE.
-  #lastUsedIndexesAsSenders: AztecAsyncMap<string, number>;
-  #lastUsedIndexesAsRecipients: AztecAsyncMap<string, number>;
-
-  constructor(store: AztecAsyncKVStore) {
-    this.#store = store;
-
-    this.#addressBook = this.#store.openMap('address_book');
-
-    this.#lastUsedIndexesAsSenders = this.#store.openMap('last_used_indexes_as_senders');
-    this.#lastUsedIndexesAsRecipients = this.#store.openMap('last_used_indexes_as_recipients');
-  }
-
-  /**
-   * Sets the last used indexes when sending a log.
-   * @param preTags - The pre tags containing the directional app tagging secrets and the indexes that are to be
-   * updated in the db.
-   * @throws If any two pre tags contain the same directional app tagging secret
-   */
-  setLastUsedIndexesAsSender(preTags: PreTag[]) {
-    this.#assertUniqueSecrets(preTags, 'sender');
-
-    return Promise.all(
-      preTags.map(({ secret, index }) => this.#lastUsedIndexesAsSenders.set(secret.toString(), index)),
-    );
-  }
-
-  /**
-   * Sets the last used indexes when looking for logs.
-   * @param preTags - The pre tags containing the directional app tagging secrets and the indexes that are to be
-   * updated in the db.
-   * @throws If any two pre tags contain the same directional app tagging secret
-   */
-  setLastUsedIndexesAsRecipient(preTags: PreTag[]) {
-    this.#assertUniqueSecrets(preTags, 'recipient');
-
-    return Promise.all(
-      preTags.map(({ secret, index }) => this.#lastUsedIndexesAsRecipients.set(secret.toString(), index)),
-    );
-  }
-
-  // It should never happen that we would receive any two pre tags on the input containing the same directional app
-  // tagging secret as everywhere we always just apply the largest index. Hence this check is a good way to catch
-  // bugs.
-  #assertUniqueSecrets(preTags: PreTag[], role: 'sender' | 'recipient'): void {
-    const secretStrings = preTags.map(({ secret }) => secret.toString());
-    const uniqueSecrets = new Set(secretStrings);
-    if (uniqueSecrets.size !== secretStrings.length) {
-      throw new Error(`Duplicate secrets found when setting last used indexes as ${role}`);
-    }
-  }
-
-  /**
-   * Returns the last used index when sending a log with a given secret.
-   * @param secret - The directional app tagging secret.
-   * @returns The last used index for the given directional app tagging secret, or undefined if not found.
-   */
-  async getLastUsedIndexesAsSender(secret: DirectionalAppTaggingSecret): Promise<number | undefined> {
-    return await this.#lastUsedIndexesAsSenders.getAsync(secret.toString());
-  }
-
-  /**
-   * Returns the last used indexes when looking for logs as a recipient.
-   * @param secrets - The directional app tagging secrets to obtain the indexes for.
-   * @returns The last used indexes for the given directional app tagging secrets, or undefined if have never yet found
-   * a log for a given secret.
-   */
-  getLastUsedIndexesAsRecipient(secrets: DirectionalAppTaggingSecret[]): Promise<(number | undefined)[]> {
-    return Promise.all(secrets.map(secret => this.#lastUsedIndexesAsRecipients.getAsync(secret.toString())));
-  }
-
-  resetNoteSyncData(): Promise<void> {
-    return this.#store.transactionAsync(async () => {
-      const keysForSenders = await toArray(this.#lastUsedIndexesAsSenders.keysAsync());
-      await Promise.all(keysForSenders.map(secret => this.#lastUsedIndexesAsSenders.delete(secret)));
-      const keysForRecipients = await toArray(this.#lastUsedIndexesAsRecipients.keysAsync());
-      await Promise.all(keysForRecipients.map(secret => this.#lastUsedIndexesAsRecipients.delete(secret)));
-    });
-  }
-
-  async addSenderAddress(address: AztecAddress): Promise<boolean> {
-    if (await this.#addressBook.hasAsync(address.toString())) {
-      return false;
-    }
-
-    await this.#addressBook.set(address.toString(), true);
-
-    return true;
-  }
-
-  async getSenderAddresses(): Promise<AztecAddress[]> {
-    return (await toArray(this.#addressBook.keysAsync())).map(AztecAddress.fromString);
-  }
-
-  async removeSenderAddress(address: AztecAddress): Promise<boolean> {
-    if (!(await this.#addressBook.hasAsync(address.toString()))) {
-      return false;
-    }
-
-    await this.#addressBook.delete(address.toString());
-
-    return true;
-  }
-
-  async getSize() {
-    const addressesCount = (await toArray(this.#addressBook.keysAsync())).length;
-    // All keys are addresses
-    return 3 * addressesCount * AztecAddress.SIZE_IN_BYTES;
-  }
-}

package/src/synchronizer/index.ts

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

package/src/synchronizer/synchronizer.ts

@@ -1,121 +0,0 @@
-import { BlockNumber } from '@aztec/foundation/branded-types';
-import { type Logger, createLogger } from '@aztec/foundation/log';
-import type { L2TipsKVStore } from '@aztec/kv-store/stores';
-import { L2BlockStream, type L2BlockStreamEvent, type L2BlockStreamEventHandler } from '@aztec/stdlib/block';
-import type { AztecNode } from '@aztec/stdlib/interfaces/client';
-
-import type { PXEConfig } from '../config/index.js';
-import type { NoteDataProvider } from '../storage/note_data_provider/note_data_provider.js';
-import type { SyncDataProvider } from '../storage/sync_data_provider/sync_data_provider.js';
-import type { TaggingDataProvider } from '../storage/tagging_data_provider/tagging_data_provider.js';
-
-/**
- * The Synchronizer class orchestrates synchronization between the PXE and Aztec node, maintaining an up-to-date
- * view of the L2 chain state. It handles block header retrieval, chain reorganizations, and provides an interface
- * for querying sync status.
- */
-export class Synchronizer implements L2BlockStreamEventHandler {
-  private log: Logger;
-  private isSyncing: Promise<void> | undefined;
-  protected readonly blockStream: L2BlockStream;
-
-  constructor(
-    private node: AztecNode,
-    private syncDataProvider: SyncDataProvider,
-    private noteDataProvider: NoteDataProvider,
-    private taggingDataProvider: TaggingDataProvider,
-    private l2TipsStore: L2TipsKVStore,
-    config: Partial<Pick<PXEConfig, 'l2BlockBatchSize'>> = {},
-    loggerOrSuffix?: string | Logger,
-  ) {
-    this.log =
-      !loggerOrSuffix || typeof loggerOrSuffix === 'string'
-        ? createLogger(loggerOrSuffix ? `pxe:synchronizer:${loggerOrSuffix}` : `pxe:synchronizer`)
-        : loggerOrSuffix;
-    this.blockStream = this.createBlockStream(config);
-  }
-
-  protected createBlockStream(config: Partial<Pick<PXEConfig, 'l2BlockBatchSize'>>) {
-    return new L2BlockStream(this.node, this.l2TipsStore, this, createLogger('pxe:block_stream'), {
-      batchSize: config.l2BlockBatchSize,
-      // Skipping finalized blocks makes us sync much faster - we only need to download blocks other than the latest one
-      // in order to detect reorgs, and there can be no reorgs on finalized block, making this safe.
-      skipFinalized: true,
-    });
-  }
-
-  /** Handle events emitted by the block stream. */
-  public async handleBlockStreamEvent(event: L2BlockStreamEvent): Promise<void> {
-    await this.l2TipsStore.handleBlockStreamEvent(event);
-
-    switch (event.type) {
-      case 'blocks-added': {
-        const lastBlock = event.blocks.at(-1)!.block;
-        this.log.verbose(`Updated pxe last block to ${lastBlock.number}`, {
-          blockHash: lastBlock.hash(),
-          archive: lastBlock.archive.root.toString(),
-          header: lastBlock.header.toInspect(),
-        });
-        await this.syncDataProvider.setHeader(lastBlock.getBlockHeader());
-        break;
-      }
-      case 'chain-pruned': {
-        this.log.warn(`Pruning data after block ${event.block.number} due to reorg`);
-        // We first unnullify and then remove so that unnullified notes that were created after the block number end up deleted.
-        const lastSynchedBlockNumber = await this.syncDataProvider.getBlockNumber();
-        await this.noteDataProvider.rollbackNotesAndNullifiers(event.block.number, lastSynchedBlockNumber);
-        // Remove all note tagging indexes to force a full resync. This is suboptimal, but unless we track the
-        // block number in which each index is used it's all we can do.
-        await this.taggingDataProvider.resetNoteSyncData();
-        // Update the header to the last block.
-        const newHeader = await this.node.getBlockHeader(event.block.number);
-        if (!newHeader) {
-          this.log.error(`Block header not found for block number ${event.block.number} during chain prune`);
-        } else {
-          await this.syncDataProvider.setHeader(newHeader);
-        }
-        break;
-      }
-    }
-  }
-
-  /**
-   * Syncs PXE and the node by downloading the metadata of the latest blocks, allowing simulations to use
-   * recent data (e.g. notes), and handling any reorgs that might have occurred.
-   */
-  public async sync() {
-    if (this.isSyncing !== undefined) {
-      this.log.debug(`Waiting for the ongoing sync to finish`);
-      await this.isSyncing;
-      return;
-    }
-
-    this.log.debug(`Syncing PXE with the node`);
-    const isSyncing = this.doSync();
-    this.isSyncing = isSyncing;
-    try {
-      await isSyncing;
-    } finally {
-      this.isSyncing = undefined;
-    }
-  }
-
-  private async doSync() {
-    let currentHeader;
-
-    try {
-      currentHeader = await this.syncDataProvider.getBlockHeader();
-    } catch {
-      this.log.debug('Header is not set, requesting from the node');
-    }
-    if (!currentHeader) {
-      // REFACTOR: We should know the header of the genesis block without having to request it from the node.
-      await this.syncDataProvider.setHeader((await this.node.getBlockHeader(BlockNumber.ZERO))!);
-    }
-    await this.blockStream.sync();
-  }
-
-  public getSynchedBlockNumber() {
-    return this.syncDataProvider.getBlockNumber();
-  }
-}

package/src/tagging/siloed_tag.ts

@@ -1,22 +0,0 @@
-import { poseidon2Hash } from '@aztec/foundation/crypto';
-import type { Fr } from '@aztec/foundation/fields';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-
-import type { Tag } from './tag.js';
-
-/**
- * Represents a tag used in private log as it "appears on the chain" - that is the tag is siloed with a contract
- * address that emitted the log.
- */
-export class SiloedTag {
-  private constructor(public readonly value: Fr) {}
-
-  static async compute(tag: Tag, app: AztecAddress): Promise<SiloedTag> {
-    const siloedTag = await poseidon2Hash([app, tag.value]);
-    return new SiloedTag(siloedTag);
-  }
-
-  toString(): string {
-    return this.value.toString();
-  }
-}

package/src/tagging/tag.ts

@@ -1,16 +0,0 @@
-import { poseidon2Hash } from '@aztec/foundation/crypto';
-import type { Fr } from '@aztec/foundation/fields';
-import type { PreTag } from '@aztec/stdlib/logs';
-
-/**
- * Represents a tag of a private log. This is not the tag that "appears" on the chain as this tag is first siloed
- * with a contract address by kernels before being included in the final log.
- */
-export class Tag {
-  private constructor(public readonly value: Fr) {}
-
-  static async compute(preTag: PreTag): Promise<Tag> {
-    const tag = await poseidon2Hash([preTag.secret.value, preTag.index]);
-    return new Tag(tag);
-  }
-}

package/src/tagging/utils.ts

@@ -1,31 +0,0 @@
-import type { DirectionalAppTaggingSecret, PreTag } from '@aztec/stdlib/logs';
-
-// TODO(benesjan): Make this return tags instead - this will moves some complexity from syncTaggedLogs
-export function getPreTagsForTheWindow(
-  secretsAndWindows: { secret: DirectionalAppTaggingSecret; leftMostIndex: number; rightMostIndex: number }[],
-): PreTag[] {
-  const secrets = [];
-  for (const secretAndWindow of secretsAndWindows) {
-    for (let i = secretAndWindow.leftMostIndex; i <= secretAndWindow.rightMostIndex; i++) {
-      secrets.push({ secret: secretAndWindow.secret, index: i });
-    }
-  }
-  return secrets;
-}
-
-/**
- * Creates a map from directional app tagging secret to initial index.
- * @param preTags - The pre tags to get the initial indexes map from.
- * @returns The map from directional app tagging secret to initial index.
- */
-export function getInitialIndexesMap(preTags: { secret: DirectionalAppTaggingSecret; index: number | undefined }[]): {
-  [k: string]: number;
-} {
-  const initialIndexes: { [k: string]: number } = {};
-
-  for (const preTag of preTags) {
-    initialIndexes[preTag.secret.toString()] = preTag.index ?? 0;
-  }
-
-  return initialIndexes;
-}