@aztec/pxe 0.0.1-commit.29c6b1a3 → 0.0.1-commit.2c85e299c

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 (209) 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 +5 -3
  5. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  6. package/dest/block_synchronizer/block_synchronizer.js +9 -3
  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 +54 -30
  12. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  13. package/dest/contract_function_simulator/contract_function_simulator.js +177 -73
  14. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +5 -5
  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 +3 -3
  17. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +1 -1
  18. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +2 -2
  19. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  20. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +1 -1
  21. package/dest/contract_function_simulator/oracle/interfaces.d.ts +49 -45
  22. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  23. package/dest/contract_function_simulator/oracle/oracle.d.ts +44 -44
  24. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  25. package/dest/contract_function_simulator/oracle/oracle.js +156 -101
  26. package/dest/contract_function_simulator/oracle/private_execution.js +1 -1
  27. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +55 -55
  28. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  29. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +101 -56
  30. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +77 -51
  31. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  32. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +116 -94
  33. package/dest/contract_logging.d.ts +22 -0
  34. package/dest/contract_logging.d.ts.map +1 -0
  35. package/dest/contract_logging.js +23 -0
  36. package/dest/contract_sync/contract_sync_service.d.ts +43 -0
  37. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  38. package/dest/contract_sync/contract_sync_service.js +97 -0
  39. package/dest/contract_sync/helpers.d.ts +29 -0
  40. package/dest/contract_sync/helpers.d.ts.map +1 -0
  41. package/dest/contract_sync/{index.js → helpers.js} +13 -12
  42. package/dest/debug/pxe_debug_utils.d.ts +14 -10
  43. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  44. package/dest/debug/pxe_debug_utils.js +16 -15
  45. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  46. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  47. package/dest/entrypoints/client/bundle/index.js +3 -0
  48. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  49. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  50. package/dest/entrypoints/client/bundle/utils.js +21 -7
  51. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  52. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  53. package/dest/entrypoints/client/lazy/index.js +3 -0
  54. package/dest/entrypoints/client/lazy/utils.d.ts +2 -2
  55. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  56. package/dest/entrypoints/client/lazy/utils.js +22 -8
  57. package/dest/entrypoints/pxe_creation_options.d.ts +3 -2
  58. package/dest/entrypoints/pxe_creation_options.d.ts.map +1 -1
  59. package/dest/entrypoints/server/index.d.ts +4 -2
  60. package/dest/entrypoints/server/index.d.ts.map +1 -1
  61. package/dest/entrypoints/server/index.js +3 -1
  62. package/dest/entrypoints/server/utils.d.ts +1 -1
  63. package/dest/entrypoints/server/utils.d.ts.map +1 -1
  64. package/dest/entrypoints/server/utils.js +28 -9
  65. package/dest/events/event_service.d.ts +4 -5
  66. package/dest/events/event_service.d.ts.map +1 -1
  67. package/dest/events/event_service.js +5 -6
  68. package/dest/job_coordinator/job_coordinator.d.ts +3 -2
  69. package/dest/job_coordinator/job_coordinator.d.ts.map +1 -1
  70. package/dest/job_coordinator/job_coordinator.js +3 -2
  71. package/dest/logs/log_service.d.ts +7 -5
  72. package/dest/logs/log_service.d.ts.map +1 -1
  73. package/dest/logs/log_service.js +19 -29
  74. package/dest/notes/note_service.d.ts +7 -7
  75. package/dest/notes/note_service.d.ts.map +1 -1
  76. package/dest/notes/note_service.js +9 -9
  77. package/dest/notes_filter.d.ts +25 -0
  78. package/dest/notes_filter.d.ts.map +1 -0
  79. package/dest/notes_filter.js +4 -0
  80. package/dest/oracle_version.d.ts +3 -3
  81. package/dest/oracle_version.d.ts.map +1 -1
  82. package/dest/oracle_version.js +3 -3
  83. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  84. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  85. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  86. package/dest/private_kernel/hints/index.d.ts +1 -1
  87. package/dest/private_kernel/hints/index.js +1 -1
  88. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  89. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  90. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  91. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  92. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  93. package/dest/private_kernel/hints/test_utils.js +203 -0
  94. package/dest/private_kernel/private_kernel_execution_prover.d.ts +3 -2
  95. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  96. package/dest/private_kernel/private_kernel_execution_prover.js +21 -13
  97. package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
  98. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  99. package/dest/private_kernel/private_kernel_oracle.js +7 -3
  100. package/dest/pxe.d.ts +71 -24
  101. package/dest/pxe.d.ts.map +1 -1
  102. package/dest/pxe.js +104 -66
  103. package/dest/storage/address_store/address_store.d.ts +1 -1
  104. package/dest/storage/address_store/address_store.d.ts.map +1 -1
  105. package/dest/storage/address_store/address_store.js +12 -11
  106. package/dest/storage/anchor_block_store/anchor_block_store.d.ts +9 -1
  107. package/dest/storage/anchor_block_store/anchor_block_store.d.ts.map +1 -1
  108. package/dest/storage/anchor_block_store/anchor_block_store.js +8 -1
  109. package/dest/storage/capsule_store/capsule_store.js +6 -8
  110. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  111. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  112. package/dest/storage/contract_store/contract_store.js +157 -72
  113. package/dest/storage/metadata.d.ts +1 -1
  114. package/dest/storage/metadata.js +1 -1
  115. package/dest/storage/note_store/note_store.d.ts +13 -3
  116. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  117. package/dest/storage/note_store/note_store.js +147 -107
  118. package/dest/storage/private_event_store/private_event_store.d.ts +1 -1
  119. package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
  120. package/dest/storage/private_event_store/private_event_store.js +84 -61
  121. package/dest/storage/private_event_store/stored_private_event.js +1 -1
  122. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  123. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  124. package/dest/storage/tagging_store/recipient_tagging_store.js +31 -19
  125. package/dest/storage/tagging_store/sender_address_book_store.d.ts +1 -1
  126. package/dest/storage/tagging_store/sender_address_book_store.d.ts.map +1 -1
  127. package/dest/storage/tagging_store/sender_address_book_store.js +20 -14
  128. package/dest/storage/tagging_store/sender_tagging_store.d.ts +5 -5
  129. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  130. package/dest/storage/tagging_store/sender_tagging_store.js +184 -114
  131. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  132. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  133. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  134. package/dest/tagging/index.d.ts +2 -2
  135. package/dest/tagging/index.d.ts.map +1 -1
  136. package/dest/tagging/index.js +1 -1
  137. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
  138. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  139. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +7 -7
  140. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  141. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
  142. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  143. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
  144. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
  145. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  146. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +3 -6
  147. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +4 -7
  148. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  149. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +14 -15
  150. package/package.json +25 -16
  151. package/src/access_scopes.ts +9 -0
  152. package/src/block_synchronizer/block_synchronizer.ts +21 -12
  153. package/src/config/index.ts +1 -1
  154. package/src/config/package_info.ts +1 -1
  155. package/src/contract_function_simulator/contract_function_simulator.ts +326 -131
  156. package/src/contract_function_simulator/execution_tagging_index_cache.ts +5 -5
  157. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +1 -1
  158. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +1 -1
  159. package/src/contract_function_simulator/oracle/interfaces.ts +53 -50
  160. package/src/contract_function_simulator/oracle/oracle.ts +157 -112
  161. package/src/contract_function_simulator/oracle/private_execution.ts +1 -1
  162. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +127 -137
  163. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +167 -105
  164. package/src/contract_logging.ts +39 -0
  165. package/src/contract_sync/contract_sync_service.ts +152 -0
  166. package/src/contract_sync/{index.ts → helpers.ts} +21 -21
  167. package/src/debug/pxe_debug_utils.ts +48 -18
  168. package/src/entrypoints/client/bundle/index.ts +3 -0
  169. package/src/entrypoints/client/bundle/utils.ts +16 -15
  170. package/src/entrypoints/client/lazy/index.ts +3 -0
  171. package/src/entrypoints/client/lazy/utils.ts +17 -15
  172. package/src/entrypoints/pxe_creation_options.ts +2 -1
  173. package/src/entrypoints/server/index.ts +3 -1
  174. package/src/entrypoints/server/utils.ts +22 -26
  175. package/src/events/event_service.ts +4 -6
  176. package/src/job_coordinator/job_coordinator.ts +4 -3
  177. package/src/logs/log_service.ts +31 -38
  178. package/src/notes/note_service.ts +9 -10
  179. package/src/notes_filter.ts +26 -0
  180. package/src/oracle_version.ts +3 -3
  181. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  182. package/src/private_kernel/hints/index.ts +1 -1
  183. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  184. package/src/private_kernel/hints/test_utils.ts +325 -0
  185. package/src/private_kernel/private_kernel_execution_prover.ts +25 -15
  186. package/src/private_kernel/private_kernel_oracle.ts +7 -7
  187. package/src/pxe.ts +197 -118
  188. package/src/storage/address_store/address_store.ts +15 -15
  189. package/src/storage/anchor_block_store/anchor_block_store.ts +8 -0
  190. package/src/storage/capsule_store/capsule_store.ts +8 -8
  191. package/src/storage/contract_store/contract_store.ts +186 -76
  192. package/src/storage/metadata.ts +1 -1
  193. package/src/storage/note_store/note_store.ts +169 -132
  194. package/src/storage/private_event_store/private_event_store.ts +102 -81
  195. package/src/storage/private_event_store/stored_private_event.ts +1 -1
  196. package/src/storage/tagging_store/recipient_tagging_store.ts +38 -24
  197. package/src/storage/tagging_store/sender_address_book_store.ts +20 -14
  198. package/src/storage/tagging_store/sender_tagging_store.ts +214 -130
  199. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  200. package/src/tagging/index.ts +1 -1
  201. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +7 -10
  202. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  203. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
  204. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +4 -9
  205. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +11 -20
  206. package/dest/contract_sync/index.d.ts +0 -23
  207. package/dest/contract_sync/index.d.ts.map +0 -1
  208. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  209. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
@@ -1,11 +1,12 @@
1
1
  import { Aes128 } from '@aztec/foundation/crypto/aes128';
2
2
  import { Fr } from '@aztec/foundation/curves/bn254';
3
- import { LogLevels, applyStringFormatting, createLogger } from '@aztec/foundation/log';
3
+ import { LogLevels, createLogger } from '@aztec/foundation/log';
4
4
  import { siloNullifier } from '@aztec/stdlib/hash';
5
5
  import { computeAddressSecret } from '@aztec/stdlib/keys';
6
6
  import { deriveEcdhSharedSecret } from '@aztec/stdlib/logs';
7
7
  import { getNonNullifiedL1ToL2MessageWitness } from '@aztec/stdlib/messaging';
8
8
  import { MerkleTreeId } from '@aztec/stdlib/trees';
9
+ import { createContractLogger, logContractMessage } from '../../contract_logging.js';
9
10
  import { EventService } from '../../events/event_service.js';
10
11
  import { LogService } from '../../logs/log_service.js';
11
12
  import { NoteService } from '../../notes/note_service.js';
@@ -20,6 +21,9 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
20
21
  /**
21
22
  * The oracle for an execution of utility contract functions.
22
23
  */ export class UtilityExecutionOracle {
24
+ isMisc = true;
25
+ isUtility = true;
26
+ contractLogger;
23
27
  contractAddress;
24
28
  authWitnesses;
25
29
  capsules;
@@ -29,48 +33,40 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
29
33
  keyStore;
30
34
  addressStore;
31
35
  aztecNode;
32
- anchorBlockStore;
33
36
  recipientTaggingStore;
34
37
  senderAddressBookStore;
35
38
  capsuleStore;
36
39
  privateEventStore;
37
40
  jobId;
38
- log;
41
+ logger;
39
42
  scopes;
40
- isMisc;
41
- isUtility;
42
- aztecNrDebugLog;
43
- constructor(contractAddress, /** List of transient auth witnesses to be used during this simulation */ authWitnesses, capsules, anchorBlockHeader, contractStore, noteStore, keyStore, addressStore, aztecNode, anchorBlockStore, recipientTaggingStore, senderAddressBookStore, capsuleStore, privateEventStore, jobId, log = createLogger('simulator:client_view_context'), scopes){
44
- this.contractAddress = contractAddress;
45
- this.authWitnesses = authWitnesses;
46
- this.capsules = capsules;
47
- this.anchorBlockHeader = anchorBlockHeader;
48
- this.contractStore = contractStore;
49
- this.noteStore = noteStore;
50
- this.keyStore = keyStore;
51
- this.addressStore = addressStore;
52
- this.aztecNode = aztecNode;
53
- this.anchorBlockStore = anchorBlockStore;
54
- this.recipientTaggingStore = recipientTaggingStore;
55
- this.senderAddressBookStore = senderAddressBookStore;
56
- this.capsuleStore = capsuleStore;
57
- this.privateEventStore = privateEventStore;
58
- this.jobId = jobId;
59
- this.log = log;
60
- this.scopes = scopes;
61
- this.isMisc = true;
62
- this.isUtility = true;
63
- this.aztecNrDebugLog = createLogger('aztec-nr:debug_log');
43
+ constructor(args){
44
+ this.contractAddress = args.contractAddress;
45
+ this.authWitnesses = args.authWitnesses;
46
+ this.capsules = args.capsules;
47
+ this.anchorBlockHeader = args.anchorBlockHeader;
48
+ this.contractStore = args.contractStore;
49
+ this.noteStore = args.noteStore;
50
+ this.keyStore = args.keyStore;
51
+ this.addressStore = args.addressStore;
52
+ this.aztecNode = args.aztecNode;
53
+ this.recipientTaggingStore = args.recipientTaggingStore;
54
+ this.senderAddressBookStore = args.senderAddressBookStore;
55
+ this.capsuleStore = args.capsuleStore;
56
+ this.privateEventStore = args.privateEventStore;
57
+ this.jobId = args.jobId;
58
+ this.logger = args.log ?? createLogger('simulator:client_view_context');
59
+ this.scopes = args.scopes;
64
60
  }
65
- utilityAssertCompatibleOracleVersion(version) {
61
+ assertCompatibleOracleVersion(version) {
66
62
  if (version !== ORACLE_VERSION) {
67
63
  throw new Error(`Incompatible oracle version. Expected version ${ORACLE_VERSION}, got ${version}.`);
68
64
  }
69
65
  }
70
- utilityGetRandomField() {
66
+ getRandomField() {
71
67
  return Fr.random();
72
68
  }
73
- utilityGetUtilityContext() {
69
+ getUtilityContext() {
74
70
  return new UtilityContext(this.anchorBlockHeader, this.contractAddress);
75
71
  }
76
72
  /**
@@ -78,31 +74,50 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
78
74
  * @param pkMHash - The master public key hash.
79
75
  * @returns A Promise that resolves to nullifier keys.
80
76
  * @throws If the keys are not registered in the key store.
81
- */ utilityGetKeyValidationRequest(pkMHash) {
77
+ * @throws If scopes are defined and the account is not in the scopes.
78
+ */ async getKeyValidationRequest(pkMHash) {
79
+ // If scopes are defined, check that the key belongs to an account in the scopes.
80
+ if (this.scopes !== 'ALL_SCOPES' && this.scopes.length > 0) {
81
+ let hasAccess = false;
82
+ for(let i = 0; i < this.scopes.length && !hasAccess; i++){
83
+ if (await this.keyStore.accountHasKey(this.scopes[i], pkMHash)) {
84
+ hasAccess = true;
85
+ }
86
+ }
87
+ if (!hasAccess) {
88
+ throw new Error(`Key validation request denied: no scoped account has a key with hash ${pkMHash.toString()}.`);
89
+ }
90
+ }
82
91
  return this.keyStore.getKeyValidationRequest(pkMHash, this.contractAddress);
83
92
  }
84
93
  /**
85
94
  * Fetches the index and sibling path of a leaf at a given block from the note hash tree.
86
- * @param blockHash - The block hash at which to get the membership witness.
87
- * @param leafValue - The leaf value
95
+ * @param anchorBlockHash - The hash of a block that contains the note hash tree root in which to find the membership
96
+ * witness.
97
+ * @param noteHash - The note hash to find in the note hash tree.
88
98
  * @returns The membership witness containing the leaf index and sibling path
89
- */ utilityGetNoteHashMembershipWitness(blockHash, leafValue) {
90
- return this.aztecNode.getNoteHashMembershipWitness(blockHash, leafValue);
99
+ */ getNoteHashMembershipWitness(anchorBlockHash, noteHash) {
100
+ return this.aztecNode.getNoteHashMembershipWitness(anchorBlockHash, noteHash);
91
101
  }
92
102
  /**
93
- * Fetches the index and sibling path of a leaf at a given block from the archive tree.
94
- * @param blockHash - The block hash at which to get the membership witness.
95
- * @param leafValue - The leaf value
103
+ * Fetches the index and sibling path of a block hash in the archive tree.
104
+ *
105
+ * Block hashes are the leaves of the archive tree. Each time a new block is added to the chain,
106
+ * its block hash is appended as a new leaf to the archive tree.
107
+ *
108
+ * @param anchorBlockHash - The hash of a block that contains the archive tree root in which to find the membership
109
+ * witness.
110
+ * @param blockHash - The block hash to find in the archive tree.
96
111
  * @returns The membership witness containing the leaf index and sibling path
97
- */ utilityGetArchiveMembershipWitness(blockHash, leafValue) {
98
- return this.aztecNode.getArchiveMembershipWitness(blockHash, leafValue);
112
+ */ getBlockHashMembershipWitness(anchorBlockHash, blockHash) {
113
+ return this.aztecNode.getBlockHashMembershipWitness(anchorBlockHash, blockHash);
99
114
  }
100
115
  /**
101
116
  * Returns a nullifier membership witness for a given nullifier at a given block.
102
117
  * @param blockHash - The block hash at which to get the index.
103
118
  * @param nullifier - Nullifier we try to find witness for.
104
119
  * @returns The nullifier membership witness (if found).
105
- */ utilityGetNullifierMembershipWitness(blockHash, nullifier) {
120
+ */ getNullifierMembershipWitness(blockHash, nullifier) {
106
121
  return this.aztecNode.getNullifierMembershipWitness(blockHash, nullifier);
107
122
  }
108
123
  /**
@@ -113,7 +128,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
113
128
  * @remarks Low nullifier witness can be used to perform a nullifier non-inclusion proof by leveraging the "linked
114
129
  * list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
115
130
  * we are trying to prove non-inclusion for.
116
- */ utilityGetLowNullifierMembershipWitness(blockHash, nullifier) {
131
+ */ getLowNullifierMembershipWitness(blockHash, nullifier) {
117
132
  return this.aztecNode.getLowNullifierMembershipWitness(blockHash, nullifier);
118
133
  }
119
134
  /**
@@ -121,15 +136,15 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
121
136
  * @param blockHash - The block hash at which to get the index.
122
137
  * @param leafSlot - The slot of the public data tree to get the witness for.
123
138
  * @returns - The witness
124
- */ utilityGetPublicDataWitness(blockHash, leafSlot) {
139
+ */ getPublicDataWitness(blockHash, leafSlot) {
125
140
  return this.aztecNode.getPublicDataWitness(blockHash, leafSlot);
126
141
  }
127
142
  /**
128
143
  * Fetches a block header of a given block.
129
144
  * @param blockNumber - The number of a block of which to get the block header.
130
145
  * @returns Block extracted from a block with block number `blockNumber`.
131
- */ async utilityGetBlockHeader(blockNumber) {
132
- const anchorBlockNumber = (await this.anchorBlockStore.getBlockHeader()).getBlockNumber();
146
+ */ async getBlockHeader(blockNumber) {
147
+ const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
133
148
  if (blockNumber > anchorBlockNumber) {
134
149
  throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
135
150
  }
@@ -137,14 +152,20 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
137
152
  return block?.header;
138
153
  }
139
154
  /**
140
- * Retrieve the complete address associated to a given address.
155
+ * Retrieve the public keys and partial address associated to a given address.
141
156
  * @param account - The account address.
142
- * @returns A complete address associated with the input address.
143
- * @throws An error if the account is not registered in the database.
144
- */ utilityGetPublicKeysAndPartialAddress(account) {
145
- return this.getCompleteAddress(account);
157
+ * @returns The public keys and partial address, or `undefined` if the account is not registered.
158
+ */ async tryGetPublicKeysAndPartialAddress(account) {
159
+ const completeAddress = await this.addressStore.getCompleteAddress(account);
160
+ if (!completeAddress) {
161
+ return undefined;
162
+ }
163
+ return {
164
+ publicKeys: completeAddress.publicKeys,
165
+ partialAddress: completeAddress.partialAddress
166
+ };
146
167
  }
147
- async getCompleteAddress(account) {
168
+ async getCompleteAddressOrFail(account) {
148
169
  const completeAddress = await this.addressStore.getCompleteAddress(account);
149
170
  if (!completeAddress) {
150
171
  throw new Error(`No public key registered for address ${account}.
@@ -156,10 +177,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
156
177
  * Returns a contract instance associated with an address or throws if not found.
157
178
  * @param address - Address.
158
179
  * @returns A contract instance.
159
- */ utilityGetContractInstance(address) {
160
- return this.getContractInstance(address);
161
- }
162
- async getContractInstance(address) {
180
+ */ async getContractInstance(address) {
163
181
  const instance = await this.contractStore.getContractInstance(address);
164
182
  if (!instance) {
165
183
  throw new Error(`No contract instance found for address ${address.toString()}`);
@@ -171,7 +189,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
171
189
  * for this transaction first, and falls back to the local database if not found.
172
190
  * @param messageHash - Hash of the message to authenticate.
173
191
  * @returns Authentication witness for the requested message hash.
174
- */ utilityGetAuthWitness(messageHash) {
192
+ */ getAuthWitness(messageHash) {
175
193
  return Promise.resolve(this.authWitnesses.find((w)=>w.requestHash.equals(messageHash))?.witness);
176
194
  }
177
195
  /**
@@ -195,8 +213,8 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
195
213
  * @param offset - The starting index for pagination.
196
214
  * @param status - The status of notes to fetch.
197
215
  * @returns Array of note data.
198
- */ async utilityGetNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status) {
199
- const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore, this.jobId);
216
+ */ async getNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status) {
217
+ const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
200
218
  const dbNotes = await noteService.getNotes(this.contractAddress, owner, storageSlot, status, this.scopes);
201
219
  return pickNotes(dbNotes, {
202
220
  selects: selectByIndexes.slice(0, numSelects).map((index, i)=>({
@@ -224,9 +242,12 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
224
242
  * Check if a nullifier exists in the nullifier tree.
225
243
  * @param innerNullifier - The inner nullifier.
226
244
  * @returns A boolean indicating whether the nullifier exists in the tree or not.
227
- */ async utilityCheckNullifierExists(innerNullifier) {
228
- const nullifier = await siloNullifier(this.contractAddress, innerNullifier);
229
- const [leafIndex] = await this.aztecNode.findLeavesIndexes('latest', MerkleTreeId.NULLIFIER_TREE, [
245
+ */ async checkNullifierExists(innerNullifier) {
246
+ const [nullifier, anchorBlockHash] = await Promise.all([
247
+ siloNullifier(this.contractAddress, innerNullifier),
248
+ this.anchorBlockHeader.hash()
249
+ ]);
250
+ const [leafIndex] = await this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, [
230
251
  nullifier
231
252
  ]);
232
253
  return leafIndex?.data !== undefined;
@@ -238,7 +259,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
238
259
  * @param secret - Secret used to compute a nullifier.
239
260
  * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
240
261
  * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
241
- */ async utilityGetL1ToL2MembershipWitness(contractAddress, messageHash, secret) {
262
+ */ async getL1ToL2MembershipWitness(contractAddress, messageHash, secret) {
242
263
  const [messageIndex, siblingPath] = await getNonNullifiedL1ToL2MessageWitness(this.aztecNode, contractAddress, messageHash, secret);
243
264
  return new MessageLoadOracleInputs(messageIndex, siblingPath);
244
265
  }
@@ -248,30 +269,34 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
248
269
  * @param contractAddress - The address to read storage from.
249
270
  * @param startStorageSlot - The starting storage slot.
250
271
  * @param numberOfElements - Number of elements to read from the starting storage slot.
251
- */ async utilityStorageRead(blockHash, contractAddress, startStorageSlot, numberOfElements) {
272
+ */ async storageRead(blockHash, contractAddress, startStorageSlot, numberOfElements) {
252
273
  const slots = Array(numberOfElements).fill(0).map((_, i)=>new Fr(startStorageSlot.value + BigInt(i)));
253
274
  const values = await Promise.all(slots.map((storageSlot)=>this.aztecNode.getPublicStorageAt(blockHash, contractAddress, storageSlot)));
254
- this.log.debug(`Oracle storage read: slots=[${slots.map((slot)=>slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`);
275
+ this.logger.debug(`Oracle storage read: slots=[${slots.map((slot)=>slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`);
255
276
  return values;
256
277
  }
257
- utilityDebugLog(level, message, fields) {
278
+ /**
279
+ * Returns a per-contract logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
280
+ */ async #getContractLogger() {
281
+ if (!this.contractLogger) {
282
+ // Purpose of instanceId is to distinguish logs from different instances of the same component. It makes sense
283
+ // to re-use jobId as instanceId here as executions of different PXE jobs are isolated.
284
+ this.contractLogger = await createContractLogger(this.contractAddress, (addr)=>this.contractStore.getDebugContractName(addr), {
285
+ instanceId: this.jobId
286
+ });
287
+ }
288
+ return this.contractLogger;
289
+ }
290
+ async log(level, message, fields) {
258
291
  if (!LogLevels[level]) {
259
- throw new Error(`Invalid debug log level: ${level}`);
292
+ throw new Error(`Invalid log level: ${level}`);
260
293
  }
261
- const levelName = LogLevels[level];
262
- this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
294
+ const logger = await this.#getContractLogger();
295
+ logContractMessage(logger, LogLevels[level], message, fields);
263
296
  }
264
- async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot) {
265
- const logService = new LogService(this.aztecNode, this.anchorBlockStore, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId);
266
- const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore, this.jobId);
267
- // It is acceptable to run the following operations in parallel for several reasons:
268
- // 1. syncTaggedLogs does not write to the note store — it only stores the pending tagged logs in a capsule array,
269
- // which is then processed in Noir after this handler returns.
270
- // 2. Even if syncTaggedLogs did write to the note store, it would not cause inconsistent state.
271
- await Promise.all([
272
- logService.syncTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes),
273
- noteService.syncNoteNullifiers(this.contractAddress)
274
- ]);
297
+ async fetchTaggedLogs(pendingTaggedLogArrayBaseSlot) {
298
+ const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.logger.getBindings());
299
+ await logService.fetchTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
275
300
  }
276
301
  /**
277
302
  * Validates all note and event validation requests enqueued via `enqueue_note_for_validation` and
@@ -282,7 +307,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
282
307
  * @param contractAddress - The address of the contract that the logs are tagged for.
283
308
  * @param noteValidationRequestsArrayBaseSlot - The base slot of capsule array containing note validation requests.
284
309
  * @param eventValidationRequestsArrayBaseSlot - The base slot of capsule array containing event validation requests.
285
- */ async utilityValidateAndStoreEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot) {
310
+ */ async validateAndStoreEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot) {
286
311
  // TODO(#10727): allow other contracts to store notes
287
312
  if (!this.contractAddress.equals(contractAddress)) {
288
313
  throw new Error(`Got a note validation request from ${contractAddress}, expected ${this.contractAddress}`);
@@ -291,9 +316,9 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
291
316
  // faster as we don't need to wait for the network round-trip.
292
317
  const noteValidationRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, this.jobId)).map(NoteValidationRequest.fromFields);
293
318
  const eventValidationRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, this.jobId)).map(EventValidationRequest.fromFields);
294
- const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore, this.jobId);
319
+ const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
295
320
  const noteStorePromises = noteValidationRequests.map((request)=>noteService.validateAndStoreNote(request.contractAddress, request.owner, request.storageSlot, request.randomness, request.noteNonce, request.content, request.noteHash, request.nullifier, request.txHash, request.recipient));
296
- const eventService = new EventService(this.anchorBlockStore, this.aztecNode, this.privateEventStore, this.jobId);
321
+ const eventService = new EventService(this.anchorBlockHeader, this.aztecNode, this.privateEventStore, this.jobId);
297
322
  const eventStorePromises = eventValidationRequests.map((request)=>eventService.validateAndStoreEvent(request.contractAddress, request.eventTypeId, request.randomness, request.serializedEvent, request.eventCommitment, request.txHash, request.recipient));
298
323
  await Promise.all([
299
324
  ...noteStorePromises,
@@ -303,7 +328,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
303
328
  await this.capsuleStore.setCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, [], this.jobId);
304
329
  await this.capsuleStore.setCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, [], this.jobId);
305
330
  }
306
- async utilityBulkRetrieveLogs(contractAddress, logRetrievalRequestsArrayBaseSlot, logRetrievalResponsesArrayBaseSlot) {
331
+ async bulkRetrieveLogs(contractAddress, logRetrievalRequestsArrayBaseSlot, logRetrievalResponsesArrayBaseSlot) {
307
332
  // TODO(#10727): allow other contracts to process partial notes
308
333
  if (!this.contractAddress.equals(contractAddress)) {
309
334
  throw new Error(`Got a note validation request from ${contractAddress}, expected ${this.contractAddress}`);
@@ -311,14 +336,14 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
311
336
  // We read all log retrieval requests and process them all concurrently. This makes the process much faster as we
312
337
  // don't need to wait for the network round-trip.
313
338
  const logRetrievalRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, this.jobId)).map(LogRetrievalRequest.fromFields);
314
- const logService = new LogService(this.aztecNode, this.anchorBlockStore, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId);
339
+ const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.logger.getBindings());
315
340
  const maybeLogRetrievalResponses = await logService.bulkRetrieveLogs(logRetrievalRequests);
316
341
  // Requests are cleared once we're done.
317
342
  await this.capsuleStore.setCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, [], this.jobId);
318
343
  // The responses are stored as Option<LogRetrievalResponse> in a second CapsuleArray.
319
344
  await this.capsuleStore.setCapsuleArray(contractAddress, logRetrievalResponsesArrayBaseSlot, maybeLogRetrievalResponses.map(LogRetrievalResponse.toSerializedOption), this.jobId);
320
345
  }
321
- utilityStoreCapsule(contractAddress, slot, capsule) {
346
+ storeCapsule(contractAddress, slot, capsule) {
322
347
  if (!contractAddress.equals(this.contractAddress)) {
323
348
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
324
349
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -326,7 +351,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
326
351
  this.capsuleStore.storeCapsule(this.contractAddress, slot, capsule, this.jobId);
327
352
  return Promise.resolve();
328
353
  }
329
- async utilityLoadCapsule(contractAddress, slot) {
354
+ async loadCapsule(contractAddress, slot) {
330
355
  if (!contractAddress.equals(this.contractAddress)) {
331
356
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
332
357
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -334,7 +359,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
334
359
  return(// TODO(#12425): On the following line, the pertinent capsule gets overshadowed by the transient one. Tackle this.
335
360
  this.capsules.find((c)=>c.contractAddress.equals(contractAddress) && c.storageSlot.equals(slot))?.data ?? await this.capsuleStore.loadCapsule(this.contractAddress, slot, this.jobId));
336
361
  }
337
- utilityDeleteCapsule(contractAddress, slot) {
362
+ deleteCapsule(contractAddress, slot) {
338
363
  if (!contractAddress.equals(this.contractAddress)) {
339
364
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
340
365
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -342,7 +367,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
342
367
  this.capsuleStore.deleteCapsule(this.contractAddress, slot, this.jobId);
343
368
  return Promise.resolve();
344
369
  }
345
- utilityCopyCapsule(contractAddress, srcSlot, dstSlot, numEntries) {
370
+ copyCapsule(contractAddress, srcSlot, dstSlot, numEntries) {
346
371
  if (!contractAddress.equals(this.contractAddress)) {
347
372
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
348
373
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -350,7 +375,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
350
375
  return this.capsuleStore.copyCapsule(this.contractAddress, srcSlot, dstSlot, numEntries, this.jobId);
351
376
  }
352
377
  // TODO(#11849): consider replacing this oracle with a pure Noir implementation of aes decryption.
353
- utilityAes128Decrypt(ciphertext, iv, symKey) {
378
+ aes128Decrypt(ciphertext, iv, symKey) {
354
379
  const aes128 = new Aes128();
355
380
  return aes128.decryptBufferCBC(ciphertext, iv, symKey);
356
381
  }
@@ -359,12 +384,9 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
359
384
  * @param address - The address to get the secret for.
360
385
  * @param ephPk - The ephemeral public key to get the secret for.
361
386
  * @returns The secret for the given address.
362
- */ utilityGetSharedSecret(address, ephPk) {
363
- return this.getSharedSecret(address, ephPk);
364
- }
365
- async getSharedSecret(address, ephPk) {
387
+ */ async getSharedSecret(address, ephPk) {
366
388
  // TODO(#12656): return an app-siloed secret
367
- const recipientCompleteAddress = await this.getCompleteAddress(address);
389
+ const recipientCompleteAddress = await this.getCompleteAddressOrFail(address);
368
390
  const ivskM = await this.keyStore.getMasterSecretKey(recipientCompleteAddress.publicKeys.masterIncomingViewingPublicKey);
369
391
  const addressSecret = await computeAddressSecret(await recipientCompleteAddress.getPreaddress(), ivskM);
370
392
  return deriveEcdhSharedSecret(addressSecret, ephPk);
@@ -0,0 +1,22 @@
1
+ import type { Fr } from '@aztec/foundation/curves/bn254';
2
+ import { type LogLevel, type Logger } from '@aztec/foundation/log';
3
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
4
+ import type { DebugLog } from '@aztec/stdlib/logs';
5
+ /** Resolves a contract address to a human-readable name, if available. */
6
+ export type ContractNameResolver = (address: AztecAddress) => Promise<string | undefined>;
7
+ /**
8
+ * Creates a logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
9
+ */
10
+ export declare function createContractLogger(contractAddress: AztecAddress, getContractName: ContractNameResolver, options?: {
11
+ instanceId?: string;
12
+ }): Promise<Logger>;
13
+ /**
14
+ * Formats and emits a single contract log message through the given logger.
15
+ */
16
+ export declare function logContractMessage(logger: Logger, level: LogLevel, message: string, fields: Fr[]): void;
17
+ /**
18
+ * Displays debug logs collected during public function simulation,
19
+ * using the `contract_log::` prefixed logger format.
20
+ */
21
+ export declare function displayDebugLogs(debugLogs: DebugLog[], getContractName: ContractNameResolver): Promise<void>;
22
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3RfbG9nZ2luZy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnRyYWN0X2xvZ2dpbmcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsRUFBRSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDekQsT0FBTyxFQUFFLEtBQUssUUFBUSxFQUFFLEtBQUssTUFBTSxFQUF1QyxNQUFNLHVCQUF1QixDQUFDO0FBQ3hHLE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBQ2hFLE9BQU8sS0FBSyxFQUFFLFFBQVEsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBRW5ELDBFQUEwRTtBQUMxRSxNQUFNLE1BQU0sb0JBQW9CLEdBQUcsQ0FBQyxPQUFPLEVBQUUsWUFBWSxLQUFLLE9BQU8sQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLENBQUM7QUFFMUY7O0dBRUc7QUFDSCx3QkFBc0Isb0JBQW9CLENBQ3hDLGVBQWUsRUFBRSxZQUFZLEVBQzdCLGVBQWUsRUFBRSxvQkFBb0IsRUFDckMsT0FBTyxDQUFDLEVBQUU7SUFBRSxVQUFVLENBQUMsRUFBRSxNQUFNLENBQUE7Q0FBRSxHQUNoQyxPQUFPLENBQUMsTUFBTSxDQUFDLENBS2pCO0FBRUQ7O0dBRUc7QUFDSCx3QkFBZ0Isa0JBQWtCLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxLQUFLLEVBQUUsUUFBUSxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLEVBQUUsRUFBRSxHQUFHLElBQUksQ0FFdkc7QUFFRDs7O0dBR0c7QUFDSCx3QkFBc0IsZ0JBQWdCLENBQUMsU0FBUyxFQUFFLFFBQVEsRUFBRSxFQUFFLGVBQWUsRUFBRSxvQkFBb0IsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBS2xIIn0=
@@ -0,0 +1 @@
1
+ {"version":3,"file":"contract_logging.d.ts","sourceRoot":"","sources":["../src/contract_logging.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,MAAM,EAAuC,MAAM,uBAAuB,CAAC;AACxG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnD,0EAA0E;AAC1E,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;AAE1F;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,eAAe,EAAE,YAAY,EAC7B,eAAe,EAAE,oBAAoB,EACrC,OAAO,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GAChC,OAAO,CAAC,MAAM,CAAC,CAKjB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAEvG;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,eAAe,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAKlH"}
@@ -0,0 +1,23 @@
1
+ import { applyStringFormatting, createLogger } from '@aztec/foundation/log';
2
+ /**
3
+ * Creates a logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
4
+ */ export async function createContractLogger(contractAddress, getContractName, options) {
5
+ const addrAbbrev = contractAddress.toString().slice(0, 10);
6
+ const name = await getContractName(contractAddress);
7
+ const module = name ? `contract_log::${name}(${addrAbbrev})` : `contract_log::Unknown(${addrAbbrev})`;
8
+ return createLogger(module, options);
9
+ }
10
+ /**
11
+ * Formats and emits a single contract log message through the given logger.
12
+ */ export function logContractMessage(logger, level, message, fields) {
13
+ logger[level](applyStringFormatting(message, fields));
14
+ }
15
+ /**
16
+ * Displays debug logs collected during public function simulation,
17
+ * using the `contract_log::` prefixed logger format.
18
+ */ export async function displayDebugLogs(debugLogs, getContractName) {
19
+ for (const log of debugLogs){
20
+ const logger = await createContractLogger(log.contractAddress, getContractName);
21
+ logContractMessage(logger, log.level, log.message, log.fields);
22
+ }
23
+ }
@@ -0,0 +1,43 @@
1
+ import type { Logger } from '@aztec/foundation/log';
2
+ import type { FunctionCall, FunctionSelector } from '@aztec/stdlib/abi';
3
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
4
+ import type { AztecNode } from '@aztec/stdlib/interfaces/client';
5
+ import type { BlockHeader } from '@aztec/stdlib/tx';
6
+ import type { AccessScopes } from '../access_scopes.js';
7
+ import type { StagedStore } from '../job_coordinator/job_coordinator.js';
8
+ import type { ContractStore } from '../storage/contract_store/contract_store.js';
9
+ import type { NoteStore } from '../storage/note_store/note_store.js';
10
+ /**
11
+ * Service for syncing the private state of contracts and verifying that the PXE holds the current class artifact.
12
+ * It uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
13
+ *
14
+ * TODO: The StagedStore naming is broken here. Figure out a better name.
15
+ */
16
+ export declare class ContractSyncService implements StagedStore {
17
+ #private;
18
+ private aztecNode;
19
+ private contractStore;
20
+ private noteStore;
21
+ private log;
22
+ readonly storeName = "contract_sync";
23
+ private syncedContracts;
24
+ private overriddenContracts;
25
+ constructor(aztecNode: AztecNode, contractStore: ContractStore, noteStore: NoteStore, log: Logger);
26
+ /** Sets contracts that should be skipped during sync for a specific job. */
27
+ setOverriddenContracts(jobId: string, addresses: Set<string>): void;
28
+ /**
29
+ * Ensures a contract's private state is synchronized and that the PXE holds the current class artifact.
30
+ * Uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
31
+ * @param contractAddress - The address of the contract to sync.
32
+ * @param functionToInvokeAfterSync - The function selector that will be called after sync (used to validate it's
33
+ * not sync_state itself).
34
+ * @param utilityExecutor - Executor function for running the sync_state utility function.
35
+ * @param scopes - Access scopes to pass through to the utility executor (affects whose account's private state is discovered).
36
+ */
37
+ ensureContractSynced(contractAddress: AztecAddress, functionToInvokeAfterSync: FunctionSelector | null, utilityExecutor: (call: FunctionCall, scopes: AccessScopes) => Promise<any>, anchorBlockHeader: BlockHeader, jobId: string, scopes: AccessScopes): Promise<void>;
38
+ /** Clears sync cache. Called by BlockSynchronizer when anchor block changes. */
39
+ wipe(): void;
40
+ commit(jobId: string): Promise<void>;
41
+ discardStaged(jobId: string): Promise<void>;
42
+ }
43
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3Rfc3luY19zZXJ2aWNlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29udHJhY3Rfc3luYy9jb250cmFjdF9zeW5jX3NlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFDcEQsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLGdCQUFnQixFQUFFLE1BQU0sbUJBQW1CLENBQUM7QUFDeEUsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLE1BQU0sNkJBQTZCLENBQUM7QUFDaEUsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDakUsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFFcEQsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFDeEQsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0sdUNBQXVDLENBQUM7QUFDekUsT0FBTyxLQUFLLEVBQUUsYUFBYSxFQUFFLE1BQU0sNkNBQTZDLENBQUM7QUFDakYsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0scUNBQXFDLENBQUM7QUFHckU7Ozs7O0dBS0c7QUFDSCxxQkFBYSxtQkFBb0IsWUFBVyxXQUFXOztJQVluRCxPQUFPLENBQUMsU0FBUztJQUNqQixPQUFPLENBQUMsYUFBYTtJQUNyQixPQUFPLENBQUMsU0FBUztJQUNqQixPQUFPLENBQUMsR0FBRztJQWRiLFFBQVEsQ0FBQyxTQUFTLG1CQUFtQjtJQUtyQyxPQUFPLENBQUMsZUFBZSxDQUF5QztJQUdoRSxPQUFPLENBQUMsbUJBQW1CLENBQXVDO0lBRWxFLFlBQ1UsU0FBUyxFQUFFLFNBQVMsRUFDcEIsYUFBYSxFQUFFLGFBQWEsRUFDNUIsU0FBUyxFQUFFLFNBQVMsRUFDcEIsR0FBRyxFQUFFLE1BQU0sRUFDakI7SUFFSiw0RUFBNEU7SUFDNUUsc0JBQXNCLENBQUMsS0FBSyxFQUFFLE1BQU0sRUFBRSxTQUFTLEVBQUUsR0FBRyxDQUFDLE1BQU0sQ0FBQyxHQUFHLElBQUksQ0FFbEU7SUFFRDs7Ozs7Ozs7T0FRRztJQUNHLG9CQUFvQixDQUN4QixlQUFlLEVBQUUsWUFBWSxFQUM3Qix5QkFBeUIsRUFBRSxnQkFBZ0IsR0FBRyxJQUFJLEVBQ2xELGVBQWUsRUFBRSxDQUFDLElBQUksRUFBRSxZQUFZLEVBQUUsTUFBTSxFQUFFLFlBQVksS0FBSyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQzNFLGlCQUFpQixFQUFFLFdBQVcsRUFDOUIsS0FBSyxFQUFFLE1BQU0sRUFDYixNQUFNLEVBQUUsWUFBWSxHQUNuQixPQUFPLENBQUMsSUFBSSxDQUFDLENBdUNmO0lBNEJELGdGQUFnRjtJQUNoRixJQUFJLElBQUksSUFBSSxDQUdYO0lBRUQsTUFBTSxDQUFDLEtBQUssRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUluQztJQUVELGFBQWEsQ0FBQyxLQUFLLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FNMUM7Q0FDRiJ9
@@ -0,0 +1 @@
1
+ {"version":3,"file":"contract_sync_service.d.ts","sourceRoot":"","sources":["../../src/contract_sync/contract_sync_service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AACjF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAGrE;;;;;GAKG;AACH,qBAAa,mBAAoB,YAAW,WAAW;;IAYnD,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,GAAG;IAdb,QAAQ,CAAC,SAAS,mBAAmB;IAKrC,OAAO,CAAC,eAAe,CAAyC;IAGhE,OAAO,CAAC,mBAAmB,CAAuC;IAElE,YACU,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,aAAa,EAC5B,SAAS,EAAE,SAAS,EACpB,GAAG,EAAE,MAAM,EACjB;IAEJ,4EAA4E;IAC5E,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,CAElE;IAED;;;;;;;;OAQG;IACG,oBAAoB,CACxB,eAAe,EAAE,YAAY,EAC7B,yBAAyB,EAAE,gBAAgB,GAAG,IAAI,EAClD,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,GAAG,CAAC,EAC3E,iBAAiB,EAAE,WAAW,EAC9B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,YAAY,GACnB,OAAO,CAAC,IAAI,CAAC,CAuCf;IA4BD,gFAAgF;IAChF,IAAI,IAAI,IAAI,CAGX;IAED,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAInC;IAED,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAM1C;CACF"}
@@ -0,0 +1,97 @@
1
+ import { syncState, verifyCurrentClassId } from './helpers.js';
2
+ /**
3
+ * Service for syncing the private state of contracts and verifying that the PXE holds the current class artifact.
4
+ * It uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
5
+ *
6
+ * TODO: The StagedStore naming is broken here. Figure out a better name.
7
+ */ export class ContractSyncService {
8
+ aztecNode;
9
+ contractStore;
10
+ noteStore;
11
+ log;
12
+ storeName;
13
+ // Tracks contracts synced since last wipe. The cache is keyed per individual scope address
14
+ // (`contractAddress:scopeAddress`), or `contractAddress:*` for undefined scopes (all accounts).
15
+ // The value is a promise that resolves when the contract is synced.
16
+ syncedContracts;
17
+ // Per-job overridden contract addresses - these contracts should not be synced.
18
+ overriddenContracts;
19
+ constructor(aztecNode, contractStore, noteStore, log){
20
+ this.aztecNode = aztecNode;
21
+ this.contractStore = contractStore;
22
+ this.noteStore = noteStore;
23
+ this.log = log;
24
+ this.storeName = 'contract_sync';
25
+ this.syncedContracts = new Map();
26
+ this.overriddenContracts = new Map();
27
+ }
28
+ /** Sets contracts that should be skipped during sync for a specific job. */ setOverriddenContracts(jobId, addresses) {
29
+ this.overriddenContracts.set(jobId, addresses);
30
+ }
31
+ /**
32
+ * Ensures a contract's private state is synchronized and that the PXE holds the current class artifact.
33
+ * Uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
34
+ * @param contractAddress - The address of the contract to sync.
35
+ * @param functionToInvokeAfterSync - The function selector that will be called after sync (used to validate it's
36
+ * not sync_state itself).
37
+ * @param utilityExecutor - Executor function for running the sync_state utility function.
38
+ * @param scopes - Access scopes to pass through to the utility executor (affects whose account's private state is discovered).
39
+ */ async ensureContractSynced(contractAddress, functionToInvokeAfterSync, utilityExecutor, anchorBlockHeader, jobId, scopes) {
40
+ // Skip sync if this contract has an override for this job (overrides are keyed by contract address only)
41
+ const overrides = this.overriddenContracts.get(jobId);
42
+ if (overrides?.has(contractAddress.toString())) {
43
+ return;
44
+ }
45
+ // Skip sync if we already synced for "all scopes", or if we have an empty list of scopes
46
+ const allScopesKey = toKey(contractAddress, 'ALL_SCOPES');
47
+ const allScopesExisting = this.syncedContracts.get(allScopesKey);
48
+ if (allScopesExisting || scopes !== 'ALL_SCOPES' && scopes.length == 0) {
49
+ return;
50
+ }
51
+ const unsyncedScopes = scopes === 'ALL_SCOPES' ? scopes : scopes.filter((scope)=>!this.syncedContracts.has(toKey(contractAddress, scope)));
52
+ const unsyncedScopesKeys = toKeys(contractAddress, unsyncedScopes);
53
+ if (unsyncedScopesKeys.length > 0) {
54
+ // Start sync and store the promise for all unsynced scopes
55
+ const promise = this.#doSync(contractAddress, functionToInvokeAfterSync, utilityExecutor, anchorBlockHeader, jobId, unsyncedScopes).catch((err)=>{
56
+ // There was an error syncing the contract, so we remove it from the cache so that it can be retried.
57
+ unsyncedScopesKeys.forEach((key)=>this.syncedContracts.delete(key));
58
+ throw err;
59
+ });
60
+ unsyncedScopesKeys.forEach((key)=>this.syncedContracts.set(key, promise));
61
+ }
62
+ const promises = toKeys(contractAddress, scopes).map((key)=>this.syncedContracts.get(key));
63
+ await Promise.all(promises);
64
+ }
65
+ async #doSync(contractAddress, functionToInvokeAfterSync, utilityExecutor, anchorBlockHeader, jobId, scopes) {
66
+ this.log.debug(`Syncing contract ${contractAddress}`);
67
+ await Promise.all([
68
+ syncState(contractAddress, this.contractStore, functionToInvokeAfterSync, utilityExecutor, this.noteStore, this.aztecNode, anchorBlockHeader, jobId, scopes),
69
+ verifyCurrentClassId(contractAddress, this.aztecNode, this.contractStore, anchorBlockHeader)
70
+ ]);
71
+ this.log.debug(`Contract ${contractAddress} synced`);
72
+ }
73
+ /** Clears sync cache. Called by BlockSynchronizer when anchor block changes. */ wipe() {
74
+ this.log.debug(`Wiping contract sync cache (${this.syncedContracts.size} entries)`);
75
+ this.syncedContracts.clear();
76
+ }
77
+ commit(jobId) {
78
+ // Clear overridden contracts for this job
79
+ this.overriddenContracts.delete(jobId);
80
+ return Promise.resolve();
81
+ }
82
+ discardStaged(jobId) {
83
+ // We clear the synced contracts cache here because, when the job is discarded, any associated database writes from
84
+ // the sync are also undone.
85
+ this.syncedContracts.clear();
86
+ this.overriddenContracts.delete(jobId);
87
+ return Promise.resolve();
88
+ }
89
+ }
90
+ function toKeys(contract, scopes) {
91
+ return scopes === 'ALL_SCOPES' ? [
92
+ toKey(contract, scopes)
93
+ ] : scopes.map((scope)=>toKey(contract, scope));
94
+ }
95
+ function toKey(contract, scope) {
96
+ return scope === 'ALL_SCOPES' ? `${contract.toString()}:*` : `${contract.toString()}:${scope.toString()}`;
97
+ }