@aztec/pxe 0.0.1-commit.6d63667d → 0.0.1-commit.7035c9bd6

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 (194) 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/index.d.ts +2 -2
  5. package/dest/config/index.d.ts.map +1 -1
  6. package/dest/config/index.js +1 -1
  7. package/dest/config/package_info.js +1 -1
  8. package/dest/contract_function_simulator/contract_function_simulator.d.ts +60 -30
  9. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  10. package/dest/contract_function_simulator/contract_function_simulator.js +199 -73
  11. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +7 -7
  12. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts.map +1 -1
  13. package/dest/contract_function_simulator/execution_tagging_index_cache.js +19 -11
  14. package/dest/contract_function_simulator/index.d.ts +2 -1
  15. package/dest/contract_function_simulator/index.d.ts.map +1 -1
  16. package/dest/contract_function_simulator/index.js +1 -0
  17. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +2 -3
  18. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts.map +1 -1
  19. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +5 -4
  20. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts +1 -1
  21. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/noir-structs/log_retrieval_response.js +1 -3
  23. package/dest/contract_function_simulator/noir-structs/message_tx_context.d.ts +16 -0
  24. package/dest/contract_function_simulator/noir-structs/message_tx_context.d.ts.map +1 -0
  25. package/dest/contract_function_simulator/noir-structs/message_tx_context.js +57 -0
  26. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +2 -4
  27. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  28. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +3 -5
  29. package/dest/contract_function_simulator/oracle/interfaces.d.ts +50 -45
  30. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  31. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts +9 -0
  32. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts.map +1 -0
  33. package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.js +42 -0
  34. package/dest/contract_function_simulator/oracle/oracle.d.ts +45 -44
  35. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  36. package/dest/contract_function_simulator/oracle/oracle.js +164 -95
  37. package/dest/contract_function_simulator/oracle/private_execution.js +5 -3
  38. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +54 -80
  39. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  40. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +98 -85
  41. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +81 -43
  42. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  43. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +153 -77
  44. package/dest/contract_logging.d.ts +22 -0
  45. package/dest/contract_logging.d.ts.map +1 -0
  46. package/dest/contract_logging.js +23 -0
  47. package/dest/contract_sync/contract_sync_service.d.ts +8 -4
  48. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -1
  49. package/dest/contract_sync/contract_sync_service.js +61 -29
  50. package/dest/contract_sync/helpers.d.ts +3 -2
  51. package/dest/contract_sync/helpers.d.ts.map +1 -1
  52. package/dest/contract_sync/helpers.js +3 -3
  53. package/dest/debug/pxe_debug_utils.d.ts +6 -7
  54. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  55. package/dest/debug/pxe_debug_utils.js +4 -7
  56. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  57. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  58. package/dest/entrypoints/client/bundle/index.js +3 -0
  59. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  60. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  61. package/dest/entrypoints/client/bundle/utils.js +9 -1
  62. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  63. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  64. package/dest/entrypoints/client/lazy/index.js +3 -0
  65. package/dest/entrypoints/client/lazy/utils.d.ts +1 -1
  66. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  67. package/dest/entrypoints/client/lazy/utils.js +9 -1
  68. package/dest/entrypoints/server/index.d.ts +3 -1
  69. package/dest/entrypoints/server/index.d.ts.map +1 -1
  70. package/dest/entrypoints/server/index.js +2 -0
  71. package/dest/entrypoints/server/utils.js +9 -1
  72. package/dest/logs/log_service.d.ts +3 -2
  73. package/dest/logs/log_service.d.ts.map +1 -1
  74. package/dest/logs/log_service.js +9 -14
  75. package/dest/messages/message_context_service.d.ts +17 -0
  76. package/dest/messages/message_context_service.d.ts.map +1 -0
  77. package/dest/messages/message_context_service.js +36 -0
  78. package/dest/notes/note_service.d.ts +4 -3
  79. package/dest/notes/note_service.d.ts.map +1 -1
  80. package/dest/notes/note_service.js +3 -2
  81. package/dest/notes_filter.d.ts +25 -0
  82. package/dest/notes_filter.d.ts.map +1 -0
  83. package/dest/notes_filter.js +4 -0
  84. package/dest/oracle_version.d.ts +2 -2
  85. package/dest/oracle_version.js +3 -3
  86. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  87. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  88. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  89. package/dest/private_kernel/hints/index.d.ts +1 -1
  90. package/dest/private_kernel/hints/index.js +1 -1
  91. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  92. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  93. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  94. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  95. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  96. package/dest/private_kernel/hints/test_utils.js +203 -0
  97. package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
  98. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  99. package/dest/private_kernel/private_kernel_execution_prover.js +19 -11
  100. package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
  101. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  102. package/dest/private_kernel/private_kernel_oracle.js +7 -3
  103. package/dest/pxe.d.ts +73 -24
  104. package/dest/pxe.d.ts.map +1 -1
  105. package/dest/pxe.js +112 -73
  106. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  107. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  108. package/dest/storage/contract_store/contract_store.js +145 -69
  109. package/dest/storage/metadata.d.ts +1 -1
  110. package/dest/storage/metadata.js +1 -1
  111. package/dest/storage/note_store/note_store.d.ts +3 -3
  112. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  113. package/dest/storage/note_store/note_store.js +6 -4
  114. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  115. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  116. package/dest/storage/tagging_store/sender_tagging_store.d.ts +29 -28
  117. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  118. package/dest/storage/tagging_store/sender_tagging_store.js +141 -115
  119. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  120. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  121. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  122. package/dest/tagging/index.d.ts +3 -3
  123. package/dest/tagging/index.d.ts.map +1 -1
  124. package/dest/tagging/index.js +1 -1
  125. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
  126. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  127. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +7 -7
  128. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  129. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
  130. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  131. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
  132. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
  133. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  134. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +13 -7
  135. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +4 -3
  136. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  137. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +20 -10
  138. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +5 -7
  139. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  140. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +36 -24
  141. package/package.json +16 -16
  142. package/src/access_scopes.ts +9 -0
  143. package/src/config/index.ts +1 -1
  144. package/src/config/package_info.ts +1 -1
  145. package/src/contract_function_simulator/contract_function_simulator.ts +359 -135
  146. package/src/contract_function_simulator/execution_tagging_index_cache.ts +19 -14
  147. package/src/contract_function_simulator/index.ts +1 -0
  148. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +8 -5
  149. package/src/contract_function_simulator/noir-structs/log_retrieval_response.ts +1 -4
  150. package/src/contract_function_simulator/noir-structs/message_tx_context.ts +55 -0
  151. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +3 -6
  152. package/src/contract_function_simulator/oracle/interfaces.ts +54 -54
  153. package/src/contract_function_simulator/oracle/legacy_oracle_mappings.ts +135 -0
  154. package/src/contract_function_simulator/oracle/oracle.ts +177 -139
  155. package/src/contract_function_simulator/oracle/private_execution.ts +4 -4
  156. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +122 -177
  157. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +232 -84
  158. package/src/contract_logging.ts +39 -0
  159. package/src/contract_sync/contract_sync_service.ts +87 -35
  160. package/src/contract_sync/helpers.ts +7 -2
  161. package/src/debug/pxe_debug_utils.ts +12 -15
  162. package/src/entrypoints/client/bundle/index.ts +3 -0
  163. package/src/entrypoints/client/bundle/utils.ts +9 -1
  164. package/src/entrypoints/client/lazy/index.ts +3 -0
  165. package/src/entrypoints/client/lazy/utils.ts +9 -1
  166. package/src/entrypoints/server/index.ts +2 -0
  167. package/src/entrypoints/server/utils.ts +7 -7
  168. package/src/logs/log_service.ts +17 -24
  169. package/src/messages/message_context_service.ts +45 -0
  170. package/src/notes/note_service.ts +4 -3
  171. package/src/notes_filter.ts +26 -0
  172. package/src/oracle_version.ts +3 -3
  173. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  174. package/src/private_kernel/hints/index.ts +1 -1
  175. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  176. package/src/private_kernel/hints/test_utils.ts +325 -0
  177. package/src/private_kernel/private_kernel_execution_prover.ts +19 -12
  178. package/src/private_kernel/private_kernel_oracle.ts +7 -7
  179. package/src/pxe.ts +201 -117
  180. package/src/storage/contract_store/contract_store.ts +174 -75
  181. package/src/storage/metadata.ts +1 -1
  182. package/src/storage/note_store/note_store.ts +12 -5
  183. package/src/storage/tagging_store/recipient_tagging_store.ts +9 -5
  184. package/src/storage/tagging_store/sender_tagging_store.ts +185 -138
  185. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  186. package/src/tagging/index.ts +2 -2
  187. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +7 -10
  188. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  189. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
  190. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +23 -10
  191. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +26 -11
  192. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +27 -26
  193. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  194. 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
 
@@ -90,12 +155,17 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
90
155
  * @throws If the keys are not registered in the key store.
91
156
  * @throws If scopes are defined and the account is not in the scopes.
92
157
  */
93
- 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.`);
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()}.`);
99
169
  }
100
170
  }
101
171
  return this.keyStore.getKeyValidationRequest(pkMHash, this.contractAddress);
@@ -108,7 +178,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
108
178
  * @param noteHash - The note hash to find in the note hash tree.
109
179
  * @returns The membership witness containing the leaf index and sibling path
110
180
  */
111
- public utilityGetNoteHashMembershipWitness(
181
+ public getNoteHashMembershipWitness(
112
182
  anchorBlockHash: BlockHash,
113
183
  noteHash: Fr,
114
184
  ): Promise<MembershipWitness<typeof NOTE_HASH_TREE_HEIGHT> | undefined> {
@@ -126,7 +196,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
126
196
  * @param blockHash - The block hash to find in the archive tree.
127
197
  * @returns The membership witness containing the leaf index and sibling path
128
198
  */
129
- public utilityGetBlockHashMembershipWitness(
199
+ public getBlockHashMembershipWitness(
130
200
  anchorBlockHash: BlockHash,
131
201
  blockHash: BlockHash,
132
202
  ): Promise<MembershipWitness<typeof ARCHIVE_HEIGHT> | undefined> {
@@ -139,7 +209,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
139
209
  * @param nullifier - Nullifier we try to find witness for.
140
210
  * @returns The nullifier membership witness (if found).
141
211
  */
142
- public utilityGetNullifierMembershipWitness(
212
+ public getNullifierMembershipWitness(
143
213
  blockHash: BlockHash,
144
214
  nullifier: Fr,
145
215
  ): Promise<NullifierMembershipWitness | undefined> {
@@ -155,7 +225,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
155
225
  * list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
156
226
  * we are trying to prove non-inclusion for.
157
227
  */
158
- public utilityGetLowNullifierMembershipWitness(
228
+ public getLowNullifierMembershipWitness(
159
229
  blockHash: BlockHash,
160
230
  nullifier: Fr,
161
231
  ): Promise<NullifierMembershipWitness | undefined> {
@@ -168,7 +238,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
168
238
  * @param leafSlot - The slot of the public data tree to get the witness for.
169
239
  * @returns - The witness
170
240
  */
171
- public utilityGetPublicDataWitness(blockHash: BlockHash, leafSlot: Fr): Promise<PublicDataWitness | undefined> {
241
+ public getPublicDataWitness(blockHash: BlockHash, leafSlot: Fr): Promise<PublicDataWitness | undefined> {
172
242
  return this.aztecNode.getPublicDataWitness(blockHash, leafSlot);
173
243
  }
174
244
 
@@ -177,7 +247,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
177
247
  * @param blockNumber - The number of a block of which to get the block header.
178
248
  * @returns Block extracted from a block with block number `blockNumber`.
179
249
  */
180
- public async utilityGetBlockHeader(blockNumber: BlockNumber): Promise<BlockHeader | undefined> {
250
+ public async getBlockHeader(blockNumber: BlockNumber): Promise<BlockHeader | undefined> {
181
251
  const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
182
252
  if (blockNumber > anchorBlockNumber) {
183
253
  throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
@@ -188,12 +258,18 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
188
258
  }
189
259
 
190
260
  /**
191
- * Retrieve the complete address associated to a given address.
261
+ * Retrieve the public keys and partial address associated to a given address.
192
262
  * @param account - The account address.
193
- * @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.
194
264
  */
195
- public utilityTryGetPublicKeysAndPartialAddress(account: AztecAddress): Promise<CompleteAddress | undefined> {
196
- 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 };
197
273
  }
198
274
 
199
275
  protected async getCompleteAddressOrFail(account: AztecAddress): Promise<CompleteAddress> {
@@ -212,11 +288,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
212
288
  * @param address - Address.
213
289
  * @returns A contract instance.
214
290
  */
215
- public utilityGetContractInstance(address: AztecAddress): Promise<ContractInstance> {
216
- return this.getContractInstance(address);
217
- }
218
-
219
- protected async getContractInstance(address: AztecAddress): Promise<ContractInstance> {
291
+ public async getContractInstance(address: AztecAddress): Promise<ContractInstance> {
220
292
  const instance = await this.contractStore.getContractInstance(address);
221
293
  if (!instance) {
222
294
  throw new Error(`No contract instance found for address ${address.toString()}`);
@@ -230,7 +302,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
230
302
  * @param messageHash - Hash of the message to authenticate.
231
303
  * @returns Authentication witness for the requested message hash.
232
304
  */
233
- public utilityGetAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
305
+ public getAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
234
306
  return Promise.resolve(this.authWitnesses.find(w => w.requestHash.equals(messageHash))?.witness);
235
307
  }
236
308
 
@@ -256,7 +328,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
256
328
  * @param status - The status of notes to fetch.
257
329
  * @returns Array of note data.
258
330
  */
259
- public async utilityGetNotes(
331
+ public async getNotes(
260
332
  owner: AztecAddress | undefined,
261
333
  storageSlot: Fr,
262
334
  numSelects: number,
@@ -296,9 +368,14 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
296
368
  * @param innerNullifier - The inner nullifier.
297
369
  * @returns A boolean indicating whether the nullifier exists in the tree or not.
298
370
  */
299
- 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]);
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
+ ]);
302
379
  return leafIndex?.data !== undefined;
303
380
  }
304
381
 
@@ -310,7 +387,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
310
387
  * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
311
388
  * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
312
389
  */
313
- public async utilityGetL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
390
+ public async getL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
314
391
  const [messageIndex, siblingPath] = await getNonNullifiedL1ToL2MessageWitness(
315
392
  this.aztecNode,
316
393
  contractAddress,
@@ -328,7 +405,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
328
405
  * @param startStorageSlot - The starting storage slot.
329
406
  * @param numberOfElements - Number of elements to read from the starting storage slot.
330
407
  */
331
- public async utilityStorageRead(
408
+ public async storageRead(
332
409
  blockHash: BlockHash,
333
410
  contractAddress: AztecAddress,
334
411
  startStorageSlot: Fr,
@@ -342,22 +419,38 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
342
419
  slots.map(storageSlot => this.aztecNode.getPublicStorageAt(blockHash, contractAddress, storageSlot)),
343
420
  );
344
421
 
345
- this.log.debug(
422
+ this.logger.debug(
346
423
  `Oracle storage read: slots=[${slots.map(slot => slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`,
347
424
  );
348
425
 
349
426
  return values;
350
427
  }
351
428
 
352
- 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> {
353
446
  if (!LogLevels[level]) {
354
- throw new Error(`Invalid debug log level: ${level}`);
447
+ throw new Error(`Invalid log level: ${level}`);
355
448
  }
356
- const levelName = LogLevels[level];
357
- this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
449
+ const logger = await this.#getContractLogger();
450
+ logContractMessage(logger, LogLevels[level], message, fields);
358
451
  }
359
452
 
360
- public async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
453
+ public async fetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
361
454
  const logService = new LogService(
362
455
  this.aztecNode,
363
456
  this.anchorBlockHeader,
@@ -367,7 +460,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
367
460
  this.senderAddressBookStore,
368
461
  this.addressStore,
369
462
  this.jobId,
370
- this.log.getBindings(),
463
+ this.logger.getBindings(),
371
464
  );
372
465
 
373
466
  await logService.fetchTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
@@ -383,10 +476,12 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
383
476
  * @param noteValidationRequestsArrayBaseSlot - The base slot of capsule array containing note validation requests.
384
477
  * @param eventValidationRequestsArrayBaseSlot - The base slot of capsule array containing event validation requests.
385
478
  */
386
- public async utilityValidateAndStoreEnqueuedNotesAndEvents(
479
+ public async validateAndStoreEnqueuedNotesAndEvents(
387
480
  contractAddress: AztecAddress,
388
481
  noteValidationRequestsArrayBaseSlot: Fr,
389
482
  eventValidationRequestsArrayBaseSlot: Fr,
483
+ maxNotePackedLen: number,
484
+ maxEventSerializedLen: number,
390
485
  ) {
391
486
  // TODO(#10727): allow other contracts to store notes
392
487
  if (!this.contractAddress.equals(contractAddress)) {
@@ -397,11 +492,11 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
397
492
  // faster as we don't need to wait for the network round-trip.
398
493
  const noteValidationRequests = (
399
494
  await this.capsuleStore.readCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, this.jobId)
400
- ).map(NoteValidationRequest.fromFields);
495
+ ).map(fields => NoteValidationRequest.fromFields(fields, maxNotePackedLen));
401
496
 
402
497
  const eventValidationRequests = (
403
498
  await this.capsuleStore.readCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, this.jobId)
404
- ).map(EventValidationRequest.fromFields);
499
+ ).map(fields => EventValidationRequest.fromFields(fields, maxEventSerializedLen));
405
500
 
406
501
  const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
407
502
  const noteStorePromises = noteValidationRequests.map(request =>
@@ -439,7 +534,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
439
534
  await this.capsuleStore.setCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, [], this.jobId);
440
535
  }
441
536
 
442
- public async utilityBulkRetrieveLogs(
537
+ public async bulkRetrieveLogs(
443
538
  contractAddress: AztecAddress,
444
539
  logRetrievalRequestsArrayBaseSlot: Fr,
445
540
  logRetrievalResponsesArrayBaseSlot: Fr,
@@ -464,7 +559,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
464
559
  this.senderAddressBookStore,
465
560
  this.addressStore,
466
561
  this.jobId,
467
- this.log.getBindings(),
562
+ this.logger.getBindings(),
468
563
  );
469
564
 
470
565
  const maybeLogRetrievalResponses = await logService.bulkRetrieveLogs(logRetrievalRequests);
@@ -481,7 +576,48 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
481
576
  );
482
577
  }
483
578
 
484
- 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> {
485
621
  if (!contractAddress.equals(this.contractAddress)) {
486
622
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
487
623
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -490,7 +626,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
490
626
  return Promise.resolve();
491
627
  }
492
628
 
493
- public async utilityLoadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
629
+ public async loadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
494
630
  if (!contractAddress.equals(this.contractAddress)) {
495
631
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
496
632
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -502,7 +638,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
502
638
  );
503
639
  }
504
640
 
505
- public utilityDeleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
641
+ public deleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
506
642
  if (!contractAddress.equals(this.contractAddress)) {
507
643
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
508
644
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -511,12 +647,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
511
647
  return Promise.resolve();
512
648
  }
513
649
 
514
- public utilityCopyCapsule(
515
- contractAddress: AztecAddress,
516
- srcSlot: Fr,
517
- dstSlot: Fr,
518
- numEntries: number,
519
- ): Promise<void> {
650
+ public copyCapsule(contractAddress: AztecAddress, srcSlot: Fr, dstSlot: Fr, numEntries: number): Promise<void> {
520
651
  if (!contractAddress.equals(this.contractAddress)) {
521
652
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
522
653
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -524,8 +655,19 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
524
655
  return this.capsuleStore.copyCapsule(this.contractAddress, srcSlot, dstSlot, numEntries, this.jobId);
525
656
  }
526
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
+
527
669
  // TODO(#11849): consider replacing this oracle with a pure Noir implementation of aes decryption.
528
- public utilityAes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
670
+ public aes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
529
671
  const aes128 = new Aes128();
530
672
  return aes128.decryptBufferCBC(ciphertext, iv, symKey);
531
673
  }
@@ -536,11 +678,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
536
678
  * @param ephPk - The ephemeral public key to get the secret for.
537
679
  * @returns The secret for the given address.
538
680
  */
539
- public utilityGetSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
540
- return this.getSharedSecret(address, ephPk);
541
- }
542
-
543
- protected async getSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
681
+ public async getSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
544
682
  // TODO(#12656): return an app-siloed secret
545
683
  const recipientCompleteAddress = await this.getCompleteAddressOrFail(address);
546
684
  const ivskM = await this.keyStore.getMasterSecretKey(
@@ -549,4 +687,14 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
549
687
  const addressSecret = await computeAddressSecret(await recipientCompleteAddress.getPreaddress(), ivskM);
550
688
  return deriveEcdhSharedSecret(addressSecret, ephPk);
551
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
+ }
552
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
+ }