@aztec/stdlib 0.0.1-commit.96dac018d → 0.0.1-commit.993d240

package/src/logs/extended_contract_class_log.ts

@@ -1,87 +0,0 @@
-import type { ZodFor } from '@aztec/foundation/schemas';
-import { BufferReader } from '@aztec/foundation/serialize';
-import { bufferToHex, hexToBuffer } from '@aztec/foundation/string';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import isEqual from 'lodash.isequal';
-import { z } from 'zod';
-
-import { ContractClassLog } from './contract_class_log.js';
-import { LogId } from './log_id.js';
-
-/**
- * Represents an individual contract class log entry extended with info about the block and tx it was emitted in.
- */
-export class ExtendedContractClassLog {
-  constructor(
-    /** Globally unique id of the log. */
-    public readonly id: LogId,
-    /** The data contents of the log. */
-    public readonly log: ContractClassLog,
-  ) {}
-
-  static async random() {
-    return new ExtendedContractClassLog(LogId.random(), await ContractClassLog.random());
-  }
-
-  static get schema(): ZodFor<ExtendedContractClassLog> {
-    return z
-      .object({
-        id: LogId.schema,
-        log: ContractClassLog.schema,
-      })
-      .transform(ExtendedContractClassLog.from);
-  }
-
-  static from(fields: FieldsOf<ExtendedContractClassLog>) {
-    return new ExtendedContractClassLog(fields.id, fields.log);
-  }
-
-  /**
-   * Serializes log to a buffer.
-   * @returns A buffer containing the serialized log.
-   */
-  public toBuffer(): Buffer {
-    return Buffer.concat([this.id.toBuffer(), this.log.toBuffer()]);
-  }
-
-  /**
-   * Serializes log to a string.
-   * @returns A string containing the serialized log.
-   */
-  public toString(): string {
-    return bufferToHex(this.toBuffer());
-  }
-
-  /**
-   * Checks if two ExtendedContractClassLog objects are equal.
-   * @param other - Another ExtendedContractClassLog object to compare with.
-   * @returns True if the two objects are equal, false otherwise.
-   */
-  public equals(other: ExtendedContractClassLog): boolean {
-    return isEqual(this, other);
-  }
-
-  /**
-   * Deserializes log from a buffer.
-   * @param buffer - The buffer or buffer reader containing the log.
-   * @returns Deserialized instance of `Log`.
-   */
-  public static fromBuffer(buffer: Buffer | BufferReader): ExtendedContractClassLog {
-    const reader = BufferReader.asReader(buffer);
-
-    const logId = LogId.fromBuffer(reader);
-    const log = ContractClassLog.fromBuffer(reader);
-
-    return new ExtendedContractClassLog(logId, log);
-  }
-
-  /**
-   * Deserializes `ExtendedContractClassLog` object from a hex string representation.
-   * @param data - A hex string representation of the log.
-   * @returns An `ExtendedContractClassLog` object.
-   */
-  public static fromString(data: string): ExtendedContractClassLog {
-    return ExtendedContractClassLog.fromBuffer(hexToBuffer(data));
-  }
-}

package/src/logs/extended_public_log.ts

@@ -1,94 +0,0 @@
-import { BufferReader } from '@aztec/foundation/serialize';
-import { bufferToHex, hexToBuffer } from '@aztec/foundation/string';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import isEqual from 'lodash.isequal';
-import { z } from 'zod';
-
-import { LogId } from './log_id.js';
-import { PublicLog } from './public_log.js';
-
-/**
- * Represents an individual public log entry extended with info about the block and tx it was emitted in.
- */
-export class ExtendedPublicLog {
-  constructor(
-    /** Globally unique id of the log. */
-    public readonly id: LogId,
-    /** The data contents of the log. */
-    public readonly log: PublicLog,
-  ) {}
-
-  static async random() {
-    return new ExtendedPublicLog(LogId.random(), await PublicLog.random());
-  }
-
-  static get schema() {
-    return z
-      .object({
-        id: LogId.schema,
-        log: PublicLog.schema,
-      })
-      .transform(ExtendedPublicLog.from);
-  }
-
-  static from(fields: FieldsOf<ExtendedPublicLog>) {
-    return new ExtendedPublicLog(fields.id, fields.log);
-  }
-
-  /**
-   * Serializes log to a buffer.
-   * @returns A buffer containing the serialized log.
-   */
-  public toBuffer(): Buffer {
-    return Buffer.concat([this.id.toBuffer(), this.log.toBuffer()]);
-  }
-
-  /**
-   * Serializes log to a string.
-   * @returns A string containing the serialized log.
-   */
-  public toString(): string {
-    return bufferToHex(this.toBuffer());
-  }
-
-  /**
-   * Serializes log to a human readable string.
-   * @returns A human readable representation of the log.
-   */
-  public toHumanReadable(): string {
-    return `${this.id.toHumanReadable()}, ${this.log.toHumanReadable()}`;
-  }
-
-  /**
-   * Checks if two ExtendedPublicLog objects are equal.
-   * @param other - Another ExtendedPublicLog object to compare with.
-   * @returns True if the two objects are equal, false otherwise.
-   */
-  public equals(other: ExtendedPublicLog): boolean {
-    return isEqual(this, other);
-  }
-
-  /**
-   * Deserializes log from a buffer.
-   * @param buffer - The buffer or buffer reader containing the log.
-   * @returns Deserialized instance of `Log`.
-   */
-  public static fromBuffer(buffer: Buffer | BufferReader): ExtendedPublicLog {
-    const reader = BufferReader.asReader(buffer);
-
-    const logId = LogId.fromBuffer(reader);
-    const log = PublicLog.fromBuffer(reader);
-
-    return new ExtendedPublicLog(logId, log);
-  }
-
-  /**
-   * Deserializes `ExtendedPublicLog` object from a hex string representation.
-   * @param data - A hex string representation of the log.
-   * @returns An `ExtendedPublicLog` object.
-   */
-  public static fromString(data: string): ExtendedPublicLog {
-    return ExtendedPublicLog.fromBuffer(hexToBuffer(data));
-  }
-}

package/src/logs/log_filter.ts

@@ -1,31 +0,0 @@
-import { z } from 'zod';
-
-import type { AztecAddress } from '../aztec-address/index.js';
-import { type ZodFor, schemas } from '../schemas/index.js';
-import { TxHash } from '../tx/tx_hash.js';
-import { LogId } from './log_id.js';
-
-/**
- * Log filter used to fetch L2 logs.
- * @remarks This filter is applied as an intersection of all it's params.
- */
-export type LogFilter = {
-  /** Hash of a transaction from which to fetch the logs. */
-  txHash?: TxHash;
-  /** The block number from which to start fetching logs (inclusive). */
-  fromBlock?: number;
-  /** The block number until which to fetch logs (not inclusive). */
-  toBlock?: number;
-  /** Log id after which to start fetching logs. */
-  afterLog?: LogId;
-  /** The contract address to filter logs by. */
-  contractAddress?: AztecAddress;
-};
-
-export const LogFilterSchema: ZodFor<LogFilter> = z.object({
-  txHash: TxHash.schema.optional(),
-  fromBlock: schemas.Integer.optional(),
-  toBlock: schemas.Integer.optional(),
-  afterLog: LogId.schema.optional(),
-  contractAddress: schemas.AztecAddress.optional(),
-});

package/src/logs/log_id.ts

@@ -1,125 +0,0 @@
-import { INITIAL_L2_BLOCK_NUM } from '@aztec/constants';
-import { toBufferBE } from '@aztec/foundation/bigint-buffer';
-import { BlockNumber, BlockNumberSchema } from '@aztec/foundation/branded-types';
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { BufferReader } from '@aztec/foundation/serialize';
-
-import { z } from 'zod';
-
-import { BlockHash } from '../block/block_hash.js';
-import { schemas } from '../schemas/index.js';
-import { TxHash } from '../tx/tx_hash.js';
-
-/** A globally unique log id. */
-export class LogId {
-  constructor(
-    /** The block number the log was emitted in. */
-    public readonly blockNumber: BlockNumber,
-    /** The hash of the block the log was emitted in. */
-    public readonly blockHash: BlockHash,
-    /** The hash of the transaction the log was emitted in. */
-    public readonly txHash: TxHash,
-    /** The index of a tx in a block the log was emitted in. */
-    public readonly txIndex: number,
-    /** The index of a log the tx was emitted in. */
-    public readonly logIndex: number,
-  ) {
-    if (!Number.isInteger(blockNumber) || blockNumber < INITIAL_L2_BLOCK_NUM) {
-      throw new Error(`Invalid block number: ${blockNumber}`);
-    }
-    if (!Number.isInteger(txIndex)) {
-      throw new Error(`Invalid tx index: ${txIndex}`);
-    }
-    if (!Number.isInteger(logIndex)) {
-      throw new Error(`Invalid log index: ${logIndex}`);
-    }
-  }
-
-  static random() {
-    return new LogId(
-      BlockNumber(Math.floor(Math.random() * 1000) + 1),
-      BlockHash.random(),
-      TxHash.random(),
-      Math.floor(Math.random() * 1000),
-      Math.floor(Math.random() * 100),
-    );
-  }
-
-  static get schema() {
-    return z
-      .object({
-        blockNumber: BlockNumberSchema,
-        blockHash: BlockHash.schema,
-        txHash: TxHash.schema,
-        txIndex: schemas.Integer,
-        logIndex: schemas.Integer,
-      })
-      .transform(
-        ({ blockNumber, blockHash, txHash, txIndex, logIndex }) =>
-          new LogId(blockNumber, blockHash, txHash, txIndex, logIndex),
-      );
-  }
-
-  /**
-   * Serializes log id to a buffer.
-   * @returns A buffer containing the serialized log id.
-   */
-  public toBuffer(): Buffer {
-    return Buffer.concat([
-      toBufferBE(BigInt(this.blockNumber), 4),
-      this.blockHash.toBuffer(),
-      this.txHash.toBuffer(),
-      toBufferBE(BigInt(this.txIndex), 4),
-      toBufferBE(BigInt(this.logIndex), 4),
-    ]);
-  }
-
-  /**
-   * Creates a LogId from a buffer.
-   * @param buffer - A buffer containing the serialized log id.
-   * @returns A log id.
-   */
-  static fromBuffer(buffer: Buffer | BufferReader): LogId {
-    const reader = BufferReader.asReader(buffer);
-
-    const blockNumber = BlockNumber(reader.readNumber());
-    const blockHash = new BlockHash(reader.readObject(Fr));
-    const txHash = reader.readObject(TxHash);
-    const txIndex = reader.readNumber();
-    const logIndex = reader.readNumber();
-
-    return new LogId(blockNumber, blockHash, txHash, txIndex, logIndex);
-  }
-
-  /**
-   * Converts the LogId instance to a string.
-   * @returns A string representation of the log id.
-   */
-  public toString(): string {
-    return `${this.blockNumber}-${this.txIndex}-${this.logIndex}-${this.blockHash.toString()}-${this.txHash.toString()}`;
-  }
-
-  /**
-   * Creates a LogId from a string.
-   * @param data - A string representation of a log id.
-   * @returns A log id.
-   */
-  static fromString(data: string): LogId {
-    const [rawBlockNumber, rawTxIndex, rawLogIndex, rawBlockHash, rawTxHash] = data.split('-');
-    const blockNumber = BlockNumber(Number(rawBlockNumber));
-    const blockHash = BlockHash.fromString(rawBlockHash);
-    const txHash = TxHash.fromString(rawTxHash);
-    const txIndex = Number(rawTxIndex);
-    const logIndex = Number(rawLogIndex);
-
-    return new LogId(blockNumber, blockHash, txHash, txIndex, logIndex);
-  }
-
-  /**
-   * Serializes log id to a human readable string.
-   * @returns A human readable representation of the log id.
-   */
-  public toHumanReadable(): string {
-    return `logId: (blockNumber: ${this.blockNumber}, blockHash: ${this.blockHash.toString()}, txHash: ${this.txHash.toString()}, txIndex: ${this.txIndex}, logIndex: ${this.logIndex})`;
-  }
-}

package/src/logs/tx_scoped_l2_log.ts

@@ -1,98 +0,0 @@
-import { BlockNumber, BlockNumberSchema } from '@aztec/foundation/branded-types';
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { schemas as foundationSchemas } from '@aztec/foundation/schemas';
-import {
-  BufferReader,
-  bigintToUInt64BE,
-  numToUInt32BE,
-  serializeArrayOfBufferableToVector,
-} from '@aztec/foundation/serialize';
-
-import { z } from 'zod';
-
-import { schemas } from '../schemas/schemas.js';
-import { TxHash } from '../tx/tx_hash.js';
-import type { UInt64 } from '../types/shared.js';
-
-export class TxScopedL2Log {
-  constructor(
-    /*
-     * Hash of the tx where the log is included
-     */
-    public txHash: TxHash,
-    /*
-     * The block this log is included in
-     */
-    public blockNumber: BlockNumber,
-    /*
-     * The timestamp of the block this log is included in
-     */
-    public blockTimestamp: UInt64,
-    /*
-     * The log data as an array of field elements
-     */
-    public logData: Fr[],
-    /*
-     * The note hashes from the tx effect
-     */
-    public noteHashes: Fr[],
-    /*
-     * The first nullifier from the tx effect. Used for nonce discovery when processing notes from logs.
-     *
-     * (Note nonces are computed as `hash(firstNullifier, noteIndexInTx)`.)
-     */
-    public firstNullifier: Fr,
-  ) {}
-
-  static get schema() {
-    return z
-      .object({
-        txHash: TxHash.schema,
-        blockNumber: BlockNumberSchema,
-        blockTimestamp: schemas.UInt64,
-        logData: z.array(foundationSchemas.Fr),
-        noteHashes: z.array(foundationSchemas.Fr),
-        firstNullifier: foundationSchemas.Fr,
-      })
-      .transform(
-        ({ txHash, blockNumber, blockTimestamp, logData, noteHashes, firstNullifier }) =>
-          new TxScopedL2Log(txHash, blockNumber, blockTimestamp, logData, noteHashes, firstNullifier),
-      );
-  }
-
-  toBuffer() {
-    return Buffer.concat([
-      this.txHash.toBuffer(),
-      numToUInt32BE(this.blockNumber),
-      bigintToUInt64BE(this.blockTimestamp),
-      serializeArrayOfBufferableToVector(this.logData),
-      serializeArrayOfBufferableToVector(this.noteHashes),
-      this.firstNullifier.toBuffer(),
-    ]);
-  }
-
-  static fromBuffer(buffer: Buffer) {
-    const reader = BufferReader.asReader(buffer);
-    const txHash = reader.readObject(TxHash);
-    const blockNumber = BlockNumber(reader.readNumber());
-    const blockTimestamp = reader.readUInt64();
-    const logData = reader.readVector(Fr);
-    const noteHashes = reader.readVector(Fr);
-    const firstNullifier = reader.readObject(Fr);
-
-    return new TxScopedL2Log(txHash, blockNumber, blockTimestamp, logData, noteHashes, firstNullifier);
-  }
-
-  equals(other: TxScopedL2Log) {
-    return (
-      this.txHash.equals(other.txHash) &&
-      this.blockNumber === other.blockNumber &&
-      this.blockTimestamp === other.blockTimestamp &&
-      this.logData.length === other.logData.length &&
-      this.logData.every((f, i) => f.equals(other.logData[i])) &&
-      this.noteHashes.length === other.noteHashes.length &&
-      this.noteHashes.every((h, i) => h.equals(other.noteHashes[i])) &&
-      this.firstNullifier.equals(other.firstNullifier)
-    );
-  }
-}

package/src/slashing/empire.ts

@@ -1,104 +0,0 @@
-import { EpochNumber, SlotNumber } from '@aztec/foundation/branded-types';
-
-import { getRoundForSlot, getRoundsForEpoch } from './helpers.js';
-import type { Offense, OffenseIdentifier, SlashPayload, SlashPayloadRound, ValidatorSlash } from './types.js';
-import { OffenseType } from './types.js';
-
-/**
- * Returns true if the offense is uncontroversial as in it can be verified via L1 data alone,
- * and does not depend on the local view of the node of the L2 p2p network.
- * @param offense - The offense type to check
- */
-export function isOffenseUncontroversial(offense: OffenseType): boolean {
-  return (
-    offense === OffenseType.PROPOSED_INSUFFICIENT_ATTESTATIONS ||
-    offense === OffenseType.PROPOSED_INCORRECT_ATTESTATIONS ||
-    offense === OffenseType.ATTESTED_DESCENDANT_OF_INVALID
-  );
-}
-
-/** Extracts offense identifiers (validator, epoch, offense type) from an Empire-based SlashPayload */
-export function getOffenseIdentifiersFromPayload(payload: SlashPayload | SlashPayloadRound): OffenseIdentifier[] {
-  return payload.slashes.flatMap((slash: ValidatorSlash) =>
-    slash.offenses.map(o => ({
-      validator: slash.validator,
-      offenseType: o.offenseType,
-      epochOrSlot: o.epochOrSlot,
-    })),
-  );
-}
-
-/** Creates ValidatorSlashes used to create an Empire-based SlashPayload from a set of Offenses */
-export function offensesToValidatorSlash(offenses: Offense[]): ValidatorSlash[] {
-  return offenses.map(offense => ({
-    validator: offense.validator,
-    amount: offense.amount,
-    offenses: [{ epochOrSlot: offense.epochOrSlot, offenseType: offense.offenseType }],
-  }));
-}
-
-/**
- * Sorts offense data by:
- * - Uncontroversial offenses first
- * - Slash amount (descending)
- * - Epoch or slot (ascending, ie oldest first)
- * - Validator address (ascending)
- * - Offense type (descending)
- */
-export function offenseDataComparator(a: Offense, b: Offense): number {
-  return (
-    Number(isOffenseUncontroversial(b.offenseType)) - Number(isOffenseUncontroversial(a.offenseType)) ||
-    Number(b.amount - a.amount) ||
-    Number(a.epochOrSlot - b.epochOrSlot) ||
-    a.validator.toString().localeCompare(b.validator.toString()) ||
-    Number(b.offenseType) - Number(a.offenseType)
-  );
-}
-
-/**
- * Returns the first round in which the offense is eligible for being included in an Empire-based slash payload.
- * Should be equal to to the first round that starts strictly after the offense becomes detectable.
- */
-export function getFirstEligibleRoundForOffense(
-  offense: OffenseIdentifier,
-  constants: { slashingRoundSize: number; epochDuration: number; proofSubmissionEpochs: number },
-): bigint {
-  // TODO(palla/slash): Check for off-by-ones
-  switch (offense.offenseType) {
-    // Inactivity is detected at the end of the epoch, so we flag it as detected in the first fresh round for the next epoch
-    case OffenseType.INACTIVITY: {
-      const epoch = offense.epochOrSlot;
-      const detectedEpoch = EpochNumber.fromBigInt(epoch + 1n);
-      return getRoundsForEpoch(detectedEpoch, constants)[0] + 1n;
-    }
-    // These offenses are detected once an epoch is pruned, which happens after the proof submission window
-    case OffenseType.VALID_EPOCH_PRUNED:
-    case OffenseType.DATA_WITHHOLDING: {
-      // TODO(palla/slash): Check for off-by-ones especially here
-      const epoch = offense.epochOrSlot;
-      const detectedEpoch = EpochNumber.fromBigInt(epoch + BigInt(constants.proofSubmissionEpochs));
-      return getRoundsForEpoch(detectedEpoch, constants)[0] + 1n;
-    }
-    // These offenses are detected immediately in the slot they occur, so we assume they are detected in the first round for the following slot
-    case OffenseType.PROPOSED_INSUFFICIENT_ATTESTATIONS:
-    case OffenseType.PROPOSED_INCORRECT_ATTESTATIONS:
-    case OffenseType.ATTESTED_DESCENDANT_OF_INVALID:
-    case OffenseType.BROADCASTED_INVALID_BLOCK_PROPOSAL:
-    case OffenseType.DUPLICATE_PROPOSAL:
-    case OffenseType.DUPLICATE_ATTESTATION: {
-      const slot = offense.epochOrSlot;
-      const detectedSlot = SlotNumber.fromBigInt(slot + 1n);
-      return getRoundForSlot(detectedSlot, constants).round + 1n;
-    }
-    // Assume these are epoch-based offenses, even though we should never have to process these
-    case OffenseType.UNKNOWN: {
-      const epoch = offense.epochOrSlot;
-      const detectedEpoch = EpochNumber.fromBigInt(epoch + 1n);
-      return getRoundsForEpoch(detectedEpoch, constants)[0] + 1n;
-    }
-    default: {
-      const _: never = offense.offenseType;
-      throw new Error(`Unknown offense type: ${offense.offenseType}`);
-    }
-  }
-}