@aztec/stdlib 3.0.0-nightly.20251007 → 3.0.0-nightly.20251008

package/src/tx/protocol_contracts.ts

@@ -0,0 +1,70 @@
+import { GeneratorIndex, MAX_PROTOCOL_CONTRACTS } from '@aztec/constants';
+import { makeTuple } from '@aztec/foundation/array';
+import { arraySerializedSizeOfNonEmpty } from '@aztec/foundation/collection';
+import { poseidon2HashWithSeparator } from '@aztec/foundation/crypto';
+import { Fr } from '@aztec/foundation/fields';
+import {
+  BufferReader,
+  FieldReader,
+  type Tuple,
+  assertLength,
+  serializeToBuffer,
+  serializeToFields,
+} from '@aztec/foundation/serialize';
+import type { FieldsOf } from '@aztec/foundation/types';
+
+import { z } from 'zod';
+
+import { AztecAddress } from '../aztec-address/index.js';
+
+export class ProtocolContracts {
+  constructor(public derivedAddresses: Tuple<AztecAddress, typeof MAX_PROTOCOL_CONTRACTS>) {}
+
+  static from(fields: FieldsOf<ProtocolContracts>) {
+    return new ProtocolContracts(...ProtocolContracts.getFields(fields));
+  }
+
+  static getFields(fields: FieldsOf<ProtocolContracts>) {
+    return [fields.derivedAddresses] as const;
+  }
+
+  static fromFields(fields: Fr[] | FieldReader): ProtocolContracts {
+    const reader = FieldReader.asReader(fields);
+    return new ProtocolContracts(reader.readArray(MAX_PROTOCOL_CONTRACTS, AztecAddress));
+  }
+
+  toFields(): Fr[] {
+    return serializeToFields(...ProtocolContracts.getFields(this));
+  }
+
+  static fromBuffer(buffer: Buffer | BufferReader): ProtocolContracts {
+    const reader = BufferReader.asReader(buffer);
+    return new ProtocolContracts(reader.readArray(MAX_PROTOCOL_CONTRACTS, AztecAddress));
+  }
+
+  toBuffer() {
+    return serializeToBuffer(...ProtocolContracts.getFields(this));
+  }
+
+  static empty() {
+    return new ProtocolContracts(makeTuple(MAX_PROTOCOL_CONTRACTS, () => AztecAddress.zero()));
+  }
+
+  getSize() {
+    return arraySerializedSizeOfNonEmpty(this.derivedAddresses);
+  }
+
+  hash() {
+    return poseidon2HashWithSeparator(this.derivedAddresses, GeneratorIndex.PROTOCOL_CONTRACTS);
+  }
+
+  static get schema() {
+    return z
+      .object({
+        derivedAddresses: AztecAddress.schema.array().min(MAX_PROTOCOL_CONTRACTS).max(MAX_PROTOCOL_CONTRACTS),
+      })
+      .transform(
+        ({ derivedAddresses }) => new ProtocolContracts(assertLength(derivedAddresses, MAX_PROTOCOL_CONTRACTS)),
+      );
+  }
+}

package/src/tx/tx_constant_data.ts

@@ -7,29 +7,16 @@ import { BlockHeader } from './block_header.js';
 import { TxContext } from './tx_context.js';
 
 /**
- * Data that is constant/not modified by neither of the kernels.
+ * Version of `PrivateTxConstantData` exposed by the tail circuits
+ * It compresses the protocol contracts list to a hash to minimize the number of public inputs.
+ * Refer to `PrivateTxConstantData` for more details.
  */
 export class TxConstantData {
   constructor(
-    /** Header of a block whose state is used during execution (not the block the transaction is included in). */
     public anchorBlockHeader: BlockHeader,
-    /**
-     * Context of the transaction.
-     *
-     * Note: `chainId` and `version` in txContext are not redundant to the values in
-     * self.anchor_block_header.global_variables because they can be different in case of a protocol upgrade. In such
-     * a situation we could be using header from a block before the upgrade took place but be using the updated
-     * protocol to execute and prove the transaction.
-     */
     public txContext: TxContext,
-    /**
-     * Root of the vk tree for the protocol circuits.
-     */
     public vkTreeRoot: Fr,
-    /**
-     * Root of the tree for the protocol contracts.
-     */
-    public protocolContractTreeRoot: Fr,
+    public protocolContractsHash: Fr,
   ) {}
 
   static from(fields: FieldsOf<TxConstantData>) {
@@ -37,7 +24,7 @@ export class TxConstantData {
   }
 
   static getFields(fields: FieldsOf<TxConstantData>) {
-    return [fields.anchorBlockHeader, fields.txContext, fields.vkTreeRoot, fields.protocolContractTreeRoot] as const;
+    return [fields.anchorBlockHeader, fields.txContext, fields.vkTreeRoot, fields.protocolContractsHash] as const;
   }
 
   static fromFields(fields: Fr[] | FieldReader): TxConstantData {
@@ -83,7 +70,7 @@ export class TxConstantData {
       this.anchorBlockHeader.getSize() +
       this.txContext.getSize() +
       this.vkTreeRoot.size +
-      this.protocolContractTreeRoot.size
+      this.protocolContractsHash.size
     );
   }
 

package/src/tx/validator/error_texts.ts

@@ -16,7 +16,7 @@ export const TX_ERROR_INVALID_INCLUDE_BY_TIMESTAMP = 'Invalid expiration timesta
 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 verification keys tree root';
-export const TX_ERROR_INCORRECT_PROTOCOL_CONTRACT_TREE_ROOT = 'Incorrect protocol contracts tree root';
+export const TX_ERROR_INCORRECT_PROTOCOL_CONTRACTS_HASH = 'Incorrect protocol contracts hash';
 
 // Proof
 export const TX_ERROR_INVALID_PROOF = 'Invalid proof';

package/src/versioning/versioning.ts

@@ -14,21 +14,21 @@ export type ComponentsVersions = {
   // such as the keystore, we need to change it so we can handle updates.
   l1RollupAddress: EthAddress;
   rollupVersion: number;
-  l2ProtocolContractsTreeRoot: string;
+  l2ProtocolContractsHash: string;
   l2CircuitsVkTreeRoot: string;
 };
 
 /** Returns components versions from chain config. */
 export function getComponentsVersionsFromConfig(
   config: ChainConfig,
-  l2ProtocolContractsTreeRoot: string | Fr,
+  l2ProtocolContractsHash: string | Fr,
   l2CircuitsVkTreeRoot: string | Fr,
 ): ComponentsVersions {
   return {
     l1ChainId: config.l1ChainId,
     l1RollupAddress: config.l1Contracts?.rollupAddress, // This should not be undefined, but sometimes the config lies to us and it is...
     rollupVersion: config.rollupVersion,
-    l2ProtocolContractsTreeRoot: l2ProtocolContractsTreeRoot.toString(),
+    l2ProtocolContractsHash: l2ProtocolContractsHash.toString(),
     l2CircuitsVkTreeRoot: l2CircuitsVkTreeRoot.toString(),
   };
 }
@@ -37,7 +37,7 @@ export function getComponentsVersionsFromConfig(
 export function compressComponentVersions(versions: ComponentsVersions): string {
   if (
     versions.l1RollupAddress === undefined ||
-    versions.l2ProtocolContractsTreeRoot === undefined ||
+    versions.l2ProtocolContractsHash === undefined ||
     versions.l2CircuitsVkTreeRoot === undefined
   ) {
     throw new Error(`Component versions are not set: ${jsonStringify(versions)}`);
@@ -48,7 +48,7 @@ export function compressComponentVersions(versions: ComponentsVersions): string
     versions.l1ChainId,
     versions.l1RollupAddress.toString().slice(2, 10),
     versions.rollupVersion,
-    versions.l2ProtocolContractsTreeRoot.toString().slice(2, 10),
+    versions.l2ProtocolContractsHash.toString().slice(2, 10),
     versions.l2CircuitsVkTreeRoot.toString().slice(2, 10),
   ].join('-');
 }
@@ -62,7 +62,7 @@ export class ComponentsVersionsError extends Error {
 
 /** Checks if the compressed string matches against the expected versions. Throws on mismatch. */
 export function checkCompressedComponentVersion(compressed: string, expected: ComponentsVersions) {
-  const [versionVersion, l1ChainId, l1RollupAddress, rollupVersion, l2ProtocolContractsTreeRoot, l2CircuitsVkTreeRoot] =
+  const [versionVersion, l1ChainId, l1RollupAddress, rollupVersion, l2ProtocolContractsHash, l2CircuitsVkTreeRoot] =
     compressed.split('-');
   if (versionVersion !== '00') {
     throw new ComponentsVersionsError('version', '00', versionVersion);
@@ -76,11 +76,11 @@ export function checkCompressedComponentVersion(compressed: string, expected: Co
   if (rollupVersion !== expected.rollupVersion.toString()) {
     throw new ComponentsVersionsError('L2 chain version', expected.rollupVersion.toString(), rollupVersion);
   }
-  if (l2ProtocolContractsTreeRoot !== expected.l2ProtocolContractsTreeRoot.toString().slice(2, 10)) {
+  if (l2ProtocolContractsHash !== expected.l2ProtocolContractsHash.toString().slice(2, 10)) {
     throw new ComponentsVersionsError(
       `L2 protocol contracts vk tree root`,
-      expected.l2ProtocolContractsTreeRoot.toString(),
-      l2ProtocolContractsTreeRoot,
+      expected.l2ProtocolContractsHash.toString(),
+      l2ProtocolContractsHash,
     );
   }
   if (l2CircuitsVkTreeRoot !== expected.l2CircuitsVkTreeRoot.toString().slice(2, 10)) {
@@ -99,7 +99,7 @@ export function validatePartialComponentVersionsMatch(
 ) {
   for (const key of [
     'l1RollupAddress',
-    'l2ProtocolContractsTreeRoot',
+    'l2ProtocolContractsHash',
     'l2CircuitsVkTreeRoot',
     'l1ChainId',
     'rollupVersion',

package/dest/trees/protocol_contract_leaf.d.ts

@@ -1,84 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
-import type { IndexedTreeLeaf, IndexedTreeLeafPreimage } from '@aztec/foundation/trees';
-import { z } from 'zod';
-/**
- * Class containing the data of a preimage of a single leaf in the protocol contract tree.
- * Note: It's called preimage because this data gets hashed before being inserted as a node into the `IndexedTree`.
- * Note: Though this tree contains addresses, they are converted to fields to avoid unnecessary conversions in the tree.
- */
-export declare class ProtocolContractLeafPreimage implements IndexedTreeLeafPreimage {
-    /**
-     * Leaf value inside the indexed tree's linked list.
-     */
-    address: Fr;
-    /**
-     * Next value inside the indexed tree's linked list.
-     */
-    nextAddress: Fr;
-    /**
-     * Index of the next leaf in the indexed tree's linked list.
-     */
-    nextIndex: bigint;
-    constructor(
-    /**
-     * Leaf value inside the indexed tree's linked list.
-     */
-    address: Fr, 
-    /**
-     * Next value inside the indexed tree's linked list.
-     */
-    nextAddress: Fr, 
-    /**
-     * Index of the next leaf in the indexed tree's linked list.
-     */
-    nextIndex: bigint);
-    static get schema(): z.ZodEffects<z.ZodObject<{
-        address: z.ZodType<Fr, any, string>;
-        nextAddress: z.ZodType<Fr, any, string>;
-        nextIndex: z.ZodPipeline<z.ZodUnion<[z.ZodBigInt, z.ZodNumber, z.ZodString]>, z.ZodBigInt>;
-    }, "strip", z.ZodTypeAny, {
-        nextIndex: bigint;
-        address: Fr;
-        nextAddress: Fr;
-    }, {
-        nextIndex: string | number | bigint;
-        address: string;
-        nextAddress: string;
-    }>, ProtocolContractLeafPreimage, {
-        nextIndex: string | number | bigint;
-        address: string;
-        nextAddress: string;
-    }>;
-    getKey(): bigint;
-    getNextKey(): bigint;
-    getNextIndex(): bigint;
-    asLeaf(): ProtocolContractLeaf;
-    toBuffer(): Buffer;
-    toHashInputs(): Buffer[];
-    toFields(): Fr[];
-    static random(): ProtocolContractLeafPreimage;
-    static empty(): ProtocolContractLeafPreimage;
-    static fromBuffer(buffer: Buffer | BufferReader): ProtocolContractLeafPreimage;
-}
-/**
- * An address to be inserted or checked in the protocol contract tree.
- */
-export declare class ProtocolContractLeaf implements IndexedTreeLeaf {
-    /**
-     * Address value.
-     */
-    address: Fr;
-    constructor(
-    /**
-     * Address value.
-     */
-    address: Fr);
-    getKey(): bigint;
-    toBuffer(): Buffer;
-    isEmpty(): boolean;
-    updateTo(_another: ProtocolContractLeaf): ProtocolContractLeaf;
-    static buildDummy(key: bigint): ProtocolContractLeaf;
-    static fromBuffer(buf: Buffer): ProtocolContractLeaf;
-}
-//# sourceMappingURL=protocol_contract_leaf.d.ts.map

package/dest/trees/protocol_contract_leaf.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"protocol_contract_leaf.d.ts","sourceRoot":"","sources":["../../src/trees/protocol_contract_leaf.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAExF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;GAIG;AACH,qBAAa,4BAA6B,YAAW,uBAAuB;IAExE;;OAEG;IACI,OAAO,EAAE,EAAE;IAClB;;OAEG;IACI,WAAW,EAAE,EAAE;IACtB;;OAEG;IACI,SAAS,EAAE,MAAM;;IAXxB;;OAEG;IACI,OAAO,EAAE,EAAE;IAClB;;OAEG;IACI,WAAW,EAAE,EAAE;IACtB;;OAEG;IACI,SAAS,EAAE,MAAM;IAG1B,MAAM,KAAK,MAAM;;;;;;;;;;;;;;;;OAUhB;IAED,MAAM,IAAI,MAAM;IAIhB,UAAU,IAAI,MAAM;IAIpB,YAAY,IAAI,MAAM;IAItB,MAAM,IAAI,oBAAoB;IAI9B,QAAQ,IAAI,MAAM;IAIlB,YAAY,IAAI,MAAM,EAAE;IAKxB,QAAQ,IAAI,EAAE,EAAE;IAIhB,MAAM,CAAC,MAAM;IAQb,MAAM,CAAC,KAAK,IAAI,4BAA4B;IAI5C,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,4BAA4B;CAQ/E;AAED;;GAEG;AACH,qBAAa,oBAAqB,YAAW,eAAe;IAExD;;OAEG;IACI,OAAO,EAAE,EAAE;;IAHlB;;OAEG;IACI,OAAO,EAAE,EAAE;IAGpB,MAAM,IAAI,MAAM;IAIhB,QAAQ,IAAI,MAAM;IAIlB,OAAO,IAAI,OAAO;IAIlB,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,GAAG,oBAAoB;IAI9D,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,oBAAoB;IAIpD,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,oBAAoB;CAGrD"}

package/dest/trees/protocol_contract_leaf.js

@@ -1,100 +0,0 @@
-import { MAX_PROTOCOL_CONTRACTS } from '@aztec/constants';
-import { toBigIntBE } from '@aztec/foundation/bigint-buffer';
-import { Fr } from '@aztec/foundation/fields';
-import { schemas } from '@aztec/foundation/schemas';
-import { BufferReader } from '@aztec/foundation/serialize';
-import { z } from 'zod';
-/**
- * Class containing the data of a preimage of a single leaf in the protocol contract tree.
- * Note: It's called preimage because this data gets hashed before being inserted as a node into the `IndexedTree`.
- * Note: Though this tree contains addresses, they are converted to fields to avoid unnecessary conversions in the tree.
- */ export class ProtocolContractLeafPreimage {
-    address;
-    nextAddress;
-    nextIndex;
-    constructor(/**
-     * Leaf value inside the indexed tree's linked list.
-     */ address, /**
-     * Next value inside the indexed tree's linked list.
-     */ nextAddress, /**
-     * Index of the next leaf in the indexed tree's linked list.
-     */ nextIndex){
-        this.address = address;
-        this.nextAddress = nextAddress;
-        this.nextIndex = nextIndex;
-    }
-    static get schema() {
-        return z.object({
-            address: schemas.Fr,
-            nextAddress: schemas.Fr,
-            nextIndex: schemas.BigInt
-        }).transform(({ address, nextAddress, nextIndex })=>new ProtocolContractLeafPreimage(address, nextAddress, nextIndex));
-    }
-    getKey() {
-        return this.address.toBigInt();
-    }
-    getNextKey() {
-        return this.nextAddress.toBigInt();
-    }
-    getNextIndex() {
-        return this.nextIndex;
-    }
-    asLeaf() {
-        return new ProtocolContractLeaf(this.address);
-    }
-    toBuffer() {
-        return Buffer.concat(this.toHashInputs());
-    }
-    toHashInputs() {
-        // Note: the protocol contract leaves only hash the value and next value.
-        return [
-            Buffer.from(this.address.toBuffer()),
-            Buffer.from(this.nextAddress.toBuffer())
-        ];
-    }
-    toFields() {
-        return [
-            this.address,
-            this.nextAddress,
-            new Fr(this.nextIndex)
-        ];
-    }
-    static random() {
-        return new ProtocolContractLeafPreimage(Fr.random(), Fr.random(), BigInt(Math.floor(Math.random() * 1000) % MAX_PROTOCOL_CONTRACTS));
-    }
-    static empty() {
-        return new ProtocolContractLeafPreimage(Fr.ZERO, Fr.ZERO, 0n);
-    }
-    static fromBuffer(buffer) {
-        const reader = BufferReader.asReader(buffer);
-        return new ProtocolContractLeafPreimage(reader.readObject(Fr), reader.readObject(Fr), toBigIntBE(reader.readBytes(32)));
-    }
-}
-/**
- * An address to be inserted or checked in the protocol contract tree.
- */ export class ProtocolContractLeaf {
-    address;
-    constructor(/**
-     * Address value.
-     */ address){
-        this.address = address;
-    }
-    getKey() {
-        return this.address.toBigInt();
-    }
-    toBuffer() {
-        return this.address.toBuffer();
-    }
-    isEmpty() {
-        return this.address.isZero();
-    }
-    updateTo(_another) {
-        throw new Error('Protocol contract tree is insert only');
-    }
-    static buildDummy(key) {
-        return new ProtocolContractLeaf(new Fr(key));
-    }
-    static fromBuffer(buf) {
-        return new ProtocolContractLeaf(Fr.fromBuffer(buf));
-    }
-}

package/src/trees/protocol_contract_leaf.ts

@@ -1,128 +0,0 @@
-import { MAX_PROTOCOL_CONTRACTS } from '@aztec/constants';
-import { toBigIntBE } from '@aztec/foundation/bigint-buffer';
-import { Fr } from '@aztec/foundation/fields';
-import { schemas } from '@aztec/foundation/schemas';
-import { BufferReader } from '@aztec/foundation/serialize';
-import type { IndexedTreeLeaf, IndexedTreeLeafPreimage } from '@aztec/foundation/trees';
-
-import { z } from 'zod';
-
-/**
- * Class containing the data of a preimage of a single leaf in the protocol contract tree.
- * Note: It's called preimage because this data gets hashed before being inserted as a node into the `IndexedTree`.
- * Note: Though this tree contains addresses, they are converted to fields to avoid unnecessary conversions in the tree.
- */
-export class ProtocolContractLeafPreimage implements IndexedTreeLeafPreimage {
-  constructor(
-    /**
-     * Leaf value inside the indexed tree's linked list.
-     */
-    public address: Fr,
-    /**
-     * Next value inside the indexed tree's linked list.
-     */
-    public nextAddress: Fr,
-    /**
-     * Index of the next leaf in the indexed tree's linked list.
-     */
-    public nextIndex: bigint,
-  ) {}
-
-  static get schema() {
-    return z
-      .object({
-        address: schemas.Fr,
-        nextAddress: schemas.Fr,
-        nextIndex: schemas.BigInt,
-      })
-      .transform(
-        ({ address, nextAddress, nextIndex }) => new ProtocolContractLeafPreimage(address, nextAddress, nextIndex),
-      );
-  }
-
-  getKey(): bigint {
-    return this.address.toBigInt();
-  }
-
-  getNextKey(): bigint {
-    return this.nextAddress.toBigInt();
-  }
-
-  getNextIndex(): bigint {
-    return this.nextIndex;
-  }
-
-  asLeaf(): ProtocolContractLeaf {
-    return new ProtocolContractLeaf(this.address);
-  }
-
-  toBuffer(): Buffer {
-    return Buffer.concat(this.toHashInputs());
-  }
-
-  toHashInputs(): Buffer[] {
-    // Note: the protocol contract leaves only hash the value and next value.
-    return [Buffer.from(this.address.toBuffer()), Buffer.from(this.nextAddress.toBuffer())];
-  }
-
-  toFields(): Fr[] {
-    return [this.address, this.nextAddress, new Fr(this.nextIndex)];
-  }
-
-  static random() {
-    return new ProtocolContractLeafPreimage(
-      Fr.random(),
-      Fr.random(),
-      BigInt(Math.floor(Math.random() * 1000) % MAX_PROTOCOL_CONTRACTS),
-    );
-  }
-
-  static empty(): ProtocolContractLeafPreimage {
-    return new ProtocolContractLeafPreimage(Fr.ZERO, Fr.ZERO, 0n);
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader): ProtocolContractLeafPreimage {
-    const reader = BufferReader.asReader(buffer);
-    return new ProtocolContractLeafPreimage(
-      reader.readObject(Fr),
-      reader.readObject(Fr),
-      toBigIntBE(reader.readBytes(32)),
-    );
-  }
-}
-
-/**
- * An address to be inserted or checked in the protocol contract tree.
- */
-export class ProtocolContractLeaf implements IndexedTreeLeaf {
-  constructor(
-    /**
-     * Address value.
-     */
-    public address: Fr,
-  ) {}
-
-  getKey(): bigint {
-    return this.address.toBigInt();
-  }
-
-  toBuffer(): Buffer {
-    return this.address.toBuffer();
-  }
-
-  isEmpty(): boolean {
-    return this.address.isZero();
-  }
-
-  updateTo(_another: ProtocolContractLeaf): ProtocolContractLeaf {
-    throw new Error('Protocol contract tree is insert only');
-  }
-
-  static buildDummy(key: bigint): ProtocolContractLeaf {
-    return new ProtocolContractLeaf(new Fr(key));
-  }
-
-  static fromBuffer(buf: Buffer): ProtocolContractLeaf {
-    return new ProtocolContractLeaf(Fr.fromBuffer(buf));
-  }
-}