@aztec/pxe 0.0.1-commit.d431d1c → 0.0.1-commit.e2b2873ed

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 (179) hide show
  1. package/dest/bin/check_oracle_version.js +1 -1
  2. package/dest/block_synchronizer/block_synchronizer.d.ts +9 -5
  3. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  4. package/dest/block_synchronizer/block_synchronizer.js +62 -16
  5. package/dest/config/index.d.ts +3 -1
  6. package/dest/config/index.d.ts.map +1 -1
  7. package/dest/config/index.js +17 -0
  8. package/dest/contract_function_simulator/contract_function_simulator.d.ts +50 -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 +71 -40
  11. package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +1 -1
  12. package/dest/contract_function_simulator/noir-structs/event_validation_request.js +1 -1
  13. package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +1 -1
  14. package/dest/contract_function_simulator/noir-structs/note_validation_request.js +1 -1
  15. package/dest/contract_function_simulator/oracle/interfaces.d.ts +15 -12
  16. package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
  17. package/dest/contract_function_simulator/oracle/oracle.d.ts +7 -5
  18. package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
  19. package/dest/contract_function_simulator/oracle/oracle.js +51 -29
  20. package/dest/contract_function_simulator/oracle/private_execution.d.ts +2 -22
  21. package/dest/contract_function_simulator/oracle/private_execution.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/oracle/private_execution.js +0 -37
  23. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +43 -36
  24. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  25. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +87 -23
  26. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +61 -30
  27. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  28. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +108 -86
  29. package/dest/contract_sync/contract_sync_service.d.ts +42 -0
  30. package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
  31. package/dest/contract_sync/contract_sync_service.js +97 -0
  32. package/dest/contract_sync/helpers.d.ts +28 -0
  33. package/dest/contract_sync/helpers.d.ts.map +1 -0
  34. package/dest/contract_sync/helpers.js +55 -0
  35. package/dest/debug/pxe_debug_utils.d.ts +22 -9
  36. package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
  37. package/dest/debug/pxe_debug_utils.js +28 -17
  38. package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
  39. package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
  40. package/dest/entrypoints/client/bundle/utils.js +21 -7
  41. package/dest/entrypoints/client/lazy/utils.d.ts +2 -2
  42. package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
  43. package/dest/entrypoints/client/lazy/utils.js +22 -8
  44. package/dest/entrypoints/pxe_creation_options.d.ts +3 -2
  45. package/dest/entrypoints/pxe_creation_options.d.ts.map +1 -1
  46. package/dest/entrypoints/server/index.d.ts +2 -1
  47. package/dest/entrypoints/server/index.d.ts.map +1 -1
  48. package/dest/entrypoints/server/index.js +1 -0
  49. package/dest/entrypoints/server/utils.d.ts +1 -1
  50. package/dest/entrypoints/server/utils.d.ts.map +1 -1
  51. package/dest/entrypoints/server/utils.js +28 -9
  52. package/dest/events/event_service.d.ts +5 -6
  53. package/dest/events/event_service.d.ts.map +1 -1
  54. package/dest/events/event_service.js +6 -7
  55. package/dest/job_coordinator/job_coordinator.d.ts +3 -2
  56. package/dest/job_coordinator/job_coordinator.d.ts.map +1 -1
  57. package/dest/job_coordinator/job_coordinator.js +3 -2
  58. package/dest/logs/log_service.d.ts +6 -5
  59. package/dest/logs/log_service.d.ts.map +1 -1
  60. package/dest/logs/log_service.js +24 -28
  61. package/dest/notes/note_service.d.ts +6 -6
  62. package/dest/notes/note_service.d.ts.map +1 -1
  63. package/dest/notes/note_service.js +14 -14
  64. package/dest/oracle_version.d.ts +3 -3
  65. package/dest/oracle_version.d.ts.map +1 -1
  66. package/dest/oracle_version.js +4 -3
  67. package/dest/private_kernel/private_kernel_execution_prover.d.ts +3 -2
  68. package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
  69. package/dest/private_kernel/private_kernel_execution_prover.js +2 -2
  70. package/dest/private_kernel/private_kernel_oracle.d.ts +3 -3
  71. package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
  72. package/dest/pxe.d.ts +68 -23
  73. package/dest/pxe.d.ts.map +1 -1
  74. package/dest/pxe.js +78 -48
  75. package/dest/storage/address_store/address_store.d.ts +1 -1
  76. package/dest/storage/address_store/address_store.d.ts.map +1 -1
  77. package/dest/storage/address_store/address_store.js +12 -11
  78. package/dest/storage/anchor_block_store/anchor_block_store.d.ts +9 -1
  79. package/dest/storage/anchor_block_store/anchor_block_store.d.ts.map +1 -1
  80. package/dest/storage/anchor_block_store/anchor_block_store.js +8 -1
  81. package/dest/storage/capsule_store/capsule_store.js +6 -8
  82. package/dest/storage/contract_store/contract_store.d.ts +1 -2
  83. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  84. package/dest/storage/contract_store/contract_store.js +27 -30
  85. package/dest/storage/metadata.d.ts +1 -1
  86. package/dest/storage/metadata.js +1 -1
  87. package/dest/storage/note_store/note_store.d.ts +47 -50
  88. package/dest/storage/note_store/note_store.d.ts.map +1 -1
  89. package/dest/storage/note_store/note_store.js +278 -252
  90. package/dest/storage/note_store/stored_note.d.ts +16 -0
  91. package/dest/storage/note_store/stored_note.d.ts.map +1 -0
  92. package/dest/storage/note_store/stored_note.js +43 -0
  93. package/dest/storage/private_event_store/private_event_store.d.ts +17 -4
  94. package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
  95. package/dest/storage/private_event_store/private_event_store.js +198 -147
  96. package/dest/storage/private_event_store/stored_private_event.d.ts +23 -0
  97. package/dest/storage/private_event_store/stored_private_event.d.ts.map +1 -0
  98. package/dest/storage/private_event_store/stored_private_event.js +56 -0
  99. package/dest/storage/tagging_store/recipient_tagging_store.d.ts +1 -1
  100. package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
  101. package/dest/storage/tagging_store/recipient_tagging_store.js +31 -19
  102. package/dest/storage/tagging_store/sender_address_book_store.d.ts +1 -1
  103. package/dest/storage/tagging_store/sender_address_book_store.d.ts.map +1 -1
  104. package/dest/storage/tagging_store/sender_address_book_store.js +20 -14
  105. package/dest/storage/tagging_store/sender_tagging_store.d.ts +1 -1
  106. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  107. package/dest/storage/tagging_store/sender_tagging_store.js +183 -113
  108. package/dest/tagging/get_all_logs_by_tags.d.ts +24 -0
  109. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -0
  110. package/dest/tagging/get_all_logs_by_tags.js +46 -0
  111. package/dest/tagging/index.d.ts +2 -1
  112. package/dest/tagging/index.d.ts.map +1 -1
  113. package/dest/tagging/index.js +1 -0
  114. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +3 -2
  115. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
  116. package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +2 -2
  117. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +3 -2
  118. package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
  119. package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +5 -2
  120. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +3 -2
  121. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  122. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +2 -2
  123. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +1 -1
  124. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
  125. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +5 -8
  126. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +3 -2
  127. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  128. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +7 -4
  129. package/package.json +25 -16
  130. package/src/bin/check_oracle_version.ts +1 -0
  131. package/src/block_synchronizer/block_synchronizer.ts +76 -33
  132. package/src/config/index.ts +14 -0
  133. package/src/contract_function_simulator/contract_function_simulator.ts +117 -87
  134. package/src/contract_function_simulator/noir-structs/event_validation_request.ts +1 -1
  135. package/src/contract_function_simulator/noir-structs/note_validation_request.ts +1 -1
  136. package/src/contract_function_simulator/oracle/interfaces.ts +20 -11
  137. package/src/contract_function_simulator/oracle/oracle.ts +56 -26
  138. package/src/contract_function_simulator/oracle/private_execution.ts +1 -60
  139. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +122 -101
  140. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +170 -95
  141. package/src/contract_sync/contract_sync_service.ts +145 -0
  142. package/src/contract_sync/helpers.ts +93 -0
  143. package/src/debug/pxe_debug_utils.ts +61 -17
  144. package/src/entrypoints/client/bundle/utils.ts +16 -15
  145. package/src/entrypoints/client/lazy/utils.ts +17 -15
  146. package/src/entrypoints/pxe_creation_options.ts +2 -1
  147. package/src/entrypoints/server/index.ts +1 -0
  148. package/src/entrypoints/server/utils.ts +22 -26
  149. package/src/events/event_service.ts +5 -7
  150. package/src/job_coordinator/job_coordinator.ts +4 -3
  151. package/src/logs/log_service.ts +35 -28
  152. package/src/notes/note_service.ts +21 -20
  153. package/src/oracle_version.ts +4 -3
  154. package/src/private_kernel/private_kernel_execution_prover.ts +6 -3
  155. package/src/private_kernel/private_kernel_oracle.ts +2 -2
  156. package/src/pxe.ts +178 -85
  157. package/src/storage/address_store/address_store.ts +15 -15
  158. package/src/storage/anchor_block_store/anchor_block_store.ts +8 -0
  159. package/src/storage/capsule_store/capsule_store.ts +8 -8
  160. package/src/storage/contract_store/contract_store.ts +26 -35
  161. package/src/storage/metadata.ts +1 -1
  162. package/src/storage/note_store/note_store.ts +317 -318
  163. package/src/storage/note_store/stored_note.ts +48 -0
  164. package/src/storage/private_event_store/private_event_store.ts +250 -190
  165. package/src/storage/private_event_store/stored_private_event.ts +73 -0
  166. package/src/storage/tagging_store/recipient_tagging_store.ts +31 -21
  167. package/src/storage/tagging_store/sender_address_book_store.ts +20 -14
  168. package/src/storage/tagging_store/sender_tagging_store.ts +210 -126
  169. package/src/tagging/get_all_logs_by_tags.ts +68 -0
  170. package/src/tagging/index.ts +1 -0
  171. package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +11 -1
  172. package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +7 -1
  173. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +3 -1
  174. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +5 -17
  175. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +12 -3
  176. package/dest/tree_membership/tree_membership_service.d.ts +0 -50
  177. package/dest/tree_membership/tree_membership_service.d.ts.map +0 -1
  178. package/dest/tree_membership/tree_membership_service.js +0 -75
  179. package/src/tree_membership/tree_membership_service.ts +0 -97
@@ -4,11 +4,12 @@ import { LogLevels, applyStringFormatting, createLogger } from '@aztec/foundatio
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
+ import { getNonNullifiedL1ToL2MessageWitness } from '@aztec/stdlib/messaging';
8
+ import { MerkleTreeId } from '@aztec/stdlib/trees';
7
9
  import { EventService } from '../../events/event_service.js';
8
10
  import { LogService } from '../../logs/log_service.js';
9
11
  import { NoteService } from '../../notes/note_service.js';
10
12
  import { ORACLE_VERSION } from '../../oracle_version.js';
11
- import { TreeMembershipService } from '../../tree_membership/tree_membership_service.js';
12
13
  import { EventValidationRequest } from '../noir-structs/event_validation_request.js';
13
14
  import { LogRetrievalRequest } from '../noir-structs/log_retrieval_request.js';
14
15
  import { LogRetrievalResponse } from '../noir-structs/log_retrieval_response.js';
@@ -19,6 +20,9 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
19
20
  /**
20
21
  * The oracle for an execution of utility contract functions.
21
22
  */ export class UtilityExecutionOracle {
23
+ isMisc = true;
24
+ isUtility = true;
25
+ contractLogger;
22
26
  contractAddress;
23
27
  authWitnesses;
24
28
  capsules;
@@ -28,7 +32,6 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
28
32
  keyStore;
29
33
  addressStore;
30
34
  aztecNode;
31
- anchorBlockStore;
32
35
  recipientTaggingStore;
33
36
  senderAddressBookStore;
34
37
  capsuleStore;
@@ -36,30 +39,23 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
36
39
  jobId;
37
40
  log;
38
41
  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, anchorBlockStore, 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.anchorBlockStore = anchorBlockStore;
53
- this.recipientTaggingStore = recipientTaggingStore;
54
- this.senderAddressBookStore = senderAddressBookStore;
55
- this.capsuleStore = capsuleStore;
56
- this.privateEventStore = privateEventStore;
57
- this.jobId = jobId;
58
- this.log = log;
59
- this.scopes = scopes;
60
- this.isMisc = true;
61
- this.isUtility = true;
62
- this.aztecNrDebugLog = createLogger('aztec-nr:debug_log');
42
+ constructor(args){
43
+ this.contractAddress = args.contractAddress;
44
+ this.authWitnesses = args.authWitnesses;
45
+ this.capsules = args.capsules;
46
+ this.anchorBlockHeader = args.anchorBlockHeader;
47
+ this.contractStore = args.contractStore;
48
+ this.noteStore = args.noteStore;
49
+ this.keyStore = args.keyStore;
50
+ this.addressStore = args.addressStore;
51
+ this.aztecNode = args.aztecNode;
52
+ this.recipientTaggingStore = args.recipientTaggingStore;
53
+ this.senderAddressBookStore = args.senderAddressBookStore;
54
+ this.capsuleStore = args.capsuleStore;
55
+ this.privateEventStore = args.privateEventStore;
56
+ this.jobId = args.jobId;
57
+ this.log = args.log ?? createLogger('simulator:client_view_context');
58
+ this.scopes = args.scopes;
63
59
  }
64
60
  utilityAssertCompatibleOracleVersion(version) {
65
61
  if (version !== ORACLE_VERSION) {
@@ -77,26 +73,51 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
77
73
  * @param pkMHash - The master public key hash.
78
74
  * @returns A Promise that resolves to nullifier keys.
79
75
  * @throws If the keys are not registered in the key store.
80
- */ utilityGetKeyValidationRequest(pkMHash) {
76
+ * @throws If scopes are defined and the account is not in the scopes.
77
+ */ async utilityGetKeyValidationRequest(pkMHash) {
78
+ // If scopes are defined, check that the key belongs to an account in the scopes.
79
+ if (this.scopes && this.scopes.length > 0) {
80
+ let hasAccess = false;
81
+ for(let i = 0; i < this.scopes.length && !hasAccess; i++){
82
+ if (await this.keyStore.accountHasKey(this.scopes[i], pkMHash)) {
83
+ hasAccess = true;
84
+ }
85
+ }
86
+ if (!hasAccess) {
87
+ throw new Error(`Key validation request denied: no scoped account has a key with hash ${pkMHash.toString()}.`);
88
+ }
89
+ }
81
90
  return this.keyStore.getKeyValidationRequest(pkMHash, this.contractAddress);
82
91
  }
83
92
  /**
84
- * Fetches the index and sibling path of a leaf at a given block from a given tree.
85
- * @param blockHash - The block hash at which to get the membership witness.
86
- * @param treeId - Id of the tree to get the sibling path from.
87
- * @param leafValue - The leaf value
88
- * @returns The index and sibling path concatenated [index, sibling_path]
89
- */ utilityGetMembershipWitness(blockHash, treeId, leafValue) {
90
- const treeMembershipService = new TreeMembershipService(this.aztecNode);
91
- return treeMembershipService.getMembershipWitness(blockHash, treeId, leafValue);
93
+ * Fetches the index and sibling path of a leaf at a given block from the note hash tree.
94
+ * @param anchorBlockHash - The hash of a block that contains the note hash tree root in which to find the membership
95
+ * witness.
96
+ * @param noteHash - The note hash to find in the note hash tree.
97
+ * @returns The membership witness containing the leaf index and sibling path
98
+ */ utilityGetNoteHashMembershipWitness(anchorBlockHash, noteHash) {
99
+ return this.aztecNode.getNoteHashMembershipWitness(anchorBlockHash, noteHash);
100
+ }
101
+ /**
102
+ * Fetches the index and sibling path of a block hash in the archive tree.
103
+ *
104
+ * Block hashes are the leaves of the archive tree. Each time a new block is added to the chain,
105
+ * its block hash is appended as a new leaf to the archive tree.
106
+ *
107
+ * @param anchorBlockHash - The hash of a block that contains the archive tree root in which to find the membership
108
+ * witness.
109
+ * @param blockHash - The block hash to find in the archive tree.
110
+ * @returns The membership witness containing the leaf index and sibling path
111
+ */ utilityGetBlockHashMembershipWitness(anchorBlockHash, blockHash) {
112
+ return this.aztecNode.getBlockHashMembershipWitness(anchorBlockHash, blockHash);
92
113
  }
93
114
  /**
94
115
  * Returns a nullifier membership witness for a given nullifier at a given block.
95
116
  * @param blockHash - The block hash at which to get the index.
96
117
  * @param nullifier - Nullifier we try to find witness for.
97
118
  * @returns The nullifier membership witness (if found).
98
- */ async utilityGetNullifierMembershipWitness(blockHash, nullifier) {
99
- return await this.aztecNode.getNullifierMembershipWitness(blockHash, nullifier);
119
+ */ utilityGetNullifierMembershipWitness(blockHash, nullifier) {
120
+ return this.aztecNode.getNullifierMembershipWitness(blockHash, nullifier);
100
121
  }
101
122
  /**
102
123
  * Returns a low nullifier membership witness for a given nullifier at a given block.
@@ -106,25 +127,23 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
106
127
  * @remarks Low nullifier witness can be used to perform a nullifier non-inclusion proof by leveraging the "linked
107
128
  * list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
108
129
  * we are trying to prove non-inclusion for.
109
- */ async utilityGetLowNullifierMembershipWitness(blockHash, nullifier) {
110
- const treeMembershipService = new TreeMembershipService(this.aztecNode);
111
- return await treeMembershipService.getLowNullifierMembershipWitness(blockHash, nullifier);
130
+ */ utilityGetLowNullifierMembershipWitness(blockHash, nullifier) {
131
+ return this.aztecNode.getLowNullifierMembershipWitness(blockHash, nullifier);
112
132
  }
113
133
  /**
114
134
  * Returns a public data tree witness for a given leaf slot at a given block.
115
135
  * @param blockHash - The block hash at which to get the index.
116
136
  * @param leafSlot - The slot of the public data tree to get the witness for.
117
137
  * @returns - The witness
118
- */ async utilityGetPublicDataWitness(blockHash, leafSlot) {
119
- const treeMembershipService = new TreeMembershipService(this.aztecNode);
120
- return await treeMembershipService.getPublicDataWitness(blockHash, leafSlot);
138
+ */ utilityGetPublicDataWitness(blockHash, leafSlot) {
139
+ return this.aztecNode.getPublicDataWitness(blockHash, leafSlot);
121
140
  }
122
141
  /**
123
142
  * Fetches a block header of a given block.
124
143
  * @param blockNumber - The number of a block of which to get the block header.
125
144
  * @returns Block extracted from a block with block number `blockNumber`.
126
145
  */ async utilityGetBlockHeader(blockNumber) {
127
- const anchorBlockNumber = (await this.anchorBlockStore.getBlockHeader()).getBlockNumber();
146
+ const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
128
147
  if (blockNumber > anchorBlockNumber) {
129
148
  throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
130
149
  }
@@ -134,12 +153,11 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
134
153
  /**
135
154
  * Retrieve the complete address associated to a given address.
136
155
  * @param account - The account address.
137
- * @returns A complete address associated with the input address.
138
- * @throws An error if the account is not registered in the database.
139
- */ utilityGetPublicKeysAndPartialAddress(account) {
140
- return this.getCompleteAddress(account);
156
+ * @returns A complete address associated with the input address, or `undefined` if not registered.
157
+ */ utilityTryGetPublicKeysAndPartialAddress(account) {
158
+ return this.addressStore.getCompleteAddress(account);
141
159
  }
142
- async getCompleteAddress(account) {
160
+ async getCompleteAddressOrFail(account) {
143
161
  const completeAddress = await this.addressStore.getCompleteAddress(account);
144
162
  if (!completeAddress) {
145
163
  throw new Error(`No public key registered for address ${account}.
@@ -191,7 +209,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
191
209
  * @param status - The status of notes to fetch.
192
210
  * @returns Array of note data.
193
211
  */ async utilityGetNotes(owner, storageSlot, numSelects, selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, limit, offset, status) {
194
- const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore);
212
+ const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
195
213
  const dbNotes = await noteService.getNotes(this.contractAddress, owner, storageSlot, status, this.scopes);
196
214
  return pickNotes(dbNotes, {
197
215
  selects: selectByIndexes.slice(0, numSelects).map((index, i)=>({
@@ -220,10 +238,14 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
220
238
  * @param innerNullifier - The inner nullifier.
221
239
  * @returns A boolean indicating whether the nullifier exists in the tree or not.
222
240
  */ async utilityCheckNullifierExists(innerNullifier) {
223
- const nullifier = await siloNullifier(this.contractAddress, innerNullifier);
224
- const treeMembershipService = new TreeMembershipService(this.aztecNode);
225
- const index = await treeMembershipService.getNullifierIndex(nullifier);
226
- return index !== undefined;
241
+ const [nullifier, anchorBlockHash] = await Promise.all([
242
+ siloNullifier(this.contractAddress, innerNullifier),
243
+ this.anchorBlockHeader.hash()
244
+ ]);
245
+ const [leafIndex] = await this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, [
246
+ nullifier
247
+ ]);
248
+ return leafIndex?.data !== undefined;
227
249
  }
228
250
  /**
229
251
  * Fetches a message from the executionStore, given its key.
@@ -233,9 +255,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
233
255
  * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
234
256
  * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
235
257
  */ async utilityGetL1ToL2MembershipWitness(contractAddress, messageHash, secret) {
236
- const treeMembershipService = new TreeMembershipService(this.aztecNode);
237
- const [messageIndex, siblingPath] = await treeMembershipService.getL1ToL2MembershipWitness(contractAddress, messageHash, secret);
238
- // Assuming messageIndex is what you intended to use for the index in MessageLoadOracleInputs
258
+ const [messageIndex, siblingPath] = await getNonNullifiedL1ToL2MessageWitness(this.aztecNode, contractAddress, messageHash, secret);
239
259
  return new MessageLoadOracleInputs(messageIndex, siblingPath);
240
260
  }
241
261
  /**
@@ -245,35 +265,37 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
245
265
  * @param startStorageSlot - The starting storage slot.
246
266
  * @param numberOfElements - Number of elements to read from the starting storage slot.
247
267
  */ async utilityStorageRead(blockHash, contractAddress, startStorageSlot, numberOfElements) {
248
- const values = [];
249
- // TODO: why do we serialize these requests? This should probably a single call
250
- // Privacy considerations?
251
- for(let i = 0n; i < numberOfElements; i++){
252
- const storageSlot = new Fr(startStorageSlot.value + i);
253
- const value = await this.aztecNode.getPublicStorageAt(blockHash, contractAddress, storageSlot);
254
- this.log.debug(`Oracle storage read: slot=${storageSlot.toString()} address-${contractAddress.toString()} value=${value}`);
255
- values.push(value);
256
- }
268
+ const slots = Array(numberOfElements).fill(0).map((_, i)=>new Fr(startStorageSlot.value + BigInt(i)));
269
+ const values = await Promise.all(slots.map((storageSlot)=>this.aztecNode.getPublicStorageAt(blockHash, contractAddress, storageSlot)));
270
+ this.log.debug(`Oracle storage read: slots=[${slots.map((slot)=>slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`);
257
271
  return values;
258
272
  }
259
- utilityDebugLog(level, message, fields) {
273
+ /**
274
+ * Returns a per-contract logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
275
+ */ async #getContractLogger() {
276
+ if (!this.contractLogger) {
277
+ const addrAbbrev = this.contractAddress.toString().slice(0, 10);
278
+ const name = await this.contractStore.getDebugContractName(this.contractAddress);
279
+ const module = name ? `contract_log::${name}(${addrAbbrev})` : `contract_log::${addrAbbrev}`;
280
+ // Purpose of instanceId is to distinguish logs from different instances of the same component. It makes sense
281
+ // to re-use jobId as instanceId here as executions of different PXE jobs are isolated.
282
+ this.contractLogger = createLogger(module, {
283
+ instanceId: this.jobId
284
+ });
285
+ }
286
+ return this.contractLogger;
287
+ }
288
+ async utilityLog(level, message, fields) {
260
289
  if (!LogLevels[level]) {
261
- throw new Error(`Invalid debug log level: ${level}`);
290
+ throw new Error(`Invalid log level: ${level}`);
262
291
  }
263
292
  const levelName = LogLevels[level];
264
- this.aztecNrDebugLog[levelName](`${applyStringFormatting(message, fields)}`);
293
+ const logger = await this.#getContractLogger();
294
+ logger[levelName](`${applyStringFormatting(message, fields)}`);
265
295
  }
266
296
  async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot) {
267
- const logService = new LogService(this.aztecNode, this.anchorBlockStore, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId);
268
- const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore);
269
- // It is acceptable to run the following operations in parallel for several reasons:
270
- // 1. syncTaggedLogs does not write to the note store — it only stores the pending tagged logs in a capsule array,
271
- // which is then processed in Noir after this handler returns.
272
- // 2. Even if syncTaggedLogs did write to the note store, it would not cause inconsistent state.
273
- await Promise.all([
274
- logService.syncTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes),
275
- noteService.syncNoteNullifiers(this.contractAddress)
276
- ]);
297
+ const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.log.getBindings());
298
+ await logService.fetchTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
277
299
  }
278
300
  /**
279
301
  * Validates all note and event validation requests enqueued via `enqueue_note_for_validation` and
@@ -284,7 +306,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
284
306
  * @param contractAddress - The address of the contract that the logs are tagged for.
285
307
  * @param noteValidationRequestsArrayBaseSlot - The base slot of capsule array containing note validation requests.
286
308
  * @param eventValidationRequestsArrayBaseSlot - The base slot of capsule array containing event validation requests.
287
- */ async utilityValidateEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot) {
309
+ */ async utilityValidateAndStoreEnqueuedNotesAndEvents(contractAddress, noteValidationRequestsArrayBaseSlot, eventValidationRequestsArrayBaseSlot) {
288
310
  // TODO(#10727): allow other contracts to store notes
289
311
  if (!this.contractAddress.equals(contractAddress)) {
290
312
  throw new Error(`Got a note validation request from ${contractAddress}, expected ${this.contractAddress}`);
@@ -293,10 +315,10 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
293
315
  // faster as we don't need to wait for the network round-trip.
294
316
  const noteValidationRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, this.jobId)).map(NoteValidationRequest.fromFields);
295
317
  const eventValidationRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, this.jobId)).map(EventValidationRequest.fromFields);
296
- const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockStore);
297
- const noteStorePromises = noteValidationRequests.map((request)=>noteService.storeNote(request.contractAddress, request.owner, request.storageSlot, request.randomness, request.noteNonce, request.content, request.noteHash, request.nullifier, request.txHash, request.recipient));
298
- const eventService = new EventService(this.anchorBlockStore, this.aztecNode, this.privateEventStore, this.jobId);
299
- const eventStorePromises = eventValidationRequests.map((request)=>eventService.storeEvent(request.contractAddress, request.eventTypeId, request.randomness, request.serializedEvent, request.eventCommitment, request.txHash, request.recipient));
318
+ const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
319
+ 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));
320
+ const eventService = new EventService(this.anchorBlockHeader, this.aztecNode, this.privateEventStore, this.jobId);
321
+ const eventStorePromises = eventValidationRequests.map((request)=>eventService.validateAndStoreEvent(request.contractAddress, request.eventTypeId, request.randomness, request.serializedEvent, request.eventCommitment, request.txHash, request.recipient));
300
322
  await Promise.all([
301
323
  ...noteStorePromises,
302
324
  ...eventStorePromises
@@ -313,7 +335,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
313
335
  // We read all log retrieval requests and process them all concurrently. This makes the process much faster as we
314
336
  // don't need to wait for the network round-trip.
315
337
  const logRetrievalRequests = (await this.capsuleStore.readCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, this.jobId)).map(LogRetrievalRequest.fromFields);
316
- const logService = new LogService(this.aztecNode, this.anchorBlockStore, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId);
338
+ const logService = new LogService(this.aztecNode, this.anchorBlockHeader, this.keyStore, this.capsuleStore, this.recipientTaggingStore, this.senderAddressBookStore, this.addressStore, this.jobId, this.log.getBindings());
317
339
  const maybeLogRetrievalResponses = await logService.bulkRetrieveLogs(logRetrievalRequests);
318
340
  // Requests are cleared once we're done.
319
341
  await this.capsuleStore.setCapsuleArray(contractAddress, logRetrievalRequestsArrayBaseSlot, [], this.jobId);
@@ -366,7 +388,7 @@ import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
366
388
  }
367
389
  async getSharedSecret(address, ephPk) {
368
390
  // TODO(#12656): return an app-siloed secret
369
- const recipientCompleteAddress = await this.getCompleteAddress(address);
391
+ const recipientCompleteAddress = await this.getCompleteAddressOrFail(address);
370
392
  const ivskM = await this.keyStore.getMasterSecretKey(recipientCompleteAddress.publicKeys.masterIncomingViewingPublicKey);
371
393
  const addressSecret = await computeAddressSecret(await recipientCompleteAddress.getPreaddress(), ivskM);
372
394
  return deriveEcdhSharedSecret(addressSecret, ephPk);
@@ -0,0 +1,42 @@
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 { StagedStore } from '../job_coordinator/job_coordinator.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
+ * Service for syncing the private state of contracts and verifying that the PXE holds the current class artifact.
11
+ * It uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
12
+ *
13
+ * TODO: The StagedStore naming is broken here. Figure out a better name.
14
+ */
15
+ export declare class ContractSyncService implements StagedStore {
16
+ #private;
17
+ private aztecNode;
18
+ private contractStore;
19
+ private noteStore;
20
+ private log;
21
+ readonly storeName = "contract_sync";
22
+ private syncedContracts;
23
+ private overriddenContracts;
24
+ constructor(aztecNode: AztecNode, contractStore: ContractStore, noteStore: NoteStore, log: Logger);
25
+ /** Sets contracts that should be skipped during sync for a specific job. */
26
+ setOverriddenContracts(jobId: string, addresses: Set<string>): void;
27
+ /**
28
+ * Ensures a contract's private state is synchronized and that the PXE holds the current class artifact.
29
+ * Uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
30
+ * @param contractAddress - The address of the contract to sync.
31
+ * @param functionToInvokeAfterSync - The function selector that will be called after sync (used to validate it's
32
+ * not sync_state itself).
33
+ * @param utilityExecutor - Executor function for running the sync_state utility function.
34
+ * @param scopes - Scopes to pass through to the utility executor (affects which notes are discovered).
35
+ */
36
+ ensureContractSynced(contractAddress: AztecAddress, functionToInvokeAfterSync: FunctionSelector | null, utilityExecutor: (call: FunctionCall, scopes: undefined | AztecAddress[]) => Promise<any>, anchorBlockHeader: BlockHeader, jobId: string, scopes: undefined | AztecAddress[]): Promise<void>;
37
+ /** Clears sync cache. Called by BlockSynchronizer when anchor block changes. */
38
+ wipe(): void;
39
+ commit(jobId: string): Promise<void>;
40
+ discardStaged(jobId: string): Promise<void>;
41
+ }
42
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3Rfc3luY19zZXJ2aWNlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29udHJhY3Rfc3luYy9jb250cmFjdF9zeW5jX3NlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFDcEQsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLGdCQUFnQixFQUFFLE1BQU0sbUJBQW1CLENBQUM7QUFDeEUsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLE1BQU0sNkJBQTZCLENBQUM7QUFDaEUsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDakUsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFFcEQsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0sdUNBQXVDLENBQUM7QUFDekUsT0FBTyxLQUFLLEVBQUUsYUFBYSxFQUFFLE1BQU0sNkNBQTZDLENBQUM7QUFDakYsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0scUNBQXFDLENBQUM7QUFHckU7Ozs7O0dBS0c7QUFDSCxxQkFBYSxtQkFBb0IsWUFBVyxXQUFXOztJQVluRCxPQUFPLENBQUMsU0FBUztJQUNqQixPQUFPLENBQUMsYUFBYTtJQUNyQixPQUFPLENBQUMsU0FBUztJQUNqQixPQUFPLENBQUMsR0FBRztJQWRiLFFBQVEsQ0FBQyxTQUFTLG1CQUFtQjtJQUtyQyxPQUFPLENBQUMsZUFBZSxDQUF5QztJQUdoRSxPQUFPLENBQUMsbUJBQW1CLENBQXVDO0lBRWxFLFlBQ1UsU0FBUyxFQUFFLFNBQVMsRUFDcEIsYUFBYSxFQUFFLGFBQWEsRUFDNUIsU0FBUyxFQUFFLFNBQVMsRUFDcEIsR0FBRyxFQUFFLE1BQU0sRUFDakI7SUFFSiw0RUFBNEU7SUFDNUUsc0JBQXNCLENBQUMsS0FBSyxFQUFFLE1BQU0sRUFBRSxTQUFTLEVBQUUsR0FBRyxDQUFDLE1BQU0sQ0FBQyxHQUFHLElBQUksQ0FFbEU7SUFFRDs7Ozs7Ozs7T0FRRztJQUNHLG9CQUFvQixDQUN4QixlQUFlLEVBQUUsWUFBWSxFQUM3Qix5QkFBeUIsRUFBRSxnQkFBZ0IsR0FBRyxJQUFJLEVBQ2xELGVBQWUsRUFBRSxDQUFDLElBQUksRUFBRSxZQUFZLEVBQUUsTUFBTSxFQUFFLFNBQVMsR0FBRyxZQUFZLEVBQUUsS0FBSyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQ3pGLGlCQUFpQixFQUFFLFdBQVcsRUFDOUIsS0FBSyxFQUFFLE1BQU0sRUFDYixNQUFNLEVBQUUsU0FBUyxHQUFHLFlBQVksRUFBRSxHQUNqQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBbUNmO0lBMEJELGdGQUFnRjtJQUNoRixJQUFJLElBQUksSUFBSSxDQUdYO0lBRUQsTUFBTSxDQUFDLEtBQUssRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUluQztJQUVELGFBQWEsQ0FBQyxLQUFLLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FNMUM7Q0FDRiJ9
@@ -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,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,SAAS,GAAG,YAAY,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EACzF,iBAAiB,EAAE,WAAW,EAC9B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,SAAS,GAAG,YAAY,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC,CAmCf;IA0BD,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 - Scopes to pass through to the utility executor (affects which notes are 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, undefined);
47
+ const allScopesExisting = this.syncedContracts.get(allScopesKey);
48
+ if (allScopesExisting || scopes && scopes.length == 0) {
49
+ return;
50
+ }
51
+ const unsyncedScopes = 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, (call)=>utilityExecutor(call, unsyncedScopes), anchorBlockHeader, jobId).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) {
66
+ this.log.debug(`Syncing contract ${contractAddress}`);
67
+ await Promise.all([
68
+ syncState(contractAddress, this.contractStore, functionToInvokeAfterSync, utilityExecutor, this.noteStore, this.aztecNode, anchorBlockHeader, jobId),
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 === undefined ? [
92
+ toKey(contract, undefined)
93
+ ] : scopes.map((scope)=>toKey(contract, scope));
94
+ }
95
+ function toKey(contract, scope) {
96
+ return scope === undefined ? `${contract.toString()}:*` : `${contract.toString()}:${scope.toString()}`;
97
+ }
@@ -0,0 +1,28 @@
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 { ContractStore } from '../storage/contract_store/contract_store.js';
7
+ import type { NoteStore } from '../storage/note_store/note_store.js';
8
+ /**
9
+ * Read the current class id of a contract from the execution data provider or AztecNode. If not found, class id
10
+ * from the instance is used.
11
+ * @param contractAddress - The address of the contract to read the class id for.
12
+ * @param instance - The instance of the contract.
13
+ * @param aztecNode - The Aztec node to query for storage.
14
+ * @param header - The header of the block at which to load the DelayedPublicMutable storing the class id.
15
+ * @returns The current class id.
16
+ */
17
+ export declare function readCurrentClassId(contractAddress: AztecAddress, instance: ContractInstance, aztecNode: AztecNode, header: BlockHeader): Promise<import("@aztec/foundation/schemas").Fr>;
18
+ export declare function syncState(contractAddress: AztecAddress, contractStore: ContractStore, functionToInvokeAfterSync: FunctionSelector | null, utilityExecutor: (privateSyncCall: FunctionCall) => Promise<any>, noteStore: NoteStore, aztecNode: AztecNode, anchorBlockHeader: BlockHeader, jobId: string): Promise<void>;
19
+ /**
20
+ * Verify that the current class id of a contract obtained from AztecNode is the same as the one in contract data
21
+ * provider (i.e. PXE's own storage).
22
+ * @param contractAddress - The address of the contract to verify.
23
+ * @param aztecNode - The Aztec node to query for storage.
24
+ * @param contractStore - The contract store to fetch the local instance from.
25
+ * @param header - The header of the block at which to verify the current class id.
26
+ */
27
+ export declare function verifyCurrentClassId(contractAddress: AztecAddress, aztecNode: AztecNode, contractStore: ContractStore, header: BlockHeader): Promise<void>;
28
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0X3N5bmMvaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUN4RSxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUNoRSxPQUFPLEtBQUssRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLHdCQUF3QixDQUFDO0FBRS9ELE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBQ2pFLE9BQU8sS0FBSyxFQUFFLFdBQVcsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBR3BELE9BQU8sS0FBSyxFQUFFLGFBQWEsRUFBRSxNQUFNLDZDQUE2QyxDQUFDO0FBQ2pGLE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLHFDQUFxQyxDQUFDO0FBRXJFOzs7Ozs7OztHQVFHO0FBQ0gsd0JBQXNCLGtCQUFrQixDQUN0QyxlQUFlLEVBQUUsWUFBWSxFQUM3QixRQUFRLEVBQUUsZ0JBQWdCLEVBQzFCLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLE1BQU0sRUFBRSxXQUFXLG1EQWFwQjtBQUVELHdCQUFzQixTQUFTLENBQzdCLGVBQWUsRUFBRSxZQUFZLEVBQzdCLGFBQWEsRUFBRSxhQUFhLEVBQzVCLHlCQUF5QixFQUFFLGdCQUFnQixHQUFHLElBQUksRUFDbEQsZUFBZSxFQUFFLENBQUMsZUFBZSxFQUFFLFlBQVksS0FBSyxPQUFPLENBQUMsR0FBRyxDQUFDLEVBQ2hFLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLGlCQUFpQixFQUFFLFdBQVcsRUFDOUIsS0FBSyxFQUFFLE1BQU0saUJBaUJkO0FBRUQ7Ozs7Ozs7R0FPRztBQUNILHdCQUFzQixvQkFBb0IsQ0FDeEMsZUFBZSxFQUFFLFlBQVksRUFDN0IsU0FBUyxFQUFFLFNBQVMsRUFDcEIsYUFBYSxFQUFFLGFBQWEsRUFDNUIsTUFBTSxFQUFFLFdBQVcsaUJBYXBCIn0=
@@ -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;AAGpD,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,KAAK,OAAO,CAAC,GAAG,CAAC,EAChE,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,SAAS,EACpB,iBAAiB,EAAE,WAAW,EAC9B,KAAK,EAAE,MAAM,iBAiBd;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,eAAe,EAAE,YAAY,EAC7B,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,WAAW,iBAapB"}
@@ -0,0 +1,55 @@
1
+ import { ProtocolContractAddress, isProtocolContract } from '@aztec/protocol-contracts';
2
+ import { DelayedPublicMutableValues, DelayedPublicMutableValuesWithHash } from '@aztec/stdlib/delayed-public-mutable';
3
+ import { NoteService } from '../notes/note_service.js';
4
+ /**
5
+ * Read the current class id of a contract from the execution data provider or AztecNode. If not found, class id
6
+ * from the instance is used.
7
+ * @param contractAddress - The address of the contract to read the class id for.
8
+ * @param instance - The instance of the contract.
9
+ * @param aztecNode - The Aztec node to query for storage.
10
+ * @param header - The header of the block at which to load the DelayedPublicMutable storing the class id.
11
+ * @returns The current class id.
12
+ */ export async function readCurrentClassId(contractAddress, instance, aztecNode, header) {
13
+ const blockHash = await header.hash();
14
+ const timestamp = header.globalVariables.timestamp;
15
+ const { delayedPublicMutableSlot } = await DelayedPublicMutableValuesWithHash.getContractUpdateSlots(contractAddress);
16
+ const delayedPublicMutableValues = await DelayedPublicMutableValues.readFromTree(delayedPublicMutableSlot, (slot)=>aztecNode.getPublicStorageAt(blockHash, ProtocolContractAddress.ContractInstanceRegistry, slot));
17
+ let currentClassId = delayedPublicMutableValues.svc.getCurrentAt(timestamp)[0];
18
+ if (currentClassId.isZero()) {
19
+ currentClassId = instance.originalContractClassId;
20
+ }
21
+ return currentClassId;
22
+ }
23
+ export async function syncState(contractAddress, contractStore, functionToInvokeAfterSync, utilityExecutor, noteStore, aztecNode, anchorBlockHeader, jobId) {
24
+ // Protocol contracts don't have private state to sync
25
+ if (!isProtocolContract(contractAddress)) {
26
+ const syncStateFunctionCall = await contractStore.getFunctionCall('sync_state', [], contractAddress);
27
+ if (functionToInvokeAfterSync && functionToInvokeAfterSync.equals(syncStateFunctionCall.selector)) {
28
+ throw new Error('Forbidden `sync_state` invocation. `sync_state` can only be invoked by PXE, manual execution can lead to inconsistencies.');
29
+ }
30
+ const noteService = new NoteService(noteStore, aztecNode, anchorBlockHeader, jobId);
31
+ // Both sync_state and syncNoteNullifiers interact with the note store, but running them in parallel is safe
32
+ // because note store is designed to handle concurrent operations.
33
+ await Promise.all([
34
+ utilityExecutor(syncStateFunctionCall),
35
+ noteService.syncNoteNullifiers(contractAddress)
36
+ ]);
37
+ }
38
+ }
39
+ /**
40
+ * Verify that the current class id of a contract obtained from AztecNode is the same as the one in contract data
41
+ * provider (i.e. PXE's own storage).
42
+ * @param contractAddress - The address of the contract to verify.
43
+ * @param aztecNode - The Aztec node to query for storage.
44
+ * @param contractStore - The contract store to fetch the local instance from.
45
+ * @param header - The header of the block at which to verify the current class id.
46
+ */ export async function verifyCurrentClassId(contractAddress, aztecNode, contractStore, header) {
47
+ const instance = await contractStore.getContractInstance(contractAddress);
48
+ if (!instance) {
49
+ throw new Error(`No contract instance found for address ${contractAddress.toString()}`);
50
+ }
51
+ const currentClassId = await readCurrentClassId(contractAddress, instance, aztecNode, header);
52
+ if (!instance.currentContractClassId.equals(currentClassId)) {
53
+ throw new Error(`Contract ${contractAddress} is outdated, current class id is ${currentClassId}, local class id is ${instance.currentContractClassId}`);
54
+ }
55
+ }
@@ -1,6 +1,12 @@
1
+ import type { FunctionCall } from '@aztec/stdlib/abi';
2
+ import type { AuthWitness } from '@aztec/stdlib/auth-witness';
3
+ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
1
4
  import type { NoteDao, NotesFilter } from '@aztec/stdlib/note';
2
- import type { PXE } from '../pxe.js';
3
- import type { ContractStore } from '../storage/contract_store/contract_store.js';
5
+ import type { ContractOverrides } from '@aztec/stdlib/tx';
6
+ import type { BlockSynchronizer } from '../block_synchronizer/block_synchronizer.js';
7
+ import type { ContractFunctionSimulator } from '../contract_function_simulator/contract_function_simulator.js';
8
+ import type { ContractSyncService } from '../contract_sync/contract_sync_service.js';
9
+ import type { AnchorBlockStore } from '../storage/index.js';
4
10
  import type { NoteStore } from '../storage/note_store/note_store.js';
5
11
  /**
6
12
  * Methods provided by this class might help debugging but must not be used in production.
@@ -8,13 +14,15 @@ import type { NoteStore } from '../storage/note_store/note_store.js';
8
14
  */
9
15
  export declare class PXEDebugUtils {
10
16
  #private;
11
- private contractStore;
17
+ private contractSyncService;
12
18
  private noteStore;
13
- constructor(contractStore: ContractStore, noteStore: NoteStore);
14
- /**
15
- * Not injected through constructor since they're are co-dependant.
16
- */
17
- setPXE(pxe: PXE): void;
19
+ private blockStateSynchronizer;
20
+ private anchorBlockStore;
21
+ constructor(contractSyncService: ContractSyncService, noteStore: NoteStore, blockStateSynchronizer: BlockSynchronizer, anchorBlockStore: AnchorBlockStore);
22
+ /** Not injected through constructor since they're are co-dependant */
23
+ setPXEHelpers(putJobInQueue: <T>(job: (jobId: string) => Promise<T>) => Promise<T>, getSimulatorForTx: (overrides?: {
24
+ contracts?: ContractOverrides;
25
+ }) => ContractFunctionSimulator, simulateUtility: (contractFunctionSimulator: ContractFunctionSimulator, call: FunctionCall, authWitnesses: AuthWitness[] | undefined, scopes: AztecAddress[] | undefined, jobId: string) => Promise<any>): void;
18
26
  /**
19
27
  * A debugging utility to get notes based on the provided filter.
20
28
  *
@@ -27,5 +35,10 @@ export declare class PXEDebugUtils {
27
35
  * @returns The requested notes.
28
36
  */
29
37
  getNotes(filter: NotesFilter): Promise<NoteDao[]>;
38
+ /**
39
+ * Triggers a sync of the PXE with the node.
40
+ * Blocks until the sync is complete.
41
+ */
42
+ sync(): Promise<void>;
30
43
  }
31
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHhlX2RlYnVnX3V0aWxzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZGVidWcvcHhlX2RlYnVnX3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxFQUFFLE9BQU8sRUFBRSxXQUFXLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUUvRCxPQUFPLEtBQUssRUFBRSxHQUFHLEVBQUUsTUFBTSxXQUFXLENBQUM7QUFDckMsT0FBTyxLQUFLLEVBQUUsYUFBYSxFQUFFLE1BQU0sNkNBQTZDLENBQUM7QUFDakYsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0scUNBQXFDLENBQUM7QUFFckU7OztHQUdHO0FBQ0gscUJBQWEsYUFBYTs7SUFJdEIsT0FBTyxDQUFDLGFBQWE7SUFDckIsT0FBTyxDQUFDLFNBQVM7SUFGbkIsWUFDVSxhQUFhLEVBQUUsYUFBYSxFQUM1QixTQUFTLEVBQUUsU0FBUyxFQUMxQjtJQUVKOztPQUVHO0lBQ0ksTUFBTSxDQUFDLEdBQUcsRUFBRSxHQUFHLFFBRXJCO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNVLFFBQVEsQ0FBQyxNQUFNLEVBQUUsV0FBVyxHQUFHLE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQyxDQVU3RDtDQUNGIn0=
44
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHhlX2RlYnVnX3V0aWxzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZGVidWcvcHhlX2RlYnVnX3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLG1CQUFtQixDQUFDO0FBQ3RELE9BQU8sS0FBSyxFQUFFLFdBQVcsRUFBRSxNQUFNLDRCQUE0QixDQUFDO0FBQzlELE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBQ2hFLE9BQU8sS0FBSyxFQUFFLE9BQU8sRUFBRSxXQUFXLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUMvRCxPQUFPLEtBQUssRUFBRSxpQkFBaUIsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBRTFELE9BQU8sS0FBSyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sNkNBQTZDLENBQUM7QUFDckYsT0FBTyxLQUFLLEVBQUUseUJBQXlCLEVBQUUsTUFBTSwrREFBK0QsQ0FBQztBQUMvRyxPQUFPLEtBQUssRUFBRSxtQkFBbUIsRUFBRSxNQUFNLDJDQUEyQyxDQUFDO0FBQ3JGLE9BQU8sS0FBSyxFQUFFLGdCQUFnQixFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFDNUQsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0scUNBQXFDLENBQUM7QUFFckU7OztHQUdHO0FBQ0gscUJBQWEsYUFBYTs7SUFZdEIsT0FBTyxDQUFDLG1CQUFtQjtJQUMzQixPQUFPLENBQUMsU0FBUztJQUNqQixPQUFPLENBQUMsc0JBQXNCO0lBQzlCLE9BQU8sQ0FBQyxnQkFBZ0I7SUFKMUIsWUFDVSxtQkFBbUIsRUFBRSxtQkFBbUIsRUFDeEMsU0FBUyxFQUFFLFNBQVMsRUFDcEIsc0JBQXNCLEVBQUUsaUJBQWlCLEVBQ3pDLGdCQUFnQixFQUFFLGdCQUFnQixFQUN4QztJQUVKLHNFQUFzRTtJQUMvRCxhQUFhLENBQ2xCLGFBQWEsRUFBRSxDQUFDLENBQUMsRUFBRSxHQUFHLEVBQUUsQ0FBQyxLQUFLLEVBQUUsTUFBTSxLQUFLLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxPQUFPLENBQUMsQ0FBQyxDQUFDLEVBQ3BFLGlCQUFpQixFQUFFLENBQUMsU0FBUyxDQUFDLEVBQUU7UUFBRSxTQUFTLENBQUMsRUFBRSxpQkFBaUIsQ0FBQTtLQUFFLEtBQUsseUJBQXlCLEVBQy9GLGVBQWUsRUFBRSxDQUNmLHlCQUF5QixFQUFFLHlCQUF5QixFQUNwRCxJQUFJLEVBQUUsWUFBWSxFQUNsQixhQUFhLEVBQUUsV0FBVyxFQUFFLEdBQUcsU0FBUyxFQUN4QyxNQUFNLEVBQUUsWUFBWSxFQUFFLEdBQUcsU0FBUyxFQUNsQyxLQUFLLEVBQUUsTUFBTSxLQUNWLE9BQU8sQ0FBQyxHQUFHLENBQUMsUUFLbEI7SUFFRDs7Ozs7Ozs7OztPQVVHO0lBQ0ksUUFBUSxDQUFDLE1BQU0sRUFBRSxXQUFXLEdBQUcsT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDLENBb0J2RDtJQUVEOzs7T0FHRztJQUNJLElBQUksSUFBSSxPQUFPLENBQUMsSUFBSSxDQUFDLENBRTNCO0NBQ0YifQ==