@aztec/aztec.js 0.0.0-test.1 → 0.0.1-commit.0208eb9

package/src/contract/interaction_options.ts

@@ -0,0 +1,208 @@
+import type { FieldsOf } from '@aztec/foundation/types';
+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 { Capsule, OffchainEffect, SimulationStats, TxHash, TxReceipt } from '@aztec/stdlib/tx';
+
+import type { FeePaymentMethod } from '../fee/fee_payment_method.js';
+import type { ProfileOptions, SendOptions, SimulateOptions } from '../wallet/index.js';
+import type { WaitOpts } from './wait_opts.js';
+
+/**
+ * Options used to tweak the simulation and add gas estimation capabilities
+ */
+export type FeeEstimationOptions = {
+  /** Whether to modify the fee settings of the simulation 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;
+};
+
+/**
+ * Interactions allow configuring a custom fee payment method that gets bundled with the transaction before
+ * sending it to the wallet
+ */
+export type FeePaymentMethodOption = {
+  /** Fee payment method to embed in the interaction */
+  paymentMethod?: FeePaymentMethod;
+};
+
+/**
+ * User-defined partial gas settings for the interaction. This type is completely optional since
+ * the wallet will fill in the missing options
+ */
+export type GasSettingsOption = {
+  /** The gas settings */
+  gasSettings?: Partial<FieldsOf<GasSettings>>;
+};
+
+/** Fee options as set by a user. */
+export type InteractionFeeOptions = GasSettingsOption & FeePaymentMethodOption;
+
+/**  Fee options that can be set for simulation *only* */
+export type SimulationInteractionFeeOptions = InteractionFeeOptions & FeeEstimationOptions;
+
+/**
+ * Represents the options to configure a request from a contract interaction.
+ * Allows specifying additional auth witnesses and capsules to use during execution
+ */
+export type RequestInteractionOptions = {
+  /** Extra authwits to use during execution */
+  authWitnesses?: AuthWitness[];
+  /** Extra capsules to use during execution */
+  capsules?: Capsule[];
+  /** Fee payment method to embed in the interaction request */
+  fee?: FeePaymentMethodOption;
+};
+
+/**
+ * Constant for explicitly not waiting for transaction confirmation.
+ * We use this instead of false to avoid confusion with falsy checks.
+ */
+export const NO_WAIT = 'NO_WAIT' as const;
+
+/**
+ * Type for the NO_WAIT constant.
+ */
+export type NoWait = typeof NO_WAIT;
+
+/**
+ * Type for wait options in interactions.
+ * - NO_WAIT symbol: Don't wait for confirmation, return TxHash immediately
+ * - WaitOpts object: Wait with custom options and return receipt/result
+ * - undefined: Wait with default options and return receipt/result
+ */
+export type InteractionWaitOptions = NoWait | WaitOpts | undefined;
+
+/**
+ * Base options for calling a (constrained) function in a contract, without wait parameter.
+ */
+export type SendInteractionOptionsWithoutWait = RequestInteractionOptions & {
+  /** The sender's Aztec address. */
+  from: AztecAddress;
+  /** The fee options for the transaction. */
+  fee?: InteractionFeeOptions;
+};
+
+/**
+ * Represents options for calling a (constrained) function in a contract.
+ */
+export type SendInteractionOptions<W extends InteractionWaitOptions = undefined> = SendInteractionOptionsWithoutWait & {
+  /**
+   * Whether to wait for the transaction to be mined.
+   * - undefined (default): wait with default options and return TxReceipt
+   * - WaitOpts object: wait with custom options and return TxReceipt
+   * - NO_WAIT: return txHash immediately without waiting
+   */
+  wait?: W;
+};
+
+/**
+ * Represents the options for simulating a contract function interaction.
+ * Allows specifying the address from which the method should be called.
+ * Disregarded for simulation of public functions
+ */
+export type SimulateInteractionOptions = Omit<SendInteractionOptions, 'fee'> & {
+  /** The fee options for the transaction. */
+  fee?: SimulationInteractionFeeOptions;
+  /** Simulate without checking for the validity of the resulting transaction, e.g. whether it emits any existing nullifiers. */
+  skipTxValidation?: boolean;
+  /** Whether to ensure the fee payer is not empty and has enough balance to pay for the fee. */
+  skipFeeEnforcement?: boolean;
+  /** Whether to include metadata such as offchain effects and performance statistics (e.g. timing information of the different circuits and oracles) in
+   * the simulation result, instead of just the return value of the function */
+  includeMetadata?: boolean;
+};
+
+/**
+ * Represents the options for profiling an interaction.
+ */
+export type ProfileInteractionOptions = SimulateInteractionOptions & {
+  /** Whether to return gates information or the bytecode/witnesses. */
+  profileMode: 'gates' | 'execution-steps' | 'full';
+  /** Whether to generate a Chonk proof or not */
+  skipProofGeneration?: boolean;
+};
+
+/**
+ * Represents the result type of a simulation.
+ * By default, it will just be the return value of the simulated function
+ * If `includeMetadata` is set to true in `SimulateInteractionOptions` on the input of `simulate(...)`,
+ * it will provide extra information.
+ */
+export type SimulationReturn<T extends boolean | undefined> = T extends true
+  ? {
+      /** Additional stats about the simulation */
+      stats: SimulationStats;
+      /** Offchain effects generated during the simulation */
+      offchainEffects: OffchainEffect[];
+      /**  Return value of the function */
+      result: any;
+      /** Gas estimation results */
+      estimatedGas: Pick<GasSettings, 'gasLimits' | 'teardownGasLimits'>;
+    }
+  : any;
+
+/**
+ * Represents the result type of sending a transaction.
+ * If `wait` is NO_WAIT, returns TxHash immediately without waiting.
+ * If `wait` is undefined or WaitOpts, returns TReturn (defaults to TxReceipt) after waiting.
+ */
+export type SendReturn<T extends InteractionWaitOptions, TReturn = TxReceipt> = T extends NoWait ? TxHash : TReturn;
+
+/**
+ * Transforms and cleans up the higher level SendInteractionOptions defined by the interaction into
+ * SendOptions, which are the ones that can be serialized and forwarded to the wallet
+ * @param options - The send interaction options with optional wait parameter
+ * @returns The send options to forward to the wallet
+ */
+export function toSendOptions<W extends InteractionWaitOptions = undefined>(
+  options: SendInteractionOptions<W>,
+): SendOptions<W> {
+  return {
+    ...options,
+    fee: {
+      // If a payment method that includes gas settings was used,
+      // try to reuse as much as possible while still allowing
+      // manual override. CAREFUL: this can cause mismatches during proving
+      gasSettings: {
+        ...options.fee?.paymentMethod?.getGasSettings(),
+        ...options.fee?.gasSettings,
+      },
+    },
+    wait: options.wait, // Pass through wait option
+  };
+}
+
+/**
+ * Transforms and cleans up the higher level SimulateInteractionOptions defined by the interaction into
+ * SimulateOptions, which are the ones that can be serialized and forwarded to the wallet
+ */
+export function toSimulateOptions(options: SimulateInteractionOptions): SimulateOptions {
+  return {
+    ...options,
+    fee: {
+      // If a payment method that includes gas settings was used,
+      // try to reuse as much as possible while still allowing
+      // manual override. CAREFUL: this can cause mismatches during proving
+      gasSettings: {
+        ...options.fee?.paymentMethod?.getGasSettings(),
+        ...options.fee?.gasSettings,
+      },
+      estimateGas: options.fee?.estimateGas,
+      estimatedGasPadding: options.fee?.estimatedGasPadding,
+    },
+  };
+}
+
+/**
+ * Transforms and cleans up the higher level ProfileInteractionOptions defined by the interaction into
+ * ProfileOptions, which are the ones that can be serialized and forwarded to the wallet
+ */
+export function toProfileOptions(options: ProfileInteractionOptions): ProfileOptions {
+  return {
+    ...toSimulateOptions(options),
+    profileMode: options.profileMode,
+    skipProofGeneration: options.skipProofGeneration,
+  };
+}

package/src/contract/protocol_contracts/auth-registry.ts

@@ -0,0 +1,351 @@
+/* Autogenerated file, do not edit! */
+/* eslint-disable */
+import { ProtocolContractAddress } from '@aztec/protocol-contracts';
+import { FunctionType } from '@aztec/stdlib/abi';
+
+import type { ContractArtifact } from '../../api/abi.js';
+import { PublicKeys } from '../../api/keys.js';
+import type {
+  AztecAddressLike,
+  EthAddressLike,
+  FieldLike,
+  FunctionSelectorLike,
+  WrappedFieldLike,
+} from '../../utils/abi_types.js';
+import type { Wallet } from '../../wallet/wallet.js';
+import { ContractBase, type ContractMethod } from '../contract_base.js';
+import { ContractFunctionInteraction } from '../contract_function_interaction.js';
+
+const AuthRegistryContractArtifact: ContractArtifact = {
+  name: 'AuthRegistry',
+  functions: [
+    {
+      ...{
+        functionType: FunctionType.PUBLIC,
+        name: 'public_dispatch',
+        isOnlySelf: false,
+        isStatic: false,
+        isInitializer: false,
+        parameters: [{ name: 'selector', type: { kind: 'field' }, visibility: 'private' }],
+        returnTypes: [],
+        errorTypes: {
+          '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+          '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
+          '5525725861591553972': { error_kind: 'string', string: 'rejecting all' },
+          '11691217184967371519': {
+            error_kind: 'string',
+            string: 'Function is_reject_all can only be called statically',
+          },
+          '12511970388699677811': { error_kind: 'fmtstring', length: 27, item_types: [{ kind: 'field' }] },
+          '13455385521185560676': {
+            error_kind: 'string',
+            string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
+          },
+          '13929691561421487185': {
+            error_kind: 'string',
+            string: 'Function _set_authorized can only be called by the same contract',
+          },
+          '14990209321349310352': { error_kind: 'string', string: 'attempt to add with overflow' },
+          '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+          '16431471497789672479': { error_kind: 'string', string: 'Index out of bounds' },
+          '17089945683942782951': { error_kind: 'string', string: 'unauthorized' },
+          '17312933876399746100': {
+            error_kind: 'string',
+            string: 'Function is_consumable can only be called statically',
+          },
+        },
+      },
+      bytecode: Buffer.from([]),
+      debugSymbols: '',
+    },
+    {
+      ...{
+        functionType: FunctionType.PRIVATE,
+        name: 'set_authorized_private',
+        isOnlySelf: false,
+        isStatic: false,
+        isInitializer: false,
+        parameters: [
+          {
+            name: 'approver',
+            type: {
+              kind: 'struct',
+              fields: [{ name: 'inner', type: { kind: 'field' } }],
+              path: 'aztec::protocol_types::address::aztec_address::AztecAddress',
+            },
+            visibility: 'private',
+          },
+          { name: 'message_hash', type: { kind: 'field' }, visibility: 'private' },
+          { name: 'authorize', type: { kind: 'boolean' }, visibility: 'private' },
+        ],
+        returnTypes: [],
+        errorTypes: {
+          '7555607922535724711': { error_kind: 'string', string: 'Preimage mismatch' },
+          '9894212961085021188': { error_kind: 'string', string: 'Message not authorized by account' },
+          '14990209321349310352': { error_kind: 'string', string: 'attempt to add with overflow' },
+          '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+        },
+      },
+      bytecode: Buffer.from([]),
+      debugSymbols: '',
+    },
+    {
+      ...{
+        functionType: FunctionType.UTILITY,
+        name: 'utility_is_consumable',
+        isOnlySelf: false,
+        isStatic: false,
+        isInitializer: false,
+        parameters: [
+          {
+            name: 'on_behalf_of',
+            type: {
+              kind: 'struct',
+              fields: [{ name: 'inner', type: { kind: 'field' } }],
+              path: 'aztec::protocol_types::address::aztec_address::AztecAddress',
+            },
+            visibility: 'private',
+          },
+          { name: 'message_hash', type: { kind: 'field' }, visibility: 'private' },
+        ],
+        returnTypes: [{ kind: 'boolean' }],
+        errorTypes: {
+          '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+          '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
+          '13455385521185560676': {
+            error_kind: 'string',
+            string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
+          },
+          '14990209321349310352': { error_kind: 'string', string: 'attempt to add with overflow' },
+          '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+          '16431471497789672479': { error_kind: 'string', string: 'Index out of bounds' },
+        },
+      },
+      bytecode: Buffer.from([]),
+      debugSymbols: '',
+    },
+  ],
+  nonDispatchPublicFunctions: [
+    {
+      functionType: FunctionType.PUBLIC,
+      name: '_set_authorized',
+      isOnlySelf: true,
+      isStatic: false,
+      isInitializer: false,
+      parameters: [
+        {
+          name: 'approver',
+          type: {
+            kind: 'struct',
+            fields: [{ name: 'inner', type: { kind: 'field' } }],
+            path: 'aztec::protocol_types::address::aztec_address::AztecAddress',
+          },
+          visibility: 'private',
+        },
+        { name: 'message_hash', type: { kind: 'field' }, visibility: 'private' },
+        { name: 'authorize', type: { kind: 'boolean' }, visibility: 'private' },
+      ],
+      returnTypes: [],
+      errorTypes: {
+        '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+        '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
+        '13455385521185560676': {
+          error_kind: 'string',
+          string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
+        },
+        '13929691561421487185': {
+          error_kind: 'string',
+          string: 'Function _set_authorized can only be called by the same contract',
+        },
+        '14990209321349310352': { error_kind: 'string', string: 'attempt to add with overflow' },
+        '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+        '16431471497789672479': { error_kind: 'string', string: 'Index out of bounds' },
+      },
+    },
+    {
+      functionType: FunctionType.PUBLIC,
+      name: 'consume',
+      isOnlySelf: false,
+      isStatic: false,
+      isInitializer: false,
+      parameters: [
+        {
+          name: 'on_behalf_of',
+          type: {
+            kind: 'struct',
+            fields: [{ name: 'inner', type: { kind: 'field' } }],
+            path: 'aztec::protocol_types::address::aztec_address::AztecAddress',
+          },
+          visibility: 'private',
+        },
+        { name: 'inner_hash', type: { kind: 'field' }, visibility: 'private' },
+      ],
+      returnTypes: [{ kind: 'field' }],
+      errorTypes: {
+        '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+        '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
+        '5525725861591553972': { error_kind: 'string', string: 'rejecting all' },
+        '13455385521185560676': {
+          error_kind: 'string',
+          string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
+        },
+        '14990209321349310352': { error_kind: 'string', string: 'attempt to add with overflow' },
+        '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+        '16431471497789672479': { error_kind: 'string', string: 'Index out of bounds' },
+        '17089945683942782951': { error_kind: 'string', string: 'unauthorized' },
+      },
+    },
+    {
+      functionType: FunctionType.PUBLIC,
+      name: 'is_consumable',
+      isOnlySelf: false,
+      isStatic: true,
+      isInitializer: false,
+      parameters: [
+        {
+          name: 'on_behalf_of',
+          type: {
+            kind: 'struct',
+            fields: [{ name: 'inner', type: { kind: 'field' } }],
+            path: 'aztec::protocol_types::address::aztec_address::AztecAddress',
+          },
+          visibility: 'private',
+        },
+        { name: 'message_hash', type: { kind: 'field' }, visibility: 'private' },
+      ],
+      returnTypes: [{ kind: 'boolean' }],
+      errorTypes: {
+        '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+        '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
+        '13455385521185560676': {
+          error_kind: 'string',
+          string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
+        },
+        '14990209321349310352': { error_kind: 'string', string: 'attempt to add with overflow' },
+        '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+        '16431471497789672479': { error_kind: 'string', string: 'Index out of bounds' },
+        '17312933876399746100': {
+          error_kind: 'string',
+          string: 'Function is_consumable can only be called statically',
+        },
+      },
+    },
+    {
+      functionType: FunctionType.PUBLIC,
+      name: 'is_reject_all',
+      isOnlySelf: false,
+      isStatic: true,
+      isInitializer: false,
+      parameters: [
+        {
+          name: 'on_behalf_of',
+          type: {
+            kind: 'struct',
+            fields: [{ name: 'inner', type: { kind: 'field' } }],
+            path: 'aztec::protocol_types::address::aztec_address::AztecAddress',
+          },
+          visibility: 'private',
+        },
+      ],
+      returnTypes: [{ kind: 'boolean' }],
+      errorTypes: {
+        '11691217184967371519': {
+          error_kind: 'string',
+          string: 'Function is_reject_all can only be called statically',
+        },
+        '13455385521185560676': {
+          error_kind: 'string',
+          string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
+        },
+        '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+      },
+    },
+    {
+      functionType: FunctionType.PUBLIC,
+      name: 'set_authorized',
+      isOnlySelf: false,
+      isStatic: false,
+      isInitializer: false,
+      parameters: [
+        { name: 'message_hash', type: { kind: 'field' }, visibility: 'private' },
+        { name: 'authorize', type: { kind: 'boolean' }, visibility: 'private' },
+      ],
+      returnTypes: [],
+      errorTypes: {
+        '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+        '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
+        '13455385521185560676': {
+          error_kind: 'string',
+          string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
+        },
+        '14990209321349310352': { error_kind: 'string', string: 'attempt to add with overflow' },
+        '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+        '16431471497789672479': { error_kind: 'string', string: 'Index out of bounds' },
+      },
+    },
+    {
+      functionType: FunctionType.PUBLIC,
+      name: 'set_reject_all',
+      isOnlySelf: false,
+      isStatic: false,
+      isInitializer: false,
+      parameters: [{ name: 'reject', type: { kind: 'boolean' }, visibility: 'private' }],
+      returnTypes: [],
+      errorTypes: {
+        '13455385521185560676': {
+          error_kind: 'string',
+          string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
+        },
+        '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+      },
+    },
+  ],
+  outputs: { structs: {}, globals: {} },
+  storageLayout: {},
+  fileMap: {},
+};
+
+export class AuthRegistryContract extends ContractBase {
+  private constructor(wallet: Wallet) {
+    super(ProtocolContractAddress.AuthRegistry, AuthRegistryContractArtifact, wallet);
+  }
+
+  public static at(wallet: Wallet): AuthRegistryContract {
+    return new AuthRegistryContract(wallet);
+  }
+
+  declare public methods: {
+    /** consume(on_behalf_of: struct, inner_hash: field) */
+    consume: ((on_behalf_of: AztecAddressLike, inner_hash: FieldLike) => ContractFunctionInteraction) &
+      Pick<ContractMethod, 'selector'>;
+
+    /** is_consumable(on_behalf_of: struct, message_hash: field) */
+    is_consumable: ((on_behalf_of: AztecAddressLike, message_hash: FieldLike) => ContractFunctionInteraction) &
+      Pick<ContractMethod, 'selector'>;
+
+    /** is_reject_all(on_behalf_of: struct) */
+    is_reject_all: ((on_behalf_of: AztecAddressLike) => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
+
+    /** public_dispatch(selector: field) */
+    public_dispatch: ((selector: FieldLike) => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
+
+    /** set_authorized(message_hash: field, authorize: boolean) */
+    set_authorized: ((message_hash: FieldLike, authorize: boolean) => ContractFunctionInteraction) &
+      Pick<ContractMethod, 'selector'>;
+
+    /** set_authorized_private(approver: struct, message_hash: field, authorize: boolean) */
+    set_authorized_private: ((
+      approver: AztecAddressLike,
+      message_hash: FieldLike,
+      authorize: boolean,
+    ) => ContractFunctionInteraction) &
+      Pick<ContractMethod, 'selector'>;
+
+    /** set_reject_all(reject: boolean) */
+    set_reject_all: ((reject: boolean) => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
+
+    /** utility_is_consumable(on_behalf_of: struct, message_hash: field) */
+    utility_is_consumable: ((on_behalf_of: AztecAddressLike, message_hash: FieldLike) => ContractFunctionInteraction) &
+      Pick<ContractMethod, 'selector'>;
+  };
+}