@aztec/pxe 0.0.1-commit.023c3e5 → 0.0.1-commit.033589e

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 (167) 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/package_info.js +1 -1
  8. package/dest/contract_function_simulator/contract_function_simulator.d.ts +54 -28
  9. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  10. package/dest/contract_function_simulator/contract_function_simulator.js +177 -71
  11. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +5 -5
  12. package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts.map +1 -1
  13. package/dest/contract_function_simulator/execution_tagging_index_cache.js +3 -3
  14. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +1 -1
  15. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +2 -2
  16. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
  17. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +1 -1
  18. package/dest/contract_function_simulator/oracle/interfaces.d.ts +44 -44
  19. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  20. package/dest/contract_function_simulator/oracle/oracle.d.ts +44 -44
  21. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/oracle/oracle.js +151 -96
  23. package/dest/contract_function_simulator/oracle/private_execution.js +1 -1
  24. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +55 -54
  25. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  26. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +100 -55
  27. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +60 -42
  28. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  29. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +91 -80
  30. package/dest/contract_logging.d.ts +22 -0
  31. package/dest/contract_logging.d.ts.map +1 -0
  32. package/dest/contract_logging.js +23 -0
  33. package/dest/contract_sync/contract_sync_service.d.ts +43 -0
  34. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  35. package/dest/contract_sync/contract_sync_service.js +97 -0
  36. package/dest/contract_sync/helpers.d.ts +29 -0
  37. package/dest/contract_sync/helpers.d.ts.map +1 -0
  38. package/dest/contract_sync/{index.js → helpers.js} +13 -12
  39. package/dest/debug/pxe_debug_utils.d.ts +14 -10
  40. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  41. package/dest/debug/pxe_debug_utils.js +16 -15
  42. package/dest/entrypoints/client/bundle/index.d.ts +4 -1
  43. package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
  44. package/dest/entrypoints/client/bundle/index.js +3 -0
  45. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  46. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  47. package/dest/entrypoints/client/bundle/utils.js +9 -1
  48. package/dest/entrypoints/client/lazy/index.d.ts +4 -1
  49. package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
  50. package/dest/entrypoints/client/lazy/index.js +3 -0
  51. package/dest/entrypoints/client/lazy/utils.d.ts +1 -1
  52. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  53. package/dest/entrypoints/client/lazy/utils.js +9 -1
  54. package/dest/entrypoints/server/index.d.ts +4 -2
  55. package/dest/entrypoints/server/index.d.ts.map +1 -1
  56. package/dest/entrypoints/server/index.js +3 -1
  57. package/dest/entrypoints/server/utils.js +9 -1
  58. package/dest/logs/log_service.d.ts +3 -2
  59. package/dest/logs/log_service.d.ts.map +1 -1
  60. package/dest/logs/log_service.js +11 -18
  61. package/dest/notes/note_service.d.ts +4 -3
  62. package/dest/notes/note_service.d.ts.map +1 -1
  63. package/dest/notes/note_service.js +3 -2
  64. package/dest/notes_filter.d.ts +25 -0
  65. package/dest/notes_filter.d.ts.map +1 -0
  66. package/dest/notes_filter.js +4 -0
  67. package/dest/oracle_version.d.ts +2 -2
  68. package/dest/oracle_version.js +3 -3
  69. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
  70. package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
  71. package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
  72. package/dest/private_kernel/hints/index.d.ts +1 -1
  73. package/dest/private_kernel/hints/index.js +1 -1
  74. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
  75. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
  76. package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
  77. package/dest/private_kernel/hints/test_utils.d.ts +122 -0
  78. package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
  79. package/dest/private_kernel/hints/test_utils.js +203 -0
  80. package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
  81. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  82. package/dest/private_kernel/private_kernel_execution_prover.js +19 -11
  83. package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
  84. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  85. package/dest/private_kernel/private_kernel_oracle.js +7 -3
  86. package/dest/pxe.d.ts +71 -24
  87. package/dest/pxe.d.ts.map +1 -1
  88. package/dest/pxe.js +100 -64
  89. package/dest/storage/contract_store/contract_store.d.ts +42 -15
  90. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  91. package/dest/storage/contract_store/contract_store.js +145 -69
  92. package/dest/storage/note_store/note_store.d.ts +3 -3
  93. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  94. package/dest/storage/note_store/note_store.js +6 -4
  95. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
  96. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  97. package/dest/storage/tagging_store/sender_tagging_store.d.ts +5 -5
  98. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  99. package/dest/storage/tagging_store/sender_tagging_store.js +4 -4
  100. package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
  101. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  102. package/dest/tagging/get_all_logs_by_tags.js +17 -3
  103. package/dest/tagging/index.d.ts +2 -2
  104. package/dest/tagging/index.d.ts.map +1 -1
  105. package/dest/tagging/index.js +1 -1
  106. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
  107. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  108. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +7 -7
  109. package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
  110. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
  111. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  112. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
  113. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
  114. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  115. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +3 -6
  116. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +4 -7
  117. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  118. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +14 -15
  119. package/package.json +25 -16
  120. package/src/access_scopes.ts +9 -0
  121. package/src/block_synchronizer/block_synchronizer.ts +6 -0
  122. package/src/config/package_info.ts +1 -1
  123. package/src/contract_function_simulator/contract_function_simulator.ts +326 -131
  124. package/src/contract_function_simulator/execution_tagging_index_cache.ts +5 -5
  125. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +1 -1
  126. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +1 -1
  127. package/src/contract_function_simulator/oracle/interfaces.ts +43 -43
  128. package/src/contract_function_simulator/oracle/oracle.ts +145 -110
  129. package/src/contract_function_simulator/oracle/private_execution.ts +1 -1
  130. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +126 -132
  131. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +136 -86
  132. package/src/contract_logging.ts +39 -0
  133. package/src/contract_sync/contract_sync_service.ts +152 -0
  134. package/src/contract_sync/{index.ts → helpers.ts} +21 -21
  135. package/src/debug/pxe_debug_utils.ts +48 -18
  136. package/src/entrypoints/client/bundle/index.ts +3 -0
  137. package/src/entrypoints/client/bundle/utils.ts +9 -1
  138. package/src/entrypoints/client/lazy/index.ts +3 -0
  139. package/src/entrypoints/client/lazy/utils.ts +9 -1
  140. package/src/entrypoints/server/index.ts +3 -1
  141. package/src/entrypoints/server/utils.ts +7 -7
  142. package/src/logs/log_service.ts +18 -25
  143. package/src/notes/note_service.ts +4 -3
  144. package/src/notes_filter.ts +26 -0
  145. package/src/oracle_version.ts +3 -3
  146. package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
  147. package/src/private_kernel/hints/index.ts +1 -1
  148. package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
  149. package/src/private_kernel/hints/test_utils.ts +325 -0
  150. package/src/private_kernel/private_kernel_execution_prover.ts +19 -12
  151. package/src/private_kernel/private_kernel_oracle.ts +7 -7
  152. package/src/pxe.ts +184 -113
  153. package/src/storage/contract_store/contract_store.ts +174 -75
  154. package/src/storage/note_store/note_store.ts +12 -5
  155. package/src/storage/tagging_store/recipient_tagging_store.ts +9 -5
  156. package/src/storage/tagging_store/sender_tagging_store.ts +8 -8
  157. package/src/tagging/get_all_logs_by_tags.ts +28 -4
  158. package/src/tagging/index.ts +1 -1
  159. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +7 -10
  160. package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
  161. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
  162. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +4 -9
  163. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +11 -20
  164. package/dest/contract_sync/index.d.ts +0 -23
  165. package/dest/contract_sync/index.d.ts.map +0 -1
  166. package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
  167. 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;
@@ -34,41 +38,35 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
34
38
  capsuleStore;
35
39
  privateEventStore;
36
40
  jobId;
37
- log;
41
+ logger;
38
42
  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');
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;
62
60
  }
63
- utilityAssertCompatibleOracleVersion(version) {
61
+ assertCompatibleOracleVersion(version) {
64
62
  if (version !== ORACLE_VERSION) {
65
63
  throw new Error(`Incompatible oracle version. Expected version ${ORACLE_VERSION}, got ${version}.`);
66
64
  }
67
65
  }
68
- utilityGetRandomField() {
66
+ getRandomField() {
69
67
  return Fr.random();
70
68
  }
71
- utilityGetUtilityContext() {
69
+ getUtilityContext() {
72
70
  return new UtilityContext(this.anchorBlockHeader, this.contractAddress);
73
71
  }
74
72
  /**
@@ -76,7 +74,20 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
76
74
  * @param pkMHash - The master public key hash.
77
75
  * @returns A Promise that resolves to nullifier keys.
78
76
  * @throws If the keys are not registered in the key store.
79
- */ 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
+ }
80
91
  return this.keyStore.getKeyValidationRequest(pkMHash, this.contractAddress);
81
92
  }
82
93
  /**
@@ -85,7 +96,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
85
96
  * witness.
86
97
  * @param noteHash - The note hash to find in the note hash tree.
87
98
  * @returns The membership witness containing the leaf index and sibling path
88
- */ utilityGetNoteHashMembershipWitness(anchorBlockHash, noteHash) {
99
+ */ getNoteHashMembershipWitness(anchorBlockHash, noteHash) {
89
100
  return this.aztecNode.getNoteHashMembershipWitness(anchorBlockHash, noteHash);
90
101
  }
91
102
  /**
@@ -98,7 +109,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
98
109
  * witness.
99
110
  * @param blockHash - The block hash to find in the archive tree.
100
111
  * @returns The membership witness containing the leaf index and sibling path
101
- */ utilityGetBlockHashMembershipWitness(anchorBlockHash, blockHash) {
112
+ */ getBlockHashMembershipWitness(anchorBlockHash, blockHash) {
102
113
  return this.aztecNode.getBlockHashMembershipWitness(anchorBlockHash, blockHash);
103
114
  }
104
115
  /**
@@ -106,7 +117,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
106
117
  * @param blockHash - The block hash at which to get the index.
107
118
  * @param nullifier - Nullifier we try to find witness for.
108
119
  * @returns The nullifier membership witness (if found).
109
- */ utilityGetNullifierMembershipWitness(blockHash, nullifier) {
120
+ */ getNullifierMembershipWitness(blockHash, nullifier) {
110
121
  return this.aztecNode.getNullifierMembershipWitness(blockHash, nullifier);
111
122
  }
112
123
  /**
@@ -117,7 +128,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
117
128
  * @remarks Low nullifier witness can be used to perform a nullifier non-inclusion proof by leveraging the "linked
118
129
  * list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
119
130
  * we are trying to prove non-inclusion for.
120
- */ utilityGetLowNullifierMembershipWitness(blockHash, nullifier) {
131
+ */ getLowNullifierMembershipWitness(blockHash, nullifier) {
121
132
  return this.aztecNode.getLowNullifierMembershipWitness(blockHash, nullifier);
122
133
  }
123
134
  /**
@@ -125,14 +136,14 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
125
136
  * @param blockHash - The block hash at which to get the index.
126
137
  * @param leafSlot - The slot of the public data tree to get the witness for.
127
138
  * @returns - The witness
128
- */ utilityGetPublicDataWitness(blockHash, leafSlot) {
139
+ */ getPublicDataWitness(blockHash, leafSlot) {
129
140
  return this.aztecNode.getPublicDataWitness(blockHash, leafSlot);
130
141
  }
131
142
  /**
132
143
  * Fetches a block header of a given block.
133
144
  * @param blockNumber - The number of a block of which to get the block header.
134
145
  * @returns Block extracted from a block with block number `blockNumber`.
135
- */ async utilityGetBlockHeader(blockNumber) {
146
+ */ async getBlockHeader(blockNumber) {
136
147
  const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
137
148
  if (blockNumber > anchorBlockNumber) {
138
149
  throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
@@ -143,12 +154,11 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
143
154
  /**
144
155
  * Retrieve the complete address associated to a given address.
145
156
  * @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);
157
+ * @returns A complete address associated with the input address, or `undefined` if not registered.
158
+ */ tryGetPublicKeysAndPartialAddress(account) {
159
+ return this.addressStore.getCompleteAddress(account);
150
160
  }
151
- async getCompleteAddress(account) {
161
+ async getCompleteAddressOrFail(account) {
152
162
  const completeAddress = await this.addressStore.getCompleteAddress(account);
153
163
  if (!completeAddress) {
154
164
  throw new Error(`No public key registered for address ${account}.
@@ -160,10 +170,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
160
170
  * Returns a contract instance associated with an address or throws if not found.
161
171
  * @param address - Address.
162
172
  * @returns A contract instance.
163
- */ utilityGetContractInstance(address) {
164
- return this.getContractInstance(address);
165
- }
166
- async getContractInstance(address) {
173
+ */ async getContractInstance(address) {
167
174
  const instance = await this.contractStore.getContractInstance(address);
168
175
  if (!instance) {
169
176
  throw new Error(`No contract instance found for address ${address.toString()}`);
@@ -175,7 +182,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
175
182
  * for this transaction first, and falls back to the local database if not found.
176
183
  * @param messageHash - Hash of the message to authenticate.
177
184
  * @returns Authentication witness for the requested message hash.
178
- */ utilityGetAuthWitness(messageHash) {
185
+ */ getAuthWitness(messageHash) {
179
186
  return Promise.resolve(this.authWitnesses.find((w)=>w.requestHash.equals(messageHash))?.witness);
180
187
  }
181
188
  /**
@@ -199,7 +206,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
199
206
  * @param offset - The starting index for pagination.
200
207
  * @param status - The status of notes to fetch.
201
208
  * @returns Array of note data.
202
- */ async utilityGetNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status) {
209
+ */ async getNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status) {
203
210
  const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
204
211
  const dbNotes = await noteService.getNotes(this.contractAddress, owner, storageSlot, status, this.scopes);
205
212
  return pickNotes(dbNotes, {
@@ -228,9 +235,12 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
228
235
  * Check if a nullifier exists in the nullifier tree.
229
236
  * @param innerNullifier - The inner nullifier.
230
237
  * @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, [
238
+ */ async checkNullifierExists(innerNullifier) {
239
+ const [nullifier, anchorBlockHash] = await Promise.all([
240
+ siloNullifier(this.contractAddress, innerNullifier),
241
+ this.anchorBlockHeader.hash()
242
+ ]);
243
+ const [leafIndex] = await this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, [
234
244
  nullifier
235
245
  ]);
236
246
  return leafIndex?.data !== undefined;
@@ -242,7 +252,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
242
252
  * @param secret - Secret used to compute a nullifier.
243
253
  * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
244
254
  * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
245
- */ async utilityGetL1ToL2MembershipWitness(contractAddress, messageHash, secret) {
255
+ */ async getL1ToL2MembershipWitness(contractAddress, messageHash, secret) {
246
256
  const [messageIndex, siblingPath] = await getNonNullifiedL1ToL2MessageWitness(this.aztecNode, contractAddress, messageHash, secret);
247
257
  return new MessageLoadOracleInputs(messageIndex, siblingPath);
248
258
  }
@@ -252,30 +262,34 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
252
262
  * @param contractAddress - The address to read storage from.
253
263
  * @param startStorageSlot - The starting storage slot.
254
264
  * @param numberOfElements - Number of elements to read from the starting storage slot.
255
- */ async utilityStorageRead(blockHash, contractAddress, startStorageSlot, numberOfElements) {
265
+ */ async storageRead(blockHash, contractAddress, startStorageSlot, numberOfElements) {
256
266
  const slots = Array(numberOfElements).fill(0).map((_, i)=>new Fr(startStorageSlot.value + BigInt(i)));
257
267
  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(', ')}]`);
268
+ this.logger.debug(`Oracle storage read: slots=[${slots.map((slot)=>slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`);
259
269
  return values;
260
270
  }
261
- utilityDebugLog(level, message, fields) {
271
+ /**
272
+ * Returns a per-contract logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
273
+ */ async #getContractLogger() {
274
+ if (!this.contractLogger) {
275
+ // Purpose of instanceId is to distinguish logs from different instances of the same component. It makes sense
276
+ // to re-use jobId as instanceId here as executions of different PXE jobs are isolated.
277
+ this.contractLogger = await createContractLogger(this.contractAddress, (addr)=>this.contractStore.getDebugContractName(addr), {
278
+ instanceId: this.jobId
279
+ });
280
+ }
281
+ return this.contractLogger;
282
+ }
283
+ async log(level, message, fields) {
262
284
  if (!LogLevels[level]) {
263
- throw new Error(`Invalid debug log level: ${level}`);
285
+ throw new Error(`Invalid log level: ${level}`);
264
286
  }
265
- const levelName = LogLevels[level];
266
- this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
287
+ const logger = await this.#getContractLogger();
288
+ logContractMessage(logger, LogLevels[level], message, fields);
267
289
  }
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());
270
- const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
271
- // It is acceptable to run the following operations in parallel for several reasons:
272
- // 1. syncTaggedLogs does not write to the note store — it only stores the pending tagged logs in a capsule array,
273
- // which is then processed in Noir after this handler returns.
274
- // 2. Even if syncTaggedLogs did write to the note store, it would not cause inconsistent state.
275
- await Promise.all([
276
- logService.syncTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes),
277
- noteService.syncNoteNullifiers(this.contractAddress)
278
- ]);
290
+ async fetchTaggedLogs(pendingTaggedLogArrayBaseSlot) {
291
+ const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.logger.getBindings());
292
+ await logService.fetchTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
279
293
  }
280
294
  /**
281
295
  * Validates all note and event validation requests enqueued via `enqueue_note_for_validation` and
@@ -286,7 +300,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
286
300
  * @param contractAddress - The address of the contract that the logs are tagged for.
287
301
  * @param noteValidationRequestsArrayBaseSlot - The base slot of capsule array containing note validation requests.
288
302
  * @param eventValidationRequestsArrayBaseSlot - The base slot of capsule array containing event validation requests.
289
- */ async utilityValidateAndStoreEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot) {
303
+ */ async validateAndStoreEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot) {
290
304
  // TODO(#10727): allow other contracts to store notes
291
305
  if (!this.contractAddress.equals(contractAddress)) {
292
306
  throw new Error(`Got a note validation request from ${contractAddress}, expected ${this.contractAddress}`);
@@ -307,7 +321,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
307
321
  await this.capsuleStore.setCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, [], this.jobId);
308
322
  await this.capsuleStore.setCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, [], this.jobId);
309
323
  }
310
- async utilityBulkRetrieveLogs(contractAddress, logRetrievalRequestsArrayBaseSlot, logRetrievalResponsesArrayBaseSlot) {
324
+ async bulkRetrieveLogs(contractAddress, logRetrievalRequestsArrayBaseSlot, logRetrievalResponsesArrayBaseSlot) {
311
325
  // TODO(#10727): allow other contracts to process partial notes
312
326
  if (!this.contractAddress.equals(contractAddress)) {
313
327
  throw new Error(`Got a note validation request from ${contractAddress}, expected ${this.contractAddress}`);
@@ -315,14 +329,14 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
315
329
  // We read all log retrieval requests and process them all concurrently. This makes the process much faster as we
316
330
  // don't need to wait for the network round-trip.
317
331
  const logRetrievalRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, this.jobId)).map(LogRetrievalRequest.fromFields);
318
- const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.log.getBindings());
332
+ const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.logger.getBindings());
319
333
  const maybeLogRetrievalResponses = await logService.bulkRetrieveLogs(logRetrievalRequests);
320
334
  // Requests are cleared once we're done.
321
335
  await this.capsuleStore.setCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, [], this.jobId);
322
336
  // The responses are stored as Option<LogRetrievalResponse> in a second CapsuleArray.
323
337
  await this.capsuleStore.setCapsuleArray(contractAddress, logRetrievalResponsesArrayBaseSlot, maybeLogRetrievalResponses.map(LogRetrievalResponse.toSerializedOption), this.jobId);
324
338
  }
325
- utilityStoreCapsule(contractAddress, slot, capsule) {
339
+ storeCapsule(contractAddress, slot, capsule) {
326
340
  if (!contractAddress.equals(this.contractAddress)) {
327
341
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
328
342
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -330,7 +344,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
330
344
  this.capsuleStore.storeCapsule(this.contractAddress, slot, capsule, this.jobId);
331
345
  return Promise.resolve();
332
346
  }
333
- async utilityLoadCapsule(contractAddress, slot) {
347
+ async loadCapsule(contractAddress, slot) {
334
348
  if (!contractAddress.equals(this.contractAddress)) {
335
349
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
336
350
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -338,7 +352,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
338
352
  return(// TODO(#12425): On the following line, the pertinent capsule gets overshadowed by the transient one. Tackle this.
339
353
  this.capsules.find((c)=>c.contractAddress.equals(contractAddress) && c.storageSlot.equals(slot))?.data ?? await this.capsuleStore.loadCapsule(this.contractAddress, slot, this.jobId));
340
354
  }
341
- utilityDeleteCapsule(contractAddress, slot) {
355
+ deleteCapsule(contractAddress, slot) {
342
356
  if (!contractAddress.equals(this.contractAddress)) {
343
357
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
344
358
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -346,7 +360,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
346
360
  this.capsuleStore.deleteCapsule(this.contractAddress, slot, this.jobId);
347
361
  return Promise.resolve();
348
362
  }
349
- utilityCopyCapsule(contractAddress, srcSlot, dstSlot, numEntries) {
363
+ copyCapsule(contractAddress, srcSlot, dstSlot, numEntries) {
350
364
  if (!contractAddress.equals(this.contractAddress)) {
351
365
  // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
352
366
  throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -354,7 +368,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
354
368
  return this.capsuleStore.copyCapsule(this.contractAddress, srcSlot, dstSlot, numEntries, this.jobId);
355
369
  }
356
370
  // TODO(#11849): consider replacing this oracle with a pure Noir implementation of aes decryption.
357
- utilityAes128Decrypt(ciphertext, iv, symKey) {
371
+ aes128Decrypt(ciphertext, iv, symKey) {
358
372
  const aes128 = new Aes128();
359
373
  return aes128.decryptBufferCBC(ciphertext, iv, symKey);
360
374
  }
@@ -363,12 +377,9 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
363
377
  * @param address - The address to get the secret for.
364
378
  * @param ephPk - The ephemeral public key to get the secret for.
365
379
  * @returns The secret for the given address.
366
- */ utilityGetSharedSecret(address, ephPk) {
367
- return this.getSharedSecret(address, ephPk);
368
- }
369
- async getSharedSecret(address, ephPk) {
380
+ */ async getSharedSecret(address, ephPk) {
370
381
  // TODO(#12656): return an app-siloed secret
371
- const recipientCompleteAddress = await this.getCompleteAddress(address);
382
+ const recipientCompleteAddress = await this.getCompleteAddressOrFail(address);
372
383
  const ivskM = await this.keyStore.getMasterSecretKey(recipientCompleteAddress.publicKeys.masterIncomingViewingPublicKey);
373
384
  const addressSecret = await computeAddressSecret(await recipientCompleteAddress.getPreaddress(), ivskM);
374
385
  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
+ }
@@ -0,0 +1,29 @@
1
+ import type { FunctionCall, FunctionSelector } from '@aztec/stdlib/abi';
2
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
3
+ import type { ContractInstance } from '@aztec/stdlib/contract';
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 { ContractStore } from '../storage/contract_store/contract_store.js';
8
+ import type { NoteStore } from '../storage/note_store/note_store.js';
9
+ /**
10
+ * Read the current class id of a contract from the execution data provider or AztecNode. If not found, class id
11
+ * from the instance is used.
12
+ * @param contractAddress - The address of the contract to read the class id for.
13
+ * @param instance - The instance of the contract.
14
+ * @param aztecNode - The Aztec node to query for storage.
15
+ * @param header - The header of the block at which to load the DelayedPublicMutable storing the class id.
16
+ * @returns The current class id.
17
+ */
18
+ export declare function readCurrentClassId(contractAddress: AztecAddress, instance: ContractInstance, aztecNode: AztecNode, header: BlockHeader): Promise<import("@aztec/foundation/schemas").Fr>;
19
+ export declare function syncState(contractAddress: AztecAddress, contractStore: ContractStore, functionToInvokeAfterSync: FunctionSelector | null, utilityExecutor: (privateSyncCall: FunctionCall, scopes: AccessScopes) => Promise<any>, noteStore: NoteStore, aztecNode: AztecNode, anchorBlockHeader: BlockHeader, jobId: string, scopes: AccessScopes): Promise<void>;
20
+ /**
21
+ * Verify that the current class id of a contract obtained from AztecNode is the same as the one in contract data
22
+ * provider (i.e. PXE's own storage).
23
+ * @param contractAddress - The address of the contract to verify.
24
+ * @param aztecNode - The Aztec node to query for storage.
25
+ * @param contractStore - The contract store to fetch the local instance from.
26
+ * @param header - The header of the block at which to verify the current class id.
27
+ */
28
+ export declare function verifyCurrentClassId(contractAddress: AztecAddress, aztecNode: AztecNode, contractStore: ContractStore, header: BlockHeader): Promise<void>;
29
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0X3N5bmMvaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUN4RSxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUNoRSxPQUFPLEtBQUssRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLHdCQUF3QixDQUFDO0FBRS9ELE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBQ2pFLE9BQU8sS0FBSyxFQUFFLFdBQVcsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBRXBELE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBRXhELE9BQU8sS0FBSyxFQUFFLGFBQWEsRUFBRSxNQUFNLDZDQUE2QyxDQUFDO0FBQ2pGLE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLHFDQUFxQyxDQUFDO0FBRXJFOzs7Ozs7OztHQVFHO0FBQ0gsd0JBQXNCLGtCQUFrQixDQUN0QyxlQUFlLEVBQUUsWUFBWSxFQUM3QixRQUFRLEVBQUUsZ0JBQWdCLEVBQzFCLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLE1BQU0sRUFBRSxXQUFXLG1EQWFwQjtBQUVELHdCQUFzQixTQUFTLENBQzdCLGVBQWUsRUFBRSxZQUFZLEVBQzdCLGFBQWEsRUFBRSxhQUFhLEVBQzVCLHlCQUF5QixFQUFFLGdCQUFnQixHQUFHLElBQUksRUFDbEQsZUFBZSxFQUFFLENBQUMsZUFBZSxFQUFFLFlBQVksRUFBRSxNQUFNLEVBQUUsWUFBWSxLQUFLLE9BQU8sQ0FBQyxHQUFHLENBQUMsRUFDdEYsU0FBUyxFQUFFLFNBQVMsRUFDcEIsU0FBUyxFQUFFLFNBQVMsRUFDcEIsaUJBQWlCLEVBQUUsV0FBVyxFQUM5QixLQUFLLEVBQUUsTUFBTSxFQUNiLE1BQU0sRUFBRSxZQUFZLGlCQW9CckI7QUFFRDs7Ozs7OztHQU9HO0FBQ0gsd0JBQXNCLG9CQUFvQixDQUN4QyxlQUFlLEVBQUUsWUFBWSxFQUM3QixTQUFTLEVBQUUsU0FBUyxFQUNwQixhQUFhLEVBQUUsYUFBYSxFQUM1QixNQUFNLEVBQUUsV0FBVyxpQkFhcEIifQ==
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/contract_sync/helpers.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,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;AAExD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AACjF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAErE;;;;;;;;GAQG;AACH,wBAAsB,kBAAkB,CACtC,eAAe,EAAE,YAAY,EAC7B,QAAQ,EAAE,gBAAgB,EAC1B,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,WAAW,mDAapB;AAED,wBAAsB,SAAS,CAC7B,eAAe,EAAE,YAAY,EAC7B,aAAa,EAAE,aAAa,EAC5B,yBAAyB,EAAE,gBAAgB,GAAG,IAAI,EAClD,eAAe,EAAE,CAAC,eAAe,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,GAAG,CAAC,EACtF,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,iBAAiB,EAAE,WAAW,EAC9B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,YAAY,iBAoBrB;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,eAAe,EAAE,YAAY,EAC7B,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,WAAW,iBAapB"}