@aztec/foundation 0.0.1-commit.7d4e6cd → 0.0.1-commit.7ffbba4

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 (191) hide show
  1. package/dest/array/sorted_array.d.ts +6 -1
  2. package/dest/array/sorted_array.d.ts.map +1 -1
  3. package/dest/array/sorted_array.js +18 -15
  4. package/dest/branded-types/block_number.d.ts +4 -1
  5. package/dest/branded-types/block_number.d.ts.map +1 -1
  6. package/dest/branded-types/block_number.js +3 -0
  7. package/dest/branded-types/index.d.ts +2 -1
  8. package/dest/branded-types/index.d.ts.map +1 -1
  9. package/dest/branded-types/index.js +1 -0
  10. package/dest/branded-types/index_within_checkpoint.d.ts +42 -0
  11. package/dest/branded-types/index_within_checkpoint.d.ts.map +1 -0
  12. package/dest/branded-types/index_within_checkpoint.js +59 -0
  13. package/dest/buffer/buffer16.d.ts +4 -1
  14. package/dest/buffer/buffer16.d.ts.map +1 -1
  15. package/dest/buffer/buffer32.d.ts +4 -1
  16. package/dest/buffer/buffer32.d.ts.map +1 -1
  17. package/dest/collection/array.d.ts +12 -1
  18. package/dest/collection/array.d.ts.map +1 -1
  19. package/dest/collection/array.js +51 -0
  20. package/dest/config/env_var.d.ts +2 -2
  21. package/dest/config/env_var.d.ts.map +1 -1
  22. package/dest/config/index.d.ts +5 -1
  23. package/dest/config/index.d.ts.map +1 -1
  24. package/dest/config/index.js +29 -0
  25. package/dest/config/network_config.d.ts +13 -1
  26. package/dest/config/network_config.d.ts.map +1 -1
  27. package/dest/config/network_config.js +3 -1
  28. package/dest/config/network_name.d.ts +2 -2
  29. package/dest/config/network_name.d.ts.map +1 -1
  30. package/dest/config/network_name.js +2 -0
  31. package/dest/crypto/ecdsa/signature.d.ts +10 -1
  32. package/dest/crypto/ecdsa/signature.d.ts.map +1 -1
  33. package/dest/crypto/poseidon/index.d.ts +1 -2
  34. package/dest/crypto/poseidon/index.d.ts.map +1 -1
  35. package/dest/crypto/poseidon/index.js +13 -22
  36. package/dest/crypto/random/randomness_singleton.d.ts +4 -3
  37. package/dest/crypto/random/randomness_singleton.d.ts.map +1 -1
  38. package/dest/crypto/random/randomness_singleton.js +4 -4
  39. package/dest/crypto/secp256k1-signer/utils.d.ts +12 -1
  40. package/dest/crypto/secp256k1-signer/utils.d.ts.map +1 -1
  41. package/dest/crypto/secp256k1-signer/utils.js +26 -0
  42. package/dest/crypto/sync/poseidon/index.d.ts +1 -2
  43. package/dest/crypto/sync/poseidon/index.d.ts.map +1 -1
  44. package/dest/crypto/sync/poseidon/index.js +0 -8
  45. package/dest/curves/bls12/point.d.ts +10 -1
  46. package/dest/curves/bls12/point.d.ts.map +1 -1
  47. package/dest/curves/bn254/field.d.ts +2 -1
  48. package/dest/curves/bn254/field.d.ts.map +1 -1
  49. package/dest/curves/bn254/field.js +5 -2
  50. package/dest/curves/grumpkin/point.d.ts +11 -2
  51. package/dest/curves/grumpkin/point.d.ts.map +1 -1
  52. package/dest/error/index.d.ts +4 -4
  53. package/dest/error/index.d.ts.map +1 -1
  54. package/dest/eth-signature/eth_signature.d.ts +5 -1
  55. package/dest/eth-signature/eth_signature.d.ts.map +1 -1
  56. package/dest/eth-signature/eth_signature.js +7 -2
  57. package/dest/jest/setup.js +28 -1
  58. package/dest/json-rpc/client/safe_json_rpc_client.d.ts +2 -1
  59. package/dest/json-rpc/client/safe_json_rpc_client.d.ts.map +1 -1
  60. package/dest/json-rpc/client/safe_json_rpc_client.js +1 -1
  61. package/dest/json-rpc/client/undici.d.ts +1 -1
  62. package/dest/json-rpc/client/undici.d.ts.map +1 -1
  63. package/dest/json-rpc/client/undici.js +21 -4
  64. package/dest/json-rpc/fixtures/class_a.d.ts +3 -3
  65. package/dest/json-rpc/fixtures/class_a.d.ts.map +1 -1
  66. package/dest/json-rpc/fixtures/class_b.d.ts +3 -3
  67. package/dest/json-rpc/fixtures/class_b.d.ts.map +1 -1
  68. package/dest/json-rpc/server/api_key_auth.d.ts +19 -0
  69. package/dest/json-rpc/server/api_key_auth.d.ts.map +1 -0
  70. package/dest/json-rpc/server/api_key_auth.js +57 -0
  71. package/dest/json-rpc/server/index.d.ts +2 -1
  72. package/dest/json-rpc/server/index.d.ts.map +1 -1
  73. package/dest/json-rpc/server/index.js +1 -0
  74. package/dest/json-rpc/server/safe_json_rpc_server.js +1 -1
  75. package/dest/log/bigint-utils.d.ts +5 -0
  76. package/dest/log/bigint-utils.d.ts.map +1 -0
  77. package/dest/log/bigint-utils.js +21 -0
  78. package/dest/log/gcloud-logger-config.d.ts +1 -1
  79. package/dest/log/gcloud-logger-config.d.ts.map +1 -1
  80. package/dest/log/gcloud-logger-config.js +3 -0
  81. package/dest/log/libp2p_logger.d.ts +5 -2
  82. package/dest/log/libp2p_logger.d.ts.map +1 -1
  83. package/dest/log/libp2p_logger.js +14 -4
  84. package/dest/log/log-filters.d.ts +17 -4
  85. package/dest/log/log-filters.d.ts.map +1 -1
  86. package/dest/log/log-filters.js +26 -12
  87. package/dest/log/pino-logger-server.d.ts +9 -0
  88. package/dest/log/pino-logger-server.d.ts.map +1 -0
  89. package/dest/log/pino-logger-server.js +18 -0
  90. package/dest/log/pino-logger.d.ts +37 -8
  91. package/dest/log/pino-logger.d.ts.map +1 -1
  92. package/dest/log/pino-logger.js +121 -28
  93. package/dest/queue/base_memory_queue.d.ts +2 -2
  94. package/dest/queue/base_memory_queue.d.ts.map +1 -1
  95. package/dest/queue/semaphore.d.ts +5 -1
  96. package/dest/queue/semaphore.d.ts.map +1 -1
  97. package/dest/retry/index.d.ts +11 -1
  98. package/dest/retry/index.d.ts.map +1 -1
  99. package/dest/retry/index.js +11 -0
  100. package/dest/serialize/buffer_reader.d.ts +14 -4
  101. package/dest/serialize/buffer_reader.d.ts.map +1 -1
  102. package/dest/serialize/buffer_reader.js +26 -4
  103. package/dest/serialize/serialize.d.ts +19 -1
  104. package/dest/serialize/serialize.d.ts.map +1 -1
  105. package/dest/serialize/serialize.js +31 -0
  106. package/dest/sleep/index.d.ts +2 -1
  107. package/dest/sleep/index.d.ts.map +1 -1
  108. package/dest/sleep/index.js +10 -1
  109. package/dest/timer/date.d.ts +25 -1
  110. package/dest/timer/date.d.ts.map +1 -1
  111. package/dest/timer/date.js +33 -0
  112. package/dest/transport/transport_client.js +2 -2
  113. package/dest/trees/balanced_merkle_tree_root.d.ts +17 -0
  114. package/dest/trees/balanced_merkle_tree_root.d.ts.map +1 -0
  115. package/dest/trees/{balanced_merkle_tree.js → balanced_merkle_tree_root.js} +2 -17
  116. package/dest/trees/hasher.d.ts +3 -1
  117. package/dest/trees/hasher.d.ts.map +1 -1
  118. package/dest/trees/hasher.js +10 -5
  119. package/dest/trees/index.d.ts +4 -4
  120. package/dest/trees/index.d.ts.map +1 -1
  121. package/dest/trees/index.js +3 -3
  122. package/dest/trees/membership_witness.d.ts +11 -1
  123. package/dest/trees/membership_witness.d.ts.map +1 -1
  124. package/dest/trees/membership_witness.js +9 -0
  125. package/dest/trees/merkle_tree_calculator.d.ts +1 -1
  126. package/dest/trees/merkle_tree_calculator.d.ts.map +1 -1
  127. package/dest/trees/merkle_tree_calculator.js +2 -2
  128. package/dest/trees/sibling_path.d.ts +2 -1
  129. package/dest/trees/sibling_path.d.ts.map +1 -1
  130. package/dest/trees/sibling_path.js +2 -2
  131. package/dest/trees/unbalanced_merkle_tree_calculator.d.ts +2 -2
  132. package/dest/trees/unbalanced_merkle_tree_calculator.d.ts.map +1 -1
  133. package/dest/trees/unbalanced_merkle_tree_calculator.js +1 -1
  134. package/dest/trees/{unbalanced_merkle_tree.d.ts → unbalanced_merkle_tree_root.d.ts} +3 -7
  135. package/dest/trees/unbalanced_merkle_tree_root.d.ts.map +1 -0
  136. package/dest/trees/{unbalanced_merkle_tree.js → unbalanced_merkle_tree_root.js} +8 -52
  137. package/dest/trees/unbalanced_tree_store.d.ts +5 -1
  138. package/dest/trees/unbalanced_tree_store.d.ts.map +1 -1
  139. package/dest/trees/unbalanced_tree_store.js +49 -1
  140. package/dest/types/index.d.ts +4 -2
  141. package/dest/types/index.d.ts.map +1 -1
  142. package/dest/types/index.js +3 -0
  143. package/package.json +25 -4
  144. package/src/array/sorted_array.ts +22 -17
  145. package/src/branded-types/block_number.ts +5 -0
  146. package/src/branded-types/index.ts +1 -0
  147. package/src/branded-types/index_within_checkpoint.ts +88 -0
  148. package/src/collection/array.ts +52 -0
  149. package/src/config/env_var.ts +57 -12
  150. package/src/config/index.ts +32 -0
  151. package/src/config/network_config.ts +2 -0
  152. package/src/config/network_name.ts +4 -1
  153. package/src/crypto/poseidon/index.ts +13 -23
  154. package/src/crypto/random/randomness_singleton.ts +9 -5
  155. package/src/crypto/secp256k1-signer/utils.ts +32 -0
  156. package/src/crypto/sync/poseidon/index.ts +0 -9
  157. package/src/curves/bn254/field.ts +6 -2
  158. package/src/eth-signature/eth_signature.ts +7 -1
  159. package/src/jest/setup.mjs +31 -1
  160. package/src/json-rpc/client/safe_json_rpc_client.ts +2 -0
  161. package/src/json-rpc/client/undici.ts +21 -3
  162. package/src/json-rpc/server/api_key_auth.ts +63 -0
  163. package/src/json-rpc/server/index.ts +1 -0
  164. package/src/json-rpc/server/safe_json_rpc_server.ts +1 -1
  165. package/src/log/bigint-utils.ts +25 -0
  166. package/src/log/gcloud-logger-config.ts +5 -0
  167. package/src/log/libp2p_logger.ts +12 -5
  168. package/src/log/log-filters.ts +29 -11
  169. package/src/log/pino-logger-server.ts +25 -0
  170. package/src/log/pino-logger.ts +142 -38
  171. package/src/queue/base_memory_queue.ts +1 -1
  172. package/src/queue/semaphore.ts +5 -0
  173. package/src/retry/index.ts +18 -0
  174. package/src/serialize/buffer_reader.ts +36 -9
  175. package/src/serialize/serialize.ts +32 -0
  176. package/src/sleep/index.ts +10 -1
  177. package/src/timer/date.ts +48 -0
  178. package/src/transport/transport_client.ts +2 -2
  179. package/src/trees/{balanced_merkle_tree.ts → balanced_merkle_tree_root.ts} +2 -18
  180. package/src/trees/hasher.ts +9 -0
  181. package/src/trees/index.ts +3 -3
  182. package/src/trees/membership_witness.ts +8 -0
  183. package/src/trees/merkle_tree_calculator.ts +2 -2
  184. package/src/trees/sibling_path.ts +2 -2
  185. package/src/trees/unbalanced_merkle_tree_calculator.ts +1 -2
  186. package/src/trees/{unbalanced_merkle_tree.ts → unbalanced_merkle_tree_root.ts} +8 -66
  187. package/src/trees/unbalanced_tree_store.ts +57 -2
  188. package/src/types/index.ts +6 -1
  189. package/dest/trees/balanced_merkle_tree.d.ts +0 -22
  190. package/dest/trees/balanced_merkle_tree.d.ts.map +0 -1
  191. package/dest/trees/unbalanced_merkle_tree.d.ts.map +0 -1
@@ -22,6 +22,7 @@ import { InterruptError } from '../error/index.js';
22
22
  */
23
23
  export class InterruptibleSleep {
24
24
  private interrupts: Array<(shouldThrow: boolean) => void> = [];
25
+ private timeoutIds: NodeJS.Timeout[] = [];
25
26
 
26
27
  /**
27
28
  * Sleep for a specified amount of time in milliseconds.
@@ -38,9 +39,15 @@ export class InterruptibleSleep {
38
39
  this.interrupts.push(resolve);
39
40
  });
40
41
 
41
- const timeoutPromise = new Promise<boolean>(resolve => setTimeout(() => resolve(false), ms));
42
+ let timeoutId: NodeJS.Timeout;
43
+ const timeoutPromise = new Promise<boolean>(resolve => {
44
+ timeoutId = setTimeout(() => resolve(false), ms);
45
+ this.timeoutIds.push(timeoutId);
46
+ });
42
47
  const shouldThrow = await Promise.race([interruptPromise, timeoutPromise]);
43
48
 
49
+ clearTimeout(timeoutId!);
50
+ this.timeoutIds = this.timeoutIds.filter(id => id !== timeoutId);
44
51
  this.interrupts = this.interrupts.filter(res => res !== interruptResolve);
45
52
 
46
53
  if (shouldThrow) {
@@ -58,6 +65,8 @@ export class InterruptibleSleep {
58
65
  public interrupt(sleepShouldThrow = false): void {
59
66
  this.interrupts.forEach(resolve => resolve(sleepShouldThrow));
60
67
  this.interrupts = [];
68
+ this.timeoutIds.forEach(id => clearTimeout(id));
69
+ this.timeoutIds = [];
61
70
  }
62
71
  }
63
72
 
package/src/timer/date.ts CHANGED
@@ -31,4 +31,52 @@ export class TestDateProvider extends DateProvider {
31
31
  this.offset = timeMs - Date.now();
32
32
  this.logger.warn(`Time set to ${new Date(timeMs).toISOString()}`, { offset: this.offset, timeMs });
33
33
  }
34
+
35
+ /** Resets the time back to real time (offset = 0). */
36
+ public reset() {
37
+ this.offset = 0;
38
+ this.logger.warn('Time reset to real time');
39
+ }
40
+
41
+ /** Advances the time by the given number of seconds. */
42
+ public advanceTime(seconds: number) {
43
+ this.offset += seconds * 1000;
44
+ }
45
+ }
46
+
47
+ /**
48
+ * A date provider for tests that only advances time via explicit advanceTime() calls.
49
+ * Unlike TestDateProvider, this does NOT track real time progression - time is completely
50
+ * frozen until explicitly advanced. This eliminates flakiness from tests taking
51
+ * varying amounts of real time to execute.
52
+ */
53
+ export class ManualDateProvider extends DateProvider {
54
+ private currentTimeMs: number;
55
+
56
+ /**
57
+ * @param initialTimeMs - Initial time in milliseconds. Defaults to a round timestamp for easy visualization.
58
+ */
59
+ constructor(initialTimeMs: number = Date.UTC(2025, 0, 1, 0, 0, 0)) {
60
+ super();
61
+ this.currentTimeMs = initialTimeMs;
62
+ }
63
+
64
+ public override now(): number {
65
+ return this.currentTimeMs;
66
+ }
67
+
68
+ /** Sets the current time to the given timestamp in milliseconds. */
69
+ public setTime(timeMs: number) {
70
+ this.currentTimeMs = timeMs;
71
+ }
72
+
73
+ /** Advances the time by the given number of seconds. */
74
+ public advanceTime(seconds: number) {
75
+ this.currentTimeMs += seconds * 1000;
76
+ }
77
+
78
+ /** Advances the time by the given number of milliseconds. */
79
+ public advanceTimeMs(ms: number) {
80
+ this.currentTimeMs += ms;
81
+ }
34
82
  }
@@ -91,7 +91,7 @@ export class TransportClient<Payload> extends EventEmitter {
91
91
  }
92
92
  const msgId = this.msgId++;
93
93
  const msg = { msgId, payload };
94
- log.debug(format(`->`, msg));
94
+ log.trace(format(`->`, msg));
95
95
  return new Promise<any>((resolve, reject) => {
96
96
  this.pendingRequests.push({ resolve, reject, msgId });
97
97
  this.socket!.send(msg, transfer).catch(reject);
@@ -111,7 +111,7 @@ export class TransportClient<Payload> extends EventEmitter {
111
111
  this.close();
112
112
  return;
113
113
  }
114
- log.debug(format(`<-`, msg));
114
+ log.trace(format(`<-`, msg));
115
115
  if (isEventMessage(msg)) {
116
116
  this.emit('event_msg', msg.payload);
117
117
  return;
@@ -1,23 +1,7 @@
1
- import { pedersenHash as pedersenHashArray } from '@aztec/foundation/crypto/pedersen';
2
- import { poseidon2Hash } from '@aztec/foundation/crypto/poseidon';
3
- import { sha256Trunc } from '@aztec/foundation/crypto/sha256';
4
-
5
- import type { AsyncHasher, Hasher } from './hasher.js';
6
-
7
- export const shaMerkleHash: Hasher['hash'] = (left: Buffer, right: Buffer) =>
8
- sha256Trunc(Buffer.concat([left, right])) as Buffer<ArrayBuffer>;
9
-
10
- export const pedersenMerkleHash: AsyncHasher['hash'] = async (left: Buffer, right: Buffer) =>
11
- (await pedersenHashArray([left, right])).toBuffer() as Buffer<ArrayBuffer>;
12
-
13
- export const poseidonMerkleHash: AsyncHasher['hash'] = async (left: Buffer, right: Buffer) =>
14
- (await poseidon2Hash([left, right])).toBuffer() as Buffer<ArrayBuffer>;
1
+ import { poseidonMerkleHash, shaMerkleHash } from './hasher.js';
15
2
 
16
3
  export const computeBalancedShaRoot = (leaves: Buffer[]) => computeBalancedMerkleTreeRoot(leaves);
17
4
 
18
- export const computeBalancedPedersenRoot = async (leaves: Buffer[]) =>
19
- await computeBalancedMerkleTreeRootAsync(leaves, pedersenMerkleHash);
20
-
21
5
  export const computeBalancedPoseidonRoot = async (leaves: Buffer[]) =>
22
6
  await computeBalancedMerkleTreeRootAsync(leaves, poseidonMerkleHash);
23
7
 
@@ -46,7 +30,7 @@ export function computeBalancedMerkleTreeRoot(leaves: Buffer[], hasher = shaMerk
46
30
 
47
31
  /**
48
32
  * Computes the Merkle root with the provided leaves **asynchronously**.
49
- * This method uses an asynchronous hash function (defaults to `pedersenHash`).
33
+ * This method uses an asynchronous hash function (defaults to `poseidon2Hash`).
50
34
  *
51
35
  * @throws If the number of leaves is not a power of two.
52
36
  */
@@ -1,3 +1,6 @@
1
+ import { poseidon2Hash } from '../crypto/poseidon/index.js';
2
+ import { sha256Trunc } from '../crypto/sha256/index.js';
3
+
1
4
  /**
2
5
  * Defines hasher interface used by Merkle trees.
3
6
  */
@@ -37,3 +40,9 @@ export interface AsyncHasher {
37
40
  */
38
41
  hashInputs(inputs: Buffer[]): Promise<Buffer<ArrayBuffer>>;
39
42
  }
43
+
44
+ export const shaMerkleHash: Hasher['hash'] = (left: Buffer, right: Buffer) =>
45
+ sha256Trunc(Buffer.concat([left, right])) as Buffer<ArrayBuffer>;
46
+
47
+ export const poseidonMerkleHash: AsyncHasher['hash'] = async (left: Buffer, right: Buffer) =>
48
+ (await poseidon2Hash([left, right])).toBuffer() as Buffer<ArrayBuffer>;
@@ -1,6 +1,4 @@
1
- export * from './balanced_merkle_tree.js';
2
- export * from './unbalanced_merkle_tree.js';
3
- export * from './unbalanced_tree_store.js';
1
+ export * from './balanced_merkle_tree_root.js';
4
2
  export * from './merkle_tree_calculator.js';
5
3
  export * from './merkle_tree.js';
6
4
  export * from './indexed_merkle_tree_calculator.js';
@@ -10,3 +8,5 @@ export * from './membership_witness.js';
10
8
  export * from './hasher.js';
11
9
  export * from './indexed_tree_leaf.js';
12
10
  export * from './unbalanced_merkle_tree_calculator.js';
11
+ export * from './unbalanced_merkle_tree_root.js';
12
+ export * from './unbalanced_tree_store.js';
@@ -38,6 +38,14 @@ export class MembershipWitness<N extends number> {
38
38
  return [new Fr(this.leafIndex), ...this.siblingPath];
39
39
  }
40
40
 
41
+ /**
42
+ * Returns a representation of the membership witness as expected by intrinsic Noir deserialization.
43
+ */
44
+ public toNoirRepresentation(): (string | string[])[] {
45
+ // TODO(#12874): remove the stupid as string conversion by modifying ForeignCallOutput type in acvm.js
46
+ return [new Fr(this.leafIndex).toString() as string, this.siblingPath.map(fr => fr.toString()) as string[]];
47
+ }
48
+
41
49
  static schemaFor<N extends number>(size: N) {
42
50
  return schemas.Buffer.transform(b => MembershipWitness.fromBuffer(b, size));
43
51
  }
@@ -1,4 +1,4 @@
1
- import { pedersenHash } from '@aztec/foundation/crypto/pedersen';
1
+ import { poseidon2Hash } from '@aztec/foundation/crypto/poseidon';
2
2
 
3
3
  import type { AsyncHasher } from './hasher.js';
4
4
  import { MerkleTree } from './merkle_tree.js';
@@ -19,7 +19,7 @@ export class MerkleTreeCalculator {
19
19
  height: number,
20
20
  zeroLeaf: Buffer = Buffer.alloc(32),
21
21
  hasher = async (left: Buffer, right: Buffer) =>
22
- (await pedersenHash([left, right])).toBuffer() as Buffer<ArrayBuffer>,
22
+ (await poseidon2Hash([left, right])).toBuffer() as Buffer<ArrayBuffer>,
23
23
  ) {
24
24
  const zeroHashes = [zeroLeaf];
25
25
  for (let i = 0; i < height; i++) {
@@ -1,5 +1,5 @@
1
1
  import { makeTuple } from '../array/array.js';
2
- import { pedersenHash } from '../crypto/pedersen/index.js';
2
+ import { poseidon2Hash } from '../crypto/poseidon/index.js';
3
3
  import { Fr } from '../curves/bn254/index.js';
4
4
  import { schemas } from '../schemas/index.js';
5
5
  import {
@@ -172,7 +172,7 @@ export async function computeRootFromSiblingPath(
172
172
  leaf: Buffer,
173
173
  siblingPath: Buffer[],
174
174
  index: number,
175
- hasher = async (left: Buffer, right: Buffer) => (await pedersenHash([left, right])).toBuffer(),
175
+ hasher = async (left: Buffer, right: Buffer) => (await poseidon2Hash([left, right])).toBuffer(),
176
176
  ) {
177
177
  let result = leaf;
178
178
  for (const sibling of siblingPath) {
@@ -1,5 +1,4 @@
1
- import { shaMerkleHash } from './balanced_merkle_tree.js';
2
- import type { Hasher } from './hasher.js';
1
+ import { type Hasher, shaMerkleHash } from './hasher.js';
3
2
  import { SiblingPath } from './sibling_path.js';
4
3
  import { type TreeNodeLocation, UnbalancedTreeStore } from './unbalanced_tree_store.js';
5
4
 
@@ -1,9 +1,5 @@
1
- import {
2
- computeBalancedMerkleTreeRoot,
3
- computeBalancedMerkleTreeRootAsync,
4
- poseidonMerkleHash,
5
- shaMerkleHash,
6
- } from './balanced_merkle_tree.js';
1
+ import { computeBalancedMerkleTreeRoot, computeBalancedMerkleTreeRootAsync } from './balanced_merkle_tree_root.js';
2
+ import { poseidonMerkleHash, shaMerkleHash } from './hasher.js';
7
3
  import { UnbalancedMerkleTreeCalculator } from './unbalanced_merkle_tree_calculator.js';
8
4
 
9
5
  export const computeUnbalancedShaRoot = (leaves: Buffer[]) => computeUnbalancedMerkleTreeRoot(leaves, shaMerkleHash);
@@ -11,8 +7,7 @@ export const computeUnbalancedShaRoot = (leaves: Buffer[]) => computeUnbalancedM
11
7
  export const computeUnbalancedPoseidonRoot = async (leaves: Buffer[]) =>
12
8
  await computeUnbalancedMerkleTreeRootAsync(leaves, poseidonMerkleHash);
13
9
 
14
- export const computeCompressedUnbalancedShaRoot = (leaves: Buffer[]) =>
15
- computeCompressedUnbalancedMerkleTreeRoot(leaves);
10
+ export const computeWonkyShaRoot = (leaves: Buffer[]) => computeWonkyMerkleTreeRoot(leaves);
16
11
 
17
12
  /**
18
13
  * Computes the Merkle root of an unbalanced tree.
@@ -105,7 +100,11 @@ export async function computeUnbalancedMerkleTreeRootAsync(
105
100
  return root!;
106
101
  }
107
102
 
108
- export function computeCompressedUnbalancedMerkleTreeRoot(
103
+ // A **wonky** tree is a "compressed" unbalanced Merkle tree.
104
+ // It is constructed in the same way as an unbalanced tree: by first creating the largest possible left subtree, with
105
+ // the remaining leaves forming a right subtree that follows the same process recursively.
106
+ // During construction, leaves equal to `valueToCompress` are skipped (compressed) and do not contribute to the tree.
107
+ export function computeWonkyMerkleTreeRoot(
109
108
  leaves: Buffer[],
110
109
  valueToCompress = Buffer.alloc(32),
111
110
  emptyRoot = Buffer.alloc(32),
@@ -114,60 +113,3 @@ export function computeCompressedUnbalancedMerkleTreeRoot(
114
113
  const calculator = UnbalancedMerkleTreeCalculator.create(leaves, valueToCompress, emptyRoot, hasher);
115
114
  return calculator.getRoot();
116
115
  }
117
-
118
- /// Get the depth of the maximum balanced tree that can be created with the given number of leaves. The subtree will be
119
- /// the left most subtree of the wonky tree with a total of `numLeaves` leaves.
120
- ///
121
- /// Note: All the leaves may not be used to form the tree. For example, if there are 5 leaves, the maximum depth is 2,
122
- /// only 4 leaves are used to form a balanced tree.
123
- function getMaxBalancedSubtreeDepth(numLeaves: number) {
124
- return Math.floor(Math.log2(numLeaves));
125
- }
126
-
127
- /// Get the maximum depth of an unbalanced tree that can be created with the given number of leaves.
128
- function getMaxUnbalancedTreeDepth(numLeaves: number) {
129
- return Math.ceil(Math.log2(numLeaves));
130
- }
131
-
132
- function findPosition(
133
- rootLevel: number,
134
- leafLevel: number,
135
- numLeaves: number,
136
- indexOffset: number,
137
- targetIndex: number,
138
- ): { level: number; indexAtLevel: number } {
139
- if (numLeaves <= 1) {
140
- // Single leaf.
141
- return { level: rootLevel, indexAtLevel: indexOffset };
142
- }
143
-
144
- // The largest balanced tree that can be created with the given number of leaves.
145
- const maxBalancedTreeDepth = getMaxBalancedSubtreeDepth(numLeaves);
146
- const numBalancedLeaves = 2 ** maxBalancedTreeDepth;
147
- const numRemainingLeaves = numLeaves - numBalancedLeaves;
148
-
149
- if (targetIndex < numBalancedLeaves) {
150
- // Target is in the balanced tree.
151
-
152
- // - If numRemainingLeaves is 0: this balanced tree is grown from the current root.
153
- // - If numRemainingLeaves is not 0: the remaining leaves will form another tree, which will become the right child of the root.
154
- // And the balanced tree will be the left child of the root.
155
- // There will be an extra level between the root of the balanced tree and the current root.
156
- const extraLevel = numRemainingLeaves ? 1 : 0;
157
-
158
- return { level: rootLevel + maxBalancedTreeDepth + extraLevel, indexAtLevel: indexOffset + targetIndex };
159
- } else {
160
- // Target is in the right branch.
161
- const rightBranchMaxLevel = getMaxUnbalancedTreeDepth(numRemainingLeaves);
162
- const shiftedUp = leafLevel - rootLevel - rightBranchMaxLevel - 1;
163
- const nextLeafLevel = leafLevel - shiftedUp;
164
- const newIndexOffset = (indexOffset + numBalancedLeaves) >> shiftedUp;
165
- const shiftedTargetIndex = targetIndex - numBalancedLeaves;
166
- return findPosition(rootLevel + 1, nextLeafLevel, numRemainingLeaves, newIndexOffset, shiftedTargetIndex);
167
- }
168
- }
169
-
170
- export function findLeafLevelAndIndex(numLeaves: number, leafIndex: number) {
171
- const maxLevel = getMaxUnbalancedTreeDepth(numLeaves);
172
- return findPosition(0, maxLevel, numLeaves, 0, leafIndex);
173
- }
@@ -1,5 +1,3 @@
1
- import { findLeafLevelAndIndex } from './unbalanced_merkle_tree.js';
2
-
3
1
  export interface TreeNodeLocation {
4
2
  level: number;
5
3
  index: number;
@@ -104,3 +102,60 @@ export class UnbalancedTreeStore<T> {
104
102
  return `${location.level}-${location.index}`;
105
103
  }
106
104
  }
105
+
106
+ /// Get the depth of the maximum balanced tree that can be created with the given number of leaves. The subtree will be
107
+ /// the left most subtree of the unbalanced tree with a total of `numLeaves` leaves.
108
+ ///
109
+ /// Note: All the leaves may not be used to form the tree. For example, if there are 5 leaves, the maximum depth is 2,
110
+ /// only 4 leaves are used to form a balanced tree.
111
+ function getMaxBalancedSubtreeDepth(numLeaves: number) {
112
+ return Math.floor(Math.log2(numLeaves));
113
+ }
114
+
115
+ /// Get the maximum depth of an unbalanced tree that can be created with the given number of leaves.
116
+ function getMaxUnbalancedTreeDepth(numLeaves: number) {
117
+ return Math.ceil(Math.log2(numLeaves));
118
+ }
119
+
120
+ function findPosition(
121
+ rootLevel: number,
122
+ leafLevel: number,
123
+ numLeaves: number,
124
+ indexOffset: number,
125
+ targetIndex: number,
126
+ ): { level: number; indexAtLevel: number } {
127
+ if (numLeaves <= 1) {
128
+ // Single leaf.
129
+ return { level: rootLevel, indexAtLevel: indexOffset };
130
+ }
131
+
132
+ // The largest balanced tree that can be created with the given number of leaves.
133
+ const maxBalancedTreeDepth = getMaxBalancedSubtreeDepth(numLeaves);
134
+ const numBalancedLeaves = 2 ** maxBalancedTreeDepth;
135
+ const numRemainingLeaves = numLeaves - numBalancedLeaves;
136
+
137
+ if (targetIndex < numBalancedLeaves) {
138
+ // Target is in the balanced tree.
139
+
140
+ // - If numRemainingLeaves is 0: this balanced tree is grown from the current root.
141
+ // - If numRemainingLeaves is not 0: the remaining leaves will form another tree, which will become the right child of the root.
142
+ // And the balanced tree will be the left child of the root.
143
+ // There will be an extra level between the root of the balanced tree and the current root.
144
+ const extraLevel = numRemainingLeaves ? 1 : 0;
145
+
146
+ return { level: rootLevel + maxBalancedTreeDepth + extraLevel, indexAtLevel: indexOffset + targetIndex };
147
+ } else {
148
+ // Target is in the right branch.
149
+ const rightBranchMaxLevel = getMaxUnbalancedTreeDepth(numRemainingLeaves);
150
+ const shiftedUp = leafLevel - rootLevel - rightBranchMaxLevel - 1;
151
+ const nextLeafLevel = leafLevel - shiftedUp;
152
+ const newIndexOffset = (indexOffset + numBalancedLeaves) >> shiftedUp;
153
+ const shiftedTargetIndex = targetIndex - numBalancedLeaves;
154
+ return findPosition(rootLevel + 1, nextLeafLevel, numRemainingLeaves, newIndexOffset, shiftedTargetIndex);
155
+ }
156
+ }
157
+
158
+ export function findLeafLevelAndIndex(numLeaves: number, leafIndex: number) {
159
+ const maxLevel = getMaxUnbalancedTreeDepth(numLeaves);
160
+ return findPosition(0, maxLevel, numLeaves, 0, leafIndex);
161
+ }
@@ -24,6 +24,11 @@ export function isDefined<T>(value: T | undefined): value is T {
24
24
  return value !== undefined;
25
25
  }
26
26
 
27
+ /** Type guard for error classes */
28
+ export function isErrorClass<T extends Error>(value: unknown, errorClass: new (...args: any[]) => T): value is T {
29
+ return value instanceof errorClass || (value instanceof Error && value.name === errorClass.name);
30
+ }
31
+
27
32
  /** Resolves a record-like type. Lifted from viem. */
28
33
  export type Prettify<T> = {
29
34
  [K in keyof T]: T[K];
@@ -33,7 +38,7 @@ export type Prettify<T> = {
33
38
  * Type-safe Event Emitter type
34
39
  * @example
35
40
  * export type ArchiverEmitter = TypedEventEmitter<{
36
- * [L2BlockSourceEvents.L2PruneDetected]: (args: L2BlockSourceEvent) => void;
41
+ * [L2BlockSourceEvents.L2PruneUnproven]: (args: L2BlockSourceEvent) => void;
37
42
  * [L2BlockSourceEvents.L2BlockProven]: (args: L2BlockSourceEvent) => void;
38
43
  * }>;
39
44
  * class Archiver extends (EventEmitter as new () => ArchiverEmitter) {
@@ -1,22 +0,0 @@
1
- import type { AsyncHasher, Hasher } from './hasher.js';
2
- export declare const shaMerkleHash: Hasher['hash'];
3
- export declare const pedersenMerkleHash: AsyncHasher['hash'];
4
- export declare const poseidonMerkleHash: AsyncHasher['hash'];
5
- export declare const computeBalancedShaRoot: (leaves: Buffer<ArrayBufferLike>[]) => Buffer<ArrayBufferLike>;
6
- export declare const computeBalancedPedersenRoot: (leaves: Buffer<ArrayBufferLike>[]) => Promise<Buffer<ArrayBufferLike>>;
7
- export declare const computeBalancedPoseidonRoot: (leaves: Buffer<ArrayBufferLike>[]) => Promise<Buffer<ArrayBufferLike>>;
8
- /**
9
- * Computes the Merkle root with the provided leaves **synchronously**.
10
- * This method uses a synchronous hash function (defaults to `sha256Trunc`).
11
- *
12
- * @throws If the number of leaves is not a power of two.
13
- */
14
- export declare function computeBalancedMerkleTreeRoot(leaves: Buffer[], hasher?: (lhs: Uint8Array<ArrayBufferLike>, rhs: Uint8Array<ArrayBufferLike>) => Buffer<ArrayBuffer>): Buffer;
15
- /**
16
- * Computes the Merkle root with the provided leaves **asynchronously**.
17
- * This method uses an asynchronous hash function (defaults to `pedersenHash`).
18
- *
19
- * @throws If the number of leaves is not a power of two.
20
- */
21
- export declare function computeBalancedMerkleTreeRootAsync(leaves: Buffer[], hasher?: (lhs: Uint8Array<ArrayBufferLike>, rhs: Uint8Array<ArrayBufferLike>) => Promise<Buffer<ArrayBuffer>>): Promise<Buffer>;
22
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFsYW5jZWRfbWVya2xlX3RyZWUuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy90cmVlcy9iYWxhbmNlZF9tZXJrbGVfdHJlZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFJQSxPQUFPLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBRXZELGVBQU8sTUFBTSxhQUFhLEVBQUUsTUFBTSxDQUFDLE1BQU0sQ0FDeUIsQ0FBQztBQUVuRSxlQUFPLE1BQU0sa0JBQWtCLEVBQUUsV0FBVyxDQUFDLE1BQU0sQ0FDeUIsQ0FBQztBQUU3RSxlQUFPLE1BQU0sa0JBQWtCLEVBQUUsV0FBVyxDQUFDLE1BQU0sQ0FDcUIsQ0FBQztBQUV6RSxlQUFPLE1BQU0sc0JBQXNCLGdFQUE4RCxDQUFDO0FBRWxHLGVBQU8sTUFBTSwyQkFBMkIseUVBQzhCLENBQUM7QUFFdkUsZUFBTyxNQUFNLDJCQUEyQix5RUFDOEIsQ0FBQztBQUV2RTs7Ozs7R0FLRztBQUNILHdCQUFnQiw2QkFBNkIsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLEVBQUUsTUFBTSw4RkFBZ0IsR0FBRyxNQUFNLENBZTlGO0FBRUQ7Ozs7O0dBS0c7QUFDSCx3QkFBc0Isa0NBQWtDLENBQ3RELE1BQU0sRUFBRSxNQUFNLEVBQUUsRUFDaEIsTUFBTSx1R0FBcUIsR0FDMUIsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQWVqQiJ9
@@ -1 +0,0 @@
1
- {"version":3,"file":"balanced_merkle_tree.d.ts","sourceRoot":"","sources":["../../src/trees/balanced_merkle_tree.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAEvD,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,CACyB,CAAC;AAEnE,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC,MAAM,CACyB,CAAC;AAE7E,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC,MAAM,CACqB,CAAC;AAEzE,eAAO,MAAM,sBAAsB,gEAA8D,CAAC;AAElG,eAAO,MAAM,2BAA2B,yEAC8B,CAAC;AAEvE,eAAO,MAAM,2BAA2B,yEAC8B,CAAC;AAEvE;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,8FAAgB,GAAG,MAAM,CAe9F;AAED;;;;;GAKG;AACH,wBAAsB,kCAAkC,CACtD,MAAM,EAAE,MAAM,EAAE,EAChB,MAAM,uGAAqB,GAC1B,OAAO,CAAC,MAAM,CAAC,CAejB"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"unbalanced_merkle_tree.d.ts","sourceRoot":"","sources":["../../src/trees/unbalanced_merkle_tree.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,wBAAwB,gEAA+E,CAAC;AAErH,eAAO,MAAM,6BAA6B,yEAC8B,CAAC;AAEzE,eAAO,MAAM,kCAAkC,gEACI,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,+BAA+B,CAC7C,MAAM,EAAE,MAAM,EAAE,EAChB,MAAM,8FAAgB,EACtB,SAAS,sBAAmB,GAC3B,MAAM,CA6BR;AAED,wBAAsB,oCAAoC,CACxD,MAAM,EAAE,MAAM,EAAE,EAChB,MAAM,uGAAqB,EAC3B,SAAS,sBAAmB,GAC3B,OAAO,CAAC,MAAM,CAAC,CA6BjB;AAED,wBAAgB,yCAAyC,CACvD,MAAM,EAAE,MAAM,EAAE,EAChB,eAAe,sBAAmB,EAClC,SAAS,sBAAmB,EAC5B,MAAM,8FAAgB,GACrB,MAAM,CAGR;AAsDD,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;;;EAGzE"}