@aztec/stdlib 1.0.0 → 1.1.2

package/src/tx/include_by_timestamp.ts

@@ -0,0 +1,90 @@
+import { INCLUDE_BY_TIMESTAMP_LENGTH } from '@aztec/constants';
+import { Fr } from '@aztec/foundation/fields';
+import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
+import type { FieldsOf } from '@aztec/foundation/types';
+
+import type { UInt64 } from '../types/index.js';
+
+/**
+ * Maximum block timestamp value at which the transaction can still be included.
+ */
+export class IncludeByTimestamp {
+  constructor(
+    /**
+     * Whether max inclusion timestamp was requested.
+     */
+    public isSome: boolean,
+    /**
+     * The requested max inclusion timestamp of a block, if isSome is true.
+     */
+    public value: UInt64,
+  ) {
+    // For sanity we check that the value is less than 2 ** 64.
+    if (value >= 1n << 64n) {
+      throw new Error('Value is not a u64.');
+    }
+  }
+
+  /**
+   * Serialize as a buffer.
+   * @returns The buffer.
+   */
+  toBuffer() {
+    return serializeToBuffer(...IncludeByTimestamp.getFields(this));
+  }
+
+  toFields(): Fr[] {
+    const fields = serializeToFields(...IncludeByTimestamp.getFields(this));
+    if (fields.length !== INCLUDE_BY_TIMESTAMP_LENGTH) {
+      throw new Error(
+        `Invalid number of fields for IncludeByTimestamp. Expected ${INCLUDE_BY_TIMESTAMP_LENGTH}, got ${fields.length}`,
+      );
+    }
+    return fields;
+  }
+
+  /**
+   * Deserializes IncludeByTimestamp from a buffer or reader.
+   * @param buffer - Buffer to read from.
+   * @returns The IncludeByTimestamp.
+   */
+  static fromBuffer(buffer: Buffer | BufferReader): IncludeByTimestamp {
+    const reader = BufferReader.asReader(buffer);
+    const isSome = reader.readBoolean();
+    // UInt64 is aliased to bigint in TypeScript, causing it to be serialized as a 256-bit integer.
+    // Therefore, we must read it back using readUInt256() rather than readUInt64().
+    const value = reader.readUInt256();
+    return new IncludeByTimestamp(isSome, value);
+  }
+
+  static fromFields(fields: Fr[] | FieldReader): IncludeByTimestamp {
+    const reader = FieldReader.asReader(fields);
+    return new IncludeByTimestamp(reader.readBoolean(), reader.readU64());
+  }
+
+  static empty() {
+    return new IncludeByTimestamp(false, 0n);
+  }
+
+  isEmpty(): boolean {
+    return !this.isSome && this.value === 0n;
+  }
+
+  /**
+   * Create a new instance from a fields dictionary.
+   * @param fields - The dictionary.
+   * @returns A new instance.
+   */
+  static from(fields: FieldsOf<IncludeByTimestamp>): IncludeByTimestamp {
+    return new IncludeByTimestamp(...IncludeByTimestamp.getFields(fields));
+  }
+
+  /**
+   * Serialize into a field array. Low-level utility.
+   * @param fields - Object with fields.
+   * @returns The array.
+   */
+  static getFields(fields: FieldsOf<IncludeByTimestamp>) {
+    return [fields.isSome, fields.value] as const;
+  }
+}

package/src/tx/index.ts

@@ -1,7 +1,7 @@
 export * from './block_header.js';
 export * from './call_context.js';
 export * from './global_variables.js';
-export * from './max_block_number.js';
+export * from './include_by_timestamp.js';
 export * from './content_commitment.js';
 export * from './state_reference.js';
 export * from './partial_state_reference.js';

package/src/tx/offchain_effect.ts

@@ -2,6 +2,7 @@ import { Fr } from '@aztec/foundation/fields';
 
 import type { AztecAddress } from '../aztec-address/index.js';
 
+// The following identifier was copied over from `noir-projects/aztec-nr/aztec/src/messages/offchain_messages.nr`.
 // poseidon2hash("aztecnr_offchain_message")
 export const OFFCHAIN_MESSAGE_IDENTIFIER: Fr = new Fr(
   6023466688192654631553769360478808766602235351827869819420284624004071427516n,

package/src/tx/validator/error_texts.ts

@@ -11,10 +11,10 @@ export const TX_ERROR_DUPLICATE_NULLIFIER_IN_TX = 'Duplicate nullifier in tx';
 export const TX_ERROR_EXISTING_NULLIFIER = 'Existing nullifier';
 
 // Metadata
-export const TX_ERROR_INVALID_MAX_BLOCK_NUMBER = 'Invalid max block number';
+export const TX_ERROR_INVALID_INCLUDE_BY_TIMESTAMP = 'Invalid expiration timestamp';
 export const TX_ERROR_INCORRECT_L1_CHAIN_ID = 'Incorrect L1 chain id';
 export const TX_ERROR_INCORRECT_ROLLUP_VERSION = 'Incorrect rollup version';
-export const TX_ERROR_INCORRECT_VK_TREE_ROOT = 'Incorrect protocol circuits tree root';
+export const TX_ERROR_INCORRECT_VK_TREE_ROOT = 'Incorrect verification keys tree root';
 export const TX_ERROR_INCORRECT_PROTOCOL_CONTRACT_TREE_ROOT = 'Incorrect protocol contracts tree root';
 
 // Proof

package/src/types/shared.ts

@@ -44,12 +44,3 @@ export enum CircuitType {
   STANDARD = 0,
   ULTRA = 1,
 }
-
-/**
- * Rollup types.
- */
-export enum RollupTypes {
-  Base = 0,
-  Merge = 1,
-  Root = 2,
-}

package/src/vks/verification_key.ts

@@ -9,6 +9,7 @@ import { bufferSchemaFor } from '@aztec/foundation/schemas';
 import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 import { bufferToHex, hexToBuffer } from '@aztec/foundation/string';
 
+import { hashVK } from '../hash/index.js';
 import { CircuitType } from '../types/shared.js';
 
 /**
@@ -93,6 +94,11 @@ export class VerificationKeyAsFields {
     public hash: Fr,
   ) {}
 
+  static async fromKey(key: Fr[]) {
+    const hash = await hashVK(key);
+    return new VerificationKeyAsFields(key, hash);
+  }
+
   public get numPublicInputs() {
     return Number(this.key[CIRCUIT_PUBLIC_INPUTS_INDEX]);
   }

package/dest/tx/max_block_number.d.ts

@@ -1,54 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { BufferReader, FieldReader } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-import type { UInt32 } from '../types/index.js';
-/**
- * Maximum block number.
- */
-export declare class MaxBlockNumber {
-    /**
-     * Whether a max block number was requested.
-     */
-    isSome: boolean;
-    /**
-     * The requested max block number, if isSome is true.
-     */
-    value: UInt32;
-    constructor(
-    /**
-     * Whether a max block number was requested.
-     */
-    isSome: boolean, 
-    /**
-     * The requested max block number, if isSome is true.
-     */
-    value: UInt32);
-    /**
-     * Serialize as a buffer.
-     * @returns The buffer.
-     */
-    toBuffer(): Buffer<ArrayBufferLike>;
-    toFields(): Fr[];
-    /**
-     * Deserializes MaxBlockNumber from a buffer or reader.
-     * @param buffer - Buffer to read from.
-     * @returns The MaxBlockNumber.
-     */
-    static fromBuffer(buffer: Buffer | BufferReader): MaxBlockNumber;
-    static fromFields(fields: Fr[] | FieldReader): MaxBlockNumber;
-    static empty(): MaxBlockNumber;
-    isEmpty(): boolean;
-    /**
-     * Create a new instance from a fields dictionary.
-     * @param fields - The dictionary.
-     * @returns A new instance.
-     */
-    static from(fields: FieldsOf<MaxBlockNumber>): MaxBlockNumber;
-    /**
-     * Serialize into a field array. Low-level utility.
-     * @param fields - Object with fields.
-     * @returns The array.
-     */
-    static getFields(fields: FieldsOf<MaxBlockNumber>): readonly [boolean, number];
-}
-//# sourceMappingURL=max_block_number.d.ts.map

package/dest/tx/max_block_number.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"max_block_number.d.ts","sourceRoot":"","sources":["../../src/tx/max_block_number.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,WAAW,EAAwC,MAAM,6BAA6B,CAAC;AAC9G,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;GAEG;AACH,qBAAa,cAAc;IAEvB;;OAEG;IACI,MAAM,EAAE,OAAO;IACtB;;OAEG;IACI,KAAK,EAAE,MAAM;;IAPpB;;OAEG;IACI,MAAM,EAAE,OAAO;IACtB;;OAEG;IACI,KAAK,EAAE,MAAM;IAGtB;;;OAGG;IACH,QAAQ;IAIR,QAAQ,IAAI,EAAE,EAAE;IAUhB;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,cAAc;IAKhE,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,EAAE,GAAG,WAAW,GAAG,cAAc;IAK7D,MAAM,CAAC,KAAK;IAIZ,OAAO,IAAI,OAAO;IAIlB;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,GAAG,cAAc;IAI7D;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC;CAGlD"}

package/dest/tx/max_block_number.js

@@ -1,64 +0,0 @@
-import { MAX_BLOCK_NUMBER_LENGTH } from '@aztec/constants';
-import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
-/**
- * Maximum block number.
- */ export class MaxBlockNumber {
-    isSome;
-    value;
-    constructor(/**
-     * Whether a max block number was requested.
-     */ isSome, /**
-     * The requested max block number, if isSome is true.
-     */ value){
-        this.isSome = isSome;
-        this.value = value;
-    }
-    /**
-   * Serialize as a buffer.
-   * @returns The buffer.
-   */ toBuffer() {
-        return serializeToBuffer(...MaxBlockNumber.getFields(this));
-    }
-    toFields() {
-        const fields = serializeToFields(...MaxBlockNumber.getFields(this));
-        if (fields.length !== MAX_BLOCK_NUMBER_LENGTH) {
-            throw new Error(`Invalid number of fields for MaxBlockNumber. Expected ${MAX_BLOCK_NUMBER_LENGTH}, got ${fields.length}`);
-        }
-        return fields;
-    }
-    /**
-   * Deserializes MaxBlockNumber from a buffer or reader.
-   * @param buffer - Buffer to read from.
-   * @returns The MaxBlockNumber.
-   */ static fromBuffer(buffer) {
-        const reader = BufferReader.asReader(buffer);
-        return new MaxBlockNumber(reader.readBoolean(), reader.readNumber());
-    }
-    static fromFields(fields) {
-        const reader = FieldReader.asReader(fields);
-        return new MaxBlockNumber(reader.readBoolean(), reader.readU32());
-    }
-    static empty() {
-        return new MaxBlockNumber(false, 0);
-    }
-    isEmpty() {
-        return !this.isSome && this.value === 0;
-    }
-    /**
-   * Create a new instance from a fields dictionary.
-   * @param fields - The dictionary.
-   * @returns A new instance.
-   */ static from(fields) {
-        return new MaxBlockNumber(...MaxBlockNumber.getFields(fields));
-    }
-    /**
-   * Serialize into a field array. Low-level utility.
-   * @param fields - Object with fields.
-   * @returns The array.
-   */ static getFields(fields) {
-        return [
-            fields.isSome,
-            fields.value
-        ];
-    }
-}

package/src/tx/max_block_number.ts

@@ -1,81 +0,0 @@
-import { MAX_BLOCK_NUMBER_LENGTH } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
-import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import type { UInt32 } from '../types/index.js';
-
-/**
- * Maximum block number.
- */
-export class MaxBlockNumber {
-  constructor(
-    /**
-     * Whether a max block number was requested.
-     */
-    public isSome: boolean,
-    /**
-     * The requested max block number, if isSome is true.
-     */
-    public value: UInt32,
-  ) {}
-
-  /**
-   * Serialize as a buffer.
-   * @returns The buffer.
-   */
-  toBuffer() {
-    return serializeToBuffer(...MaxBlockNumber.getFields(this));
-  }
-
-  toFields(): Fr[] {
-    const fields = serializeToFields(...MaxBlockNumber.getFields(this));
-    if (fields.length !== MAX_BLOCK_NUMBER_LENGTH) {
-      throw new Error(
-        `Invalid number of fields for MaxBlockNumber. Expected ${MAX_BLOCK_NUMBER_LENGTH}, got ${fields.length}`,
-      );
-    }
-    return fields;
-  }
-
-  /**
-   * Deserializes MaxBlockNumber from a buffer or reader.
-   * @param buffer - Buffer to read from.
-   * @returns The MaxBlockNumber.
-   */
-  static fromBuffer(buffer: Buffer | BufferReader): MaxBlockNumber {
-    const reader = BufferReader.asReader(buffer);
-    return new MaxBlockNumber(reader.readBoolean(), reader.readNumber());
-  }
-
-  static fromFields(fields: Fr[] | FieldReader): MaxBlockNumber {
-    const reader = FieldReader.asReader(fields);
-    return new MaxBlockNumber(reader.readBoolean(), reader.readU32());
-  }
-
-  static empty() {
-    return new MaxBlockNumber(false, 0);
-  }
-
-  isEmpty(): boolean {
-    return !this.isSome && this.value === 0;
-  }
-
-  /**
-   * Create a new instance from a fields dictionary.
-   * @param fields - The dictionary.
-   * @returns A new instance.
-   */
-  static from(fields: FieldsOf<MaxBlockNumber>): MaxBlockNumber {
-    return new MaxBlockNumber(...MaxBlockNumber.getFields(fields));
-  }
-
-  /**
-   * Serialize into a field array. Low-level utility.
-   * @param fields - Object with fields.
-   * @returns The array.
-   */
-  static getFields(fields: FieldsOf<MaxBlockNumber>) {
-    return [fields.isSome, fields.value] as const;
-  }
-}