@aztec/pxe 0.0.1-commit.8afd444 → 0.0.1-commit.8ee97c858

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 (200) 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/block_synchronizer/block_synchronizer.d.ts +4 -2
  5. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  6. package/dest/block_synchronizer/block_synchronizer.js +7 -1
  7. package/dest/config/index.d.ts +2 -2
  8. package/dest/config/index.d.ts.map +1 -1
  9. package/dest/config/index.js +1 -1
  10. package/dest/config/package_info.js +1 -1
  11. package/dest/contract_function_simulator/contract_function_simulator.d.ts +61 -29
  12. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  13. package/dest/contract_function_simulator/contract_function_simulator.js +200 -72
  14. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +7 -7
  15. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts.map +1 -1
  16. package/dest/contract_function_simulator/execution_tagging_index_cache.js +19 -11
  17. package/dest/contract_function_simulator/index.d.ts +2 -1
  18. package/dest/contract_function_simulator/index.d.ts.map +1 -1
  19. package/dest/contract_function_simulator/index.js +1 -0
  20. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +2 -3
  21. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +5 -4
  23. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts +1 -1
  24. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts.map +1 -1
  25. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.js +1 -3
  26. package/dest/contract_function_simulator/noir-structs/message_tx_context.d.ts +16 -0
  27. package/dest/contract_function_simulator/noir-structs/message_tx_context.d.ts.map +1 -0
  28. package/dest/contract_function_simulator/noir-structs/message_tx_context.js +57 -0
  29. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +2 -4
  30. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  31. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +3 -5
  32. package/dest/contract_function_simulator/oracle/interfaces.d.ts +50 -45
  33. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  34. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts +9 -0
  35. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts.map +1 -0
  36. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.js +42 -0
  37. package/dest/contract_function_simulator/oracle/oracle.d.ts +45 -44
  38. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  39. package/dest/contract_function_simulator/oracle/oracle.js +164 -95
  40. package/dest/contract_function_simulator/oracle/private_execution.js +5 -3
  41. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +54 -78
  42. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  43. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +98 -85
  44. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +82 -43
  45. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  46. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +156 -72
  47. package/dest/contract_logging.d.ts +22 -0
  48. package/dest/contract_logging.d.ts.map +1 -0
  49. package/dest/contract_logging.js +23 -0
  50. package/dest/contract_sync/contract_sync_service.d.ts +45 -0
  51. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  52. package/dest/contract_sync/contract_sync_service.js +114 -0
  53. package/dest/contract_sync/helpers.d.ts +29 -0
  54. package/dest/contract_sync/helpers.d.ts.map +1 -0
  55. package/dest/contract_sync/{index.js → helpers.js} +8 -14
  56. package/dest/debug/pxe_debug_utils.d.ts +14 -10
  57. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  58. package/dest/debug/pxe_debug_utils.js +16 -15
  59. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  60. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  61. package/dest/entrypoints/client/bundle/index.js +3 -0
  62. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  63. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  64. package/dest/entrypoints/client/bundle/utils.js +9 -1
  65. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  66. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  67. package/dest/entrypoints/client/lazy/index.js +3 -0
  68. package/dest/entrypoints/client/lazy/utils.d.ts +1 -1
  69. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  70. package/dest/entrypoints/client/lazy/utils.js +9 -1
  71. package/dest/entrypoints/server/index.d.ts +4 -2
  72. package/dest/entrypoints/server/index.d.ts.map +1 -1
  73. package/dest/entrypoints/server/index.js +3 -1
  74. package/dest/entrypoints/server/utils.js +9 -1
  75. package/dest/logs/log_service.d.ts +3 -2
  76. package/dest/logs/log_service.d.ts.map +1 -1
  77. package/dest/logs/log_service.js +9 -14
  78. package/dest/messages/message_context_service.d.ts +17 -0
  79. package/dest/messages/message_context_service.d.ts.map +1 -0
  80. package/dest/messages/message_context_service.js +36 -0
  81. package/dest/notes/note_service.d.ts +4 -3
  82. package/dest/notes/note_service.d.ts.map +1 -1
  83. package/dest/notes/note_service.js +3 -2
  84. package/dest/notes_filter.d.ts +25 -0
  85. package/dest/notes_filter.d.ts.map +1 -0
  86. package/dest/notes_filter.js +4 -0
  87. package/dest/oracle_version.d.ts +2 -2
  88. package/dest/oracle_version.js +3 -3
  89. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  90. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  91. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  92. package/dest/private_kernel/hints/index.d.ts +1 -1
  93. package/dest/private_kernel/hints/index.js +1 -1
  94. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  95. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  96. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  97. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  98. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  99. package/dest/private_kernel/hints/test_utils.js +203 -0
  100. package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
  101. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  102. package/dest/private_kernel/private_kernel_execution_prover.js +19 -11
  103. package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
  104. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  105. package/dest/private_kernel/private_kernel_oracle.js +7 -3
  106. package/dest/pxe.d.ts +74 -24
  107. package/dest/pxe.d.ts.map +1 -1
  108. package/dest/pxe.js +124 -74
  109. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  110. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  111. package/dest/storage/contract_store/contract_store.js +145 -69
  112. package/dest/storage/metadata.d.ts +1 -1
  113. package/dest/storage/metadata.js +1 -1
  114. package/dest/storage/note_store/note_store.d.ts +3 -3
  115. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  116. package/dest/storage/note_store/note_store.js +6 -4
  117. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  118. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  119. package/dest/storage/tagging_store/sender_tagging_store.d.ts +29 -28
  120. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  121. package/dest/storage/tagging_store/sender_tagging_store.js +141 -115
  122. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  123. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  124. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  125. package/dest/tagging/index.d.ts +3 -3
  126. package/dest/tagging/index.d.ts.map +1 -1
  127. package/dest/tagging/index.js +1 -1
  128. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
  129. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  130. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +7 -7
  131. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  132. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
  133. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  134. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
  135. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
  136. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  137. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +13 -7
  138. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +4 -3
  139. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  140. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +20 -10
  141. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +5 -7
  142. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  143. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +36 -24
  144. package/package.json +25 -16
  145. package/src/access_scopes.ts +9 -0
  146. package/src/block_synchronizer/block_synchronizer.ts +6 -0
  147. package/src/config/index.ts +1 -1
  148. package/src/config/package_info.ts +1 -1
  149. package/src/contract_function_simulator/contract_function_simulator.ts +360 -133
  150. package/src/contract_function_simulator/execution_tagging_index_cache.ts +19 -14
  151. package/src/contract_function_simulator/index.ts +1 -0
  152. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +8 -5
  153. package/src/contract_function_simulator/noir-structs/log_retrieval_response.ts +1 -4
  154. package/src/contract_function_simulator/noir-structs/message_tx_context.ts +55 -0
  155. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +3 -6
  156. package/src/contract_function_simulator/oracle/interfaces.ts +54 -54
  157. package/src/contract_function_simulator/oracle/legacy_oracle_mappings.ts +135 -0
  158. package/src/contract_function_simulator/oracle/oracle.ts +177 -139
  159. package/src/contract_function_simulator/oracle/private_execution.ts +4 -4
  160. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +123 -179
  161. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +235 -79
  162. package/src/contract_logging.ts +39 -0
  163. package/src/contract_sync/contract_sync_service.ts +181 -0
  164. package/src/contract_sync/{index.ts → helpers.ts} +13 -34
  165. package/src/debug/pxe_debug_utils.ts +48 -18
  166. package/src/entrypoints/client/bundle/index.ts +3 -0
  167. package/src/entrypoints/client/bundle/utils.ts +9 -1
  168. package/src/entrypoints/client/lazy/index.ts +3 -0
  169. package/src/entrypoints/client/lazy/utils.ts +9 -1
  170. package/src/entrypoints/server/index.ts +3 -1
  171. package/src/entrypoints/server/utils.ts +7 -7
  172. package/src/logs/log_service.ts +17 -24
  173. package/src/messages/message_context_service.ts +45 -0
  174. package/src/notes/note_service.ts +4 -3
  175. package/src/notes_filter.ts +26 -0
  176. package/src/oracle_version.ts +3 -3
  177. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  178. package/src/private_kernel/hints/index.ts +1 -1
  179. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  180. package/src/private_kernel/hints/test_utils.ts +325 -0
  181. package/src/private_kernel/private_kernel_execution_prover.ts +19 -12
  182. package/src/private_kernel/private_kernel_oracle.ts +7 -7
  183. package/src/pxe.ts +225 -127
  184. package/src/storage/contract_store/contract_store.ts +174 -75
  185. package/src/storage/metadata.ts +1 -1
  186. package/src/storage/note_store/note_store.ts +12 -5
  187. package/src/storage/tagging_store/recipient_tagging_store.ts +9 -5
  188. package/src/storage/tagging_store/sender_tagging_store.ts +185 -138
  189. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  190. package/src/tagging/index.ts +2 -2
  191. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +7 -10
  192. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  193. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
  194. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +23 -10
  195. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +26 -11
  196. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +27 -26
  197. package/dest/contract_sync/index.d.ts +0 -24
  198. package/dest/contract_sync/index.d.ts.map +0 -1
  199. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  200. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
@@ -3,25 +3,30 @@ 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
+ import { isProtocolContract } from '@aztec/protocol-contracts';
9
10
  import type { AuthWitness } from '@aztec/stdlib/auth-witness';
10
11
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
11
12
  import { BlockHash } from '@aztec/stdlib/block';
12
- import type { CompleteAddress, ContractInstance } from '@aztec/stdlib/contract';
13
+ import type { CompleteAddress, ContractInstance, PartialAddress } from '@aztec/stdlib/contract';
13
14
  import { siloNullifier } from '@aztec/stdlib/hash';
14
15
  import type { AztecNode } from '@aztec/stdlib/interfaces/server';
15
16
  import type { KeyValidationRequest } from '@aztec/stdlib/kernel';
16
- import { computeAddressSecret } from '@aztec/stdlib/keys';
17
+ import { type PublicKeys, computeAddressSecret } from '@aztec/stdlib/keys';
17
18
  import { deriveEcdhSharedSecret } from '@aztec/stdlib/logs';
18
19
  import { getNonNullifiedL1ToL2MessageWitness } from '@aztec/stdlib/messaging';
19
20
  import type { NoteStatus } from '@aztec/stdlib/note';
20
21
  import { MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
21
- import type { BlockHeader, Capsule } from '@aztec/stdlib/tx';
22
+ import type { BlockHeader, Capsule, OffchainEffect } from '@aztec/stdlib/tx';
22
23
 
24
+ import type { AccessScopes } from '../../access_scopes.js';
25
+ import { createContractLogger, logContractMessage } from '../../contract_logging.js';
26
+ import type { ContractSyncService } from '../../contract_sync/contract_sync_service.js';
23
27
  import { EventService } from '../../events/event_service.js';
24
28
  import { LogService } from '../../logs/log_service.js';
29
+ import { MessageContextService } from '../../messages/message_context_service.js';
25
30
  import { NoteService } from '../../notes/note_service.js';
26
31
  import { ORACLE_VERSION } from '../../oracle_version.js';
27
32
  import type { AddressStore } from '../../storage/address_store/address_store.js';
@@ -34,12 +39,36 @@ import type { SenderAddressBookStore } from '../../storage/tagging_store/sender_
34
39
  import { EventValidationRequest } from '../noir-structs/event_validation_request.js';
35
40
  import { LogRetrievalRequest } from '../noir-structs/log_retrieval_request.js';
36
41
  import { LogRetrievalResponse } from '../noir-structs/log_retrieval_response.js';
42
+ import { MessageTxContext } from '../noir-structs/message_tx_context.js';
37
43
  import { NoteValidationRequest } from '../noir-structs/note_validation_request.js';
38
44
  import { UtilityContext } from '../noir-structs/utility_context.js';
39
45
  import { pickNotes } from '../pick_notes.js';
40
46
  import type { IMiscOracle, IUtilityExecutionOracle, NoteData } from './interfaces.js';
41
47
  import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
42
48
 
49
+ /** Args for UtilityExecutionOracle constructor. */
50
+ export type UtilityExecutionOracleArgs = {
51
+ contractAddress: AztecAddress;
52
+ /** List of transient auth witnesses to be used during this simulation */
53
+ authWitnesses: AuthWitness[];
54
+ capsules: Capsule[]; // TODO(#12425): Rename to transientCapsules
55
+ anchorBlockHeader: BlockHeader;
56
+ contractStore: ContractStore;
57
+ noteStore: NoteStore;
58
+ keyStore: KeyStore;
59
+ addressStore: AddressStore;
60
+ aztecNode: AztecNode;
61
+ recipientTaggingStore: RecipientTaggingStore;
62
+ senderAddressBookStore: SenderAddressBookStore;
63
+ capsuleStore: CapsuleStore;
64
+ privateEventStore: PrivateEventStore;
65
+ messageContextService: MessageContextService;
66
+ contractSyncService: ContractSyncService;
67
+ jobId: string;
68
+ log?: ReturnType<typeof createLogger>;
69
+ scopes: AccessScopes;
70
+ };
71
+
43
72
  /**
44
73
  * The oracle for an execution of utility contract functions.
45
74
  */
@@ -47,39 +76,75 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
47
76
  isMisc = true as const;
48
77
  isUtility = true as const;
49
78
 
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
- ) {}
71
-
72
- public utilityAssertCompatibleOracleVersion(version: number): void {
79
+ private contractLogger: Logger | undefined;
80
+ private offchainEffects: OffchainEffect[] = [];
81
+
82
+ protected readonly contractAddress: AztecAddress;
83
+ protected readonly authWitnesses: AuthWitness[];
84
+ protected readonly capsules: Capsule[];
85
+ protected readonly anchorBlockHeader: BlockHeader;
86
+ protected readonly contractStore: ContractStore;
87
+ protected readonly noteStore: NoteStore;
88
+ protected readonly keyStore: KeyStore;
89
+ protected readonly addressStore: AddressStore;
90
+ protected readonly aztecNode: AztecNode;
91
+ protected readonly recipientTaggingStore: RecipientTaggingStore;
92
+ protected readonly senderAddressBookStore: SenderAddressBookStore;
93
+ protected readonly capsuleStore: CapsuleStore;
94
+ protected readonly privateEventStore: PrivateEventStore;
95
+ protected readonly messageContextService: MessageContextService;
96
+ protected readonly contractSyncService: ContractSyncService;
97
+ protected readonly jobId: string;
98
+ protected logger: ReturnType<typeof createLogger>;
99
+ protected readonly scopes: AccessScopes;
100
+
101
+ constructor(args: UtilityExecutionOracleArgs) {
102
+ this.contractAddress = args.contractAddress;
103
+ this.authWitnesses = args.authWitnesses;
104
+ this.capsules = args.capsules;
105
+ this.anchorBlockHeader = args.anchorBlockHeader;
106
+ this.contractStore = args.contractStore;
107
+ this.noteStore = args.noteStore;
108
+ this.keyStore = args.keyStore;
109
+ this.addressStore = args.addressStore;
110
+ this.aztecNode = args.aztecNode;
111
+ this.recipientTaggingStore = args.recipientTaggingStore;
112
+ this.senderAddressBookStore = args.senderAddressBookStore;
113
+ this.capsuleStore = args.capsuleStore;
114
+ this.privateEventStore = args.privateEventStore;
115
+ this.messageContextService = args.messageContextService;
116
+ this.contractSyncService = args.contractSyncService;
117
+ this.jobId = args.jobId;
118
+ this.logger = args.log ?? createLogger('simulator:client_view_context');
119
+ this.scopes = args.scopes;
120
+ }
121
+
122
+ public assertCompatibleOracleVersion(version: number): void {
123
+ // TODO(F-416): Remove this hack on v5 when protocol contracts are redeployed.
124
+ // Protocol contracts/canonical contracts shipped with committed bytecode that cannot be changed. Assert they use
125
+ // the expected pinned version or the current one. We want to allow for both the pinned and the current versions
126
+ // because we want this code to work with both the pinned and unpinned version since some branches do not have the
127
+ // pinned contracts (like e.g. next)
128
+ const LEGACY_ORACLE_VERSION = 12;
129
+ if (isProtocolContract(this.contractAddress)) {
130
+ if (version !== LEGACY_ORACLE_VERSION && version !== ORACLE_VERSION) {
131
+ throw new Error(
132
+ `Expected legacy oracle version ${LEGACY_ORACLE_VERSION} or current oracle version ${ORACLE_VERSION} for alpha payload contract at ${this.contractAddress}, got ${version}.`,
133
+ );
134
+ }
135
+ return;
136
+ }
137
+
73
138
  if (version !== ORACLE_VERSION) {
74
139
  throw new Error(`Incompatible oracle version. Expected version ${ORACLE_VERSION}, got ${version}.`);
75
140
  }
76
141
  }
77
142
 
78
- public utilityGetRandomField(): Fr {
143
+ public getRandomField(): Fr {
79
144
  return Fr.random();
80
145
  }
81
146
 
82
- public utilityGetUtilityContext(): UtilityContext {
147
+ public getUtilityContext(): UtilityContext {
83
148
  return new UtilityContext(this.anchorBlockHeader, this.contractAddress);
84
149
  }
85
150
 
@@ -88,8 +153,21 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
88
153
  * @param pkMHash - The master public key hash.
89
154
  * @returns A Promise that resolves to nullifier keys.
90
155
  * @throws If the keys are not registered in the key store.
156
+ * @throws If scopes are defined and the account is not in the scopes.
91
157
  */
92
- public utilityGetKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
158
+ public async getKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
159
+ // If scopes are defined, check that the key belongs to an account in the scopes.
160
+ if (this.scopes !== 'ALL_SCOPES' && this.scopes.length > 0) {
161
+ let hasAccess = false;
162
+ for (let i = 0; i < this.scopes.length && !hasAccess; i++) {
163
+ if (await this.keyStore.accountHasKey(this.scopes[i], pkMHash)) {
164
+ hasAccess = true;
165
+ }
166
+ }
167
+ if (!hasAccess) {
168
+ throw new Error(`Key validation request denied: no scoped account has a key with hash ${pkMHash.toString()}.`);
169
+ }
170
+ }
93
171
  return this.keyStore.getKeyValidationRequest(pkMHash, this.contractAddress);
94
172
  }
95
173
 
@@ -100,7 +178,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
100
178
  * @param noteHash - The note hash to find in the note hash tree.
101
179
  * @returns The membership witness containing the leaf index and sibling path
102
180
  */
103
- public utilityGetNoteHashMembershipWitness(
181
+ public getNoteHashMembershipWitness(
104
182
  anchorBlockHash: BlockHash,
105
183
  noteHash: Fr,
106
184
  ): Promise<MembershipWitness<typeof NOTE_HASH_TREE_HEIGHT> | undefined> {
@@ -118,7 +196,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
118
196
  * @param blockHash - The block hash to find in the archive tree.
119
197
  * @returns The membership witness containing the leaf index and sibling path
120
198
  */
121
- public utilityGetBlockHashMembershipWitness(
199
+ public getBlockHashMembershipWitness(
122
200
  anchorBlockHash: BlockHash,
123
201
  blockHash: BlockHash,
124
202
  ): Promise<MembershipWitness<typeof ARCHIVE_HEIGHT> | undefined> {
@@ -131,7 +209,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
131
209
  * @param nullifier - Nullifier we try to find witness for.
132
210
  * @returns The nullifier membership witness (if found).
133
211
  */
134
- public utilityGetNullifierMembershipWitness(
212
+ public getNullifierMembershipWitness(
135
213
  blockHash: BlockHash,
136
214
  nullifier: Fr,
137
215
  ): Promise<NullifierMembershipWitness | undefined> {
@@ -147,7 +225,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
147
225
  * list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
148
226
  * we are trying to prove non-inclusion for.
149
227
  */
150
- public utilityGetLowNullifierMembershipWitness(
228
+ public getLowNullifierMembershipWitness(
151
229
  blockHash: BlockHash,
152
230
  nullifier: Fr,
153
231
  ): Promise<NullifierMembershipWitness | undefined> {
@@ -160,7 +238,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
160
238
  * @param leafSlot - The slot of the public data tree to get the witness for.
161
239
  * @returns - The witness
162
240
  */
163
- public utilityGetPublicDataWitness(blockHash: BlockHash, leafSlot: Fr): Promise<PublicDataWitness | undefined> {
241
+ public getPublicDataWitness(blockHash: BlockHash, leafSlot: Fr): Promise<PublicDataWitness | undefined> {
164
242
  return this.aztecNode.getPublicDataWitness(blockHash, leafSlot);
165
243
  }
166
244
 
@@ -169,7 +247,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
169
247
  * @param blockNumber - The number of a block of which to get the block header.
170
248
  * @returns Block extracted from a block with block number `blockNumber`.
171
249
  */
172
- public async utilityGetBlockHeader(blockNumber: BlockNumber): Promise<BlockHeader | undefined> {
250
+ public async getBlockHeader(blockNumber: BlockNumber): Promise<BlockHeader | undefined> {
173
251
  const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
174
252
  if (blockNumber > anchorBlockNumber) {
175
253
  throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
@@ -180,12 +258,18 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
180
258
  }
181
259
 
182
260
  /**
183
- * Retrieve the complete address associated to a given address.
261
+ * Retrieve the public keys and partial address associated to a given address.
184
262
  * @param account - The account address.
185
- * @returns A complete address associated with the input address, or `undefined` if not registered.
263
+ * @returns The public keys and partial address, or `undefined` if the account is not registered.
186
264
  */
187
- public utilityTryGetPublicKeysAndPartialAddress(account: AztecAddress): Promise<CompleteAddress | undefined> {
188
- return this.addressStore.getCompleteAddress(account);
265
+ public async tryGetPublicKeysAndPartialAddress(
266
+ account: AztecAddress,
267
+ ): Promise<{ publicKeys: PublicKeys; partialAddress: PartialAddress } | undefined> {
268
+ const completeAddress = await this.addressStore.getCompleteAddress(account);
269
+ if (!completeAddress) {
270
+ return undefined;
271
+ }
272
+ return { publicKeys: completeAddress.publicKeys, partialAddress: completeAddress.partialAddress };
189
273
  }
190
274
 
191
275
  protected async getCompleteAddressOrFail(account: AztecAddress): Promise<CompleteAddress> {
@@ -204,11 +288,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
204
288
  * @param address - Address.
205
289
  * @returns A contract instance.
206
290
  */
207
- public utilityGetContractInstance(address: AztecAddress): Promise<ContractInstance> {
208
- return this.getContractInstance(address);
209
- }
210
-
211
- protected async getContractInstance(address: AztecAddress): Promise<ContractInstance> {
291
+ public async getContractInstance(address: AztecAddress): Promise<ContractInstance> {
212
292
  const instance = await this.contractStore.getContractInstance(address);
213
293
  if (!instance) {
214
294
  throw new Error(`No contract instance found for address ${address.toString()}`);
@@ -222,7 +302,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
222
302
  * @param messageHash - Hash of the message to authenticate.
223
303
  * @returns Authentication witness for the requested message hash.
224
304
  */
225
- public utilityGetAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
305
+ public getAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
226
306
  return Promise.resolve(this.authWitnesses.find(w => w.requestHash.equals(messageHash))?.witness);
227
307
  }
228
308
 
@@ -248,7 +328,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
248
328
  * @param status - The status of notes to fetch.
249
329
  * @returns Array of note data.
250
330
  */
251
- public async utilityGetNotes(
331
+ public async getNotes(
252
332
  owner: AztecAddress | undefined,
253
333
  storageSlot: Fr,
254
334
  numSelects: number,
@@ -288,9 +368,14 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
288
368
  * @param innerNullifier - The inner nullifier.
289
369
  * @returns A boolean indicating whether the nullifier exists in the tree or not.
290
370
  */
291
- public async utilityCheckNullifierExists(innerNullifier: Fr) {
292
- const nullifier = await siloNullifier(this.contractAddress, innerNullifier!);
293
- const [leafIndex] = await this.aztecNode.findLeavesIndexes('latest', MerkleTreeId.NULLIFIER_TREE, [nullifier]);
371
+ public async checkNullifierExists(innerNullifier: Fr) {
372
+ const [nullifier, anchorBlockHash] = await Promise.all([
373
+ siloNullifier(this.contractAddress, innerNullifier!),
374
+ this.anchorBlockHeader.hash(),
375
+ ]);
376
+ const [leafIndex] = await this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, [
377
+ nullifier,
378
+ ]);
294
379
  return leafIndex?.data !== undefined;
295
380
  }
296
381
 
@@ -302,7 +387,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
302
387
  * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
303
388
  * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
304
389
  */
305
- public async utilityGetL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
390
+ public async getL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
306
391
  const [messageIndex, siblingPath] = await getNonNullifiedL1ToL2MessageWitness(
307
392
  this.aztecNode,
308
393
  contractAddress,
@@ -320,7 +405,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
320
405
  * @param startStorageSlot - The starting storage slot.
321
406
  * @param numberOfElements - Number of elements to read from the starting storage slot.
322
407
  */
323
- public async utilityStorageRead(
408
+ public async storageRead(
324
409
  blockHash: BlockHash,
325
410
  contractAddress: AztecAddress,
326
411
  startStorageSlot: Fr,
@@ -334,22 +419,38 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
334
419
  slots.map(storageSlot => this.aztecNode.getPublicStorageAt(blockHash, contractAddress, storageSlot)),
335
420
  );
336
421
 
337
- this.log.debug(
422
+ this.logger.debug(
338
423
  `Oracle storage read: slots=[${slots.map(slot => slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`,
339
424
  );
340
425
 
341
426
  return values;
342
427
  }
343
428
 
344
- public utilityDebugLog(level: number, message: string, fields: Fr[]): void {
429
+ /**
430
+ * Returns a per-contract logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
431
+ */
432
+ async #getContractLogger(): Promise<Logger> {
433
+ if (!this.contractLogger) {
434
+ // Purpose of instanceId is to distinguish logs from different instances of the same component. It makes sense
435
+ // to re-use jobId as instanceId here as executions of different PXE jobs are isolated.
436
+ this.contractLogger = await createContractLogger(
437
+ this.contractAddress,
438
+ addr => this.contractStore.getDebugContractName(addr),
439
+ { instanceId: this.jobId },
440
+ );
441
+ }
442
+ return this.contractLogger;
443
+ }
444
+
445
+ public async log(level: number, message: string, fields: Fr[]): Promise<void> {
345
446
  if (!LogLevels[level]) {
346
- throw new Error(`Invalid debug log level: ${level}`);
447
+ throw new Error(`Invalid log level: ${level}`);
347
448
  }
348
- const levelName = LogLevels[level];
349
- this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
449
+ const logger = await this.#getContractLogger();
450
+ logContractMessage(logger, LogLevels[level], message, fields);
350
451
  }
351
452
 
352
- public async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
453
+ public async fetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
353
454
  const logService = new LogService(
354
455
  this.aztecNode,
355
456
  this.anchorBlockHeader,
@@ -359,7 +460,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
359
460
  this.senderAddressBookStore,
360
461
  this.addressStore,
361
462
  this.jobId,
362
- this.log.getBindings(),
463
+ this.logger.getBindings(),
363
464
  );
364
465
 
365
466
  await logService.fetchTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
@@ -375,10 +476,12 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
375
476
  * @param noteValidationRequestsArrayBaseSlot - The base slot of capsule array containing note validation requests.
376
477
  * @param eventValidationRequestsArrayBaseSlot - The base slot of capsule array containing event validation requests.
377
478
  */
378
- public async utilityValidateAndStoreEnqueuedNotesAndEvents(
479
+ public async validateAndStoreEnqueuedNotesAndEvents(
379
480
  contractAddress: AztecAddress,
380
481
  noteValidationRequestsArrayBaseSlot: Fr,
381
482
  eventValidationRequestsArrayBaseSlot: Fr,
483
+ maxNotePackedLen: number,
484
+ maxEventSerializedLen: number,
382
485
  ) {
383
486
  // TODO(#10727): allow other contracts to store notes
384
487
  if (!this.contractAddress.equals(contractAddress)) {
@@ -389,11 +492,11 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
389
492
  // faster as we don't need to wait for the network round-trip.
390
493
  const noteValidationRequests = (
391
494
  await this.capsuleStore.readCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, this.jobId)
392
- ).map(NoteValidationRequest.fromFields);
495
+ ).map(fields => NoteValidationRequest.fromFields(fields, maxNotePackedLen));
393
496
 
394
497
  const eventValidationRequests = (
395
498
  await this.capsuleStore.readCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, this.jobId)
396
- ).map(EventValidationRequest.fromFields);
499
+ ).map(fields => EventValidationRequest.fromFields(fields, maxEventSerializedLen));
397
500
 
398
501
  const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
399
502
  const noteStorePromises = noteValidationRequests.map(request =>
@@ -431,7 +534,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
431
534
  await this.capsuleStore.setCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, [], this.jobId);
432
535
  }
433
536
 
434
- public async utilityBulkRetrieveLogs(
537
+ public async bulkRetrieveLogs(
435
538
  contractAddress: AztecAddress,
436
539
  logRetrievalRequestsArrayBaseSlot: Fr,
437
540
  logRetrievalResponsesArrayBaseSlot: Fr,
@@ -456,7 +559,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
456
559
  this.senderAddressBookStore,
457
560
  this.addressStore,
458
561
  this.jobId,
459
- this.log.getBindings(),
562
+ this.logger.getBindings(),
460
563
  );
461
564
 
462
565
  const maybeLogRetrievalResponses = await logService.bulkRetrieveLogs(logRetrievalRequests);
@@ -473,7 +576,48 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
473
576
  );
474
577
  }
475
578
 
476
- public utilityStoreCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
579
+ public async utilityResolveMessageContexts(
580
+ contractAddress: AztecAddress,
581
+ messageContextRequestsArrayBaseSlot: Fr,
582
+ messageContextResponsesArrayBaseSlot: Fr,
583
+ ) {
584
+ try {
585
+ if (!this.contractAddress.equals(contractAddress)) {
586
+ throw new Error(`Got a message context request from ${contractAddress}, expected ${this.contractAddress}`);
587
+ }
588
+ const requestCapsules = await this.capsuleStore.readCapsuleArray(
589
+ contractAddress,
590
+ messageContextRequestsArrayBaseSlot,
591
+ this.jobId,
592
+ );
593
+
594
+ const txHashes = requestCapsules.map((fields, i) => {
595
+ if (fields.length !== 1) {
596
+ throw new Error(
597
+ `Malformed message context request at index ${i}: expected 1 field (tx hash), got ${fields.length}`,
598
+ );
599
+ }
600
+ return fields[0];
601
+ });
602
+
603
+ const maybeMessageContexts = await this.messageContextService.resolveMessageContexts(
604
+ txHashes,
605
+ this.anchorBlockHeader.getBlockNumber(),
606
+ );
607
+
608
+ // Leave response in response capsule array.
609
+ await this.capsuleStore.setCapsuleArray(
610
+ contractAddress,
611
+ messageContextResponsesArrayBaseSlot,
612
+ maybeMessageContexts.map(MessageTxContext.toSerializedOption),
613
+ this.jobId,
614
+ );
615
+ } finally {
616
+ await this.capsuleStore.setCapsuleArray(contractAddress, messageContextRequestsArrayBaseSlot, [], this.jobId);
617
+ }
618
+ }
619
+
620
+ public storeCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
477
621
  if (!contractAddress.equals(this.contractAddress)) {
478
622
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
479
623
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -482,7 +626,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
482
626
  return Promise.resolve();
483
627
  }
484
628
 
485
- public async utilityLoadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
629
+ public async loadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
486
630
  if (!contractAddress.equals(this.contractAddress)) {
487
631
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
488
632
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -494,7 +638,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
494
638
  );
495
639
  }
496
640
 
497
- public utilityDeleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
641
+ public deleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
498
642
  if (!contractAddress.equals(this.contractAddress)) {
499
643
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
500
644
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -503,12 +647,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
503
647
  return Promise.resolve();
504
648
  }
505
649
 
506
- public utilityCopyCapsule(
507
- contractAddress: AztecAddress,
508
- srcSlot: Fr,
509
- dstSlot: Fr,
510
- numEntries: number,
511
- ): Promise<void> {
650
+ public copyCapsule(contractAddress: AztecAddress, srcSlot: Fr, dstSlot: Fr, numEntries: number): Promise<void> {
512
651
  if (!contractAddress.equals(this.contractAddress)) {
513
652
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
514
653
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -516,8 +655,19 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
516
655
  return this.capsuleStore.copyCapsule(this.contractAddress, srcSlot, dstSlot, numEntries, this.jobId);
517
656
  }
518
657
 
658
+ /**
659
+ * Clears cached sync state for a contract for a set of scopes, forcing re-sync on the next query so that newly
660
+ * stored notes or events are discovered.
661
+ */
662
+ public invalidateContractSyncCache(contractAddress: AztecAddress, scopes: AztecAddress[]): void {
663
+ if (!contractAddress.equals(this.contractAddress)) {
664
+ throw new Error(`Contract ${this.contractAddress} cannot invalidate sync cache of ${contractAddress}`);
665
+ }
666
+ this.contractSyncService.invalidateContractForScopes(contractAddress, scopes);
667
+ }
668
+
519
669
  // TODO(#11849): consider replacing this oracle with a pure Noir implementation of aes decryption.
520
- public utilityAes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
670
+ public aes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
521
671
  const aes128 = new Aes128();
522
672
  return aes128.decryptBufferCBC(ciphertext, iv, symKey);
523
673
  }
@@ -528,11 +678,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
528
678
  * @param ephPk - The ephemeral public key to get the secret for.
529
679
  * @returns The secret for the given address.
530
680
  */
531
- public utilityGetSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
532
- return this.getSharedSecret(address, ephPk);
533
- }
534
-
535
- protected async getSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
681
+ public async getSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
536
682
  // TODO(#12656): return an app-siloed secret
537
683
  const recipientCompleteAddress = await this.getCompleteAddressOrFail(address);
538
684
  const ivskM = await this.keyStore.getMasterSecretKey(
@@ -541,4 +687,14 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
541
687
  const addressSecret = await computeAddressSecret(await recipientCompleteAddress.getPreaddress(), ivskM);
542
688
  return deriveEcdhSharedSecret(addressSecret, ephPk);
543
689
  }
690
+
691
+ public emitOffchainEffect(data: Fr[]): Promise<void> {
692
+ this.offchainEffects.push({ data, contractAddress: this.contractAddress });
693
+ return Promise.resolve();
694
+ }
695
+
696
+ /** Returns offchain effects collected during execution. */
697
+ public getOffchainEffects(): OffchainEffect[] {
698
+ return this.offchainEffects;
699
+ }
544
700
  }
@@ -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
+ }