@aztec/pxe 0.0.1-commit.86469d5 → 0.0.1-commit.88c5703d4

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