@aztec/aztec.js 3.0.0-canary.a9708bd → 3.0.0-devnet.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dest/account/account.d.ts +60 -0
- package/dest/account/account.d.ts.map +1 -0
- package/dest/account/account.js +59 -0
- package/dest/account/account_contract.d.ts +5 -5
- package/dest/account/account_contract.d.ts.map +1 -1
- package/dest/account/account_contract.js +0 -1
- package/dest/{wallet/account_wallet_with_private_key.d.ts → account/account_with_secret_key.d.ts} +7 -8
- package/dest/account/account_with_secret_key.d.ts.map +1 -0
- package/dest/{wallet/account_wallet_with_private_key.js → account/account_with_secret_key.js} +5 -5
- package/dest/account/index.d.ts +1 -4
- package/dest/account/index.d.ts.map +1 -1
- package/dest/account/index.js +1 -4
- package/dest/account/signerless_account.d.ts +24 -0
- package/dest/account/signerless_account.d.ts.map +1 -0
- package/dest/account/signerless_account.js +27 -0
- package/dest/api/abi.d.ts +1 -0
- package/dest/api/abi.d.ts.map +1 -1
- package/dest/api/account.d.ts +4 -2
- package/dest/api/account.d.ts.map +1 -1
- package/dest/api/account.js +3 -1
- package/dest/api/addresses.d.ts +1 -0
- package/dest/api/addresses.d.ts.map +1 -1
- package/dest/api/addresses.js +1 -0
- package/dest/api/authorization.d.ts +2 -0
- package/dest/api/authorization.d.ts.map +1 -1
- package/dest/api/authorization.js +2 -0
- package/dest/api/block.d.ts +3 -0
- package/dest/api/block.d.ts.map +1 -0
- package/dest/api/block.js +2 -0
- package/dest/api/contract.d.ts +4 -5
- package/dest/api/contract.d.ts.map +1 -1
- package/dest/api/contract.js +3 -3
- package/dest/api/crypto.d.ts +2 -0
- package/dest/api/crypto.d.ts.map +1 -0
- package/dest/api/crypto.js +1 -0
- package/dest/api/ethereum.d.ts +0 -1
- package/dest/api/ethereum.d.ts.map +1 -1
- package/dest/api/ethereum.js +0 -1
- package/dest/api/events.d.ts +12 -0
- package/dest/api/events.d.ts.map +1 -0
- package/dest/api/events.js +30 -0
- package/dest/api/fee.d.ts +1 -2
- package/dest/api/fee.d.ts.map +1 -1
- package/dest/api/fee.js +0 -1
- package/dest/api/keys.d.ts +4 -0
- package/dest/api/keys.d.ts.map +1 -0
- package/dest/api/keys.js +3 -0
- package/dest/api/log.d.ts +1 -0
- package/dest/api/log.d.ts.map +1 -1
- package/dest/api/log.js +1 -0
- package/dest/api/messaging.d.ts +3 -0
- package/dest/api/messaging.d.ts.map +1 -0
- package/dest/api/messaging.js +2 -0
- package/dest/api/node.d.ts +21 -0
- package/dest/api/node.d.ts.map +1 -0
- package/dest/api/node.js +18 -0
- package/dest/api/note.d.ts +2 -0
- package/dest/api/note.d.ts.map +1 -0
- package/dest/api/note.js +1 -0
- package/dest/api/protocol.d.ts +3 -0
- package/dest/api/protocol.d.ts.map +1 -0
- package/dest/api/protocol.js +2 -0
- package/dest/api/trees.d.ts +3 -0
- package/dest/api/trees.d.ts.map +1 -0
- package/dest/api/trees.js +2 -0
- package/dest/api/tx.d.ts +2 -0
- package/dest/api/tx.d.ts.map +1 -0
- package/dest/api/tx.js +1 -0
- package/dest/api/utils.d.ts +10 -6
- package/dest/api/utils.d.ts.map +1 -1
- package/dest/api/utils.js +10 -5
- package/dest/api/wallet.d.ts +4 -1
- package/dest/api/wallet.d.ts.map +1 -1
- package/dest/api/wallet.js +4 -1
- package/dest/contract/base_contract_interaction.d.ts +6 -48
- package/dest/contract/base_contract_interaction.d.ts.map +1 -1
- package/dest/contract/base_contract_interaction.js +6 -106
- package/dest/contract/batch_call.d.ts +6 -14
- package/dest/contract/batch_call.d.ts.map +1 -1
- package/dest/contract/batch_call.js +42 -52
- package/dest/contract/contract.d.ts +1 -1
- package/dest/contract/contract.d.ts.map +1 -1
- package/dest/contract/contract.js +2 -12
- package/dest/contract/contract_base.d.ts +1 -1
- package/dest/contract/contract_base.d.ts.map +1 -1
- package/dest/contract/contract_function_interaction.d.ts +29 -40
- package/dest/contract/contract_function_interaction.d.ts.map +1 -1
- package/dest/contract/contract_function_interaction.js +41 -53
- package/dest/contract/deploy_method.d.ts +63 -56
- package/dest/contract/deploy_method.d.ts.map +1 -1
- package/dest/contract/deploy_method.js +68 -86
- package/dest/contract/deploy_sent_tx.d.ts +0 -1
- package/dest/contract/deploy_sent_tx.d.ts.map +1 -1
- package/dest/contract/deploy_sent_tx.js +7 -10
- package/dest/contract/interaction_options.d.ts +74 -19
- package/dest/contract/interaction_options.d.ts.map +1 -1
- package/dest/contract/interaction_options.js +51 -3
- package/dest/contract/sent_tx.d.ts +3 -3
- package/dest/contract/sent_tx.d.ts.map +1 -1
- package/dest/contract/sent_tx.js +5 -5
- package/dest/contract/wait_for_proven.d.ts +3 -3
- package/dest/contract/wait_for_proven.d.ts.map +1 -1
- package/dest/contract/wait_for_proven.js +2 -2
- package/dest/deployment/publish_instance.d.ts +1 -1
- package/dest/deployment/publish_instance.d.ts.map +1 -1
- package/dest/deployment/publish_instance.js +2 -5
- package/dest/ethereum/portal_manager.d.ts +3 -4
- package/dest/ethereum/portal_manager.d.ts.map +1 -1
- package/dest/ethereum/portal_manager.js +3 -5
- package/dest/fee/fee_juice_payment_method_with_claim.d.ts +12 -7
- package/dest/fee/fee_juice_payment_method_with_claim.d.ts.map +1 -1
- package/dest/fee/fee_juice_payment_method_with_claim.js +21 -12
- package/dest/fee/fee_payment_method.d.ts +26 -0
- package/dest/fee/fee_payment_method.d.ts.map +1 -0
- package/dest/fee/fee_payment_method.js +3 -0
- package/dest/fee/private_fee_payment_method.d.ts +22 -5
- package/dest/fee/private_fee_payment_method.d.ts.map +1 -1
- package/dest/fee/private_fee_payment_method.js +34 -13
- package/dest/fee/public_fee_payment_method.d.ts +22 -5
- package/dest/fee/public_fee_payment_method.d.ts.map +1 -1
- package/dest/fee/public_fee_payment_method.js +37 -14
- package/dest/fee/sponsored_fee_payment.d.ts +2 -0
- package/dest/fee/sponsored_fee_payment.d.ts.map +1 -1
- package/dest/fee/sponsored_fee_payment.js +4 -0
- package/dest/utils/authwit.d.ts +77 -25
- package/dest/utils/authwit.d.ts.map +1 -1
- package/dest/utils/authwit.js +219 -24
- package/dest/utils/cross_chain.d.ts +24 -0
- package/dest/utils/cross_chain.d.ts.map +1 -0
- package/dest/utils/cross_chain.js +30 -0
- package/dest/utils/fee_juice.d.ts +3 -2
- package/dest/utils/fee_juice.d.ts.map +1 -1
- package/dest/utils/fee_juice.js +3 -2
- package/dest/{fee → wallet}/account_entrypoint_meta_payment_method.d.ts +13 -10
- package/dest/wallet/account_entrypoint_meta_payment_method.d.ts.map +1 -0
- package/dest/wallet/account_entrypoint_meta_payment_method.js +76 -0
- package/dest/wallet/account_manager.d.ts +69 -0
- package/dest/wallet/account_manager.d.ts.map +1 -0
- package/dest/wallet/account_manager.js +113 -0
- package/dest/wallet/base_wallet.d.ts +78 -35
- package/dest/wallet/base_wallet.d.ts.map +1 -1
- package/dest/wallet/base_wallet.js +216 -48
- package/dest/wallet/deploy_account_method.d.ts +52 -0
- package/dest/wallet/deploy_account_method.d.ts.map +1 -0
- package/dest/wallet/deploy_account_method.js +77 -0
- package/dest/wallet/index.d.ts +2 -15
- package/dest/wallet/index.d.ts.map +1 -1
- package/dest/wallet/index.js +2 -19
- package/dest/wallet/wallet.d.ts +2473 -6
- package/dest/wallet/wallet.d.ts.map +1 -1
- package/dest/wallet/wallet.js +202 -3
- package/package.json +25 -21
- package/src/account/account.ts +97 -0
- package/src/account/account_contract.ts +4 -6
- package/src/{wallet/account_wallet_with_private_key.ts → account/account_with_secret_key.ts} +6 -8
- package/src/account/index.ts +1 -4
- package/src/account/signerless_account.ts +46 -0
- package/src/api/abi.ts +11 -0
- package/src/api/account.ts +4 -2
- package/src/api/addresses.ts +1 -0
- package/src/api/authorization.ts +11 -0
- package/src/api/block.ts +2 -0
- package/src/api/contract.ts +16 -8
- package/src/api/crypto.ts +1 -0
- package/src/api/ethereum.ts +0 -1
- package/src/api/events.ts +44 -0
- package/src/api/fee.ts +1 -2
- package/src/api/keys.ts +8 -0
- package/src/api/log.ts +1 -0
- package/src/api/messaging.ts +2 -0
- package/src/api/node.ts +20 -0
- package/src/api/note.ts +1 -0
- package/src/api/protocol.ts +2 -0
- package/src/api/trees.ts +2 -0
- package/src/api/tx.ts +11 -0
- package/src/api/utils.ts +12 -19
- package/src/api/wallet.ts +33 -5
- package/src/contract/base_contract_interaction.ts +9 -138
- package/src/contract/batch_call.ts +52 -61
- package/src/contract/contract.ts +2 -12
- package/src/contract/contract_function_interaction.ts +65 -97
- package/src/contract/deploy_method.ts +117 -99
- package/src/contract/deploy_sent_tx.ts +4 -10
- package/src/contract/interaction_options.ts +126 -24
- package/src/contract/sent_tx.ts +4 -4
- package/src/contract/wait_for_proven.ts +4 -4
- package/src/deployment/publish_instance.ts +3 -8
- package/src/ethereum/portal_manager.ts +4 -12
- package/src/fee/fee_juice_payment_method_with_claim.ts +26 -17
- package/src/fee/fee_payment_method.ts +26 -0
- package/src/fee/private_fee_payment_method.ts +60 -41
- package/src/fee/public_fee_payment_method.ts +73 -49
- package/src/fee/sponsored_fee_payment.ts +6 -0
- package/src/utils/authwit.ts +250 -38
- package/src/utils/cross_chain.ts +53 -0
- package/src/utils/fee_juice.ts +4 -3
- package/src/wallet/account_entrypoint_meta_payment_method.ts +105 -0
- package/src/wallet/account_manager.ts +154 -0
- package/src/wallet/base_wallet.ts +287 -78
- package/src/wallet/deploy_account_method.ts +125 -0
- package/src/wallet/index.ts +2 -32
- package/src/wallet/wallet.ts +357 -29
- package/dest/account_manager/account_manager.d.ts +0 -119
- package/dest/account_manager/account_manager.d.ts.map +0 -1
- package/dest/account_manager/account_manager.js +0 -202
- package/dest/account_manager/deploy_account_sent_tx.d.ts +0 -30
- package/dest/account_manager/deploy_account_sent_tx.d.ts.map +0 -1
- package/dest/account_manager/deploy_account_sent_tx.js +0 -29
- package/dest/account_manager/index.d.ts +0 -3
- package/dest/account_manager/index.d.ts.map +0 -1
- package/dest/account_manager/index.js +0 -2
- package/dest/api/interfaces.d.ts +0 -2
- package/dest/api/interfaces.d.ts.map +0 -1
- package/dest/api/interfaces.js +0 -1
- package/dest/api/log_id.d.ts +0 -2
- package/dest/api/log_id.d.ts.map +0 -1
- package/dest/api/log_id.js +0 -1
- package/dest/api/rpc.d.ts +0 -3
- package/dest/api/rpc.d.ts.map +0 -1
- package/dest/api/rpc.js +0 -2
- package/dest/api/tx_hash.d.ts +0 -2
- package/dest/api/tx_hash.d.ts.map +0 -1
- package/dest/api/tx_hash.js +0 -1
- package/dest/contract/deploy_proven_tx.d.ts +0 -21
- package/dest/contract/deploy_proven_tx.d.ts.map +0 -1
- package/dest/contract/deploy_proven_tx.js +0 -21
- package/dest/contract/proven_tx.d.ts +0 -21
- package/dest/contract/proven_tx.d.ts.map +0 -1
- package/dest/contract/proven_tx.js +0 -23
- package/dest/ethereum/l1_contracts.d.ts +0 -3
- package/dest/ethereum/l1_contracts.d.ts.map +0 -1
- package/dest/ethereum/l1_contracts.js +0 -13
- package/dest/fee/account_entrypoint_meta_payment_method.d.ts.map +0 -1
- package/dest/fee/account_entrypoint_meta_payment_method.js +0 -64
- package/dest/fee/fee_juice_payment_method.d.ts +0 -14
- package/dest/fee/fee_juice_payment_method.d.ts.map +0 -1
- package/dest/fee/fee_juice_payment_method.js +0 -21
- package/dest/fee/utils.d.ts +0 -13
- package/dest/fee/utils.d.ts.map +0 -1
- package/dest/fee/utils.js +0 -32
- package/dest/index.d.ts +0 -59
- package/dest/index.d.ts.map +0 -1
- package/dest/index.js +0 -62
- package/dest/rpc_clients/node/index.d.ts +0 -12
- package/dest/rpc_clients/node/index.d.ts.map +0 -1
- package/dest/rpc_clients/node/index.js +0 -72
- package/dest/rpc_clients/pxe_client.d.ts +0 -10
- package/dest/rpc_clients/pxe_client.d.ts.map +0 -1
- package/dest/rpc_clients/pxe_client.js +0 -23
- package/dest/utils/pxe.d.ts +0 -4
- package/dest/utils/pxe.d.ts.map +0 -1
- package/dest/utils/pxe.js +0 -14
- package/dest/wallet/account_wallet.d.ts +0 -74
- package/dest/wallet/account_wallet.d.ts.map +0 -1
- package/dest/wallet/account_wallet.js +0 -232
- package/dest/wallet/account_wallet_with_private_key.d.ts.map +0 -1
- package/dest/wallet/signerless_wallet.d.ts +0 -23
- package/dest/wallet/signerless_wallet.d.ts.map +0 -1
- package/dest/wallet/signerless_wallet.js +0 -33
- package/src/account_manager/account_manager.ts +0 -276
- package/src/account_manager/deploy_account_sent_tx.ts +0 -46
- package/src/account_manager/index.ts +0 -2
- package/src/api/interfaces.ts +0 -1
- package/src/api/log_id.ts +0 -1
- package/src/api/rpc.ts +0 -2
- package/src/api/tx_hash.ts +0 -1
- package/src/contract/deploy_proven_tx.ts +0 -45
- package/src/contract/proven_tx.ts +0 -36
- package/src/ethereum/l1_contracts.ts +0 -21
- package/src/fee/account_entrypoint_meta_payment_method.ts +0 -89
- package/src/fee/fee_juice_payment_method.ts +0 -25
- package/src/fee/utils.ts +0 -39
- package/src/index.ts +0 -85
- package/src/rpc_clients/node/index.ts +0 -77
- package/src/rpc_clients/pxe_client.ts +0 -25
- package/src/utils/pxe.ts +0 -17
- package/src/wallet/account_wallet.ts +0 -246
- package/src/wallet/signerless_wallet.ts +0 -56
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/entrypoints/payload';
|
|
2
|
+
import { Fr } from '@aztec/foundation/fields';
|
|
3
|
+
import type { ContractArtifact, FunctionArtifact } from '@aztec/stdlib/abi';
|
|
4
|
+
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
5
|
+
import type { PublicKeys } from '@aztec/stdlib/keys';
|
|
6
|
+
|
|
7
|
+
import type { Contract } from '../contract/contract.js';
|
|
8
|
+
import type { ContractBase } from '../contract/contract_base.js';
|
|
9
|
+
import {
|
|
10
|
+
DeployMethod,
|
|
11
|
+
type DeployOptions,
|
|
12
|
+
type RequestDeployOptions,
|
|
13
|
+
type SimulateDeployOptions,
|
|
14
|
+
} from '../contract/deploy_method.js';
|
|
15
|
+
import type { FeePaymentMethod } from '../fee/fee_payment_method.js';
|
|
16
|
+
import { AccountEntrypointMetaPaymentMethod } from './account_entrypoint_meta_payment_method.js';
|
|
17
|
+
import type { Wallet } from './index.js';
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* The configuration options for the request method. Omits the contractAddressSalt, since
|
|
21
|
+
* for account contracts that is fixed in the constructor
|
|
22
|
+
*/
|
|
23
|
+
export type RequestDeployAccountOptions = Omit<RequestDeployOptions, 'contractAddressSalt'>;
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* The configuration options for the send/prove methods. Omits:
|
|
27
|
+
* - The contractAddressSalt, since for account contracts that is fixed in the constructor.
|
|
28
|
+
* - UniversalDeployment flag, since account contracts are always deployed with it set to true
|
|
29
|
+
*/
|
|
30
|
+
export type DeployAccountOptions = Omit<DeployOptions, 'contractAddressSalt' | 'universalDeploy'>;
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* The configuration options for the simulate method. Omits the contractAddressSalt, since
|
|
34
|
+
* for account contracts that is fixed in the constructor
|
|
35
|
+
*/
|
|
36
|
+
export type SimulateDeployAccountOptions = Omit<SimulateDeployOptions, 'contractAddressSalt'>;
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Modified version of the DeployMethod used to deploy account contracts. Supports deploying
|
|
40
|
+
* contracts that can pay for their own fee, plus some preconfigured options to avoid errors.
|
|
41
|
+
*/
|
|
42
|
+
export class DeployAccountMethod<TContract extends ContractBase = Contract> extends DeployMethod<TContract> {
|
|
43
|
+
constructor(
|
|
44
|
+
publicKeys: PublicKeys,
|
|
45
|
+
wallet: Wallet,
|
|
46
|
+
artifact: ContractArtifact,
|
|
47
|
+
postDeployCtor: (address: AztecAddress, wallet: Wallet) => Promise<TContract>,
|
|
48
|
+
private salt: Fr,
|
|
49
|
+
args: any[] = [],
|
|
50
|
+
constructorNameOrArtifact?: string | FunctionArtifact,
|
|
51
|
+
) {
|
|
52
|
+
super(publicKeys, wallet, artifact, postDeployCtor, args, constructorNameOrArtifact);
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Returns a FeePaymentMethod that routes the original one provided as an argument
|
|
57
|
+
* through the account's entrypoint. This allows an account contract to pay
|
|
58
|
+
* for its own deployment and initialization.
|
|
59
|
+
*
|
|
60
|
+
* For more details on how the fee payment routing works see documentation of AccountEntrypointMetaPaymentMethod class.
|
|
61
|
+
*
|
|
62
|
+
* @param originalPaymentMethod - originalPaymentMethod The original payment method to be wrapped.
|
|
63
|
+
* @returns A FeePaymentMethod that routes the original one through the account's entrypoint (AccountEntrypointMetaPaymentMethod)
|
|
64
|
+
*/
|
|
65
|
+
private getSelfFeePaymentMethod(originalPaymentMethod?: FeePaymentMethod) {
|
|
66
|
+
if (!this.address) {
|
|
67
|
+
throw new Error('Instance is not yet constructed. This is a bug!');
|
|
68
|
+
}
|
|
69
|
+
return new AccountEntrypointMetaPaymentMethod(
|
|
70
|
+
this.wallet,
|
|
71
|
+
this.artifact,
|
|
72
|
+
'entrypoint',
|
|
73
|
+
this.address,
|
|
74
|
+
originalPaymentMethod,
|
|
75
|
+
);
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Returns the execution payload that allows this operation to happen on chain.
|
|
80
|
+
* @param opts - Configuration options.
|
|
81
|
+
* @returns The execution payload for this operation
|
|
82
|
+
*/
|
|
83
|
+
public override async request(opts?: RequestDeployAccountOptions): Promise<ExecutionPayload> {
|
|
84
|
+
const optionsWithDefaults: RequestDeployOptions = {
|
|
85
|
+
...opts,
|
|
86
|
+
// Regardless of whom sends the transaction, account contracts
|
|
87
|
+
// are always deployed as universalDeployment: true
|
|
88
|
+
deployer: undefined,
|
|
89
|
+
contractAddressSalt: new Fr(this.salt),
|
|
90
|
+
skipClassPublication: opts?.skipClassPublication ?? true,
|
|
91
|
+
skipInstancePublication: opts?.skipInstancePublication ?? true,
|
|
92
|
+
skipInitialization: opts?.skipInitialization ?? false,
|
|
93
|
+
};
|
|
94
|
+
// Override the fee to undefined, since we'll replace it
|
|
95
|
+
const deploymentExecutionPayload = await super.request({ ...optionsWithDefaults, fee: undefined });
|
|
96
|
+
const executionPayloads = [deploymentExecutionPayload];
|
|
97
|
+
// If this is a self-deployment, manage the fee accordingly
|
|
98
|
+
if (opts?.deployer?.equals(AztecAddress.ZERO)) {
|
|
99
|
+
const feePaymentMethod = this.getSelfFeePaymentMethod(opts?.fee?.paymentMethod);
|
|
100
|
+
const feeExecutionPayload = await feePaymentMethod.getExecutionPayload();
|
|
101
|
+
// Notice they are reversed (fee payment usually goes first):
|
|
102
|
+
// this is because we need to construct the contract BEFORE it can pay for its own fee
|
|
103
|
+
executionPayloads.push(feeExecutionPayload);
|
|
104
|
+
} else {
|
|
105
|
+
const feeExecutionPayload = opts?.fee?.paymentMethod
|
|
106
|
+
? await opts.fee.paymentMethod.getExecutionPayload()
|
|
107
|
+
: undefined;
|
|
108
|
+
if (feeExecutionPayload) {
|
|
109
|
+
executionPayloads.unshift(feeExecutionPayload);
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
return mergeExecutionPayloads(executionPayloads);
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
override convertDeployOptionsToRequestOptions(options: DeployOptions): RequestDeployOptions {
|
|
116
|
+
return {
|
|
117
|
+
...options,
|
|
118
|
+
// Deployer is handled in the request method and forcibly set to undefined,
|
|
119
|
+
// since our account contracts are created with universalDeployment: true
|
|
120
|
+
// We need to forward it though, because depending on the deployer we have to assemble
|
|
121
|
+
// The fee payment method one way or another
|
|
122
|
+
deployer: options.from,
|
|
123
|
+
};
|
|
124
|
+
}
|
|
125
|
+
}
|
package/src/wallet/index.ts
CHANGED
|
@@ -1,33 +1,3 @@
|
|
|
1
|
-
import type { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
2
|
-
import type { PXE } from '@aztec/stdlib/interfaces/client';
|
|
3
|
-
|
|
4
|
-
import type { AccountContract } from '../account/account_contract.js';
|
|
5
|
-
import { AccountWallet } from './account_wallet.js';
|
|
6
|
-
|
|
7
1
|
export * from './wallet.js';
|
|
8
|
-
export * from './
|
|
9
|
-
export * from './
|
|
10
|
-
export * from './signerless_wallet.js';
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* Gets a wallet for an already registered account.
|
|
14
|
-
* @param pxe - PXE Service instance.
|
|
15
|
-
* @param address - Address for the account.
|
|
16
|
-
* @param accountContract - Account contract implementation.
|
|
17
|
-
* @returns A wallet for this account that can be used to interact with a contract instance.
|
|
18
|
-
*/
|
|
19
|
-
export async function getWallet(
|
|
20
|
-
pxe: PXE,
|
|
21
|
-
address: AztecAddress,
|
|
22
|
-
accountContract: AccountContract,
|
|
23
|
-
): Promise<AccountWallet> {
|
|
24
|
-
const completeAddress = (await pxe.getRegisteredAccounts()).find(completeAddress =>
|
|
25
|
-
completeAddress.address.equals(address),
|
|
26
|
-
);
|
|
27
|
-
if (!completeAddress) {
|
|
28
|
-
throw new Error(`Account ${address} not found`);
|
|
29
|
-
}
|
|
30
|
-
const nodeInfo = await pxe.getNodeInfo();
|
|
31
|
-
const entrypoint = accountContract.getInterface(completeAddress, nodeInfo);
|
|
32
|
-
return new AccountWallet(pxe, entrypoint);
|
|
33
|
-
}
|
|
2
|
+
export * from './base_wallet.js';
|
|
3
|
+
export * from './account_manager.js';
|
package/src/wallet/wallet.ts
CHANGED
|
@@ -1,34 +1,362 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
import type {
|
|
1
|
+
import type { ChainInfo } from '@aztec/entrypoints/interfaces';
|
|
2
|
+
import type { ExecutionPayload } from '@aztec/entrypoints/payload';
|
|
3
|
+
import type { Fr } from '@aztec/foundation/fields';
|
|
4
|
+
import {
|
|
5
|
+
AbiTypeSchema,
|
|
6
|
+
type ContractArtifact,
|
|
7
|
+
ContractArtifactSchema,
|
|
8
|
+
type EventMetadataDefinition,
|
|
9
|
+
FunctionAbiSchema,
|
|
10
|
+
FunctionType,
|
|
11
|
+
} from '@aztec/stdlib/abi';
|
|
12
|
+
import { AuthWitness } from '@aztec/stdlib/auth-witness';
|
|
13
|
+
import type { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
14
|
+
import {
|
|
15
|
+
type ContractClassMetadata,
|
|
16
|
+
ContractClassWithIdSchema,
|
|
17
|
+
type ContractInstanceWithAddress,
|
|
18
|
+
ContractInstanceWithAddressSchema,
|
|
19
|
+
type ContractInstantiationData,
|
|
20
|
+
type ContractMetadata,
|
|
21
|
+
} from '@aztec/stdlib/contract';
|
|
22
|
+
import { Gas } from '@aztec/stdlib/gas';
|
|
23
|
+
import { PublicKeys } from '@aztec/stdlib/keys';
|
|
24
|
+
import { AbiDecodedSchema, type ApiSchemaFor, type ZodFor, optional, schemas } from '@aztec/stdlib/schemas';
|
|
25
|
+
import {
|
|
26
|
+
Capsule,
|
|
27
|
+
HashedValues,
|
|
28
|
+
TxHash,
|
|
29
|
+
TxProfileResult,
|
|
30
|
+
TxReceipt,
|
|
31
|
+
TxSimulationResult,
|
|
32
|
+
UtilitySimulationResult,
|
|
33
|
+
} from '@aztec/stdlib/tx';
|
|
3
34
|
|
|
4
|
-
import
|
|
5
|
-
|
|
35
|
+
import { z } from 'zod';
|
|
36
|
+
|
|
37
|
+
import type { Contract } from '../contract/contract.js';
|
|
38
|
+
import type {
|
|
39
|
+
FeeEstimationOptions,
|
|
40
|
+
GasSettingsOption,
|
|
41
|
+
ProfileInteractionOptions,
|
|
42
|
+
SendInteractionOptions,
|
|
43
|
+
SimulateInteractionOptions,
|
|
44
|
+
} from '../contract/interaction_options.js';
|
|
45
|
+
import type { CallIntent, IntentInnerHash } from '../utils/authwit.js';
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* A wrapper type that allows any item to be associated with an alias.
|
|
49
|
+
*/
|
|
50
|
+
export type Aliased<T> = {
|
|
51
|
+
/**
|
|
52
|
+
* The alias
|
|
53
|
+
*/
|
|
54
|
+
alias: string;
|
|
55
|
+
/**
|
|
56
|
+
* The item being aliased.
|
|
57
|
+
*/
|
|
58
|
+
item: T;
|
|
59
|
+
};
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* A reduced representation of a Contract, only including its instance and artifact
|
|
63
|
+
*/
|
|
64
|
+
export type ContractInstanceAndArtifact = Pick<Contract, 'artifact' | 'instance'>;
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Options that can be provided to the wallet for configuration of the fee payment.
|
|
68
|
+
*/
|
|
69
|
+
export type UserFeeOptions = {
|
|
70
|
+
/**
|
|
71
|
+
* Informs the wallet that the crafted tx already contains the necessary calls to pay for its fee
|
|
72
|
+
* and who is paying
|
|
73
|
+
*/
|
|
74
|
+
embeddedPaymentMethodFeePayer?: AztecAddress;
|
|
75
|
+
} & GasSettingsOption;
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* Options for simulating interactions with the wallet. Overrides the fee settings of an interaction with
|
|
79
|
+
* a simplified version that only hints at the wallet wether the interaction contains a
|
|
80
|
+
* fee payment method or not
|
|
81
|
+
*/
|
|
82
|
+
export type SimulateOptions = Omit<SimulateInteractionOptions, 'fee'> & {
|
|
83
|
+
/** The fee options */
|
|
84
|
+
fee?: UserFeeOptions & FeeEstimationOptions;
|
|
85
|
+
};
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* Options for profiling interactions with the wallet. Overrides the fee settings of an interaction with
|
|
89
|
+
* a simplified version that only hints at the wallet wether the interaction contains a
|
|
90
|
+
* fee payment method or not
|
|
91
|
+
*/
|
|
92
|
+
export type ProfileOptions = Omit<ProfileInteractionOptions, 'fee'> & {
|
|
93
|
+
/** The fee options */
|
|
94
|
+
fee?: UserFeeOptions;
|
|
95
|
+
};
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* Options for sending/proving interactions with the wallet. Overrides the fee settings of an interaction with
|
|
99
|
+
* a simplified version that only hints at the wallet wether the interaction contains a
|
|
100
|
+
* fee payment method or not
|
|
101
|
+
*/
|
|
102
|
+
export type SendOptions = Omit<SendInteractionOptions, 'fee'> & {
|
|
103
|
+
/** The fee options */
|
|
104
|
+
fee?: UserFeeOptions;
|
|
105
|
+
};
|
|
106
|
+
|
|
107
|
+
/**
|
|
108
|
+
* Helper type that represents all methods that can be batched.
|
|
109
|
+
*/
|
|
110
|
+
export type BatchableMethods = Pick<Wallet, 'registerContract' | 'sendTx' | 'registerSender' | 'simulateUtility'>;
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* From the batchable methods, we create a type that represents a method call with its name and arguments.
|
|
114
|
+
* This is what the wallet will accept as arguments to the `batch` method.
|
|
115
|
+
*/
|
|
116
|
+
export type BatchedMethod<T extends keyof BatchableMethods> = {
|
|
117
|
+
/** The method name */
|
|
118
|
+
name: T;
|
|
119
|
+
/** The method arguments */
|
|
120
|
+
args: Parameters<BatchableMethods[T]>;
|
|
121
|
+
};
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* Helper type to extract the return type of a batched method
|
|
125
|
+
*/
|
|
126
|
+
export type BatchedMethodResult<T> =
|
|
127
|
+
T extends BatchedMethod<infer K> ? Awaited<ReturnType<BatchableMethods[K]>> : never;
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* Wrapper type for batch results that includes the method name for discriminated union deserialization.
|
|
131
|
+
* Each result is wrapped as \{ name: 'methodName', result: ActualResult \} to allow proper deserialization
|
|
132
|
+
* when AztecAddress and TxHash would otherwise be ambiguous (both are hex strings).
|
|
133
|
+
*/
|
|
134
|
+
export type BatchedMethodResultWrapper<T extends BatchedMethod<keyof BatchableMethods>> = {
|
|
135
|
+
/** The method name */
|
|
136
|
+
name: T['name'];
|
|
137
|
+
/** The method result */
|
|
138
|
+
result: BatchedMethodResult<T>;
|
|
139
|
+
};
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* Maps a tuple of BatchedMethod to a tuple of their wrapped return types
|
|
143
|
+
*/
|
|
144
|
+
export type BatchResults<T extends readonly BatchedMethod<keyof BatchableMethods>[]> = {
|
|
145
|
+
[K in keyof T]: BatchedMethodResultWrapper<T[K]>;
|
|
146
|
+
};
|
|
6
147
|
|
|
7
148
|
/**
|
|
8
149
|
* The wallet interface.
|
|
9
150
|
*/
|
|
10
|
-
export type Wallet =
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
151
|
+
export type Wallet = {
|
|
152
|
+
getContractClassMetadata(id: Fr, includeArtifact?: boolean): Promise<ContractClassMetadata>;
|
|
153
|
+
getContractMetadata(address: AztecAddress): Promise<ContractMetadata>;
|
|
154
|
+
getPrivateEvents<T>(
|
|
155
|
+
contractAddress: AztecAddress,
|
|
156
|
+
eventMetadata: EventMetadataDefinition,
|
|
157
|
+
from: number,
|
|
158
|
+
numBlocks: number,
|
|
159
|
+
recipients: AztecAddress[],
|
|
160
|
+
): Promise<T[]>;
|
|
161
|
+
getChainInfo(): Promise<ChainInfo>;
|
|
162
|
+
getTxReceipt(txHash: TxHash): Promise<TxReceipt>;
|
|
163
|
+
registerSender(address: AztecAddress, alias?: string): Promise<AztecAddress>;
|
|
164
|
+
getAddressBook(): Promise<Aliased<AztecAddress>[]>;
|
|
165
|
+
getAccounts(): Promise<Aliased<AztecAddress>[]>;
|
|
166
|
+
registerContract(
|
|
167
|
+
instanceData: AztecAddress | ContractInstanceWithAddress | ContractInstantiationData | ContractInstanceAndArtifact,
|
|
168
|
+
): Promise<ContractInstanceWithAddress>;
|
|
169
|
+
// Overloaded definition to avoid zod issues
|
|
170
|
+
registerContract(
|
|
171
|
+
instanceData: AztecAddress | ContractInstanceWithAddress | ContractInstantiationData | ContractInstanceAndArtifact,
|
|
172
|
+
artifact: ContractArtifact,
|
|
173
|
+
): Promise<ContractInstanceWithAddress>;
|
|
174
|
+
registerContract(
|
|
175
|
+
instanceData: AztecAddress | ContractInstanceWithAddress | ContractInstantiationData | ContractInstanceAndArtifact,
|
|
176
|
+
artifact: ContractArtifact | undefined,
|
|
177
|
+
secretKey: Fr | undefined,
|
|
178
|
+
): Promise<ContractInstanceWithAddress>;
|
|
179
|
+
simulateTx(exec: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult>;
|
|
180
|
+
simulateUtility(
|
|
181
|
+
functionName: string,
|
|
182
|
+
args: any[],
|
|
183
|
+
to: AztecAddress,
|
|
184
|
+
authwits?: AuthWitness[],
|
|
185
|
+
): Promise<UtilitySimulationResult>;
|
|
186
|
+
profileTx(exec: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult>;
|
|
187
|
+
sendTx(exec: ExecutionPayload, opts: SendOptions): Promise<TxHash>;
|
|
188
|
+
createAuthWit(
|
|
189
|
+
from: AztecAddress,
|
|
190
|
+
messageHashOrIntent: Fr | Buffer<ArrayBuffer> | IntentInnerHash | CallIntent,
|
|
191
|
+
): Promise<AuthWitness>;
|
|
192
|
+
batch<const T extends readonly BatchedMethod<keyof BatchableMethods>[]>(methods: T): Promise<BatchResults<T>>;
|
|
193
|
+
};
|
|
194
|
+
|
|
195
|
+
export const ContractInstantiationDataSchema = z.object({
|
|
196
|
+
constructorArtifact: optional(z.union([FunctionAbiSchema, z.string()])),
|
|
197
|
+
constructorArgs: optional(z.array(z.any())),
|
|
198
|
+
skipArgsDecoding: optional(z.boolean()),
|
|
199
|
+
salt: schemas.Fr,
|
|
200
|
+
publicKeys: optional(PublicKeys.schema),
|
|
201
|
+
deployer: optional(schemas.AztecAddress),
|
|
202
|
+
});
|
|
203
|
+
|
|
204
|
+
export const FunctionCallSchema = z.object({
|
|
205
|
+
name: z.string(),
|
|
206
|
+
to: schemas.AztecAddress,
|
|
207
|
+
selector: schemas.FunctionSelector,
|
|
208
|
+
type: z.nativeEnum(FunctionType),
|
|
209
|
+
isStatic: z.boolean(),
|
|
210
|
+
hideMsgSender: z.boolean(),
|
|
211
|
+
args: z.array(schemas.Fr),
|
|
212
|
+
returnTypes: z.array(AbiTypeSchema),
|
|
213
|
+
});
|
|
214
|
+
|
|
215
|
+
export const ExecutionPayloadSchema = z.object({
|
|
216
|
+
calls: z.array(FunctionCallSchema),
|
|
217
|
+
authWitnesses: z.array(AuthWitness.schema),
|
|
218
|
+
capsules: z.array(Capsule.schema),
|
|
219
|
+
extraHashedArgs: z.array(HashedValues.schema),
|
|
220
|
+
});
|
|
221
|
+
|
|
222
|
+
export const UserFeeOptionsSchema = z.object({
|
|
223
|
+
gasSettings: optional(
|
|
224
|
+
z.object({
|
|
225
|
+
gasLimits: optional(Gas.schema),
|
|
226
|
+
teardownGasLimits: optional(Gas.schema),
|
|
227
|
+
maxFeePerGas: optional(z.object({ feePerDaGas: schemas.BigInt, feePerL2Gas: schemas.BigInt })),
|
|
228
|
+
maxPriorityFeePerGas: optional(z.object({ feePerDaGas: schemas.BigInt, feePerL2Gas: schemas.BigInt })),
|
|
229
|
+
}),
|
|
230
|
+
),
|
|
231
|
+
embeddedPaymentMethodFeePayer: optional(schemas.AztecAddress),
|
|
232
|
+
});
|
|
233
|
+
|
|
234
|
+
export const WalletSimulationFeeOptionSchema = UserFeeOptionsSchema.extend({
|
|
235
|
+
estimatedGasPadding: optional(z.number()),
|
|
236
|
+
estimateGas: optional(z.boolean()),
|
|
237
|
+
});
|
|
238
|
+
|
|
239
|
+
export const SendOptionsSchema = z.object({
|
|
240
|
+
from: schemas.AztecAddress,
|
|
241
|
+
authWitnesses: optional(z.array(AuthWitness.schema)),
|
|
242
|
+
capsules: optional(z.array(Capsule.schema)),
|
|
243
|
+
fee: optional(UserFeeOptionsSchema),
|
|
244
|
+
});
|
|
245
|
+
|
|
246
|
+
export const SimulateOptionsSchema = z.object({
|
|
247
|
+
from: schemas.AztecAddress,
|
|
248
|
+
authWitnesses: optional(z.array(AuthWitness.schema)),
|
|
249
|
+
capsules: optional(z.array(Capsule.schema)),
|
|
250
|
+
fee: optional(WalletSimulationFeeOptionSchema),
|
|
251
|
+
skipTxValidation: optional(z.boolean()),
|
|
252
|
+
skipFeeEnforcement: optional(z.boolean()),
|
|
253
|
+
includeMetadata: optional(z.boolean()),
|
|
254
|
+
});
|
|
255
|
+
|
|
256
|
+
export const ProfileOptionsSchema = SimulateOptionsSchema.extend({
|
|
257
|
+
profileMode: z.enum(['gates', 'execution-steps', 'full']),
|
|
258
|
+
skipProofGeneration: optional(z.boolean()),
|
|
259
|
+
});
|
|
260
|
+
|
|
261
|
+
export const InstanceDataSchema = z.union([
|
|
262
|
+
schemas.AztecAddress,
|
|
263
|
+
ContractInstanceWithAddressSchema,
|
|
264
|
+
ContractInstantiationDataSchema,
|
|
265
|
+
z.object({ instance: ContractInstanceWithAddressSchema, artifact: ContractArtifactSchema }),
|
|
266
|
+
]);
|
|
267
|
+
|
|
268
|
+
export const MessageHashOrIntentSchema = z.union([
|
|
269
|
+
schemas.Fr,
|
|
270
|
+
schemas.Buffer,
|
|
271
|
+
z.object({ consumer: schemas.AztecAddress, innerHash: z.union([schemas.Buffer, schemas.Fr]) }),
|
|
272
|
+
z.object({
|
|
273
|
+
caller: schemas.AztecAddress,
|
|
274
|
+
call: FunctionCallSchema,
|
|
275
|
+
}),
|
|
276
|
+
]);
|
|
277
|
+
|
|
278
|
+
export const BatchedMethodSchema = z.union([
|
|
279
|
+
z.object({
|
|
280
|
+
name: z.literal('registerSender'),
|
|
281
|
+
args: z.tuple([schemas.AztecAddress, optional(z.string())]),
|
|
282
|
+
}),
|
|
283
|
+
z.object({
|
|
284
|
+
name: z.literal('registerContract'),
|
|
285
|
+
args: z.tuple([InstanceDataSchema, optional(ContractArtifactSchema), optional(schemas.Fr)]),
|
|
286
|
+
}),
|
|
287
|
+
z.object({
|
|
288
|
+
name: z.literal('sendTx'),
|
|
289
|
+
args: z.tuple([ExecutionPayloadSchema, SendOptionsSchema]),
|
|
290
|
+
}),
|
|
291
|
+
z.object({
|
|
292
|
+
name: z.literal('simulateUtility'),
|
|
293
|
+
args: z.tuple([z.string(), z.array(z.any()), schemas.AztecAddress, optional(z.array(AuthWitness.schema))]),
|
|
294
|
+
}),
|
|
295
|
+
]);
|
|
296
|
+
|
|
297
|
+
export const ContractMetadataSchema = z.object({
|
|
298
|
+
contractInstance: z.union([ContractInstanceWithAddressSchema, z.undefined()]),
|
|
299
|
+
isContractInitialized: z.boolean(),
|
|
300
|
+
isContractPublished: z.boolean(),
|
|
301
|
+
}) satisfies ZodFor<ContractMetadata>;
|
|
302
|
+
|
|
303
|
+
export const ContractClassMetadataSchema = z.object({
|
|
304
|
+
contractClass: z.union([ContractClassWithIdSchema, z.undefined()]),
|
|
305
|
+
isContractClassPubliclyRegistered: z.boolean(),
|
|
306
|
+
artifact: z.union([ContractArtifactSchema, z.undefined()]),
|
|
307
|
+
}) satisfies ZodFor<ContractClassMetadata>;
|
|
308
|
+
|
|
309
|
+
export const EventMetadataDefinitionSchema = z.object({
|
|
310
|
+
eventSelector: schemas.EventSelector,
|
|
311
|
+
abiType: AbiTypeSchema,
|
|
312
|
+
fieldNames: z.array(z.string()),
|
|
313
|
+
});
|
|
314
|
+
|
|
315
|
+
export const WalletSchema: ApiSchemaFor<Wallet> = {
|
|
316
|
+
getChainInfo: z
|
|
317
|
+
.function()
|
|
318
|
+
.args()
|
|
319
|
+
.returns(z.object({ chainId: schemas.Fr, version: schemas.Fr })),
|
|
320
|
+
getContractClassMetadata: z.function().args(schemas.Fr, optional(z.boolean())).returns(ContractClassMetadataSchema),
|
|
321
|
+
getContractMetadata: z.function().args(schemas.AztecAddress).returns(ContractMetadataSchema),
|
|
322
|
+
getTxReceipt: z.function().args(TxHash.schema).returns(TxReceipt.schema),
|
|
323
|
+
getPrivateEvents: z
|
|
324
|
+
.function()
|
|
325
|
+
.args(schemas.AztecAddress, EventMetadataDefinitionSchema, z.number(), z.number(), z.array(schemas.AztecAddress))
|
|
326
|
+
.returns(z.array(AbiDecodedSchema)),
|
|
327
|
+
registerSender: z.function().args(schemas.AztecAddress, optional(z.string())).returns(schemas.AztecAddress),
|
|
328
|
+
getAddressBook: z
|
|
329
|
+
.function()
|
|
330
|
+
.args()
|
|
331
|
+
.returns(z.array(z.object({ alias: z.string(), item: schemas.AztecAddress }))),
|
|
332
|
+
getAccounts: z
|
|
333
|
+
.function()
|
|
334
|
+
.args()
|
|
335
|
+
.returns(z.array(z.object({ alias: z.string(), item: schemas.AztecAddress }))),
|
|
336
|
+
registerContract: z
|
|
337
|
+
.function()
|
|
338
|
+
.args(InstanceDataSchema, optional(ContractArtifactSchema), optional(schemas.Fr))
|
|
339
|
+
.returns(ContractInstanceWithAddressSchema),
|
|
340
|
+
simulateTx: z.function().args(ExecutionPayloadSchema, SimulateOptionsSchema).returns(TxSimulationResult.schema),
|
|
341
|
+
simulateUtility: z
|
|
342
|
+
.function()
|
|
343
|
+
.args(z.string(), z.array(z.any()), schemas.AztecAddress, optional(z.array(AuthWitness.schema)))
|
|
344
|
+
.returns(UtilitySimulationResult.schema),
|
|
345
|
+
profileTx: z.function().args(ExecutionPayloadSchema, ProfileOptionsSchema).returns(TxProfileResult.schema),
|
|
346
|
+
sendTx: z.function().args(ExecutionPayloadSchema, SendOptionsSchema).returns(TxHash.schema),
|
|
347
|
+
createAuthWit: z.function().args(schemas.AztecAddress, MessageHashOrIntentSchema).returns(AuthWitness.schema),
|
|
348
|
+
// @ts-expect-error - ApiSchemaFor cannot properly type generic methods with readonly arrays
|
|
349
|
+
batch: z
|
|
350
|
+
.function()
|
|
351
|
+
.args(z.array(BatchedMethodSchema))
|
|
352
|
+
.returns(
|
|
353
|
+
z.array(
|
|
354
|
+
z.discriminatedUnion('name', [
|
|
355
|
+
z.object({ name: z.literal('registerSender'), result: schemas.AztecAddress }),
|
|
356
|
+
z.object({ name: z.literal('registerContract'), result: ContractInstanceWithAddressSchema }),
|
|
357
|
+
z.object({ name: z.literal('sendTx'), result: TxHash.schema }),
|
|
358
|
+
z.object({ name: z.literal('simulateUtility'), result: UtilitySimulationResult.schema }),
|
|
359
|
+
]),
|
|
360
|
+
),
|
|
361
|
+
),
|
|
362
|
+
};
|
|
@@ -1,119 +0,0 @@
|
|
|
1
|
-
import { Fr } from '@aztec/foundation/fields';
|
|
2
|
-
import { CompleteAddress, type ContractInstanceWithAddress } from '@aztec/stdlib/contract';
|
|
3
|
-
import type { PXE } from '@aztec/stdlib/interfaces/client';
|
|
4
|
-
import type { AccountContract } from '../account/account_contract.js';
|
|
5
|
-
import type { Salt } from '../account/index.js';
|
|
6
|
-
import type { AccountInterface } from '../account/interface.js';
|
|
7
|
-
import { DeployMethod, type DeployOptions } from '../contract/deploy_method.js';
|
|
8
|
-
import { type WaitOpts } from '../contract/sent_tx.js';
|
|
9
|
-
import { AccountEntrypointMetaPaymentMethod } from '../fee/account_entrypoint_meta_payment_method.js';
|
|
10
|
-
import { AztecAddress, type FeePaymentMethod } from '../index.js';
|
|
11
|
-
import { AccountWalletWithSecretKey, type Wallet } from '../wallet/index.js';
|
|
12
|
-
import { DeployAccountSentTx } from './deploy_account_sent_tx.js';
|
|
13
|
-
/**
|
|
14
|
-
* Options to deploy an account contract.
|
|
15
|
-
*/
|
|
16
|
-
export type DeployAccountOptions = Pick<DeployOptions, 'fee' | 'skipClassPublication' | 'skipInstancePublication' | 'skipInitialization'> & {
|
|
17
|
-
/**
|
|
18
|
-
* Wallet used for any txs to initialize and/or publish the account contract. Must be funded in order to pay for the fee.
|
|
19
|
-
*/
|
|
20
|
-
deployWallet?: Wallet;
|
|
21
|
-
};
|
|
22
|
-
/**
|
|
23
|
-
* Manages a user account. Provides methods for calculating the account's address, deploying the account contract,
|
|
24
|
-
* and creating and registering the user wallet in the PXE Service.
|
|
25
|
-
*/
|
|
26
|
-
export declare class AccountManager {
|
|
27
|
-
private pxe;
|
|
28
|
-
private secretKey;
|
|
29
|
-
private accountContract;
|
|
30
|
-
private instance;
|
|
31
|
-
/**
|
|
32
|
-
* Contract instantiation salt for the account contract
|
|
33
|
-
*/
|
|
34
|
-
readonly salt: Salt;
|
|
35
|
-
private constructor();
|
|
36
|
-
static create(pxe: PXE, secretKey: Fr, accountContract: AccountContract, salt?: Salt): Promise<AccountManager>;
|
|
37
|
-
protected getPublicKeys(): import("@aztec/stdlib/keys").PublicKeys;
|
|
38
|
-
protected getPublicKeysHash(): Fr | Promise<Fr>;
|
|
39
|
-
/**
|
|
40
|
-
* Returns the entrypoint for this account as defined by its account contract.
|
|
41
|
-
* @returns An entrypoint.
|
|
42
|
-
*/
|
|
43
|
-
getAccount(): Promise<AccountInterface>;
|
|
44
|
-
/**
|
|
45
|
-
* Gets the calculated complete address associated with this account.
|
|
46
|
-
* Does not require the account to have been published for public execution.
|
|
47
|
-
* @returns The address, partial address, and encryption public key.
|
|
48
|
-
*/
|
|
49
|
-
getCompleteAddress(): Promise<CompleteAddress>;
|
|
50
|
-
/**
|
|
51
|
-
* Gets the address for this given account.
|
|
52
|
-
* Does not require the account to have been published for public execution.
|
|
53
|
-
* @returns The address.
|
|
54
|
-
*/
|
|
55
|
-
getAddress(): AztecAddress;
|
|
56
|
-
/**
|
|
57
|
-
* Returns the contract instance definition associated with this account.
|
|
58
|
-
* Does not require the account to have been published for public execution.
|
|
59
|
-
* @returns ContractInstance instance.
|
|
60
|
-
*/
|
|
61
|
-
getInstance(): ContractInstanceWithAddress;
|
|
62
|
-
/**
|
|
63
|
-
* Returns a Wallet instance associated with this account. Use it to create Contract
|
|
64
|
-
* instances to be interacted with from this account.
|
|
65
|
-
* @returns A Wallet instance.
|
|
66
|
-
*/
|
|
67
|
-
getWallet(): Promise<AccountWalletWithSecretKey>;
|
|
68
|
-
/**
|
|
69
|
-
* Add this account in the PXE Service and returns the associated wallet. Adding
|
|
70
|
-
* the account to the PXE Service is required for managing private state associated with it.
|
|
71
|
-
* Use the returned wallet to create Contract instances to be interacted with from this account.
|
|
72
|
-
* @param opts - Options to wait for the account to be synched.
|
|
73
|
-
* @returns A Wallet instance.
|
|
74
|
-
*/
|
|
75
|
-
register(): Promise<AccountWalletWithSecretKey>;
|
|
76
|
-
/**
|
|
77
|
-
* Returns the pre-populated ContractSetupMethods which can prepare a tx to
|
|
78
|
-
* initialize and/or publish this account's account contract (depending on the contract's design).
|
|
79
|
-
* If no wallet is provided, it uses a signerless wallet with the multi call entrypoint
|
|
80
|
-
* @param deployWallet - Wallet used for any txs that are needed to
|
|
81
|
-
* set up the account contract for use.
|
|
82
|
-
* @returns A ContractSetupMethods instance that can set up this account contract for use
|
|
83
|
-
*/
|
|
84
|
-
getDeployMethod(deployWallet?: Wallet): Promise<DeployMethod>;
|
|
85
|
-
/**
|
|
86
|
-
* Returns a FeePaymentMethod that routes the original one provided as an argument
|
|
87
|
-
* through the account's entrypoint. This allows an account contract to pay
|
|
88
|
-
* for its own deployment and initialization.
|
|
89
|
-
*
|
|
90
|
-
* For more details on how the fee payment routing works see documentation of AccountEntrypointMetaPaymentMethod class.
|
|
91
|
-
*
|
|
92
|
-
* @param originalPaymentMethod - originalPaymentMethod The original payment method to be wrapped.
|
|
93
|
-
* @returns A FeePaymentMethod that routes the original one through the account's entrypoint (AccountEntrypointMetaPaymentMethod)
|
|
94
|
-
*/
|
|
95
|
-
getSelfPaymentMethod(originalPaymentMethod?: FeePaymentMethod): Promise<AccountEntrypointMetaPaymentMethod>;
|
|
96
|
-
/**
|
|
97
|
-
* Submits a tx to initialize and/or publish this account's account contract
|
|
98
|
-
* (depending on the contract's design).
|
|
99
|
-
* Doesn't necessarily publish the class nor publish the instance.
|
|
100
|
-
* Uses the salt provided in the constructor or a randomly generated one.
|
|
101
|
-
* Adds the account to the PXE Service first.
|
|
102
|
-
* @param opts - Fee options to be used for the deployment.
|
|
103
|
-
* @returns A SentTx object that can be waited to get the associated Wallet.
|
|
104
|
-
*/
|
|
105
|
-
deploy(opts?: DeployAccountOptions): DeployAccountSentTx;
|
|
106
|
-
/**
|
|
107
|
-
* Deploys the account contract that backs this account if needed and awaits the tx to be mined.
|
|
108
|
-
* Uses the salt provided in the constructor or a randomly generated one. If no initialization
|
|
109
|
-
* is required it skips the transaction, and only registers the account in the PXE Service.
|
|
110
|
-
* @param opts - Options to wait for the tx to be mined.
|
|
111
|
-
* @returns A Wallet instance.
|
|
112
|
-
*/
|
|
113
|
-
waitSetup(opts?: DeployAccountOptions & WaitOpts): Promise<AccountWalletWithSecretKey>;
|
|
114
|
-
/**
|
|
115
|
-
* Returns whether this account contract has an initializer function.
|
|
116
|
-
*/
|
|
117
|
-
hasInitializer(): Promise<boolean>;
|
|
118
|
-
}
|
|
119
|
-
//# sourceMappingURL=account_manager.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"account_manager.d.ts","sourceRoot":"","sources":["../../src/account_manager/account_manager.ts"],"names":[],"mappings":"AACA,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,gCAAgC,CAAC;AACtE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,KAAK,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAChF,OAAO,EAAmB,KAAK,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,kCAAkC,EAAE,MAAM,kDAAkD,CAAC;AACtG,OAAO,EAAE,YAAY,EAAyB,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACzF,OAAO,EAAE,0BAA0B,EAAoB,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC/F,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,aAAa,EACb,KAAK,GAAG,sBAAsB,GAAG,yBAAyB,GAAG,oBAAoB,CAClF,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;IAoB1F,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;;;;;;;OAOG;IACU,eAAe,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAgD1E;;;;;;;;;OASG;IACU,oBAAoB,CAAC,qBAAqB,CAAC,EAAE,gBAAgB;IAa1E;;;;;;;;OAQG;IACI,MAAM,CAAC,IAAI,CAAC,EAAE,oBAAoB,GAAG,mBAAmB;IA6B/D;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,GAAE,oBAAoB,GAAG,QAA0B,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAKpH;;OAEG;IACU,cAAc;CAG5B"}
|