@aztec/stdlib 0.0.0-test.1 → 0.0.1-commit.b655e406

package/src/kernel/combined_constant_data.ts

@@ -1,128 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { type ZodFor, hexSchemaFor, schemas } from '@aztec/foundation/schemas';
-import { BufferReader, FieldReader, serializeToBuffer } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { z } from 'zod';
-
-import { BlockHeader } from '../tx/block_header.js';
-import { GlobalVariables } from '../tx/global_variables.js';
-import type { TxConstantData } from '../tx/tx_constant_data.js';
-import { TxContext } from '../tx/tx_context.js';
-
-/**
- * Data that is constant/not modified by neither of the kernels.
- */
-export class CombinedConstantData {
-  constructor(
-    /** Header of a block whose state is used during execution (not the block the transaction is included in). */
-    public historicalHeader: BlockHeader,
-    /**
-     * Context of the transaction.
-     *
-     * Note: `chainId` and `version` in txContext are not redundant to the values in
-     * self.historical_header.global_variables because they can be different in case of a protocol upgrade. In such
-     * a situation we could be using header from a block before the upgrade took place but be using the updated
-     * protocol to execute and prove the transaction.
-     */
-    public txContext: TxContext,
-    /**
-     * Root of the vk tree for the protocol circuits.
-     */
-    public vkTreeRoot: Fr,
-    /**
-     * Root of the tree for the protocol contracts.
-     */
-    public protocolContractTreeRoot: Fr,
-    /** Present when output by a public kernel, empty otherwise. */
-    public globalVariables: GlobalVariables,
-  ) {}
-
-  static combine(TxConstantData: TxConstantData, globalVariables: GlobalVariables) {
-    return new CombinedConstantData(
-      TxConstantData.historicalHeader,
-      TxConstantData.txContext,
-      TxConstantData.vkTreeRoot,
-      TxConstantData.protocolContractTreeRoot,
-      globalVariables,
-    );
-  }
-
-  static get schema(): ZodFor<CombinedConstantData> {
-    return z
-      .object({
-        historicalHeader: BlockHeader.schema,
-        txContext: TxContext.schema,
-        vkTreeRoot: schemas.Fr,
-        protocolContractTreeRoot: schemas.Fr,
-        globalVariables: GlobalVariables.schema,
-      })
-      .transform(CombinedConstantData.from)
-      .or(hexSchemaFor(CombinedConstantData));
-  }
-
-  toBuffer() {
-    return serializeToBuffer(
-      this.historicalHeader,
-      this.txContext,
-      this.vkTreeRoot,
-      this.protocolContractTreeRoot,
-      this.globalVariables,
-    );
-  }
-
-  clone(): CombinedConstantData {
-    return CombinedConstantData.fromBuffer(this.toBuffer());
-  }
-
-  getSize() {
-    return (
-      this.historicalHeader.getSize() +
-      this.txContext.getSize() +
-      this.vkTreeRoot.size +
-      this.protocolContractTreeRoot.size +
-      this.globalVariables.getSize()
-    );
-  }
-
-  static from({
-    historicalHeader,
-    txContext,
-    vkTreeRoot,
-    protocolContractTreeRoot,
-    globalVariables,
-  }: FieldsOf<CombinedConstantData>): CombinedConstantData {
-    return new CombinedConstantData(historicalHeader, txContext, vkTreeRoot, protocolContractTreeRoot, globalVariables);
-  }
-
-  /**
-   * Deserializes from a buffer or reader, corresponding to a write in cpp.
-   * @param buffer - Buffer or buffer reader to read from.
-   * @returns A new instance of CombinedConstantData.
-   */
-  static fromBuffer(buffer: Buffer | BufferReader): CombinedConstantData {
-    const reader = BufferReader.asReader(buffer);
-    return new CombinedConstantData(
-      reader.readObject(BlockHeader),
-      reader.readObject(TxContext),
-      Fr.fromBuffer(reader),
-      Fr.fromBuffer(reader),
-      reader.readObject(GlobalVariables),
-    );
-  }
-
-  static fromFields(fields: Fr[] | FieldReader): CombinedConstantData {
-    const reader = FieldReader.asReader(fields);
-    return new CombinedConstantData(
-      reader.readObject(BlockHeader),
-      reader.readObject(TxContext),
-      reader.readField(),
-      reader.readField(),
-      reader.readObject(GlobalVariables),
-    );
-  }
-
-  static empty() {
-    return new CombinedConstantData(BlockHeader.empty(), TxContext.empty(), Fr.ZERO, Fr.ZERO, GlobalVariables.empty());
-  }
-}

package/src/kernel/hints/rollup_validation_requests.ts

@@ -1,73 +0,0 @@
-import { ROLLUP_VALIDATION_REQUESTS_LENGTH } from '@aztec/constants';
-import type { Fr } from '@aztec/foundation/fields';
-import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
-import { bufferToHex, hexToBuffer } from '@aztec/foundation/string';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { MaxBlockNumber } from '../../tx/max_block_number.js';
-
-/**
- * Validation requests directed at the rollup, accumulated during the execution of the transaction.
- */
-export class RollupValidationRequests {
-  constructor(
-    /**
-     * The largest block number in which this transaction can be included.
-     */
-    public maxBlockNumber: MaxBlockNumber,
-  ) {}
-
-  getSize() {
-    return this.toBuffer().length;
-  }
-
-  toBuffer() {
-    return serializeToBuffer(this.maxBlockNumber);
-  }
-
-  toString() {
-    return bufferToHex(this.toBuffer());
-  }
-
-  static getFields(fields: FieldsOf<RollupValidationRequests>) {
-    return [fields.maxBlockNumber] as const;
-  }
-
-  static fromFields(fields: Fr[] | FieldReader) {
-    const reader = FieldReader.asReader(fields);
-    return new RollupValidationRequests(MaxBlockNumber.fromFields(reader));
-  }
-
-  toFields(): Fr[] {
-    const fields = serializeToFields(...RollupValidationRequests.getFields(this));
-    if (fields.length !== ROLLUP_VALIDATION_REQUESTS_LENGTH) {
-      throw new Error(
-        `Invalid number of fields for RollupValidationRequests. Expected ${ROLLUP_VALIDATION_REQUESTS_LENGTH}, got ${fields.length}`,
-      );
-    }
-    return fields;
-  }
-
-  /**
-   * Deserializes from a buffer or reader, corresponding to a write in cpp.
-   * @param buffer - Buffer or reader to read from.
-   * @returns Deserialized object.
-   */
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new RollupValidationRequests(reader.readObject(MaxBlockNumber));
-  }
-
-  /**
-   * Deserializes from a string, corresponding to a write in cpp.
-   * @param str - String to read from.
-   * @returns Deserialized object.
-   */
-  static fromString(str: string) {
-    return RollupValidationRequests.fromBuffer(hexToBuffer(str));
-  }
-
-  static empty() {
-    return new RollupValidationRequests(MaxBlockNumber.empty());
-  }
-}

package/src/kernel/private_kernel_prover_profile_result.ts

@@ -1,7 +0,0 @@
-import { z } from 'zod';
-
-export const PrivateKernelProverProfileResultSchema = z.object({
-  gateCounts: z.array(z.object({ circuitName: z.string(), gateCount: z.number() })),
-});
-
-export type PrivateKernelProverProfileResult = z.infer<typeof PrivateKernelProverProfileResultSchema>;

package/src/logs/indexed_tagging_secret.ts

@@ -1,45 +0,0 @@
-import { poseidon2Hash } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
-
-import type { AztecAddress } from '../aztec-address/index.js';
-
-export class IndexedTaggingSecret {
-  constructor(public appTaggingSecret: Fr, public index: number) {
-    if (index < 0) {
-      throw new Error('IndexedTaggingSecret index out of bounds');
-    }
-  }
-
-  toFields(): Fr[] {
-    return [this.appTaggingSecret, new Fr(this.index)];
-  }
-
-  static fromFields(serialized: Fr[]) {
-    return new this(serialized[0], serialized[1].toNumber());
-  }
-
-  /**
-   * Computes the tag based on the app tagging secret, recipient and index.
-   * @dev By including the recipient we achieve "directionality" of the tag (when sending a note in the other
-   * direction, the tag will be different).
-   * @param recipient The recipient of the note
-   * @returns The tag.
-   */
-  computeTag(recipient: AztecAddress) {
-    return poseidon2Hash([this.appTaggingSecret, recipient, this.index]);
-  }
-
-  /**
-   * Computes the siloed tag.
-   * @dev We do this second layer of siloing (one was already done as the tagging secret is app-siloed) because kernels
-   * do that to protect against contract impersonation attacks. This extra layer of siloing in kernels ensures that
-   * a malicious contract cannot emit a note with a tag corresponding to another contract.
-   * @param recipient The recipient of the note
-   * @param app The app address
-   * @returns The siloed tag.
-   */
-  async computeSiloedTag(recipient: AztecAddress, app: AztecAddress) {
-    const tag = await this.computeTag(recipient);
-    return poseidon2Hash([app, tag]);
-  }
-}

package/src/logs/l1_payload/encrypted_log_payload.ts

@@ -1,202 +0,0 @@
-import { PRIVATE_LOG_SIZE_IN_FIELDS } from '@aztec/constants';
-import { randomBytes } from '@aztec/foundation/crypto';
-import { Fr, type GrumpkinScalar, NotOnCurveError, Point } from '@aztec/foundation/fields';
-import { BufferReader, type Tuple, numToUInt16BE, serializeToBuffer } from '@aztec/foundation/serialize';
-
-import { AztecAddress } from '../../aztec-address/index.js';
-import { derivePublicKeyFromSecretKey } from '../../keys/derivation.js';
-import { PrivateLog } from '../private_log.js';
-import {
-  aes128Decrypt,
-  aes128Encrypt,
-  deriveAesSymmetricKeyAndIvFromEcdhSharedSecretUsingSha256,
-} from './encryption_util.js';
-import { deriveEcdhSharedSecret, deriveEcdhSharedSecretUsingAztecAddress } from './shared_secret_derivation.js';
-
-// Below constants should match the values defined in aztec-nr/aztec/src/encrypted_logs/log_assembly_strategies/default_aes128/note.nr.
-// Note: we will soon be 'abstracting' log processing: apps will process their own logs, instead of the PXE processing all apps' logs. Therefore, this file will imminently change considerably.
-
-const TAG_SIZE_IN_FIELDS = 1;
-const EPK_SIZE_IN_FIELDS = 1;
-
-const USABLE_PRIVATE_LOG_SIZE_IN_FIELDS = PRIVATE_LOG_SIZE_IN_FIELDS - TAG_SIZE_IN_FIELDS - EPK_SIZE_IN_FIELDS;
-const USABLE_PRIVATE_LOG_SIZE_IN_BYTES = ((USABLE_PRIVATE_LOG_SIZE_IN_FIELDS * 31) / 16) * 16;
-
-// The incoming header ciphertext is 48 bytes
-// 32 bytes for the address, and 16 bytes padding to follow PKCS#7
-const HEADER_CIPHERTEXT_SIZE_IN_BYTES = 48;
-const USABLE_PLAINTEXT_SIZE_IN_BYTES = USABLE_PRIVATE_LOG_SIZE_IN_BYTES - HEADER_CIPHERTEXT_SIZE_IN_BYTES;
-
-const CONTRACT_ADDRESS_SIZE_IN_BYTES = 32;
-
-const SIZE_OF_ENCODING_OF_CIPHERTEXT_SIZE_IN_BYTES = 2;
-
-function beBytes31ToFields(bytes: Buffer): Fr[] {
-  const fields = [];
-  const numFields = Math.ceil(bytes.length / 31);
-  for (let i = 0; i < numFields; i++) {
-    fields.push(new Fr(bytes.subarray(i * 31, (i + 1) * 31)));
-  }
-  return fields;
-}
-
-function fieldsToBEBytes31(fields: Fr[]) {
-  return Buffer.concat(fields.map(f => f.toBuffer().subarray(1)));
-}
-
-/**
- * Encrypted log payload with a tag used for retrieval by clients.
- */
-export class EncryptedLogPayload {
-  constructor(
-    /**
-     * Note discovery tag.
-     */
-    public readonly tag: Fr,
-    /**
-     * Address of a contract that emitted the log.
-     */
-    public readonly contractAddress: AztecAddress,
-    /**
-     * Decrypted incoming body.
-     */
-    public readonly incomingBodyPlaintext: Buffer,
-  ) {}
-
-  // NB: Only appears to be used in tests
-  // See noir-projects/aztec-nr/aztec/src/encrypted_logs/log_assembly_strategies/default_aes128/note.nr
-  public async generatePayload(
-    ephSk: GrumpkinScalar,
-    recipient: AztecAddress,
-    rand: (len: number) => Buffer = randomBytes,
-  ): Promise<PrivateLog> {
-    const ephPk = await derivePublicKeyFromSecretKey(ephSk);
-    const [ephPkX, ephPkSignBool] = ephPk.toXAndSign();
-    const ephPkSignU8 = Buffer.from([Number(ephPkSignBool)]);
-
-    const ciphertextSharedSecret = await deriveEcdhSharedSecretUsingAztecAddress(ephSk, recipient); // not to be confused with the tagging shared secret
-
-    const [symKey, iv] = deriveAesSymmetricKeyAndIvFromEcdhSharedSecretUsingSha256(ciphertextSharedSecret);
-
-    if (this.incomingBodyPlaintext.length > USABLE_PLAINTEXT_SIZE_IN_BYTES) {
-      throw new Error(`Incoming body plaintext cannot be more than ${USABLE_PLAINTEXT_SIZE_IN_BYTES} bytes.`);
-    }
-
-    const finalPlaintext = this.incomingBodyPlaintext;
-
-    const ciphertextBytes = await aes128Encrypt(finalPlaintext, iv, symKey);
-
-    const headerPlaintext = serializeToBuffer(this.contractAddress.toBuffer(), numToUInt16BE(ciphertextBytes.length));
-
-    // TODO: it is unsafe to re-use the same iv and symKey. We'll need to do something cleverer.
-    const headerCiphertextBytes = await aes128Encrypt(headerPlaintext, iv, symKey);
-
-    if (headerCiphertextBytes.length !== HEADER_CIPHERTEXT_SIZE_IN_BYTES) {
-      throw new Error(`Invalid header ciphertext size: ${headerCiphertextBytes.length}`);
-    }
-
-    const properLogBytesLength = 1 /* ephPkSignU8 */ + HEADER_CIPHERTEXT_SIZE_IN_BYTES + ciphertextBytes.length;
-
-    const logBytesPaddingToMult31 = rand(31 * Math.ceil(properLogBytesLength / 31) - properLogBytesLength);
-
-    const logBytes = serializeToBuffer(ephPkSignU8, headerCiphertextBytes, ciphertextBytes, logBytesPaddingToMult31);
-
-    if (logBytes.length % 31 !== 0) {
-      throw new Error(`logBytes.length should be divisible by 31, got: ${logBytes.length}`);
-    }
-
-    const fieldsPadding = Array.from({ length: USABLE_PRIVATE_LOG_SIZE_IN_FIELDS - logBytes.length / 31 }, () =>
-      Fr.fromBuffer(rand(32)),
-    ); // we use the randomBytes function instead of `Fr.random()`, so that we can use deterministic randomness in tests, through the rand() function.
-
-    const logFields = [this.tag, ephPkX, ...beBytes31ToFields(logBytes), ...fieldsPadding] as Tuple<
-      Fr,
-      typeof PRIVATE_LOG_SIZE_IN_FIELDS
-    >;
-
-    if (logFields.length !== PRIVATE_LOG_SIZE_IN_FIELDS) {
-      throw new Error(
-        `Expected private log payload to have ${PRIVATE_LOG_SIZE_IN_FIELDS} fields. Got ${logFields.length}.`,
-      );
-    }
-
-    return new PrivateLog(logFields);
-  }
-
-  /**
-   * Decrypts a ciphertext as an incoming log.
-   *
-   * This is executable by the recipient of the note, and uses the addressSecret to decrypt the payload.
-   *
-   * @param payload - The payload for the log
-   * @param addressSecret - The address secret, used to decrypt the logs
-   * @param ciphertextLength - Optionally supply the ciphertext length (see trimCiphertext())
-   * @returns The decrypted log payload
-   */
-  public static async decryptAsIncoming(
-    payload: Fr[],
-    addressSecret: GrumpkinScalar,
-  ): Promise<EncryptedLogPayload | undefined> {
-    try {
-      const logFields = payload;
-
-      const tag = logFields[0];
-      const ephPkX = logFields[1];
-
-      const reader = BufferReader.asReader(fieldsToBEBytes31(logFields.slice(TAG_SIZE_IN_FIELDS + EPK_SIZE_IN_FIELDS)));
-
-      const ephPkSigBuf = reader.readBytes(1);
-      const ephPkSignBool = !!ephPkSigBuf[0];
-      const ephPk = await Point.fromXAndSign(ephPkX, ephPkSignBool);
-
-      const headerCiphertextBytes = reader.readBytes(HEADER_CIPHERTEXT_SIZE_IN_BYTES);
-
-      let contractAddress = AztecAddress.ZERO;
-      if (!addressSecret) {
-        throw new Error('Cannot decrypt without an address secret.');
-      }
-
-      const ciphertextSharedSecret = await deriveEcdhSharedSecret(addressSecret, ephPk);
-
-      const [symKey, iv] = deriveAesSymmetricKeyAndIvFromEcdhSharedSecretUsingSha256(ciphertextSharedSecret);
-
-      const headerPlaintextBytes = await aes128Decrypt(headerCiphertextBytes, iv, symKey);
-
-      const headerReader = BufferReader.asReader(headerPlaintextBytes);
-
-      const contractAddressBuf = headerReader.readBytes(CONTRACT_ADDRESS_SIZE_IN_BYTES);
-      contractAddress = AztecAddress.fromBuffer(contractAddressBuf);
-
-      const ciphertextBytesLengthBuf = headerReader.readBytes(SIZE_OF_ENCODING_OF_CIPHERTEXT_SIZE_IN_BYTES);
-      const ciphertextBytesLength = (ciphertextBytesLengthBuf[0] << 8) + ciphertextBytesLengthBuf[1];
-
-      const ciphertextBytes = reader.readBytes(ciphertextBytesLength);
-
-      const plaintextBytes = await aes128Decrypt(ciphertextBytes, iv, symKey);
-
-      return new EncryptedLogPayload(tag, contractAddress, plaintextBytes);
-    } catch (e: any) {
-      // Following error messages are expected to occur when decryption fails
-      if (!this.isAcceptableError(e)) {
-        // If we encounter an unexpected error, we rethrow it
-        throw e;
-      }
-      return;
-    }
-  }
-
-  private static isAcceptableError(e: any) {
-    return (
-      e instanceof NotOnCurveError ||
-      e.message.endsWith('is greater or equal to field modulus.') ||
-      e.message.startsWith('Invalid AztecAddress length') ||
-      e.message.startsWith('Selector must fit in') ||
-      e.message.startsWith('Attempted to read beyond buffer length') ||
-      e.message.startsWith('RangeError [ERR_BUFFER_OUT_OF_BOUNDS]:')
-    );
-  }
-
-  public toBuffer() {
-    return serializeToBuffer(this.tag, this.contractAddress.toBuffer(), this.incomingBodyPlaintext);
-  }
-}

package/src/logs/l1_payload/encryption_util.ts

@@ -1,54 +0,0 @@
-import { GeneratorIndex } from '@aztec/constants';
-import { Aes128, sha256 } from '@aztec/foundation/crypto';
-import type { Point } from '@aztec/foundation/fields';
-import { numToUInt8 } from '@aztec/foundation/serialize';
-
-function extractCloseToUniformlyRandom256BitsFromEcdhSharedSecretUsingSha256(sharedSecret: Point): Buffer {
-  const secretBuffer = Buffer.concat([sharedSecret.toCompressedBuffer(), numToUInt8(GeneratorIndex.SYMMETRIC_KEY)]);
-  const hash = sha256(secretBuffer);
-  return hash;
-}
-
-function deriveAesSymmetricKeyAndIvFromEcdhSharedSecret(
-  sharedSecret: Point,
-  randomnessExtractionFunction: (sharedSecret: Point) => Buffer,
-): [Buffer, Buffer] {
-  const random256Bits = randomnessExtractionFunction(sharedSecret);
-  const symKey = random256Bits.subarray(0, 16);
-  const iv = random256Bits.subarray(16, 32);
-  return [symKey, iv];
-}
-
-export function deriveAesSymmetricKeyAndIvFromEcdhSharedSecretUsingSha256(sharedSecret: Point): [Buffer, Buffer] {
-  return deriveAesSymmetricKeyAndIvFromEcdhSharedSecret(
-    sharedSecret,
-    extractCloseToUniformlyRandom256BitsFromEcdhSharedSecretUsingSha256,
-  );
-}
-
-/**
- * Encrypts the plaintext using the secret key and public key
- *
- * @param plaintext - The plaintext buffer
- * @param secret - The secret key used to derive the AES secret
- * @param publicKey - Public key used to derived the AES secret
- * @param deriveSecret - Function to derive the AES secret from the ephemeral secret key and public key
- * @returns The ciphertext
- */
-export function aes128Encrypt(plaintext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
-  const aes128 = new Aes128();
-  return aes128.encryptBufferCBC(plaintext, iv, symKey);
-}
-
-/**
- * Decrypts the ciphertext using the secret key and public key
- * @param ciphertext - The ciphertext buffer
- * @param secret - The secret key used to derive the AES secret
- * @param publicKey - The public key used to derive the AES secret
- * @param deriveSecret - Function to derive the AES secret from the ephemeral secret key and public key
- * @returns
- */
-export function aes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
-  const aes128 = new Aes128();
-  return aes128.decryptBufferCBC(ciphertext, iv, symKey);
-}

package/src/logs/l1_payload/index.ts

@@ -1,2 +0,0 @@
-export * from './encrypted_log_payload.js';
-export * from './l1_note_payload.js';