@aztec/entrypoints 4.0.0-nightly.20250907 → 4.0.0-nightly.20260108

package/src/encoding.ts

@@ -1,16 +1,14 @@
 import { GeneratorIndex } from '@aztec/constants';
 import { padArrayEnd } from '@aztec/foundation/collection';
-import { poseidon2HashWithSeparator } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
+import { poseidon2HashWithSeparator } from '@aztec/foundation/crypto/poseidon';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import type { Tuple } from '@aztec/foundation/serialize';
 import { FunctionCall, FunctionType } from '@aztec/stdlib/abi';
 import { HashedValues } from '@aztec/stdlib/tx';
 
 // These must match the values defined in:
 // - noir-projects/aztec-nr/aztec/src/entrypoint/app.nr
-const APP_MAX_CALLS = 4;
-// - and noir-projects/aztec-nr/aztec/src/entrypoint/fee.nr
-const FEE_MAX_CALLS = 2;
+const APP_MAX_CALLS = 5;
 
 /** Encoded function call for an Aztec entrypoint */
 export type EncodedFunctionCall = {
@@ -23,6 +21,8 @@ export type EncodedFunctionCall = {
   target_address: Fr;
   /** Whether the function is public or private */
   is_public: boolean;
+  /** Only applicable for enqueued public function calls. Whether the msg_sender will be set to "null". */
+  hide_msg_sender: boolean;
   /** Whether the function can alter state */
   is_static: boolean;
 };
@@ -40,7 +40,7 @@ export type EncodedCalls = {
  * This utility class helps in creating the payload for the entrypoint by taking into
  * account how the calls are encoded and hashed.
  * */
-export abstract class EncodedCallsForEntrypoint implements EncodedCalls {
+export class EncodedAppEntrypointCalls implements EncodedCalls {
   constructor(
     /** Function calls in the expected format (Noir's convention) */
     public encodedFunctionCalls: EncodedFunctionCall[],
@@ -71,7 +71,9 @@ export abstract class EncodedCallsForEntrypoint implements EncodedCalls {
    * Serializes the payload to an array of fields
    * @returns The fields of the payload
    */
-  abstract toFields(): Fr[];
+  toFields(): Fr[] {
+    return [...this.functionCallsToFields(), this.tx_nonce];
+  }
 
   /**
    * Hashes the payload
@@ -88,20 +90,11 @@ export abstract class EncodedCallsForEntrypoint implements EncodedCalls {
       call.function_selector,
       call.target_address,
       new Fr(call.is_public),
+      new Fr(call.hide_msg_sender),
       new Fr(call.is_static),
     ]);
   }
 
-  /**
-   * Encodes a set of function calls for a dapp entrypoint
-   * @param functionCalls - The function calls to execute
-   * @returns The encoded calls
-   */
-  static async fromFunctionCalls(functionCalls: FunctionCall[]) {
-    const encoded = await encode(functionCalls);
-    return new EncodedAppEntrypointCalls(encoded.encodedFunctionCalls, encoded.hashedArguments, 0, Fr.random());
-  }
-
   /**
    * Encodes the functions for the app-portion of a transaction from a set of function calls and a nonce
    * @param functionCalls - The function calls to execute
@@ -109,7 +102,7 @@ export abstract class EncodedCallsForEntrypoint implements EncodedCalls {
    * nonce can be replaced by submitting a new one with a higher fee.
    * @returns The encoded calls
    */
-  static async fromAppExecution(
+  static async create(
     functionCalls: FunctionCall[] | Tuple<FunctionCall, typeof APP_MAX_CALLS>,
     txNonce = Fr.random(),
   ) {
@@ -125,86 +118,6 @@ export abstract class EncodedCallsForEntrypoint implements EncodedCalls {
       txNonce,
     );
   }
-
-  /**
-   * Creates an encoded set of functions to pay the fee for a transaction
-   * @param functionCalls - The calls generated by the payment method
-   * @param isFeePayer - Whether the sender should be appointed as fee payer
-   * @returns The encoded calls
-   */
-  static async fromFeeCalls(
-    functionCalls: FunctionCall[] | Tuple<FunctionCall, typeof FEE_MAX_CALLS>,
-    isFeePayer: boolean,
-  ) {
-    const paddedCalls = padArrayEnd(functionCalls, FunctionCall.empty(), FEE_MAX_CALLS);
-    const encoded = await encode(paddedCalls);
-    return new EncodedFeeEntrypointCalls(
-      encoded.encodedFunctionCalls,
-      encoded.hashedArguments,
-      GeneratorIndex.FEE_PAYLOAD,
-      Fr.random(),
-      isFeePayer,
-    );
-  }
-}
-
-/** Encoded calls for app phase execution. */
-export class EncodedAppEntrypointCalls extends EncodedCallsForEntrypoint {
-  constructor(
-    encodedFunctionCalls: EncodedFunctionCall[],
-    hashedArguments: HashedValues[],
-    generatorIndex: number,
-    txNonce: Fr,
-  ) {
-    super(encodedFunctionCalls, hashedArguments, generatorIndex, txNonce);
-  }
-
-  override toFields(): Fr[] {
-    return [...this.functionCallsToFields(), this.tx_nonce];
-  }
-}
-
-/** Encoded calls for fee payment */
-export class EncodedFeeEntrypointCalls extends EncodedCallsForEntrypoint {
-  #isFeePayer: boolean;
-
-  constructor(
-    encodedFunctionCalls: EncodedFunctionCall[],
-    hashedArguments: HashedValues[],
-    generatorIndex: number,
-    txNonce: Fr,
-    isFeePayer: boolean,
-  ) {
-    super(encodedFunctionCalls, hashedArguments, generatorIndex, txNonce);
-    this.#isFeePayer = isFeePayer;
-  }
-
-  override toFields(): Fr[] {
-    return [...this.functionCallsToFields(), this.tx_nonce, new Fr(this.#isFeePayer)];
-  }
-
-  /* eslint-disable camelcase */
-  /** Whether the sender should be appointed as fee payer. */
-  get is_fee_payer() {
-    return this.#isFeePayer;
-  }
-  /* eslint-enable camelcase */
-}
-
-/**
- * Computes a hash of a combined set of app and fee calls.
- * @param appCalls - A set of app calls.
- * @param feeCalls - A set of calls used to pay fees.
- * @returns A hash of a combined call set.
- */
-export async function computeCombinedPayloadHash(
-  appPayload: EncodedAppEntrypointCalls,
-  feePayload: EncodedFeeEntrypointCalls,
-): Promise<Fr> {
-  return poseidon2HashWithSeparator(
-    [await appPayload.hash(), await feePayload.hash()],
-    GeneratorIndex.COMBINED_PAYLOAD,
-  );
 }
 
 /** Encodes FunctionCalls for execution, following Noir's convention */
@@ -224,6 +137,7 @@ export async function encode(calls: FunctionCall[]): Promise<EncodedCalls> {
     function_selector: call.selector.toField(),
     target_address: call.to.toField(),
     is_public: call.type == FunctionType.PUBLIC,
+    hide_msg_sender: call.hideMsgSender,
     is_static: call.isStatic,
   }));
 

package/src/interfaces.ts

@@ -1,26 +1,29 @@
-import type { Fr } from '@aztec/foundation/fields';
-import type { FieldsOf } from '@aztec/foundation/types';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import type { AuthWitness } from '@aztec/stdlib/auth-witness';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { GasSettings } from '@aztec/stdlib/gas';
-import type { TxExecutionRequest } from '@aztec/stdlib/tx';
+import type { ExecutionPayload, TxExecutionRequest } from '@aztec/stdlib/tx';
 
-import type { ExecutionPayload } from './payload.js';
+import { z } from 'zod';
 
 /**
- * General options for the tx execution.
+ * Information on the connected chain. Used by wallets when constructing transactions to protect against replay
+ * attacks.
  */
-export type TxExecutionOptions = {
-  /** Whether the transaction can be cancelled. */
-  cancellable?: boolean;
-  /**
-   * A nonce to inject into the app payload of the transaction. When used with cancellable=true, this nonce will be
-   * used to compute a nullifier that allows cancelling this transaction by submitting a new one with the same nonce
-   * but higher fee. The nullifier ensures only one transaction can succeed.
-   */
-  txNonce?: Fr;
+export type ChainInfo = {
+  /** The L1 chain id */
+  chainId: Fr;
+  /** The version of the rollup  */
+  version: Fr;
 };
 
+/**
+ * Zod schema for ChainInfo
+ */
+export const ChainInfoSchema = z.object({
+  chainId: Fr.schema,
+  version: Fr.schema,
+});
+
 /**
  * Creates transaction execution requests out of a set of function calls, a fee payment method and
  * general options for the transaction
@@ -29,14 +32,14 @@ export interface EntrypointInterface {
   /**
    * Generates an execution request out of set of function calls.
    * @param exec - The execution intents to be run.
-   * @param fee - The fee options for the transaction.
-   * @param options - Transaction nonce and whether the transaction is cancellable.
+   * @param gasSettings - The gas settings for the transaction.
+   * @param options - Miscellaneous tx options that enable/disable features of the entrypoint
    * @returns The authenticated transaction execution request.
    */
   createTxExecutionRequest(
     exec: ExecutionPayload,
-    fee: FeeOptions,
-    options: TxExecutionOptions,
+    gasSettings: GasSettings,
+    options?: any,
   ): Promise<TxExecutionRequest>;
 }
 
@@ -49,49 +52,3 @@ export interface AuthWitnessProvider {
    */
   createAuthWit(messageHash: Fr | Buffer): Promise<AuthWitness>;
 }
-
-/**
- * Holds information about how the fee for a transaction is to be paid.
- */
-export interface FeePaymentMethod {
-  /** The asset used to pay the fee. */
-  getAsset(): Promise<AztecAddress>;
-  /**
-   * Returns the data to be added to the final execution request
-   * to pay the fee in the given asset
-   * @param gasSettings - The gas limits and max fees.
-   * @returns The function calls to pay the fee.
-   */
-  getExecutionPayload(gasSettings: GasSettings): Promise<ExecutionPayload>;
-  /**
-   * The expected fee payer for this tx.
-   * @param gasSettings - The gas limits and max fees.
-   */
-  getFeePayer(gasSettings: GasSettings): Promise<AztecAddress>;
-}
-
-/**
- * Fee payment options for a transaction.
- */
-export type FeeOptions = {
-  /** The fee payment method to use */
-  paymentMethod: FeePaymentMethod;
-  /** The gas settings */
-  gasSettings: GasSettings;
-};
-
-// docs:start:user_fee_options
-/** Fee options as set by a user. */
-export type UserFeeOptions = {
-  /** The fee payment method to use */
-  paymentMethod?: FeePaymentMethod;
-  /** The gas settings */
-  gasSettings?: Partial<FieldsOf<GasSettings>>;
-  /** Percentage to pad the base fee by, if empty, defaults to 0.5 */
-  baseFeePadding?: number;
-  /** Whether to run an initial simulation of the tx with high gas limit to figure out actual gas settings. */
-  estimateGas?: boolean;
-  /** Percentage to pad the estimated gas limits by, if empty, defaults to 0.1. Only relevant if estimateGas is set. */
-  estimatedGasPadding?: number;
-};
-// docs:end:user_fee_options

package/dest/payload.d.ts

@@ -1,32 +0,0 @@
-import { FunctionCall } from '@aztec/stdlib/abi';
-import type { AuthWitness } from '@aztec/stdlib/auth-witness';
-import { Capsule, HashedValues } from '@aztec/stdlib/tx';
-/**
- * Represents data necessary to perform an action in the network successfully.
- * This class can be considered Aztec's "minimal execution unit".
- * */
-export declare class ExecutionPayload {
-    /** The function calls to be executed. */
-    calls: FunctionCall[];
-    /** Any transient auth witnesses needed for this execution */
-    authWitnesses: AuthWitness[];
-    /** Data passed through an oracle for this execution. */
-    capsules: Capsule[];
-    /** Extra hashed values to be injected in the execution cache */
-    extraHashedArgs: HashedValues[];
-    constructor(
-    /** The function calls to be executed. */
-    calls: FunctionCall[], 
-    /** Any transient auth witnesses needed for this execution */
-    authWitnesses: AuthWitness[], 
-    /** Data passed through an oracle for this execution. */
-    capsules: Capsule[], 
-    /** Extra hashed values to be injected in the execution cache */
-    extraHashedArgs?: HashedValues[]);
-    static empty(): ExecutionPayload;
-}
-/**
- * Merges an array ExecutionPayloads combining their calls, authWitnesses, capsules and extraArgHashes.
- */
-export declare function mergeExecutionPayloads(requests: ExecutionPayload[]): ExecutionPayload;
-//# sourceMappingURL=payload.d.ts.map

package/dest/payload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../src/payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;KAGK;AACL,qBAAa,gBAAgB;IAEzB,yCAAyC;IAClC,KAAK,EAAE,YAAY,EAAE;IAC5B,6DAA6D;IACtD,aAAa,EAAE,WAAW,EAAE;IACnC,wDAAwD;IACjD,QAAQ,EAAE,OAAO,EAAE;IAC1B,gEAAgE;IACzD,eAAe,EAAE,YAAY,EAAE;;IAPtC,yCAAyC;IAClC,KAAK,EAAE,YAAY,EAAE;IAC5B,6DAA6D;IACtD,aAAa,EAAE,WAAW,EAAE;IACnC,wDAAwD;IACjD,QAAQ,EAAE,OAAO,EAAE;IAC1B,gEAAgE;IACzD,eAAe,GAAE,YAAY,EAAO;IAG7C,MAAM,CAAC,KAAK;CAGb;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,gBAAgB,CAMrF"}

package/dest/payload.js

@@ -1,27 +0,0 @@
-/**
- * Represents data necessary to perform an action in the network successfully.
- * This class can be considered Aztec's "minimal execution unit".
- * */ export class ExecutionPayload {
-    calls;
-    authWitnesses;
-    capsules;
-    extraHashedArgs;
-    constructor(/** The function calls to be executed. */ calls, /** Any transient auth witnesses needed for this execution */ authWitnesses, /** Data passed through an oracle for this execution. */ capsules, /** Extra hashed values to be injected in the execution cache */ extraHashedArgs = []){
-        this.calls = calls;
-        this.authWitnesses = authWitnesses;
-        this.capsules = capsules;
-        this.extraHashedArgs = extraHashedArgs;
-    }
-    static empty() {
-        return new ExecutionPayload([], [], []);
-    }
-}
-/**
- * Merges an array ExecutionPayloads combining their calls, authWitnesses, capsules and extraArgHashes.
- */ export function mergeExecutionPayloads(requests) {
-    const calls = requests.map((r)=>r.calls).flat();
-    const combinedAuthWitnesses = requests.map((r)=>r.authWitnesses ?? []).flat();
-    const combinedCapsules = requests.map((r)=>r.capsules ?? []).flat();
-    const combinedextraHashedArgs = requests.map((r)=>r.extraHashedArgs ?? []).flat();
-    return new ExecutionPayload(calls, combinedAuthWitnesses, combinedCapsules, combinedextraHashedArgs);
-}

package/src/payload.ts

@@ -1,35 +0,0 @@
-import { FunctionCall } from '@aztec/stdlib/abi';
-import type { AuthWitness } from '@aztec/stdlib/auth-witness';
-import { Capsule, HashedValues } from '@aztec/stdlib/tx';
-
-/**
- * Represents data necessary to perform an action in the network successfully.
- * This class can be considered Aztec's "minimal execution unit".
- * */
-export class ExecutionPayload {
-  public constructor(
-    /** The function calls to be executed. */
-    public calls: FunctionCall[],
-    /** Any transient auth witnesses needed for this execution */
-    public authWitnesses: AuthWitness[],
-    /** Data passed through an oracle for this execution. */
-    public capsules: Capsule[],
-    /** Extra hashed values to be injected in the execution cache */
-    public extraHashedArgs: HashedValues[] = [],
-  ) {}
-
-  static empty() {
-    return new ExecutionPayload([], [], []);
-  }
-}
-
-/**
- * Merges an array ExecutionPayloads combining their calls, authWitnesses, capsules and extraArgHashes.
- */
-export function mergeExecutionPayloads(requests: ExecutionPayload[]): ExecutionPayload {
-  const calls = requests.map(r => r.calls).flat();
-  const combinedAuthWitnesses = requests.map(r => r.authWitnesses ?? []).flat();
-  const combinedCapsules = requests.map(r => r.capsules ?? []).flat();
-  const combinedextraHashedArgs = requests.map(r => r.extraHashedArgs ?? []).flat();
-  return new ExecutionPayload(calls, combinedAuthWitnesses, combinedCapsules, combinedextraHashedArgs);
-}