@aztec/cli-wallet 0.0.1-commit.3f296a7d2 → 0.0.1-commit.42ee6df9b

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 (39) hide show
  1. package/dest/cmds/check_tx.js +2 -1
  2. package/dest/cmds/create_account.d.ts +4 -3
  3. package/dest/cmds/create_account.d.ts.map +1 -1
  4. package/dest/cmds/create_account.js +22 -19
  5. package/dest/cmds/deploy.d.ts +4 -3
  6. package/dest/cmds/deploy.d.ts.map +1 -1
  7. package/dest/cmds/deploy.js +22 -21
  8. package/dest/cmds/deploy_account.d.ts +4 -3
  9. package/dest/cmds/deploy_account.d.ts.map +1 -1
  10. package/dest/cmds/deploy_account.js +17 -14
  11. package/dest/cmds/get_fee_juice_balance.d.ts +5 -0
  12. package/dest/cmds/get_fee_juice_balance.d.ts.map +1 -0
  13. package/dest/cmds/get_fee_juice_balance.js +27 -0
  14. package/dest/cmds/index.d.ts +1 -1
  15. package/dest/cmds/index.d.ts.map +1 -1
  16. package/dest/cmds/index.js +30 -14
  17. package/dest/cmds/send.d.ts +4 -3
  18. package/dest/cmds/send.d.ts.map +1 -1
  19. package/dest/cmds/send.js +23 -22
  20. package/dest/storage/wallet_db.d.ts +6 -1
  21. package/dest/storage/wallet_db.d.ts.map +1 -1
  22. package/dest/storage/wallet_db.js +14 -0
  23. package/dest/utils/options/fees.d.ts +2 -2
  24. package/dest/utils/options/fees.d.ts.map +1 -1
  25. package/dest/utils/options/fees.js +6 -5
  26. package/dest/utils/wallet.d.ts +1 -1
  27. package/dest/utils/wallet.d.ts.map +1 -1
  28. package/dest/utils/wallet.js +7 -4
  29. package/package.json +14 -14
  30. package/src/cmds/check_tx.ts +3 -2
  31. package/src/cmds/create_account.ts +23 -15
  32. package/src/cmds/deploy.ts +19 -14
  33. package/src/cmds/deploy_account.ts +17 -10
  34. package/src/cmds/get_fee_juice_balance.ts +37 -0
  35. package/src/cmds/index.ts +56 -3
  36. package/src/cmds/send.ts +20 -15
  37. package/src/storage/wallet_db.ts +14 -0
  38. package/src/utils/options/fees.ts +7 -5
  39. package/src/utils/wallet.ts +6 -1
package/src/cmds/index.ts CHANGED
@@ -12,6 +12,7 @@ import {
12
12
  } from '@aztec/cli/utils';
13
13
  import { randomBytes } from '@aztec/foundation/crypto/random';
14
14
  import type { LogFn, Logger } from '@aztec/foundation/log';
15
+ import { TxStatus } from '@aztec/stdlib/tx';
15
16
 
16
17
  import { type Command, Option } from 'commander';
17
18
  import inquirer from 'inquirer';
@@ -40,6 +41,17 @@ import {
40
41
  integerArgParser,
41
42
  } from '../utils/options/index.js';
42
43
 
44
+ function parseWaitForStatus(status: string): TxStatus {
45
+ switch (status) {
46
+ case 'proposed':
47
+ return TxStatus.PROPOSED;
48
+ case 'checkpointed':
49
+ return TxStatus.CHECKPOINTED;
50
+ default:
51
+ throw new Error(`Invalid wait-for-status: ${status}. Use 'proposed' or 'checkpointed'.`);
52
+ }
53
+ }
54
+
43
55
  // TODO: This function is only used in 1 place so we could just inline this
44
56
  export function injectCommands(
45
57
  program: Command,
@@ -90,6 +102,11 @@ export function injectCommands(
90
102
  )
91
103
  .addOption(createAliasOption('Alias for the account. Used for easy reference in subsequent commands.', !db))
92
104
  .addOption(createTypeOption(true))
105
+ .option(
106
+ '-s, --salt <hex string>',
107
+ 'Optional deployment salt as a hex string for generating the deployment address. Defaults to 0.',
108
+ parseFieldFromHexString,
109
+ )
93
110
  .option(
94
111
  '--register-only',
95
112
  'Just register the account on the Wallet. Do not deploy or initialize the account contract.',
@@ -98,6 +115,7 @@ export function injectCommands(
98
115
  // `options.wait` is default true. Passing `--no-wait` will set it to false.
99
116
  // https://github.com/tj/commander.js#other-option-types-negatable-boolean-and-booleanvalue
100
117
  .option('--no-wait', 'Skip waiting for the contract to be deployed. Print the hash of deployment transaction')
118
+ .option('--wait-for-status <status>', "Tx status to wait for: 'proposed' or 'checkpointed'", 'proposed')
101
119
  .addOption(createVerboseOption());
102
120
 
103
121
  addOptions(createAccountCommand, CLIFeeArgs.getOptions()).action(async (_options, command) => {
@@ -107,7 +125,9 @@ export function injectCommands(
107
125
  type,
108
126
  from: parsedFromAddress,
109
127
  secretKey,
128
+ salt,
110
129
  wait,
130
+ waitForStatus: waitForStatusStr,
111
131
  registerOnly,
112
132
  skipInitialization,
113
133
  publicDeploy,
@@ -137,6 +157,7 @@ export function injectCommands(
137
157
  node,
138
158
  type,
139
159
  secretKey,
160
+ salt,
140
161
  publicKey,
141
162
  alias,
142
163
  parsedFromAddress,
@@ -146,6 +167,7 @@ export function injectCommands(
146
167
  registerClass,
147
168
  wait,
148
169
  CLIFeeArgs.parse(options, log, db),
170
+ parseWaitForStatus(waitForStatusStr),
149
171
  json,
150
172
  verbose,
151
173
  debugLogger,
@@ -180,12 +202,22 @@ export function injectCommands(
180
202
  '--skip-initialization',
181
203
  'Skip initializing the account contract. Useful for publicly deploying an existing account.',
182
204
  )
205
+ .option('--wait-for-status <status>', "Tx status to wait for: 'proposed' or 'checkpointed'", 'proposed')
183
206
  .addOption(createVerboseOption());
184
207
 
185
208
  addOptions(deployAccountCommand, CLIFeeArgs.getOptions()).action(async (parsedAccount, _options, command) => {
186
209
  const { deployAccount } = await import('./deploy_account.js');
187
210
  const options = command.optsWithGlobals();
188
- const { wait, from: parsedFromAddress, json, registerClass, skipInitialization, publicDeploy, verbose } = options;
211
+ const {
212
+ wait,
213
+ waitForStatus: waitForStatusStr,
214
+ from: parsedFromAddress,
215
+ json,
216
+ registerClass,
217
+ skipInitialization,
218
+ publicDeploy,
219
+ verbose,
220
+ } = options;
189
221
 
190
222
  const { wallet, node } = walletAndNodeWrapper;
191
223
 
@@ -199,6 +231,7 @@ export function injectCommands(
199
231
  publicDeploy,
200
232
  skipInitialization,
201
233
  CLIFeeArgs.parse(options, log, db),
234
+ parseWaitForStatus(waitForStatusStr),
202
235
  json,
203
236
  verbose,
204
237
  debugLogger,
@@ -219,7 +252,7 @@ export function injectCommands(
219
252
  )
220
253
  .option(
221
254
  '-s, --salt <hex string>',
222
- 'Optional deployment salt as a hex string for generating the deployment address.',
255
+ 'Optional deployment salt as a hex string for generating the deployment address. Defaults to random.',
223
256
  parseFieldFromHexString,
224
257
  )
225
258
  .option('--universal', 'Do not mix the sender address into the deployment.')
@@ -238,6 +271,7 @@ export function injectCommands(
238
271
  'The amount of time in seconds to wait for the deployment to post to L2',
239
272
  ).conflicts('wait'),
240
273
  )
274
+ .option('--wait-for-status <status>', "Tx status to wait for: 'proposed' or 'checkpointed'", 'proposed')
241
275
  .addOption(createVerboseOption());
242
276
 
243
277
  addOptions(deployCommand, CLIFeeArgs.getOptions()).action(async (artifactPathPromise, _options, command) => {
@@ -249,6 +283,7 @@ export function injectCommands(
249
283
  args,
250
284
  salt,
251
285
  wait,
286
+ waitForStatus: waitForStatusStr,
252
287
  classRegistration,
253
288
  init,
254
289
  publicDeployment,
@@ -279,8 +314,9 @@ export function injectCommands(
279
314
  typeof init === 'string' ? false : init,
280
315
  wait,
281
316
  CLIFeeArgs.parse(options, log, db),
282
- timeout,
317
+ parseWaitForStatus(waitForStatusStr),
283
318
  verbose,
319
+ timeout,
284
320
  debugLogger,
285
321
  log,
286
322
  );
@@ -308,6 +344,7 @@ export function injectCommands(
308
344
  )
309
345
  .addOption(createAccountOption('Alias or address of the account to send the transaction from', !db, db))
310
346
  .option('--no-wait', 'Print transaction hash without waiting for it to be mined')
347
+ .option('--wait-for-status <status>', "Tx status to wait for: 'proposed' or 'checkpointed'", 'proposed')
311
348
  .addOption(createVerboseOption());
312
349
 
313
350
  addOptions(sendCommand, CLIFeeArgs.getOptions()).action(async (functionName, _options, command) => {
@@ -319,6 +356,7 @@ export function injectCommands(
319
356
  contractAddress,
320
357
  from: parsedFromAddress,
321
358
  wait,
359
+ waitForStatus: waitForStatusStr,
322
360
  alias,
323
361
  authWitness: authWitnessArray,
324
362
  verbose,
@@ -342,6 +380,7 @@ export function injectCommands(
342
380
  alias,
343
381
  CLIFeeArgs.parse(options, log, db),
344
382
  authWitnesses,
383
+ parseWaitForStatus(waitForStatusStr),
345
384
  verbose,
346
385
  log,
347
386
  );
@@ -492,6 +531,20 @@ export function injectCommands(
492
531
  }
493
532
  });
494
533
 
534
+ program
535
+ .command('get-fee-juice-balance')
536
+ .description('Checks the Fee Juice balance for a given address.')
537
+ .argument('<address>', 'Aztec address or alias to check balance for', address =>
538
+ aliasedAddressParser('accounts', address, db),
539
+ )
540
+ .option('--json', 'Emit output as json')
541
+ .option('--exact', 'Show exact balance with all 18 decimal places')
542
+ .action(async (address, options) => {
543
+ const { getFeeJuiceBalanceCmd } = await import('./get_fee_juice_balance.js');
544
+ const { json, exact } = options;
545
+ await getFeeJuiceBalanceCmd(walletAndNodeWrapper.node, address, json, exact, log);
546
+ });
547
+
495
548
  program
496
549
  .command('create-authwit')
497
550
  .description(
package/src/cmds/send.ts CHANGED
@@ -1,9 +1,10 @@
1
1
  import type { AztecAddress } from '@aztec/aztec.js/addresses';
2
2
  import { AuthWitness } from '@aztec/aztec.js/authorization';
3
3
  import { Contract, NO_WAIT, type SendInteractionOptions } from '@aztec/aztec.js/contracts';
4
- import type { AztecNode } from '@aztec/aztec.js/node';
4
+ import { type AztecNode, waitForTx } from '@aztec/aztec.js/node';
5
5
  import { prepTx } from '@aztec/cli/utils';
6
6
  import type { LogFn } from '@aztec/foundation/log';
7
+ import { TxStatus } from '@aztec/stdlib/tx';
7
8
 
8
9
  import { DEFAULT_TX_TIMEOUT_S } from '../utils/cli_wallet_and_node_wrapper.js';
9
10
  import { CLIFeeArgs } from '../utils/options/fees.js';
@@ -22,6 +23,7 @@ export async function send(
22
23
  cancellable: boolean,
23
24
  feeOpts: CLIFeeArgs,
24
25
  authWitnesses: AuthWitness[],
26
+ waitForStatus: TxStatus,
25
27
  verbose: boolean,
26
28
  log: LogFn,
27
29
  ) {
@@ -37,6 +39,7 @@ export async function send(
37
39
  authWitnesses,
38
40
  };
39
41
 
42
+ const localStart = performance.now();
40
43
  const sim = await call.simulate({
41
44
  ...sendOptions,
42
45
  fee: { ...sendOptions.fee, estimateGas: true },
@@ -53,21 +56,29 @@ export async function send(
53
56
  printProfileResult(stats!, log);
54
57
  }
55
58
 
59
+ const { txHash } = await call.send({
60
+ ...sendOptions,
61
+ fee: { ...sendOptions.fee, gasSettings: estimatedGas },
62
+ wait: NO_WAIT,
63
+ });
64
+ const localTimeMs = performance.now() - localStart;
65
+
66
+ log(`\nTransaction hash: ${txHash.toString()}`);
67
+
56
68
  if (wait) {
57
69
  try {
58
- const { receipt } = await call.send({
59
- ...sendOptions,
60
- fee: { ...sendOptions.fee, gasSettings: estimatedGas },
61
- wait: { timeout: DEFAULT_TX_TIMEOUT_S },
62
- });
70
+ const nodeStart = performance.now();
71
+ const receipt = await waitForTx(node, txHash, { timeout: DEFAULT_TX_TIMEOUT_S, waitForStatus });
72
+ const nodeTimeMs = performance.now() - nodeStart;
63
73
 
64
- const txHash = receipt.txHash;
65
- log(`\nTransaction hash: ${txHash.toString()}`);
66
- log('Transaction has been mined');
74
+ const statusLabel = waitForStatus === TxStatus.PROPOSED ? 'proposed' : 'checkpointed';
75
+ log(`Transaction has been ${statusLabel}`);
67
76
  log(` Tx fee: ${receipt.transactionFee}`);
68
77
  log(` Status: ${receipt.status}`);
69
78
  log(` Block number: ${receipt.blockNumber}`);
70
79
  log(` Block hash: ${receipt.blockHash?.toString()}`);
80
+ log(` Local processing time: ${(localTimeMs / 1000).toFixed(1)}s`);
81
+ log(` Node inclusion time: ${(nodeTimeMs / 1000).toFixed(1)}s`);
71
82
 
72
83
  return {
73
84
  txHash,
@@ -77,12 +88,6 @@ export async function send(
77
88
  throw err;
78
89
  }
79
90
  } else {
80
- const { txHash } = await call.send({
81
- ...sendOptions,
82
- fee: { ...sendOptions.fee, gasSettings: estimatedGas },
83
- wait: NO_WAIT,
84
- });
85
- log(`\nTransaction hash: ${txHash.toString()}`);
86
91
  log('Transaction pending. Check status with check-tx');
87
92
  return {
88
93
  txHash,
@@ -70,6 +70,20 @@ export class WalletDB {
70
70
  return { amount: BigInt(amountStr), secret: secretStr, leafIndex: BigInt(leafIndexStr) };
71
71
  }
72
72
 
73
+ async peekBridgedFeeJuice(recipient: AztecAddress, log: LogFn) {
74
+ const stackPointer =
75
+ (await this.#bridgedFeeJuice.getAsync(`${recipient.toString()}:stackPointer`))?.readInt8() || 0;
76
+ const result = await this.#bridgedFeeJuice.getAsync(`${recipient.toString()}:${stackPointer}`);
77
+ if (!result) {
78
+ throw new Error(
79
+ `No stored fee juice available for recipient ${recipient.toString()}. Please provide claim amount and secret. Stack pointer ${stackPointer}`,
80
+ );
81
+ }
82
+ const [amountStr, secretStr, leafIndexStr] = result.toString().split(':');
83
+ log(`Peeked ${amountStr} fee juice for recipient ${recipient.toString()}. Stack pointer ${stackPointer}`);
84
+ return { amount: BigInt(amountStr), secret: secretStr, leafIndex: BigInt(leafIndexStr) };
85
+ }
86
+
73
87
  async storeAccount(
74
88
  address: AztecAddress,
75
89
  {
@@ -115,6 +115,7 @@ export function parsePaymentMethod(
115
115
  payment: string,
116
116
  log: LogFn,
117
117
  db?: WalletDB,
118
+ estimateOnly?: boolean,
118
119
  ): (wallet: Wallet, from: AztecAddress, gasSettings: GasSettings) => Promise<FeePaymentMethod | undefined> {
119
120
  const parsed = payment.split(',').reduce(
120
121
  (acc, item) => {
@@ -149,7 +150,7 @@ export function parsePaymentMethod(
149
150
  amount: claimAmount,
150
151
  secret: claimSecret,
151
152
  leafIndex: messageLeafIndex,
152
- } = await db.popBridgedFeeJuice(from, log));
153
+ } = estimateOnly ? await db.peekBridgedFeeJuice(from, log) : await db.popBridgedFeeJuice(from, log));
153
154
  } else {
154
155
  ({ claimAmount, claimSecret, messageLeafIndex } = parsed);
155
156
  }
@@ -157,10 +158,10 @@ export function parsePaymentMethod(
157
158
  const { FeeJuicePaymentMethodWithClaim } = await import('@aztec/aztec.js/fee');
158
159
  return new FeeJuicePaymentMethodWithClaim(from, {
159
160
  claimAmount: (typeof claimAmount === 'string'
160
- ? Fr.fromHexString(claimAmount)
161
+ ? Fr.fromString(claimAmount)
161
162
  : new Fr(claimAmount)
162
163
  ).toBigInt(),
163
- claimSecret: Fr.fromHexString(claimSecret),
164
+ claimSecret: typeof claimSecret === 'string' ? Fr.fromString(claimSecret) : claimSecret,
164
165
  messageLeafIndex: BigInt(messageLeafIndex),
165
166
  });
166
167
  } else {
@@ -266,9 +267,10 @@ export class CLIFeeArgs {
266
267
  }
267
268
 
268
269
  static parse(args: RawCliFeeArgs, log: LogFn, db?: WalletDB): CLIFeeArgs {
270
+ const estimateOnly = !!args.estimateGasOnly;
269
271
  return new CLIFeeArgs(
270
- !!args.estimateGasOnly,
271
- parsePaymentMethod(args.payment ?? 'method=fee_juice', log, db),
272
+ estimateOnly,
273
+ parsePaymentMethod(args.payment ?? 'method=fee_juice', log, db, estimateOnly),
272
274
  parseGasSettings(args),
273
275
  );
274
276
  }
@@ -56,7 +56,12 @@ export class CLIWallet extends BaseWallet {
56
56
 
57
57
  override async getAccounts(): Promise<Aliased<AztecAddress>[]> {
58
58
  const accounts = (await this.db?.listAliases('accounts')) ?? [];
59
- return Promise.resolve(accounts.map(({ key, value }) => ({ alias: value, item: AztecAddress.fromString(key) })));
59
+ return Promise.resolve(
60
+ accounts.map(({ key, value }) => {
61
+ const alias = key.includes(':') ? key.slice(key.indexOf(':') + 1) : key;
62
+ return { alias, item: AztecAddress.fromString(value) };
63
+ }),
64
+ );
60
65
  }
61
66
 
62
67
  private async createCancellationTxExecutionRequest(