@aztec/stdlib 0.0.1-commit.9b94fc1 → 0.0.1-commit.d3ec352c

package/src/note/note_dao.ts

@@ -1,4 +1,5 @@
 import { toBigIntBE } from '@aztec/foundation/bigint-buffer';
+import { BlockNumber } from '@aztec/foundation/branded-types';
 import { Fr, Point } from '@aztec/foundation/fields';
 import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
@@ -17,13 +18,15 @@ export class NoteDao {
     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 owner of the note - generally the account that can spend the note. */
+    public owner: 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 randomness injected to the note.
+     * The randomness injected to the note hash preimage.
      */
     public randomness: Fr,
     /** The nonce that was injected into the note hash preimage in order to guarantee uniqueness. */
@@ -48,7 +51,7 @@ export class NoteDao {
     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,
+    public l2BlockNumber: BlockNumber,
     /** The L2 block hash in which the tx with this note was included. Used for note management while processing
      * reorgs.*/
     public l2BlockHash: string,
@@ -60,6 +63,7 @@ export class NoteDao {
     return serializeToBuffer([
       this.note,
       this.contractAddress,
+      this.owner,
       this.storageSlot,
       this.randomness,
       this.noteNonce,
@@ -77,19 +81,21 @@ export class NoteDao {
 
     const note = Note.fromBuffer(reader);
     const contractAddress = AztecAddress.fromBuffer(reader);
+    const owner = AztecAddress.fromBuffer(reader);
     const storageSlot = Fr.fromBuffer(reader);
     const randomness = 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 l2BlockNumber = BlockNumber(reader.readNumber());
     const l2BlockHash = Fr.fromBuffer(reader).toString();
     const index = toBigIntBE(reader.readBytes(32));
 
     return new NoteDao(
       note,
       contractAddress,
+      owner,
       storageSlot,
       randomness,
       noteNonce,
@@ -118,25 +124,29 @@ export class NoteDao {
   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;
+    return (
+      noteSize + AztecAddress.SIZE_IN_BYTES * 2 + Fr.SIZE_IN_BYTES * 4 + TxHash.SIZE + Point.SIZE_IN_BYTES + indexSize
+    );
   }
 
   static async random({
     note = Note.random(),
     contractAddress = undefined,
+    owner = undefined,
     storageSlot = Fr.random(),
     randomness = Fr.random(),
     noteNonce = Fr.random(),
     noteHash = Fr.random(),
     siloedNullifier = Fr.random(),
     txHash = TxHash.random(),
-    l2BlockNumber = Math.floor(Math.random() * 1000),
+    l2BlockNumber = BlockNumber(Math.floor(Math.random() * 1000)),
     l2BlockHash = Fr.random().toString(),
     index = Fr.random().toBigInt(),
   }: Partial<NoteDao> = {}) {
     return new NoteDao(
       note,
       contractAddress ?? (await AztecAddress.random()),
+      owner ?? (await AztecAddress.random()),
       storageSlot,
       randomness,
       noteNonce,

package/src/note/notes_filter.ts

@@ -16,6 +16,8 @@ export type NotesFilter = {
    * @remarks Providing a contract address is required as we need that information to trigger private state sync.
    */
   contractAddress: AztecAddress;
+  /** The owner of the note. */
+  owner?: AztecAddress;
   /** The specific storage location of the note on the contract. */
   storageSlot?: Fr;
   /** The status of the note. Defaults to 'ACTIVE'. */
@@ -28,6 +30,7 @@ export type NotesFilter = {
 
 export const NotesFilterSchema: ZodFor<NotesFilter> = z.object({
   contractAddress: schemas.AztecAddress,
+  owner: schemas.AztecAddress.optional(),
   storageSlot: schemas.Fr.optional(),
   status: z.nativeEnum(NoteStatus).optional(),
   siloedNullifier: schemas.Fr.optional(),

package/src/rollup/checkpoint_header.ts

@@ -137,11 +137,13 @@ export class CheckpointHeader {
     });
   }
 
-  static random(overrides: Partial<FieldsOf<CheckpointHeader>> = {}): CheckpointHeader {
+  static random(
+    overrides: Partial<FieldsOf<CheckpointHeader>> & Partial<FieldsOf<ContentCommitment>> = {},
+  ): CheckpointHeader {
     return CheckpointHeader.from({
       lastArchiveRoot: Fr.random(),
       blockHeadersHash: Fr.random(),
-      contentCommitment: ContentCommitment.random(),
+      contentCommitment: ContentCommitment.random(overrides),
       slotNumber: SlotNumber(Math.floor(Math.random() * 1000) + 1),
       timestamp: BigInt(Math.floor(Date.now() / 1000)),
       coinbase: EthAddress.random(),

package/src/tests/factories.ts

@@ -43,7 +43,7 @@ import {
   VK_TREE_HEIGHT,
 } from '@aztec/constants';
 import { type FieldsOf, makeTuple } from '@aztec/foundation/array';
-import { SlotNumber } from '@aztec/foundation/branded-types';
+import { BlockNumber, SlotNumber } from '@aztec/foundation/branded-types';
 import { compact } from '@aztec/foundation/collection';
 import { Grumpkin, SchnorrSignature, poseidon2HashWithSeparator, sha256 } from '@aztec/foundation/crypto';
 import { EthAddress } from '@aztec/foundation/eth-address';
@@ -694,7 +694,7 @@ export function makeGlobalVariables(seed = 1, overrides: Partial<FieldsOf<Global
   return GlobalVariables.from({
     chainId: new Fr(seed),
     version: new Fr(seed + 1),
-    blockNumber: seed + 2,
+    blockNumber: BlockNumber(seed + 2),
     slotNumber: SlotNumber(seed + 3),
     timestamp: BigInt(seed + 4),
     coinbase: EthAddress.fromField(new Fr(seed + 5)),
@@ -916,8 +916,8 @@ export function makeL2BlockHeader(
     overrides?.contentCommitment ?? makeContentCommitment(seed + 0x200),
     overrides?.state ?? makeStateReference(seed + 0x600),
     makeGlobalVariables((seed += 0x700), {
-      ...(blockNumber ? { blockNumber } : {}),
-      ...(slotNumber ? { slotNumber: SlotNumber(slotNumber) } : {}),
+      ...(blockNumber !== undefined ? { blockNumber: BlockNumber(blockNumber) } : {}),
+      ...(slotNumber !== undefined ? { slotNumber: SlotNumber(slotNumber) } : {}),
     }),
     new Fr(seed + 0x800),
     new Fr(seed + 0x900),

package/src/tests/mocks.ts

@@ -7,6 +7,7 @@ import {
   MAX_TOTAL_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
 } from '@aztec/constants';
 import { makeTuple } from '@aztec/foundation/array';
+import { BlockNumber } from '@aztec/foundation/branded-types';
 import { Buffer32 } from '@aztec/foundation/buffer';
 import { padArrayEnd, times } from '@aztec/foundation/collection';
 import { Secp256k1Signer, randomBytes } from '@aztec/foundation/crypto';
@@ -513,7 +514,7 @@ export async function randomPublishedL2Block(
   l2BlockNumber: number,
   opts: { signers?: Secp256k1Signer[] } = {},
 ): Promise<PublishedL2Block> {
-  const block = await L2Block.random(l2BlockNumber);
+  const block = await L2Block.random(BlockNumber(l2BlockNumber));
   const l1 = L1PublishedData.fromFields({
     blockNumber: BigInt(block.number),
     timestamp: block.header.globalVariables.timestamp,

package/src/tx/block_header.ts

@@ -1,5 +1,5 @@
 import { BLOCK_HEADER_LENGTH, GeneratorIndex } from '@aztec/constants';
-import { SlotNumber } from '@aztec/foundation/branded-types';
+import { BlockNumber, SlotNumber } from '@aztec/foundation/branded-types';
 import { poseidon2HashWithSeparator, randomInt } from '@aztec/foundation/crypto';
 import { Fr } from '@aztec/foundation/fields';
 import { type ZodFor, schemas } from '@aztec/foundation/schemas';
@@ -66,7 +66,7 @@ export class BlockHeader {
     return this.globalVariables.slotNumber;
   }
 
-  getBlockNumber() {
+  getBlockNumber(): BlockNumber {
     return this.globalVariables.blockNumber;
   }
 

package/src/tx/content_commitment.ts

@@ -28,6 +28,10 @@ export class ContentCommitment {
     return [fields.blobsHash, fields.inHash, fields.outHash] as const;
   }
 
+  static from(fields: FieldsOf<ContentCommitment>) {
+    return new ContentCommitment(...ContentCommitment.getFields(fields));
+  }
+
   getSize() {
     return this.toBuffer().length;
   }
@@ -75,8 +79,13 @@ export class ContentCommitment {
     return new ContentCommitment(reader.readField(), reader.readField(), reader.readField());
   }
 
-  static random(): ContentCommitment {
-    return new ContentCommitment(Fr.random(), Fr.random(), Fr.random());
+  static random(overrides: Partial<FieldsOf<ContentCommitment>> = {}): ContentCommitment {
+    return ContentCommitment.from({
+      blobsHash: Fr.random(),
+      inHash: Fr.random(),
+      outHash: Fr.random(),
+      ...overrides,
+    });
   }
 
   static empty(): ContentCommitment {

package/src/tx/global_variables.ts

@@ -1,5 +1,5 @@
 import { GLOBAL_VARIABLES_LENGTH } from '@aztec/constants';
-import { SlotNumber } from '@aztec/foundation/branded-types';
+import { BlockNumber, BlockNumberSchema, SlotNumber } from '@aztec/foundation/branded-types';
 import { randomInt } from '@aztec/foundation/crypto';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
@@ -19,7 +19,7 @@ import { z } from 'zod';
 import { AztecAddress } from '../aztec-address/index.js';
 import { GasFees } from '../gas/gas_fees.js';
 import { schemas } from '../schemas/index.js';
-import type { UInt32, UInt64 } from '../types/index.js';
+import type { UInt64 } from '../types/index.js';
 
 /**
  * Global variables of the L2 block.
@@ -31,7 +31,7 @@ export class GlobalVariables {
     /** Version for the L2 block. */
     public version: Fr,
     /** Block number of the L2 block. */
-    public blockNumber: UInt32,
+    public blockNumber: BlockNumber,
     /** Slot number of the L2 block */
     public slotNumber: SlotNumber,
     /** Timestamp of the L2 block. */
@@ -49,7 +49,7 @@ export class GlobalVariables {
       .object({
         chainId: schemas.Fr,
         version: schemas.Fr,
-        blockNumber: schemas.UInt32,
+        blockNumber: BlockNumberSchema,
         slotNumber: schemas.SlotNumber,
         timestamp: schemas.BigInt,
         coinbase: schemas.EthAddress,
@@ -89,7 +89,7 @@ export class GlobalVariables {
 
   static empty(fields: Partial<FieldsOf<GlobalVariables>> = {}): GlobalVariables {
     return GlobalVariables.from({
-      blockNumber: 0,
+      blockNumber: BlockNumber.ZERO,
       slotNumber: SlotNumber.ZERO,
       timestamp: 0n,
       chainId: Fr.ZERO,
@@ -106,7 +106,7 @@ export class GlobalVariables {
     return new GlobalVariables(
       Fr.fromBuffer(reader),
       Fr.fromBuffer(reader),
-      reader.readNumber(),
+      BlockNumber(reader.readNumber()),
       SlotNumber(reader.readNumber()),
       reader.readUInt64(),
       reader.readObject(EthAddress),
@@ -121,7 +121,7 @@ export class GlobalVariables {
     return new GlobalVariables(
       reader.readField(),
       reader.readField(),
-      reader.readU32(),
+      BlockNumber(reader.readU32()),
       SlotNumber(reader.readU32()),
       reader.readField().toBigInt(),
       EthAddress.fromField(reader.readField()),
@@ -219,7 +219,7 @@ export class GlobalVariables {
     return GlobalVariables.from({
       chainId: new Fr(randomInt(100_000)),
       version: new Fr(randomInt(100_000)),
-      blockNumber: randomInt(100_000),
+      blockNumber: BlockNumber(randomInt(100_000)),
       slotNumber: SlotNumber(randomInt(100_000)),
       coinbase: EthAddress.random(),
       feeRecipient: AztecAddress.fromField(Fr.random()),

package/src/tx/indexed_tx_effect.ts

@@ -1,11 +1,12 @@
+import { BlockNumber } from '@aztec/foundation/branded-types';
 import { schemas } from '@aztec/foundation/schemas';
 import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 import { L2BlockHash } from '../block/block_hash.js';
-import { type InBlock, inBlockSchemaFor, randomInBlock } from '../block/in_block.js';
+import { type DataInBlock, inBlockSchemaFor, randomInBlock } from '../block/in_block.js';
 import { TxEffect } from './tx_effect.js';
 
-export type IndexedTxEffect = InBlock<TxEffect> & { txIndexInBlock: number };
+export type IndexedTxEffect = DataInBlock<TxEffect> & { txIndexInBlock: number };
 
 export function indexedTxSchema() {
   return inBlockSchemaFor(TxEffect.schema).extend({ txIndexInBlock: schemas.Integer });
@@ -26,7 +27,7 @@ export function deserializeIndexedTxEffect(buffer: Buffer): IndexedTxEffect {
   const reader = BufferReader.asReader(buffer);
 
   const l2BlockHash = reader.readObject(L2BlockHash);
-  const l2BlockNumber = reader.readNumber();
+  const l2BlockNumber = BlockNumber(reader.readNumber());
   const txIndexInBlock = reader.readNumber();
   const data = reader.readObject(TxEffect);
 

package/src/tx/private_execution_result.ts

@@ -1,3 +1,4 @@
+import type { BlockNumber } from '@aztec/foundation/branded-types';
 import { timesParallel } from '@aztec/foundation/collection';
 import { randomBytes, randomInt } from '@aztec/foundation/crypto';
 import { Fr } from '@aztec/foundation/fields';
@@ -13,7 +14,6 @@ import { ContractClassLog, ContractClassLogFields } from '../logs/contract_class
 import { type PreTag, PreTagSchema } from '../logs/pre_tag.js';
 import { Note } from '../note/note.js';
 import { type ZodFor, mapSchema, schemas } from '../schemas/index.js';
-import type { UInt32 } from '../types/index.js';
 import { HashedValues } from './hashed_values.js';
 import type { OffchainEffect } from './offchain_effect.js';
 
@@ -109,7 +109,7 @@ export class PrivateExecutionResult {
   /**
    * The anchor block number that this execution was simulated with.
    */
-  getSimulationAnchorBlockNumber(): UInt32 {
+  getSimulationAnchorBlockNumber(): BlockNumber {
     return this.entrypoint.publicInputs.anchorBlockHeader.globalVariables.blockNumber;
   }
 }

package/src/tx/processed_tx.ts

@@ -3,7 +3,7 @@ import { Fr } from '@aztec/foundation/fields';
 import type { AvmProvingRequest } from '../avm/avm_proving_request.js';
 import type { PublicDataWrite } from '../avm/public_data_write.js';
 import { RevertCode } from '../avm/revert_code.js';
-import type { SimulationError } from '../errors/simulation_error.js';
+import { SimulationError } from '../errors/simulation_error.js';
 import { Gas } from '../gas/gas.js';
 import type { GasUsed } from '../gas/gas_used.js';
 import { computeL2ToL1MessageHash } from '../hash/hash.js';
@@ -173,6 +173,12 @@ export function makeProcessedTxFromTxWithPublicCalls(
     contractClassLogs,
   );
 
+  // Some callers expect a revert reason if the tx reverted.
+  const finalRevertReason =
+    revertReason === undefined && !revertCode.isOK()
+      ? new SimulationError('TX reverted', /*functionErrorStack=*/ [], /*revertData=*/ [])
+      : revertReason;
+
   return {
     hash: txEffect.txHash,
     data: tx.data,
@@ -182,6 +188,6 @@ export function makeProcessedTxFromTxWithPublicCalls(
     txEffect,
     gasUsed,
     revertCode,
-    revertReason,
+    revertReason: finalRevertReason,
   };
 }

package/src/tx/tx.ts

@@ -300,8 +300,9 @@ export class Tx extends Gossipable {
   }
 
   /** Recomputes the tx hash. Used for testing purposes only when a property of the tx was mutated. */
-  public async recomputeHash() {
+  public async recomputeHash(): Promise<TxHash> {
     (this as any).txHash = await Tx.computeTxHash(this);
+    return this.txHash;
   }
 
   #combinePublicCallRequestWithCallData(request: PublicCallRequest) {

package/src/tx/tx_receipt.ts

@@ -1,3 +1,4 @@
+import { BlockNumber, BlockNumberSchema } from '@aztec/foundation/branded-types';
 import type { FieldsOf } from '@aztec/foundation/types';
 
 import { z } from 'zod';
@@ -38,7 +39,7 @@ export class TxReceipt {
     /** The hash of the block containing the transaction. */
     public blockHash?: L2BlockHash,
     /** The block number in which the transaction was included. */
-    public blockNumber?: number,
+    public blockNumber?: BlockNumber,
   ) {}
 
   static empty() {
@@ -52,7 +53,7 @@ export class TxReceipt {
         status: z.nativeEnum(TxStatus),
         error: z.string(),
         blockHash: L2BlockHash.schema.optional(),
-        blockNumber: z.number().int().nonnegative().optional(),
+        blockNumber: BlockNumberSchema.optional(),
         transactionFee: schemas.BigInt.optional(),
       })
       .transform(TxReceipt.from);

package/dest/block/l2_block_number.d.ts

@@ -1,5 +0,0 @@
-import { z } from 'zod';
-export declare const L2BlockNumberSchema: z.ZodUnion<[z.ZodPipeline<z.ZodUnion<[z.ZodBigInt, z.ZodNumber, z.ZodString]>, z.ZodNumber>, z.ZodLiteral<"latest">]>;
-/** Helper type for a specific L2 block number or the latest block number */
-export type L2BlockNumber = z.infer<typeof L2BlockNumberSchema>;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibDJfYmxvY2tfbnVtYmVyLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYmxvY2svbDJfYmxvY2tfbnVtYmVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxDQUFDLEVBQUUsTUFBTSxLQUFLLENBQUM7QUFJeEIsZUFBTyxNQUFNLG1CQUFtQix1SEFBa0QsQ0FBQztBQUVuRiw0RUFBNEU7QUFDNUUsTUFBTSxNQUFNLGFBQWEsR0FBRyxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sbUJBQW1CLENBQUMsQ0FBQyJ9

package/dest/block/l2_block_number.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"l2_block_number.d.ts","sourceRoot":"","sources":["../../src/block/l2_block_number.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,mBAAmB,uHAAkD,CAAC;AAEnF,4EAA4E;AAC5E,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC"}

package/dest/block/l2_block_number.js

@@ -1,6 +0,0 @@
-import { z } from 'zod';
-import { schemas } from '../schemas/index.js';
-export const L2BlockNumberSchema = z.union([
-    schemas.Integer,
-    z.literal('latest')
-]);

package/src/block/l2_block_number.ts

@@ -1,8 +0,0 @@
-import { z } from 'zod';
-
-import { schemas } from '../schemas/index.js';
-
-export const L2BlockNumberSchema = z.union([schemas.Integer, z.literal('latest')]);
-
-/** Helper type for a specific L2 block number or the latest block number */
-export type L2BlockNumber = z.infer<typeof L2BlockNumberSchema>;