@aztec/foundation 0.0.1-commit.b6e433891 → 0.0.1-commit.b8a057fa

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 (258) hide show
  1. package/dest/bigint-buffer/index.d.ts +1 -1
  2. package/dest/bigint-buffer/index.d.ts.map +1 -1
  3. package/dest/bigint-buffer/index.js +6 -1
  4. package/dest/branded-types/block_number.d.ts +3 -3
  5. package/dest/branded-types/block_number.d.ts.map +1 -1
  6. package/dest/branded-types/block_number.js +15 -4
  7. package/dest/branded-types/buffer32_hash.d.ts +27 -0
  8. package/dest/branded-types/buffer32_hash.d.ts.map +1 -0
  9. package/dest/branded-types/buffer32_hash.js +12 -0
  10. package/dest/branded-types/checkpoint_number.d.ts +9 -3
  11. package/dest/branded-types/checkpoint_number.d.ts.map +1 -1
  12. package/dest/branded-types/checkpoint_number.js +11 -0
  13. package/dest/branded-types/epoch.d.ts +2 -2
  14. package/dest/branded-types/epoch.d.ts.map +1 -1
  15. package/dest/branded-types/index.d.ts +2 -1
  16. package/dest/branded-types/index.d.ts.map +1 -1
  17. package/dest/branded-types/index.js +1 -0
  18. package/dest/branded-types/index_within_checkpoint.d.ts +2 -2
  19. package/dest/branded-types/index_within_checkpoint.d.ts.map +1 -1
  20. package/dest/branded-types/slot.d.ts +5 -2
  21. package/dest/branded-types/slot.d.ts.map +1 -1
  22. package/dest/branded-types/slot.js +3 -0
  23. package/dest/buffer/buffer16.d.ts +3 -1
  24. package/dest/buffer/buffer16.d.ts.map +1 -1
  25. package/dest/buffer/buffer32.d.ts +28 -61
  26. package/dest/buffer/buffer32.d.ts.map +1 -1
  27. package/dest/buffer/buffer32.js +29 -63
  28. package/dest/collection/array.d.ts +11 -1
  29. package/dest/collection/array.d.ts.map +1 -1
  30. package/dest/collection/array.js +33 -0
  31. package/dest/collection/index.d.ts +3 -1
  32. package/dest/collection/index.d.ts.map +1 -1
  33. package/dest/collection/index.js +2 -0
  34. package/dest/collection/lru_map.d.ts +41 -0
  35. package/dest/collection/lru_map.d.ts.map +1 -0
  36. package/dest/collection/lru_map.js +119 -0
  37. package/dest/collection/lru_set.d.ts +35 -0
  38. package/dest/collection/lru_set.d.ts.map +1 -0
  39. package/dest/collection/lru_set.js +95 -0
  40. package/dest/committable/committable.js +1 -1
  41. package/dest/config/env_var.d.ts +2 -2
  42. package/dest/config/env_var.d.ts.map +1 -1
  43. package/dest/config/index.d.ts +67 -37
  44. package/dest/config/index.d.ts.map +1 -1
  45. package/dest/config/index.js +72 -71
  46. package/dest/config/network_config.d.ts +11 -55
  47. package/dest/config/network_config.d.ts.map +1 -1
  48. package/dest/config/network_name.d.ts +2 -2
  49. package/dest/config/network_name.d.ts.map +1 -1
  50. package/dest/config/network_name.js +1 -3
  51. package/dest/config/secret_value.d.ts +2 -2
  52. package/dest/config/secret_value.d.ts.map +1 -1
  53. package/dest/crypto/aes128/index.d.ts +2 -1
  54. package/dest/crypto/aes128/index.d.ts.map +1 -1
  55. package/dest/crypto/aes128/index.js +11 -2
  56. package/dest/crypto/bls/bn254_keystore.d.ts +10 -177
  57. package/dest/crypto/bls/bn254_keystore.d.ts.map +1 -1
  58. package/dest/crypto/bls/bn254_keystore.js +22 -34
  59. package/dest/crypto/keys/index.d.ts +3 -2
  60. package/dest/crypto/keys/index.d.ts.map +1 -1
  61. package/dest/crypto/keys/index.js +30 -6
  62. package/dest/crypto/poseidon/index.d.ts +1 -1
  63. package/dest/crypto/poseidon/index.d.ts.map +1 -1
  64. package/dest/crypto/poseidon/index.js +40 -33
  65. package/dest/crypto/schnorr/index.d.ts +8 -7
  66. package/dest/crypto/schnorr/index.d.ts.map +1 -1
  67. package/dest/crypto/schnorr/index.js +6 -6
  68. package/dest/crypto/schnorr/signature.d.ts +9 -29
  69. package/dest/crypto/schnorr/signature.d.ts.map +1 -1
  70. package/dest/crypto/schnorr/signature.js +20 -36
  71. package/dest/curves/bls12/field.d.ts +3 -3
  72. package/dest/curves/bls12/field.d.ts.map +1 -1
  73. package/dest/curves/bls12/field.js +0 -5
  74. package/dest/curves/bls12/point.d.ts +2 -2
  75. package/dest/curves/bls12/point.d.ts.map +1 -1
  76. package/dest/curves/bn254/field.d.ts +23 -19
  77. package/dest/curves/bn254/field.d.ts.map +1 -1
  78. package/dest/curves/bn254/field.js +23 -17
  79. package/dest/curves/grumpkin/point.d.ts +14 -28
  80. package/dest/curves/grumpkin/point.d.ts.map +1 -1
  81. package/dest/curves/grumpkin/point.js +29 -43
  82. package/dest/eth-address/index.d.ts +2 -2
  83. package/dest/eth-address/index.d.ts.map +1 -1
  84. package/dest/eth-address/index.js +0 -3
  85. package/dest/eth-signature/eth_signature.d.ts +2 -2
  86. package/dest/eth-signature/eth_signature.d.ts.map +1 -1
  87. package/dest/fifo/fifo_frame_reader.d.ts +41 -0
  88. package/dest/fifo/fifo_frame_reader.d.ts.map +1 -0
  89. package/dest/fifo/fifo_frame_reader.js +91 -0
  90. package/dest/fifo/index.d.ts +2 -0
  91. package/dest/fifo/index.d.ts.map +1 -0
  92. package/dest/fifo/index.js +1 -0
  93. package/dest/fifo_set/fifo_set.d.ts +15 -0
  94. package/dest/fifo_set/fifo_set.d.ts.map +1 -0
  95. package/dest/fifo_set/fifo_set.js +39 -0
  96. package/dest/fifo_set/index.d.ts +2 -0
  97. package/dest/fifo_set/index.d.ts.map +1 -0
  98. package/dest/fifo_set/index.js +1 -0
  99. package/dest/json-rpc/client/fetch.d.ts +1 -1
  100. package/dest/json-rpc/client/fetch.d.ts.map +1 -1
  101. package/dest/json-rpc/client/fetch.js +4 -3
  102. package/dest/json-rpc/client/safe_json_rpc_client.d.ts +1 -1
  103. package/dest/json-rpc/client/safe_json_rpc_client.d.ts.map +1 -1
  104. package/dest/json-rpc/client/safe_json_rpc_client.js +2 -2
  105. package/dest/json-rpc/client/undici.d.ts +1 -1
  106. package/dest/json-rpc/client/undici.d.ts.map +1 -1
  107. package/dest/json-rpc/client/undici.js +5 -3
  108. package/dest/json-rpc/fixtures/test_state.d.ts +4 -8
  109. package/dest/json-rpc/fixtures/test_state.d.ts.map +1 -1
  110. package/dest/json-rpc/fixtures/test_state.js +57 -17
  111. package/dest/json-rpc/server/safe_json_rpc_server.d.ts +8 -3
  112. package/dest/json-rpc/server/safe_json_rpc_server.d.ts.map +1 -1
  113. package/dest/json-rpc/server/safe_json_rpc_server.js +27 -13
  114. package/dest/log/pino-logger.d.ts +1 -1
  115. package/dest/log/pino-logger.d.ts.map +1 -1
  116. package/dest/log/pino-logger.js +17 -2
  117. package/dest/noir/noir_package_config.d.ts +19 -104
  118. package/dest/noir/noir_package_config.d.ts.map +1 -1
  119. package/dest/noir/noir_package_config.js +1 -1
  120. package/dest/promise/running-promise.d.ts +5 -4
  121. package/dest/promise/running-promise.d.ts.map +1 -1
  122. package/dest/promise/running-promise.js +7 -3
  123. package/dest/queue/batch_queue.d.ts +1 -1
  124. package/dest/queue/batch_queue.d.ts.map +1 -1
  125. package/dest/queue/batch_queue.js +1 -0
  126. package/dest/retry/index.d.ts +31 -3
  127. package/dest/retry/index.d.ts.map +1 -1
  128. package/dest/retry/index.js +44 -2
  129. package/dest/schemas/api.d.ts +12 -10
  130. package/dest/schemas/api.d.ts.map +1 -1
  131. package/dest/schemas/api.js +7 -1
  132. package/dest/schemas/parse.d.ts +4 -4
  133. package/dest/schemas/parse.d.ts.map +1 -1
  134. package/dest/schemas/parse.js +6 -5
  135. package/dest/schemas/schemas.d.ts +15 -15
  136. package/dest/schemas/types.d.ts +3 -3
  137. package/dest/schemas/types.d.ts.map +1 -1
  138. package/dest/schemas/utils.d.ts +7 -11
  139. package/dest/schemas/utils.d.ts.map +1 -1
  140. package/dest/schemas/utils.js +2 -18
  141. package/dest/serialize/buffer_sink.d.ts +134 -0
  142. package/dest/serialize/buffer_sink.d.ts.map +1 -0
  143. package/dest/serialize/buffer_sink.js +297 -0
  144. package/dest/serialize/index.d.ts +2 -1
  145. package/dest/serialize/index.d.ts.map +1 -1
  146. package/dest/serialize/index.js +1 -0
  147. package/dest/string/index.js +1 -1
  148. package/dest/testing/files/index.d.ts +2 -3
  149. package/dest/testing/files/index.d.ts.map +1 -1
  150. package/dest/testing/files/index.js +1 -2
  151. package/dest/timer/index.d.ts +2 -2
  152. package/dest/timer/index.d.ts.map +1 -1
  153. package/dest/timer/index.js +1 -1
  154. package/dest/timer/timeout.d.ts +3 -1
  155. package/dest/timer/timeout.d.ts.map +1 -1
  156. package/dest/timer/timeout.js +26 -0
  157. package/dest/transport/dispatch/create_dispatch_proxy.d.ts +11 -2
  158. package/dest/transport/dispatch/create_dispatch_proxy.d.ts.map +1 -1
  159. package/dest/transport/index.d.ts +1 -2
  160. package/dest/transport/index.d.ts.map +1 -1
  161. package/dest/transport/index.js +0 -1
  162. package/dest/trees/balanced_merkle_tree_root.d.ts +2 -3
  163. package/dest/trees/balanced_merkle_tree_root.d.ts.map +1 -1
  164. package/dest/trees/balanced_merkle_tree_root.js +2 -3
  165. package/dest/trees/hasher.d.ts +3 -2
  166. package/dest/trees/hasher.d.ts.map +1 -1
  167. package/dest/trees/hasher.js +5 -5
  168. package/dest/trees/indexed_merkle_tree_calculator.d.ts +1 -1
  169. package/dest/trees/indexed_merkle_tree_calculator.d.ts.map +1 -1
  170. package/dest/trees/indexed_merkle_tree_calculator.js +5 -1
  171. package/dest/trees/membership_witness.d.ts +2 -6
  172. package/dest/trees/membership_witness.d.ts.map +1 -1
  173. package/dest/trees/membership_witness.js +0 -9
  174. package/dest/trees/merkle_tree_calculator.d.ts +4 -2
  175. package/dest/trees/merkle_tree_calculator.d.ts.map +1 -1
  176. package/dest/trees/merkle_tree_calculator.js +1 -5
  177. package/dest/trees/sibling_path.d.ts +5 -4
  178. package/dest/trees/sibling_path.d.ts.map +1 -1
  179. package/dest/trees/sibling_path.js +10 -8
  180. package/dest/trees/unbalanced_merkle_tree_root.d.ts +2 -3
  181. package/dest/trees/unbalanced_merkle_tree_root.d.ts.map +1 -1
  182. package/dest/trees/unbalanced_merkle_tree_root.js +2 -3
  183. package/dest/types/index.d.ts +23 -1
  184. package/dest/types/index.d.ts.map +1 -1
  185. package/dest/types/index.js +15 -0
  186. package/package.json +6 -4
  187. package/src/bigint-buffer/index.ts +6 -1
  188. package/src/branded-types/block_number.ts +20 -2
  189. package/src/branded-types/buffer32_hash.ts +38 -0
  190. package/src/branded-types/checkpoint_number.ts +16 -1
  191. package/src/branded-types/epoch.ts +1 -1
  192. package/src/branded-types/index.ts +1 -0
  193. package/src/branded-types/index_within_checkpoint.ts +1 -1
  194. package/src/branded-types/slot.ts +6 -1
  195. package/src/buffer/buffer16.ts +3 -0
  196. package/src/buffer/buffer32.ts +39 -68
  197. package/src/collection/array.ts +34 -0
  198. package/src/collection/index.ts +2 -0
  199. package/src/collection/lru_map.ts +143 -0
  200. package/src/collection/lru_set.ts +115 -0
  201. package/src/committable/committable.ts +1 -1
  202. package/src/config/env_var.ts +48 -24
  203. package/src/config/index.ts +143 -122
  204. package/src/config/network_name.ts +2 -5
  205. package/src/config/secret_value.ts +1 -1
  206. package/src/crypto/aes128/index.ts +11 -2
  207. package/src/crypto/bls/bn254_keystore.ts +33 -43
  208. package/src/crypto/keys/index.ts +20 -4
  209. package/src/crypto/poseidon/index.ts +42 -34
  210. package/src/crypto/schnorr/index.ts +9 -8
  211. package/src/crypto/schnorr/signature.ts +17 -46
  212. package/src/curves/bls12/field.ts +0 -7
  213. package/src/curves/bn254/field.ts +35 -34
  214. package/src/curves/grumpkin/point.ts +23 -40
  215. package/src/eth-address/index.ts +0 -4
  216. package/src/fifo/fifo_frame_reader.ts +113 -0
  217. package/src/fifo/index.ts +1 -0
  218. package/src/fifo_set/fifo_set.ts +52 -0
  219. package/src/fifo_set/index.ts +1 -0
  220. package/src/json-rpc/client/fetch.ts +4 -3
  221. package/src/json-rpc/client/safe_json_rpc_client.ts +2 -2
  222. package/src/json-rpc/client/undici.ts +5 -3
  223. package/src/json-rpc/fixtures/test_state.ts +10 -10
  224. package/src/json-rpc/server/safe_json_rpc_server.ts +31 -13
  225. package/src/log/pino-logger.ts +19 -2
  226. package/src/noir/noir_package_config.ts +32 -20
  227. package/src/promise/running-promise.ts +8 -5
  228. package/src/queue/batch_queue.ts +1 -0
  229. package/src/retry/index.ts +66 -4
  230. package/src/schemas/api.ts +25 -25
  231. package/src/schemas/parse.ts +9 -6
  232. package/src/schemas/schemas.ts +4 -4
  233. package/src/schemas/types.ts +2 -2
  234. package/src/schemas/utils.ts +4 -38
  235. package/src/serialize/buffer_sink.ts +350 -0
  236. package/src/serialize/index.ts +1 -0
  237. package/src/string/index.ts +1 -1
  238. package/src/testing/files/index.ts +1 -2
  239. package/src/timer/index.ts +1 -1
  240. package/src/timer/timeout.ts +31 -0
  241. package/src/transport/dispatch/create_dispatch_proxy.ts +11 -1
  242. package/src/transport/index.ts +0 -1
  243. package/src/trees/balanced_merkle_tree_root.ts +2 -5
  244. package/src/trees/hasher.ts +6 -3
  245. package/src/trees/indexed_merkle_tree_calculator.ts +5 -1
  246. package/src/trees/membership_witness.ts +0 -8
  247. package/src/trees/merkle_tree_calculator.ts +4 -10
  248. package/src/trees/sibling_path.ts +11 -6
  249. package/src/trees/unbalanced_merkle_tree_root.ts +2 -5
  250. package/src/types/index.ts +47 -0
  251. package/dest/crypto/serialize.d.ts +0 -51
  252. package/dest/crypto/serialize.d.ts.map +0 -1
  253. package/dest/crypto/serialize.js +0 -68
  254. package/dest/transport/dispatch/create_dispatch_fn.d.ts +0 -25
  255. package/dest/transport/dispatch/create_dispatch_fn.d.ts.map +0 -1
  256. package/dest/transport/dispatch/create_dispatch_fn.js +0 -17
  257. package/src/crypto/serialize.ts +0 -85
  258. package/src/transport/dispatch/create_dispatch_fn.ts +0 -35
@@ -1,5 +1,4 @@
1
1
  import { toBigIntBE } from '../../bigint-buffer/index.js';
2
- import { poseidon2Hash } from '../../crypto/poseidon/index.js';
3
2
  import { randomBoolean } from '../../crypto/random/index.js';
4
3
  import { hexSchemaFor } from '../../schemas/utils.js';
5
4
  import { BufferReader, FieldReader, serializeToBuffer } from '../../serialize/index.js';
@@ -13,13 +12,16 @@ import { Fr } from '../bn254/field.js';
13
12
  * TODO(#7386): Clean up this class.
14
13
  */
15
14
  export class Point {
16
- static ZERO = new Point(Fr.ZERO, Fr.ZERO, false);
15
+ static INFINITY = new Point(Fr.ZERO, Fr.ZERO);
17
16
  static SIZE_IN_BYTES = Fr.SIZE_IN_BYTES * 2;
18
17
  static COMPRESSED_SIZE_IN_BYTES = Fr.SIZE_IN_BYTES;
19
18
 
20
19
  /** Used to differentiate this class from AztecAddress */
21
20
  public readonly kind = 'point';
22
21
 
22
+ /** Whether the point is at infinity */
23
+ public readonly isInfinite: boolean;
24
+
23
25
  constructor(
24
26
  /**
25
27
  * The point's x coordinate
@@ -29,12 +31,10 @@ export class Point {
29
31
  * The point's y coordinate
30
32
  */
31
33
  public readonly y: Fr,
32
- /**
33
- * Whether the point is at infinity
34
- */
35
- public readonly isInfinite: boolean,
36
34
  ) {
37
35
  // TODO(#7386): check if on curve
36
+ // NOTE: now there is no isInfinite in the struct, empty == inf, so an empty class would pass an on-curve check. This may be fine depending on the usage.
37
+ this.isInfinite = x.isZero() && y.isZero();
38
38
  }
39
39
 
40
40
  toJSON() {
@@ -61,11 +61,11 @@ export class Point {
61
61
  if (obj instanceof Buffer || Buffer.isBuffer(obj)) {
62
62
  return Point.fromBuffer(obj);
63
63
  }
64
- return new Point(Fr.fromPlainObject(obj.x), Fr.fromPlainObject(obj.y), obj.isInfinite ?? false);
64
+ return new this(Fr.fromPlainObject(obj.x), Fr.fromPlainObject(obj.y));
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
  */
@@ -92,7 +92,7 @@ export class Point {
92
92
  */
93
93
  static fromBuffer(buffer: Buffer | BufferReader) {
94
94
  const reader = BufferReader.asReader(buffer);
95
- return new this(Fr.fromBuffer(reader), Fr.fromBuffer(reader), false);
95
+ return new this(Fr.fromBuffer(reader), Fr.fromBuffer(reader));
96
96
  }
97
97
 
98
98
  /**
@@ -129,12 +129,13 @@ export class Point {
129
129
  * @returns The point as an array of 2 fields
130
130
  */
131
131
  toFields() {
132
- return [this.x, this.y, new Fr(this.isInfinite)];
132
+ return [this.x, this.y];
133
133
  }
134
134
 
135
135
  static fromFields(fields: Fr[] | FieldReader) {
136
136
  const reader = FieldReader.asReader(fields);
137
- return new this(reader.readField(), reader.readField(), reader.readBoolean());
137
+ const [x, y] = [reader.readField(), reader.readField()];
138
+ return new this(x, y);
138
139
  }
139
140
 
140
141
  /**
@@ -159,11 +160,12 @@ export class Point {
159
160
  const finalY = sign ? new Fr(yPositiveBigInt) : new Fr(yNegativeBigInt);
160
161
 
161
162
  // Create and return the new Point
162
- return new this(x, finalY, false);
163
+ return new this(x, finalY);
163
164
  }
164
165
 
165
166
  /**
166
- * @returns
167
+ * @param x - The x coordinate of the point
168
+ * @returns y^2 such that y^2 = x^3 - 17
167
169
  */
168
170
  static YFromX(x: Fr): Promise<Fr | null> {
169
171
  // Calculate y^2 = x^3 - 17 (i.e. the Grumpkin curve equation)
@@ -191,24 +193,15 @@ export class Point {
191
193
  return {
192
194
  x: this.x.toBigInt(),
193
195
  y: this.y.toBigInt(),
194
- isInfinite: this.isInfinite ? 1n : 0n,
195
196
  };
196
197
  }
197
198
 
198
199
  /**
199
200
  * Converts the Point instance to a Buffer representation of the coordinates.
200
201
  * @returns A Buffer representation of the Point instance.
201
- * @dev Note that toBuffer does not include the isInfinite flag and other serialization methods do (e.g. toFields).
202
- * This is because currently when we work with point as bytes we don't want to populate the extra bytes for
203
- * isInfinite flag because:
204
- * 1. Our Grumpkin BB API currently does not handle point at infinity,
205
- * 2. we use toBuffer when serializing notes and events and there we only work with public keys and point at infinity
206
- * is not considered a valid public key and the extra byte would raise DA cost.
202
+ * @dev Note that toBuffer does not include the isInfinite flag. The point at infinity is serialized as (0, 0).
207
203
  */
208
204
  toBuffer() {
209
- if (this.isInfinite) {
210
- throw new Error('Cannot serialize infinite point with isInfinite flag');
211
- }
212
205
  const buf = serializeToBuffer([this.x, this.y]);
213
206
  if (buf.length !== Point.SIZE_IN_BYTES) {
214
207
  throw new Error(`Invalid buffer length for Point: ${buf.length}`);
@@ -258,12 +251,10 @@ export class Point {
258
251
  }
259
252
 
260
253
  toNoirStruct() {
261
- /* eslint-disable camelcase */
262
- return { x: this.x, y: this.y, is_infinite: this.isInfinite };
263
- /* eslint-enable camelcase */
254
+ return { x: this.x, y: this.y };
264
255
  }
265
256
 
266
- // Used for IvpkM, OvpkM, NpkM and TpkM. TODO(#8124): Consider removing this method.
257
+ // Used for IvpkM. TODO(#8124): Consider removing this method.
267
258
  toWrappedNoirStruct() {
268
259
  return { inner: this.toNoirStruct() };
269
260
  }
@@ -283,21 +274,13 @@ export class Point {
283
274
  return this.x.isZero() && this.y.isZero();
284
275
  }
285
276
 
286
- hash() {
287
- return poseidon2Hash(this.toFields());
288
- }
289
-
290
277
  /**
291
- * Check if this is point at infinity.
292
- * Check this is consistent with how bb is encoding the point at infinity
278
+ * @param x - The x coordinate of the point
279
+ * @param y - The y coordinate of the point
280
+ * @returns Whether the point exists on Grumpkin
293
281
  */
294
- public get inf() {
295
- return this.isInfinite;
296
- }
297
-
298
- isOnGrumpkin() {
299
- // TODO: Check this against how bb handles curve check and infinity point check
300
- if (this.inf) {
282
+ isOnCurve() {
283
+ if (this.isInfinite) {
301
284
  return true;
302
285
  }
303
286
 
@@ -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,113 @@
1
+ import EventEmitter from 'node:events';
2
+ import * as fs from 'node:fs';
3
+ import * as net from 'node:net';
4
+ import type { Readable } from 'node:stream';
5
+
6
+ /**
7
+ * Events emitted by FifoFrameReader.
8
+ *
9
+ * - `frame`: A complete frame payload (without the 4-byte length header).
10
+ * - `error`: An unrecoverable error (invalid frame length, stream error).
11
+ * - `end`: The underlying stream has ended.
12
+ */
13
+ export interface FifoFrameReaderEvents {
14
+ frame: [payload: Buffer];
15
+ error: [error: Error];
16
+ end: [];
17
+ }
18
+
19
+ /**
20
+ * Reads length-delimited frames from a readable stream (typically a named FIFO pipe).
21
+ *
22
+ * Wire format: `[4-byte big-endian payload length][payload bytes]`
23
+ *
24
+ * Emits a `frame` event for each complete frame with the raw payload buffer.
25
+ * Callers are responsible for deserializing the payload (e.g., via msgpack).
26
+ *
27
+ * On encountering an invalid payload length (0 or >maxPayloadSize), emits `error`
28
+ * and destroys the stream.
29
+ */
30
+ export class FifoFrameReader extends EventEmitter<FifoFrameReaderEvents> {
31
+ private stream: Readable | null = null;
32
+ private pendingBuf: Buffer = Buffer.alloc(0);
33
+ private running = false;
34
+
35
+ constructor(private readonly maxPayloadSize = 10 * 1024 * 1024) {
36
+ super();
37
+ }
38
+
39
+ /** Open a FIFO at the given path and start reading frames. */
40
+ start(fifoPath: string): void {
41
+ // Read the FIFO through a libuv pipe handle (net.Socket) rather than fs.createReadStream.
42
+ // An fs read stream services the pipe with a blocking threadpool read that destroy() cannot
43
+ // cancel: if a writer never closes, that read stays parked and keeps the host process alive
44
+ // (manifesting as Jest "did not exit"). Opening O_NONBLOCK and wrapping the fd in a pipe
45
+ // handle makes reads epoll-based, so stop()'s destroy() releases the handle immediately,
46
+ // regardless of whether the writer is still attached.
47
+ const fd = fs.openSync(fifoPath, fs.constants.O_RDONLY | fs.constants.O_NONBLOCK);
48
+ let socket: net.Socket;
49
+ try {
50
+ socket = new net.Socket({ fd, readable: true, writable: false });
51
+ } catch (err) {
52
+ fs.closeSync(fd);
53
+ throw err;
54
+ }
55
+ this.startFromStream(socket);
56
+ }
57
+
58
+ /** Start reading frames from an existing readable stream. */
59
+ startFromStream(stream: Readable): void {
60
+ if (this.running) {
61
+ throw new Error('FifoFrameReader is already running');
62
+ }
63
+ this.running = true;
64
+ this.pendingBuf = Buffer.alloc(0);
65
+ this.stream = stream;
66
+
67
+ stream.on('data', (chunk: Buffer | string) => {
68
+ const buf = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
69
+ this.pendingBuf = this.pendingBuf.length > 0 ? Buffer.concat([this.pendingBuf, buf]) : buf;
70
+ this.drainFrames();
71
+ });
72
+
73
+ stream.on('error', (err: Error) => {
74
+ if (this.running) {
75
+ this.emit('error', err);
76
+ }
77
+ });
78
+
79
+ stream.on('end', () => {
80
+ this.emit('end');
81
+ });
82
+ }
83
+
84
+ /** Stop reading and destroy the underlying stream. */
85
+ stop(): void {
86
+ this.running = false;
87
+ if (this.stream) {
88
+ this.stream.destroy();
89
+ this.stream = null;
90
+ }
91
+ }
92
+
93
+ /** Parse complete frames out of the pending buffer. */
94
+ private drainFrames(): void {
95
+ while (this.pendingBuf.length >= 4) {
96
+ const payloadLen = this.pendingBuf.readUInt32BE(0);
97
+ if (payloadLen === 0 || payloadLen > this.maxPayloadSize) {
98
+ this.emit('error', new Error(`Invalid payload length: ${payloadLen}`));
99
+ this.stop();
100
+ return;
101
+ }
102
+
103
+ const frameLen = 4 + payloadLen;
104
+ if (this.pendingBuf.length < frameLen) {
105
+ break; // Wait for more data
106
+ }
107
+
108
+ const payload = this.pendingBuf.subarray(4, frameLen);
109
+ this.pendingBuf = this.pendingBuf.subarray(frameLen);
110
+ this.emit('frame', Buffer.from(payload));
111
+ }
112
+ }
113
+ }
@@ -0,0 +1 @@
1
+ export { FifoFrameReader } from './fifo_frame_reader.js';
@@ -0,0 +1,52 @@
1
+ /** A Set capped to a fixed number of entries, evicting the oldest inserted value when full. */
2
+ export class FifoSet<T> extends Set<T> {
3
+ private _limit: number | undefined;
4
+
5
+ private constructor(values?: Iterable<T>) {
6
+ super(values);
7
+ }
8
+
9
+ /** Creates a bounded set with a positive integer limit. */
10
+ static withLimit<T>(limit: number, values?: Iterable<T>): FifoSet<T> {
11
+ if (!Number.isSafeInteger(limit) || limit <= 0) {
12
+ throw new TypeError(`FifoSet limit must be a positive safe integer: ${limit}`);
13
+ }
14
+
15
+ const set = new FifoSet(values);
16
+ set._limit = limit;
17
+ set.compact();
18
+
19
+ return set;
20
+ }
21
+
22
+ override add(value: T): this {
23
+ super.add(value);
24
+ this.compact();
25
+ return this;
26
+ }
27
+
28
+ /** Maximum number of entries retained by this set. */
29
+ public get limit(): number {
30
+ return this._limit ?? Infinity;
31
+ }
32
+
33
+ /** Evicts oldest entries until the set is within its limit. */
34
+ public compact(): void {
35
+ while (this.size > this.limit) {
36
+ const head = this.values().next();
37
+ if (head.done) {
38
+ return;
39
+ }
40
+ this.delete(head.value);
41
+ }
42
+ }
43
+
44
+ /** Adds a value only if it is absent, returning whether the set changed. */
45
+ public addIfAbsent(value: T): boolean {
46
+ if (this.has(value)) {
47
+ return false;
48
+ }
49
+ this.add(value);
50
+ return true;
51
+ }
52
+ }
@@ -0,0 +1 @@
1
+ export * from './fifo_set.js';
@@ -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 {
@@ -2,7 +2,7 @@ import { format } from 'util';
2
2
 
3
3
  import { type Logger, createLogger } from '../../log/pino-logger.js';
4
4
  import { type PromiseWithResolvers, promiseWithResolvers } from '../../promise/utils.js';
5
- import { type ApiSchema, type ApiSchemaFor, schemaHasMethod } from '../../schemas/api.js';
5
+ import { type ApiSchema, type ApiSchemaFor, getSchemaReturnType, schemaHasMethod } from '../../schemas/api.js';
6
6
  import { jsonStringify } from '../convert.js';
7
7
  import { type JsonRpcFetch, defaultFetch } from './fetch.js';
8
8
 
@@ -236,7 +236,7 @@ export function createSafeJsonRpcClient<T extends object>(
236
236
  if ([null, undefined, 'null', 'undefined'].includes(response.result)) {
237
237
  return;
238
238
  }
239
- return (schema as ApiSchema)[methodName].returnType().parseAsync(response.result);
239
+ return getSchemaReturnType((schema as ApiSchema)[methodName]).parseAsync(response.result);
240
240
  };
241
241
 
242
242
  const clientId = nextClientId++;
@@ -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) {
@@ -130,14 +130,14 @@ export class TestState implements TestStateApi {
130
130
  }
131
131
 
132
132
  export const TestStateSchema: ApiSchemaFor<TestStateApi> = {
133
- getNote: z.function().args(z.number()).returns(TestNote.schema.optional()),
134
- getNotes: z.function().args(optional(schemas.Integer)).returns(z.array(TestNote.schema)),
135
- getNotes2: z.function().args(optional(schemas.BigInt)).returns(z.array(TestNote.schema)),
136
- getNotes3: z.function().args(optional(schemas.Integer)).returns(z.array(TestNote.schema)),
137
- clear: z.function().returns(z.void()),
138
- addNotes: z.function().args(z.array(TestNote.schema)).returns(z.array(TestNote.schema)),
139
- fail: z.function().returns(z.void()),
140
- count: z.function().returns(z.number()),
141
- getStatus: z.function().returns(z.object({ status: z.string(), count: schemas.BigInt })),
142
- getTuple: z.function().returns(z.tuple([z.string(), optional(z.string()), z.number()])),
133
+ getNote: z.function({ input: z.tuple([z.number()]), output: TestNote.schema.optional() }),
134
+ getNotes: z.function({ input: z.tuple([optional(schemas.Integer)]), output: z.array(TestNote.schema) }),
135
+ getNotes2: z.function({ input: z.tuple([optional(schemas.BigInt)]), output: z.array(TestNote.schema) }),
136
+ getNotes3: z.function({ input: z.tuple([optional(schemas.Integer)]), output: z.array(TestNote.schema) }),
137
+ clear: z.function({ input: z.tuple([]), output: z.void() }),
138
+ addNotes: z.function({ input: z.tuple([z.array(TestNote.schema)]), output: z.array(TestNote.schema) }),
139
+ fail: z.function({ input: z.tuple([]), output: z.void() }),
140
+ count: z.function({ input: z.tuple([]), output: z.number() }),
141
+ getStatus: z.function({ input: z.tuple([]), output: z.object({ status: z.string(), count: schemas.BigInt }) }),
142
+ getTuple: z.function({ input: z.tuple([]), output: z.tuple([z.string(), optional(z.string()), z.number()]) }),
143
143
  };
@@ -10,7 +10,13 @@ import { ZodError } from 'zod';
10
10
 
11
11
  import { type Logger, createLogger } from '../../log/index.js';
12
12
  import { promiseWithResolvers } from '../../promise/utils.js';
13
- import { type ApiSchema, type ApiSchemaFor, parseWithOptionals, schemaHasMethod } from '../../schemas/index.js';
13
+ import {
14
+ type ApiSchema,
15
+ type ApiSchemaFor,
16
+ getSchemaParameters,
17
+ parseWithOptionals,
18
+ schemaHasMethod,
19
+ } from '../../schemas/index.js';
14
20
  import { jsonStringify } from '../convert.js';
15
21
  import { assert } from '../js_utils.js';
16
22
 
@@ -53,8 +59,10 @@ export class SafeJsonRpcServer {
53
59
  config: Partial<SafeJsonRpcServerConfig> = {},
54
60
  /** Health check function */
55
61
  private readonly healthCheck: StatusCheckFn = () => true,
56
- /** Additional middlewares */
62
+ /** Additional Koa middlewares */
57
63
  private extraMiddlewares: Application.Middleware[] = [],
64
+ /** Additional per-request diagnostics middlewares */
65
+ private diagnosticsMiddleware?: DiagnosticsMiddleware,
58
66
  /** Logger */
59
67
  private log = createLogger('json-rpc:server'),
60
68
  ) {
@@ -155,7 +163,7 @@ export class SafeJsonRpcServer {
155
163
  };
156
164
  return;
157
165
  }
158
- const resp = await this.processBatch(ctx.request.body);
166
+ const resp = await this.processBatch(ctx.request.body, ctx.request.headers);
159
167
  if (Array.isArray(resp)) {
160
168
  ctx.status = 200;
161
169
  ctx.body = resp;
@@ -164,7 +172,7 @@ export class SafeJsonRpcServer {
164
172
  ctx.body = resp;
165
173
  }
166
174
  } else {
167
- const resp = await this.processRequest(ctx.request.body);
175
+ const resp = await this.processRequest(ctx.request.body, ctx.request.headers);
168
176
  if ('error' in resp) {
169
177
  ctx.status = this.config.http200OnError ? 200 : 400;
170
178
  }
@@ -176,11 +184,11 @@ export class SafeJsonRpcServer {
176
184
  return router;
177
185
  }
178
186
 
179
- private async processBatch(requests: any[]) {
187
+ private async processBatch(requests: any[], headers: http.IncomingHttpHeaders = {}) {
180
188
  if (requests.length === 0) {
181
189
  return { jsonrpc: '2.0', error: { code: -32600, message: 'Invalid Request' }, id: null };
182
190
  }
183
- const results = await Promise.allSettled(requests.map(req => this.processRequest(req)));
191
+ const results = await Promise.allSettled(requests.map(req => this.processRequest(req, headers)));
184
192
  return results.map(res => {
185
193
  if (res.status === 'fulfilled') {
186
194
  return res.value;
@@ -191,7 +199,7 @@ export class SafeJsonRpcServer {
191
199
  });
192
200
  }
193
201
 
194
- private async processRequest(request: any) {
202
+ private async processRequest(request: any, headers: http.IncomingHttpHeaders = {}) {
195
203
  if (!request || typeof request !== 'object') {
196
204
  return { jsonrpc: '2.0', error: { code: -32600, message: 'Invalid Request' }, id: null };
197
205
  }
@@ -206,7 +214,16 @@ export class SafeJsonRpcServer {
206
214
  return { jsonrpc, id, error: { code: -32601, message: `Method not found: ${method}` } };
207
215
  } else {
208
216
  try {
209
- const result = await this.proxy.call(method, params);
217
+ let result: any;
218
+
219
+ if (this.diagnosticsMiddleware) {
220
+ await this.diagnosticsMiddleware({ id: id ?? null, method, params, headers }, async () => {
221
+ result = await this.proxy.call(method, params);
222
+ });
223
+ } else {
224
+ result = await this.proxy.call(method, params);
225
+ }
226
+
210
227
  return { jsonrpc, id, result };
211
228
  } catch (err: any) {
212
229
  if (err && err instanceof ZodError) {
@@ -309,7 +326,7 @@ export class SafeJsonProxy<T extends object = any> implements Proxy {
309
326
  assert(schemaHasMethod(this.schema, methodName), `Method ${methodName} not found in schema`);
310
327
  const method = this.handler[methodName as keyof T];
311
328
  assert(typeof method === 'function', `Method ${methodName} is not a function`);
312
- const args = await parseWithOptionals(jsonParams, this.schema[methodName].parameters());
329
+ const args = await parseWithOptionals(jsonParams, getSchemaParameters(this.schema[methodName]));
313
330
  const ret = await method.apply(this.handler, args);
314
331
  this.log.debug(format('response', methodName, ret));
315
332
  return ret;
@@ -377,6 +394,7 @@ function makeAggregateHealthcheck(namedHandlers: NamespacedApiHandlers, log?: Lo
377
394
  export type SafeJsonRpcServerOptions = Partial<
378
395
  SafeJsonRpcServerConfig & {
379
396
  healthCheck: StatusCheckFn;
397
+ diagnostic: DiagnosticsMiddleware;
380
398
  log: Logger;
381
399
  middlewares: Application.Middleware[];
382
400
  }
@@ -391,10 +409,10 @@ export function createNamespacedSafeJsonRpcServer(
391
409
  handlers: NamespacedApiHandlers,
392
410
  options: Omit<SafeJsonRpcServerOptions, 'healthcheck'> = {},
393
411
  ): SafeJsonRpcServer {
394
- const { middlewares, log } = options;
412
+ const { diagnostic, middlewares, log } = options;
395
413
  const proxy = new NamespacedSafeJsonProxy(handlers);
396
414
  const healthCheck = makeAggregateHealthcheck(handlers, log);
397
- return new SafeJsonRpcServer(proxy, options, healthCheck, middlewares, log);
415
+ return new SafeJsonRpcServer(proxy, options, healthCheck, middlewares, diagnostic, log);
398
416
  }
399
417
 
400
418
  export function createSafeJsonRpcServer<T extends object = any>(
@@ -402,9 +420,9 @@ export function createSafeJsonRpcServer<T extends object = any>(
402
420
  schema: ApiSchemaFor<T>,
403
421
  options: SafeJsonRpcServerOptions = {},
404
422
  ) {
405
- const { log, healthCheck, middlewares: extraMiddlewares } = options;
423
+ const { diagnostic, log, healthCheck, middlewares: extraMiddlewares } = options;
406
424
  const proxy = new SafeJsonProxy(handler, schema);
407
- return new SafeJsonRpcServer(proxy, options, healthCheck, extraMiddlewares, log);
425
+ return new SafeJsonRpcServer(proxy, options, healthCheck, extraMiddlewares, diagnostic, log);
408
426
  }
409
427
 
410
428
  /**
@@ -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
  }
@@ -10,26 +10,6 @@ const noirLocalDependencySchema = z.object({
10
10
  path: z.string(),
11
11
  });
12
12
 
13
- const noirPackageConfigSchema = z.object({
14
- package: z.object({
15
- name: z.string().default(''),
16
- type: z.enum(['lib', 'contract', 'bin']).default('bin'),
17
- entry: z.string().optional(),
18
- description: z.string().optional(),
19
- authors: z.array(z.string()).optional(),
20
- // eslint-disable-next-line camelcase
21
- compiler_version: z.string().optional(),
22
- backend: z.string().optional(),
23
- license: z.string().optional(),
24
- }),
25
- dependencies: z.record(z.union([noirGitDependencySchema, noirLocalDependencySchema])).default({}),
26
- });
27
-
28
- /**
29
- * Noir package configuration.
30
- */
31
- export type NoirPackageConfig = z.infer<typeof noirPackageConfigSchema>;
32
-
33
13
  /**
34
14
  * A remote package dependency.
35
15
  */
@@ -45,6 +25,38 @@ export type NoirLocalDependencyConfig = z.infer<typeof noirLocalDependencySchema
45
25
  */
46
26
  export type NoirDependencyConfig = NoirGitDependencyConfig | NoirLocalDependencyConfig;
47
27
 
28
+ /**
29
+ * Noir package configuration.
30
+ */
31
+ export type NoirPackageConfig = {
32
+ package: {
33
+ name: string;
34
+ type: 'lib' | 'contract' | 'bin';
35
+ entry?: string | undefined;
36
+ description?: string | undefined;
37
+ authors?: string[] | undefined;
38
+ compiler_version?: string | undefined;
39
+ backend?: string | undefined;
40
+ license?: string | undefined;
41
+ };
42
+ dependencies: Record<string, NoirDependencyConfig>;
43
+ };
44
+
45
+ const noirPackageConfigSchema: z.ZodType<NoirPackageConfig> = z.object({
46
+ package: z.object({
47
+ name: z.string().default(''),
48
+ type: z.enum(['lib', 'contract', 'bin']).default('bin'),
49
+ entry: z.string().optional(),
50
+ description: z.string().optional(),
51
+ authors: z.array(z.string()).optional(),
52
+ // eslint-disable-next-line camelcase
53
+ compiler_version: z.string().optional(),
54
+ backend: z.string().optional(),
55
+ license: z.string().optional(),
56
+ }),
57
+ dependencies: z.record(z.string(), z.union([noirGitDependencySchema, noirLocalDependencySchema])).default({}),
58
+ });
59
+
48
60
  /**
49
61
  * Checks that an object is a package configuration.
50
62
  * @param config - Config to check