@aztec/pxe 0.0.1-commit.b655e406 → 0.0.1-commit.c7c42ec

package/src/storage/address_data_provider/index.ts

@@ -1 +0,0 @@
-export { AddressDataProvider } from './address_data_provider.js';

package/src/storage/capsule_data_provider/index.ts

@@ -1 +0,0 @@
-export { CapsuleDataProvider } from './capsule_data_provider.js';

package/src/storage/contract_data_provider/index.ts

@@ -1 +0,0 @@
-export { ContractDataProvider } from './contract_data_provider.js';

package/src/storage/note_data_provider/index.ts

@@ -1,2 +0,0 @@
-export { NoteDao } from './note_dao.js';
-export { NoteDataProvider } from './note_data_provider.js';

package/src/storage/note_data_provider/note_dao.ts

@@ -1,154 +0,0 @@
-import { toBigIntBE } from '@aztec/foundation/bigint-buffer';
-import { Fr, Point } from '@aztec/foundation/fields';
-import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import { Note } from '@aztec/stdlib/note';
-import { TxHash } from '@aztec/stdlib/tx';
-
-import type { NoteData } from '../../contract_function_simulator/oracle/interfaces.js';
-
-/**
- * A Note Data Access Object, representing a note that was committed to the note hash tree, holding all of the
- * information required to use it during execution and manage its state.
- */
-export class NoteDao implements NoteData {
-  constructor(
-    // Note information
-
-    /** The packed content of the note, as will be returned in the getNotes oracle. */
-    public note: Note,
-    /** The address of the contract that created the note (i.e. the address used by the kernel during siloing). */
-    public contractAddress: AztecAddress,
-    /**
-     * The storage location of the note. This value is not used for anything in PXE, but we do index by storage slot
-     * since contracts typically make queries based on it.
-     */
-    public storageSlot: Fr,
-    /** The nonce that was injected into the note hash preimage in order to guarantee uniqueness. */
-    public noteNonce: Fr,
-
-    // Computed values
-    /**
-     * The inner hash (non-unique, non-siloed) of the note. Each contract determines how the note is hashed. Can
-     * be used alongside contractAddress and nonce to compute the uniqueNoteHash and the siloedNoteHash.
-     */
-    public noteHash: Fr,
-    /**
-     * The nullifier of the note, siloed by contract address.
-     * Note: Might be set as 0 if the note was added to PXE as nullified.
-     */
-    public siloedNullifier: Fr,
-
-    // Metadata
-    /** The hash of the tx in which this note was created. Knowing the tx hash allows for efficient node queries e.g.
-     *  when searching for txEffects.
-     */
-    public txHash: TxHash,
-    /** The L2 block number in which the tx with this note was included. Used for note management while processing
-     * reorgs.*/
-    public l2BlockNumber: number,
-    /** The L2 block hash in which the tx with this note was included. Used for note management while processing
-     * reorgs.*/
-    public l2BlockHash: string,
-    /** The index of the leaf in the global note hash tree the note is stored at */
-    public index: bigint,
-    /**
-     * The address whose public key was used to encrypt the note log during delivery.
-     * (This is the x-coordinate of the public key.)
-     */
-    public recipient: AztecAddress,
-  ) {}
-
-  toBuffer(): Buffer {
-    return serializeToBuffer([
-      this.note,
-      this.contractAddress,
-      this.storageSlot,
-      this.noteNonce,
-      this.noteHash,
-      this.siloedNullifier,
-      this.txHash,
-      this.l2BlockNumber,
-      Fr.fromHexString(this.l2BlockHash),
-      this.index,
-      this.recipient,
-    ]);
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-
-    const note = Note.fromBuffer(reader);
-    const contractAddress = AztecAddress.fromBuffer(reader);
-    const storageSlot = Fr.fromBuffer(reader);
-    const noteNonce = Fr.fromBuffer(reader);
-    const noteHash = Fr.fromBuffer(reader);
-    const siloedNullifier = Fr.fromBuffer(reader);
-    const txHash = reader.readObject(TxHash);
-    const l2BlockNumber = reader.readNumber();
-    const l2BlockHash = Fr.fromBuffer(reader).toString();
-    const index = toBigIntBE(reader.readBytes(32));
-    const recipient = AztecAddress.fromBuffer(reader);
-
-    return new NoteDao(
-      note,
-      contractAddress,
-      storageSlot,
-      noteNonce,
-      noteHash,
-      siloedNullifier,
-      txHash,
-      l2BlockNumber,
-      l2BlockHash,
-      index,
-      recipient,
-    );
-  }
-
-  toString() {
-    return '0x' + this.toBuffer().toString('hex');
-  }
-
-  static fromString(str: string) {
-    const hex = str.replace(/^0x/, '');
-    return NoteDao.fromBuffer(Buffer.from(hex, 'hex'));
-  }
-
-  /**
-   * Returns the size in bytes of the Note Dao.
-   * @returns - Its size in bytes.
-   */
-  public getSize() {
-    const indexSize = Math.ceil(Math.log2(Number(this.index)));
-    const noteSize = 4 + this.note.items.length * Fr.SIZE_IN_BYTES;
-    return noteSize + AztecAddress.SIZE_IN_BYTES + Fr.SIZE_IN_BYTES * 4 + TxHash.SIZE + Point.SIZE_IN_BYTES + indexSize;
-  }
-
-  static async random({
-    note = Note.random(),
-    contractAddress = undefined,
-    storageSlot = Fr.random(),
-    noteNonce = Fr.random(),
-    noteHash = Fr.random(),
-    siloedNullifier = Fr.random(),
-    txHash = TxHash.random(),
-    l2BlockNumber = Math.floor(Math.random() * 1000),
-    l2BlockHash = Fr.random().toString(),
-    index = Fr.random().toBigInt(),
-    recipient = undefined,
-  }: Partial<NoteDao> = {}) {
-    return new NoteDao(
-      note,
-      contractAddress ?? (await AztecAddress.random()),
-      storageSlot,
-      noteNonce,
-      noteHash,
-      siloedNullifier,
-      txHash,
-      l2BlockNumber,
-      l2BlockHash,
-      index,
-      recipient ?? (await AztecAddress.random()),
-    );
-  }
-}

package/src/storage/sync_data_provider/index.ts

@@ -1 +0,0 @@
-export { SyncDataProvider } from './sync_data_provider.js';

package/src/storage/tagging_data_provider/index.ts

@@ -1 +0,0 @@
-export { TaggingDataProvider } from './tagging_data_provider.js';

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/tagging/constants.ts

@@ -1,2 +0,0 @@
-// Half the size of the window we slide over the tagging indexes.
-export const WINDOW_HALF_SIZE = 10;

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;
-}