@aztec/aztec.js 0.0.0-test.0

package/README.md

@@ -0,0 +1,44 @@
+# Aztec.js
+
+Aztec.js is a library that provides APIs for managing accounts and interacting with contracts on the Aztec network. It communicates with the [Private eXecution Environment (PXE)](https://docs.aztec.network/developers/reference/aztecjs/pxe) through a `PXE` implementation, allowing developers to easily register new accounts, deploy contracts, view functions, and send transactions.
+
+## Installing
+
+```
+npm install @aztec/aztec.js
+```
+
+## Usage
+
+Use the `@aztec/accounts` package in order to create and manage accounts, and acquire a `Wallet` object needed to send transactions and interact with the network.
+
+### Deploy a contract
+
+```typescript
+import { Contract } from '@aztec/aztec.js';
+
+const contract = await Contract.deploy(wallet, MyContractArtifact, [...constructorArgs])
+  .send()
+  .deployed();
+console.log(`Contract deployed at ${contract.address}`);
+```
+
+### Send a transaction
+
+```typescript
+import { Contract } from '@aztec/aztec.js';
+
+const contract = await Contract.at(contractAddress, MyContractArtifact, wallet);
+const tx = await contract.methods.transfer(amount, recipientAddress).send().wait();
+console.log(`Transferred ${amount} to ${recipientAddress} on block ${tx.blockNumber}`);
+```
+
+### Simulate a function
+
+```typescript
+import { Contract } from '@aztec/aztec.js';
+
+const contract = await Contract.at(contractAddress, MyContractArtifact, wallet);
+const balance = await contract.methods.get_balance(wallet.getAddress()).simulate();
+console.log(`Account balance is ${balance}`);
+```

package/dest/account/contract.d.ts

@@ -0,0 +1,37 @@
+import { Fr } from '@aztec/foundation/fields';
+import type { ContractArtifact } from '@aztec/stdlib/abi';
+import type { CompleteAddress, NodeInfo } from '@aztec/stdlib/contract';
+import type { AccountInterface, AuthWitnessProvider } from './interface.js';
+/**
+ * An account contract instance. Knows its artifact, deployment arguments, how to create
+ * transaction execution requests out of function calls, and how to authorize actions.
+ */
+export interface AccountContract {
+    /**
+     * Returns the artifact of this account contract.
+     */
+    getContractArtifact(): Promise<ContractArtifact>;
+    /**
+     * Returns the deployment arguments for this instance, or undefined if this contract does not require deployment.
+     */
+    getDeploymentArgs(): Promise<any[] | undefined>;
+    /**
+     * Returns the account interface for this account contract given a deployment at the provided address.
+     * The account interface is responsible for assembling tx requests given requested function calls, and
+     * for creating signed auth witnesses given action identifiers (message hashes).
+     * @param address - Address where this account contract is deployed.
+     * @param nodeInfo - Info on the chain where it is deployed.
+     * @returns An account interface instance for creating tx requests and authorizing actions.
+     */
+    getInterface(address: CompleteAddress, nodeInfo: NodeInfo): AccountInterface;
+    /**
+     * Returns the auth witness provider for the given address.
+     * @param address - Address for which to create auth witnesses.
+     */
+    getAuthWitnessProvider(address: CompleteAddress): AuthWitnessProvider;
+}
+/**
+ * Compute the address of an account contract from secret and salt.
+ */
+export declare function getAccountContractAddress(accountContract: AccountContract, secret: Fr, salt: Fr): Promise<import("@aztec/stdlib/aztec-address").AztecAddress>;
+//# sourceMappingURL=contract.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../../src/account/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAIxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAG5E;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,mBAAmB,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEjD;;OAEG;IACH,iBAAiB,IAAI,OAAO,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;IAEhD;;;;;;;OAOG;IACH,YAAY,CAAC,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,GAAG,gBAAgB,CAAC;IAE7E;;;OAGG;IACH,sBAAsB,CAAC,OAAO,EAAE,eAAe,GAAG,mBAAmB,CAAC;CACvE;AAGD;;GAEG;AACH,wBAAsB,yBAAyB,CAAC,eAAe,EAAE,eAAe,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,+DAUrG"}

package/dest/account/contract.js

@@ -0,0 +1,16 @@
+import { getContractInstanceFromDeployParams } from '@aztec/stdlib/contract';
+import { deriveKeys } from '@aztec/stdlib/keys';
+// docs:end:account-contract-interface
+/**
+ * Compute the address of an account contract from secret and salt.
+ */ export async function getAccountContractAddress(accountContract, secret, salt) {
+    const { publicKeys } = await deriveKeys(secret);
+    const constructorArgs = await accountContract.getDeploymentArgs();
+    const artifact = await accountContract.getContractArtifact();
+    const instance = await getContractInstanceFromDeployParams(artifact, {
+        constructorArgs,
+        salt,
+        publicKeys
+    });
+    return instance.address;
+}

package/dest/account/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The `account` module provides utilities for managing accounts. The {@link AccountManager} class
+ * allows to deploy and register a fresh account, or to obtain a `Wallet` instance out of an account
+ * already deployed. Use the `@aztec/accounts` package to load default account implementations that rely
+ * on ECDSA or Schnorr signatures.
+ *
+ * @packageDocumentation
+ */
+import type { Fr } from '@aztec/foundation/fields';
+export { type AccountContract, getAccountContractAddress } from './contract.js';
+export { type AccountInterface, type AuthWitnessProvider } from './interface.js';
+export * from './wallet.js';
+/** A contract deployment salt. */
+export type Salt = Fr | number | bigint;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/account/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,EAAE,KAAK,eAAe,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAChF,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACjF,cAAc,aAAa,CAAC;AAE5B,kCAAkC;AAClC,MAAM,MAAM,IAAI,GAAG,EAAE,GAAG,MAAM,GAAG,MAAM,CAAC"}

package/dest/account/index.js

@@ -0,0 +1,9 @@
+/**
+ * The `account` module provides utilities for managing accounts. The {@link AccountManager} class
+ * allows to deploy and register a fresh account, or to obtain a `Wallet` instance out of an account
+ * already deployed. Use the `@aztec/accounts` package to load default account implementations that rely
+ * on ECDSA or Schnorr signatures.
+ *
+ * @packageDocumentation
+ */ export { getAccountContractAddress } from './contract.js';
+export * from './wallet.js';

package/dest/account/interface.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { Fr } from '@aztec/foundation/fields';
+import type { AuthWitness } from '@aztec/stdlib/auth-witness';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { CompleteAddress } from '@aztec/stdlib/contract';
+import type { EntrypointInterface } from '../entrypoint/entrypoint.js';
+/** Creates authorization witnesses. */
+export interface AuthWitnessProvider {
+    /**
+     * Computes an authentication witness from either a message hash
+     * @param messageHash - The message hash to approve
+     * @returns The authentication witness
+     */
+    createAuthWit(messageHash: Fr | Buffer): Promise<AuthWitness>;
+}
+/**
+ * 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=interface.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../src/account/interface.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAGvE,uCAAuC;AACvC,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,aAAa,CAAC,WAAW,EAAE,EAAE,GAAG,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAC/D;AAED;;;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

@@ -0,0 +1,4 @@
+/**
+ * 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/account/wallet.d.ts

@@ -0,0 +1,11 @@
+import type { AuthWitness } from '@aztec/stdlib/auth-witness';
+import type { PXE } from '@aztec/stdlib/interfaces/client';
+import type { IntentAction, IntentInnerHash } from '../utils/authwit.js';
+import type { AccountInterface } from './interface.js';
+/**
+ * The wallet interface.
+ */
+export type Wallet = AccountInterface & PXE & {
+    createAuthWit(intent: IntentInnerHash | IntentAction): Promise<AuthWitness>;
+};
+//# sourceMappingURL=wallet.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../src/account/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC;AAE3D,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,gBAAgB,GACnC,GAAG,GAAG;IACJ,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAC7E,CAAC"}

package/dest/account/wallet.js

@@ -0,0 +1,3 @@
+/**
+ * The wallet interface.
+ */ export { };

package/dest/account_manager/deploy_account_method.d.ts

@@ -0,0 +1,15 @@
+import { type ContractArtifact, type FunctionArtifact } from '@aztec/stdlib/abi';
+import type { PublicKeys } from '@aztec/stdlib/keys';
+import type { AuthWitnessProvider } from '../account/interface.js';
+import type { Wallet } from '../account/wallet.js';
+import type { ExecutionRequestInit } from '../api/entrypoint.js';
+import { DeployMethod, type DeployOptions } from '../contract/deploy_method.js';
+/**
+ * Contract interaction for deploying an account contract. Handles fee preparation and contract initialization.
+ */
+export declare class DeployAccountMethod extends DeployMethod {
+    #private;
+    constructor(authWitnessProvider: AuthWitnessProvider, publicKeys: PublicKeys, wallet: Wallet, artifact: ContractArtifact, args?: any[], constructorNameOrArtifact?: string | FunctionArtifact, feePaymentNameOrArtifact?: string | FunctionArtifact);
+    protected getInitializeFunctionCalls(options: DeployOptions): Promise<Pick<ExecutionRequestInit, 'calls' | 'authWitnesses' | 'hashedArguments'>>;
+}
+//# sourceMappingURL=deploy_account_method.d.ts.map

package/dest/account_manager/deploy_account_method.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy_account_method.d.ts","sourceRoot":"","sources":["../../src/account_manager/deploy_account_method.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EAItB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAEjE,OAAO,EAAE,YAAY,EAAE,KAAK,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAGhF;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;;gBAKjD,mBAAmB,EAAE,mBAAmB,EACxC,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,gBAAgB,EAC1B,IAAI,GAAE,GAAG,EAAO,EAChB,yBAAyB,CAAC,EAAE,MAAM,GAAG,gBAAgB,EACrD,wBAAwB,CAAC,EAAE,MAAM,GAAG,gBAAgB;cAkB7B,0BAA0B,CACjD,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,OAAO,GAAG,eAAe,GAAG,iBAAiB,CAAC,CAAC;CAmCtF"}

package/dest/account_manager/deploy_account_method.js

@@ -0,0 +1,43 @@
+import { FunctionSelector, encodeArguments, getFunctionArtifactByName } from '@aztec/stdlib/abi';
+import { Contract } from '../contract/contract.js';
+import { DeployMethod } from '../contract/deploy_method.js';
+import { EntrypointPayload, computeCombinedPayloadHash } from '../entrypoint/payload.js';
+/**
+ * Contract interaction for deploying an account contract. Handles fee preparation and contract initialization.
+ */ export class DeployAccountMethod extends DeployMethod {
+    #authWitnessProvider;
+    #feePaymentArtifact;
+    constructor(authWitnessProvider, publicKeys, wallet, artifact, args = [], constructorNameOrArtifact, feePaymentNameOrArtifact){
+        super(publicKeys, wallet, artifact, (address, wallet)=>Contract.at(address, artifact, wallet), args, constructorNameOrArtifact);
+        this.#authWitnessProvider = authWitnessProvider;
+        this.#feePaymentArtifact = typeof feePaymentNameOrArtifact === 'string' ? getFunctionArtifactByName(artifact, feePaymentNameOrArtifact) : feePaymentNameOrArtifact;
+    }
+    async getInitializeFunctionCalls(options) {
+        const exec = await super.getInitializeFunctionCalls(options);
+        if (options.fee && this.#feePaymentArtifact) {
+            const { address } = await this.getInstance();
+            const emptyAppPayload = await EntrypointPayload.fromAppExecution([]);
+            const fee = await this.getDefaultFeeOptions(options.fee);
+            const feePayload = await EntrypointPayload.fromFeeOptions(address, fee);
+            exec.calls.push({
+                name: this.#feePaymentArtifact.name,
+                to: address,
+                args: encodeArguments(this.#feePaymentArtifact, [
+                    emptyAppPayload,
+                    feePayload,
+                    false
+                ]),
+                selector: await FunctionSelector.fromNameAndParameters(this.#feePaymentArtifact.name, this.#feePaymentArtifact.parameters),
+                type: this.#feePaymentArtifact.functionType,
+                isStatic: this.#feePaymentArtifact.isStatic,
+                returnTypes: this.#feePaymentArtifact.returnTypes
+            });
+            exec.authWitnesses ??= [];
+            exec.hashedArguments ??= [];
+            exec.authWitnesses.push(await this.#authWitnessProvider.createAuthWit(await computeCombinedPayloadHash(emptyAppPayload, feePayload)));
+            exec.hashedArguments.push(...emptyAppPayload.hashedArguments);
+            exec.hashedArguments.push(...feePayload.hashedArguments);
+        }
+        return exec;
+    }
+}

package/dest/account_manager/deploy_account_sent_tx.d.ts

@@ -0,0 +1,30 @@
+import type { FieldsOf } from '@aztec/foundation/types';
+import type { PXE } from '@aztec/stdlib/interfaces/client';
+import type { TxHash, TxReceipt } from '@aztec/stdlib/tx';
+import type { Wallet } from '../account/index.js';
+import { SentTx, type WaitOpts } from '../contract/sent_tx.js';
+/** Extends a transaction receipt with a wallet instance for the newly deployed contract. */
+export type DeployAccountTxReceipt = FieldsOf<TxReceipt> & {
+    /** Wallet that corresponds to the newly deployed account contract. */
+    wallet: Wallet;
+};
+/**
+ * A deployment transaction for an account contract sent to the network, extending SentTx with methods to get the resulting wallet.
+ */
+export declare class DeployAccountSentTx extends SentTx {
+    private getWalletPromise;
+    constructor(pxe: PXE, txHashPromise: Promise<TxHash>, getWalletPromise: Promise<Wallet>);
+    /**
+     * 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.
+     */
+    getWallet(opts?: WaitOpts): Promise<Wallet>;
+    /**
+     * Awaits for the tx to be mined and returns the receipt along with a wallet 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 wallet for the deployed account contract.
+     */
+    wait(opts?: WaitOpts): Promise<DeployAccountTxReceipt>;
+}
+//# sourceMappingURL=deploy_account_sent_tx.d.ts.map

package/dest/account_manager/deploy_account_sent_tx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploy_account_sent_tx.d.ts","sourceRoot":"","sources":["../../src/account_manager/deploy_account_sent_tx.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAmB,MAAM,EAAE,KAAK,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAEhF,4FAA4F;AAC5F,MAAM,MAAM,sBAAsB,GAAG,QAAQ,CAAC,SAAS,CAAC,GAAG;IACzD,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,MAAM;IACS,OAAO,CAAC,gBAAgB;gBAAlE,GAAG,EAAE,GAAG,EAAE,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,EAAU,gBAAgB,EAAE,OAAO,CAAC,MAAM,CAAC;IAI/F;;;;OAIG;IACU,SAAS,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IAKxD;;;;OAIG;IACmB,IAAI,CAAC,IAAI,GAAE,QAA0B,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAK9F"}

package/dest/account_manager/deploy_account_sent_tx.js

@@ -0,0 +1,29 @@
+import { DefaultWaitOpts, SentTx } from '../contract/sent_tx.js';
+/**
+ * A deployment transaction for an account contract sent to the network, extending SentTx with methods to get the resulting wallet.
+ */ export class DeployAccountSentTx extends SentTx {
+    getWalletPromise;
+    constructor(pxe, txHashPromise, getWalletPromise){
+        super(pxe, txHashPromise), this.getWalletPromise = getWalletPromise;
+    }
+    /**
+   * 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 getWallet(opts) {
+        const receipt = await this.wait(opts);
+        return receipt.wallet;
+    }
+    /**
+   * Awaits for the tx to be mined and returns the receipt along with a wallet 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 wallet for the deployed account contract.
+   */ async wait(opts = DefaultWaitOpts) {
+        const receipt = await super.wait(opts);
+        const wallet = await this.getWalletPromise;
+        return {
+            ...receipt,
+            wallet
+        };
+    }
+}

package/dest/account_manager/index.d.ts

@@ -0,0 +1,108 @@
+import { Fr } from '@aztec/foundation/fields';
+import { CompleteAddress, type ContractInstanceWithAddress } from '@aztec/stdlib/contract';
+import type { PXE } from '@aztec/stdlib/interfaces/client';
+import type { AccountContract } from '../account/contract.js';
+import type { Salt, Wallet } from '../account/index.js';
+import type { AccountInterface } from '../account/interface.js';
+import { DeployMethod, type DeployOptions } from '../contract/deploy_method.js';
+import { Contract } from '../contract/index.js';
+import { type WaitOpts } from '../contract/sent_tx.js';
+import { AccountWalletWithSecretKey } from '../wallet/index.js';
+import { DeployAccountMethod } from './deploy_account_method.js';
+import { DeployAccountSentTx } from './deploy_account_sent_tx.js';
+/**
+ * Options to deploy an account contract.
+ */
+export type DeployAccountOptions = Pick<DeployOptions, 'fee' | 'skipClassRegistration' | 'skipPublicDeployment' | 'skipInitialization'> & {
+    /**
+     * Wallet used for deploying the account contract. Must be funded in order to pay for the fee.
+     */
+    deployWallet?: Wallet;
+};
+/**
+ * Manages a user account. Provides methods for calculating the account's address, deploying the account contract,
+ * and creating and registering the user wallet in the PXE Service.
+ */
+export declare class AccountManager {
+    private pxe;
+    private secretKey;
+    private accountContract;
+    private instance;
+    /**
+     * Deployment salt for the account contract
+     */
+    readonly salt: Salt;
+    private constructor();
+    static create(pxe: PXE, secretKey: Fr, accountContract: AccountContract, salt?: Salt): Promise<AccountManager>;
+    protected getPublicKeys(): import("@aztec/stdlib/keys").PublicKeys;
+    protected getPublicKeysHash(): Fr | Promise<Fr>;
+    /**
+     * Returns the entrypoint for this account as defined by its account contract.
+     * @returns An entrypoint.
+     */
+    getAccount(): Promise<AccountInterface>;
+    /**
+     * Gets the calculated complete address associated with this account.
+     * Does not require the account to be deployed or registered.
+     * @returns The address, partial address, and encryption public key.
+     */
+    getCompleteAddress(): Promise<CompleteAddress>;
+    /**
+     * Gets the address for this given account.
+     * Does not require the account to be deployed or registered.
+     * @returns The address.
+     */
+    getAddress(): import("@aztec/stdlib/aztec-address").AztecAddress;
+    /**
+     * Returns the contract instance definition associated with this account.
+     * Does not require the account to be deployed or registered.
+     * @returns ContractInstance instance.
+     */
+    getInstance(): ContractInstanceWithAddress;
+    /**
+     * Returns a Wallet instance associated with this account. Use it to create Contract
+     * instances to be interacted with from this account.
+     * @returns A Wallet instance.
+     */
+    getWallet(): Promise<AccountWalletWithSecretKey>;
+    /**
+     * Registers this account in the PXE Service and returns the associated wallet. Registering
+     * the account on the PXE Service is required for managing private state associated with it.
+     * Use the returned wallet to create Contract instances to be interacted with from this account.
+     * @param opts - Options to wait for the account to be synched.
+     * @returns A Wallet instance.
+     */
+    register(): Promise<AccountWalletWithSecretKey>;
+    /**
+     * Returns the pre-populated deployment method to deploy the account contract that backs this account.
+     * Typically you will not need this method and can call `deploy` directly. Use this for having finer
+     * grained control on when to create, simulate, and send the deployment tx.
+     * @param deployWallet - Wallet used for deploying the account contract.
+     * @returns A DeployMethod instance that deploys this account contract.
+     */
+    getDeployMethod(deployWallet?: Wallet): Promise<DeployMethod<Contract> | DeployAccountMethod>;
+    /**
+     * Deploys the account contract that backs this account.
+     * Does not register the associated class nor publicly deploy the instance by default.
+     * Uses the salt provided in the constructor or a randomly generated one.
+     * Registers the account in the PXE Service before deploying the contract.
+     * @param opts - Fee options to be used for the deployment.
+     * @returns A SentTx object that can be waited to get the associated Wallet.
+     */
+    deploy(opts?: DeployAccountOptions): DeployAccountSentTx;
+    /**
+     * Deploys the account contract that backs this account if needed and awaits the tx to be mined.
+     * Uses the salt provided in the constructor or a randomly generated one. If no initialization
+     * is required it skips the transaction, and only registers the account in the PXE Service.
+     * @param opts - Options to wait for the tx to be mined.
+     * @returns A Wallet instance.
+     */
+    waitSetup(opts?: DeployAccountOptions & WaitOpts): Promise<AccountWalletWithSecretKey>;
+    /**
+     * Returns whether this account contract has a constructor and needs deployment.
+     */
+    isDeployable(): Promise<boolean>;
+}
+export { DeployAccountMethod } from './deploy_account_method.js';
+export { type DeployAccountTxReceipt, DeployAccountSentTx } from './deploy_account_sent_tx.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/account_manager/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/account_manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,KAAK,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAE3F,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC;AAG3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,KAAK,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAmB,KAAK,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAExE,OAAO,EAAE,0BAA0B,EAAoB,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,aAAa,EACb,KAAK,GAAG,uBAAuB,GAAG,sBAAsB,GAAG,oBAAoB,CAChF,GAAG;IACF;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,qBAAa,cAAc;IAEvB,OAAO,CAAC,GAAG;IACX,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,QAAQ;IAChB;;OAEG;aACa,IAAI,EAAE,IAAI;IAR5B,OAAO;WAWM,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,EAAE,eAAe,EAAE,eAAe,EAAE,IAAI,CAAC,EAAE,IAAI;IAc1F,SAAS,CAAC,aAAa;IAIvB,SAAS,CAAC,iBAAiB;IAI3B;;;OAGG;IACU,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAMpD;;;;OAIG;IACI,kBAAkB,IAAI,OAAO,CAAC,eAAe,CAAC;IAIrD;;;;OAIG;IACI,UAAU;IAIjB;;;;OAIG;IACI,WAAW,IAAI,2BAA2B;IAIjD;;;;OAIG;IACU,SAAS,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAK7D;;;;;;OAMG;IACU,QAAQ,IAAI,OAAO,CAAC,0BAA0B,CAAC;IAW5D;;;;;;OAMG;IACU,eAAe,CAAC,YAAY,CAAC,EAAE,MAAM;IA2ClD;;;;;;;OAOG;IACI,MAAM,CAAC,IAAI,CAAC,EAAE,oBAAoB,GAAG,mBAAmB;IAgB/D;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,GAAE,oBAAoB,GAAG,QAA0B,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAKpH;;OAEG;IACU,YAAY;CAG1B;AAED,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,KAAK,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC"}

package/dest/account_manager/index.js

@@ -0,0 +1,159 @@
+import { Fr } from '@aztec/foundation/fields';
+import { CompleteAddress } from '@aztec/stdlib/contract';
+import { getContractInstanceFromDeployParams } from '@aztec/stdlib/contract';
+import { deriveKeys } from '@aztec/stdlib/keys';
+import { DeployMethod } from '../contract/deploy_method.js';
+import { Contract } from '../contract/index.js';
+import { DefaultWaitOpts } from '../contract/sent_tx.js';
+import { DefaultMultiCallEntrypoint } from '../entrypoint/default_multi_call_entrypoint.js';
+import { AccountWalletWithSecretKey, SignerlessWallet } from '../wallet/index.js';
+import { DeployAccountMethod } from './deploy_account_method.js';
+import { DeployAccountSentTx } from './deploy_account_sent_tx.js';
+/**
+ * Manages a user account. Provides methods for calculating the account's address, deploying the account contract,
+ * and creating and registering the user wallet in the PXE Service.
+ */ export class AccountManager {
+    pxe;
+    secretKey;
+    accountContract;
+    instance;
+    salt;
+    constructor(pxe, secretKey, accountContract, instance, /**
+     * Deployment salt for the account contract
+     */ salt){
+        this.pxe = pxe;
+        this.secretKey = secretKey;
+        this.accountContract = accountContract;
+        this.instance = instance;
+        this.salt = salt;
+    }
+    static async create(pxe, secretKey, accountContract, salt) {
+        const { publicKeys } = await deriveKeys(secretKey);
+        salt = salt !== undefined ? new Fr(salt) : Fr.random();
+        const artifact = await accountContract.getContractArtifact();
+        const instance = await getContractInstanceFromDeployParams(artifact, {
+            constructorArgs: await accountContract.getDeploymentArgs(),
+            salt: salt,
+            publicKeys
+        });
+        return new AccountManager(pxe, secretKey, accountContract, instance, salt);
+    }
+    getPublicKeys() {
+        return this.instance.publicKeys;
+    }
+    getPublicKeysHash() {
+        return this.getPublicKeys().hash();
+    }
+    /**
+   * Returns the entrypoint for this account as defined by its account contract.
+   * @returns An entrypoint.
+   */ async getAccount() {
+        const nodeInfo = await this.pxe.getNodeInfo();
+        const completeAddress = await this.getCompleteAddress();
+        return this.accountContract.getInterface(completeAddress, nodeInfo);
+    }
+    /**
+   * Gets the calculated complete address associated with this account.
+   * Does not require the account to be deployed or registered.
+   * @returns The address, partial address, and encryption public key.
+   */ getCompleteAddress() {
+        return CompleteAddress.fromSecretKeyAndInstance(this.secretKey, this.instance);
+    }
+    /**
+   * Gets the address for this given account.
+   * Does not require the account to be deployed or registered.
+   * @returns The address.
+   */ getAddress() {
+        return this.instance.address;
+    }
+    /**
+   * Returns the contract instance definition associated with this account.
+   * Does not require the account to be deployed or registered.
+   * @returns ContractInstance instance.
+   */ getInstance() {
+        return this.instance;
+    }
+    /**
+   * Returns a Wallet instance associated with this account. Use it to create Contract
+   * instances to be interacted with from this account.
+   * @returns A Wallet instance.
+   */ async getWallet() {
+        const entrypoint = await this.getAccount();
+        return new AccountWalletWithSecretKey(this.pxe, entrypoint, this.secretKey, this.salt);
+    }
+    /**
+   * Registers this account in the PXE Service and returns the associated wallet. Registering
+   * the account on the PXE Service is required for managing private state associated with it.
+   * Use the returned wallet to create Contract instances to be interacted with from this account.
+   * @param opts - Options to wait for the account to be synched.
+   * @returns A Wallet instance.
+   */ async register() {
+        await this.pxe.registerContract({
+            artifact: await this.accountContract.getContractArtifact(),
+            instance: this.getInstance()
+        });
+        await this.pxe.registerAccount(this.secretKey, (await this.getCompleteAddress()).partialAddress);
+        return this.getWallet();
+    }
+    /**
+   * Returns the pre-populated deployment method to deploy the account contract that backs this account.
+   * Typically you will not need this method and can call `deploy` directly. Use this for having finer
+   * grained control on when to create, simulate, and send the deployment tx.
+   * @param deployWallet - Wallet used for deploying the account contract.
+   * @returns A DeployMethod instance that deploys this account contract.
+   */ async getDeployMethod(deployWallet) {
+        const artifact = await this.accountContract.getContractArtifact();
+        if (!await this.isDeployable()) {
+            throw new Error(`Account contract ${artifact.name} does not require deployment.`);
+        }
+        const completeAddress = await this.getCompleteAddress();
+        await this.pxe.registerAccount(this.secretKey, completeAddress.partialAddress);
+        const args = await this.accountContract.getDeploymentArgs() ?? [];
+        if (deployWallet) {
+            // If deploying using an existing wallet/account, treat it like regular contract deployment.
+            const thisWallet = await this.getWallet();
+            return new DeployMethod(this.getPublicKeys(), deployWallet, artifact, (address)=>Contract.at(address, artifact, thisWallet), args, 'constructor');
+        }
+        const { l1ChainId: chainId, protocolVersion } = await this.pxe.getNodeInfo();
+        // We use a signerless wallet with the multi call entrypoint in order to make multiple calls in one go.
+        // If we used getWallet, the deployment would get routed via the account contract entrypoint
+        // and it can't be used unless the contract is initialized.
+        const wallet = new SignerlessWallet(this.pxe, new DefaultMultiCallEntrypoint(chainId, protocolVersion));
+        return new DeployAccountMethod(this.accountContract.getAuthWitnessProvider(completeAddress), this.getPublicKeys(), wallet, artifact, args, 'constructor', 'entrypoint');
+    }
+    /**
+   * Deploys the account contract that backs this account.
+   * Does not register the associated class nor publicly deploy the instance by default.
+   * Uses the salt provided in the constructor or a randomly generated one.
+   * Registers the account in the PXE Service before deploying the contract.
+   * @param opts - Fee options to be used for the deployment.
+   * @returns A SentTx object that can be waited to get the associated Wallet.
+   */ deploy(opts) {
+        const sentTx = this.getDeployMethod(opts?.deployWallet).then((deployMethod)=>deployMethod.send({
+                contractAddressSalt: new Fr(this.salt),
+                skipClassRegistration: opts?.skipClassRegistration ?? true,
+                skipPublicDeployment: opts?.skipPublicDeployment ?? true,
+                skipInitialization: opts?.skipInitialization ?? false,
+                universalDeploy: true,
+                fee: opts?.fee
+            })).then((tx)=>tx.getTxHash());
+        return new DeployAccountSentTx(this.pxe, sentTx, this.getWallet());
+    }
+    /**
+   * Deploys the account contract that backs this account if needed and awaits the tx to be mined.
+   * Uses the salt provided in the constructor or a randomly generated one. If no initialization
+   * is required it skips the transaction, and only registers the account in the PXE Service.
+   * @param opts - Options to wait for the tx to be mined.
+   * @returns A Wallet instance.
+   */ async waitSetup(opts = DefaultWaitOpts) {
+        await (await this.isDeployable() ? this.deploy(opts).wait(opts) : this.register());
+        return this.getWallet();
+    }
+    /**
+   * Returns whether this account contract has a constructor and needs deployment.
+   */ async isDeployable() {
+        return await this.accountContract.getDeploymentArgs() !== undefined;
+    }
+}
+export { DeployAccountMethod } from './deploy_account_method.js';
+export { DeployAccountSentTx } from './deploy_account_sent_tx.js';

package/dest/api/abi.d.ts

@@ -0,0 +1,3 @@
+export { type ContractArtifact, type FunctionArtifact, EventSelector, FunctionSelector, loadContractArtifact, contractArtifactToBuffer, contractArtifactFromBuffer, } from '@aztec/stdlib/abi';
+export { type NoirCompiledContract } from '@aztec/stdlib/noir';
+//# sourceMappingURL=abi.d.ts.map

package/dest/api/abi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abi.d.ts","sourceRoot":"","sources":["../../src/api/abi.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,aAAa,EACb,gBAAgB,EAChB,oBAAoB,EACpB,wBAAwB,EACxB,0BAA0B,GAC3B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,oBAAoB,CAAC"}

package/dest/api/abi.js

@@ -0,0 +1 @@
+export { EventSelector, FunctionSelector, loadContractArtifact, contractArtifactToBuffer, contractArtifactFromBuffer } from '@aztec/stdlib/abi';

package/dest/api/account.d.ts

@@ -0,0 +1,3 @@
+export { type AccountContract, type AccountInterface, type AuthWitnessProvider, type Salt, type Wallet, getAccountContractAddress, } from '../account/index.js';
+export { AccountManager } from '../account_manager/index.js';
+//# sourceMappingURL=account.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/api/account.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,IAAI,EACT,KAAK,MAAM,EACX,yBAAyB,GAC1B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC"}

package/dest/api/account.js

@@ -0,0 +1,2 @@
+export { getAccountContractAddress } from '../account/index.js';
+export { AccountManager } from '../account_manager/index.js';

package/dest/api/addresses.d.ts

@@ -0,0 +1,3 @@
+export { AztecAddress } from '@aztec/stdlib/aztec-address';
+export { CompleteAddress } from '@aztec/stdlib/contract';
+//# sourceMappingURL=addresses.d.ts.map

package/dest/api/addresses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresses.d.ts","sourceRoot":"","sources":["../../src/api/addresses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC"}