@aztec/stdlib 0.0.1-commit.5daedc8 → 0.0.1-commit.6201a7b05

package/src/l1-contracts/slash_factory.ts

@@ -1,177 +0,0 @@
-import { type L1TxRequest, type ViemClient, tryExtractEvent } from '@aztec/ethereum';
-import { maxBigint } from '@aztec/foundation/bigint';
-import { EthAddress } from '@aztec/foundation/eth-address';
-import { createLogger } from '@aztec/foundation/log';
-import { SlashFactoryAbi } from '@aztec/l1-artifacts/SlashFactoryAbi';
-
-import { type GetContractReturnType, type Hex, type Log, encodeFunctionData, getContract } from 'viem';
-
-import type { L1RollupConstants } from '../epoch-helpers/index.js';
-import {
-  OffenseToBigInt,
-  type SlashPayload,
-  type ValidatorSlash,
-  type ValidatorSlashOffense,
-  bigIntToOffense,
-} from '../slashing/index.js';
-
-export class SlashFactoryContract {
-  private readonly logger = createLogger('contracts:slash_factory');
-  private readonly contract: GetContractReturnType<typeof SlashFactoryAbi, ViemClient>;
-
-  constructor(
-    public readonly client: ViemClient,
-    address: Hex | EthAddress,
-  ) {
-    this.contract = getContract({
-      address: typeof address === 'string' ? address : address.toString(),
-      abi: SlashFactoryAbi,
-      client,
-    });
-  }
-
-  public get address() {
-    return EthAddress.fromString(this.contract.address);
-  }
-
-  public buildCreatePayloadRequest(slashes: ValidatorSlash[]): L1TxRequest {
-    const sorted = this.sortSlashes(slashes);
-
-    return {
-      to: this.contract.address,
-      data: encodeFunctionData({
-        abi: SlashFactoryAbi,
-        functionName: 'createSlashPayload',
-        args: [
-          sorted.map(d => d.validator.toString()),
-          sorted.map(d => d.amount),
-          sorted.map(d => d.offenses.map(packValidatorSlashOffense)),
-        ],
-      }),
-    };
-  }
-
-  /** Tries to extract a SlashPayloadCreated event from the given logs. */
-  public tryExtractSlashPayloadCreatedEvent(logs: Log[]) {
-    return tryExtractEvent(logs, this.address.toString(), SlashFactoryAbi, 'SlashPayloadCreated');
-  }
-
-  public async getSlashPayloadCreatedEvents(): Promise<SlashPayload[]> {
-    const events = await this.contract.getEvents.SlashPayloadCreated();
-    return Promise.all(
-      events.map(async event => {
-        const { validators, amounts, offenses } = event.args;
-        const slashes: ValidatorSlash[] = validators!.map((validator, i) => ({
-          validator: EthAddress.fromString(validator),
-          amount: amounts![i],
-          offenses: offenses![i].map(unpackValidatorSlashOffense),
-        }));
-
-        const block = await this.client.getBlock({ blockNumber: event.blockNumber, includeTransactions: false });
-        return { address: EthAddress.fromString(event.args.payloadAddress!), slashes, timestamp: block.timestamp };
-      }),
-    );
-  }
-
-  /**
-   * Searches for a slash payload in the events emitted by the contract.
-   * This method cannot query for historical payload events, it queries for payloads that have not yet expired.
-   * @param payloadAddress The address of the payload to search for.
-   * @param constants The L1 rollup constants needed for time calculations.
-   */
-  public async getSlashPayloadFromEvents(
-    payloadAddress: EthAddress,
-    settings: {
-      logsBatchSize?: number;
-      slashingRoundSize: number;
-      slashingPayloadLifetimeInRounds: number;
-    } & Pick<L1RollupConstants, 'slotDuration' | 'ethereumSlotDuration'>,
-  ): Promise<Omit<SlashPayload, 'votes'> | undefined> {
-    // We query for the log where the payload was emitted walking backwards until we go past payload expiration time
-    // Note that all log queries require a block range, and RPC providers cap the max range (eg quicknode is 10k blocks).
-    const { slashingRoundSize, slashingPayloadLifetimeInRounds, slotDuration, ethereumSlotDuration } = settings;
-    const currentBlockNumber = await this.client.getBlockNumber({ cacheTime: 0 });
-
-    // Why the +1 below? Just for good measure. Better err on the safe side.
-    const earliestBlockNumber = maxBigint(
-      0n,
-      currentBlockNumber -
-        ((BigInt(slashingPayloadLifetimeInRounds) + 1n) * BigInt(slashingRoundSize) * BigInt(slotDuration)) /
-          BigInt(ethereumSlotDuration),
-    );
-
-    this.logger.trace(
-      `Starting search for slash payload ${payloadAddress} from block ${currentBlockNumber} with earliest block ${earliestBlockNumber}`,
-    );
-    const batchSize = BigInt(settings.logsBatchSize ?? 10000);
-    let toBlock = currentBlockNumber;
-
-    do {
-      const fromBlock = maxBigint(earliestBlockNumber, toBlock - batchSize);
-      this.logger.trace(`Searching for slash payload ${payloadAddress} in blocks ${fromBlock} to ${toBlock}`);
-      const logs = await this.contract.getEvents.SlashPayloadCreated(
-        { payloadAddress: payloadAddress.toString() },
-        { fromBlock, toBlock, strict: true },
-      );
-
-      // We found the payload, return it
-      if (logs.length > 0) {
-        const log = logs[0];
-        const { validators, amounts, offenses } = log.args;
-
-        // Convert the data to our internal types
-        const slashes: ValidatorSlash[] = validators!.map((validator, i) => ({
-          validator: EthAddress.fromString(validator),
-          amount: amounts![i],
-          offenses: offenses![i].map(unpackValidatorSlashOffense),
-        }));
-
-        // Get the timestamp from the block
-        const block = await this.client.getBlock({ blockNumber: log.blockNumber, includeTransactions: false });
-
-        return { address: payloadAddress, slashes, timestamp: block.timestamp };
-      }
-
-      // If not found, we go back one batch
-      toBlock -= batchSize;
-    } while (toBlock > earliestBlockNumber);
-
-    return undefined;
-  }
-
-  public async getAddressAndIsDeployed(
-    slashes: ValidatorSlash[],
-  ): Promise<{ address: EthAddress; salt: Hex; isDeployed: boolean }> {
-    const sortedSlashes = this.sortSlashes(slashes);
-    const [address, salt, isDeployed] = await this.contract.read.getAddressAndIsDeployed([
-      sortedSlashes.map(s => s.validator.toString()),
-      sortedSlashes.map(s => s.amount),
-      sortedSlashes.map(s => s.offenses.map(packValidatorSlashOffense)),
-    ]);
-    return { address: EthAddress.fromString(address), salt, isDeployed };
-  }
-
-  private sortSlashes(slashes: ValidatorSlash[]): ValidatorSlash[] {
-    const offenseSorter = (a: ValidatorSlashOffense, b: ValidatorSlashOffense) => {
-      return a.epochOrSlot === b.epochOrSlot ? a.offenseType - b.offenseType : Number(a.epochOrSlot - b.epochOrSlot);
-    };
-    return [...slashes]
-      .map(slash => ({ ...slash, offenses: [...slash.offenses].sort(offenseSorter) }))
-      .sort((a, b) => a.validator.toString().localeCompare(b.validator.toString()));
-  }
-}
-
-export function packValidatorSlashOffense(offense: ValidatorSlashOffense): bigint {
-  const offenseId = OffenseToBigInt[offense.offenseType];
-  if (offenseId > (1 << 8) - 1) {
-    throw new Error(`Offense type ${offense.offenseType} cannot be packed into 8 bits`);
-  }
-  return (offenseId << 120n) + offense.epochOrSlot;
-}
-
-export function unpackValidatorSlashOffense(packed: bigint): ValidatorSlashOffense {
-  const offenseId = (packed >> 120n) & 0xffn;
-  const epochOrSlot = packed & ((1n << 120n) - 1n);
-  const offenseType = bigIntToOffense(offenseId);
-  return { epochOrSlot, offenseType };
-}

package/src/logs/log_with_tx_data.ts

@@ -1,46 +0,0 @@
-import { MAX_NOTE_HASHES_PER_TX, PRIVATE_LOG_CIPHERTEXT_LEN } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
-import { TxHash } from '@aztec/stdlib/tx';
-
-// This is used as a response for PXE's custom getPublicLogByTag oracle.
-export class PublicLogWithTxData {
-  constructor(
-    public logPayload: Fr[],
-    public txHash: TxHash,
-    public uniqueNoteHashesInTx: Fr[],
-    public firstNullifierInTx: Fr,
-  ) {}
-}
-
-// This is used as a response for PXE's custom getPrivateLogByTag oracle.
-export class PrivateLogWithTxData {
-  constructor(
-    public logPayload: Fr[],
-    public txHash: TxHash,
-    public uniqueNoteHashesInTx: Fr[],
-    public firstNullifierInTx: Fr,
-  ) {}
-
-  toNoirSerialization(): (Fr | Fr[])[] {
-    return [
-      ...toBoundedVecSerialization(this.logPayload, PRIVATE_LOG_CIPHERTEXT_LEN),
-      this.txHash.hash,
-      ...toBoundedVecSerialization(this.uniqueNoteHashesInTx, MAX_NOTE_HASHES_PER_TX),
-      this.firstNullifierInTx,
-    ];
-  }
-
-  static noirSerializationOfEmpty(): (Fr | Fr[])[] {
-    return new PrivateLogWithTxData([], TxHash.zero(), [], new Fr(0)).toNoirSerialization();
-  }
-}
-
-function toBoundedVecSerialization(array: Fr[], maxLength: number) {
-  if (array.length > maxLength) {
-    throw new Error(
-      `An array of length ${array.length} cannot be converted to a BoundedVec of max length ${maxLength}`,
-    );
-  }
-
-  return [array.concat(Array(maxLength - array.length).fill(new Fr(0))), new Fr(array.length)];
-}

package/src/note/notes_filter.ts

@@ -1,35 +0,0 @@
-import type { Fr } from '@aztec/foundation/fields';
-
-import { z } from 'zod';
-
-import type { AztecAddress } from '../aztec-address/index.js';
-import { type ZodFor, schemas } from '../schemas/index.js';
-import { NoteStatus } from './note_status.js';
-
-/**
- * A filter used to fetch notes.
- * @remarks This filter is applied as an intersection of all its params.
- */
-export type NotesFilter = {
-  /**
-   * The contract address the note belongs to.
-   * @remarks Providing a contract address is required as we need that information to trigger private state sync.
-   */
-  contractAddress: AztecAddress;
-  /** The specific storage location of the note on the contract. */
-  storageSlot?: Fr;
-  /** The status of the note. Defaults to 'ACTIVE'. */
-  status?: NoteStatus;
-  /** The siloed nullifier for the note. */
-  siloedNullifier?: Fr;
-  /** The scopes in which to get notes from. This defaults to all scopes. */
-  scopes?: AztecAddress[];
-};
-
-export const NotesFilterSchema: ZodFor<NotesFilter> = z.object({
-  contractAddress: schemas.AztecAddress,
-  storageSlot: schemas.Fr.optional(),
-  status: z.nativeEnum(NoteStatus).optional(),
-  siloedNullifier: schemas.Fr.optional(),
-  scopes: z.array(schemas.AztecAddress).optional(),
-});

package/src/p2p/block_attestation.ts

@@ -1,136 +0,0 @@
-import { SlotNumber } from '@aztec/foundation/branded-types';
-import { Buffer32 } from '@aztec/foundation/buffer';
-import { keccak256, tryRecoverAddress } from '@aztec/foundation/crypto';
-import type { EthAddress } from '@aztec/foundation/eth-address';
-import { Signature } from '@aztec/foundation/eth-signature';
-import { Fr } from '@aztec/foundation/fields';
-import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-
-import { z } from 'zod';
-
-import type { ZodFor } from '../schemas/index.js';
-import { ConsensusPayload } from './consensus_payload.js';
-import { Gossipable } from './gossipable.js';
-import { SignatureDomainSeparator, getHashedSignaturePayloadEthSignedMessage } from './signature_utils.js';
-import { TopicType } from './topic_type.js';
-
-export class BlockAttestationHash extends Buffer32 {
-  constructor(hash: Buffer) {
-    super(hash);
-  }
-}
-
-/**
- * BlockAttestation
- *
- * A validator that has attested to seeing the contents of a block
- * will produce a block attestation over the header of the block
- */
-export class BlockAttestation extends Gossipable {
-  static override p2pTopic = TopicType.block_attestation;
-
-  private sender: EthAddress | undefined;
-  private proposer: EthAddress | undefined;
-
-  constructor(
-    /** The payload of the message, and what the signature is over */
-    public readonly payload: ConsensusPayload,
-
-    /** The signature of the block attester */
-    public readonly signature: Signature,
-
-    /** The signature from the block proposer */
-    public readonly proposerSignature: Signature,
-  ) {
-    super();
-  }
-
-  static get schema(): ZodFor<BlockAttestation> {
-    return z
-      .object({
-        payload: ConsensusPayload.schema,
-        signature: Signature.schema,
-        proposerSignature: Signature.schema,
-      })
-      .transform(obj => new BlockAttestation(obj.payload, obj.signature, obj.proposerSignature));
-  }
-
-  override generateP2PMessageIdentifier(): Promise<Buffer32> {
-    return Promise.resolve(new BlockAttestationHash(keccak256(this.signature.toBuffer())));
-  }
-
-  get archive(): Fr {
-    return this.payload.archive;
-  }
-
-  get slotNumber(): SlotNumber {
-    return this.payload.header.slotNumber;
-  }
-
-  /**
-   * Lazily evaluate and cache the signer of the attestation
-   * @returns The signer of the attestation, or undefined if signature recovery fails
-   */
-  getSender(): EthAddress | undefined {
-    if (!this.sender) {
-      // Recover the sender from the attestation
-      const hashed = getHashedSignaturePayloadEthSignedMessage(this.payload, SignatureDomainSeparator.blockAttestation);
-      // Cache the sender for later use
-      this.sender = tryRecoverAddress(hashed, this.signature);
-    }
-
-    return this.sender;
-  }
-
-  /**
-   * Lazily evaluate and cache the proposer of the block
-   * @returns The proposer of the block
-   */
-  getProposer(): EthAddress | undefined {
-    if (!this.proposer) {
-      // Recover the proposer from the proposal signature
-      const hashed = getHashedSignaturePayloadEthSignedMessage(this.payload, SignatureDomainSeparator.blockProposal);
-      // Cache the proposer for later use
-      this.proposer = tryRecoverAddress(hashed, this.proposerSignature);
-    }
-
-    return this.proposer;
-  }
-
-  getPayload(): Buffer {
-    return this.payload.getPayloadToSign(SignatureDomainSeparator.blockAttestation);
-  }
-
-  toBuffer(): Buffer {
-    return serializeToBuffer([this.payload, this.signature, this.proposerSignature]);
-  }
-
-  static fromBuffer(buf: Buffer | BufferReader): BlockAttestation {
-    const reader = BufferReader.asReader(buf);
-    return new BlockAttestation(
-      reader.readObject(ConsensusPayload),
-      reader.readObject(Signature),
-      reader.readObject(Signature),
-    );
-  }
-
-  static empty(): BlockAttestation {
-    return new BlockAttestation(ConsensusPayload.empty(), Signature.empty(), Signature.empty());
-  }
-
-  static random(): BlockAttestation {
-    return new BlockAttestation(ConsensusPayload.random(), Signature.random(), Signature.random());
-  }
-
-  getSize(): number {
-    return this.payload.getSize() + this.signature.getSize() + this.proposerSignature.getSize();
-  }
-
-  toInspect() {
-    return {
-      payload: this.payload.toInspect(),
-      signature: this.signature.toString(),
-      proposerSignature: this.proposerSignature.toString(),
-    };
-  }
-}

package/src/slashing/empire.ts

@@ -1,102 +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: {
-      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}`);
-    }
-  }
-}

package/src/tx/content_commitment.ts

@@ -1,104 +0,0 @@
-import type { ViemContentCommitment } from '@aztec/ethereum';
-import { Fr } from '@aztec/foundation/fields';
-import { schemas } from '@aztec/foundation/schemas';
-import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
-import { bufferToHex } from '@aztec/foundation/string';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { z } from 'zod';
-
-export class ContentCommitment {
-  constructor(
-    public blobsHash: Fr,
-    public inHash: Fr,
-    public outHash: Fr,
-  ) {}
-
-  static get schema() {
-    return z
-      .object({
-        blobsHash: schemas.Fr,
-        inHash: schemas.Fr,
-        outHash: schemas.Fr,
-      })
-      .transform(({ blobsHash, inHash, outHash }) => new ContentCommitment(blobsHash, inHash, outHash));
-  }
-
-  static getFields(fields: FieldsOf<ContentCommitment>) {
-    return [fields.blobsHash, fields.inHash, fields.outHash] as const;
-  }
-
-  getSize() {
-    return this.toBuffer().length;
-  }
-
-  toBuffer() {
-    return serializeToBuffer(...ContentCommitment.getFields(this));
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader): ContentCommitment {
-    const reader = BufferReader.asReader(buffer);
-
-    return new ContentCommitment(reader.readObject(Fr), reader.readObject(Fr), reader.readObject(Fr));
-  }
-
-  toInspect() {
-    return {
-      blobsHash: this.blobsHash.toString(),
-      inHash: this.inHash.toString(),
-      outHash: this.outHash.toString(),
-    };
-  }
-
-  toViem(): ViemContentCommitment {
-    return {
-      blobsHash: this.blobsHash.toString(),
-      inHash: this.inHash.toString(),
-      outHash: this.outHash.toString(),
-    };
-  }
-
-  static fromViem(contentCommitment: ViemContentCommitment) {
-    return new ContentCommitment(
-      Fr.fromString(contentCommitment.blobsHash),
-      Fr.fromString(contentCommitment.inHash),
-      Fr.fromString(contentCommitment.outHash),
-    );
-  }
-
-  toFields(): Fr[] {
-    return serializeToFields(...ContentCommitment.getFields(this));
-  }
-
-  static fromFields(fields: Fr[] | FieldReader): ContentCommitment {
-    const reader = FieldReader.asReader(fields);
-    return new ContentCommitment(reader.readField(), reader.readField(), reader.readField());
-  }
-
-  static random(): ContentCommitment {
-    return new ContentCommitment(Fr.random(), Fr.random(), Fr.random());
-  }
-
-  static empty(): ContentCommitment {
-    return new ContentCommitment(Fr.zero(), Fr.zero(), Fr.zero());
-  }
-
-  isEmpty(): boolean {
-    return this.blobsHash.isZero() && this.inHash.isZero() && this.outHash.isZero();
-  }
-
-  public toString(): string {
-    return bufferToHex(this.toBuffer());
-  }
-
-  static fromString(str: string): ContentCommitment {
-    const buffer = Buffer.from(str.replace(/^0x/i, ''), 'hex');
-    return ContentCommitment.fromBuffer(buffer);
-  }
-
-  public equals(other: this): boolean {
-    return (
-      this.blobsHash.equals(other.blobsHash) && this.inHash.equals(other.inHash) && this.outHash.equals(other.outHash)
-    );
-  }
-}