@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
@@ -1,11 +1,13 @@
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
+ import { isProtocolContract } from '@aztec/protocol-contracts';
4
5
  import { siloNullifier } from '@aztec/stdlib/hash';
5
6
  import { computeAddressSecret } from '@aztec/stdlib/keys';
6
7
  import { deriveEcdhSharedSecret } from '@aztec/stdlib/logs';
7
8
  import { getNonNullifiedL1ToL2MessageWitness } from '@aztec/stdlib/messaging';
8
9
  import { MerkleTreeId } from '@aztec/stdlib/trees';
10
+ import { createContractLogger, logContractMessage } from '../../contract_logging.js';
9
11
  import { EventService } from '../../events/event_service.js';
10
12
  import { LogService } from '../../logs/log_service.js';
11
13
  import { NoteService } from '../../notes/note_service.js';
@@ -13,6 +15,7 @@ import { ORACLE_VERSION } from '../../oracle_version.js';
13
15
  import { EventValidationRequest } from '../noir-structs/event_validation_request.js';
14
16
  import { LogRetrievalRequest } from '../noir-structs/log_retrieval_request.js';
15
17
  import { LogRetrievalResponse } from '../noir-structs/log_retrieval_response.js';
18
+ import { MessageTxContext } from '../noir-structs/message_tx_context.js';
16
19
  import { NoteValidationRequest } from '../noir-structs/note_validation_request.js';
17
20
  import { UtilityContext } from '../noir-structs/utility_context.js';
18
21
  import { pickNotes } from '../pick_notes.js';
@@ -20,6 +23,10 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
20
23
  /**
21
24
  * The oracle for an execution of utility contract functions.
22
25
  */ export class UtilityExecutionOracle {
26
+ isMisc = true;
27
+ isUtility = true;
28
+ contractLogger;
29
+ offchainEffects = [];
23
30
  contractAddress;
24
31
  authWitnesses;
25
32
  capsules;
@@ -33,42 +40,50 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
33
40
  senderAddressBookStore;
34
41
  capsuleStore;
35
42
  privateEventStore;
43
+ messageContextService;
36
44
  jobId;
37
- log;
45
+ logger;
38
46
  scopes;
39
- isMisc;
40
- isUtility;
41
- aztecNrDebugLog;
42
- constructor(contractAddress, /** List of transient auth witnesses to be used during this simulation */ authWitnesses, capsules, anchorBlockHeader, contractStore, noteStore, keyStore, addressStore, aztecNode, recipientTaggingStore, senderAddressBookStore, capsuleStore, privateEventStore, jobId, log = createLogger('simulator:client_view_context'), scopes){
43
- this.contractAddress = contractAddress;
44
- this.authWitnesses = authWitnesses;
45
- this.capsules = capsules;
46
- this.anchorBlockHeader = anchorBlockHeader;
47
- this.contractStore = contractStore;
48
- this.noteStore = noteStore;
49
- this.keyStore = keyStore;
50
- this.addressStore = addressStore;
51
- this.aztecNode = aztecNode;
52
- this.recipientTaggingStore = recipientTaggingStore;
53
- this.senderAddressBookStore = senderAddressBookStore;
54
- this.capsuleStore = capsuleStore;
55
- this.privateEventStore = privateEventStore;
56
- this.jobId = jobId;
57
- this.log = log;
58
- this.scopes = scopes;
59
- this.isMisc = true;
60
- this.isUtility = true;
61
- this.aztecNrDebugLog = createLogger('aztec-nr:debug_log');
62
- }
63
- utilityAssertCompatibleOracleVersion(version) {
47
+ constructor(args){
48
+ this.contractAddress = args.contractAddress;
49
+ this.authWitnesses = args.authWitnesses;
50
+ this.capsules = args.capsules;
51
+ this.anchorBlockHeader = args.anchorBlockHeader;
52
+ this.contractStore = args.contractStore;
53
+ this.noteStore = args.noteStore;
54
+ this.keyStore = args.keyStore;
55
+ this.addressStore = args.addressStore;
56
+ this.aztecNode = args.aztecNode;
57
+ this.recipientTaggingStore = args.recipientTaggingStore;
58
+ this.senderAddressBookStore = args.senderAddressBookStore;
59
+ this.capsuleStore = args.capsuleStore;
60
+ this.privateEventStore = args.privateEventStore;
61
+ this.messageContextService = args.messageContextService;
62
+ this.jobId = args.jobId;
63
+ this.logger = args.log ?? createLogger('simulator:client_view_context');
64
+ this.scopes = args.scopes;
65
+ }
66
+ assertCompatibleOracleVersion(version) {
67
+ // TODO(F-416): Remove this hack on v5 when protocol contracts are redeployed.
68
+ // Protocol contracts/canonical contracts shipped with committed bytecode that cannot be changed. Assert they use
69
+ // the expected pinned version or the current one. We want to allow for both the pinned and the current versions
70
+ // because we want this code to work with both the pinned and unpinned version since some branches do not have the
71
+ // pinned contracts (like e.g. next)
72
+ const LEGACY_ORACLE_VERSION = 12;
73
+ if (isProtocolContract(this.contractAddress)) {
74
+ if (version !== LEGACY_ORACLE_VERSION && version !== ORACLE_VERSION) {
75
+ throw new Error(`Expected legacy oracle version ${LEGACY_ORACLE_VERSION} or current oracle version ${ORACLE_VERSION} for alpha payload contract at ${this.contractAddress}, got ${version}.`);
76
+ }
77
+ return;
78
+ }
64
79
  if (version !== ORACLE_VERSION) {
65
80
  throw new Error(`Incompatible oracle version. Expected version ${ORACLE_VERSION}, got ${version}.`);
66
81
  }
67
82
  }
68
- utilityGetRandomField() {
83
+ getRandomField() {
69
84
  return Fr.random();
70
85
  }
71
- utilityGetUtilityContext() {
86
+ getUtilityContext() {
72
87
  return new UtilityContext(this.anchorBlockHeader, this.contractAddress);
73
88
  }
74
89
  /**
@@ -76,7 +91,20 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
76
91
  * @param pkMHash - The master public key hash.
77
92
  * @returns A Promise that resolves to nullifier keys.
78
93
  * @throws If the keys are not registered in the key store.
79
- */ utilityGetKeyValidationRequest(pkMHash) {
94
+ * @throws If scopes are defined and the account is not in the scopes.
95
+ */ async getKeyValidationRequest(pkMHash) {
96
+ // If scopes are defined, check that the key belongs to an account in the scopes.
97
+ if (this.scopes !== 'ALL_SCOPES' && this.scopes.length > 0) {
98
+ let hasAccess = false;
99
+ for(let i = 0; i < this.scopes.length && !hasAccess; i++){
100
+ if (await this.keyStore.accountHasKey(this.scopes[i], pkMHash)) {
101
+ hasAccess = true;
102
+ }
103
+ }
104
+ if (!hasAccess) {
105
+ throw new Error(`Key validation request denied: no scoped account has a key with hash ${pkMHash.toString()}.`);
106
+ }
107
+ }
80
108
  return this.keyStore.getKeyValidationRequest(pkMHash, this.contractAddress);
81
109
  }
82
110
  /**
@@ -85,7 +113,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
85
113
  * witness.
86
114
  * @param noteHash - The note hash to find in the note hash tree.
87
115
  * @returns The membership witness containing the leaf index and sibling path
88
- */ utilityGetNoteHashMembershipWitness(anchorBlockHash, noteHash) {
116
+ */ getNoteHashMembershipWitness(anchorBlockHash, noteHash) {
89
117
  return this.aztecNode.getNoteHashMembershipWitness(anchorBlockHash, noteHash);
90
118
  }
91
119
  /**
@@ -98,7 +126,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
98
126
  * witness.
99
127
  * @param blockHash - The block hash to find in the archive tree.
100
128
  * @returns The membership witness containing the leaf index and sibling path
101
- */ utilityGetBlockHashMembershipWitness(anchorBlockHash, blockHash) {
129
+ */ getBlockHashMembershipWitness(anchorBlockHash, blockHash) {
102
130
  return this.aztecNode.getBlockHashMembershipWitness(anchorBlockHash, blockHash);
103
131
  }
104
132
  /**
@@ -106,7 +134,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
106
134
  * @param blockHash - The block hash at which to get the index.
107
135
  * @param nullifier - Nullifier we try to find witness for.
108
136
  * @returns The nullifier membership witness (if found).
109
- */ utilityGetNullifierMembershipWitness(blockHash, nullifier) {
137
+ */ getNullifierMembershipWitness(blockHash, nullifier) {
110
138
  return this.aztecNode.getNullifierMembershipWitness(blockHash, nullifier);
111
139
  }
112
140
  /**
@@ -117,7 +145,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
117
145
  * @remarks Low nullifier witness can be used to perform a nullifier non-inclusion proof by leveraging the "linked
118
146
  * list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
119
147
  * we are trying to prove non-inclusion for.
120
- */ utilityGetLowNullifierMembershipWitness(blockHash, nullifier) {
148
+ */ getLowNullifierMembershipWitness(blockHash, nullifier) {
121
149
  return this.aztecNode.getLowNullifierMembershipWitness(blockHash, nullifier);
122
150
  }
123
151
  /**
@@ -125,14 +153,14 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
125
153
  * @param blockHash - The block hash at which to get the index.
126
154
  * @param leafSlot - The slot of the public data tree to get the witness for.
127
155
  * @returns - The witness
128
- */ utilityGetPublicDataWitness(blockHash, leafSlot) {
156
+ */ getPublicDataWitness(blockHash, leafSlot) {
129
157
  return this.aztecNode.getPublicDataWitness(blockHash, leafSlot);
130
158
  }
131
159
  /**
132
160
  * Fetches a block header of a given block.
133
161
  * @param blockNumber - The number of a block of which to get the block header.
134
162
  * @returns Block extracted from a block with block number `blockNumber`.
135
- */ async utilityGetBlockHeader(blockNumber) {
163
+ */ async getBlockHeader(blockNumber) {
136
164
  const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
137
165
  if (blockNumber > anchorBlockNumber) {
138
166
  throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
@@ -141,14 +169,20 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
141
169
  return block?.header;
142
170
  }
143
171
  /**
144
- * Retrieve the complete address associated to a given address.
172
+ * Retrieve the public keys and partial address associated to a given address.
145
173
  * @param account - The account address.
146
- * @returns A complete address associated with the input address.
147
- * @throws An error if the account is not registered in the database.
148
- */ utilityGetPublicKeysAndPartialAddress(account) {
149
- return this.getCompleteAddress(account);
174
+ * @returns The public keys and partial address, or `undefined` if the account is not registered.
175
+ */ async tryGetPublicKeysAndPartialAddress(account) {
176
+ const completeAddress = await this.addressStore.getCompleteAddress(account);
177
+ if (!completeAddress) {
178
+ return undefined;
179
+ }
180
+ return {
181
+ publicKeys: completeAddress.publicKeys,
182
+ partialAddress: completeAddress.partialAddress
183
+ };
150
184
  }
151
- async getCompleteAddress(account) {
185
+ async getCompleteAddressOrFail(account) {
152
186
  const completeAddress = await this.addressStore.getCompleteAddress(account);
153
187
  if (!completeAddress) {
154
188
  throw new Error(`No public key registered for address ${account}.
@@ -160,10 +194,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
160
194
  * Returns a contract instance associated with an address or throws if not found.
161
195
  * @param address - Address.
162
196
  * @returns A contract instance.
163
- */ utilityGetContractInstance(address) {
164
- return this.getContractInstance(address);
165
- }
166
- async getContractInstance(address) {
197
+ */ async getContractInstance(address) {
167
198
  const instance = await this.contractStore.getContractInstance(address);
168
199
  if (!instance) {
169
200
  throw new Error(`No contract instance found for address ${address.toString()}`);
@@ -175,7 +206,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
175
206
  * for this transaction first, and falls back to the local database if not found.
176
207
  * @param messageHash - Hash of the message to authenticate.
177
208
  * @returns Authentication witness for the requested message hash.
178
- */ utilityGetAuthWitness(messageHash) {
209
+ */ getAuthWitness(messageHash) {
179
210
  return Promise.resolve(this.authWitnesses.find((w)=>w.requestHash.equals(messageHash))?.witness);
180
211
  }
181
212
  /**
@@ -199,7 +230,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
199
230
  * @param offset - The starting index for pagination.
200
231
  * @param status - The status of notes to fetch.
201
232
  * @returns Array of note data.
202
- */ async utilityGetNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status) {
233
+ */ async getNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status) {
203
234
  const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
204
235
  const dbNotes = await noteService.getNotes(this.contractAddress, owner, storageSlot, status, this.scopes);
205
236
  return pickNotes(dbNotes, {
@@ -228,9 +259,12 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
228
259
  * Check if a nullifier exists in the nullifier tree.
229
260
  * @param innerNullifier - The inner nullifier.
230
261
  * @returns A boolean indicating whether the nullifier exists in the tree or not.
231
- */ async utilityCheckNullifierExists(innerNullifier) {
232
- const nullifier = await siloNullifier(this.contractAddress, innerNullifier);
233
- const [leafIndex] = await this.aztecNode.findLeavesIndexes('latest', MerkleTreeId.NULLIFIER_TREE, [
262
+ */ async checkNullifierExists(innerNullifier) {
263
+ const [nullifier, anchorBlockHash] = await Promise.all([
264
+ siloNullifier(this.contractAddress, innerNullifier),
265
+ this.anchorBlockHeader.hash()
266
+ ]);
267
+ const [leafIndex] = await this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, [
234
268
  nullifier
235
269
  ]);
236
270
  return leafIndex?.data !== undefined;
@@ -242,7 +276,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
242
276
  * @param secret - Secret used to compute a nullifier.
243
277
  * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
244
278
  * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
245
- */ async utilityGetL1ToL2MembershipWitness(contractAddress, messageHash, secret) {
279
+ */ async getL1ToL2MembershipWitness(contractAddress, messageHash, secret) {
246
280
  const [messageIndex, siblingPath] = await getNonNullifiedL1ToL2MessageWitness(this.aztecNode, contractAddress, messageHash, secret);
247
281
  return new MessageLoadOracleInputs(messageIndex, siblingPath);
248
282
  }
@@ -252,21 +286,33 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
252
286
  * @param contractAddress - The address to read storage from.
253
287
  * @param startStorageSlot - The starting storage slot.
254
288
  * @param numberOfElements - Number of elements to read from the starting storage slot.
255
- */ async utilityStorageRead(blockHash, contractAddress, startStorageSlot, numberOfElements) {
289
+ */ async storageRead(blockHash, contractAddress, startStorageSlot, numberOfElements) {
256
290
  const slots = Array(numberOfElements).fill(0).map((_, i)=>new Fr(startStorageSlot.value + BigInt(i)));
257
291
  const values = await Promise.all(slots.map((storageSlot)=>this.aztecNode.getPublicStorageAt(blockHash, contractAddress, storageSlot)));
258
- this.log.debug(`Oracle storage read: slots=[${slots.map((slot)=>slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`);
292
+ this.logger.debug(`Oracle storage read: slots=[${slots.map((slot)=>slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`);
259
293
  return values;
260
294
  }
261
- utilityDebugLog(level, message, fields) {
295
+ /**
296
+ * Returns a per-contract logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
297
+ */ async #getContractLogger() {
298
+ if (!this.contractLogger) {
299
+ // Purpose of instanceId is to distinguish logs from different instances of the same component. It makes sense
300
+ // to re-use jobId as instanceId here as executions of different PXE jobs are isolated.
301
+ this.contractLogger = await createContractLogger(this.contractAddress, (addr)=>this.contractStore.getDebugContractName(addr), {
302
+ instanceId: this.jobId
303
+ });
304
+ }
305
+ return this.contractLogger;
306
+ }
307
+ async log(level, message, fields) {
262
308
  if (!LogLevels[level]) {
263
- throw new Error(`Invalid debug log level: ${level}`);
309
+ throw new Error(`Invalid log level: ${level}`);
264
310
  }
265
- const levelName = LogLevels[level];
266
- this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
311
+ const logger = await this.#getContractLogger();
312
+ logContractMessage(logger, LogLevels[level], message, fields);
267
313
  }
268
- async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot) {
269
- const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.log.getBindings());
314
+ async fetchTaggedLogs(pendingTaggedLogArrayBaseSlot) {
315
+ const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.logger.getBindings());
270
316
  await logService.fetchTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
271
317
  }
272
318
  /**
@@ -278,15 +324,15 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
278
324
  * @param contractAddress - The address of the contract that the logs are tagged for.
279
325
  * @param noteValidationRequestsArrayBaseSlot - The base slot of capsule array containing note validation requests.
280
326
  * @param eventValidationRequestsArrayBaseSlot - The base slot of capsule array containing event validation requests.
281
- */ async utilityValidateAndStoreEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot) {
327
+ */ async validateAndStoreEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot, maxNotePackedLen, maxEventSerializedLen) {
282
328
  // TODO(#10727): allow other contracts to store notes
283
329
  if (!this.contractAddress.equals(contractAddress)) {
284
330
  throw new Error(`Got a note validation request from ${contractAddress}, expected ${this.contractAddress}`);
285
331
  }
286
332
  // We read all note and event validation requests and process them all concurrently. This makes the process much
287
333
  // faster as we don't need to wait for the network round-trip.
288
- const noteValidationRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, this.jobId)).map(NoteValidationRequest.fromFields);
289
- const eventValidationRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, this.jobId)).map(EventValidationRequest.fromFields);
334
+ const noteValidationRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, this.jobId)).map((fields)=>NoteValidationRequest.fromFields(fields, maxNotePackedLen));
335
+ const eventValidationRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, this.jobId)).map((fields)=>EventValidationRequest.fromFields(fields, maxEventSerializedLen));
290
336
  const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
291
337
  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));
292
338
  const eventService = new EventService(this.anchorBlockHeader, this.aztecNode, this.privateEventStore, this.jobId);
@@ -299,7 +345,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
299
345
  await this.capsuleStore.setCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, [], this.jobId);
300
346
  await this.capsuleStore.setCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, [], this.jobId);
301
347
  }
302
- async utilityBulkRetrieveLogs(contractAddress, logRetrievalRequestsArrayBaseSlot, logRetrievalResponsesArrayBaseSlot) {
348
+ async bulkRetrieveLogs(contractAddress, logRetrievalRequestsArrayBaseSlot, logRetrievalResponsesArrayBaseSlot) {
303
349
  // TODO(#10727): allow other contracts to process partial notes
304
350
  if (!this.contractAddress.equals(contractAddress)) {
305
351
  throw new Error(`Got a note validation request from ${contractAddress}, expected ${this.contractAddress}`);
@@ -307,14 +353,33 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
307
353
  // We read all log retrieval requests and process them all concurrently. This makes the process much faster as we
308
354
  // don't need to wait for the network round-trip.
309
355
  const logRetrievalRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, this.jobId)).map(LogRetrievalRequest.fromFields);
310
- const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.log.getBindings());
356
+ const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.logger.getBindings());
311
357
  const maybeLogRetrievalResponses = await logService.bulkRetrieveLogs(logRetrievalRequests);
312
358
  // Requests are cleared once we're done.
313
359
  await this.capsuleStore.setCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, [], this.jobId);
314
360
  // The responses are stored as Option<LogRetrievalResponse> in a second CapsuleArray.
315
361
  await this.capsuleStore.setCapsuleArray(contractAddress, logRetrievalResponsesArrayBaseSlot, maybeLogRetrievalResponses.map(LogRetrievalResponse.toSerializedOption), this.jobId);
316
362
  }
317
- utilityStoreCapsule(contractAddress, slot, capsule) {
363
+ async utilityResolveMessageContexts(contractAddress, messageContextRequestsArrayBaseSlot, messageContextResponsesArrayBaseSlot) {
364
+ try {
365
+ if (!this.contractAddress.equals(contractAddress)) {
366
+ throw new Error(`Got a message context request from ${contractAddress}, expected ${this.contractAddress}`);
367
+ }
368
+ const requestCapsules = await this.capsuleStore.readCapsuleArray(contractAddress, messageContextRequestsArrayBaseSlot, this.jobId);
369
+ const txHashes = requestCapsules.map((fields, i)=>{
370
+ if (fields.length !== 1) {
371
+ throw new Error(`Malformed message context request at index ${i}: expected 1 field (tx hash), got ${fields.length}`);
372
+ }
373
+ return fields[0];
374
+ });
375
+ const maybeMessageContexts = await this.messageContextService.resolveMessageContexts(txHashes, this.anchorBlockHeader.getBlockNumber());
376
+ // Leave response in response capsule array.
377
+ await this.capsuleStore.setCapsuleArray(contractAddress, messageContextResponsesArrayBaseSlot, maybeMessageContexts.map(MessageTxContext.toSerializedOption), this.jobId);
378
+ } finally{
379
+ await this.capsuleStore.setCapsuleArray(contractAddress, messageContextRequestsArrayBaseSlot, [], this.jobId);
380
+ }
381
+ }
382
+ storeCapsule(contractAddress, slot, capsule) {
318
383
  if (!contractAddress.equals(this.contractAddress)) {
319
384
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
320
385
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -322,7 +387,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
322
387
  this.capsuleStore.storeCapsule(this.contractAddress, slot, capsule, this.jobId);
323
388
  return Promise.resolve();
324
389
  }
325
- async utilityLoadCapsule(contractAddress, slot) {
390
+ async loadCapsule(contractAddress, slot) {
326
391
  if (!contractAddress.equals(this.contractAddress)) {
327
392
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
328
393
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -330,7 +395,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
330
395
  return(// TODO(#12425): On the following line, the pertinent capsule gets overshadowed by the transient one. Tackle this.
331
396
  this.capsules.find((c)=>c.contractAddress.equals(contractAddress) && c.storageSlot.equals(slot))?.data ?? await this.capsuleStore.loadCapsule(this.contractAddress, slot, this.jobId));
332
397
  }
333
- utilityDeleteCapsule(contractAddress, slot) {
398
+ deleteCapsule(contractAddress, slot) {
334
399
  if (!contractAddress.equals(this.contractAddress)) {
335
400
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
336
401
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -338,7 +403,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
338
403
  this.capsuleStore.deleteCapsule(this.contractAddress, slot, this.jobId);
339
404
  return Promise.resolve();
340
405
  }
341
- utilityCopyCapsule(contractAddress, srcSlot, dstSlot, numEntries) {
406
+ copyCapsule(contractAddress, srcSlot, dstSlot, numEntries) {
342
407
  if (!contractAddress.equals(this.contractAddress)) {
343
408
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
344
409
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -346,7 +411,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
346
411
  return this.capsuleStore.copyCapsule(this.contractAddress, srcSlot, dstSlot, numEntries, this.jobId);
347
412
  }
348
413
  // TODO(#11849): consider replacing this oracle with a pure Noir implementation of aes decryption.
349
- utilityAes128Decrypt(ciphertext, iv, symKey) {
414
+ aes128Decrypt(ciphertext, iv, symKey) {
350
415
  const aes128 = new Aes128();
351
416
  return aes128.decryptBufferCBC(ciphertext, iv, symKey);
352
417
  }
@@ -355,14 +420,21 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
355
420
  * @param address - The address to get the secret for.
356
421
  * @param ephPk - The ephemeral public key to get the secret for.
357
422
  * @returns The secret for the given address.
358
- */ utilityGetSharedSecret(address, ephPk) {
359
- return this.getSharedSecret(address, ephPk);
360
- }
361
- async getSharedSecret(address, ephPk) {
423
+ */ async getSharedSecret(address, ephPk) {
362
424
  // TODO(#12656): return an app-siloed secret
363
- const recipientCompleteAddress = await this.getCompleteAddress(address);
425
+ const recipientCompleteAddress = await this.getCompleteAddressOrFail(address);
364
426
  const ivskM = await this.keyStore.getMasterSecretKey(recipientCompleteAddress.publicKeys.masterIncomingViewingPublicKey);
365
427
  const addressSecret = await computeAddressSecret(await recipientCompleteAddress.getPreaddress(), ivskM);
366
428
  return deriveEcdhSharedSecret(addressSecret, ephPk);
367
429
  }
430
+ emitOffchainEffect(data) {
431
+ this.offchainEffects.push({
432
+ data,
433
+ contractAddress: this.contractAddress
434
+ });
435
+ return Promise.resolve();
436
+ }
437
+ /** Returns offchain effects collected during execution. */ getOffchainEffects() {
438
+ return this.offchainEffects;
439
+ }
368
440
  }
@@ -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
+ }