@aztec/stdlib 0.0.1-commit.b655e406 → 0.0.1-commit.fce3e4f

package/src/rollup/checkpoint_header.ts

@@ -1,4 +1,5 @@
 import type { ViemHeader } from '@aztec/ethereum';
+import { SlotNumber } from '@aztec/foundation/branded-types';
 import { sha256ToField } from '@aztec/foundation/crypto';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
@@ -20,10 +21,12 @@ export class CheckpointHeader {
   constructor(
     /** Root of the archive tree before this block is added. */
     public lastArchiveRoot: Fr,
+    /** Hash of the headers of all blocks in this checkpoint. */
+    public blockHeadersHash: Fr,
     /** Content commitment of the L2 block. */
     public contentCommitment: ContentCommitment,
     /** Slot number of the L2 block */
-    public slotNumber: Fr,
+    public slotNumber: SlotNumber,
     /** Timestamp of the L2 block. */
     public timestamp: UInt64,
     /** Recipient of block reward. */
@@ -40,8 +43,9 @@ export class CheckpointHeader {
     return z
       .object({
         lastArchiveRoot: schemas.Fr,
+        blockHeadersHash: schemas.Fr,
         contentCommitment: ContentCommitment.schema,
-        slotNumber: schemas.Fr,
+        slotNumber: schemas.SlotNumber,
         timestamp: schemas.BigInt,
         coinbase: schemas.EthAddress,
         feeRecipient: schemas.AztecAddress,
@@ -54,6 +58,7 @@ export class CheckpointHeader {
   static getFields(fields: FieldsOf<CheckpointHeader>) {
     return [
       fields.lastArchiveRoot,
+      fields.blockHeadersHash,
       fields.contentCommitment,
       fields.slotNumber,
       fields.timestamp,
@@ -72,9 +77,10 @@ export class CheckpointHeader {
     const reader = BufferReader.asReader(buffer);
 
     return new CheckpointHeader(
+      reader.readObject(Fr),
       reader.readObject(Fr),
       reader.readObject(ContentCommitment),
-      Fr.fromBuffer(reader),
+      SlotNumber(Fr.fromBuffer(reader).toNumber()),
       reader.readUInt64(),
       reader.readObject(EthAddress),
       reader.readObject(AztecAddress),
@@ -86,8 +92,9 @@ export class CheckpointHeader {
   equals(other: CheckpointHeader) {
     return (
       this.lastArchiveRoot.equals(other.lastArchiveRoot) &&
+      this.blockHeadersHash.equals(other.blockHeadersHash) &&
       this.contentCommitment.equals(other.contentCommitment) &&
-      this.slotNumber.equals(other.slotNumber) &&
+      this.slotNumber === other.slotNumber &&
       this.timestamp === other.timestamp &&
       this.coinbase.equals(other.coinbase) &&
       this.feeRecipient.equals(other.feeRecipient) &&
@@ -100,8 +107,9 @@ export class CheckpointHeader {
     // Note: The order here must match the order in the ProposedHeaderLib solidity library.
     return serializeToBuffer([
       this.lastArchiveRoot,
+      this.blockHeadersHash,
       this.contentCommitment,
-      this.slotNumber,
+      new Fr(this.slotNumber),
       bigintToUInt64BE(this.timestamp),
       this.coinbase,
       this.feeRecipient,
@@ -117,8 +125,9 @@ export class CheckpointHeader {
   static empty(fields: Partial<FieldsOf<CheckpointHeader>> = {}) {
     return CheckpointHeader.from({
       lastArchiveRoot: Fr.ZERO,
+      blockHeadersHash: Fr.ZERO,
       contentCommitment: ContentCommitment.empty(),
-      slotNumber: Fr.ZERO,
+      slotNumber: SlotNumber.ZERO,
       timestamp: 0n,
       coinbase: EthAddress.ZERO,
       feeRecipient: AztecAddress.ZERO,
@@ -128,24 +137,27 @@ export class CheckpointHeader {
     });
   }
 
-  static random(): CheckpointHeader {
-    return new CheckpointHeader(
-      Fr.random(),
-      ContentCommitment.random(),
-      new Fr(BigInt(Math.floor(Math.random() * 1000) + 1)),
-      BigInt(Math.floor(Date.now() / 1000)),
-      EthAddress.random(),
-      new AztecAddress(Fr.random()),
-      GasFees.random(),
-      new Fr(BigInt(Math.floor(Math.random() * 1000000))),
-    );
+  static random(overrides: Partial<FieldsOf<CheckpointHeader>> = {}): CheckpointHeader {
+    return CheckpointHeader.from({
+      lastArchiveRoot: Fr.random(),
+      blockHeadersHash: Fr.random(),
+      contentCommitment: ContentCommitment.random(),
+      slotNumber: SlotNumber(Math.floor(Math.random() * 1000) + 1),
+      timestamp: BigInt(Math.floor(Date.now() / 1000)),
+      coinbase: EthAddress.random(),
+      feeRecipient: new AztecAddress(Fr.random()),
+      gasFees: GasFees.random(),
+      totalManaUsed: new Fr(BigInt(Math.floor(Math.random() * 1000000))),
+      ...overrides,
+    });
   }
 
   isEmpty(): boolean {
     return (
       this.lastArchiveRoot.isZero() &&
+      this.blockHeadersHash.isZero() &&
       this.contentCommitment.isEmpty() &&
-      this.slotNumber.isZero() &&
+      this.slotNumber === 0 &&
       this.timestamp === 0n &&
       this.coinbase.isZero() &&
       this.feeRecipient.isZero() &&
@@ -169,8 +181,9 @@ export class CheckpointHeader {
   static fromViem(header: ViemHeader) {
     return new CheckpointHeader(
       Fr.fromString(header.lastArchiveRoot),
+      Fr.fromString(header.blockHeadersHash),
       ContentCommitment.fromViem(header.contentCommitment),
-      new Fr(header.slotNumber),
+      SlotNumber.fromBigInt(header.slotNumber),
       header.timestamp,
       new EthAddress(hexToBuffer(header.coinbase)),
       new AztecAddress(hexToBuffer(header.feeRecipient)),
@@ -179,11 +192,20 @@ export class CheckpointHeader {
     );
   }
 
+  /**
+   * Returns the slot number as a SlotNumber branded type.
+   * @deprecated Use slotNumber directly instead.
+   */
+  getSlotNumber(): SlotNumber {
+    return this.slotNumber;
+  }
+
   toViem(): ViemHeader {
     return {
       lastArchiveRoot: this.lastArchiveRoot.toString(),
+      blockHeadersHash: this.blockHeadersHash.toString(),
       contentCommitment: this.contentCommitment.toViem(),
-      slotNumber: this.slotNumber.toBigInt(),
+      slotNumber: BigInt(this.slotNumber),
       timestamp: this.timestamp,
       coinbase: this.coinbase.toString(),
       feeRecipient: `0x${this.feeRecipient.toBuffer().toString('hex').padStart(64, '0')}`,
@@ -198,8 +220,9 @@ export class CheckpointHeader {
   toInspect() {
     return {
       lastArchive: this.lastArchiveRoot.toString(),
+      blockHeadersHash: this.blockHeadersHash.toString(),
       contentCommitment: this.contentCommitment.toInspect(),
-      slotNumber: this.slotNumber.toBigInt(),
+      slotNumber: this.slotNumber,
       timestamp: this.timestamp,
       coinbase: this.coinbase.toString(),
       feeRecipient: this.feeRecipient.toString(),
@@ -212,8 +235,9 @@ export class CheckpointHeader {
     const gasfees = `da:${this.gasFees.feePerDaGas}, l2:${this.gasFees.feePerL2Gas}`;
     return `Header {
   lastArchiveRoot: ${this.lastArchiveRoot.toString()},
+  blockHeadersHash: ${this.blockHeadersHash.toString()},
   contentCommitment: ${inspect(this.contentCommitment)},
-  slotNumber: ${this.slotNumber.toBigInt()},
+  slotNumber: ${this.slotNumber},
   timestamp: ${this.timestamp},
   coinbase: ${this.coinbase.toString()},
   feeRecipient: ${this.feeRecipient.toString()},

package/src/rollup/checkpoint_root_rollup_private_inputs.ts

@@ -1,5 +1,5 @@
 import { BlobAccumulator, FinalBlobBatchingChallenges } from '@aztec/blob-lib/types';
-import { ARCHIVE_HEIGHT, BLOBS_PER_BLOCK, FIELDS_PER_BLOB } from '@aztec/constants';
+import { ARCHIVE_HEIGHT, BLOBS_PER_CHECKPOINT, FIELDS_PER_BLOB } from '@aztec/constants';
 import { BLS12Point, Fr } from '@aztec/foundation/fields';
 import { bufferSchemaFor } from '@aztec/foundation/schemas';
 import { BufferReader, type Tuple, serializeToBuffer } from '@aztec/foundation/serialize';
@@ -31,13 +31,13 @@ export class CheckpointRootRollupHints {
     /**
      * Flat list of all tx effects which will be added to the blob.
      * Below line gives error 'Type instantiation is excessively deep and possibly infinite. ts(2589)'
-     * Tuple<Fr, FIELDS_PER_BLOB * BLOBS_PER_BLOCK>
+     * Tuple<Fr, FIELDS_PER_BLOB * BLOBS_PER_CHECKPOINT>
      */
     public blobFields: Fr[],
     /**
      * KZG commitments representing the blob (precomputed in ts, injected to use inside circuit).
      */
-    public blobCommitments: Tuple<BLS12Point, typeof BLOBS_PER_BLOCK>,
+    public blobCommitments: Tuple<BLS12Point, typeof BLOBS_PER_CHECKPOINT>,
     /**
      * The hash of eth blob hashes for this block
      * See yarn-project/foundation/src/blob/index.ts or body.ts for calculation
@@ -74,8 +74,8 @@ export class CheckpointRootRollupHints {
       reader.readObject(FinalBlobBatchingChallenges),
       // Below line gives error 'Type instantiation is excessively deep and possibly infinite. ts(2589)'
       // reader.readArray(FIELDS_PER_BLOB, Fr),
-      Array.from({ length: FIELDS_PER_BLOB * BLOBS_PER_BLOCK }, () => Fr.fromBuffer(reader)),
-      reader.readArray(BLOBS_PER_BLOCK, BLS12Point),
+      Array.from({ length: FIELDS_PER_BLOB * BLOBS_PER_CHECKPOINT }, () => Fr.fromBuffer(reader)),
+      reader.readArray(BLOBS_PER_CHECKPOINT, BLS12Point),
       Fr.fromBuffer(reader),
     );
   }

package/src/rollup/index.ts

@@ -1,6 +1,7 @@
 export * from './avm_proof_data.js';
 export * from './base_rollup_hints.js';
 export * from './block_constant_data.js';
+export * from './block_headers_hash.js';
 export * from './block_merge_rollup_private_inputs.js';
 export * from './block_rollup_public_inputs.js';
 export * from './block_root_rollup_private_inputs.js';

package/src/schemas/schemas.ts

@@ -1,3 +1,4 @@
+import type { EpochNumber, SlotNumber } from '@aztec/foundation/branded-types';
 import type { Buffer32 } from '@aztec/foundation/buffer';
 import type { EthAddress } from '@aztec/foundation/eth-address';
 import type { Fq, Fr, Point } from '@aztec/foundation/fields';
@@ -10,6 +11,7 @@ import { EventSelector } from '../abi/event_selector.js';
 import { FunctionSelector } from '../abi/function_selector.js';
 import { NoteSelector } from '../abi/note_selector.js';
 import { AztecAddress } from '../aztec-address/index.js';
+import { Gas } from '../gas/gas.js';
 
 /**
  * Validation schemas for common types. Every schema must match its toJSON.
@@ -63,6 +65,19 @@ export const schemas = {
 
   /** Accepts a hex string. */
   EventSelector: EventSelector.schema,
+
+  /** Accepts a number, bigint, or string and coerces to SlotNumber. */
+  SlotNumber: foundationSchemas.SlotNumber as ZodFor<SlotNumber>,
+
+  /** Accepts a number, bigint, or string and coerces to EpochNumber. */
+  EpochNumber: foundationSchemas.EpochNumber as ZodFor<EpochNumber>,
+
+  GasUsed: z.object({
+    totalGas: Gas.schema,
+    teardownGas: Gas.schema,
+    publicGas: Gas.schema,
+    billedGas: Gas.schema,
+  }),
 };
 
 export const AbiDecodedSchema: ZodFor<AbiDecoded> = z.union([
@@ -73,6 +88,9 @@ export const AbiDecodedSchema: ZodFor<AbiDecoded> = z.union([
   z.record(z.lazy(() => AbiDecodedSchema)),
 ]);
 
+// C++ only supports null values, which we want to convert to undefined.
+export const NullishToUndefined = (schema: ZodFor<any>) => schema.nullish().transform(x => x ?? undefined);
+
 export {
   type ZodFor,
   bufferSchema,

package/src/slashing/empire.ts

@@ -1,3 +1,5 @@
+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';
@@ -66,7 +68,7 @@ export function getFirstEligibleRoundForOffense(
     // 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 = epoch + 1n;
+      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
@@ -74,7 +76,7 @@ export function getFirstEligibleRoundForOffense(
     case OffenseType.DATA_WITHHOLDING: {
       // TODO(palla/slash): Check for off-by-ones especially here
       const epoch = offense.epochOrSlot;
-      const detectedEpoch = epoch + BigInt(constants.proofSubmissionEpochs);
+      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
@@ -83,13 +85,13 @@ export function getFirstEligibleRoundForOffense(
     case OffenseType.ATTESTED_DESCENDANT_OF_INVALID:
     case OffenseType.BROADCASTED_INVALID_BLOCK_PROPOSAL: {
       const slot = offense.epochOrSlot;
-      const detectedSlot = slot + 1n;
+      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 = epoch + 1n;
+      const detectedEpoch = EpochNumber.fromBigInt(epoch + 1n);
       return getRoundsForEpoch(detectedEpoch, constants)[0] + 1n;
     }
     default: {

package/src/slashing/helpers.ts

@@ -1,21 +1,24 @@
+import { EpochNumber, SlotNumber } from '@aztec/foundation/branded-types';
+
 import { type L1RollupConstants, getEpochAtSlot, getSlotRangeForEpoch } from '../epoch-helpers/index.js';
 import type { SlasherConfig } from '../interfaces/slasher.js';
 import { type Offense, OffenseType } from './types.js';
 
 /** Returns the voting round number and voting slot within the round for a given L2 slot. */
 export function getRoundForSlot(
-  slot: bigint,
+  slot: SlotNumber,
   constants: { slashingRoundSize: number },
-): { round: bigint; votingSlot: bigint } {
+): { round: bigint; votingSlot: SlotNumber } {
   const roundSize = BigInt(constants.slashingRoundSize);
-  const round = slot / roundSize;
-  const votingSlot = slot % roundSize;
+  const slotBigInt = BigInt(slot);
+  const round = slotBigInt / roundSize;
+  const votingSlot = SlotNumber.fromBigInt(slotBigInt % roundSize);
   return { round, votingSlot };
 }
 
 /** Returns the voting round(s) lower and upper bounds (inclusive) covered by the given epoch */
 export function getRoundsForEpoch(
-  epoch: bigint,
+  epoch: EpochNumber,
   constants: { slashingRoundSize: number; epochDuration: number },
 ): [bigint, bigint] {
   const [start, end] = getSlotRangeForEpoch(epoch, constants);
@@ -28,13 +31,13 @@ export function getRoundsForEpoch(
 export function getEpochsForRound(
   round: bigint,
   constants: { slashingRoundSize: number; epochDuration: number },
-): bigint[] {
-  const epochs: bigint[] = [];
-  const firstSlot = round * BigInt(constants.slashingRoundSize);
-  const lastSlot = firstSlot + BigInt(constants.slashingRoundSize) - 1n;
+): EpochNumber[] {
+  const epochs: EpochNumber[] = [];
+  const firstSlot = SlotNumber.fromBigInt(round * BigInt(constants.slashingRoundSize));
+  const lastSlot = SlotNumber(firstSlot + constants.slashingRoundSize - 1);
   const startEpoch = getEpochAtSlot(firstSlot, constants);
   const endEpoch = getEpochAtSlot(lastSlot, constants);
-  for (let epoch = startEpoch; epoch <= endEpoch; epoch++) {
+  for (let epoch = startEpoch; epoch <= endEpoch; epoch = EpochNumber(epoch + 1)) {
     epochs.push(epoch);
   }
   return epochs;
@@ -101,9 +104,11 @@ export function getTimeUnitForOffense(offense: OffenseType): 'epoch' | 'slot' {
 export function getSlotForOffense(
   offense: Pick<Offense, 'epochOrSlot' | 'offenseType'>,
   constants: Pick<L1RollupConstants, 'epochDuration'>,
-): bigint {
+): SlotNumber {
   const { epochOrSlot, offenseType } = offense;
-  return getTimeUnitForOffense(offenseType) === 'epoch' ? epochOrSlot * BigInt(constants.epochDuration) : epochOrSlot;
+  return getTimeUnitForOffense(offenseType) === 'epoch'
+    ? SlotNumber.fromBigInt(epochOrSlot * BigInt(constants.epochDuration))
+    : SlotNumber.fromBigInt(epochOrSlot);
 }
 
 /** Returns the epoch for a given offense. If the offense type or epoch is not defined, returns undefined. */

package/src/slashing/interfaces.ts

@@ -1,3 +1,5 @@
+import type { SlotNumber } from '@aztec/foundation/branded-types';
+
 import type { ProposerSlashAction } from './types.js';
 
 export interface ProposerSlashActionProvider {
@@ -7,5 +9,5 @@ export interface ProposerSlashActionProvider {
    * @param slotNumber - The current slot number
    * @returns The actions to take
    */
-  getProposerActions(slotNumber: bigint): Promise<ProposerSlashAction[]>;
+  getProposerActions(slotNumber: SlotNumber): Promise<ProposerSlashAction[]>;
 }