@aztec/aztec.js 3.0.0-canary.a9708bd → 3.0.0-devnet.2

package/dest/wallet/deploy_account_method.d.ts

@@ -0,0 +1,52 @@
+import { ExecutionPayload } from '@aztec/entrypoints/payload';
+import { Fr } from '@aztec/foundation/fields';
+import type { ContractArtifact, FunctionArtifact } from '@aztec/stdlib/abi';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { PublicKeys } from '@aztec/stdlib/keys';
+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: (address: AztecAddress, wallet: Wallet) => Promise<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=deploy_account_method.d.ts.map

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,gBAAgB,EAA0B,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD,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;gBAJZ,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,CAAC,EACrE,IAAI,EAAE,EAAE,EAChB,IAAI,GAAE,GAAG,EAAO,EAChB,yBAAyB,CAAC,EAAE,MAAM,GAAG,gBAAgB;IAKvD;;;;;;;;;OASG;IACH,OAAO,CAAC,uBAAuB;IAa/B;;;;OAIG;IACmB,OAAO,CAAC,IAAI,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgCnF,oCAAoC,CAAC,OAAO,EAAE,aAAa,GAAG,oBAAoB;CAU5F"}

package/dest/wallet/deploy_account_method.js

@@ -0,0 +1,77 @@
+import { mergeExecutionPayloads } from '@aztec/entrypoints/payload';
+import { Fr } from '@aztec/foundation/fields';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+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,4 @@
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { PXE } from '@aztec/stdlib/interfaces/client';
-import type { AccountContract } from '../account/account_contract.js';
-import { AccountWallet } from './account_wallet.js';
 export * from './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>;
+export * from './base_wallet.js';
+export * from './account_manager.js';
 //# sourceMappingURL=index.d.ts.map

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,gCAAgC,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,cAAc,aAAa,CAAC;AAC5B,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,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC"}

package/dest/wallet/index.js

@@ -1,20 +1,3 @@
-import { AccountWallet } from './account_wallet.js';
 export * from './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 './base_wallet.js';
+export * from './account_manager.js';