@aztec/aztec.js 0.0.1-commit.f295ac2 → 0.0.1-commit.fc805bf

package/src/wallet/wallet.ts

@@ -15,6 +15,7 @@ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { type ContractInstanceWithAddress, ContractInstanceWithAddressSchema } from '@aztec/stdlib/contract';
 import { Gas } from '@aztec/stdlib/gas';
 import { AbiDecodedSchema, type ApiSchemaFor, optional, schemas, zodFor } from '@aztec/stdlib/schemas';
+import type { ExecutionPayload, InTx } from '@aztec/stdlib/tx';
 import {
   Capsule,
   HashedValues,
@@ -25,18 +26,21 @@ import {
   UtilitySimulationResult,
   inTxSchema,
 } from '@aztec/stdlib/tx';
-import type { ExecutionPayload, InTx } from '@aztec/stdlib/tx';
 
 import { z } from 'zod';
 
-import type {
-  FeeEstimationOptions,
-  GasSettingsOption,
-  ProfileInteractionOptions,
-  SendInteractionOptions,
-  SimulateInteractionOptions,
+import {
+  type FeeEstimationOptions,
+  type GasSettingsOption,
+  type InteractionWaitOptions,
+  NO_WAIT,
+  type ProfileInteractionOptions,
+  type SendInteractionOptionsWithoutWait,
+  type SendReturn,
+  type SimulateInteractionOptions,
 } from '../contract/interaction_options.js';
 import type { CallIntent, IntentInnerHash } from '../utils/authwit.js';
+import type { AppCapabilities, WalletCapabilities } from './capabilities.js';
 
 /**
  * A wrapper type that allows any item to be associated with an alias.
@@ -77,9 +81,14 @@ export type ProfileOptions = Omit<ProfileInteractionOptions, 'fee'> & {
  * a simplified version that only hints at the wallet whether the interaction contains a
  * fee payment method or not
  */
-export type SendOptions = Omit<SendInteractionOptions, 'fee'> & {
+export type SendOptions<W extends InteractionWaitOptions = undefined> = Omit<
+  SendInteractionOptionsWithoutWait,
+  'fee'
+> & {
   /** The fee options */
   fee?: GasSettingsOption;
+  /** Whether to wait for the transaction to be mined */
+  wait?: W;
 };
 
 /**
@@ -197,7 +206,6 @@ export type Wallet = {
     eventFilter: PrivateEventFilter,
   ): Promise<PrivateEvent<T>[]>;
   getChainInfo(): Promise<ChainInfo>;
-  getTxReceipt(txHash: TxHash): Promise<TxReceipt>;
   getContractMetadata(address: AztecAddress): Promise<ContractMetadata>;
   getContractClassMetadata(id: Fr): Promise<ContractClassMetadata>;
   registerSender(address: AztecAddress, alias?: string): Promise<AztecAddress>;
@@ -211,8 +219,12 @@ export type Wallet = {
   simulateTx(exec: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult>;
   simulateUtility(call: FunctionCall, authwits?: AuthWitness[]): Promise<UtilitySimulationResult>;
   profileTx(exec: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult>;
-  sendTx(exec: ExecutionPayload, opts: SendOptions): Promise<TxHash>;
-  createAuthWit(from: AztecAddress, messageHashOrIntent: Fr | IntentInnerHash | CallIntent): Promise<AuthWitness>;
+  sendTx<W extends InteractionWaitOptions = undefined>(
+    exec: ExecutionPayload,
+    opts: SendOptions<W>,
+  ): Promise<SendReturn<W>>;
+  createAuthWit(from: AztecAddress, messageHashOrIntent: IntentInnerHash | CallIntent): Promise<AuthWitness>;
+  requestCapabilities(manifest: AppCapabilities): Promise<WalletCapabilities>;
   batch<const T extends readonly BatchedMethod[]>(methods: T): Promise<BatchResults<T>>;
 };
 
@@ -251,11 +263,19 @@ export const WalletSimulationFeeOptionSchema = GasSettingsOptionSchema.extend({
   estimateGas: optional(z.boolean()),
 });
 
+export const WaitOptsSchema = z.object({
+  ignoreDroppedReceiptsFor: optional(z.number()),
+  timeout: optional(z.number()),
+  interval: optional(z.number()),
+  dontThrowOnRevert: optional(z.boolean()),
+});
+
 export const SendOptionsSchema = z.object({
   from: schemas.AztecAddress,
   authWitnesses: optional(z.array(AuthWitness.schema)),
   capsules: optional(z.array(Capsule.schema)),
   fee: optional(GasSettingsOptionSchema),
+  wait: optional(z.union([z.literal(NO_WAIT), WaitOptsSchema])),
 });
 
 export const SimulateOptionsSchema = z.object({
@@ -274,7 +294,6 @@ export const ProfileOptionsSchema = SimulateOptionsSchema.extend({
 });
 
 export const MessageHashOrIntentSchema = z.union([
-  schemas.Fr,
   z.object({ consumer: schemas.AztecAddress, innerHash: schemas.Fr }),
   z.object({
     caller: schemas.AztecAddress,
@@ -316,6 +335,119 @@ export const ContractClassMetadataSchema = z.object({
   isContractClassPubliclyRegistered: z.boolean(),
 });
 
+export const ContractFunctionPatternSchema = z.object({
+  contract: z.union([schemas.AztecAddress, z.literal('*')]),
+  function: z.union([z.string(), z.literal('*')]),
+});
+
+export const AccountsCapabilitySchema = z.object({
+  type: z.literal('accounts'),
+  canGet: optional(z.boolean()),
+  canCreateAuthWit: optional(z.boolean()),
+});
+
+export const GrantedAccountsCapabilitySchema = AccountsCapabilitySchema.extend({
+  accounts: z.array(z.object({ alias: z.string(), item: schemas.AztecAddress })),
+});
+
+export const ContractsCapabilitySchema = z.object({
+  type: z.literal('contracts'),
+  contracts: z.union([z.literal('*'), z.array(schemas.AztecAddress)]),
+  canRegister: optional(z.boolean()),
+  canGetMetadata: optional(z.boolean()),
+});
+
+export const GrantedContractsCapabilitySchema = ContractsCapabilitySchema;
+
+export const ContractClassesCapabilitySchema = z.object({
+  type: z.literal('contractClasses'),
+  classes: z.union([z.literal('*'), z.array(schemas.Fr)]),
+  canGetMetadata: z.boolean(),
+});
+
+export const GrantedContractClassesCapabilitySchema = ContractClassesCapabilitySchema;
+
+export const SimulationCapabilitySchema = z.object({
+  type: z.literal('simulation'),
+  transactions: optional(
+    z.object({
+      scope: z.union([z.literal('*'), z.array(ContractFunctionPatternSchema)]),
+    }),
+  ),
+  utilities: optional(
+    z.object({
+      scope: z.union([z.literal('*'), z.array(ContractFunctionPatternSchema)]),
+    }),
+  ),
+});
+
+export const GrantedSimulationCapabilitySchema = SimulationCapabilitySchema;
+
+export const TransactionCapabilitySchema = z.object({
+  type: z.literal('transaction'),
+  scope: z.union([z.literal('*'), z.array(ContractFunctionPatternSchema)]),
+});
+
+export const GrantedTransactionCapabilitySchema = TransactionCapabilitySchema;
+
+export const DataCapabilitySchema = z.object({
+  type: z.literal('data'),
+  addressBook: optional(z.boolean()),
+  privateEvents: optional(
+    z.object({
+      contracts: z.union([z.literal('*'), z.array(schemas.AztecAddress)]),
+    }),
+  ),
+});
+
+export const GrantedDataCapabilitySchema = DataCapabilitySchema;
+
+export const CapabilitySchema = z.discriminatedUnion('type', [
+  AccountsCapabilitySchema,
+  ContractsCapabilitySchema,
+  ContractClassesCapabilitySchema,
+  SimulationCapabilitySchema,
+  TransactionCapabilitySchema,
+  DataCapabilitySchema,
+]);
+
+export const GrantedCapabilitySchema = z.discriminatedUnion('type', [
+  GrantedAccountsCapabilitySchema,
+  GrantedContractsCapabilitySchema,
+  GrantedContractClassesCapabilitySchema,
+  GrantedSimulationCapabilitySchema,
+  GrantedTransactionCapabilitySchema,
+  GrantedDataCapabilitySchema,
+]);
+
+export const AppCapabilitiesSchema = z.object({
+  version: z.literal('1.0'),
+  metadata: z.object({
+    name: z.string(),
+    version: z.string(),
+    description: optional(z.string()),
+    url: optional(z.string()),
+    icon: optional(z.string()),
+  }),
+  capabilities: z.array(CapabilitySchema),
+  behavior: optional(
+    z.object({
+      mode: optional(z.enum(['strict', 'permissive'])),
+      expiration: optional(z.number()),
+    }),
+  ),
+});
+
+export const WalletCapabilitiesSchema = z.object({
+  version: z.literal('1.0'),
+  granted: z.array(GrantedCapabilitySchema),
+  wallet: z.object({
+    name: z.string(),
+    version: z.string(),
+  }),
+  expiresAt: optional(z.number()),
+});
+
 /**
  * Record of all wallet method schemas (excluding batch).
  * This is the single source of truth for method schemas - batch schemas are derived from this.
@@ -325,7 +457,6 @@ const WalletMethodSchemas = {
     .function()
     .args()
     .returns(z.object({ chainId: schemas.Fr, version: schemas.Fr })),
-  getTxReceipt: z.function().args(TxHash.schema).returns(TxReceipt.schema),
   getContractMetadata: z.function().args(schemas.AztecAddress).returns(ContractMetadataSchema),
   getContractClassMetadata: z.function().args(schemas.Fr).returns(ContractClassMetadataSchema),
   getPrivateEvents: z
@@ -351,8 +482,12 @@ const WalletMethodSchemas = {
     .args(FunctionCallSchema, optional(z.array(AuthWitness.schema)))
     .returns(UtilitySimulationResult.schema),
   profileTx: z.function().args(ExecutionPayloadSchema, ProfileOptionsSchema).returns(TxProfileResult.schema),
-  sendTx: z.function().args(ExecutionPayloadSchema, SendOptionsSchema).returns(TxHash.schema),
+  sendTx: z
+    .function()
+    .args(ExecutionPayloadSchema, SendOptionsSchema)
+    .returns(z.union([TxHash.schema, TxReceipt.schema])),
   createAuthWit: z.function().args(schemas.AztecAddress, MessageHashOrIntentSchema).returns(AuthWitness.schema),
+  requestCapabilities: z.function().args(AppCapabilitiesSchema).returns(WalletCapabilitiesSchema),
 };
 
 /**

package/dest/account/interface.d.ts

@@ -1,19 +0,0 @@
-import type { AuthWitnessProvider, EntrypointInterface } from '@aztec/entrypoints/interfaces';
-import type { Fr } from '@aztec/foundation/curves/bn254';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { CompleteAddress } from '@aztec/stdlib/contract';
-/**
- * Handler for interfacing with an account. Knows how to create transaction execution
- * requests and authorize actions for its corresponding account.
- */
-export interface AccountInterface extends EntrypointInterface, AuthWitnessProvider {
-    /** Returns the complete address for this account. */
-    getCompleteAddress(): CompleteAddress;
-    /** Returns the address for this account. */
-    getAddress(): AztecAddress;
-    /** Returns the chain id for this account */
-    getChainId(): Fr;
-    /** Returns the rollup version for this account */
-    getVersion(): Fr;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWNjb3VudC9pbnRlcmZhY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsbUJBQW1CLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSwrQkFBK0IsQ0FBQztBQUM5RixPQUFPLEtBQUssRUFBRSxFQUFFLEVBQUUsTUFBTSxnQ0FBZ0MsQ0FBQztBQUN6RCxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUNoRSxPQUFPLEtBQUssRUFBRSxlQUFlLEVBQUUsTUFBTSx3QkFBd0IsQ0FBQztBQUk5RDs7O0dBR0c7QUFDSCxNQUFNLFdBQVcsZ0JBQWlCLFNBQVEsbUJBQW1CLEVBQUUsbUJBQW1CO0lBQ2hGLHFEQUFxRDtJQUNyRCxrQkFBa0IsSUFBSSxlQUFlLENBQUM7SUFFdEMsNENBQTRDO0lBQzVDLFVBQVUsSUFBSSxZQUFZLENBQUM7SUFFM0IsNENBQTRDO0lBQzVDLFVBQVUsSUFBSSxFQUFFLENBQUM7SUFFakIsa0RBQWtEO0lBQ2xELFVBQVUsSUFBSSxFQUFFLENBQUM7Q0FDbEIifQ==

package/dest/account/interface.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../src/account/interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAC9F,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAI9D;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB,EAAE,mBAAmB;IAChF,qDAAqD;IACrD,kBAAkB,IAAI,eAAe,CAAC;IAEtC,4CAA4C;IAC5C,UAAU,IAAI,YAAY,CAAC;IAE3B,4CAA4C;IAC5C,UAAU,IAAI,EAAE,CAAC;IAEjB,kDAAkD;IAClD,UAAU,IAAI,EAAE,CAAC;CAClB"}

package/dest/account/interface.js

@@ -1,5 +0,0 @@
-// docs:start:account-interface
-/**
- * Handler for interfacing with an account. Knows how to create transaction execution
- * requests and authorize actions for its corresponding account.
- */ export { }; // docs:end:account-interface

package/dest/contract/deploy_sent_tx.d.ts

@@ -1,48 +0,0 @@
-import type { FieldsOf } from '@aztec/foundation/types';
-import type { ContractInstanceWithAddress } from '@aztec/stdlib/contract';
-import type { TxHash, TxReceipt } from '@aztec/stdlib/tx';
-import type { Wallet } from '../wallet/wallet.js';
-import type { ContractBase } from './contract_base.js';
-import { SentTx, type WaitOpts } from './sent_tx.js';
-/** Options related to waiting for a deployment tx. */
-export type DeployedWaitOpts = WaitOpts & {
-    /** Wallet to use for creating a contract instance. Uses the one set in the deployer constructor if not set. */
-    wallet?: Wallet;
-};
-/** Extends a transaction receipt with a contract instance that represents the newly deployed contract. */
-export type DeployTxReceipt<TContract extends ContractBase = ContractBase> = FieldsOf<TxReceipt> & {
-    /** Instance of the newly deployed contract. */
-    contract: TContract;
-    /** The deployed contract instance with address and metadata. */
-    instance: ContractInstanceWithAddress;
-};
-/**
- * A contract deployment transaction sent to the network, extending SentTx with methods to publish a contract instance.
- */
-export declare class DeploySentTx<TContract extends ContractBase = ContractBase> extends SentTx {
-    private postDeployCtor;
-    /** A getter for the deployed contract instance */
-    private instanceGetter;
-    private log;
-    constructor(wallet: Wallet, sendTx: () => Promise<TxHash>, postDeployCtor: (instance: ContractInstanceWithAddress, wallet: Wallet) => TContract, 
-    /** A getter for the deployed contract instance */
-    instanceGetter: () => Promise<ContractInstanceWithAddress>);
-    /**
-     * Returns the contract instance for this deployment.
-     * @returns The deployed contract instance with address and metadata.
-     */
-    getInstance(): Promise<ContractInstanceWithAddress>;
-    /**
-     * Awaits for the tx to be mined and returns the contract instance. Throws if tx is not mined.
-     * @param opts - Options for configuring the waiting for the tx to be mined.
-     * @returns The deployed contract instance.
-     */
-    deployed(opts?: DeployedWaitOpts): Promise<TContract>;
-    /**
-     * Awaits for the tx to be mined and returns the receipt along with a contract instance. Throws if tx is not mined.
-     * @param opts - Options for configuring the waiting for the tx to be mined.
-     * @returns The transaction receipt with the deployed contract instance.
-     */
-    wait(opts?: DeployedWaitOpts): Promise<DeployTxReceipt<TContract>>;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVwbG95X3NlbnRfdHguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb250cmFjdC9kZXBsb3lfc2VudF90eC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEtBQUssRUFBRSxRQUFRLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQztBQUN4RCxPQUFPLEtBQUssRUFBRSwyQkFBMkIsRUFBRSxNQUFNLHdCQUF3QixDQUFDO0FBQzFFLE9BQU8sS0FBSyxFQUFFLE1BQU0sRUFBRSxTQUFTLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQUUxRCxPQUFPLEtBQUssRUFBRSxNQUFNLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUNsRCxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUN2RCxPQUFPLEVBQUUsTUFBTSxFQUFFLEtBQUssUUFBUSxFQUFFLE1BQU0sY0FBYyxDQUFDO0FBRXJELHNEQUFzRDtBQUN0RCxNQUFNLE1BQU0sZ0JBQWdCLEdBQUcsUUFBUSxHQUFHO0lBQ3hDLCtHQUErRztJQUMvRyxNQUFNLENBQUMsRUFBRSxNQUFNLENBQUM7Q0FDakIsQ0FBQztBQUVGLDBHQUEwRztBQUMxRyxNQUFNLE1BQU0sZUFBZSxDQUFDLFNBQVMsU0FBUyxZQUFZLEdBQUcsWUFBWSxJQUFJLFFBQVEsQ0FBQyxTQUFTLENBQUMsR0FBRztJQUNqRywrQ0FBK0M7SUFDL0MsUUFBUSxFQUFFLFNBQVMsQ0FBQztJQUNwQixnRUFBZ0U7SUFDaEUsUUFBUSxFQUFFLDJCQUEyQixDQUFDO0NBQ3ZDLENBQUM7QUFFRjs7R0FFRztBQUNILHFCQUFhLFlBQVksQ0FBQyxTQUFTLFNBQVMsWUFBWSxHQUFHLFlBQVksQ0FBRSxTQUFRLE1BQU07SUFNbkYsT0FBTyxDQUFDLGNBQWM7SUFDdEIsa0RBQWtEO0lBQ2xELE9BQU8sQ0FBQyxjQUFjO0lBUHhCLE9BQU8sQ0FBQyxHQUFHLENBQTBDO0lBRXJELFlBQ0UsTUFBTSxFQUFFLE1BQU0sRUFDZCxNQUFNLEVBQUUsTUFBTSxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQ3JCLGNBQWMsRUFBRSxDQUFDLFFBQVEsRUFBRSwyQkFBMkIsRUFBRSxNQUFNLEVBQUUsTUFBTSxLQUFLLFNBQVM7SUFDNUYsa0RBQWtEO0lBQzFDLGNBQWMsRUFBRSxNQUFNLE9BQU8sQ0FBQywyQkFBMkIsQ0FBQyxFQUduRTtJQUVEOzs7T0FHRztJQUNVLFdBQVcsSUFBSSxPQUFPLENBQUMsMkJBQTJCLENBQUMsQ0FFL0Q7SUFFRDs7OztPQUlHO0lBQ1UsUUFBUSxDQUFDLElBQUksQ0FBQyxFQUFFLGdCQUFnQixHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FJakU7SUFFRDs7OztPQUlHO0lBQ21CLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxnQkFBZ0IsR0FBRyxPQUFPLENBQUMsZUFBZSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBVXZGO0NBQ0YifQ==

package/dest/contract/deploy_sent_tx.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"deploy_sent_tx.d.ts","sourceRoot":"","sources":["../../src/contract/deploy_sent_tx.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAC;AAErD,sDAAsD;AACtD,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG;IACxC,+GAA+G;IAC/G,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,0GAA0G;AAC1G,MAAM,MAAM,eAAe,CAAC,SAAS,SAAS,YAAY,GAAG,YAAY,IAAI,QAAQ,CAAC,SAAS,CAAC,GAAG;IACjG,+CAA+C;IAC/C,QAAQ,EAAE,SAAS,CAAC;IACpB,gEAAgE;IAChE,QAAQ,EAAE,2BAA2B,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,qBAAa,YAAY,CAAC,SAAS,SAAS,YAAY,GAAG,YAAY,CAAE,SAAQ,MAAM;IAMnF,OAAO,CAAC,cAAc;IACtB,kDAAkD;IAClD,OAAO,CAAC,cAAc;IAPxB,OAAO,CAAC,GAAG,CAA0C;IAErD,YACE,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EACrB,cAAc,EAAE,CAAC,QAAQ,EAAE,2BAA2B,EAAE,MAAM,EAAE,MAAM,KAAK,SAAS;IAC5F,kDAAkD;IAC1C,cAAc,EAAE,MAAM,OAAO,CAAC,2BAA2B,CAAC,EAGnE;IAED;;;OAGG;IACU,WAAW,IAAI,OAAO,CAAC,2BAA2B,CAAC,CAE/D;IAED;;;;OAIG;IACU,QAAQ,CAAC,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,CAIjE;IAED;;;;OAIG;IACmB,IAAI,CAAC,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAUvF;CACF"}

package/dest/contract/deploy_sent_tx.js

@@ -1,46 +0,0 @@
-import { createLogger } from '@aztec/foundation/log';
-import { SentTx } from './sent_tx.js';
-/**
- * A contract deployment transaction sent to the network, extending SentTx with methods to publish a contract instance.
- */ export class DeploySentTx extends SentTx {
-    postDeployCtor;
-    instanceGetter;
-    log;
-    constructor(wallet, sendTx, postDeployCtor, /** A getter for the deployed contract instance */ instanceGetter){
-        super(wallet, sendTx), this.postDeployCtor = postDeployCtor, this.instanceGetter = instanceGetter, this.log = createLogger('aztecjs:deploy_sent_tx');
-    }
-    /**
-   * Returns the contract instance for this deployment.
-   * @returns The deployed contract instance with address and metadata.
-   */ async getInstance() {
-        return await this.instanceGetter();
-    }
-    /**
-   * Awaits for the tx to be mined and returns the contract instance. Throws if tx is not mined.
-   * @param opts - Options for configuring the waiting for the tx to be mined.
-   * @returns The deployed contract instance.
-   */ async deployed(opts) {
-        const receipt = await this.wait(opts);
-        this.log.info(`Contract ${receipt.instance.address.toString()} successfully deployed.`);
-        return receipt.contract;
-    }
-    /**
-   * Awaits for the tx to be mined and returns the receipt along with a contract instance. Throws if tx is not mined.
-   * @param opts - Options for configuring the waiting for the tx to be mined.
-   * @returns The transaction receipt with the deployed contract instance.
-   */ async wait(opts) {
-        const receipt = await super.wait(opts);
-        // In the case of DeploySentTx we have a guarantee that this.walletOrNode is a Wallet so we can cast it to Wallet.
-        const contractWallet = opts?.wallet ?? this.walletOrNode;
-        if (!contractWallet) {
-            throw new Error(`A wallet is required for creating a contract instance`);
-        }
-        const instance = await this.instanceGetter();
-        const contract = this.postDeployCtor(instance, contractWallet);
-        return {
-            ...receipt,
-            contract,
-            instance
-        };
-    }
-}

package/dest/contract/sent_tx.d.ts

@@ -1,50 +0,0 @@
-import type { AztecNode } from '@aztec/stdlib/interfaces/client';
-import { TxHash, type TxReceipt } from '@aztec/stdlib/tx';
-import type { Wallet } from '../wallet/wallet.js';
-/** Options related to waiting for a tx. */
-export type WaitOpts = {
-    /** The amount of time to ignore TxStatus.DROPPED receipts (in seconds) due to the presumption that it is being propagated by the p2p network. Defaults to 5. */
-    ignoreDroppedReceiptsFor?: number;
-    /** The maximum time (in seconds) to wait for the transaction to be mined. Defaults to 60. */
-    timeout?: number;
-    /** The time interval (in seconds) between retries to fetch the transaction receipt. Defaults to 1. */
-    interval?: number;
-    /** Whether to accept a revert as a status code for the tx when waiting for it. If false, will throw if the tx reverts. */
-    dontThrowOnRevert?: boolean;
-};
-export declare const DefaultWaitOpts: WaitOpts;
-/**
- * The SentTx class represents a sent transaction through the PXE (or directly to a node) providing methods to fetch
- * its hash, receipt, and mining status.
- */
-export declare class SentTx {
-    protected walletOrNode: Wallet | AztecNode;
-    protected sendTxPromise: Promise<void>;
-    protected sendTxError?: Error;
-    protected txHash?: TxHash;
-    constructor(walletOrNode: Wallet | AztecNode, sendTx: () => Promise<TxHash>);
-    /**
-     * Retrieves the transaction hash of the SentTx instance.
-     * The function internally awaits for the 'txHashPromise' to resolve, and then returns the resolved transaction hash.
-     *
-     * @returns A promise that resolves to the transaction hash of the SentTx instance.
-     * TODO(#7717): Don't throw here.
-     */
-    getTxHash(): Promise<TxHash>;
-    /**
-     * Retrieve the transaction receipt associated with the current SentTx instance.
-     * The function fetches the transaction hash using 'getTxHash' and then queries
-     * the PXE to get the corresponding transaction receipt.
-     *
-     * @returns A promise that resolves to a TxReceipt object representing the fetched transaction receipt.
-     */
-    getReceipt(): Promise<TxReceipt>;
-    /**
-     * Awaits for a tx to be mined and returns the receipt. Throws if tx is not mined.
-     * @param opts - Options for configuring the waiting for the tx to be mined.
-     * @returns The transaction receipt.
-     */
-    wait(opts?: WaitOpts): Promise<TxReceipt>;
-    protected waitForReceipt(opts?: WaitOpts): Promise<TxReceipt>;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VudF90eC5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0L3NlbnRfdHgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBRUEsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDakUsT0FBTyxFQUFFLE1BQU0sRUFBRSxLQUFLLFNBQVMsRUFBWSxNQUFNLGtCQUFrQixDQUFDO0FBRXBFLE9BQU8sS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBRWxELDJDQUEyQztBQUMzQyxNQUFNLE1BQU0sUUFBUSxHQUFHO0lBQ3JCLGdLQUFnSztJQUNoSyx3QkFBd0IsQ0FBQyxFQUFFLE1BQU0sQ0FBQztJQUNsQyw2RkFBNkY7SUFDN0YsT0FBTyxDQUFDLEVBQUUsTUFBTSxDQUFDO0lBQ2pCLHNHQUFzRztJQUN0RyxRQUFRLENBQUMsRUFBRSxNQUFNLENBQUM7SUFDbEIsMEhBQTBIO0lBQzFILGlCQUFpQixDQUFDLEVBQUUsT0FBTyxDQUFDO0NBQzdCLENBQUM7QUFFRixlQUFPLE1BQU0sZUFBZSxFQUFFLFFBSTdCLENBQUM7QUFFRjs7O0dBR0c7QUFDSCxxQkFBYSxNQUFNO0lBTWYsU0FBUyxDQUFDLFlBQVksRUFBRSxNQUFNLEdBQUcsU0FBUztJQUw1QyxTQUFTLENBQUMsYUFBYSxFQUFFLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUN2QyxTQUFTLENBQUMsV0FBVyxDQUFDLEVBQUUsS0FBSyxDQUFDO0lBQzlCLFNBQVMsQ0FBQyxNQUFNLENBQUMsRUFBRSxNQUFNLENBQUM7SUFFMUIsWUFDWSxZQUFZLEVBQUUsTUFBTSxHQUFHLFNBQVMsRUFDMUMsTUFBTSxFQUFFLE1BQU0sT0FBTyxDQUFDLE1BQU0sQ0FBQyxFQWM5QjtJQUVEOzs7Ozs7T0FNRztJQUNVLFNBQVMsSUFBSSxPQUFPLENBQUMsTUFBTSxDQUFDLENBV3hDO0lBRUQ7Ozs7OztPQU1HO0lBQ1UsVUFBVSxJQUFJLE9BQU8sQ0FBQyxTQUFTLENBQUMsQ0FHNUM7SUFFRDs7OztPQUlHO0lBQ1UsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLFFBQVEsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLENBUXJEO0lBRUQsVUFBZ0IsY0FBYyxDQUFDLElBQUksQ0FBQyxFQUFFLFFBQVEsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLENBNEJsRTtDQUNGIn0=

package/dest/contract/sent_tx.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sent_tx.d.ts","sourceRoot":"","sources":["../../src/contract/sent_tx.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,KAAK,SAAS,EAAY,MAAM,kBAAkB,CAAC;AAEpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAElD,2CAA2C;AAC3C,MAAM,MAAM,QAAQ,GAAG;IACrB,gKAAgK;IAChK,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,6FAA6F;IAC7F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sGAAsG;IACtG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0HAA0H;IAC1H,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,QAI7B,CAAC;AAEF;;;GAGG;AACH,qBAAa,MAAM;IAMf,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS;IAL5C,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,SAAS,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC;IAC9B,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAE1B,YACY,YAAY,EAAE,MAAM,GAAG,SAAS,EAC1C,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EAc9B;IAED;;;;;;OAMG;IACU,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAWxC;IAED;;;;;;OAMG;IACU,UAAU,IAAI,OAAO,CAAC,SAAS,CAAC,CAG5C;IAED;;;;OAIG;IACU,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAQrD;IAED,UAAgB,cAAc,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CA4BlE;CACF"}

package/dest/contract/sent_tx.js

@@ -1,90 +0,0 @@
-import { promiseWithResolvers } from '@aztec/foundation/promise';
-import { retryUntil } from '@aztec/foundation/retry';
-import { TxStatus } from '@aztec/stdlib/tx';
-export const DefaultWaitOpts = {
-    ignoreDroppedReceiptsFor: 5,
-    timeout: 300,
-    interval: 1
-};
-/**
- * The SentTx class represents a sent transaction through the PXE (or directly to a node) providing methods to fetch
- * its hash, receipt, and mining status.
- */ export class SentTx {
-    walletOrNode;
-    sendTxPromise;
-    sendTxError;
-    txHash;
-    constructor(walletOrNode, sendTx){
-        this.walletOrNode = walletOrNode;
-        const { promise, resolve } = promiseWithResolvers();
-        this.sendTxPromise = promise;
-        sendTx().then((txHash)=>{
-            this.txHash = txHash;
-            resolve();
-        }).catch((err)=>{
-            this.sendTxError = err;
-            // Calling resolve instead of reject here because we want to throw the error when getTxHash is called.
-            resolve();
-        });
-    }
-    /**
-   * Retrieves the transaction hash of the SentTx instance.
-   * The function internally awaits for the 'txHashPromise' to resolve, and then returns the resolved transaction hash.
-   *
-   * @returns A promise that resolves to the transaction hash of the SentTx instance.
-   * TODO(#7717): Don't throw here.
-   */ async getTxHash() {
-        // Make sure sendTx has been resolved, which can be triggered when it returns a txHash or when it throws an error.
-        await this.sendTxPromise;
-        // If sendTx threw an error, throw it.
-        if (this.sendTxError) {
-            throw this.sendTxError;
-        }
-        // sendTx returned a txHash if it's been resolved and no error was set.
-        return Promise.resolve(this.txHash);
-    }
-    /**
-   * Retrieve the transaction receipt associated with the current SentTx instance.
-   * The function fetches the transaction hash using 'getTxHash' and then queries
-   * the PXE to get the corresponding transaction receipt.
-   *
-   * @returns A promise that resolves to a TxReceipt object representing the fetched transaction receipt.
-   */ async getReceipt() {
-        const txHash = await this.getTxHash();
-        return await this.walletOrNode.getTxReceipt(txHash);
-    }
-    /**
-   * Awaits for a tx to be mined and returns the receipt. Throws if tx is not mined.
-   * @param opts - Options for configuring the waiting for the tx to be mined.
-   * @returns The transaction receipt.
-   */ async wait(opts) {
-        const receipt = await this.waitForReceipt(opts);
-        if (receipt.status !== TxStatus.SUCCESS && !opts?.dontThrowOnRevert) {
-            throw new Error(`Transaction ${(await this.getTxHash()).toString()} was ${receipt.status}. Reason: ${receipt.error ?? 'unknown'}`);
-        }
-        return receipt;
-    }
-    async waitForReceipt(opts) {
-        const txHash = await this.getTxHash();
-        const startTime = Date.now();
-        const ignoreDroppedReceiptsFor = opts?.ignoreDroppedReceiptsFor ?? DefaultWaitOpts.ignoreDroppedReceiptsFor;
-        return await retryUntil(async ()=>{
-            const txReceipt = await this.walletOrNode.getTxReceipt(txHash);
-            // If receipt is not yet available, try again
-            if (txReceipt.status === TxStatus.PENDING) {
-                return undefined;
-            }
-            // If the tx was "dropped", either return it or ignore based on timing.
-            // We can ignore it at first because the transaction may have been sent to node 1, and now we're asking node 2 for the receipt.
-            // If we don't allow a short grace period, we could incorrectly return a TxReceipt with status DROPPED.
-            if (txReceipt.status === TxStatus.DROPPED) {
-                const elapsedSeconds = (Date.now() - startTime) / 1000;
-                if (!ignoreDroppedReceiptsFor || elapsedSeconds > ignoreDroppedReceiptsFor) {
-                    return txReceipt;
-                }
-                return undefined;
-            }
-            return txReceipt;
-        }, 'isMined', opts?.timeout ?? DefaultWaitOpts.timeout, opts?.interval ?? DefaultWaitOpts.interval);
-    }
-}

package/src/account/interface.ts

@@ -1,25 +0,0 @@
-import type { AuthWitnessProvider, EntrypointInterface } from '@aztec/entrypoints/interfaces';
-import type { Fr } from '@aztec/foundation/curves/bn254';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { CompleteAddress } from '@aztec/stdlib/contract';
-
-// docs:start:account-interface
-
-/**
- * Handler for interfacing with an account. Knows how to create transaction execution
- * requests and authorize actions for its corresponding account.
- */
-export interface AccountInterface extends EntrypointInterface, AuthWitnessProvider {
-  /** Returns the complete address for this account. */
-  getCompleteAddress(): CompleteAddress;
-
-  /** Returns the address for this account. */
-  getAddress(): AztecAddress;
-
-  /** Returns the chain id for this account */
-  getChainId(): Fr;
-
-  /** Returns the rollup version for this account */
-  getVersion(): Fr;
-}
-// docs:end:account-interface

package/src/contract/deploy_sent_tx.ts

@@ -1,75 +0,0 @@
-import { createLogger } from '@aztec/foundation/log';
-import type { FieldsOf } from '@aztec/foundation/types';
-import type { ContractInstanceWithAddress } from '@aztec/stdlib/contract';
-import type { TxHash, TxReceipt } from '@aztec/stdlib/tx';
-
-import type { Wallet } from '../wallet/wallet.js';
-import type { ContractBase } from './contract_base.js';
-import { SentTx, type WaitOpts } from './sent_tx.js';
-
-/** Options related to waiting for a deployment tx. */
-export type DeployedWaitOpts = WaitOpts & {
-  /** Wallet to use for creating a contract instance. Uses the one set in the deployer constructor if not set. */
-  wallet?: Wallet;
-};
-
-/** Extends a transaction receipt with a contract instance that represents the newly deployed contract. */
-export type DeployTxReceipt<TContract extends ContractBase = ContractBase> = FieldsOf<TxReceipt> & {
-  /** Instance of the newly deployed contract. */
-  contract: TContract;
-  /** The deployed contract instance with address and metadata. */
-  instance: ContractInstanceWithAddress;
-};
-
-/**
- * A contract deployment transaction sent to the network, extending SentTx with methods to publish a contract instance.
- */
-export class DeploySentTx<TContract extends ContractBase = ContractBase> extends SentTx {
-  private log = createLogger('aztecjs:deploy_sent_tx');
-
-  constructor(
-    wallet: Wallet,
-    sendTx: () => Promise<TxHash>,
-    private postDeployCtor: (instance: ContractInstanceWithAddress, wallet: Wallet) => TContract,
-    /** A getter for the deployed contract instance */
-    private instanceGetter: () => Promise<ContractInstanceWithAddress>,
-  ) {
-    super(wallet, sendTx);
-  }
-
-  /**
-   * Returns the contract instance for this deployment.
-   * @returns The deployed contract instance with address and metadata.
-   */
-  public async getInstance(): Promise<ContractInstanceWithAddress> {
-    return await this.instanceGetter();
-  }
-
-  /**
-   * Awaits for the tx to be mined and returns the contract instance. Throws if tx is not mined.
-   * @param opts - Options for configuring the waiting for the tx to be mined.
-   * @returns The deployed contract instance.
-   */
-  public async deployed(opts?: DeployedWaitOpts): Promise<TContract> {
-    const receipt = await this.wait(opts);
-    this.log.info(`Contract ${receipt.instance.address.toString()} successfully deployed.`);
-    return receipt.contract;
-  }
-
-  /**
-   * Awaits for the tx to be mined and returns the receipt along with a contract instance. Throws if tx is not mined.
-   * @param opts - Options for configuring the waiting for the tx to be mined.
-   * @returns The transaction receipt with the deployed contract instance.
-   */
-  public override async wait(opts?: DeployedWaitOpts): Promise<DeployTxReceipt<TContract>> {
-    const receipt = await super.wait(opts);
-    // In the case of DeploySentTx we have a guarantee that this.walletOrNode is a Wallet so we can cast it to Wallet.
-    const contractWallet = opts?.wallet ?? (this.walletOrNode as Wallet);
-    if (!contractWallet) {
-      throw new Error(`A wallet is required for creating a contract instance`);
-    }
-    const instance = await this.instanceGetter();
-    const contract = this.postDeployCtor(instance, contractWallet) as TContract;
-    return { ...receipt, contract, instance };
-  }
-}