@aztec/foundation 0.0.1-commit.993d52e → 0.0.1-commit.9badcec54

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 (169) hide show
  1. package/dest/branded-types/buffer32_hash.d.ts +24 -0
  2. package/dest/branded-types/buffer32_hash.d.ts.map +1 -0
  3. package/dest/branded-types/buffer32_hash.js +19 -0
  4. package/dest/branded-types/checkpoint_number.d.ts +4 -1
  5. package/dest/branded-types/checkpoint_number.d.ts.map +1 -1
  6. package/dest/branded-types/checkpoint_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/slot.d.ts +4 -1
  11. package/dest/branded-types/slot.d.ts.map +1 -1
  12. package/dest/branded-types/slot.js +3 -0
  13. package/dest/buffer/buffer16.d.ts +3 -1
  14. package/dest/buffer/buffer16.d.ts.map +1 -1
  15. package/dest/buffer/buffer32.d.ts +28 -61
  16. package/dest/buffer/buffer32.d.ts.map +1 -1
  17. package/dest/buffer/buffer32.js +26 -60
  18. package/dest/buffer/index.d.ts +2 -1
  19. package/dest/buffer/index.d.ts.map +1 -1
  20. package/dest/buffer/index.js +1 -0
  21. package/dest/buffer/utils.d.ts +3 -0
  22. package/dest/buffer/utils.d.ts.map +1 -0
  23. package/dest/buffer/utils.js +7 -0
  24. package/dest/collection/array.d.ts +3 -1
  25. package/dest/collection/array.d.ts.map +1 -1
  26. package/dest/collection/array.js +15 -0
  27. package/dest/collection/index.d.ts +2 -1
  28. package/dest/collection/index.d.ts.map +1 -1
  29. package/dest/collection/index.js +1 -0
  30. package/dest/collection/lru_set.d.ts +35 -0
  31. package/dest/collection/lru_set.d.ts.map +1 -0
  32. package/dest/collection/lru_set.js +95 -0
  33. package/dest/config/env_var.d.ts +2 -2
  34. package/dest/config/env_var.d.ts.map +1 -1
  35. package/dest/config/index.d.ts +48 -30
  36. package/dest/config/index.d.ts.map +1 -1
  37. package/dest/config/index.js +21 -30
  38. package/dest/config/network_config.d.ts +13 -1
  39. package/dest/config/network_config.d.ts.map +1 -1
  40. package/dest/config/network_config.js +2 -0
  41. package/dest/config/network_name.d.ts +2 -2
  42. package/dest/config/network_name.d.ts.map +1 -1
  43. package/dest/config/network_name.js +2 -0
  44. package/dest/crypto/aes128/index.d.ts +2 -1
  45. package/dest/crypto/aes128/index.d.ts.map +1 -1
  46. package/dest/crypto/aes128/index.js +11 -2
  47. package/dest/crypto/bls/bn254_keystore.d.ts +1 -10
  48. package/dest/crypto/bls/bn254_keystore.d.ts.map +1 -1
  49. package/dest/crypto/bls/bn254_keystore.js +0 -17
  50. package/dest/crypto/poseidon/index.d.ts +1 -1
  51. package/dest/crypto/poseidon/index.d.ts.map +1 -1
  52. package/dest/crypto/poseidon/index.js +40 -33
  53. package/dest/curves/bls12/field.d.ts +1 -1
  54. package/dest/curves/bls12/field.d.ts.map +1 -1
  55. package/dest/curves/bls12/field.js +0 -5
  56. package/dest/curves/bn254/field.d.ts +17 -16
  57. package/dest/curves/bn254/field.d.ts.map +1 -1
  58. package/dest/curves/bn254/field.js +18 -13
  59. package/dest/curves/grumpkin/point.d.ts +4 -4
  60. package/dest/curves/grumpkin/point.d.ts.map +1 -1
  61. package/dest/curves/grumpkin/point.js +7 -4
  62. package/dest/eth-address/index.d.ts +1 -1
  63. package/dest/eth-address/index.d.ts.map +1 -1
  64. package/dest/eth-address/index.js +0 -3
  65. package/dest/fifo/fifo_frame_reader.d.ts +41 -0
  66. package/dest/fifo/fifo_frame_reader.d.ts.map +1 -0
  67. package/dest/fifo/fifo_frame_reader.js +74 -0
  68. package/dest/fifo/index.d.ts +2 -0
  69. package/dest/fifo/index.d.ts.map +1 -0
  70. package/dest/fifo/index.js +1 -0
  71. package/dest/jest/setup.js +24 -0
  72. package/dest/json-rpc/client/fetch.d.ts +1 -1
  73. package/dest/json-rpc/client/fetch.d.ts.map +1 -1
  74. package/dest/json-rpc/client/fetch.js +4 -3
  75. package/dest/json-rpc/client/undici.d.ts +1 -1
  76. package/dest/json-rpc/client/undici.d.ts.map +1 -1
  77. package/dest/json-rpc/client/undici.js +5 -3
  78. package/dest/log/pino-logger.d.ts +1 -1
  79. package/dest/log/pino-logger.d.ts.map +1 -1
  80. package/dest/log/pino-logger.js +17 -2
  81. package/dest/queue/batch_queue.d.ts +1 -1
  82. package/dest/queue/batch_queue.d.ts.map +1 -1
  83. package/dest/queue/batch_queue.js +1 -0
  84. package/dest/retry/index.d.ts +12 -1
  85. package/dest/retry/index.d.ts.map +1 -1
  86. package/dest/retry/index.js +21 -0
  87. package/dest/schemas/api.d.ts +2 -2
  88. package/dest/schemas/api.d.ts.map +1 -1
  89. package/dest/sleep/index.d.ts +2 -1
  90. package/dest/sleep/index.d.ts.map +1 -1
  91. package/dest/sleep/index.js +10 -1
  92. package/dest/string/index.js +1 -1
  93. package/dest/timer/date.d.ts +3 -1
  94. package/dest/timer/date.d.ts.map +1 -1
  95. package/dest/timer/date.js +4 -0
  96. package/dest/transport/dispatch/create_dispatch_proxy.d.ts +11 -2
  97. package/dest/transport/dispatch/create_dispatch_proxy.d.ts.map +1 -1
  98. package/dest/transport/index.d.ts +1 -2
  99. package/dest/transport/index.d.ts.map +1 -1
  100. package/dest/transport/index.js +0 -1
  101. package/dest/trees/balanced_merkle_tree_root.d.ts +2 -3
  102. package/dest/trees/balanced_merkle_tree_root.d.ts.map +1 -1
  103. package/dest/trees/balanced_merkle_tree_root.js +2 -3
  104. package/dest/trees/hasher.d.ts +3 -2
  105. package/dest/trees/hasher.d.ts.map +1 -1
  106. package/dest/trees/hasher.js +5 -5
  107. package/dest/trees/indexed_merkle_tree_calculator.d.ts +1 -1
  108. package/dest/trees/indexed_merkle_tree_calculator.d.ts.map +1 -1
  109. package/dest/trees/indexed_merkle_tree_calculator.js +5 -1
  110. package/dest/trees/merkle_tree_calculator.d.ts +4 -2
  111. package/dest/trees/merkle_tree_calculator.d.ts.map +1 -1
  112. package/dest/trees/merkle_tree_calculator.js +1 -5
  113. package/dest/trees/sibling_path.d.ts +2 -2
  114. package/dest/trees/sibling_path.d.ts.map +1 -1
  115. package/dest/trees/sibling_path.js +1 -5
  116. package/dest/trees/unbalanced_merkle_tree_root.d.ts +2 -3
  117. package/dest/trees/unbalanced_merkle_tree_root.d.ts.map +1 -1
  118. package/dest/trees/unbalanced_merkle_tree_root.js +2 -3
  119. package/package.json +3 -2
  120. package/src/branded-types/buffer32_hash.ts +42 -0
  121. package/src/branded-types/checkpoint_number.ts +5 -0
  122. package/src/branded-types/index.ts +1 -0
  123. package/src/branded-types/slot.ts +5 -0
  124. package/src/buffer/buffer16.ts +3 -0
  125. package/src/buffer/buffer32.ts +36 -65
  126. package/src/buffer/index.ts +1 -0
  127. package/src/buffer/utils.ts +8 -0
  128. package/src/collection/array.ts +14 -0
  129. package/src/collection/index.ts +1 -0
  130. package/src/collection/lru_set.ts +115 -0
  131. package/src/config/env_var.ts +22 -9
  132. package/src/config/index.ts +96 -84
  133. package/src/config/network_config.ts +2 -0
  134. package/src/config/network_name.ts +4 -1
  135. package/src/crypto/aes128/index.ts +11 -2
  136. package/src/crypto/bls/bn254_keystore.ts +0 -23
  137. package/src/crypto/poseidon/index.ts +42 -34
  138. package/src/curves/bls12/field.ts +0 -7
  139. package/src/curves/bn254/field.ts +25 -31
  140. package/src/curves/grumpkin/point.ts +6 -3
  141. package/src/eth-address/index.ts +0 -4
  142. package/src/fifo/fifo_frame_reader.ts +98 -0
  143. package/src/fifo/index.ts +1 -0
  144. package/src/jest/setup.mjs +27 -0
  145. package/src/json-rpc/client/fetch.ts +4 -3
  146. package/src/json-rpc/client/undici.ts +5 -3
  147. package/src/log/pino-logger.ts +19 -2
  148. package/src/queue/batch_queue.ts +1 -0
  149. package/src/retry/index.ts +30 -0
  150. package/src/schemas/api.ts +4 -1
  151. package/src/sleep/index.ts +10 -1
  152. package/src/string/index.ts +1 -1
  153. package/src/timer/date.ts +6 -0
  154. package/src/transport/dispatch/create_dispatch_proxy.ts +11 -1
  155. package/src/transport/index.ts +0 -1
  156. package/src/trees/balanced_merkle_tree_root.ts +2 -5
  157. package/src/trees/hasher.ts +6 -3
  158. package/src/trees/indexed_merkle_tree_calculator.ts +5 -1
  159. package/src/trees/merkle_tree_calculator.ts +4 -10
  160. package/src/trees/sibling_path.ts +1 -2
  161. package/src/trees/unbalanced_merkle_tree_root.ts +2 -5
  162. package/dest/crypto/serialize.d.ts +0 -51
  163. package/dest/crypto/serialize.d.ts.map +0 -1
  164. package/dest/crypto/serialize.js +0 -68
  165. package/dest/transport/dispatch/create_dispatch_fn.d.ts +0 -25
  166. package/dest/transport/dispatch/create_dispatch_fn.d.ts.map +0 -1
  167. package/dest/transport/dispatch/create_dispatch_fn.js +0 -17
  168. package/src/crypto/serialize.ts +0 -85
  169. package/src/transport/dispatch/create_dispatch_fn.ts +0 -35
@@ -1,21 +1,35 @@
1
- import { Barretenberg } from '@aztec/bb.js';
1
+ import { Barretenberg, BarretenbergSync } from '@aztec/bb.js';
2
2
 
3
3
  import { Fr } from '../../curves/bn254/field.js';
4
4
  import { type Fieldable, serializeToFields } from '../../serialize/serialize.js';
5
5
 
6
+ const IS_BROWSER = typeof self !== 'undefined';
7
+
8
+ async function poseidon2HashFields(inputFields: Fr[]): Promise<Fr> {
9
+ if (IS_BROWSER) {
10
+ await BarretenbergSync.initSingleton();
11
+ const api = BarretenbergSync.getSingleton();
12
+ const response = api.poseidon2Hash({
13
+ inputs: inputFields.map(i => i.toBuffer()),
14
+ });
15
+ return Fr.fromBuffer(Buffer.from(response.hash));
16
+ } else {
17
+ await Barretenberg.initSingleton();
18
+ const api = Barretenberg.getSingleton();
19
+ const response = await api.poseidon2Hash({
20
+ inputs: inputFields.map(i => i.toBuffer()),
21
+ });
22
+ return Fr.fromBuffer(Buffer.from(response.hash));
23
+ }
24
+ }
25
+
6
26
  /**
7
27
  * Create a poseidon hash (field) from an array of input fields.
8
28
  * @param input - The input fields to hash.
9
29
  * @returns The poseidon hash.
10
30
  */
11
- export async function poseidon2Hash(input: Fieldable[]): Promise<Fr> {
12
- const inputFields = serializeToFields(input);
13
- await Barretenberg.initSingleton();
14
- const api = Barretenberg.getSingleton();
15
- const response = await api.poseidon2Hash({
16
- inputs: inputFields.map(i => i.toBuffer()),
17
- });
18
- return Fr.fromBuffer(Buffer.from(response.hash));
31
+ export function poseidon2Hash(input: Fieldable[]): Promise<Fr> {
32
+ return poseidon2HashFields(serializeToFields(input));
19
33
  }
20
34
 
21
35
  /**
@@ -24,15 +38,10 @@ export async function poseidon2Hash(input: Fieldable[]): Promise<Fr> {
24
38
  * @param separator - The domain separator.
25
39
  * @returns The poseidon hash.
26
40
  */
27
- export async function poseidon2HashWithSeparator(input: Fieldable[], separator: number): Promise<Fr> {
41
+ export function poseidon2HashWithSeparator(input: Fieldable[], separator: number): Promise<Fr> {
28
42
  const inputFields = serializeToFields(input);
29
43
  inputFields.unshift(new Fr(separator));
30
- await Barretenberg.initSingleton();
31
- const api = Barretenberg.getSingleton();
32
- const response = await api.poseidon2Hash({
33
- inputs: inputFields.map(i => i.toBuffer()),
34
- });
35
- return Fr.fromBuffer(Buffer.from(response.hash));
44
+ return poseidon2HashFields(inputFields);
36
45
  }
37
46
 
38
47
  /**
@@ -42,19 +51,24 @@ export async function poseidon2HashWithSeparator(input: Fieldable[], separator:
42
51
  */
43
52
  export async function poseidon2Permutation(input: Fieldable[]): Promise<Fr[]> {
44
53
  const inputFields = serializeToFields(input);
45
- // We'd like this assertion but it's not possible to use it in the browser.
46
- // assert(input.length === 4, 'Input state must be of size 4');
47
- await Barretenberg.initSingleton();
48
- const api = Barretenberg.getSingleton();
49
- const response = await api.poseidon2Permutation({
50
- inputs: inputFields.map(i => i.toBuffer()),
51
- });
52
- // We'd like this assertion but it's not possible to use it in the browser.
53
- // assert(response.outputs.length === 4, 'Output state must be of size 4');
54
- return response.outputs.map(o => Fr.fromBuffer(Buffer.from(o)));
54
+ if (IS_BROWSER) {
55
+ await BarretenbergSync.initSingleton();
56
+ const api = BarretenbergSync.getSingleton();
57
+ const response = api.poseidon2Permutation({
58
+ inputs: inputFields.map(i => i.toBuffer()),
59
+ });
60
+ return response.outputs.map(o => Fr.fromBuffer(Buffer.from(o)));
61
+ } else {
62
+ await Barretenberg.initSingleton();
63
+ const api = Barretenberg.getSingleton();
64
+ const response = await api.poseidon2Permutation({
65
+ inputs: inputFields.map(i => i.toBuffer()),
66
+ });
67
+ return response.outputs.map(o => Fr.fromBuffer(Buffer.from(o)));
68
+ }
55
69
  }
56
70
 
57
- export async function poseidon2HashBytes(input: Buffer): Promise<Fr> {
71
+ export function poseidon2HashBytes(input: Buffer): Promise<Fr> {
58
72
  const inputFields = [];
59
73
  for (let i = 0; i < input.length; i += 31) {
60
74
  const fieldBytes = Buffer.alloc(32, 0);
@@ -65,11 +79,5 @@ export async function poseidon2HashBytes(input: Buffer): Promise<Fr> {
65
79
  inputFields.push(Fr.fromBuffer(fieldBytes));
66
80
  }
67
81
 
68
- await Barretenberg.initSingleton();
69
- const api = Barretenberg.getSingleton();
70
- const response = await api.poseidon2Hash({
71
- inputs: inputFields.map(i => i.toBuffer()),
72
- });
73
-
74
- return Fr.fromBuffer(Buffer.from(response.hash));
82
+ return poseidon2HashFields(inputFields);
75
83
  }
@@ -6,7 +6,6 @@ import { toBigIntBE, toBufferBE } from '../../bigint-buffer/index.js';
6
6
  import { randomBytes } from '../../crypto/random/index.js';
7
7
  import { hexSchemaFor } from '../../schemas/utils.js';
8
8
  import { BufferReader } from '../../serialize/buffer_reader.js';
9
- import { TypeRegistry } from '../../serialize/type_registry.js';
10
9
  import { Fr } from '../bn254/field.js';
11
10
 
12
11
  /**
@@ -323,9 +322,6 @@ export class BLS12Fr extends BLS12Field {
323
322
  }
324
323
  }
325
324
 
326
- // For deserializing JSON.
327
- TypeRegistry.register('BLS12Fr', BLS12Fr);
328
-
329
325
  /**
330
326
  * Fq field class.
331
327
  * @dev This class is used to represent elements of BLS12-381 base field.
@@ -458,6 +454,3 @@ export class BLS12Fq extends BLS12Field {
458
454
  return hexSchemaFor(BLS12Fq);
459
455
  }
460
456
  }
461
-
462
- // For deserializing JSON.
463
- TypeRegistry.register('BLS12Fq', BLS12Fq);
@@ -6,9 +6,6 @@ import { toBigIntBE, toBufferBE } from '../../bigint-buffer/index.js';
6
6
  import { randomBytes } from '../../crypto/random/index.js';
7
7
  import { hexSchemaFor } from '../../schemas/utils.js';
8
8
  import { BufferReader } from '../../serialize/buffer_reader.js';
9
- import { TypeRegistry } from '../../serialize/type_registry.js';
10
-
11
- /* eslint-disable @typescript-eslint/no-unsafe-declaration-merging */
12
9
 
13
10
  /**
14
11
  * Represents a field derived from BaseField.
@@ -187,10 +184,25 @@ function fromHexString<T extends BaseField>(buf: string, f: DerivedField<T>) {
187
184
  return new f(toBigIntBE(buffer));
188
185
  }
189
186
 
190
- /** Branding to ensure fields are not interchangeable types. */
191
- export interface Fr {
192
- /** Brand. */
193
- _branding: 'Fr';
187
+ /**
188
+ * Abstract unbranded base class for BN254 scalar field elements.
189
+ * Extend this instead of Fr when defining a branded subtype (e.g. BlockHash)
190
+ * to avoid inheriting Fr's `_branding`.
191
+ */
192
+ export abstract class BaseFr extends BaseField {
193
+ static MODULUS = 0x30644e72e131a029b85045b68181585d2833e84879b9709143e1f593f0000001n;
194
+
195
+ constructor(value: number | bigint | boolean | BaseField | Buffer) {
196
+ super(value);
197
+ }
198
+
199
+ protected modulus() {
200
+ return BaseFr.MODULUS;
201
+ }
202
+
203
+ toJSON() {
204
+ return this.toString();
205
+ }
194
206
  }
195
207
 
196
208
  /**
@@ -198,10 +210,12 @@ export interface Fr {
198
210
  * @dev This class is used to represent elements of BN254 scalar field or elements in the base field of Grumpkin.
199
211
  * (Grumpkin's scalar field corresponds to BN254's base field and vice versa.)
200
212
  */
201
- export class Fr extends BaseField {
213
+ export class Fr extends BaseFr {
214
+ /** Branding for nominal typing. */
215
+ declare private readonly _branding: 'Fr';
216
+ static override MODULUS = 0x30644e72e131a029b85045b68181585d2833e84879b9709143e1f593f0000001n;
202
217
  static ZERO = new Fr(0n);
203
218
  static ONE = new Fr(1n);
204
- static MODULUS = 0x30644e72e131a029b85045b68181585d2833e84879b9709143e1f593f0000001n;
205
219
  static MAX_FIELD_VALUE = new Fr(this.MODULUS - 1n);
206
220
 
207
221
  constructor(value: number | bigint | boolean | Fr | Buffer) {
@@ -212,10 +226,6 @@ export class Fr extends BaseField {
212
226
  return `Fr<${this.toString()}>`;
213
227
  }
214
228
 
215
- protected modulus() {
216
- return Fr.MODULUS;
217
- }
218
-
219
229
  static random() {
220
230
  return random(Fr);
221
231
  }
@@ -320,10 +330,6 @@ export class Fr extends BaseField {
320
330
  return Fr.fromBuffer(Buffer.from(response.value));
321
331
  }
322
332
 
323
- toJSON() {
324
- return this.toString();
325
- }
326
-
327
333
  /**
328
334
  * Creates an Fr instance from a plain object without Zod validation.
329
335
  * This method is optimized for performance and skips validation, making it suitable
@@ -345,23 +351,14 @@ export class Fr extends BaseField {
345
351
  }
346
352
  }
347
353
 
348
- // For deserializing JSON.
349
- TypeRegistry.register('Fr', Fr);
350
-
351
- /**
352
- * Branding to ensure fields are not interchangeable types.
353
- */
354
- export interface Fq {
355
- /** Brand. */
356
- _branding: 'Fq';
357
- }
358
-
359
354
  /**
360
355
  * Fq field class.
361
356
  * @dev This class is used to represent elements of BN254 base field or elements in the scalar field of Grumpkin.
362
357
  * (Grumpkin's scalar field corresponds to BN254's base field and vice versa.)
363
358
  */
364
359
  export class Fq extends BaseField {
360
+ /** Branding for nominal typing. */
361
+ declare private readonly _branding: 'Fq';
365
362
  static ZERO = new Fq(0n);
366
363
  static MODULUS = 0x30644e72e131a029b85045b68181585d97816a916871ca8d3c208c16d87cfd47n;
367
364
  private static HIGH_SHIFT = BigInt((BaseField.SIZE_IN_BYTES / 2) * 8);
@@ -470,9 +467,6 @@ export class Fq extends BaseField {
470
467
  }
471
468
  }
472
469
 
473
- // For deserializing JSON.
474
- TypeRegistry.register('Fq', Fq);
475
-
476
470
  // Beware: Performance bottleneck below
477
471
 
478
472
  /**
@@ -65,7 +65,7 @@ export class Point {
65
65
  }
66
66
 
67
67
  /**
68
- * Generate a random Point instance.
68
+ * Generate a random Point instance that is on the curve.
69
69
  *
70
70
  * @returns A randomly generated Point instance.
71
71
  */
@@ -125,9 +125,12 @@ export class Point {
125
125
  }
126
126
 
127
127
  /**
128
- * Returns the contents of the point as an array of 2 fields.
129
- * @returns The point as an array of 2 fields
128
+ * Returns the contents of the point as an array of 3 fields.
129
+ * @returns The point as an array of 3 fields
130
130
  */
131
+ // TODO(F-553): Once we take the breaking change and drop the custom Noir `Point` wrapper in
132
+ // `noir-projects/noir-protocol-circuits/crates/types/src/point.nr`, revert this to serialize as `[x, y]` (2 fields)
133
+ // and drop the `is_infinite` flag from `fromFields` / `toNoirStruct` below.
131
134
  toFields() {
132
135
  return [this.x, this.y, new Fr(this.isInfinite)];
133
136
  }
@@ -5,7 +5,6 @@ import { randomBytes } from '../crypto/random/index.js';
5
5
  import { Fr } from '../curves/bn254/index.js';
6
6
  import { hexSchemaFor } from '../schemas/utils.js';
7
7
  import { BufferReader, FieldReader } from '../serialize/index.js';
8
- import { TypeRegistry } from '../serialize/type_registry.js';
9
8
  import { bufferToHex } from '../string/index.js';
10
9
 
11
10
  /**
@@ -268,6 +267,3 @@ export class EthAddress {
268
267
  return addrA.equals(addrB);
269
268
  }
270
269
  }
271
-
272
- // For deserializing JSON.
273
- TypeRegistry.register('EthAddress', EthAddress);
@@ -0,0 +1,98 @@
1
+ import EventEmitter from 'node:events';
2
+ import * as fs from 'node:fs';
3
+ import type { Readable } from 'node:stream';
4
+
5
+ /**
6
+ * Events emitted by FifoFrameReader.
7
+ *
8
+ * - `frame`: A complete frame payload (without the 4-byte length header).
9
+ * - `error`: An unrecoverable error (invalid frame length, stream error).
10
+ * - `end`: The underlying stream has ended.
11
+ */
12
+ export interface FifoFrameReaderEvents {
13
+ frame: [payload: Buffer];
14
+ error: [error: Error];
15
+ end: [];
16
+ }
17
+
18
+ /**
19
+ * Reads length-delimited frames from a readable stream (typically a named FIFO pipe).
20
+ *
21
+ * Wire format: `[4-byte big-endian payload length][payload bytes]`
22
+ *
23
+ * Emits a `frame` event for each complete frame with the raw payload buffer.
24
+ * Callers are responsible for deserializing the payload (e.g., via msgpack).
25
+ *
26
+ * On encountering an invalid payload length (0 or >maxPayloadSize), emits `error`
27
+ * and destroys the stream.
28
+ */
29
+ export class FifoFrameReader extends EventEmitter<FifoFrameReaderEvents> {
30
+ private stream: Readable | null = null;
31
+ private pendingBuf: Buffer = Buffer.alloc(0);
32
+ private running = false;
33
+
34
+ constructor(private readonly maxPayloadSize = 10 * 1024 * 1024) {
35
+ super();
36
+ }
37
+
38
+ /** Open a FIFO at the given path and start reading frames. */
39
+ start(fifoPath: string, highWaterMark = 64 * 1024): void {
40
+ this.startFromStream(fs.createReadStream(fifoPath, { highWaterMark }));
41
+ }
42
+
43
+ /** Start reading frames from an existing readable stream. */
44
+ startFromStream(stream: Readable): void {
45
+ if (this.running) {
46
+ throw new Error('FifoFrameReader is already running');
47
+ }
48
+ this.running = true;
49
+ this.pendingBuf = Buffer.alloc(0);
50
+ this.stream = stream;
51
+
52
+ stream.on('data', (chunk: Buffer | string) => {
53
+ const buf = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
54
+ this.pendingBuf = this.pendingBuf.length > 0 ? Buffer.concat([this.pendingBuf, buf]) : buf;
55
+ this.drainFrames();
56
+ });
57
+
58
+ stream.on('error', (err: Error) => {
59
+ if (this.running) {
60
+ this.emit('error', err);
61
+ }
62
+ });
63
+
64
+ stream.on('end', () => {
65
+ this.emit('end');
66
+ });
67
+ }
68
+
69
+ /** Stop reading and destroy the underlying stream. */
70
+ stop(): void {
71
+ this.running = false;
72
+ if (this.stream) {
73
+ this.stream.destroy();
74
+ this.stream = null;
75
+ }
76
+ }
77
+
78
+ /** Parse complete frames out of the pending buffer. */
79
+ private drainFrames(): void {
80
+ while (this.pendingBuf.length >= 4) {
81
+ const payloadLen = this.pendingBuf.readUInt32BE(0);
82
+ if (payloadLen === 0 || payloadLen > this.maxPayloadSize) {
83
+ this.emit('error', new Error(`Invalid payload length: ${payloadLen}`));
84
+ this.stop();
85
+ return;
86
+ }
87
+
88
+ const frameLen = 4 + payloadLen;
89
+ if (this.pendingBuf.length < frameLen) {
90
+ break; // Wait for more data
91
+ }
92
+
93
+ const payload = this.pendingBuf.subarray(4, frameLen);
94
+ this.pendingBuf = this.pendingBuf.subarray(frameLen);
95
+ this.emit('frame', Buffer.from(payload));
96
+ }
97
+ }
98
+ }
@@ -0,0 +1 @@
1
+ export { FifoFrameReader } from './fifo_frame_reader.js';
@@ -10,3 +10,30 @@ import pretty from 'pino-pretty';
10
10
  if (!parseBooleanEnv(process.env.LOG_JSON)) {
11
11
  overwriteLoggingStream(pretty(pinoPrettyOpts));
12
12
  }
13
+
14
+ // Prevent timers from keeping the process alive after tests complete.
15
+ // Libraries like viem create internal polling loops (via setTimeout) that
16
+ // reschedule themselves indefinitely. In test environments we never want a
17
+ // timer to be the reason the process can't exit. We also unref stdout/stderr
18
+ // which, when they are pipes (as in Jest workers), remain ref'd by default.
19
+ {
20
+ const origSetTimeout = globalThis.setTimeout;
21
+ const origSetInterval = globalThis.setInterval;
22
+ globalThis.setTimeout = function unrefSetTimeout(...args) {
23
+ const id = origSetTimeout.apply(this, args);
24
+ id?.unref?.();
25
+ return id;
26
+ };
27
+ // Preserve .unref, .__promisify__ etc. that may exist on the original
28
+ Object.setPrototypeOf(globalThis.setTimeout, origSetTimeout);
29
+
30
+ globalThis.setInterval = function unrefSetInterval(...args) {
31
+ const id = origSetInterval.apply(this, args);
32
+ id?.unref?.();
33
+ return id;
34
+ };
35
+ Object.setPrototypeOf(globalThis.setInterval, origSetInterval);
36
+
37
+ if (process.stdout?._handle?.unref) process.stdout._handle.unref();
38
+ if (process.stderr?._handle?.unref) process.stderr._handle.unref();
39
+ }
@@ -43,17 +43,18 @@ export async function defaultFetch(
43
43
  }
44
44
 
45
45
  let responseJson;
46
+ const responseText = await resp.text();
46
47
  try {
47
- responseJson = await resp.json();
48
+ responseJson = JSON.parse(responseText);
48
49
  } catch {
49
50
  if (!resp.ok) {
50
51
  throw new Error(resp.statusText);
51
52
  }
52
- throw new Error(`Failed to parse body as JSON: ${await resp.text()}`);
53
+ throw new Error(`Failed to parse body as JSON: ${responseText}`);
53
54
  }
54
55
 
55
56
  if (!resp.ok) {
56
- const errorMessage = `Error ${resp.status} from server ${host}: ${responseJson.error.message}`;
57
+ const errorMessage = `Error ${resp.status} from server ${host}: ${responseJson?.error?.message ?? JSON.stringify(responseJson)}`;
57
58
  if (noRetry || (resp.status >= 400 && resp.status < 500)) {
58
59
  throw new NoRetryError(errorMessage);
59
60
  } else {
@@ -44,18 +44,20 @@ export function makeUndiciFetch(client = new Agent()): JsonRpcFetch {
44
44
  let responseJson: any;
45
45
  const responseOk = resp.statusCode >= 200 && resp.statusCode <= 299;
46
46
  const contentEncoding = resp.headers['content-encoding'];
47
+ let responseText: string;
47
48
  try {
48
49
  if (contentEncoding === 'gzip') {
49
50
  const jsonBuffer = await gunzip(await resp.body.arrayBuffer());
50
- responseJson = JSON.parse(jsonBuffer.toString('utf-8'));
51
+ responseText = jsonBuffer.toString('utf-8');
51
52
  } else {
52
- responseJson = await resp.body.json();
53
+ responseText = await resp.body.text();
53
54
  }
55
+ responseJson = JSON.parse(responseText);
54
56
  } catch {
55
57
  if (!responseOk) {
56
58
  throw new Error('HTTP ' + resp.statusCode);
57
59
  }
58
- throw new Error(`Failed to parse body as JSON. encoding: ${contentEncoding}, body: ${await resp.body.text()}`);
60
+ throw new Error(`Failed to parse body as JSON. encoding: ${contentEncoding}, body: ${responseText!}`);
59
61
  }
60
62
 
61
63
  if (!responseOk) {
@@ -21,6 +21,8 @@ export type LoggerBindings = {
21
21
  instanceId?: string;
22
22
  };
23
23
 
24
+ const MAX_MODULE_NAME_LENGTH = 256;
25
+
24
26
  // Allow global hooks for providing default bindings.
25
27
  // Used by withLoggerBindings in pino-logger-server to propagate bindings via AsyncLocalStorage.
26
28
  type LogBindingsHandler = () => LoggerBindings | undefined;
@@ -48,7 +50,7 @@ function getBindingsFromHandlers(): LoggerBindings | undefined {
48
50
  }
49
51
 
50
52
  export function createLogger(module: string, bindings?: LoggerBindings): Logger {
51
- module = module.replace(/^aztec:/, '');
53
+ module = module.slice(0, MAX_MODULE_NAME_LENGTH).replace(/^aztec:/, '');
52
54
 
53
55
  const resolvedBindings = { ...getBindingsFromHandlers(), ...bindings };
54
56
  const actor = resolvedBindings?.actor;
@@ -375,5 +377,20 @@ export type Logger = { [K in LogLevel]: LogFn } & { /** Error log function */ er
375
377
  * @returns A string with both the log message and the error message.
376
378
  */
377
379
  function formatErr(msg: string, err?: unknown): string {
378
- return err ? `${msg}: ${inspect(err)}` : msg;
380
+ if (!err) {
381
+ return msg;
382
+ }
383
+
384
+ try {
385
+ return `${msg}: ${inspect(err)}`;
386
+ } catch {
387
+ // inspect can crash on error objects with broken property descriptors
388
+ try {
389
+ // eslint-disable-next-line @typescript-eslint/no-base-to-string
390
+ return `${msg}: ${err instanceof Error ? `${err.name}: ${err.message}` : String(err)}`;
391
+ } catch {
392
+ // if even String(err) fails, return the original message with a note about the error
393
+ return `${msg}: [unserializable error]`;
394
+ }
395
+ }
379
396
  }
@@ -105,6 +105,7 @@ export class BatchQueue<T, K extends string | number> {
105
105
  return Promise.resolve();
106
106
  }
107
107
 
108
+ this.flushCurrentBatch();
108
109
  this.container.end();
109
110
  return runningPromise;
110
111
  }
@@ -104,6 +104,36 @@ export async function retryUntil<T>(
104
104
  }
105
105
  }
106
106
 
107
+ /**
108
+ * Retry an asynchronous function until it returns a truthy value or the maximum number of retries is exceeded.
109
+ * The function is retried periodically with a fixed interval between attempts.
110
+ *
111
+ * @param fn - The asynchronous function to be retried, which should return a truthy value upon success or undefined otherwise.
112
+ * @param name - The optional name of the operation, used for generating error messages.
113
+ * @param maxRetries - The maximum number of retry attempts before throwing an error.
114
+ * @param retryInterval - The optional interval, in seconds, between retry attempts. Defaults to 1 second.
115
+ * @returns A Promise that resolves with the successful (truthy) result of the provided function, or rejects if retries are exhausted.
116
+ */
117
+ export async function retryTimes<T>(
118
+ fn: () => (T | undefined) | Promise<T | undefined>,
119
+ name = '',
120
+ maxRetries: number,
121
+ retryInterval = 1,
122
+ ) {
123
+ for (let attempt = 0; attempt <= maxRetries; attempt++) {
124
+ const result = await fn();
125
+ if (result) {
126
+ return result;
127
+ }
128
+
129
+ if (attempt < maxRetries) {
130
+ await sleep(retryInterval * 1000);
131
+ }
132
+ }
133
+
134
+ throw new Error(name ? `Retries exhausted awaiting ${name}` : 'Retries exhausted');
135
+ }
136
+
107
137
  /**
108
138
  * Convenience wrapper around retryUntil with fast polling for tests.
109
139
  * Uses 10s timeout and 100ms polling interval by default.
@@ -37,7 +37,10 @@ export type ApiSchema = {
37
37
  };
38
38
 
39
39
  /** Return whether an API schema defines a valid function schema for a given method name. */
40
- export function schemaHasMethod(schema: ApiSchema, methodName: string) {
40
+ export function schemaHasMethod<T extends ApiSchema>(
41
+ schema: T,
42
+ methodName: string,
43
+ ): methodName is Extract<keyof T, string> {
41
44
  return (
42
45
  typeof methodName === 'string' &&
43
46
  Object.hasOwn(schema, methodName) &&
@@ -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
 
@@ -58,7 +58,7 @@ export function urlJoin(...args: string[]): string {
58
58
  end--;
59
59
  }
60
60
 
61
- if (start < end) {
61
+ if (start <= end) {
62
62
  processed.push(arg.slice(start, end + 1));
63
63
  }
64
64
  }
package/src/timer/date.ts CHANGED
@@ -32,6 +32,12 @@ export class TestDateProvider extends DateProvider {
32
32
  this.logger.warn(`Time set to ${new Date(timeMs).toISOString()}`, { offset: this.offset, timeMs });
33
33
  }
34
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
+
35
41
  /** Advances the time by the given number of seconds. */
36
42
  public advanceTime(seconds: number) {
37
43
  this.offset += seconds * 1000;
@@ -2,7 +2,17 @@ import { EventEmitter } from 'events';
2
2
 
3
3
  import { type TransferDescriptor, isTransferDescriptor } from '../interface/transferable.js';
4
4
  import type { TransportClient } from '../transport_client.js';
5
- import type { DispatchMsg } from './create_dispatch_fn.js';
5
+
6
+ /**
7
+ * Represents a message object for dispatching function calls.
8
+ * Contains the function name ('fn') and an array of arguments ('args') required to call the target method.
9
+ */
10
+ export interface DispatchMsg {
11
+ /** Name of the target method to be called. */
12
+ fn: string;
13
+ /** An array of arguments to be passed to the target method. */
14
+ args: any[];
15
+ }
6
16
 
7
17
  /**
8
18
  * FilterOutAttributes type filters out all non-method properties of an object, leaving only the attributes
@@ -1,4 +1,3 @@
1
- export * from './dispatch/create_dispatch_fn.js';
2
1
  export * from './dispatch/create_dispatch_proxy.js';
3
2
  export * from './dispatch/messages.js';
4
3
  export * from './interface/connector.js';
@@ -1,10 +1,7 @@
1
- import { poseidonMerkleHash, shaMerkleHash } from './hasher.js';
1
+ import { shaMerkleHash } from './hasher.js';
2
2
 
3
3
  export const computeBalancedShaRoot = (leaves: Buffer[]) => computeBalancedMerkleTreeRoot(leaves);
4
4
 
5
- export const computeBalancedPoseidonRoot = async (leaves: Buffer[]) =>
6
- await computeBalancedMerkleTreeRootAsync(leaves, poseidonMerkleHash);
7
-
8
5
  /**
9
6
  * Computes the Merkle root with the provided leaves **synchronously**.
10
7
  * This method uses a synchronous hash function (defaults to `sha256Trunc`).
@@ -36,7 +33,7 @@ export function computeBalancedMerkleTreeRoot(leaves: Buffer[], hasher = shaMerk
36
33
  */
37
34
  export async function computeBalancedMerkleTreeRootAsync(
38
35
  leaves: Buffer[],
39
- hasher = poseidonMerkleHash,
36
+ hasher: (left: Buffer, right: Buffer) => Promise<Buffer<ArrayBuffer>>,
40
37
  ): Promise<Buffer> {
41
38
  const height = getTreeHeight(leaves);
42
39
  let nodes = leaves.slice();