@aztec/entrypoints 0.0.1-fake-ceab37513c → 0.0.2-commit.217f559981

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,15 +32,30 @@ 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 chainInfo - Chain information (chainId and version) for replay protection.
+   * @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,
+    chainInfo: ChainInfo,
+    options?: any,
   ): Promise<TxExecutionRequest>;
+
+  /**
+   * Wraps an execution payload such that it is executed *via* this entrypoint.
+   * This returns an ExecutionPayload with the entrypoint as the caller for the wrapped payload.
+   * Useful for account self-funding deployments and batching calls beyond the limit
+   * of a single entrypoint call.
+   *
+   * @param exec - The execution payload to wrap
+   * @param options - Implementation-specific options
+   * @returns A new execution payload with a single call to this entrypoint
+   * @throws Error if the payload cannot be wrapped (e.g., exceeds call limit)
+   */
+  wrapExecutionPayload(exec: ExecutionPayload, options?: any): Promise<ExecutionPayload>;
 }
 
 /** Creates authorization witnesses. */
@@ -49,49 +67,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);
-}