@aztec/aztec.js 0.0.0-test.1 → 0.0.1-commit.03f7ef2

package/dest/wallet/account_manager.d.ts

@@ -0,0 +1,66 @@
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { CompleteAddress, type ContractInstanceWithAddress } from '@aztec/stdlib/contract';
+import type { AccountContract } from '../account/account_contract.js';
+import { AccountWithSecretKey } from '../account/account_with_secret_key.js';
+import type { Salt } from '../account/index.js';
+import type { AccountInterface } from '../account/interface.js';
+import { DeployAccountMethod } from './deploy_account_method.js';
+import type { Wallet } from './wallet.js';
+/**
+ * Manages a user account. Provides methods for calculating the account's address and other related data,
+ * plus a helper to return a preconfigured deploy method.
+ */
+export declare class AccountManager {
+    private wallet;
+    private secretKey;
+    private accountContract;
+    private instance;
+    readonly salt: Salt;
+    private constructor();
+    static create(wallet: Wallet, 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.
+     */
+    getAccountInterface(): Promise<AccountInterface>;
+    /**
+     * Gets the calculated complete address associated with this account.
+     * Does not require the account to have been published for public execution.
+     * @returns The address, partial address, and encryption public key.
+     */
+    getCompleteAddress(): Promise<CompleteAddress>;
+    /**
+     * Returns the secret key used to derive the rest of the privacy keys for this contract
+     */
+    getSecretKey(): Fr;
+    get address(): import("../api/addresses.js").AztecAddress;
+    /**
+     * Returns the contract instance definition associated with this account.
+     * Does not require the account to have been published for public execution.
+     * @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.
+     */
+    getAccount(): Promise<AccountWithSecretKey>;
+    /**
+     * Returns the account contract that backs this account.
+     * @returns The account contract
+     */
+    getAccountContract(): AccountContract;
+    /**
+     * Returns a preconfigured deploy method that contains all the necessary function
+     * calls to deploy the account contract.
+     */
+    getDeployMethod(): Promise<DeployAccountMethod>;
+    /**
+     * Returns whether this account contract has an initializer function.
+     */
+    hasInitializer(): Promise<boolean>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWNjb3VudF9tYW5hZ2VyLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvd2FsbGV0L2FjY291bnRfbWFuYWdlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsRUFBRSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDcEQsT0FBTyxFQUNMLGVBQWUsRUFDZixLQUFLLDJCQUEyQixFQUVqQyxNQUFNLHdCQUF3QixDQUFDO0FBR2hDLE9BQU8sS0FBSyxFQUFFLGVBQWUsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBQ3RFLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxNQUFNLHVDQUF1QyxDQUFDO0FBQzdFLE9BQU8sS0FBSyxFQUFFLElBQUksRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBQ2hELE9BQU8sS0FBSyxFQUFFLGdCQUFnQixFQUFFLE1BQU0seUJBQXlCLENBQUM7QUFFaEUsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sNEJBQTRCLENBQUM7QUFDakUsT0FBTyxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBRTFDOzs7R0FHRztBQUNILHFCQUFhLGNBQWM7SUFFdkIsT0FBTyxDQUFDLE1BQU07SUFDZCxPQUFPLENBQUMsU0FBUztJQUNqQixPQUFPLENBQUMsZUFBZTtJQUN2QixPQUFPLENBQUMsUUFBUTthQUlBLElBQUksRUFBRSxJQUFJO0lBUjVCLE9BQU8sZUFTSDtJQUVKLE9BQWEsTUFBTSxDQUFDLE1BQU0sRUFBRSxNQUFNLEVBQUUsU0FBUyxFQUFFLEVBQUUsRUFBRSxlQUFlLEVBQUUsZUFBZSxFQUFFLElBQUksQ0FBQyxFQUFFLElBQUksMkJBa0IvRjtJQUVELFNBQVMsQ0FBQyxhQUFhLDRDQUV0QjtJQUVELFNBQVMsQ0FBQyxpQkFBaUIscUJBRTFCO0lBRUQ7OztPQUdHO0lBQ1UsbUJBQW1CLElBQUksT0FBTyxDQUFDLGdCQUFnQixDQUFDLENBSTVEO0lBRUQ7Ozs7T0FJRztJQUNJLGtCQUFrQixJQUFJLE9BQU8sQ0FBQyxlQUFlLENBQUMsQ0FFcEQ7SUFFRDs7T0FFRztJQUNJLFlBQVksT0FFbEI7SUFFRCxJQUFJLE9BQU8sK0NBRVY7SUFFRDs7OztPQUlHO0lBQ0ksV0FBVyxJQUFJLDJCQUEyQixDQUVoRDtJQUVEOzs7O09BSUc7SUFDVSxVQUFVLElBQUksT0FBTyxDQUFDLG9CQUFvQixDQUFDLENBR3ZEO0lBRUQ7OztPQUdHO0lBQ0gsa0JBQWtCLElBQUksZUFBZSxDQUVwQztJQUVEOzs7T0FHRztJQUNVLGVBQWUsSUFBSSxPQUFPLENBQUMsbUJBQW1CLENBQUMsQ0F3QjNEO0lBRUQ7O09BRUc7SUFDVSxjQUFjLHFCQUUxQjtDQUNGIn0=

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

@@ -0,0 +1 @@
+{"version":3,"file":"account_manager.d.ts","sourceRoot":"","sources":["../../src/wallet/account_manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACpD,OAAO,EACL,eAAe,EACf,KAAK,2BAA2B,EAEjC,MAAM,wBAAwB,CAAC;AAGhC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C;;;GAGG;AACH,qBAAa,cAAc;IAEvB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,QAAQ;aAIA,IAAI,EAAE,IAAI;IAR5B,OAAO,eASH;IAEJ,OAAa,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,eAAe,EAAE,eAAe,EAAE,IAAI,CAAC,EAAE,IAAI,2BAkB/F;IAED,SAAS,CAAC,aAAa,4CAEtB;IAED,SAAS,CAAC,iBAAiB,qBAE1B;IAED;;;OAGG;IACU,mBAAmB,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAI5D;IAED;;;;OAIG;IACI,kBAAkB,IAAI,OAAO,CAAC,eAAe,CAAC,CAEpD;IAED;;OAEG;IACI,YAAY,OAElB;IAED,IAAI,OAAO,+CAEV;IAED;;;;OAIG;IACI,WAAW,IAAI,2BAA2B,CAEhD;IAED;;;;OAIG;IACU,UAAU,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAGvD;IAED;;;OAGG;IACH,kBAAkB,IAAI,eAAe,CAEpC;IAED;;;OAGG;IACU,eAAe,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAwB3D;IAED;;OAEG;IACU,cAAc,qBAE1B;CACF"}

package/dest/wallet/account_manager.js

@@ -0,0 +1,113 @@
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { CompleteAddress, getContractInstanceFromInstantiationParams } from '@aztec/stdlib/contract';
+import { deriveKeys } from '@aztec/stdlib/keys';
+import { AccountWithSecretKey } from '../account/account_with_secret_key.js';
+import { Contract } from '../contract/contract.js';
+import { DeployAccountMethod } from './deploy_account_method.js';
+/**
+ * Manages a user account. Provides methods for calculating the account's address and other related data,
+ * plus a helper to return a preconfigured deploy method.
+ */ export class AccountManager {
+    wallet;
+    secretKey;
+    accountContract;
+    instance;
+    salt;
+    constructor(wallet, secretKey, accountContract, instance, /**
+     * Contract instantiation salt for the account contract
+     */ salt){
+        this.wallet = wallet;
+        this.secretKey = secretKey;
+        this.accountContract = accountContract;
+        this.instance = instance;
+        this.salt = salt;
+    }
+    static async create(wallet, secretKey, accountContract, salt) {
+        const { publicKeys } = await deriveKeys(secretKey);
+        salt = salt !== undefined ? new Fr(salt) : Fr.random();
+        const { constructorName, constructorArgs } = await accountContract.getInitializationFunctionAndArgs() ?? {
+            constructorName: undefined,
+            constructorArgs: undefined
+        };
+        const artifact = await accountContract.getContractArtifact();
+        const instance = await getContractInstanceFromInstantiationParams(artifact, {
+            constructorArtifact: constructorName,
+            constructorArgs,
+            salt: salt,
+            publicKeys
+        });
+        return new AccountManager(wallet, 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 getAccountInterface() {
+        const chainInfo = await this.wallet.getChainInfo();
+        const completeAddress = await this.getCompleteAddress();
+        return this.accountContract.getInterface(completeAddress, chainInfo);
+    }
+    /**
+   * Gets the calculated complete address associated with this account.
+   * Does not require the account to have been published for public execution.
+   * @returns The address, partial address, and encryption public key.
+   */ getCompleteAddress() {
+        return CompleteAddress.fromSecretKeyAndInstance(this.secretKey, this.instance);
+    }
+    /**
+   * Returns the secret key used to derive the rest of the privacy keys for this contract
+   */ getSecretKey() {
+        return this.secretKey;
+    }
+    get address() {
+        return this.instance.address;
+    }
+    /**
+   * Returns the contract instance definition associated with this account.
+   * Does not require the account to have been published for public execution.
+   * @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 getAccount() {
+        const accountInterface = await this.getAccountInterface();
+        return new AccountWithSecretKey(accountInterface, this.secretKey, this.salt);
+    }
+    /**
+   * Returns the account contract that backs this account.
+   * @returns The account contract
+   */ getAccountContract() {
+        return this.accountContract;
+    }
+    /**
+   * Returns a preconfigured deploy method that contains all the necessary function
+   * calls to deploy the account contract.
+   */ async getDeployMethod() {
+        const artifact = await this.accountContract.getContractArtifact();
+        if (!await this.hasInitializer()) {
+            // TODO(https://github.com/AztecProtocol/aztec-packages/issues/15576):
+            // there should be a path which enables an account contract's class & instance to be published,
+            // even if the account contract doesn't have an initializer function. This should not throw.
+            throw new Error(`Account contract ${artifact.name} does not have an initializer function to call.`);
+        }
+        const { constructorName, constructorArgs } = await this.accountContract.getInitializationFunctionAndArgs() ?? {
+            constructorName: undefined,
+            constructorArgs: undefined
+        };
+        return new DeployAccountMethod(this.getPublicKeys(), this.wallet, artifact, (instance)=>Contract.at(instance.address, artifact, this.wallet), new Fr(this.salt), constructorArgs, constructorName);
+    }
+    /**
+   * Returns whether this account contract has an initializer function.
+   */ async hasInitializer() {
+        return await this.accountContract.getInitializationFunctionAndArgs() !== undefined;
+    }
+}

package/dest/wallet/deploy_account_method.d.ts

@@ -0,0 +1,52 @@
+import { Fr } from '@aztec/foundation/curves/bn254';
+import type { ContractArtifact, FunctionArtifact } from '@aztec/stdlib/abi';
+import type { ContractInstanceWithAddress } from '@aztec/stdlib/contract';
+import type { PublicKeys } from '@aztec/stdlib/keys';
+import { ExecutionPayload } from '@aztec/stdlib/tx';
+import type { Contract } from '../contract/contract.js';
+import type { ContractBase } from '../contract/contract_base.js';
+import { DeployMethod, type DeployOptions, type RequestDeployOptions, type SimulateDeployOptions } from '../contract/deploy_method.js';
+import type { Wallet } from './index.js';
+/**
+ * The configuration options for the request method. Omits the contractAddressSalt, since
+ * for account contracts that is fixed in the constructor
+ */
+export type RequestDeployAccountOptions = Omit<RequestDeployOptions, 'contractAddressSalt'>;
+/**
+ * The configuration options for the send/prove methods. Omits:
+ * - The contractAddressSalt, since for account contracts that is fixed in the constructor.
+ * - UniversalDeployment flag, since account contracts are always deployed with it set to true
+ */
+export type DeployAccountOptions = Omit<DeployOptions, 'contractAddressSalt' | 'universalDeploy'>;
+/**
+ * The configuration options for the simulate method. Omits the contractAddressSalt, since
+ * for account contracts that is fixed in the constructor
+ */
+export type SimulateDeployAccountOptions = Omit<SimulateDeployOptions, 'contractAddressSalt'>;
+/**
+ * Modified version of the DeployMethod used to deploy account contracts. Supports deploying
+ * contracts that can pay for their own fee, plus some preconfigured options to avoid errors.
+ */
+export declare class DeployAccountMethod<TContract extends ContractBase = Contract> extends DeployMethod<TContract> {
+    private salt;
+    constructor(publicKeys: PublicKeys, wallet: Wallet, artifact: ContractArtifact, postDeployCtor: (instance: ContractInstanceWithAddress, wallet: Wallet) => TContract, salt: Fr, args?: any[], constructorNameOrArtifact?: string | FunctionArtifact);
+    /**
+     * Returns a FeePaymentMethod that routes the original one provided as an argument
+     * through the account's entrypoint. This allows an account contract to pay
+     * for its own deployment and initialization.
+     *
+     * For more details on how the fee payment routing works see documentation of AccountEntrypointMetaPaymentMethod class.
+     *
+     * @param originalPaymentMethod - originalPaymentMethod The original payment method to be wrapped.
+     * @returns A FeePaymentMethod that routes the original one through the account's entrypoint (AccountEntrypointMetaPaymentMethod)
+     */
+    private getSelfFeePaymentMethod;
+    /**
+     * Returns the execution payload that allows this operation to happen on chain.
+     * @param opts - Configuration options.
+     * @returns The execution payload for this operation
+     */
+    request(opts?: RequestDeployAccountOptions): Promise<ExecutionPayload>;
+    convertDeployOptionsToRequestOptions(options: DeployOptions): RequestDeployOptions;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVwbG95X2FjY291bnRfbWV0aG9kLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvd2FsbGV0L2RlcGxveV9hY2NvdW50X21ldGhvZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsRUFBRSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDcEQsT0FBTyxLQUFLLEVBQUUsZ0JBQWdCLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUU1RSxPQUFPLEtBQUssRUFBRSwyQkFBMkIsRUFBRSxNQUFNLHdCQUF3QixDQUFDO0FBQzFFLE9BQU8sS0FBSyxFQUFFLFVBQVUsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBQ3JELE9BQU8sRUFBRSxnQkFBZ0IsRUFBMEIsTUFBTSxrQkFBa0IsQ0FBQztBQUU1RSxPQUFPLEtBQUssRUFBRSxRQUFRLEVBQUUsTUFBTSx5QkFBeUIsQ0FBQztBQUN4RCxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSw4QkFBOEIsQ0FBQztBQUNqRSxPQUFPLEVBQ0wsWUFBWSxFQUNaLEtBQUssYUFBYSxFQUNsQixLQUFLLG9CQUFvQixFQUN6QixLQUFLLHFCQUFxQixFQUMzQixNQUFNLDhCQUE4QixDQUFDO0FBR3RDLE9BQU8sS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLFlBQVksQ0FBQztBQUV6Qzs7O0dBR0c7QUFDSCxNQUFNLE1BQU0sMkJBQTJCLEdBQUcsSUFBSSxDQUFDLG9CQUFvQixFQUFFLHFCQUFxQixDQUFDLENBQUM7QUFFNUY7Ozs7R0FJRztBQUNILE1BQU0sTUFBTSxvQkFBb0IsR0FBRyxJQUFJLENBQUMsYUFBYSxFQUFFLHFCQUFxQixHQUFHLGlCQUFpQixDQUFDLENBQUM7QUFFbEc7OztHQUdHO0FBQ0gsTUFBTSxNQUFNLDRCQUE0QixHQUFHLElBQUksQ0FBQyxxQkFBcUIsRUFBRSxxQkFBcUIsQ0FBQyxDQUFDO0FBRTlGOzs7R0FHRztBQUNILHFCQUFhLG1CQUFtQixDQUFDLFNBQVMsU0FBUyxZQUFZLEdBQUcsUUFBUSxDQUFFLFNBQVEsWUFBWSxDQUFDLFNBQVMsQ0FBQztJQU12RyxPQUFPLENBQUMsSUFBSTtJQUxkLFlBQ0UsVUFBVSxFQUFFLFVBQVUsRUFDdEIsTUFBTSxFQUFFLE1BQU0sRUFDZCxRQUFRLEVBQUUsZ0JBQWdCLEVBQzFCLGNBQWMsRUFBRSxDQUFDLFFBQVEsRUFBRSwyQkFBMkIsRUFBRSxNQUFNLEVBQUUsTUFBTSxLQUFLLFNBQVMsRUFDNUUsSUFBSSxFQUFFLEVBQUUsRUFDaEIsSUFBSSxHQUFFLEdBQUcsRUFBTyxFQUNoQix5QkFBeUIsQ0FBQyxFQUFFLE1BQU0sR0FBRyxnQkFBZ0IsRUFHdEQ7SUFFRDs7Ozs7Ozs7O09BU0c7SUFDSCxPQUFPLENBQUMsdUJBQXVCO0lBYS9COzs7O09BSUc7SUFDbUIsT0FBTyxDQUFDLElBQUksQ0FBQyxFQUFFLDJCQUEyQixHQUFHLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxDQThCM0Y7SUFFUSxvQ0FBb0MsQ0FBQyxPQUFPLEVBQUUsYUFBYSxHQUFHLG9CQUFvQixDQVMxRjtDQUNGIn0=

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

@@ -0,0 +1 @@
+{"version":3,"file":"deploy_account_method.d.ts","sourceRoot":"","sources":["../../src/wallet/deploy_account_method.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE5E,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAA0B,MAAM,kBAAkB,CAAC;AAE5E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EACL,YAAY,EACZ,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC3B,MAAM,8BAA8B,CAAC;AAGtC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC,oBAAoB,EAAE,qBAAqB,CAAC,CAAC;AAE5F;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAAE,qBAAqB,GAAG,iBAAiB,CAAC,CAAC;AAElG;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,CAAC;AAE9F;;;GAGG;AACH,qBAAa,mBAAmB,CAAC,SAAS,SAAS,YAAY,GAAG,QAAQ,CAAE,SAAQ,YAAY,CAAC,SAAS,CAAC;IAMvG,OAAO,CAAC,IAAI;IALd,YACE,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,CAAC,QAAQ,EAAE,2BAA2B,EAAE,MAAM,EAAE,MAAM,KAAK,SAAS,EAC5E,IAAI,EAAE,EAAE,EAChB,IAAI,GAAE,GAAG,EAAO,EAChB,yBAAyB,CAAC,EAAE,MAAM,GAAG,gBAAgB,EAGtD;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,uBAAuB;IAa/B;;;;OAIG;IACmB,OAAO,CAAC,IAAI,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,gBAAgB,CAAC,CA8B3F;IAEQ,oCAAoC,CAAC,OAAO,EAAE,aAAa,GAAG,oBAAoB,CAS1F;CACF"}

package/dest/wallet/deploy_account_method.js

@@ -0,0 +1,77 @@
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { mergeExecutionPayloads } from '@aztec/stdlib/tx';
+import { DeployMethod } from '../contract/deploy_method.js';
+import { AccountEntrypointMetaPaymentMethod } from './account_entrypoint_meta_payment_method.js';
+/**
+ * Modified version of the DeployMethod used to deploy account contracts. Supports deploying
+ * contracts that can pay for their own fee, plus some preconfigured options to avoid errors.
+ */ export class DeployAccountMethod extends DeployMethod {
+    salt;
+    constructor(publicKeys, wallet, artifact, postDeployCtor, salt, args = [], constructorNameOrArtifact){
+        super(publicKeys, wallet, artifact, postDeployCtor, args, constructorNameOrArtifact), this.salt = salt;
+    }
+    /**
+   * Returns a FeePaymentMethod that routes the original one provided as an argument
+   * through the account's entrypoint. This allows an account contract to pay
+   * for its own deployment and initialization.
+   *
+   * For more details on how the fee payment routing works see documentation of AccountEntrypointMetaPaymentMethod class.
+   *
+   * @param originalPaymentMethod - originalPaymentMethod The original payment method to be wrapped.
+   * @returns A FeePaymentMethod that routes the original one through the account's entrypoint (AccountEntrypointMetaPaymentMethod)
+   */ getSelfFeePaymentMethod(originalPaymentMethod) {
+        if (!this.address) {
+            throw new Error('Instance is not yet constructed. This is a bug!');
+        }
+        return new AccountEntrypointMetaPaymentMethod(this.wallet, this.artifact, 'entrypoint', this.address, originalPaymentMethod);
+    }
+    /**
+   * Returns the execution payload that allows this operation to happen on chain.
+   * @param opts - Configuration options.
+   * @returns The execution payload for this operation
+   */ async request(opts) {
+        const optionsWithDefaults = {
+            ...opts,
+            // Regardless of whom sends the transaction, account contracts
+            // are always deployed as universalDeployment: true
+            deployer: undefined,
+            contractAddressSalt: new Fr(this.salt),
+            skipClassPublication: opts?.skipClassPublication ?? true,
+            skipInstancePublication: opts?.skipInstancePublication ?? true,
+            skipInitialization: opts?.skipInitialization ?? false
+        };
+        // Override the fee to undefined, since we'll replace it
+        const deploymentExecutionPayload = await super.request({
+            ...optionsWithDefaults,
+            fee: undefined
+        });
+        const executionPayloads = [
+            deploymentExecutionPayload
+        ];
+        // If this is a self-deployment, manage the fee accordingly
+        if (opts?.deployer?.equals(AztecAddress.ZERO)) {
+            const feePaymentMethod = this.getSelfFeePaymentMethod(opts?.fee?.paymentMethod);
+            const feeExecutionPayload = await feePaymentMethod.getExecutionPayload();
+            // Notice they are reversed (fee payment usually goes first):
+            // this is because we need to construct the contract BEFORE it can pay for its own fee
+            executionPayloads.push(feeExecutionPayload);
+        } else {
+            const feeExecutionPayload = opts?.fee?.paymentMethod ? await opts.fee.paymentMethod.getExecutionPayload() : undefined;
+            if (feeExecutionPayload) {
+                executionPayloads.unshift(feeExecutionPayload);
+            }
+        }
+        return mergeExecutionPayloads(executionPayloads);
+    }
+    convertDeployOptionsToRequestOptions(options) {
+        return {
+            ...options,
+            // Deployer is handled in the request method and forcibly set to undefined,
+            // since our account contracts are created with universalDeployment: true
+            // We need to forward it though, because depending on the deployer we have to assemble
+            // The fee payment method one way or another
+            deployer: options.from
+        };
+    }
+}

package/dest/wallet/index.d.ts

@@ -1,17 +1,3 @@
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { PXE } from '@aztec/stdlib/interfaces/client';
-import type { AccountContract } from '../account/contract.js';
-import { AccountWallet } from './account_wallet.js';
-export * from '../account/wallet.js';
-export * from './account_wallet.js';
-export * from './account_wallet_with_private_key.js';
-export * from './signerless_wallet.js';
-/**
- * Gets a wallet for an already registered account.
- * @param pxe - PXE Service instance.
- * @param address - Address for the account.
- * @param accountContract - Account contract implementation.
- * @returns A wallet for this account that can be used to interact with a contract instance.
- */
-export declare function getWallet(pxe: PXE, address: AztecAddress, accountContract: AccountContract): Promise<AccountWallet>;
-//# sourceMappingURL=index.d.ts.map
+export * from './wallet.js';
+export * from './account_manager.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy93YWxsZXQvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxzQkFBc0IsQ0FBQyJ9

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/wallet/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC;AAE3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sCAAsC,CAAC;AACrD,cAAc,wBAAwB,CAAC;AAEvC;;;;;;GAMG;AACH,wBAAsB,SAAS,CAC7B,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,YAAY,EACrB,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,aAAa,CAAC,CAUxB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/wallet/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC"}

package/dest/wallet/index.js

@@ -1,20 +1,2 @@
-import { AccountWallet } from './account_wallet.js';
-export * from '../account/wallet.js';
-export * from './account_wallet.js';
-export * from './account_wallet_with_private_key.js';
-export * from './signerless_wallet.js';
-/**
- * Gets a wallet for an already registered account.
- * @param pxe - PXE Service instance.
- * @param address - Address for the account.
- * @param accountContract - Account contract implementation.
- * @returns A wallet for this account that can be used to interact with a contract instance.
- */ export async function getWallet(pxe, address, accountContract) {
-    const completeAddress = (await pxe.getRegisteredAccounts()).find((completeAddress)=>completeAddress.address.equals(address));
-    if (!completeAddress) {
-        throw new Error(`Account ${address} not found`);
-    }
-    const nodeInfo = await pxe.getNodeInfo();
-    const entrypoint = accountContract.getInterface(completeAddress, nodeInfo);
-    return new AccountWallet(pxe, entrypoint);
-}
+export * from './wallet.js';
+export * from './account_manager.js';