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

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.
Files changed (157) hide show
  1. package/dest/account/account.d.ts +25 -40
  2. package/dest/account/account.d.ts.map +1 -1
  3. package/dest/account/account.js +19 -47
  4. package/dest/account/account_contract.d.ts +7 -8
  5. package/dest/account/account_contract.d.ts.map +1 -1
  6. package/dest/account/account_with_secret_key.d.ts +18 -7
  7. package/dest/account/account_with_secret_key.d.ts.map +1 -1
  8. package/dest/account/account_with_secret_key.js +21 -4
  9. package/dest/account/index.d.ts +3 -2
  10. package/dest/account/index.d.ts.map +1 -1
  11. package/dest/account/index.js +2 -0
  12. package/dest/account/signerless_account.d.ts +5 -6
  13. package/dest/account/signerless_account.d.ts.map +1 -1
  14. package/dest/account/signerless_account.js +8 -11
  15. package/dest/api/account.d.ts +2 -4
  16. package/dest/api/account.d.ts.map +1 -1
  17. package/dest/api/account.js +1 -3
  18. package/dest/api/authorization.d.ts +2 -2
  19. package/dest/api/authorization.d.ts.map +1 -1
  20. package/dest/api/authorization.js +1 -1
  21. package/dest/api/block.d.ts +2 -2
  22. package/dest/api/block.d.ts.map +1 -1
  23. package/dest/api/block.js +1 -1
  24. package/dest/api/contract.d.ts +16 -10
  25. package/dest/api/contract.d.ts.map +1 -1
  26. package/dest/api/contract.js +14 -8
  27. package/dest/api/events.d.ts +10 -6
  28. package/dest/api/events.d.ts.map +1 -1
  29. package/dest/api/events.js +30 -20
  30. package/dest/api/fields.d.ts +2 -1
  31. package/dest/api/fields.d.ts.map +1 -1
  32. package/dest/api/fields.js +1 -0
  33. package/dest/api/keys.d.ts +1 -1
  34. package/dest/api/keys.js +1 -1
  35. package/dest/api/node.d.ts +8 -4
  36. package/dest/api/node.d.ts.map +1 -1
  37. package/dest/api/node.js +7 -3
  38. package/dest/api/tx.d.ts +2 -2
  39. package/dest/api/tx.d.ts.map +1 -1
  40. package/dest/api/tx.js +1 -1
  41. package/dest/api/wallet.d.ts +3 -2
  42. package/dest/api/wallet.d.ts.map +1 -1
  43. package/dest/api/wallet.js +2 -1
  44. package/dest/contract/base_contract_interaction.d.ts +8 -10
  45. package/dest/contract/base_contract_interaction.d.ts.map +1 -1
  46. package/dest/contract/base_contract_interaction.js +5 -17
  47. package/dest/contract/contract_function_interaction.d.ts +3 -12
  48. package/dest/contract/contract_function_interaction.d.ts.map +1 -1
  49. package/dest/contract/contract_function_interaction.js +6 -6
  50. package/dest/contract/deploy_method.d.ts +63 -16
  51. package/dest/contract/deploy_method.d.ts.map +1 -1
  52. package/dest/contract/deploy_method.js +36 -19
  53. package/dest/contract/interaction_options.d.ts +42 -5
  54. package/dest/contract/interaction_options.d.ts.map +1 -1
  55. package/dest/contract/interaction_options.js +8 -1
  56. package/dest/contract/protocol_contracts/auth-registry.d.ts +1 -10
  57. package/dest/contract/protocol_contracts/auth-registry.d.ts.map +1 -1
  58. package/dest/contract/protocol_contracts/auth-registry.js +97 -467
  59. package/dest/contract/protocol_contracts/contract-class-registry.d.ts +2 -11
  60. package/dest/contract/protocol_contracts/contract-class-registry.d.ts.map +1 -1
  61. package/dest/contract/protocol_contracts/contract-class-registry.js +10 -422
  62. package/dest/contract/protocol_contracts/contract-instance-registry.d.ts +2 -11
  63. package/dest/contract/protocol_contracts/contract-instance-registry.d.ts.map +1 -1
  64. package/dest/contract/protocol_contracts/contract-instance-registry.js +80 -482
  65. package/dest/contract/protocol_contracts/fee-juice.d.ts +1 -10
  66. package/dest/contract/protocol_contracts/fee-juice.d.ts.map +1 -1
  67. package/dest/contract/protocol_contracts/fee-juice.js +14 -412
  68. package/dest/contract/protocol_contracts/multi-call-entrypoint.d.ts +3 -3
  69. package/dest/contract/protocol_contracts/multi-call-entrypoint.d.ts.map +1 -1
  70. package/dest/contract/protocol_contracts/multi-call-entrypoint.js +23 -14
  71. package/dest/contract/protocol_contracts/public-checks.d.ts +3 -3
  72. package/dest/contract/protocol_contracts/public-checks.d.ts.map +1 -1
  73. package/dest/contract/protocol_contracts/public-checks.js +23 -22
  74. package/dest/contract/wait_for_proven.js +1 -1
  75. package/dest/contract/wait_opts.d.ts +16 -0
  76. package/dest/contract/wait_opts.d.ts.map +1 -0
  77. package/dest/contract/wait_opts.js +5 -0
  78. package/dest/fee/fee_juice_payment_method_with_claim.js +6 -6
  79. package/dest/fee/private_fee_payment_method.js +10 -10
  80. package/dest/fee/public_fee_payment_method.js +10 -10
  81. package/dest/fee/sponsored_fee_payment.js +3 -3
  82. package/dest/utils/authwit.d.ts +8 -6
  83. package/dest/utils/authwit.d.ts.map +1 -1
  84. package/dest/utils/authwit.js +5 -9
  85. package/dest/utils/node.d.ts +12 -1
  86. package/dest/utils/node.d.ts.map +1 -1
  87. package/dest/utils/node.js +46 -0
  88. package/dest/wallet/account_entrypoint_meta_payment_method.d.ts +5 -8
  89. package/dest/wallet/account_entrypoint_meta_payment_method.d.ts.map +1 -1
  90. package/dest/wallet/account_entrypoint_meta_payment_method.js +28 -43
  91. package/dest/wallet/account_manager.d.ts +1 -7
  92. package/dest/wallet/account_manager.d.ts.map +1 -1
  93. package/dest/wallet/account_manager.js +5 -11
  94. package/dest/wallet/capabilities.d.ts +444 -0
  95. package/dest/wallet/capabilities.d.ts.map +1 -0
  96. package/dest/wallet/capabilities.js +3 -0
  97. package/dest/wallet/deploy_account_method.d.ts +34 -6
  98. package/dest/wallet/deploy_account_method.d.ts.map +1 -1
  99. package/dest/wallet/deploy_account_method.js +7 -5
  100. package/dest/wallet/index.d.ts +2 -1
  101. package/dest/wallet/index.d.ts.map +1 -1
  102. package/dest/wallet/index.js +1 -0
  103. package/dest/wallet/wallet.d.ts +1493 -94
  104. package/dest/wallet/wallet.d.ts.map +1 -1
  105. package/dest/wallet/wallet.js +158 -26
  106. package/package.json +19 -10
  107. package/src/account/account.ts +34 -58
  108. package/src/account/account_contract.ts +6 -7
  109. package/src/account/account_with_secret_key.ts +33 -8
  110. package/src/account/index.ts +2 -1
  111. package/src/account/signerless_account.ts +13 -12
  112. package/src/api/account.ts +9 -3
  113. package/src/api/authorization.ts +1 -0
  114. package/src/api/block.ts +1 -1
  115. package/src/api/contract.ts +22 -7
  116. package/src/api/events.ts +35 -27
  117. package/src/api/fields.ts +1 -0
  118. package/src/api/keys.ts +2 -2
  119. package/src/api/node.ts +7 -3
  120. package/src/api/tx.ts +2 -0
  121. package/src/api/wallet.ts +47 -1
  122. package/src/contract/base_contract_interaction.ts +27 -15
  123. package/src/contract/contract_function_interaction.ts +13 -6
  124. package/src/contract/deploy_method.ts +115 -23
  125. package/src/contract/interaction_options.ts +49 -4
  126. package/src/contract/protocol_contracts/auth-registry.ts +45 -236
  127. package/src/contract/protocol_contracts/contract-class-registry.ts +3 -204
  128. package/src/contract/protocol_contracts/contract-instance-registry.ts +34 -233
  129. package/src/contract/protocol_contracts/fee-juice.ts +4 -202
  130. package/src/contract/protocol_contracts/multi-call-entrypoint.ts +6 -12
  131. package/src/contract/protocol_contracts/public-checks.ts +6 -14
  132. package/src/contract/wait_for_proven.ts +1 -1
  133. package/src/contract/wait_opts.ts +21 -0
  134. package/src/fee/fee_juice_payment_method_with_claim.ts +5 -5
  135. package/src/fee/private_fee_payment_method.ts +7 -7
  136. package/src/fee/public_fee_payment_method.ts +8 -8
  137. package/src/fee/sponsored_fee_payment.ts +3 -3
  138. package/src/utils/authwit.ts +19 -7
  139. package/src/utils/node.ts +62 -0
  140. package/src/wallet/account_entrypoint_meta_payment_method.ts +28 -60
  141. package/src/wallet/account_manager.ts +5 -13
  142. package/src/wallet/capabilities.ts +491 -0
  143. package/src/wallet/deploy_account_method.ts +37 -13
  144. package/src/wallet/index.ts +1 -0
  145. package/src/wallet/wallet.ts +214 -48
  146. package/dest/account/interface.d.ts +0 -19
  147. package/dest/account/interface.d.ts.map +0 -1
  148. package/dest/account/interface.js +0 -5
  149. package/dest/contract/deploy_sent_tx.d.ts +0 -48
  150. package/dest/contract/deploy_sent_tx.d.ts.map +0 -1
  151. package/dest/contract/deploy_sent_tx.js +0 -46
  152. package/dest/contract/sent_tx.d.ts +0 -50
  153. package/dest/contract/sent_tx.d.ts.map +0 -1
  154. package/dest/contract/sent_tx.js +0 -90
  155. package/src/account/interface.ts +0 -25
  156. package/src/contract/deploy_sent_tx.ts +0 -75
  157. package/src/contract/sent_tx.ts +0 -129
package/src/utils/node.ts CHANGED
@@ -1,6 +1,10 @@
1
1
  import type { Logger } from '@aztec/foundation/log';
2
2
  import { retryUntil } from '@aztec/foundation/retry';
3
3
  import type { AztecNode } from '@aztec/stdlib/interfaces/client';
4
+ import type { TxHash, TxReceipt } from '@aztec/stdlib/tx';
5
+ import { SortedTxStatuses, TxStatus } from '@aztec/stdlib/tx';
6
+
7
+ import { DefaultWaitOpts, type WaitOpts } from '../contract/wait_opts.js';
4
8
 
5
9
  export const waitForNode = async (node: AztecNode, logger?: Logger) => {
6
10
  await retryUntil(async () => {
@@ -16,4 +20,62 @@ export const waitForNode = async (node: AztecNode, logger?: Logger) => {
16
20
  }, 'RPC Get Node Info');
17
21
  };
18
22
 
23
+ /** Returns true if the receipt status is at least the desired status level. */
24
+ function hasReachedStatus(receipt: TxReceipt, desiredStatus: TxStatus): boolean {
25
+ return SortedTxStatuses.indexOf(receipt.status) >= SortedTxStatuses.indexOf(desiredStatus);
26
+ }
27
+
28
+ /**
29
+ * Waits for a transaction to be mined and returns its receipt.
30
+ * @param node - The Aztec node to query for transaction status
31
+ * @param txHash - The hash of the transaction to wait for
32
+ * @param opts - Optional configuration for waiting behavior
33
+ * @returns The transaction receipt
34
+ * @throws If the transaction fails and dontThrowOnRevert is not set
35
+ */
36
+ export async function waitForTx(node: AztecNode, txHash: TxHash, opts?: WaitOpts): Promise<TxReceipt> {
37
+ const startTime = Date.now();
38
+ const ignoreDroppedReceiptsFor = opts?.ignoreDroppedReceiptsFor ?? DefaultWaitOpts.ignoreDroppedReceiptsFor;
39
+ const waitForStatus = opts?.waitForStatus ?? TxStatus.CHECKPOINTED;
40
+
41
+ const receipt = await retryUntil(
42
+ async () => {
43
+ const txReceipt = await node.getTxReceipt(txHash);
44
+ // If receipt is not yet available, try again
45
+ if (txReceipt.isPending()) {
46
+ return undefined;
47
+ }
48
+ // If the tx was "dropped", either return it or ignore based on timing.
49
+ // We can ignore it at first because the transaction may have been sent to node 1, and now we're asking node 2 for the receipt.
50
+ // If we don't allow a short grace period, we could incorrectly return a TxReceipt with status DROPPED.
51
+ if (txReceipt.isDropped()) {
52
+ const elapsedSeconds = (Date.now() - startTime) / 1000;
53
+ if (!ignoreDroppedReceiptsFor || elapsedSeconds > ignoreDroppedReceiptsFor) {
54
+ return txReceipt;
55
+ }
56
+ return undefined;
57
+ }
58
+ // Check if the receipt has reached the desired status level
59
+ if (!hasReachedStatus(txReceipt, waitForStatus)) {
60
+ return undefined;
61
+ }
62
+ return txReceipt;
63
+ },
64
+ 'isMined',
65
+ opts?.timeout ?? DefaultWaitOpts.timeout,
66
+ opts?.interval ?? DefaultWaitOpts.interval,
67
+ );
68
+
69
+ if (!receipt.isMined()) {
70
+ throw new Error(`Transaction ${txHash.toString()} was ${receipt.status}. Reason: ${receipt.error ?? 'unknown'}`);
71
+ }
72
+ if (!receipt.hasExecutionSucceeded() && !opts?.dontThrowOnRevert) {
73
+ throw new Error(
74
+ `Transaction ${txHash.toString()} reverted: ${receipt.executionResult}. Reason: ${receipt.error ?? 'unknown'}`,
75
+ );
76
+ }
77
+
78
+ return receipt;
79
+ }
80
+
19
81
  export { createAztecNodeClient, type AztecNode } from '@aztec/stdlib/interfaces/client';
@@ -1,20 +1,11 @@
1
1
  import { AccountFeePaymentMethodOptions } from '@aztec/entrypoints/account';
2
- import { EncodedAppEntrypointCalls } from '@aztec/entrypoints/encoding';
3
2
  import { ProtocolContractAddress } from '@aztec/protocol-contracts';
4
- import {
5
- type ContractArtifact,
6
- type FunctionArtifact,
7
- FunctionCall,
8
- FunctionSelector,
9
- encodeArguments,
10
- getFunctionArtifactByName,
11
- } from '@aztec/stdlib/abi';
12
3
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
13
4
  import type { GasSettings } from '@aztec/stdlib/gas';
14
5
  import { ExecutionPayload } from '@aztec/stdlib/tx';
15
6
 
7
+ import type { Account } from '../account/account.js';
16
8
  import type { FeePaymentMethod } from '../fee/fee_payment_method.js';
17
- import type { Wallet } from './index.js';
18
9
 
19
10
  /**
20
11
  * Fee payment method that allows an account contract to pay for its own deployment
@@ -33,11 +24,9 @@ import type { Wallet } from './index.js';
33
24
  */
34
25
  export class AccountEntrypointMetaPaymentMethod implements FeePaymentMethod {
35
26
  constructor(
36
- private wallet: Wallet,
37
- private artifact: ContractArtifact,
38
- private feePaymentNameOrArtifact: string | FunctionArtifact,
39
- private accountAddress: AztecAddress,
27
+ private account: Account,
40
28
  private paymentMethod?: FeePaymentMethod,
29
+ private feeEntrypointOptions?: any,
41
30
  ) {}
42
31
 
43
32
  getAsset(): Promise<AztecAddress> {
@@ -45,59 +34,38 @@ export class AccountEntrypointMetaPaymentMethod implements FeePaymentMethod {
45
34
  }
46
35
 
47
36
  async getExecutionPayload(): Promise<ExecutionPayload> {
48
- // Get the execution payload for the fee, it includes the calls and potentially authWitnesses
49
- // It can be empty because the account might attempt to pay for the tx fee using its own
50
- // FeeJuice balance
51
- const { calls: feeCalls, authWitnesses: feeAuthwitnesses } =
52
- (await this.paymentMethod?.getExecutionPayload()) ?? ExecutionPayload.empty();
53
- // Encode the calls for the fee
54
- const feePayer = (await this.paymentMethod?.getFeePayer()) ?? this.accountAddress;
55
- const isFeePayer = feePayer.equals(this.accountAddress);
56
- let accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.EXTERNAL;
57
- if (isFeePayer) {
58
- // If the account is the fee payer, and the incoming fee payload has calls
59
- // it can only be FeeJuicePaymentMethodWithClaim
60
- // If the payload has no calls, it's paying using
61
- // its own fee juice balance
62
- accountFeePaymentMethodOptions =
63
- feeCalls.length === 0
64
- ? AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE
65
- : AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM;
66
- }
67
- const feeEncodedCalls = await EncodedAppEntrypointCalls.create(feeCalls);
37
+ // Get the execution payload for the fee
38
+ const innerPayload = (await this.paymentMethod?.getExecutionPayload()) ?? ExecutionPayload.empty();
68
39
 
69
- // Get the entrypoint args
70
- const args = [feeEncodedCalls, accountFeePaymentMethodOptions, false];
71
- const feePaymentArtifact =
72
- typeof this.feePaymentNameOrArtifact === 'string'
73
- ? getFunctionArtifactByName(this.artifact, this.feePaymentNameOrArtifact)
74
- : this.feePaymentNameOrArtifact;
40
+ // If no fee entrypoint options were provided, compute them based on the wrapped payment method
41
+ // This mimics how the actual account contract works when invoked directly:
42
+ // - If we are the fee payer, are there calls in the inner payload? In that case, those calls can
43
+ // only be claiming fee juice, so we use FEE_JUICE_WITH_CLAIM
44
+ // - If we are the fee payer, but there are no calls, then we assume the account already has
45
+ // fee juice and can pay directly with PREEXISTING_FEE_JUICE
46
+ // - If we are not the fee payer, then EXTERNAL is used
47
+ let options = this.feeEntrypointOptions;
48
+ if (!options) {
49
+ const feePayer = (await this.paymentMethod?.getFeePayer()) ?? this.account.getAddress();
50
+ const isFeePayer = feePayer.equals(this.account.getAddress());
75
51
 
76
- const entrypointCall = new FunctionCall(
77
- feePaymentArtifact.name,
78
- this.accountAddress,
79
- await FunctionSelector.fromNameAndParameters(feePaymentArtifact.name, feePaymentArtifact.parameters),
80
- feePaymentArtifact.functionType,
81
- false /** hideMsgSender -- set to `false`, because it's not applicable for an entrypoint function (only for enqueued public calls) */,
82
- feePaymentArtifact.isStatic,
83
- encodeArguments(feePaymentArtifact, args),
84
- feePaymentArtifact.returnTypes,
85
- );
52
+ let accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.EXTERNAL;
53
+ if (isFeePayer) {
54
+ accountFeePaymentMethodOptions =
55
+ innerPayload.calls.length === 0
56
+ ? AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE
57
+ : AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM;
58
+ }
86
59
 
87
- // Compute the authwitness required to verify the combined payload
88
- const payloadAuthWitness = await this.wallet.createAuthWit(this.accountAddress, await feeEncodedCalls.hash());
60
+ options = { feePaymentMethodOptions: accountFeePaymentMethodOptions };
61
+ }
89
62
 
90
- return new ExecutionPayload(
91
- [entrypointCall],
92
- [payloadAuthWitness, ...feeAuthwitnesses],
93
- [],
94
- feeEncodedCalls.hashedArguments,
95
- feePayer,
96
- );
63
+ // Use the generic wrapping mechanism from the account interface
64
+ return this.account.wrapExecutionPayload(innerPayload, options);
97
65
  }
98
66
 
99
67
  getFeePayer(): Promise<AztecAddress> {
100
- return this.paymentMethod?.getFeePayer() ?? Promise.resolve(this.accountAddress);
68
+ return this.paymentMethod?.getFeePayer() ?? Promise.resolve(this.account.getAddress());
101
69
  }
102
70
 
103
71
  getGasSettings(): GasSettings | undefined {
@@ -9,7 +9,6 @@ import { deriveKeys } from '@aztec/stdlib/keys';
9
9
  import type { AccountContract } from '../account/account_contract.js';
10
10
  import { AccountWithSecretKey } from '../account/account_with_secret_key.js';
11
11
  import type { Salt } from '../account/index.js';
12
- import type { AccountInterface } from '../account/interface.js';
13
12
  import { Contract } from '../contract/contract.js';
14
13
  import { DeployAccountMethod } from './deploy_account_method.js';
15
14
  import type { Wallet } from './wallet.js';
@@ -58,16 +57,6 @@ export class AccountManager {
58
57
  return this.getPublicKeys().hash();
59
58
  }
60
59
 
61
- /**
62
- * Returns the entrypoint for this account as defined by its account contract.
63
- * @returns An entrypoint.
64
- */
65
- public async getAccountInterface(): Promise<AccountInterface> {
66
- const chainInfo = await this.wallet.getChainInfo();
67
- const completeAddress = await this.getCompleteAddress();
68
- return this.accountContract.getInterface(completeAddress, chainInfo);
69
- }
70
-
71
60
  /**
72
61
  * Gets the calculated complete address associated with this account.
73
62
  * Does not require the account to have been published for public execution.
@@ -103,8 +92,9 @@ export class AccountManager {
103
92
  * @returns A Wallet instance.
104
93
  */
105
94
  public async getAccount(): Promise<AccountWithSecretKey> {
106
- const accountInterface = await this.getAccountInterface();
107
- return new AccountWithSecretKey(accountInterface, this.secretKey, this.salt);
95
+ const completeAddress = await this.getCompleteAddress();
96
+ const account = this.accountContract.getAccount(completeAddress);
97
+ return new AccountWithSecretKey(account, this.secretKey, this.salt);
108
98
  }
109
99
 
110
100
  /**
@@ -134,12 +124,14 @@ export class AccountManager {
134
124
  constructorArgs: undefined,
135
125
  };
136
126
 
127
+ const account = await this.getAccount();
137
128
  return new DeployAccountMethod(
138
129
  this.getPublicKeys(),
139
130
  this.wallet,
140
131
  artifact,
141
132
  instance => Contract.at(instance.address, artifact, this.wallet),
142
133
  new Fr(this.salt),
134
+ account,
143
135
  constructorArgs,
144
136
  constructorName,
145
137
  );