@aztec/pxe 0.0.1-commit.321f6a9 → 0.0.1-commit.330febf

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 (124) hide show
  1. package/dest/bin/check_oracle_version.js +2 -38
  2. package/dest/bin/index.d.ts +2 -2
  3. package/dest/bin/index.d.ts.map +1 -1
  4. package/dest/bin/index.js +1 -1
  5. package/dest/bin/oracle_version_helpers.d.ts +1 -15
  6. package/dest/bin/oracle_version_helpers.d.ts.map +1 -1
  7. package/dest/bin/oracle_version_helpers.js +0 -21
  8. package/dest/block_synchronizer/block_synchronizer.d.ts +3 -5
  9. package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
  10. package/dest/block_synchronizer/block_synchronizer.js +5 -18
  11. package/dest/contract/contract_class_service.d.ts +1 -8
  12. package/dest/contract/contract_class_service.d.ts.map +1 -1
  13. package/dest/contract/contract_class_service.js +8 -40
  14. package/dest/contract_function_simulator/contract_function_simulator.d.ts +1 -8
  15. package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
  16. package/dest/contract_function_simulator/contract_function_simulator.js +0 -17
  17. package/dest/contract_function_simulator/oracle/oracle_type_mappings.d.ts +1 -1
  18. package/dest/contract_function_simulator/oracle/oracle_type_mappings.d.ts.map +1 -1
  19. package/dest/contract_function_simulator/oracle/oracle_type_mappings.js +11 -1
  20. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +1 -1
  21. package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
  22. package/dest/contract_function_simulator/oracle/private_execution_oracle.js +6 -2
  23. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +10 -2
  24. package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
  25. package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +128 -38
  26. package/dest/events/event_service.d.ts +13 -6
  27. package/dest/events/event_service.d.ts.map +1 -1
  28. package/dest/events/event_service.js +13 -13
  29. package/dest/logs/log_service.d.ts +13 -5
  30. package/dest/logs/log_service.d.ts.map +1 -1
  31. package/dest/logs/log_service.js +20 -36
  32. package/dest/messages/tx_resolver_service.d.ts +18 -7
  33. package/dest/messages/tx_resolver_service.d.ts.map +1 -1
  34. package/dest/messages/tx_resolver_service.js +9 -8
  35. package/dest/node/benchmarked_node.d.ts +20 -0
  36. package/dest/node/benchmarked_node.d.ts.map +1 -0
  37. package/dest/node/benchmarked_node.js +94 -0
  38. package/dest/node/caching_aztec_node.d.ts +24 -0
  39. package/dest/node/caching_aztec_node.d.ts.map +1 -0
  40. package/dest/node/caching_aztec_node.js +267 -0
  41. package/dest/notes/note_service.d.ts +12 -6
  42. package/dest/notes/note_service.d.ts.map +1 -1
  43. package/dest/notes/note_service.js +9 -9
  44. package/dest/oracle_version.js +2 -2
  45. package/dest/pxe.d.ts +1 -1
  46. package/dest/pxe.d.ts.map +1 -1
  47. package/dest/pxe.js +31 -14
  48. package/dest/storage/contract_store/contract_store.d.ts +1 -1
  49. package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
  50. package/dest/storage/contract_store/contract_store.js +2 -2
  51. package/dest/storage/fact_store/origin_state.d.ts +1 -1
  52. package/dest/storage/fact_store/origin_state.js +1 -1
  53. package/dest/storage/tagging_store/sender_tagging_store.d.ts +23 -8
  54. package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
  55. package/dest/storage/tagging_store/sender_tagging_store.js +33 -18
  56. package/dest/tagging/constants.d.ts +9 -1
  57. package/dest/tagging/constants.d.ts.map +1 -1
  58. package/dest/tagging/constants.js +10 -0
  59. package/dest/tagging/get_all_logs_by_tags.d.ts +29 -8
  60. package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
  61. package/dest/tagging/get_all_logs_by_tags.js +29 -10
  62. package/dest/tagging/index.d.ts +2 -2
  63. package/dest/tagging/index.d.ts.map +1 -1
  64. package/dest/tagging/index.js +1 -1
  65. package/dest/tagging/recipient_sync/sync_tagged_private_logs.d.ts +2 -2
  66. package/dest/tagging/recipient_sync/sync_tagged_private_logs.d.ts.map +1 -1
  67. package/dest/tagging/recipient_sync/sync_tagged_private_logs.js +13 -17
  68. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +6 -3
  69. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
  70. package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +23 -38
  71. package/dest/tagging/sender_sync/utils/classify_pending_txs.d.ts +22 -0
  72. package/dest/tagging/sender_sync/utils/classify_pending_txs.d.ts.map +1 -0
  73. package/dest/tagging/sender_sync/utils/classify_pending_txs.js +61 -0
  74. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +15 -5
  75. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
  76. package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +30 -33
  77. package/dest/tagging/sender_sync/utils/resolve_pending_txs.d.ts +29 -0
  78. package/dest/tagging/sender_sync/utils/resolve_pending_txs.d.ts.map +1 -0
  79. package/dest/tagging/sender_sync/utils/resolve_pending_txs.js +41 -0
  80. package/dest/tagging/sender_sync/utils/test_utils.d.ts +16 -0
  81. package/dest/tagging/sender_sync/utils/test_utils.d.ts.map +1 -0
  82. package/dest/tagging/sender_sync/utils/test_utils.js +24 -0
  83. package/package.json +17 -17
  84. package/src/bin/check_oracle_version.ts +2 -46
  85. package/src/bin/index.ts +1 -1
  86. package/src/bin/oracle_version_helpers.ts +0 -24
  87. package/src/block_synchronizer/block_synchronizer.ts +6 -23
  88. package/src/contract/contract_class_service.ts +8 -46
  89. package/src/contract_function_simulator/contract_function_simulator.ts +0 -17
  90. package/src/contract_function_simulator/oracle/oracle_type_mappings.ts +16 -1
  91. package/src/contract_function_simulator/oracle/private_execution_oracle.ts +7 -2
  92. package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +130 -40
  93. package/src/events/event_service.ts +24 -14
  94. package/src/logs/log_service.ts +37 -44
  95. package/src/messages/tx_resolver_service.ts +22 -11
  96. package/src/node/benchmarked_node.ts +140 -0
  97. package/src/node/caching_aztec_node.ts +406 -0
  98. package/src/notes/note_service.ts +19 -13
  99. package/src/oracle_version.ts +2 -2
  100. package/src/pxe.ts +32 -16
  101. package/src/storage/contract_store/contract_store.ts +2 -1
  102. package/src/storage/fact_store/origin_state.ts +1 -1
  103. package/src/storage/tagging_store/sender_tagging_store.ts +51 -26
  104. package/src/tagging/constants.ts +12 -0
  105. package/src/tagging/get_all_logs_by_tags.ts +47 -11
  106. package/src/tagging/index.ts +6 -1
  107. package/src/tagging/recipient_sync/sync_tagged_private_logs.ts +19 -22
  108. package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +27 -57
  109. package/src/tagging/sender_sync/utils/classify_pending_txs.ts +91 -0
  110. package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +40 -38
  111. package/src/tagging/sender_sync/utils/resolve_pending_txs.ts +64 -0
  112. package/src/tagging/sender_sync/utils/test_utils.ts +46 -0
  113. package/dest/contract_function_simulator/aztec_node_read_cache.d.ts +0 -39
  114. package/dest/contract_function_simulator/aztec_node_read_cache.d.ts.map +0 -1
  115. package/dest/contract_function_simulator/aztec_node_read_cache.js +0 -60
  116. package/dest/contract_function_simulator/benchmarked_node.d.ts +0 -9
  117. package/dest/contract_function_simulator/benchmarked_node.d.ts.map +0 -1
  118. package/dest/contract_function_simulator/benchmarked_node.js +0 -77
  119. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +0 -17
  120. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +0 -1
  121. package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +0 -60
  122. package/src/contract_function_simulator/aztec_node_read_cache.ts +0 -89
  123. package/src/contract_function_simulator/benchmarked_node.ts +0 -103
  124. package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +0 -66
@@ -1,9 +1,8 @@
1
- import { PRIVATE_LOG_CIPHERTEXT_LEN } from '@aztec/constants';
2
1
  import { createLogger } from '@aztec/foundation/log';
3
2
  import { AppTaggingSecret, AppTaggingSecretKind, SiloedTag, computeSharedTaggingSecret } from '@aztec/stdlib/logs';
4
3
  import { LogSource } from '../contract_function_simulator/noir-structs/log_retrieval_request.js';
5
4
  import { assertAllowedScope } from '../storage/allowed_scopes.js';
6
- import { getAllPrivateLogsByTags, getAllPublicLogsByTagsFromContract, syncTaggedPrivateLogs } from '../tagging/index.js';
5
+ import { getAllPrivateLogsByTags, getAllPublicLogsByTagsFromContract, logQueryAnchorOf, syncTaggedPrivateLogs } from '../tagging/index.js';
7
6
  const rangeKey = (fromBlock, toBlock)=>`${fromBlock ?? ''}-${toBlock ?? ''}`;
8
7
  export class LogService {
9
8
  aztecNode;
@@ -37,17 +36,17 @@ export class LogService {
37
36
  if (logRetrievalRequests.length === 0) {
38
37
  return [];
39
38
  }
40
- const anchorBlockHash = await this.anchorBlockHeader.hash();
39
+ const anchor = await logQueryAnchorOf(this.anchorBlockHeader);
41
40
  const [publicLogsPerRequest, privateLogsPerRequest] = await Promise.all([
42
- this.#fetchPublicLogs(contractAddress, logRetrievalRequests, anchorBlockHash),
43
- this.#fetchPrivateLogs(logRetrievalRequests, anchorBlockHash)
41
+ this.#fetchPublicLogs(contractAddress, logRetrievalRequests, anchor),
42
+ this.#fetchPrivateLogs(logRetrievalRequests, anchor)
44
43
  ]);
45
44
  return logRetrievalRequests.map((_request, i)=>[
46
- ...publicLogsPerRequest[i].map(LogService.#toLogRetrievalResponse),
47
- ...privateLogsPerRequest[i].map(LogService.#toLogRetrievalResponse)
45
+ ...publicLogsPerRequest[i].map(LogService.#toRetrievedTaggedLog),
46
+ ...privateLogsPerRequest[i].map(LogService.#toRetrievedTaggedLog)
48
47
  ]);
49
48
  }
50
- async #fetchPublicLogs(contractAddress, requests, anchorBlockHash) {
49
+ async #fetchPublicLogs(contractAddress, requests, anchor) {
51
50
  const indices = requests.flatMap((r, i)=>r.source !== LogSource.PRIVATE ? [
52
51
  i
53
52
  ] : []);
@@ -61,7 +60,7 @@ export class LogService {
61
60
  })));
62
61
  await Promise.all(Array.from(groups.values()).map(async (group)=>{
63
62
  const tags = group.entries.map((e)=>e.request.tag);
64
- const results = await getAllPublicLogsByTagsFromContract(this.aztecNode, contractAddress, tags, anchorBlockHash, {
63
+ const results = await getAllPublicLogsByTagsFromContract(this.aztecNode, contractAddress, tags, anchor, {
65
64
  fromBlock: group.fromBlock,
66
65
  toBlock: group.toBlock,
67
66
  includeEffects: true
@@ -72,7 +71,7 @@ export class LogService {
72
71
  }));
73
72
  return resultsPerRequest;
74
73
  }
75
- async #fetchPrivateLogs(requests, anchorBlockHash) {
74
+ async #fetchPrivateLogs(requests, anchor) {
76
75
  const indices = requests.flatMap((r, i)=>r.source !== LogSource.PUBLIC ? [
77
76
  i
78
77
  ] : []);
@@ -86,7 +85,7 @@ export class LogService {
86
85
  })));
87
86
  await Promise.all(Array.from(groups.values()).map(async (group)=>{
88
87
  const siloedTags = await Promise.all(group.entries.map((e)=>SiloedTag.computeFromTagAndApp(e.request.tag, e.request.contractAddress)));
89
- const results = await getAllPrivateLogsByTags(this.aztecNode, siloedTags, anchorBlockHash, {
88
+ const results = await getAllPrivateLogsByTags(this.aztecNode, siloedTags, anchor, {
90
89
  fromBlock: group.fromBlock,
91
90
  toBlock: group.toBlock,
92
91
  includeEffects: true
@@ -121,7 +120,7 @@ export class LogService {
121
120
  }
122
121
  return groups;
123
122
  }
124
- static #toLogRetrievalResponse(log) {
123
+ static #toRetrievedTaggedLog(log) {
125
124
  // includeEffects: true was used, so noteHashes and nullifiers are populated. Every tx has at least one nullifier
126
125
  // (the first nullifier derived from the tx hash); empty here would indicate a buggy node.
127
126
  const noteHashes = log.noteHashes;
@@ -130,18 +129,19 @@ export class LogService {
130
129
  throw new Error(`Log for tx ${log.txHash} returned no nullifiers from the node`);
131
130
  }
132
131
  return {
133
- // Skip the tag, and clip to the wire cap: public logs can exceed PRIVATE_LOG_CIPHERTEXT_LEN, which is the fixed
134
- // size of the oracle's BoundedVec slot. A no-op for private logs, which are already within the cap.
135
- logPayload: log.logData.slice(1, 1 + PRIVATE_LOG_CIPHERTEXT_LEN),
132
+ logData: log.logData,
136
133
  txHash: log.txHash,
137
- uniqueNoteHashesInTx: noteHashes,
138
- firstNullifierInTx: nullifiers[0],
134
+ noteHashes,
135
+ nullifiers,
139
136
  blockNumber: log.blockNumber,
140
137
  blockTimestamp: log.blockTimestamp,
141
- blockHash: log.blockHash
138
+ blockHash: log.blockHash,
139
+ // The log index and the tx receipt both count the tx's position in `block.body.txEffects`, so this is the same
140
+ // index a receipt reports. Note ordering depends on the two staying in agreement.
141
+ txIndexInBlock: log.txIndexWithinBlock
142
142
  };
143
143
  }
144
- async fetchTaggedLogs(contractAddress, recipient, providedSecrets) {
144
+ /** Fetches the pending tagged logs for a recipient across all its tagging secrets for the contract. */ async fetchTaggedLogs(contractAddress, recipient, providedSecrets) {
145
145
  assertAllowedScope(recipient, this.scopes);
146
146
  this.log.verbose(`Fetching tagged logs for contract ${contractAddress.toString()} and recipient ${recipient.toString()}`);
147
147
  const l2Tips = await this.l2TipsStore.getL2Tips();
@@ -159,23 +159,7 @@ export class LogService {
159
159
  secret
160
160
  ])).values());
161
161
  const logs = await syncTaggedPrivateLogs(secrets, this.aztecNode, this.recipientTaggingStore, this.anchorBlockHeader, l2Tips.finalized.block.number, this.jobId);
162
- return logs.map((log)=>{
163
- const noteHashes = log.noteHashes;
164
- const nullifiers = log.nullifiers;
165
- if (nullifiers.length === 0) {
166
- throw new Error(`Log for tx ${log.txHash} returned no nullifiers from the node`);
167
- }
168
- return {
169
- log: log.logData,
170
- context: {
171
- txHash: log.txHash,
172
- uniqueNoteHashesInTx: noteHashes,
173
- firstNullifierInTx: nullifiers[0],
174
- blockNumber: log.blockNumber,
175
- blockHash: log.blockHash.toFr()
176
- }
177
- };
178
- });
162
+ return logs.map((log)=>LogService.#toRetrievedTaggedLog(log));
179
163
  }
180
164
  /**
181
165
  * Computes the tagging secrets PXE can enumerate for a recipient: one per known sender (via ECDH) plus any
@@ -1,17 +1,28 @@
1
+ import type { BlockNumber } from '@aztec/foundation/branded-types';
1
2
  import { Fr } from '@aztec/foundation/curves/bn254';
3
+ import type { BlockHash } from '@aztec/stdlib/block';
2
4
  import type { AztecNode } from '@aztec/stdlib/interfaces/server';
3
- import type { ResolvedTx } from '../contract_function_simulator/noir-structs/resolved_tx.js';
4
- /** Resolves transaction hashes into their on-chain context (note hashes, first nullifier, and mined block). */
5
+ import { TxHash } from '@aztec/stdlib/tx';
6
+ /** Resolves transaction hashes into their on-chain context (note hashes, nullifiers, and mined position). */
5
7
  export declare class TxResolverService {
6
8
  private readonly aztecNode;
7
9
  constructor(aztecNode: AztecNode);
8
10
  /**
9
11
  * Resolves a list of tx hashes into their on-chain context.
10
12
  *
11
- * For each tx hash, looks up the corresponding tx effect and extracts the note hashes, first nullifier, and the
12
- * number and hash of the block it was mined in. Returns `null` for tx hashes that are zero, not yet available, or in
13
- * blocks beyond the anchor block.
13
+ * For each tx hash, looks up the corresponding tx effect and extracts its note hashes and nullifiers, and the
14
+ * position it was mined at. Returns `null` for tx hashes that are zero, not yet available, or in blocks beyond the
15
+ * anchor block.
14
16
  */
15
- resolveTxs(txHashes: Fr[], anchorBlockNumber: number): Promise<(ResolvedTx | null)[]>;
17
+ resolveTxs(txHashes: Fr[], anchorBlockNumber: number): Promise<(TxOnchainContext | null)[]>;
16
18
  }
17
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHhfcmVzb2x2ZXJfc2VydmljZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL21lc3NhZ2VzL3R4X3Jlc29sdmVyX3NlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLEVBQUUsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBQ3BELE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBR2pFLE9BQU8sS0FBSyxFQUFFLFVBQVUsRUFBRSxNQUFNLDREQUE0RCxDQUFDO0FBRTdGLCtHQUErRztBQUMvRyxxQkFBYSxpQkFBaUI7SUFDaEIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxTQUFTO0lBQXRDLFlBQTZCLFNBQVMsRUFBRSxTQUFTLEVBQUk7SUFFckQ7Ozs7OztPQU1HO0lBQ0csVUFBVSxDQUFDLFFBQVEsRUFBRSxFQUFFLEVBQUUsRUFBRSxpQkFBaUIsRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLENBQUMsVUFBVSxHQUFHLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FpRDFGO0NBQ0YifQ==
19
+ /** The onchain context of a tx: the position it was mined at, and the effects it produced. */
20
+ export type TxOnchainContext = {
21
+ txHash: TxHash;
22
+ noteHashes: Fr[];
23
+ nullifiers: Fr[];
24
+ blockNumber: BlockNumber;
25
+ blockHash: BlockHash;
26
+ txIndexInBlock: number;
27
+ };
28
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHhfcmVzb2x2ZXJfc2VydmljZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL21lc3NhZ2VzL3R4X3Jlc29sdmVyX3NlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFFbkUsT0FBTyxFQUFFLEVBQUUsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBQ3BELE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBQ3JELE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBQ2pFLE9BQU8sRUFBd0IsTUFBTSxFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFFaEUsNkdBQTZHO0FBQzdHLHFCQUFhLGlCQUFpQjtJQUNoQixPQUFPLENBQUMsUUFBUSxDQUFDLFNBQVM7SUFBdEMsWUFBNkIsU0FBUyxFQUFFLFNBQVMsRUFBSTtJQUVyRDs7Ozs7O09BTUc7SUFDRyxVQUFVLENBQUMsUUFBUSxFQUFFLEVBQUUsRUFBRSxFQUFFLGlCQUFpQixFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsQ0FBQyxnQkFBZ0IsR0FBRyxJQUFJLENBQUMsRUFBRSxDQUFDLENBa0RoRztDQUNGO0FBRUQsOEZBQThGO0FBQzlGLE1BQU0sTUFBTSxnQkFBZ0IsR0FBRztJQUM3QixNQUFNLEVBQUUsTUFBTSxDQUFDO0lBQ2YsVUFBVSxFQUFFLEVBQUUsRUFBRSxDQUFDO0lBQ2pCLFVBQVUsRUFBRSxFQUFFLEVBQUUsQ0FBQztJQUNqQixXQUFXLEVBQUUsV0FBVyxDQUFDO0lBQ3pCLFNBQVMsRUFBRSxTQUFTLENBQUM7SUFDckIsY0FBYyxFQUFFLE1BQU0sQ0FBQztDQUN4QixDQUFDIn0=
@@ -1 +1 @@
1
- {"version":3,"file":"tx_resolver_service.d.ts","sourceRoot":"","sources":["../../src/messages/tx_resolver_service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAGjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4DAA4D,CAAC;AAE7F,+GAA+G;AAC/G,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAAtC,YAA6B,SAAS,EAAE,SAAS,EAAI;IAErD;;;;;;OAMG;IACG,UAAU,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,CAiD1F;CACF"}
1
+ {"version":3,"file":"tx_resolver_service.d.ts","sourceRoot":"","sources":["../../src/messages/tx_resolver_service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAwB,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAEhE,6GAA6G;AAC7G,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAAtC,YAA6B,SAAS,EAAE,SAAS,EAAI;IAErD;;;;;;OAMG;IACG,UAAU,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,gBAAgB,GAAG,IAAI,CAAC,EAAE,CAAC,CAkDhG;CACF;AAED,8FAA8F;AAC9F,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,EAAE,EAAE,CAAC;IACjB,UAAU,EAAE,EAAE,EAAE,CAAC;IACjB,WAAW,EAAE,WAAW,CAAC;IACzB,SAAS,EAAE,SAAS,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC"}
@@ -1,6 +1,6 @@
1
1
  import { uniqueBy } from '@aztec/foundation/collection';
2
2
  import { TxHash } from '@aztec/stdlib/tx';
3
- /** Resolves transaction hashes into their on-chain context (note hashes, first nullifier, and mined block). */ export class TxResolverService {
3
+ /** Resolves transaction hashes into their on-chain context (note hashes, nullifiers, and mined position). */ export class TxResolverService {
4
4
  aztecNode;
5
5
  constructor(aztecNode){
6
6
  this.aztecNode = aztecNode;
@@ -8,9 +8,9 @@ import { TxHash } from '@aztec/stdlib/tx';
8
8
  /**
9
9
  * Resolves a list of tx hashes into their on-chain context.
10
10
  *
11
- * For each tx hash, looks up the corresponding tx effect and extracts the note hashes, first nullifier, and the
12
- * number and hash of the block it was mined in. Returns `null` for tx hashes that are zero, not yet available, or in
13
- * blocks beyond the anchor block.
11
+ * For each tx hash, looks up the corresponding tx effect and extracts its note hashes and nullifiers, and the
12
+ * position it was mined at. Returns `null` for tx hashes that are zero, not yet available, or in blocks beyond the
13
+ * anchor block.
14
14
  */ async resolveTxs(txHashes, anchorBlockNumber) {
15
15
  const nonZeroTxHashes = txHashes.filter((h)=>!h.isZero()).map((h)=>TxHash.fromField(h));
16
16
  const uniqueTxHashes = uniqueBy(nonZeroTxHashes, (h)=>h.toString());
@@ -43,17 +43,18 @@ import { TxHash } from '@aztec/stdlib/tx';
43
43
  return null;
44
44
  }
45
45
  // Every tx has at least one nullifier (the first nullifier derived from the tx hash). Hitting this condition
46
- // would mean a buggy node, but since we need to access data.nullifiers[0], the defensive check does no harm.
46
+ // would mean a buggy node, but since consumers rely on nullifiers[0], the defensive check does no harm.
47
47
  const data = txEffect.data;
48
48
  if (data.nullifiers.length === 0) {
49
49
  throw new Error(`Tx effect for ${txHash} has no nullifiers`);
50
50
  }
51
51
  return {
52
52
  txHash: data.txHash,
53
- uniqueNoteHashesInTx: data.noteHashes,
54
- firstNullifierInTx: data.nullifiers[0],
53
+ noteHashes: data.noteHashes,
54
+ nullifiers: data.nullifiers,
55
55
  blockNumber: txEffect.l2BlockNumber,
56
- blockHash: txEffect.l2BlockHash.toFr()
56
+ blockHash: txEffect.l2BlockHash,
57
+ txIndexInBlock: txEffect.txIndexInBlock
57
58
  };
58
59
  });
59
60
  }
@@ -0,0 +1,20 @@
1
+ import type { AztecNode } from '@aztec/stdlib/interfaces/client';
2
+ import type { NodeStats } from '@aztec/stdlib/tx';
3
+ export interface Recording {
4
+ /** Closes the recording and returns what it saw. Reads served after this are not recorded. */
5
+ stop(): NodeStats;
6
+ }
7
+ /** An {@link AztecNode} wrapper that can report the reads it serves. */
8
+ export interface BenchmarkedAztecNode extends AztecNode {
9
+ /**
10
+ * Opens a recording of the reads this wrapper serves, until {@link Recording.stop}. Recordings are independent, so
11
+ * several may run at once: one measuring a whole run sees the same reads as one measuring a single operation.
12
+ *
13
+ * Nothing is measured while none is open, which is what keeps a long-lived wrapper from accumulating a run's worth
14
+ * of timings nobody asked for.
15
+ */
16
+ startRecording(): Recording;
17
+ }
18
+ /** Wraps `node` so that the reads it answers can be recorded. */
19
+ export declare function withRecording(node: AztecNode): BenchmarkedAztecNode;
20
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmVuY2htYXJrZWRfbm9kZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL25vZGUvYmVuY2htYXJrZWRfbm9kZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEtBQUssRUFBRSxTQUFTLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUNqRSxPQUFPLEtBQUssRUFBRSxTQUFTLEVBQUUsTUFBTSxrQkFBa0IsQ0FBQztBQWlCbEQsTUFBTSxXQUFXLFNBQVM7SUFDeEIsOEZBQThGO0lBQzlGLElBQUksSUFBSSxTQUFTLENBQUM7Q0FDbkI7QUFFRCx3RUFBd0U7QUFDeEUsTUFBTSxXQUFXLG9CQUFxQixTQUFRLFNBQVM7SUFDckQ7Ozs7OztPQU1HO0lBQ0gsY0FBYyxJQUFJLFNBQVMsQ0FBQztDQUM3QjtBQUVELGlFQUFpRTtBQUNqRSx3QkFBZ0IsYUFBYSxDQUFDLElBQUksRUFBRSxTQUFTLEdBQUcsb0JBQW9CLENBNEZuRSJ9
@@ -0,0 +1 @@
1
+ {"version":3,"file":"benchmarked_node.d.ts","sourceRoot":"","sources":["../../src/node/benchmarked_node.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAiBlD,MAAM,WAAW,SAAS;IACxB,8FAA8F;IAC9F,IAAI,IAAI,SAAS,CAAC;CACnB;AAED,wEAAwE;AACxE,MAAM,WAAW,oBAAqB,SAAQ,SAAS;IACrD;;;;;;OAMG;IACH,cAAc,IAAI,SAAS,CAAC;CAC7B;AAED,iEAAiE;AACjE,wBAAgB,aAAa,CAAC,IAAI,EAAE,SAAS,GAAG,oBAAoB,CA4FnE"}
@@ -0,0 +1,94 @@
1
+ import { Timer } from '@aztec/foundation/timer';
2
+ /** Wraps `node` so that the reads it answers can be recorded. */ export function withRecording(node) {
3
+ // The stats of every recording currently open
4
+ const open = new Set();
5
+ // Round trip tracking
6
+ let inFlightCount = 0;
7
+ let currentRoundTripTimer = null;
8
+ let currentRoundTripMethods = [];
9
+ return new Proxy(node, {
10
+ get (target, prop) {
11
+ if (prop === 'startRecording') {
12
+ return ()=>{
13
+ const stats = {
14
+ perMethod: {},
15
+ roundTrips: {
16
+ roundTrips: 0,
17
+ totalBlockingTime: 0,
18
+ roundTripDurations: [],
19
+ roundTripMethods: []
20
+ }
21
+ };
22
+ open.add(stats);
23
+ return {
24
+ stop: ()=>{
25
+ open.delete(stats);
26
+ return stats;
27
+ }
28
+ };
29
+ };
30
+ }
31
+ const value = Reflect.get(target, prop);
32
+ if (typeof value !== 'function' || typeof prop !== 'string') {
33
+ return value;
34
+ }
35
+ return (...args)=>{
36
+ // With no recording open there is nobody to report to, so the read is left untimed.
37
+ if (open.size === 0) {
38
+ return value.apply(target, args);
39
+ }
40
+ // Start of a new round trip batch?
41
+ if (inFlightCount === 0) {
42
+ currentRoundTripTimer = new Timer();
43
+ currentRoundTripMethods = [];
44
+ }
45
+ inFlightCount++;
46
+ currentRoundTripMethods.push(prop);
47
+ const callTimer = new Timer();
48
+ const result = value.apply(target, args);
49
+ // Handle completion - called when the call finishes (after Promise resolves)
50
+ const handleCompletion = ()=>{
51
+ const callTime = callTimer.ms();
52
+ for (const stats of open){
53
+ timesFor(stats, prop).push(callTime);
54
+ }
55
+ inFlightCount--;
56
+ // End of round trip batch - all concurrent calls completed
57
+ if (inFlightCount === 0 && currentRoundTripTimer) {
58
+ const roundTripTime = currentRoundTripTimer.ms();
59
+ for (const { roundTrips } of open){
60
+ roundTrips.roundTrips++;
61
+ roundTrips.totalBlockingTime += roundTripTime;
62
+ roundTrips.roundTripDurations.push(roundTripTime);
63
+ roundTrips.roundTripMethods.push(currentRoundTripMethods);
64
+ }
65
+ currentRoundTripTimer = null;
66
+ currentRoundTripMethods = [];
67
+ }
68
+ };
69
+ // If the result is a Promise, chain the completion handler
70
+ if (isThenable(result)) {
71
+ return result.then((resolved)=>{
72
+ handleCompletion();
73
+ return resolved;
74
+ }, (error)=>{
75
+ handleCompletion();
76
+ throw error;
77
+ });
78
+ } else {
79
+ // Synchronous method - handle completion immediately
80
+ handleCompletion();
81
+ return result;
82
+ }
83
+ };
84
+ }
85
+ });
86
+ }
87
+ /** The times `stats` holds for `method`, added on first use. */ function timesFor(stats, method) {
88
+ return (stats.perMethod[method] ??= {
89
+ times: []
90
+ }).times;
91
+ }
92
+ /** Whether completion can be chained onto `value` with `.then`, which a promise from any implementation allows. */ function isThenable(value) {
93
+ return typeof value === 'object' && value !== null && 'then' in value && typeof value.then === 'function';
94
+ }
@@ -0,0 +1,24 @@
1
+ import type { AztecNode } from '@aztec/stdlib/interfaces/server';
2
+ import { type BenchmarkedAztecNode } from './benchmarked_node.js';
3
+ /**
4
+ * An {@link AztecNode} wrapper that serves repeated reads from a cache it owns.
5
+ */
6
+ export interface CachingAztecNode extends BenchmarkedAztecNode {
7
+ /** Clears the read cache. The owner calls this periodically to bound memory. Cached entries never go stale. */
8
+ wipeCache(): void;
9
+ }
10
+ /**
11
+ * Wraps `node`, serving repeated reads from a cache the wrapper owns. Consumers share cached reads by sharing the
12
+ * wrapper.
13
+ *
14
+ * Only hash-pinned reads are cached. A block hash names immutable content, so the same call can never correctly answer
15
+ * differently, and even an `undefined` witness or leaf index is kept as a non-membership fact. That makes the wrapper
16
+ * safe for any consumer, whatever its anchor block. Uncached methods, and reads that name a block any other way (see
17
+ * {@link hashReferenceOf}), pass straight through. A few entries below opt out even when hash-pinned, where the answer
18
+ * can still change, and the tag queries opt in only once the request also stops short of blocks yet to be produced
19
+ * (see {@link hasImmutableAnswer}).
20
+ *
21
+ * Wiping (see {@link CachingAztecNode.wipeCache}) bounds memory. Correctness does not depend on it.
22
+ */
23
+ export declare function withCache(node: AztecNode): CachingAztecNode;
24
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FjaGluZ19henRlY19ub2RlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbm9kZS9jYWNoaW5nX2F6dGVjX25vZGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBSUEsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFZakUsT0FBTyxFQUFFLEtBQUssb0JBQW9CLEVBQWlCLE1BQU0sdUJBQXVCLENBQUM7QUFFakY7O0dBRUc7QUFDSCxNQUFNLFdBQVcsZ0JBQWlCLFNBQVEsb0JBQW9CO0lBQzVELCtHQUErRztJQUMvRyxTQUFTLElBQUksSUFBSSxDQUFDO0NBQ25CO0FBRUQ7Ozs7Ozs7Ozs7OztHQVlHO0FBQ0gsd0JBQWdCLFNBQVMsQ0FBQyxJQUFJLEVBQUUsU0FBUyxHQUFHLGdCQUFnQixDQXdKM0QifQ==
@@ -0,0 +1 @@
1
+ {"version":3,"file":"caching_aztec_node.d.ts","sourceRoot":"","sources":["../../src/node/caching_aztec_node.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAYjE,OAAO,EAAE,KAAK,oBAAoB,EAAiB,MAAM,uBAAuB,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D,+GAA+G;IAC/G,SAAS,IAAI,IAAI,CAAC;CACnB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,SAAS,GAAG,gBAAgB,CAwJ3D"}
@@ -0,0 +1,267 @@
1
+ import { BlockHash } from '@aztec/stdlib/block';
2
+ import { withRecording } from './benchmarked_node.js';
3
+ /**
4
+ * Wraps `node`, serving repeated reads from a cache the wrapper owns. Consumers share cached reads by sharing the
5
+ * wrapper.
6
+ *
7
+ * Only hash-pinned reads are cached. A block hash names immutable content, so the same call can never correctly answer
8
+ * differently, and even an `undefined` witness or leaf index is kept as a non-membership fact. That makes the wrapper
9
+ * safe for any consumer, whatever its anchor block. Uncached methods, and reads that name a block any other way (see
10
+ * {@link hashReferenceOf}), pass straight through. A few entries below opt out even when hash-pinned, where the answer
11
+ * can still change, and the tag queries opt in only once the request also stops short of blocks yet to be produced
12
+ * (see {@link hasImmutableAnswer}).
13
+ *
14
+ * Wiping (see {@link CachingAztecNode.wipeCache}) bounds memory. Correctness does not depend on it.
15
+ */ export function withCache(node) {
16
+ const cache = new AztecNodeCache();
17
+ // The recording wrapper sits below the cache, so a recording sees only the reads the node answered: a read served
18
+ // from the cache appears nowhere in it. Every read below goes to `source` rather than to `node`, and
19
+ // `startRecording` passes through this wrapper untouched.
20
+ const source = withRecording(node);
21
+ /** Runs `read` through `cache` when `block` pins a chain position by hash. Everything else goes to the node. */ const readCachedIfBlockIsHashPinned = (block, key, read, options)=>{
22
+ const blockHash = hashReferenceOf(block);
23
+ return blockHash === undefined ? read() : cache.fetch(key(blockHash.toString()), read, options);
24
+ };
25
+ const cachedReads = {
26
+ getBlock: (block, options)=>{
27
+ if (options?.includeL1PublishInfo || options?.includeAttestations) {
28
+ // These payloads keep changing after a block is fixed (its L1 publication status, its incoming committee
29
+ // attestations), so a repeat can correctly differ; read straight from the node.
30
+ return source.getBlock(block, options);
31
+ }
32
+ return readCachedIfBlockIsHashPinned(block, (blockHash)=>`block:${blockHash}:${keyPart(options)}`, ()=>source.getBlock(block, options), {
33
+ // PXE only asks for pinned blocks it has already observed, so an undefined answer means the node has not
34
+ // served the block yet, not that it never will.
35
+ shouldCache: (response)=>response !== undefined
36
+ });
37
+ },
38
+ getContract: (address, referenceBlock)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`contract:${blockHash}:${address.toString()}`, ()=>source.getContract(address, referenceBlock)),
39
+ getBlockHashMembershipWitness: (referenceBlock, blockHash)=>readCachedIfBlockIsHashPinned(referenceBlock, (referenceHash)=>`block-hash-membership-witness:${referenceHash}:${blockHash.toString()}`, ()=>source.getBlockHashMembershipWitness(referenceBlock, blockHash)),
40
+ getPublicDataWitness: (referenceBlock, leafSlot)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`public-data-witness:${blockHash}:${leafSlot.toString()}`, ()=>source.getPublicDataWitness(referenceBlock, leafSlot)),
41
+ getNoteHashMembershipWitness: (referenceBlock, noteHash)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`note-hash-membership-witness:${blockHash}:${noteHash.toString()}`, ()=>source.getNoteHashMembershipWitness(referenceBlock, noteHash)),
42
+ getNullifierMembershipWitness: (referenceBlock, nullifier)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`nullifier-membership-witness:${blockHash}:${nullifier.toString()}`, ()=>source.getNullifierMembershipWitness(referenceBlock, nullifier)),
43
+ getLowNullifierMembershipWitness: (referenceBlock, nullifier)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`low-nullifier-membership-witness:${blockHash}:${nullifier.toString()}`, ()=>source.getLowNullifierMembershipWitness(referenceBlock, nullifier)),
44
+ getL1ToL2MessageMembershipWitness: (referenceBlock, l1ToL2Message)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`l1-to-l2-message-membership-witness:${blockHash}:${l1ToL2Message.toString()}`, ()=>source.getL1ToL2MessageMembershipWitness(referenceBlock, l1ToL2Message)),
45
+ getPublicStorageAt: (referenceBlock, contractAddress, storageSlot)=>readCachedIfBlockIsHashPinned(referenceBlock, (blockHash)=>`public-storage:${blockHash}:${contractAddress.toString()}:${storageSlot.toString()}`, ()=>source.getPublicStorageAt(referenceBlock, contractAddress, storageSlot)),
46
+ findLeavesIndexes: (referenceBlock, treeId, leafValues)=>{
47
+ // Cached per leaf: only leaves without a cached result are fetched, in a single batched node call. The per-leaf
48
+ // keys don't fit single-key readCachedIfBlockIsHashPinned, so the hash gate is inline.
49
+ const referenceHash = hashReferenceOf(referenceBlock);
50
+ if (referenceHash === undefined) {
51
+ return source.findLeavesIndexes(referenceBlock, treeId, leafValues);
52
+ }
53
+ return readBatchedPerKey(cache, leafValues.map((leaf)=>`leaf-index:${referenceHash.toString()}:${treeId}:${leaf.toString()}`), (missing)=>source.findLeavesIndexes(referenceBlock, treeId, missing.map((i)=>leafValues[i])), {
54
+ method: 'findLeavesIndexes',
55
+ requested: 'leaves'
56
+ });
57
+ },
58
+ getPrivateLogsByTags: (query)=>{
59
+ if (!hasImmutableAnswer(query)) {
60
+ return source.getPrivateLogsByTags(query);
61
+ }
62
+ const keyPrefix = `private-logs:${privateLogsQueryKey(query)}`;
63
+ return readBatchedPerKey(cache, query.tags.map((tag)=>`${keyPrefix}:${tagQueryKey(tag)}`), (missing)=>source.getPrivateLogsByTags({
64
+ ...query,
65
+ tags: missing.map((i)=>query.tags[i])
66
+ }), {
67
+ method: 'getPrivateLogsByTags',
68
+ requested: 'tags'
69
+ });
70
+ },
71
+ getPublicLogsByTags: (query)=>{
72
+ if (!hasImmutableAnswer(query)) {
73
+ return source.getPublicLogsByTags(query);
74
+ }
75
+ const keyPrefix = `public-logs:${publicLogsQueryKey(query)}`;
76
+ return readBatchedPerKey(cache, query.tags.map((tag)=>`${keyPrefix}:${tagQueryKey(tag)}`), (missing)=>source.getPublicLogsByTags({
77
+ ...query,
78
+ tags: missing.map((i)=>query.tags[i])
79
+ }), {
80
+ method: 'getPublicLogsByTags',
81
+ requested: 'tags'
82
+ });
83
+ }
84
+ };
85
+ return new Proxy(source, {
86
+ get (target, prop) {
87
+ if (prop === 'wipeCache') {
88
+ return ()=>cache.wipe();
89
+ }
90
+ if (Object.hasOwn(cachedReads, prop)) {
91
+ return cachedReads[prop];
92
+ }
93
+ const value = Reflect.get(target, prop);
94
+ return typeof value === 'function' ? value.bind(target) : value;
95
+ }
96
+ });
97
+ }
98
+ /**
99
+ * Store of node read promises keyed by method and arguments.
100
+ *
101
+ * Holds no node reference of its own: it only memoizes promises handed to it by the {@link withCache} wrapper that
102
+ * owns it. Rejected promises are evicted so callers can retry. A settled value is kept unless the caller's
103
+ * `shouldCache` turns it away.
104
+ */ class AztecNodeCache {
105
+ cache = new Map();
106
+ /**
107
+ * Returns the cached promise for `key`, or runs `read` and caches the in-flight promise.
108
+ *
109
+ * `shouldCache` runs once the promise settles and answers whether its value is kept. Every settled value is kept by
110
+ * default. Callers waiting on a value that is then turned away still share the one in-flight read, so declining to
111
+ * keep a value costs nothing on concurrent reads.
112
+ */ fetch(key, read, { shouldCache } = {}) {
113
+ return this.#get(key) ?? this.#set(key, read(), shouldCache);
114
+ }
115
+ /**
116
+ * The cached promise for each of `keys`, `undefined` where there is none. For callers that batch their own misses
117
+ * rather than reading one key.
118
+ */ peekAll(keys) {
119
+ return keys.map((key)=>this.#get(key));
120
+ }
121
+ /**
122
+ * Clears the store.
123
+ */ wipe() {
124
+ this.cache.clear();
125
+ }
126
+ #get(key) {
127
+ return this.cache.get(key);
128
+ }
129
+ #set(key, promise, shouldCache) {
130
+ const evict = ()=>{
131
+ if (this.cache.get(key) === promise) {
132
+ this.cache.delete(key);
133
+ }
134
+ };
135
+ // A rejected read is evicted so callers can retry; a `shouldCache` that throws is treated the same way. The
136
+ // trailing catch keeps a throwing predicate from surfacing as an unhandled rejection on this detached promise.
137
+ promise.then((value)=>{
138
+ if (shouldCache && !shouldCache(value)) {
139
+ evict();
140
+ }
141
+ }, evict).catch(evict);
142
+ this.cache.set(key, promise);
143
+ return promise;
144
+ }
145
+ }
146
+ /**
147
+ * The block hash `block` pins to (a `BlockHash` or `{ hash }` reference), or `undefined` for every other way of naming
148
+ * a block.
149
+ *
150
+ * A number or a tag names a moving chain position, as does naming no block at all: a reorg can put a different block
151
+ * at the same number, and tags follow the growing chain. An `{ archive }` root is different, since it commits to every
152
+ * block hash up to its own block and so pins content as tightly as a hash. It stays uncached because no PXE read uses
153
+ * one: keeping an `undefined` answer as a non-membership fact is only sound because PXE pins blocks it has already
154
+ * seen, and that holds for the references PXE actually builds.
155
+ */ function hashReferenceOf(block) {
156
+ if (block instanceof BlockHash) {
157
+ return block;
158
+ }
159
+ if (typeof block === 'object' && block !== null && 'hash' in block) {
160
+ return block.hash;
161
+ }
162
+ return undefined;
163
+ }
164
+ /**
165
+ * Answers one result per entry of `keys`, taking whatever the cache already holds and fetching the rest in a single
166
+ * batched call. Each fetched result is cached under its own key, so a later call that overlaps this one fetches only
167
+ * the entries it has not seen, and a key repeated within `keys` is asked of the node once.
168
+ *
169
+ * `fetchMissing` receives the indexes still missing, in order, and must answer one result per requested index.
170
+ * `shortResponse` names the method and what it requests, for the error raised when it does not.
171
+ */ function readBatchedPerKey(cache, keys, fetchMissing, shortResponse) {
172
+ const cached = cache.peekAll(keys);
173
+ // One request per missing key rather than per missing position, so a key repeated in `keys` seeds a single entry
174
+ // that every position carrying it then reads.
175
+ const requestIndexByKey = new Map();
176
+ cached.forEach((result, index)=>{
177
+ if (result === undefined && !requestIndexByKey.has(keys[index])) {
178
+ requestIndexByKey.set(keys[index], index);
179
+ }
180
+ });
181
+ const fetchedByKey = new Map();
182
+ if (requestIndexByKey.size > 0) {
183
+ const requestedIndexes = [
184
+ ...requestIndexByKey.values()
185
+ ];
186
+ const batch = fetchMissing(requestedIndexes).then((fetched)=>{
187
+ if (fetched.length !== requestedIndexes.length) {
188
+ // Each entry is filled from the batch response by position. If the node returned fewer results than we asked
189
+ // for, the positions past the end would read undefined, which the cache keeps as a genuine answer, so a
190
+ // truncated response would be cached as fact. Rejecting the whole batch evicts those entries instead, so a
191
+ // retry re-fetches every one of them.
192
+ throw new Error(`${shortResponse.method} returned ${fetched.length} results for ${requestedIndexes.length} requested ` + `${shortResponse.requested}`);
193
+ }
194
+ return fetched;
195
+ });
196
+ [
197
+ ...requestIndexByKey.keys()
198
+ ].forEach((key, batchIndex)=>{
199
+ fetchedByKey.set(key, cache.fetch(key, ()=>batch.then((fetched)=>fetched[batchIndex])));
200
+ });
201
+ }
202
+ // Every position is answered: a cache hit, or the entry its key's request seeded just above.
203
+ return Promise.all(keys.map((key, index)=>cached[index] ?? fetchedByKey.get(key)));
204
+ }
205
+ /**
206
+ * Whether a tag query's answer can no longer change, and so can be cached.
207
+ *
208
+ * Two things would let it change, and the query has to rule out both. `referenceBlock` names the chain the answer
209
+ * belongs to, so the call fails once that block is gone rather than answering from a chain that reorged. `toBlock`
210
+ * stops the query below the tip, so blocks yet to be produced cannot add logs to the answer. Where the query starts
211
+ * does not matter: an open lower end reaches only blocks that are already behind it, which no longer move. PXE's tag
212
+ * queries get both from the `getAll*LogsByTags` helpers, which take them from the anchor block the query is pinned to.
213
+ */ function hasImmutableAnswer(query) {
214
+ return query.referenceBlock !== undefined && query.toBlock !== undefined;
215
+ }
216
+ /** Cache-key segment for the parts of a private tag query that every tag in it shares. */ function privateLogsQueryKey(query) {
217
+ const parts = {
218
+ ...sharedQueryKeyParts(query)
219
+ };
220
+ return Object.values(parts).map(keyPart).join(':');
221
+ }
222
+ /** Cache-key segment for the parts of a public tag query that every tag in it shares. */ function publicLogsQueryKey(query) {
223
+ const parts = {
224
+ ...sharedQueryKeyParts(query),
225
+ contractAddress: query.contractAddress
226
+ };
227
+ return Object.values(parts).map(keyPart).join(':');
228
+ }
229
+ /** The key parts {@link PrivateLogsQuery} and {@link PublicLogsQuery} have in common. */ function sharedQueryKeyParts(query) {
230
+ return {
231
+ referenceBlock: query.referenceBlock,
232
+ fromBlock: query.fromBlock,
233
+ toBlock: query.toBlock,
234
+ txHash: query.txHash,
235
+ includeEffects: query.includeEffects,
236
+ limitPerTag: query.limitPerTag
237
+ };
238
+ }
239
+ /**
240
+ * Cache-key segment for one tag entry, covering the pagination cursor as well as the tag: each page of a tag's stream
241
+ * is a read of its own, and a repeated query asks for the same pages in the same order.
242
+ */ function tagQueryKey(entry) {
243
+ return 'tag' in entry ? `${keyPart(entry.tag)}@${keyPart(entry.afterLog)}` : keyPart(entry);
244
+ }
245
+ /**
246
+ * Renders a call argument as a stable cache-key segment, via its own `toString` when it has one, else as JSON.
247
+ *
248
+ * Example: the options object `{ includeTransactions: true }` renders as `'{"includeTransactions":true}'`, and an
249
+ * absent optional argument as `'undefined'`.
250
+ */ function keyPart(value) {
251
+ if ([
252
+ 'string',
253
+ 'number',
254
+ 'bigint',
255
+ 'boolean'
256
+ ].includes(typeof value)) {
257
+ return String(value);
258
+ }
259
+ if (value && typeof value === 'object') {
260
+ const toString = value.toString;
261
+ if (toString && toString !== Object.prototype.toString) {
262
+ return toString.call(value);
263
+ }
264
+ return JSON.stringify(value, (_key, nested)=>typeof nested === 'bigint' ? nested.toString() : nested);
265
+ }
266
+ return String(value);
267
+ }