@aztec/pxe 0.0.1-commit.6d63667d → 0.0.1-commit.733c4a3

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 (130) hide show
  1. package/dest/access_scopes.d.ts +9 -0
  2. package/dest/access_scopes.d.ts.map +1 -0
  3. package/dest/access_scopes.js +6 -0
  4. package/dest/config/package_info.js +1 -1
  5. package/dest/contract_function_simulator/contract_function_simulator.d.ts +53 -29
  6. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  7. package/dest/contract_function_simulator/contract_function_simulator.js +173 -69
  8. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +1 -1
  9. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +2 -2
  10. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  11. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +1 -1
  12. package/dest/contract_function_simulator/oracle/interfaces.d.ts +2 -2
  13. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  14. package/dest/contract_function_simulator/oracle/oracle.d.ts +2 -2
  15. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  16. package/dest/contract_function_simulator/oracle/oracle.js +3 -3
  17. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +35 -36
  18. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  19. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +63 -18
  20. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +31 -11
  21. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +53 -35
  23. package/dest/contract_logging.d.ts +22 -0
  24. package/dest/contract_logging.d.ts.map +1 -0
  25. package/dest/contract_logging.js +23 -0
  26. package/dest/contract_sync/contract_sync_service.d.ts +4 -2
  27. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -1
  28. package/dest/contract_sync/contract_sync_service.js +34 -19
  29. package/dest/contract_sync/helpers.d.ts +3 -2
  30. package/dest/contract_sync/helpers.d.ts.map +1 -1
  31. package/dest/contract_sync/helpers.js +3 -3
  32. package/dest/debug/pxe_debug_utils.d.ts +6 -7
  33. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  34. package/dest/debug/pxe_debug_utils.js +4 -7
  35. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  36. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  37. package/dest/entrypoints/client/bundle/index.js +3 -0
  38. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  39. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  40. package/dest/entrypoints/client/bundle/utils.js +9 -1
  41. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  42. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  43. package/dest/entrypoints/client/lazy/index.js +3 -0
  44. package/dest/entrypoints/client/lazy/utils.d.ts +1 -1
  45. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  46. package/dest/entrypoints/client/lazy/utils.js +9 -1
  47. package/dest/entrypoints/server/index.d.ts +3 -1
  48. package/dest/entrypoints/server/index.d.ts.map +1 -1
  49. package/dest/entrypoints/server/index.js +2 -0
  50. package/dest/entrypoints/server/utils.js +9 -1
  51. package/dest/logs/log_service.d.ts +3 -2
  52. package/dest/logs/log_service.d.ts.map +1 -1
  53. package/dest/logs/log_service.js +5 -10
  54. package/dest/notes/note_service.d.ts +4 -3
  55. package/dest/notes/note_service.d.ts.map +1 -1
  56. package/dest/notes/note_service.js +3 -2
  57. package/dest/notes_filter.d.ts +25 -0
  58. package/dest/notes_filter.d.ts.map +1 -0
  59. package/dest/notes_filter.js +4 -0
  60. package/dest/oracle_version.d.ts +2 -2
  61. package/dest/oracle_version.js +2 -2
  62. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  63. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  64. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  65. package/dest/private_kernel/hints/index.d.ts +1 -1
  66. package/dest/private_kernel/hints/index.js +1 -1
  67. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  68. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  69. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  70. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  71. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  72. package/dest/private_kernel/hints/test_utils.js +203 -0
  73. package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
  74. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  75. package/dest/private_kernel/private_kernel_execution_prover.js +19 -11
  76. package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
  77. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  78. package/dest/private_kernel/private_kernel_oracle.js +7 -3
  79. package/dest/pxe.d.ts +68 -23
  80. package/dest/pxe.d.ts.map +1 -1
  81. package/dest/pxe.js +74 -53
  82. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  83. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  84. package/dest/storage/contract_store/contract_store.js +145 -69
  85. package/dest/storage/note_store/note_store.d.ts +3 -3
  86. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  87. package/dest/storage/note_store/note_store.js +6 -4
  88. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  89. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  90. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  91. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +4 -4
  92. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  93. package/package.json +16 -16
  94. package/src/access_scopes.ts +9 -0
  95. package/src/config/package_info.ts +1 -1
  96. package/src/contract_function_simulator/contract_function_simulator.ts +322 -130
  97. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +1 -1
  98. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +1 -1
  99. package/src/contract_function_simulator/oracle/interfaces.ts +1 -1
  100. package/src/contract_function_simulator/oracle/oracle.ts +3 -3
  101. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +83 -93
  102. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +98 -33
  103. package/src/contract_logging.ts +39 -0
  104. package/src/contract_sync/contract_sync_service.ts +49 -26
  105. package/src/contract_sync/helpers.ts +7 -2
  106. package/src/debug/pxe_debug_utils.ts +12 -15
  107. package/src/entrypoints/client/bundle/index.ts +3 -0
  108. package/src/entrypoints/client/bundle/utils.ts +9 -1
  109. package/src/entrypoints/client/lazy/index.ts +3 -0
  110. package/src/entrypoints/client/lazy/utils.ts +9 -1
  111. package/src/entrypoints/server/index.ts +2 -0
  112. package/src/entrypoints/server/utils.ts +7 -7
  113. package/src/logs/log_service.ts +7 -19
  114. package/src/notes/note_service.ts +4 -3
  115. package/src/notes_filter.ts +26 -0
  116. package/src/oracle_version.ts +2 -2
  117. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  118. package/src/private_kernel/hints/index.ts +1 -1
  119. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  120. package/src/private_kernel/hints/test_utils.ts +325 -0
  121. package/src/private_kernel/private_kernel_execution_prover.ts +19 -12
  122. package/src/private_kernel/private_kernel_oracle.ts +7 -7
  123. package/src/pxe.ts +145 -98
  124. package/src/storage/contract_store/contract_store.ts +174 -75
  125. package/src/storage/note_store/note_store.ts +12 -5
  126. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  127. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +4 -4
  128. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  129. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  130. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
@@ -5,7 +5,7 @@ import { AztecAddress } from '@aztec/stdlib/aztec-address';
5
5
  import { TxHash } from '@aztec/stdlib/tx';
6
6
 
7
7
  // TODO(#14617): should we compute this from constants? This value is aztec-nr specific.
8
- const MAX_EVENT_SERIALIZED_LEN = 12;
8
+ const MAX_EVENT_SERIALIZED_LEN = 11;
9
9
 
10
10
  /**
11
11
  * Intermediate struct used to perform batch event validation by PXE. The `utilityValidateAndStoreEnqueuedNotesAndEvents` oracle
@@ -4,7 +4,7 @@ import { AztecAddress } from '@aztec/stdlib/aztec-address';
4
4
  import { TxHash } from '@aztec/stdlib/tx';
5
5
 
6
6
  // TODO(#14617): should we compute this from constants? This value is aztec-nr specific.
7
- export const MAX_NOTE_PACKED_LEN = 10;
7
+ export const MAX_NOTE_PACKED_LEN = 9;
8
8
 
9
9
  /**
10
10
  * Intermediate struct used to perform batch note validation by PXE. The `utilityValidateAndStoreEnqueuedNotesAndEvents` oracle
@@ -54,7 +54,7 @@ export interface IMiscOracle {
54
54
 
55
55
  utilityGetRandomField(): Fr;
56
56
  utilityAssertCompatibleOracleVersion(version: number): void;
57
- utilityDebugLog(level: number, message: string, fields: Fr[]): void;
57
+ utilityLog(level: number, message: string, fields: Fr[]): Promise<void>;
58
58
  }
59
59
 
60
60
  /**
@@ -417,7 +417,7 @@ export class Oracle {
417
417
  return Promise.resolve([]);
418
418
  }
419
419
 
420
- utilityDebugLog(
420
+ async utilityLog(
421
421
  level: ACVMField[],
422
422
  message: ACVMField[],
423
423
  _ignoredFieldsSize: ACVMField[],
@@ -426,8 +426,8 @@ export class Oracle {
426
426
  const levelFr = Fr.fromString(level[0]);
427
427
  const messageStr = message.map(acvmField => String.fromCharCode(Fr.fromString(acvmField).toNumber())).join('');
428
428
  const fieldsFr = fields.map(Fr.fromString);
429
- this.handlerAsMisc().utilityDebugLog(levelFr.toNumber(), messageStr, fieldsFr);
430
- return Promise.resolve([]);
429
+ await this.handlerAsMisc().utilityLog(levelFr.toNumber(), messageStr, fieldsFr);
430
+ return [];
431
431
  }
432
432
 
433
433
  // This function's name is directly hardcoded in `circuit_recorder.ts`. Don't forget to update it there if you
@@ -2,7 +2,6 @@ import { MAX_FR_CALLDATA_TO_ALL_ENQUEUED_CALLS, PRIVATE_CONTEXT_INPUTS_LENGTH }
2
2
  import { Fr } from '@aztec/foundation/curves/bn254';
3
3
  import { createLogger } from '@aztec/foundation/log';
4
4
  import { Timer } from '@aztec/foundation/timer';
5
- import type { KeyStore } from '@aztec/key-store';
6
5
  import { type CircuitSimulator, toACVMWitness } from '@aztec/simulator/client';
7
6
  import {
8
7
  type FunctionAbi,
@@ -12,33 +11,23 @@ import {
12
11
  type NoteSelector,
13
12
  countArgumentsSize,
14
13
  } from '@aztec/stdlib/abi';
15
- import type { AuthWitness } from '@aztec/stdlib/auth-witness';
16
14
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
17
15
  import { siloNullifier } from '@aztec/stdlib/hash';
18
- import type { AztecNode } from '@aztec/stdlib/interfaces/client';
19
16
  import { PrivateContextInputs } from '@aztec/stdlib/kernel';
20
17
  import { type ContractClassLog, DirectionalAppTaggingSecret, type PreTag } from '@aztec/stdlib/logs';
21
18
  import { Tag } from '@aztec/stdlib/logs';
22
19
  import { Note, type NoteStatus } from '@aztec/stdlib/note';
23
20
  import {
24
- type BlockHeader,
25
21
  CallContext,
26
- Capsule,
27
22
  CountedContractClassLog,
28
23
  NoteAndSlot,
29
24
  PrivateCallExecutionResult,
30
25
  type TxContext,
31
26
  } from '@aztec/stdlib/tx';
32
27
 
28
+ import type { AccessScopes } from '../../access_scopes.js';
33
29
  import type { ContractSyncService } from '../../contract_sync/contract_sync_service.js';
34
30
  import { NoteService } from '../../notes/note_service.js';
35
- import type { AddressStore } from '../../storage/address_store/address_store.js';
36
- import type { CapsuleStore } from '../../storage/capsule_store/capsule_store.js';
37
- import type { ContractStore } from '../../storage/contract_store/contract_store.js';
38
- import type { NoteStore } from '../../storage/note_store/note_store.js';
39
- import type { PrivateEventStore } from '../../storage/private_event_store/private_event_store.js';
40
- import type { RecipientTaggingStore } from '../../storage/tagging_store/recipient_tagging_store.js';
41
- import type { SenderAddressBookStore } from '../../storage/tagging_store/sender_address_book_store.js';
42
31
  import type { SenderTaggingStore } from '../../storage/tagging_store/sender_tagging_store.js';
43
32
  import { syncSenderTaggingIndexes } from '../../tagging/index.js';
44
33
  import type { ExecutionNoteCache } from '../execution_note_cache.js';
@@ -47,7 +36,25 @@ import type { HashedValuesCache } from '../hashed_values_cache.js';
47
36
  import { pickNotes } from '../pick_notes.js';
48
37
  import type { IPrivateExecutionOracle, NoteData } from './interfaces.js';
49
38
  import { executePrivateFunction } from './private_execution.js';
50
- import { UtilityExecutionOracle } from './utility_execution_oracle.js';
39
+ import { UtilityExecutionOracle, type UtilityExecutionOracleArgs } from './utility_execution_oracle.js';
40
+
41
+ /** Args for PrivateExecutionOracle constructor. */
42
+ export type PrivateExecutionOracleArgs = Omit<UtilityExecutionOracleArgs, 'contractAddress'> & {
43
+ argsHash: Fr;
44
+ txContext: TxContext;
45
+ callContext: CallContext;
46
+ /** Needed to trigger contract synchronization before nested calls */
47
+ utilityExecutor: (call: FunctionCall, scopes: AccessScopes) => Promise<void>;
48
+ executionCache: HashedValuesCache;
49
+ noteCache: ExecutionNoteCache;
50
+ taggingIndexCache: ExecutionTaggingIndexCache;
51
+ senderTaggingStore: SenderTaggingStore;
52
+ contractSyncService: ContractSyncService;
53
+ totalPublicCalldataCount?: number;
54
+ sideEffectCounter?: number;
55
+ senderForTags?: AztecAddress;
56
+ simulator?: CircuitSimulator;
57
+ };
51
58
 
52
59
  /**
53
60
  * The execution oracle for the private part of a transaction.
@@ -69,57 +76,39 @@ export class PrivateExecutionOracle extends UtilityExecutionOracle implements IP
69
76
  private offchainEffects: { data: Fr[] }[] = [];
70
77
  private nestedExecutionResults: PrivateCallExecutionResult[] = [];
71
78
 
72
- constructor(
73
- private readonly argsHash: Fr,
74
- private readonly txContext: TxContext,
75
- private readonly callContext: CallContext,
76
- /** Header of a block whose state is used during private execution (not the block the transaction is included in). */
77
- protected override readonly anchorBlockHeader: BlockHeader,
78
- /** Needed to trigger contract synchronization before nested calls */
79
- private readonly utilityExecutor: (call: FunctionCall) => Promise<void>,
80
- /** List of transient auth witnesses to be used during this simulation */
81
- authWitnesses: AuthWitness[],
82
- capsules: Capsule[],
83
- private readonly executionCache: HashedValuesCache,
84
- private readonly noteCache: ExecutionNoteCache,
85
- private readonly taggingIndexCache: ExecutionTaggingIndexCache,
86
- contractStore: ContractStore,
87
- noteStore: NoteStore,
88
- keyStore: KeyStore,
89
- addressStore: AddressStore,
90
- aztecNode: AztecNode,
91
- private readonly senderTaggingStore: SenderTaggingStore,
92
- recipientTaggingStore: RecipientTaggingStore,
93
- senderAddressBookStore: SenderAddressBookStore,
94
- capsuleStore: CapsuleStore,
95
- privateEventStore: PrivateEventStore,
96
- private readonly contractSyncService: ContractSyncService,
97
- jobId: string,
98
- private totalPublicCalldataCount: number = 0,
99
- protected sideEffectCounter: number = 0,
100
- log = createLogger('simulator:client_execution_context'),
101
- scopes?: AztecAddress[],
102
- private senderForTags?: AztecAddress,
103
- private simulator?: CircuitSimulator,
104
- ) {
105
- super(
106
- callContext.contractAddress,
107
- authWitnesses,
108
- capsules,
109
- anchorBlockHeader,
110
- contractStore,
111
- noteStore,
112
- keyStore,
113
- addressStore,
114
- aztecNode,
115
- recipientTaggingStore,
116
- senderAddressBookStore,
117
- capsuleStore,
118
- privateEventStore,
119
- jobId,
120
- log,
121
- scopes,
122
- );
79
+ private readonly argsHash: Fr;
80
+ private readonly txContext: TxContext;
81
+ private readonly callContext: CallContext;
82
+ private readonly utilityExecutor: (call: FunctionCall, scopes: AccessScopes) => Promise<void>;
83
+ private readonly executionCache: HashedValuesCache;
84
+ private readonly noteCache: ExecutionNoteCache;
85
+ private readonly taggingIndexCache: ExecutionTaggingIndexCache;
86
+ private readonly senderTaggingStore: SenderTaggingStore;
87
+ private readonly contractSyncService: ContractSyncService;
88
+ private totalPublicCalldataCount: number;
89
+ protected sideEffectCounter: number;
90
+ private senderForTags?: AztecAddress;
91
+ private readonly simulator?: CircuitSimulator;
92
+
93
+ constructor(args: PrivateExecutionOracleArgs) {
94
+ super({
95
+ ...args,
96
+ contractAddress: args.callContext.contractAddress,
97
+ log: args.log ?? createLogger('simulator:client_execution_context'),
98
+ });
99
+ this.argsHash = args.argsHash;
100
+ this.txContext = args.txContext;
101
+ this.callContext = args.callContext;
102
+ this.utilityExecutor = args.utilityExecutor;
103
+ this.executionCache = args.executionCache;
104
+ this.noteCache = args.noteCache;
105
+ this.taggingIndexCache = args.taggingIndexCache;
106
+ this.senderTaggingStore = args.senderTaggingStore;
107
+ this.contractSyncService = args.contractSyncService;
108
+ this.totalPublicCalldataCount = args.totalPublicCalldataCount ?? 0;
109
+ this.sideEffectCounter = args.sideEffectCounter ?? 0;
110
+ this.senderForTags = args.senderForTags;
111
+ this.simulator = args.simulator;
123
112
  }
124
113
 
125
114
  public getPrivateContextInputs(): PrivateContextInputs {
@@ -544,6 +533,7 @@ export class PrivateExecutionOracle extends UtilityExecutionOracle implements IP
544
533
  this.utilityExecutor,
545
534
  this.anchorBlockHeader,
546
535
  this.jobId,
536
+ this.scopes,
547
537
  );
548
538
 
549
539
  const targetArtifact = await this.contractStore.getFunctionArtifactWithDebugMetadata(
@@ -555,41 +545,41 @@ export class PrivateExecutionOracle extends UtilityExecutionOracle implements IP
555
545
 
556
546
  const derivedCallContext = await this.deriveCallContext(targetContractAddress, targetArtifact, isStaticCall);
557
547
 
558
- const privateExecutionOracle = new PrivateExecutionOracle(
548
+ const privateExecutionOracle = new PrivateExecutionOracle({
559
549
  argsHash,
560
- derivedTxContext,
561
- derivedCallContext,
562
- this.anchorBlockHeader,
563
- this.utilityExecutor,
564
- this.authWitnesses,
565
- this.capsules,
566
- this.executionCache,
567
- this.noteCache,
568
- this.taggingIndexCache,
569
- this.contractStore,
570
- this.noteStore,
571
- this.keyStore,
572
- this.addressStore,
573
- this.aztecNode,
574
- this.senderTaggingStore,
575
- this.recipientTaggingStore,
576
- this.senderAddressBookStore,
577
- this.capsuleStore,
578
- this.privateEventStore,
579
- this.contractSyncService,
580
- this.jobId,
581
- this.totalPublicCalldataCount,
550
+ txContext: derivedTxContext,
551
+ callContext: derivedCallContext,
552
+ anchorBlockHeader: this.anchorBlockHeader,
553
+ utilityExecutor: this.utilityExecutor,
554
+ authWitnesses: this.authWitnesses,
555
+ capsules: this.capsules,
556
+ executionCache: this.executionCache,
557
+ noteCache: this.noteCache,
558
+ taggingIndexCache: this.taggingIndexCache,
559
+ contractStore: this.contractStore,
560
+ noteStore: this.noteStore,
561
+ keyStore: this.keyStore,
562
+ addressStore: this.addressStore,
563
+ aztecNode: this.aztecNode,
564
+ senderTaggingStore: this.senderTaggingStore,
565
+ recipientTaggingStore: this.recipientTaggingStore,
566
+ senderAddressBookStore: this.senderAddressBookStore,
567
+ capsuleStore: this.capsuleStore,
568
+ privateEventStore: this.privateEventStore,
569
+ contractSyncService: this.contractSyncService,
570
+ jobId: this.jobId,
571
+ totalPublicCalldataCount: this.totalPublicCalldataCount,
582
572
  sideEffectCounter,
583
- this.log,
584
- this.scopes,
585
- this.senderForTags,
586
- this.simulator,
587
- );
573
+ log: this.log,
574
+ scopes: this.scopes,
575
+ senderForTags: this.senderForTags,
576
+ simulator: this.simulator!,
577
+ });
588
578
 
589
579
  const setupTime = simulatorSetupTimer.ms();
590
580
 
591
581
  const childExecutionResult = await executePrivateFunction(
592
- this.simulator,
582
+ this.simulator!,
593
583
  privateExecutionOracle,
594
584
  targetArtifact,
595
585
  targetContractAddress,
@@ -3,7 +3,7 @@ import type { BlockNumber } from '@aztec/foundation/branded-types';
3
3
  import { Aes128 } from '@aztec/foundation/crypto/aes128';
4
4
  import { Fr } from '@aztec/foundation/curves/bn254';
5
5
  import { Point } from '@aztec/foundation/curves/grumpkin';
6
- import { LogLevels, applyStringFormatting, createLogger } from '@aztec/foundation/log';
6
+ import { LogLevels, type Logger, createLogger } from '@aztec/foundation/log';
7
7
  import type { MembershipWitness } from '@aztec/foundation/trees';
8
8
  import type { KeyStore } from '@aztec/key-store';
9
9
  import type { AuthWitness } from '@aztec/stdlib/auth-witness';
@@ -20,6 +20,8 @@ import type { NoteStatus } from '@aztec/stdlib/note';
20
20
  import { MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
21
21
  import type { BlockHeader, Capsule } from '@aztec/stdlib/tx';
22
22
 
23
+ import type { AccessScopes } from '../../access_scopes.js';
24
+ import { createContractLogger, logContractMessage } from '../../contract_logging.js';
23
25
  import { EventService } from '../../events/event_service.js';
24
26
  import { LogService } from '../../logs/log_service.js';
25
27
  import { NoteService } from '../../notes/note_service.js';
@@ -40,6 +42,27 @@ import { pickNotes } from '../pick_notes.js';
40
42
  import type { IMiscOracle, IUtilityExecutionOracle, NoteData } from './interfaces.js';
41
43
  import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
42
44
 
45
+ /** Args for UtilityExecutionOracle constructor. */
46
+ export type UtilityExecutionOracleArgs = {
47
+ contractAddress: AztecAddress;
48
+ /** List of transient auth witnesses to be used during this simulation */
49
+ authWitnesses: AuthWitness[];
50
+ capsules: Capsule[]; // TODO(#12425): Rename to transientCapsules
51
+ anchorBlockHeader: BlockHeader;
52
+ contractStore: ContractStore;
53
+ noteStore: NoteStore;
54
+ keyStore: KeyStore;
55
+ addressStore: AddressStore;
56
+ aztecNode: AztecNode;
57
+ recipientTaggingStore: RecipientTaggingStore;
58
+ senderAddressBookStore: SenderAddressBookStore;
59
+ capsuleStore: CapsuleStore;
60
+ privateEventStore: PrivateEventStore;
61
+ jobId: string;
62
+ log?: ReturnType<typeof createLogger>;
63
+ scopes: AccessScopes;
64
+ };
65
+
43
66
  /**
44
67
  * The oracle for an execution of utility contract functions.
45
68
  */
@@ -47,27 +70,43 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
47
70
  isMisc = true as const;
48
71
  isUtility = true as const;
49
72
 
50
- private aztecNrDebugLog = createLogger('aztec-nr:debug_log');
51
-
52
- constructor(
53
- protected readonly contractAddress: AztecAddress,
54
- /** List of transient auth witnesses to be used during this simulation */
55
- protected readonly authWitnesses: AuthWitness[],
56
- protected readonly capsules: Capsule[], // TODO(#12425): Rename to transientCapsules
57
- protected readonly anchorBlockHeader: BlockHeader,
58
- protected readonly contractStore: ContractStore,
59
- protected readonly noteStore: NoteStore,
60
- protected readonly keyStore: KeyStore,
61
- protected readonly addressStore: AddressStore,
62
- protected readonly aztecNode: AztecNode,
63
- protected readonly recipientTaggingStore: RecipientTaggingStore,
64
- protected readonly senderAddressBookStore: SenderAddressBookStore,
65
- protected readonly capsuleStore: CapsuleStore,
66
- protected readonly privateEventStore: PrivateEventStore,
67
- protected readonly jobId: string,
68
- protected log = createLogger('simulator:client_view_context'),
69
- protected readonly scopes?: AztecAddress[],
70
- ) {}
73
+ private contractLogger: Logger | undefined;
74
+
75
+ protected readonly contractAddress: AztecAddress;
76
+ protected readonly authWitnesses: AuthWitness[];
77
+ protected readonly capsules: Capsule[];
78
+ protected readonly anchorBlockHeader: BlockHeader;
79
+ protected readonly contractStore: ContractStore;
80
+ protected readonly noteStore: NoteStore;
81
+ protected readonly keyStore: KeyStore;
82
+ protected readonly addressStore: AddressStore;
83
+ protected readonly aztecNode: AztecNode;
84
+ protected readonly recipientTaggingStore: RecipientTaggingStore;
85
+ protected readonly senderAddressBookStore: SenderAddressBookStore;
86
+ protected readonly capsuleStore: CapsuleStore;
87
+ protected readonly privateEventStore: PrivateEventStore;
88
+ protected readonly jobId: string;
89
+ protected log: ReturnType<typeof createLogger>;
90
+ protected readonly scopes: AccessScopes;
91
+
92
+ constructor(args: UtilityExecutionOracleArgs) {
93
+ this.contractAddress = args.contractAddress;
94
+ this.authWitnesses = args.authWitnesses;
95
+ this.capsules = args.capsules;
96
+ this.anchorBlockHeader = args.anchorBlockHeader;
97
+ this.contractStore = args.contractStore;
98
+ this.noteStore = args.noteStore;
99
+ this.keyStore = args.keyStore;
100
+ this.addressStore = args.addressStore;
101
+ this.aztecNode = args.aztecNode;
102
+ this.recipientTaggingStore = args.recipientTaggingStore;
103
+ this.senderAddressBookStore = args.senderAddressBookStore;
104
+ this.capsuleStore = args.capsuleStore;
105
+ this.privateEventStore = args.privateEventStore;
106
+ this.jobId = args.jobId;
107
+ this.log = args.log ?? createLogger('simulator:client_view_context');
108
+ this.scopes = args.scopes;
109
+ }
71
110
 
72
111
  public utilityAssertCompatibleOracleVersion(version: number): void {
73
112
  if (version !== ORACLE_VERSION) {
@@ -91,11 +130,16 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
91
130
  * @throws If scopes are defined and the account is not in the scopes.
92
131
  */
93
132
  public async utilityGetKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
94
- // If scopes are defined, check that the key belongs to an account in the scopes
95
- if (this.scopes && this.scopes.length > 0) {
96
- const [, account] = await this.keyStore.getKeyPrefixAndAccount(pkMHash);
97
- if (!this.scopes.some(scope => scope.equals(account))) {
98
- throw new Error(`Key validation request denied: account ${account.toString()} is not in the allowed scopes.`);
133
+ // If scopes are defined, check that the key belongs to an account in the scopes.
134
+ if (this.scopes !== 'ALL_SCOPES' && this.scopes.length > 0) {
135
+ let hasAccess = false;
136
+ for (let i = 0; i < this.scopes.length && !hasAccess; i++) {
137
+ if (await this.keyStore.accountHasKey(this.scopes[i], pkMHash)) {
138
+ hasAccess = true;
139
+ }
140
+ }
141
+ if (!hasAccess) {
142
+ throw new Error(`Key validation request denied: no scoped account has a key with hash ${pkMHash.toString()}.`);
99
143
  }
100
144
  }
101
145
  return this.keyStore.getKeyValidationRequest(pkMHash, this.contractAddress);
@@ -297,8 +341,13 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
297
341
  * @returns A boolean indicating whether the nullifier exists in the tree or not.
298
342
  */
299
343
  public async utilityCheckNullifierExists(innerNullifier: Fr) {
300
- const nullifier = await siloNullifier(this.contractAddress, innerNullifier!);
301
- const [leafIndex] = await this.aztecNode.findLeavesIndexes('latest', MerkleTreeId.NULLIFIER_TREE, [nullifier]);
344
+ const [nullifier, anchorBlockHash] = await Promise.all([
345
+ siloNullifier(this.contractAddress, innerNullifier!),
346
+ this.anchorBlockHeader.hash(),
347
+ ]);
348
+ const [leafIndex] = await this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, [
349
+ nullifier,
350
+ ]);
302
351
  return leafIndex?.data !== undefined;
303
352
  }
304
353
 
@@ -349,12 +398,28 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
349
398
  return values;
350
399
  }
351
400
 
352
- public utilityDebugLog(level: number, message: string, fields: Fr[]): void {
401
+ /**
402
+ * Returns a per-contract logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
403
+ */
404
+ async #getContractLogger(): Promise<Logger> {
405
+ if (!this.contractLogger) {
406
+ // Purpose of instanceId is to distinguish logs from different instances of the same component. It makes sense
407
+ // to re-use jobId as instanceId here as executions of different PXE jobs are isolated.
408
+ this.contractLogger = await createContractLogger(
409
+ this.contractAddress,
410
+ addr => this.contractStore.getDebugContractName(addr),
411
+ { instanceId: this.jobId },
412
+ );
413
+ }
414
+ return this.contractLogger;
415
+ }
416
+
417
+ public async utilityLog(level: number, message: string, fields: Fr[]): Promise<void> {
353
418
  if (!LogLevels[level]) {
354
- throw new Error(`Invalid debug log level: ${level}`);
419
+ throw new Error(`Invalid log level: ${level}`);
355
420
  }
356
- const levelName = LogLevels[level];
357
- this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
421
+ const logger = await this.#getContractLogger();
422
+ logContractMessage(logger, LogLevels[level], message, fields);
358
423
  }
359
424
 
360
425
  public async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
@@ -0,0 +1,39 @@
1
+ import type { Fr } from '@aztec/foundation/curves/bn254';
2
+ import { type LogLevel, type Logger, applyStringFormatting, createLogger } from '@aztec/foundation/log';
3
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
4
+ import type { DebugLog } from '@aztec/stdlib/logs';
5
+
6
+ /** Resolves a contract address to a human-readable name, if available. */
7
+ export type ContractNameResolver = (address: AztecAddress) => Promise<string | undefined>;
8
+
9
+ /**
10
+ * Creates a logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
11
+ */
12
+ export async function createContractLogger(
13
+ contractAddress: AztecAddress,
14
+ getContractName: ContractNameResolver,
15
+ options?: { instanceId?: string },
16
+ ): Promise<Logger> {
17
+ const addrAbbrev = contractAddress.toString().slice(0, 10);
18
+ const name = await getContractName(contractAddress);
19
+ const module = name ? `contract_log::${name}(${addrAbbrev})` : `contract_log::Unknown(${addrAbbrev})`;
20
+ return createLogger(module, options);
21
+ }
22
+
23
+ /**
24
+ * Formats and emits a single contract log message through the given logger.
25
+ */
26
+ export function logContractMessage(logger: Logger, level: LogLevel, message: string, fields: Fr[]): void {
27
+ logger[level](applyStringFormatting(message, fields));
28
+ }
29
+
30
+ /**
31
+ * Displays debug logs collected during public function simulation,
32
+ * using the `contract_log::` prefixed logger format.
33
+ */
34
+ export async function displayDebugLogs(debugLogs: DebugLog[], getContractName: ContractNameResolver): Promise<void> {
35
+ for (const log of debugLogs) {
36
+ const logger = await createContractLogger(log.contractAddress, getContractName);
37
+ logContractMessage(logger, log.level, log.message, log.fields);
38
+ }
39
+ }
@@ -4,6 +4,7 @@ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
4
4
  import type { AztecNode } from '@aztec/stdlib/interfaces/client';
5
5
  import type { BlockHeader } from '@aztec/stdlib/tx';
6
6
 
7
+ import type { AccessScopes } from '../access_scopes.js';
7
8
  import type { StagedStore } from '../job_coordinator/job_coordinator.js';
8
9
  import type { ContractStore } from '../storage/contract_store/contract_store.js';
9
10
  import type { NoteStore } from '../storage/note_store/note_store.js';
@@ -18,8 +19,9 @@ import { syncState, verifyCurrentClassId } from './helpers.js';
18
19
  export class ContractSyncService implements StagedStore {
19
20
  readonly storeName = 'contract_sync';
20
21
 
21
- // Tracks contracts synced since last wipe. Key is contract address string, value is a promise that resolves when
22
- // the contract is synced.
22
+ // Tracks contracts synced since last wipe. The cache is keyed per individual scope address
23
+ // (`contractAddress:scopeAddress`), or `contractAddress:*` for undefined scopes (all accounts).
24
+ // The value is a promise that resolves when the contract is synced.
23
25
  private syncedContracts: Map<string, Promise<void>> = new Map();
24
26
 
25
27
  // Per-job overridden contract addresses - these contracts should not be synced.
@@ -44,51 +46,63 @@ export class ContractSyncService implements StagedStore {
44
46
  * @param functionToInvokeAfterSync - The function selector that will be called after sync (used to validate it's
45
47
  * not sync_state itself).
46
48
  * @param utilityExecutor - Executor function for running the sync_state utility function.
49
+ * @param scopes - Access scopes to pass through to the utility executor (affects whose account's private state is discovered).
47
50
  */
48
51
  async ensureContractSynced(
49
52
  contractAddress: AztecAddress,
50
53
  functionToInvokeAfterSync: FunctionSelector | null,
51
- utilityExecutor: (call: FunctionCall) => Promise<any>,
54
+ utilityExecutor: (call: FunctionCall, scopes: AccessScopes) => Promise<any>,
52
55
  anchorBlockHeader: BlockHeader,
53
56
  jobId: string,
57
+ scopes: AccessScopes,
54
58
  ): Promise<void> {
55
- const key = contractAddress.toString();
56
-
57
- // Skip sync if this contract has an override for this job
59
+ // Skip sync if this contract has an override for this job (overrides are keyed by contract address only)
58
60
  const overrides = this.overriddenContracts.get(jobId);
59
- if (overrides?.has(key)) {
61
+ if (overrides?.has(contractAddress.toString())) {
60
62
  return;
61
63
  }
62
64
 
63
- const existing = this.syncedContracts.get(key);
64
- if (existing) {
65
- return existing;
65
+ // Skip sync if we already synced for "all scopes", or if we have an empty list of scopes
66
+ const allScopesKey = toKey(contractAddress, 'ALL_SCOPES');
67
+ const allScopesExisting = this.syncedContracts.get(allScopesKey);
68
+ if (allScopesExisting || (scopes !== 'ALL_SCOPES' && scopes.length == 0)) {
69
+ return;
66
70
  }
67
71
 
68
- const syncPromise = this.#doSync(
69
- contractAddress,
70
- functionToInvokeAfterSync,
71
- utilityExecutor,
72
- anchorBlockHeader,
73
- jobId,
74
- );
75
- this.syncedContracts.set(key, syncPromise);
76
-
77
- try {
78
- await syncPromise;
79
- } catch (err) {
80
- // There was an error syncing the contract, so we remove it from the cache so that it can be retried.
81
- this.syncedContracts.delete(key);
82
- throw err;
72
+ const unsyncedScopes =
73
+ scopes === 'ALL_SCOPES'
74
+ ? scopes
75
+ : scopes.filter(scope => !this.syncedContracts.has(toKey(contractAddress, scope)));
76
+ const unsyncedScopesKeys = toKeys(contractAddress, unsyncedScopes);
77
+
78
+ if (unsyncedScopesKeys.length > 0) {
79
+ // Start sync and store the promise for all unsynced scopes
80
+ const promise = this.#doSync(
81
+ contractAddress,
82
+ functionToInvokeAfterSync,
83
+ utilityExecutor,
84
+ anchorBlockHeader,
85
+ jobId,
86
+ unsyncedScopes,
87
+ ).catch(err => {
88
+ // There was an error syncing the contract, so we remove it from the cache so that it can be retried.
89
+ unsyncedScopesKeys.forEach(key => this.syncedContracts.delete(key));
90
+ throw err;
91
+ });
92
+ unsyncedScopesKeys.forEach(key => this.syncedContracts.set(key, promise));
83
93
  }
94
+
95
+ const promises = toKeys(contractAddress, scopes).map(key => this.syncedContracts.get(key)!);
96
+ await Promise.all(promises);
84
97
  }
85
98
 
86
99
  async #doSync(
87
100
  contractAddress: AztecAddress,
88
101
  functionToInvokeAfterSync: FunctionSelector | null,
89
- utilityExecutor: (call: FunctionCall) => Promise<any>,
102
+ utilityExecutor: (call: FunctionCall, scopes: AccessScopes) => Promise<any>,
90
103
  anchorBlockHeader: BlockHeader,
91
104
  jobId: string,
105
+ scopes: AccessScopes,
92
106
  ): Promise<void> {
93
107
  this.log.debug(`Syncing contract ${contractAddress}`);
94
108
  await Promise.all([
@@ -101,6 +115,7 @@ export class ContractSyncService implements StagedStore {
101
115
  this.aztecNode,
102
116
  anchorBlockHeader,
103
117
  jobId,
118
+ scopes,
104
119
  ),
105
120
  verifyCurrentClassId(contractAddress, this.aztecNode, this.contractStore, anchorBlockHeader),
106
121
  ]);
@@ -127,3 +142,11 @@ export class ContractSyncService implements StagedStore {
127
142
  return Promise.resolve();
128
143
  }
129
144
  }
145
+
146
+ function toKeys(contract: AztecAddress, scopes: AccessScopes) {
147
+ return scopes === 'ALL_SCOPES' ? [toKey(contract, scopes)] : scopes.map(scope => toKey(contract, scope));
148
+ }
149
+
150
+ function toKey(contract: AztecAddress, scope: AztecAddress | 'ALL_SCOPES') {
151
+ return scope === 'ALL_SCOPES' ? `${contract.toString()}:*` : `${contract.toString()}:${scope.toString()}`;
152
+ }