@aztec/foundation 0.0.1-commit.fce3e4f → 0.0.1-commit.fffb133c

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 (283) hide show
  1. package/dest/array/index.d.ts +2 -1
  2. package/dest/array/index.d.ts.map +1 -1
  3. package/dest/array/index.js +1 -0
  4. package/dest/array/sorted_array.d.ts +10 -0
  5. package/dest/array/sorted_array.d.ts.map +1 -0
  6. package/dest/array/sorted_array.js +106 -0
  7. package/dest/branded-types/block_number.d.ts +56 -0
  8. package/dest/branded-types/block_number.d.ts.map +1 -0
  9. package/dest/branded-types/block_number.js +78 -0
  10. package/dest/branded-types/checkpoint_number.d.ts +54 -0
  11. package/dest/branded-types/checkpoint_number.d.ts.map +1 -0
  12. package/dest/branded-types/checkpoint_number.js +77 -0
  13. package/dest/branded-types/index.d.ts +4 -1
  14. package/dest/branded-types/index.d.ts.map +1 -1
  15. package/dest/branded-types/index.js +3 -0
  16. package/dest/branded-types/index_within_checkpoint.d.ts +42 -0
  17. package/dest/branded-types/index_within_checkpoint.d.ts.map +1 -0
  18. package/dest/branded-types/index_within_checkpoint.js +59 -0
  19. package/dest/buffer/buffer16.d.ts +5 -2
  20. package/dest/buffer/buffer16.d.ts.map +1 -1
  21. package/dest/buffer/buffer16.js +4 -2
  22. package/dest/buffer/buffer32.d.ts +5 -2
  23. package/dest/buffer/buffer32.d.ts.map +1 -1
  24. package/dest/buffer/buffer32.js +4 -2
  25. package/dest/collection/array.d.ts +6 -1
  26. package/dest/collection/array.d.ts.map +1 -1
  27. package/dest/collection/array.js +27 -0
  28. package/dest/config/env_var.d.ts +2 -2
  29. package/dest/config/env_var.d.ts.map +1 -1
  30. package/dest/config/index.d.ts +15 -4
  31. package/dest/config/index.d.ts.map +1 -1
  32. package/dest/config/index.js +32 -9
  33. package/dest/config/network_config.d.ts +13 -1
  34. package/dest/config/network_config.d.ts.map +1 -1
  35. package/dest/config/network_config.js +3 -1
  36. package/dest/config/parse-env.d.ts +3 -0
  37. package/dest/config/parse-env.d.ts.map +1 -0
  38. package/dest/config/parse-env.js +7 -0
  39. package/dest/config/secret_value.js +3 -1
  40. package/dest/crypto/bls/bn254_keystore.js +1 -1
  41. package/dest/crypto/bls/index.js +1 -1
  42. package/dest/crypto/bn254/index.d.ts +35 -51
  43. package/dest/crypto/bn254/index.d.ts.map +1 -1
  44. package/dest/crypto/bn254/index.js +51 -140
  45. package/dest/crypto/ecdsa/signature.d.ts +11 -2
  46. package/dest/crypto/ecdsa/signature.d.ts.map +1 -1
  47. package/dest/crypto/ecdsa/signature.js +2 -2
  48. package/dest/crypto/grumpkin/index.d.ts +4 -2
  49. package/dest/crypto/grumpkin/index.d.ts.map +1 -1
  50. package/dest/crypto/grumpkin/index.js +2 -1
  51. package/dest/crypto/keys/index.d.ts +2 -2
  52. package/dest/crypto/keys/index.d.ts.map +1 -1
  53. package/dest/crypto/keys/index.js +1 -1
  54. package/dest/crypto/pedersen/pedersen.wasm.d.ts +2 -2
  55. package/dest/crypto/pedersen/pedersen.wasm.d.ts.map +1 -1
  56. package/dest/crypto/pedersen/pedersen.wasm.js +1 -1
  57. package/dest/crypto/poseidon/index.d.ts +2 -3
  58. package/dest/crypto/poseidon/index.d.ts.map +1 -1
  59. package/dest/crypto/poseidon/index.js +1 -10
  60. package/dest/crypto/random/randomness_singleton.d.ts +2 -2
  61. package/dest/crypto/random/randomness_singleton.d.ts.map +1 -1
  62. package/dest/crypto/random/randomness_singleton.js +3 -3
  63. package/dest/crypto/schnorr/index.d.ts +3 -2
  64. package/dest/crypto/schnorr/index.d.ts.map +1 -1
  65. package/dest/crypto/schnorr/index.js +1 -1
  66. package/dest/crypto/schnorr/signature.d.ts +2 -2
  67. package/dest/crypto/schnorr/signature.d.ts.map +1 -1
  68. package/dest/crypto/schnorr/signature.js +2 -2
  69. package/dest/crypto/sha256/index.d.ts +2 -2
  70. package/dest/crypto/sha256/index.d.ts.map +1 -1
  71. package/dest/crypto/sha256/index.js +1 -1
  72. package/dest/crypto/sha512/index.d.ts +2 -2
  73. package/dest/crypto/sha512/index.d.ts.map +1 -1
  74. package/dest/crypto/sha512/index.js +1 -1
  75. package/dest/crypto/signature/index.d.ts +2 -2
  76. package/dest/crypto/signature/index.d.ts.map +1 -1
  77. package/dest/crypto/sync/pedersen/index.d.ts +2 -2
  78. package/dest/crypto/sync/pedersen/index.d.ts.map +1 -1
  79. package/dest/crypto/sync/pedersen/index.js +1 -1
  80. package/dest/crypto/sync/poseidon/index.d.ts +2 -3
  81. package/dest/crypto/sync/poseidon/index.d.ts.map +1 -1
  82. package/dest/crypto/sync/poseidon/index.js +1 -9
  83. package/dest/{fields/bls12_fields.d.ts → curves/bls12/field.d.ts} +3 -3
  84. package/dest/curves/bls12/field.d.ts.map +1 -0
  85. package/dest/{fields/bls12_fields.js → curves/bls12/field.js} +12 -9
  86. package/dest/curves/bls12/index.d.ts +3 -0
  87. package/dest/curves/bls12/index.d.ts.map +1 -0
  88. package/dest/curves/bls12/index.js +2 -0
  89. package/dest/{fields/bls12_point.d.ts → curves/bls12/point.d.ts} +13 -4
  90. package/dest/curves/bls12/point.d.ts.map +1 -0
  91. package/dest/{fields/bls12_point.js → curves/bls12/point.js} +10 -8
  92. package/dest/{fields/fields.d.ts → curves/bn254/field.d.ts} +7 -15
  93. package/dest/curves/bn254/field.d.ts.map +1 -0
  94. package/dest/{fields/fields.js → curves/bn254/field.js} +35 -49
  95. package/dest/curves/bn254/index.d.ts +3 -0
  96. package/dest/curves/bn254/index.d.ts.map +1 -0
  97. package/dest/curves/bn254/index.js +2 -0
  98. package/dest/curves/bn254/point.d.ts +54 -0
  99. package/dest/curves/bn254/point.d.ts.map +1 -0
  100. package/dest/curves/bn254/point.js +143 -0
  101. package/dest/curves/grumpkin/index.d.ts +10 -0
  102. package/dest/curves/grumpkin/index.d.ts.map +1 -0
  103. package/dest/curves/grumpkin/index.js +3 -0
  104. package/dest/{fields → curves/grumpkin}/point.d.ts +13 -4
  105. package/dest/curves/grumpkin/point.d.ts.map +1 -0
  106. package/dest/{fields → curves/grumpkin}/point.js +7 -7
  107. package/dest/error/index.d.ts +4 -4
  108. package/dest/error/index.d.ts.map +1 -1
  109. package/dest/eth-address/index.d.ts +3 -2
  110. package/dest/eth-address/index.d.ts.map +1 -1
  111. package/dest/eth-address/index.js +10 -3
  112. package/dest/eth-signature/eth_signature.d.ts +4 -1
  113. package/dest/eth-signature/eth_signature.d.ts.map +1 -1
  114. package/dest/iterator/filter.d.ts +3 -0
  115. package/dest/iterator/filter.d.ts.map +1 -0
  116. package/dest/iterator/filter.js +7 -0
  117. package/dest/iterator/index.d.ts +2 -0
  118. package/dest/iterator/index.d.ts.map +1 -0
  119. package/dest/iterator/index.js +1 -0
  120. package/dest/json-rpc/client/undici.d.ts +1 -1
  121. package/dest/json-rpc/client/undici.d.ts.map +1 -1
  122. package/dest/json-rpc/client/undici.js +21 -4
  123. package/dest/json-rpc/fixtures/class_a.d.ts +3 -3
  124. package/dest/json-rpc/fixtures/class_a.d.ts.map +1 -1
  125. package/dest/json-rpc/fixtures/class_b.d.ts +3 -3
  126. package/dest/json-rpc/fixtures/class_b.d.ts.map +1 -1
  127. package/dest/json-rpc/server/safe_json_rpc_server.js +1 -1
  128. package/dest/log/pino-logger.d.ts +1 -1
  129. package/dest/log/pino-logger.d.ts.map +1 -1
  130. package/dest/log/pino-logger.js +1 -1
  131. package/dest/retry/index.d.ts +11 -1
  132. package/dest/retry/index.d.ts.map +1 -1
  133. package/dest/retry/index.js +11 -0
  134. package/dest/schemas/schemas.d.ts +7 -3
  135. package/dest/schemas/schemas.d.ts.map +1 -1
  136. package/dest/schemas/schemas.js +9 -3
  137. package/dest/schemas/types.d.ts +31 -1
  138. package/dest/schemas/types.d.ts.map +1 -1
  139. package/dest/schemas/types.js +25 -1
  140. package/dest/serialize/buffer_reader.d.ts +7 -4
  141. package/dest/serialize/buffer_reader.d.ts.map +1 -1
  142. package/dest/serialize/buffer_reader.js +13 -4
  143. package/dest/serialize/field_reader.d.ts +2 -2
  144. package/dest/serialize/field_reader.d.ts.map +1 -1
  145. package/dest/serialize/field_reader.js +1 -1
  146. package/dest/serialize/free_funcs.d.ts +2 -2
  147. package/dest/serialize/free_funcs.d.ts.map +1 -1
  148. package/dest/serialize/free_funcs.js +1 -1
  149. package/dest/serialize/serialize.d.ts +2 -2
  150. package/dest/serialize/serialize.d.ts.map +1 -1
  151. package/dest/serialize/serialize.js +1 -1
  152. package/dest/sleep/index.d.ts +3 -1
  153. package/dest/sleep/index.d.ts.map +1 -1
  154. package/dest/sleep/index.js +4 -0
  155. package/dest/timer/date.d.ts +2 -1
  156. package/dest/timer/date.d.ts.map +1 -1
  157. package/dest/timer/date.js +3 -0
  158. package/dest/trees/balanced_merkle_tree_root.d.ts +17 -0
  159. package/dest/trees/balanced_merkle_tree_root.d.ts.map +1 -0
  160. package/dest/trees/{balanced_merkle_tree.js → balanced_merkle_tree_root.js} +2 -15
  161. package/dest/trees/hasher.d.ts +3 -1
  162. package/dest/trees/hasher.d.ts.map +1 -1
  163. package/dest/trees/hasher.js +10 -5
  164. package/dest/trees/index.d.ts +4 -4
  165. package/dest/trees/index.d.ts.map +1 -1
  166. package/dest/trees/index.js +3 -3
  167. package/dest/trees/indexed_merkle_tree.js +1 -1
  168. package/dest/trees/membership_witness.d.ts +12 -2
  169. package/dest/trees/membership_witness.d.ts.map +1 -1
  170. package/dest/trees/membership_witness.js +10 -1
  171. package/dest/trees/merkle_tree_calculator.d.ts +1 -1
  172. package/dest/trees/merkle_tree_calculator.d.ts.map +1 -1
  173. package/dest/trees/merkle_tree_calculator.js +2 -2
  174. package/dest/trees/sibling_path.d.ts +3 -2
  175. package/dest/trees/sibling_path.d.ts.map +1 -1
  176. package/dest/trees/sibling_path.js +3 -3
  177. package/dest/trees/unbalanced_merkle_tree_calculator.d.ts +2 -3
  178. package/dest/trees/unbalanced_merkle_tree_calculator.d.ts.map +1 -1
  179. package/dest/trees/unbalanced_merkle_tree_calculator.js +1 -5
  180. package/dest/trees/{unbalanced_merkle_tree.d.ts → unbalanced_merkle_tree_root.d.ts} +3 -5
  181. package/dest/trees/unbalanced_merkle_tree_root.d.ts.map +1 -0
  182. package/dest/trees/{unbalanced_merkle_tree.js → unbalanced_merkle_tree_root.js} +11 -49
  183. package/dest/trees/unbalanced_tree_store.d.ts +5 -1
  184. package/dest/trees/unbalanced_tree_store.d.ts.map +1 -1
  185. package/dest/trees/unbalanced_tree_store.js +49 -1
  186. package/dest/types/index.d.ts +4 -2
  187. package/dest/types/index.d.ts.map +1 -1
  188. package/dest/types/index.js +3 -0
  189. package/package.json +27 -9
  190. package/src/array/index.ts +1 -0
  191. package/src/array/sorted_array.ts +133 -0
  192. package/src/branded-types/block_number.ts +117 -0
  193. package/src/branded-types/checkpoint_number.ts +115 -0
  194. package/src/branded-types/index.ts +3 -0
  195. package/src/branded-types/index_within_checkpoint.ts +88 -0
  196. package/src/buffer/buffer16.ts +2 -2
  197. package/src/buffer/buffer32.ts +2 -2
  198. package/src/collection/array.ts +31 -0
  199. package/src/config/env_var.ts +33 -12
  200. package/src/config/index.ts +39 -6
  201. package/src/config/network_config.ts +2 -0
  202. package/src/config/parse-env.ts +4 -0
  203. package/src/crypto/bls/bn254_keystore.ts +1 -1
  204. package/src/crypto/bls/index.ts +1 -1
  205. package/src/crypto/bn254/index.ts +50 -159
  206. package/src/crypto/ecdsa/signature.ts +2 -2
  207. package/src/crypto/grumpkin/index.ts +3 -1
  208. package/src/crypto/keys/index.ts +1 -1
  209. package/src/crypto/pedersen/pedersen.wasm.ts +1 -1
  210. package/src/crypto/poseidon/index.ts +1 -11
  211. package/src/crypto/random/randomness_singleton.ts +2 -4
  212. package/src/crypto/schnorr/index.ts +2 -1
  213. package/src/crypto/schnorr/signature.ts +2 -2
  214. package/src/crypto/sha256/index.ts +1 -1
  215. package/src/crypto/sha512/index.ts +1 -1
  216. package/src/crypto/signature/index.ts +1 -1
  217. package/src/crypto/sync/pedersen/index.ts +1 -1
  218. package/src/crypto/sync/poseidon/index.ts +1 -10
  219. package/src/{fields/bls12_fields.ts → curves/bls12/field.ts} +6 -6
  220. package/src/curves/bls12/index.ts +2 -0
  221. package/src/{fields/bls12_point.ts → curves/bls12/point.ts} +7 -7
  222. package/src/{fields/fields.ts → curves/bn254/field.ts} +33 -56
  223. package/src/curves/bn254/index.ts +2 -0
  224. package/src/curves/bn254/point.ts +170 -0
  225. package/src/curves/grumpkin/index.ts +11 -0
  226. package/src/{fields → curves/grumpkin}/point.ts +7 -7
  227. package/src/eth-address/index.ts +8 -2
  228. package/src/iterator/filter.ts +11 -0
  229. package/src/iterator/index.ts +1 -0
  230. package/src/json-rpc/client/undici.ts +21 -3
  231. package/src/json-rpc/server/safe_json_rpc_server.ts +1 -1
  232. package/src/log/pino-logger.ts +2 -1
  233. package/src/retry/index.ts +18 -0
  234. package/src/schemas/schemas.ts +14 -3
  235. package/src/schemas/types.ts +33 -0
  236. package/src/serialize/buffer_reader.ts +21 -9
  237. package/src/serialize/field_reader.ts +1 -1
  238. package/src/serialize/free_funcs.ts +1 -1
  239. package/src/serialize/serialize.ts +1 -1
  240. package/src/sleep/index.ts +6 -0
  241. package/src/timer/date.ts +4 -0
  242. package/src/trees/{balanced_merkle_tree.ts → balanced_merkle_tree_root.ts} +2 -16
  243. package/src/trees/hasher.ts +9 -0
  244. package/src/trees/index.ts +3 -3
  245. package/src/trees/indexed_merkle_tree.ts +1 -1
  246. package/src/trees/membership_witness.ts +9 -1
  247. package/src/trees/merkle_tree_calculator.ts +2 -2
  248. package/src/trees/sibling_path.ts +3 -3
  249. package/src/trees/unbalanced_merkle_tree_calculator.ts +1 -12
  250. package/src/trees/{unbalanced_merkle_tree.ts → unbalanced_merkle_tree_root.ts} +17 -61
  251. package/src/trees/unbalanced_tree_store.ts +57 -2
  252. package/src/types/index.ts +6 -1
  253. package/dest/crypto/bn254/bn254_utils.d.ts +0 -39
  254. package/dest/crypto/bn254/bn254_utils.d.ts.map +0 -1
  255. package/dest/crypto/bn254/bn254_utils.js +0 -56
  256. package/dest/crypto/index.d.ts +0 -17
  257. package/dest/crypto/index.d.ts.map +0 -1
  258. package/dest/crypto/index.js +0 -16
  259. package/dest/fields/bls12_fields.d.ts.map +0 -1
  260. package/dest/fields/bls12_point.d.ts.map +0 -1
  261. package/dest/fields/coordinate.d.ts +0 -63
  262. package/dest/fields/coordinate.d.ts.map +0 -1
  263. package/dest/fields/coordinate.js +0 -96
  264. package/dest/fields/fields.d.ts.map +0 -1
  265. package/dest/fields/index.d.ts +0 -6
  266. package/dest/fields/index.d.ts.map +0 -1
  267. package/dest/fields/index.js +0 -5
  268. package/dest/fields/point.d.ts.map +0 -1
  269. package/dest/index.d.ts +0 -31
  270. package/dest/index.d.ts.map +0 -1
  271. package/dest/index.js +0 -31
  272. package/dest/json-rpc/server/telemetry.d.ts +0 -2
  273. package/dest/json-rpc/server/telemetry.d.ts.map +0 -1
  274. package/dest/json-rpc/server/telemetry.js +0 -0
  275. package/dest/trees/balanced_merkle_tree.d.ts +0 -22
  276. package/dest/trees/balanced_merkle_tree.d.ts.map +0 -1
  277. package/dest/trees/unbalanced_merkle_tree.d.ts.map +0 -1
  278. package/src/crypto/bn254/bn254_utils.ts +0 -64
  279. package/src/crypto/index.ts +0 -16
  280. package/src/fields/coordinate.ts +0 -104
  281. package/src/fields/index.ts +0 -5
  282. package/src/index.ts +0 -31
  283. package/src/json-rpc/server/telemetry.ts +0 -0
@@ -2,13 +2,11 @@ import { BarretenbergSync } from '@aztec/bb.js';
2
2
 
3
3
  import { inspect } from 'util';
4
4
 
5
- import { toBigIntBE, toBufferBE } from '../bigint-buffer/index.js';
6
- import { randomBytes } from '../crypto/random/index.js';
7
- import { hexSchemaFor } from '../schemas/utils.js';
8
- import { BufferReader } from '../serialize/buffer_reader.js';
9
- import { TypeRegistry } from '../serialize/type_registry.js';
10
-
11
- const ZERO_BUFFER = Buffer.alloc(32);
5
+ import { toBigIntBE, toBufferBE } from '../../bigint-buffer/index.js';
6
+ import { randomBytes } from '../../crypto/random/index.js';
7
+ import { hexSchemaFor } from '../../schemas/utils.js';
8
+ import { BufferReader } from '../../serialize/buffer_reader.js';
9
+ import { TypeRegistry } from '../../serialize/type_registry.js';
12
10
 
13
11
  /* eslint-disable @typescript-eslint/no-unsafe-declaration-merging */
14
12
 
@@ -25,14 +23,12 @@ type DerivedField<T extends BaseField> = {
25
23
 
26
24
  /**
27
25
  * Base field class.
28
- * Conversions from Buffer to BigInt and vice-versa are not cheap.
29
- * We allow construction with either form and lazily convert to other as needed.
30
- * We only check we are within the field modulus when initializing with bigint.
26
+ * Uses bigint as the internal representation.
27
+ * Buffers are generated on demand from the bigint value.
31
28
  */
32
29
  abstract class BaseField {
33
30
  static SIZE_IN_BYTES = 32;
34
- private asBuffer?: Buffer;
35
- private asBigInt?: bigint;
31
+ private readonly asBigInt: bigint;
36
32
 
37
33
  /**
38
34
  * Return bigint representation.
@@ -52,53 +48,41 @@ abstract class BaseField {
52
48
  if (value.length > BaseField.SIZE_IN_BYTES) {
53
49
  throw new Error(`Value length ${value.length} exceeds ${BaseField.SIZE_IN_BYTES}`);
54
50
  }
55
- this.asBuffer =
56
- value.length === BaseField.SIZE_IN_BYTES
57
- ? value
58
- : Buffer.concat([Buffer.alloc(BaseField.SIZE_IN_BYTES - value.length), value]);
51
+ this.asBigInt = toBigIntBE(value);
59
52
  } else if (typeof value === 'bigint' || typeof value === 'number' || typeof value === 'boolean') {
60
53
  this.asBigInt = BigInt(value);
61
- if (this.asBigInt >= this.modulus()) {
62
- throw new Error(`Value 0x${this.asBigInt.toString(16)} is greater or equal to field modulus.`);
63
- } else if (this.asBigInt < 0n) {
64
- throw new Error(`Value 0x${this.asBigInt.toString(16)} is negative.`);
65
- }
66
54
  } else if (value instanceof BaseField) {
67
- this.asBuffer = value.asBuffer;
68
55
  this.asBigInt = value.asBigInt;
69
56
  } else {
70
57
  throw new Error(`Type '${typeof value}' with value '${value}' passed to BaseField ctor.`);
71
58
  }
59
+
60
+ if (this.asBigInt < 0n) {
61
+ throw new Error(`Value 0x${this.asBigInt.toString(16)} is negative.`);
62
+ } else if (this.asBigInt >= this.modulus()) {
63
+ throw new Error(`Value 0x${this.asBigInt.toString(16)} is greater or equal to field modulus.`);
64
+ }
72
65
  }
73
66
 
74
67
  protected abstract modulus(): bigint;
75
68
 
76
69
  /**
77
- * We return a copy of the Buffer to ensure this remains immutable.
70
+ * Converts the bigint to a Buffer.
78
71
  */
79
72
  toBuffer(): Buffer {
80
- if (!this.asBuffer) {
81
- this.asBuffer = toBufferBE(this.asBigInt!, 32);
82
- }
83
- return Buffer.from(this.asBuffer);
73
+ return toBufferBE(this.asBigInt, 32);
84
74
  }
85
75
 
86
76
  toString(): `0x${string}` {
87
- return `0x${this.toBuffer().toString('hex')}`;
77
+ return `0x${this.asBigInt.toString(16).padStart(64, '0')}`;
88
78
  }
89
79
 
90
80
  toBigInt(): bigint {
91
- if (this.asBigInt === undefined) {
92
- this.asBigInt = toBigIntBE(this.asBuffer!);
93
- if (this.asBigInt >= this.modulus()) {
94
- throw new Error(`Value 0x${this.asBigInt.toString(16)} is greater or equal to field modulus.`);
95
- }
96
- }
97
81
  return this.asBigInt;
98
82
  }
99
83
 
100
84
  toBool(): boolean {
101
- return Boolean(this.toBigInt());
85
+ return this.asBigInt !== 0n;
102
86
  }
103
87
 
104
88
  /**
@@ -106,11 +90,10 @@ abstract class BaseField {
106
90
  * Throws if the underlying value is greater than MAX_SAFE_INTEGER.
107
91
  */
108
92
  toNumber(): number {
109
- const value = this.toBigInt();
110
- if (value > Number.MAX_SAFE_INTEGER) {
111
- throw new Error(`Value ${value.toString(16)} greater than than max safe integer`);
93
+ if (this.asBigInt > Number.MAX_SAFE_INTEGER) {
94
+ throw new Error(`Value ${this.asBigInt.toString(16)} greater than than max safe integer`);
112
95
  }
113
- return Number(value);
96
+ return Number(this.asBigInt);
114
97
  }
115
98
 
116
99
  /**
@@ -118,8 +101,7 @@ abstract class BaseField {
118
101
  * May cause loss of precision if the underlying value is greater than MAX_SAFE_INTEGER.
119
102
  */
120
103
  toNumberUnsafe(): number {
121
- const value = this.toBigInt();
122
- return Number(value);
104
+ return Number(this.asBigInt);
123
105
  }
124
106
 
125
107
  toShortString(): string {
@@ -128,21 +110,24 @@ abstract class BaseField {
128
110
  }
129
111
 
130
112
  equals(rhs: BaseField): boolean {
131
- return this.toBuffer().equals(rhs.toBuffer());
113
+ return this.asBigInt === rhs.asBigInt;
132
114
  }
133
115
 
134
116
  lt(rhs: BaseField): boolean {
135
- return this.toBigInt() < rhs.toBigInt();
117
+ return this.asBigInt < rhs.asBigInt;
136
118
  }
137
119
 
138
120
  cmp(rhs: BaseField): -1 | 0 | 1 {
139
- const lhsBigInt = this.toBigInt();
140
- const rhsBigInt = rhs.toBigInt();
141
- return lhsBigInt === rhsBigInt ? 0 : lhsBigInt < rhsBigInt ? -1 : 1;
121
+ const rhsBigInt = rhs.asBigInt;
122
+ return this.asBigInt === rhsBigInt ? 0 : this.asBigInt < rhsBigInt ? -1 : 1;
123
+ }
124
+
125
+ static cmp(lhs: BaseField, rhs: BaseField): -1 | 0 | 1 {
126
+ return lhs.cmp(rhs);
142
127
  }
143
128
 
144
129
  isZero(): boolean {
145
- return this.toBuffer().equals(ZERO_BUFFER);
130
+ return this.asBigInt === 0n;
146
131
  }
147
132
 
148
133
  isEmpty(): boolean {
@@ -195,7 +180,7 @@ function fromHexString<T extends BaseField>(buf: string, f: DerivedField<T>) {
195
180
 
196
181
  const buffer = Buffer.from(checked.length % 2 === 1 ? '0' + checked : checked, 'hex');
197
182
 
198
- return new f(buffer);
183
+ return new f(toBigIntBE(buffer));
199
184
  }
200
185
 
201
186
  /** Branding to ensure fields are not interchangeable types. */
@@ -511,14 +496,6 @@ function extendedEuclidean(a: bigint, modulus: bigint): [bigint, bigint, bigint]
511
496
  }
512
497
  }
513
498
 
514
- /**
515
- * GrumpkinScalar is an Fq.
516
- * @remarks Called GrumpkinScalar because it is used to represent elements in Grumpkin's scalar field as defined in
517
- * the Aztec Protocol Specs.
518
- */
519
- export type GrumpkinScalar = Fq;
520
- export const GrumpkinScalar = Fq;
521
-
522
499
  /** Wraps a function that returns a buffer so that all results are reduced into a field of the given type. */
523
500
  export function reduceFn<TInput, TField extends BaseField>(fn: (input: TInput) => Buffer, field: DerivedField<TField>) {
524
501
  return (input: TInput) => fromBufferReduce(fn(input), field);
@@ -0,0 +1,2 @@
1
+ export * from './field.js';
2
+ export * from './point.js';
@@ -0,0 +1,170 @@
1
+ import {
2
+ BN254_G1_GENERATOR,
3
+ BN254_G2_GENERATOR,
4
+ BarretenbergSync,
5
+ type Bn254G1Point as BbApiBn254G1Point,
6
+ type Bn254G2Point as BbApiBn254G2Point,
7
+ } from '@aztec/bb.js';
8
+
9
+ import { Fq, Fr } from './field.js';
10
+
11
+ /**
12
+ * BN254 G1 point using foundation field classes.
13
+ * Represents a point on the BN254 elliptic curve in affine coordinates.
14
+ */
15
+ export class Bn254G1Point {
16
+ constructor(
17
+ public readonly x: Fq,
18
+ public readonly y: Fq,
19
+ ) {}
20
+
21
+ private toBbApiPoint(): BbApiBn254G1Point {
22
+ return {
23
+ x: this.x.toBuffer(),
24
+ y: this.y.toBuffer(),
25
+ };
26
+ }
27
+
28
+ private static fromBbApiPoint(point: BbApiBn254G1Point): Bn254G1Point {
29
+ return new Bn254G1Point(Fq.fromBuffer(Buffer.from(point.x)), Fq.fromBuffer(Buffer.from(point.y)));
30
+ }
31
+
32
+ async isOnCurve(): Promise<boolean> {
33
+ await BarretenbergSync.initSingleton();
34
+ const api = BarretenbergSync.getSingleton();
35
+
36
+ const apiPoint = this.toBbApiPoint();
37
+ const response = api.bn254G1IsOnCurve({ point: apiPoint });
38
+ return response.isOnCurve;
39
+ }
40
+
41
+ /**
42
+ * Get the generator point for BN254 G1, or perform scalar multiplication.
43
+ * When called without arguments, returns the base generator point.
44
+ * When called with a scalar, returns scalar * generator (useful for public key derivation).
45
+ */
46
+ static async generator(scalar?: Fr): Promise<Bn254G1Point> {
47
+ if (!scalar) {
48
+ return new Bn254G1Point(
49
+ Fq.fromBuffer(Buffer.from(BN254_G1_GENERATOR.x)),
50
+ Fq.fromBuffer(Buffer.from(BN254_G1_GENERATOR.y)),
51
+ );
52
+ }
53
+
54
+ await BarretenbergSync.initSingleton();
55
+ const api = BarretenbergSync.getSingleton();
56
+
57
+ const response = api.bn254G1Mul({
58
+ point: BN254_G1_GENERATOR,
59
+ scalar: scalar.toBuffer(),
60
+ });
61
+
62
+ return Bn254G1Point.fromBbApiPoint(response.point);
63
+ }
64
+
65
+ /**
66
+ * Decompress a BN254 G1 point from compressed form (32 bytes).
67
+ * The compressed format encodes the x-coordinate and the sign bit of the y-coordinate
68
+ * in the most significant bit.
69
+ */
70
+ static async fromCompressed(compressed: Buffer): Promise<Bn254G1Point> {
71
+ if (compressed.length !== 32) {
72
+ throw new Error('Invalid compressed point length');
73
+ }
74
+ await BarretenbergSync.initSingleton();
75
+ const api = BarretenbergSync.getSingleton();
76
+
77
+ const response = api.bn254G1FromCompressed({
78
+ compressed: new Uint8Array(compressed),
79
+ });
80
+
81
+ return Bn254G1Point.fromBbApiPoint(response.point);
82
+ }
83
+
84
+ /**
85
+ * Compress this BN254 G1 point to 32 bytes.
86
+ * The compressed format encodes the x-coordinate and the sign bit of the y-coordinate
87
+ * in the most significant bit (bit 255).
88
+ */
89
+ compress(): Buffer {
90
+ const xBytes = this.x.toBuffer();
91
+ // Get the least significant bit of y to determine the sign
92
+ const yLsb = this.y.toBigInt() & 1n;
93
+ // If y is odd, set the most significant bit (bit 255) of the output
94
+ if (yLsb === 1n) {
95
+ xBytes[0] |= 0x80;
96
+ }
97
+ return xBytes;
98
+ }
99
+
100
+ equals(other: Bn254G1Point): boolean {
101
+ return this.x.equals(other.x) && this.y.equals(other.y);
102
+ }
103
+
104
+ toString(): string {
105
+ return `Bn254G1Point(x: ${this.x.toString()}, y: ${this.y.toString()})`;
106
+ }
107
+ }
108
+
109
+ /**
110
+ * BN254 G2 point using foundation field classes.
111
+ * Represents a point on the BN254 G2 curve (twist curve) in affine coordinates.
112
+ * G2 points use extension field coordinates (Fq2).
113
+ */
114
+ export class Bn254G2Point {
115
+ constructor(
116
+ public readonly x: [Fq, Fq],
117
+ public readonly y: [Fq, Fq],
118
+ ) {}
119
+
120
+ private toBbApiPoint(): BbApiBn254G2Point {
121
+ return {
122
+ x: [this.x[0].toBuffer(), this.x[1].toBuffer()],
123
+ y: [this.y[0].toBuffer(), this.y[1].toBuffer()],
124
+ };
125
+ }
126
+
127
+ private static fromBbApiPoint(point: BbApiBn254G2Point): Bn254G2Point {
128
+ return new Bn254G2Point(
129
+ [Fq.fromBuffer(Buffer.from(point.x[0])), Fq.fromBuffer(Buffer.from(point.x[1]))],
130
+ [Fq.fromBuffer(Buffer.from(point.y[0])), Fq.fromBuffer(Buffer.from(point.y[1]))],
131
+ );
132
+ }
133
+
134
+ /**
135
+ * Get the generator point for BN254 G2, or perform scalar multiplication.
136
+ * When called without arguments, returns the base generator point.
137
+ * When called with a scalar, returns scalar * generator.
138
+ */
139
+ static async generator(scalar?: Fr): Promise<Bn254G2Point> {
140
+ if (!scalar) {
141
+ return new Bn254G2Point(
142
+ [Fq.fromBuffer(Buffer.from(BN254_G2_GENERATOR.x[0])), Fq.fromBuffer(Buffer.from(BN254_G2_GENERATOR.x[1]))],
143
+ [Fq.fromBuffer(Buffer.from(BN254_G2_GENERATOR.y[0])), Fq.fromBuffer(Buffer.from(BN254_G2_GENERATOR.y[1]))],
144
+ );
145
+ }
146
+
147
+ await BarretenbergSync.initSingleton();
148
+ const api = BarretenbergSync.getSingleton();
149
+
150
+ const response = api.bn254G2Mul({
151
+ point: BN254_G2_GENERATOR as BbApiBn254G2Point,
152
+ scalar: scalar.toBuffer(),
153
+ });
154
+
155
+ return Bn254G2Point.fromBbApiPoint(response.point);
156
+ }
157
+
158
+ equals(other: Bn254G2Point): boolean {
159
+ return (
160
+ this.x[0].equals(other.x[0]) &&
161
+ this.x[1].equals(other.x[1]) &&
162
+ this.y[0].equals(other.y[0]) &&
163
+ this.y[1].equals(other.y[1])
164
+ );
165
+ }
166
+
167
+ toString(): string {
168
+ return `Bn254G2Point(x: (${this.x[0].toString()}, ${this.x[1].toString()}), y: (${this.y[0].toString()}, ${this.y[1].toString()}))`;
169
+ }
170
+ }
@@ -0,0 +1,11 @@
1
+ import { Fq } from '../bn254/field.js';
2
+
3
+ export * from './point.js';
4
+
5
+ /**
6
+ * GrumpkinScalar is an Fq.
7
+ * @remarks Called GrumpkinScalar because it is used to represent elements in Grumpkin's scalar field as defined in
8
+ * the Aztec Protocol Specs.
9
+ */
10
+ export type GrumpkinScalar = Fq;
11
+ export const GrumpkinScalar = Fq;
@@ -1,10 +1,10 @@
1
- import { toBigIntBE } from '../bigint-buffer/index.js';
2
- import { poseidon2Hash } from '../crypto/poseidon/index.js';
3
- import { randomBoolean } from '../crypto/random/index.js';
4
- import { hexSchemaFor } from '../schemas/utils.js';
5
- import { BufferReader, FieldReader, serializeToBuffer } from '../serialize/index.js';
6
- import { bufferToHex, hexToBuffer } from '../string/index.js';
7
- import { Fr } from './fields.js';
1
+ import { toBigIntBE } from '../../bigint-buffer/index.js';
2
+ import { poseidon2Hash } from '../../crypto/poseidon/index.js';
3
+ import { randomBoolean } from '../../crypto/random/index.js';
4
+ import { hexSchemaFor } from '../../schemas/utils.js';
5
+ import { BufferReader, FieldReader, serializeToBuffer } from '../../serialize/index.js';
6
+ import { bufferToHex, hexToBuffer } from '../../string/index.js';
7
+ import { Fr } from '../bn254/field.js';
8
8
 
9
9
  /**
10
10
  * Represents a Point on an elliptic curve with x and y coordinates.
@@ -2,7 +2,7 @@ import { inspect } from 'util';
2
2
 
3
3
  import { keccak256String } from '../crypto/keccak/index.js';
4
4
  import { randomBytes } from '../crypto/random/index.js';
5
- import { Fr } from '../fields/index.js';
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
8
  import { TypeRegistry } from '../serialize/type_registry.js';
@@ -249,7 +249,7 @@ export class EthAddress {
249
249
  /** Converts a number into an address. Useful for testing. */
250
250
  static fromNumber(num: bigint | number): EthAddress {
251
251
  const buffer = Buffer.alloc(EthAddress.SIZE_IN_BYTES);
252
- buffer.writeBigUInt64BE(BigInt(num), 0);
252
+ buffer.writeBigUInt64BE(BigInt(num), EthAddress.SIZE_IN_BYTES - 8);
253
253
  return new EthAddress(buffer);
254
254
  }
255
255
 
@@ -261,6 +261,12 @@ export class EthAddress {
261
261
  // Serialization from hex string.
262
262
  return hexSchemaFor(EthAddress, EthAddress.isAddress);
263
263
  }
264
+
265
+ static areEqual(a: EthAddress | string, b: EthAddress | string) {
266
+ const addrA = typeof a === 'string' ? EthAddress.fromString(a) : a;
267
+ const addrB = typeof b === 'string' ? EthAddress.fromString(b) : b;
268
+ return addrA.equals(addrB);
269
+ }
264
270
  }
265
271
 
266
272
  // For deserializing JSON.
@@ -0,0 +1,11 @@
1
+ /** Wraps an async iterable iterator such that it filters values based on a predicate. */
2
+ export async function* filter<T>(
3
+ iterator: AsyncIterableIterator<T>,
4
+ predicate: (item: T) => boolean | Promise<boolean>,
5
+ ): AsyncIterableIterator<T> {
6
+ for await (const item of iterator) {
7
+ if (await predicate(item)) {
8
+ yield item;
9
+ }
10
+ }
11
+ }
@@ -0,0 +1 @@
1
+ export { filter } from './filter.js';
@@ -1,3 +1,5 @@
1
+ import { promisify } from 'node:util';
2
+ import { gunzip as gunzipCb, gzip as gzipCb } from 'node:zlib';
1
3
  import { Agent, type Dispatcher } from 'undici';
2
4
 
3
5
  import { createLogger } from '../../log/pino-logger.js';
@@ -5,8 +7,14 @@ import { NoRetryError } from '../../retry/index.js';
5
7
  import { jsonStringify } from '../convert.js';
6
8
  import type { JsonRpcFetch } from './fetch.js';
7
9
 
10
+ const gzip = promisify(gzipCb);
11
+ const gunzip = promisify(gunzipCb);
12
+
8
13
  const log = createLogger('json-rpc:json_rpc_client:undici');
9
14
 
15
+ /** Minimum request size in bytes to trigger compression. */
16
+ const COMPRESSION_THRESHOLD = 1024;
17
+
10
18
  export { Agent };
11
19
 
12
20
  export function makeUndiciFetch(client = new Agent()): JsonRpcFetch {
@@ -14,14 +22,18 @@ export function makeUndiciFetch(client = new Agent()): JsonRpcFetch {
14
22
  log.trace(`JsonRpcClient.fetch: ${host}`, { host, body });
15
23
  let resp: Dispatcher.ResponseData;
16
24
  try {
25
+ const jsonBody = Buffer.from(jsonStringify(body));
26
+ const shouldCompress = jsonBody.length >= COMPRESSION_THRESHOLD;
17
27
  resp = await client.request({
18
28
  method: 'POST',
19
29
  origin: new URL(host),
20
30
  path: '/',
21
- body: jsonStringify(body),
31
+ body: shouldCompress ? await gzip(jsonBody) : jsonBody,
22
32
  headers: {
23
33
  ...extraHeaders,
24
34
  'content-type': 'application/json',
35
+ ...(shouldCompress && { 'content-encoding': 'gzip' }),
36
+ 'accept-encoding': 'gzip',
25
37
  },
26
38
  });
27
39
  } catch (err) {
@@ -31,13 +43,19 @@ export function makeUndiciFetch(client = new Agent()): JsonRpcFetch {
31
43
 
32
44
  let responseJson: any;
33
45
  const responseOk = resp.statusCode >= 200 && resp.statusCode <= 299;
46
+ const contentEncoding = resp.headers['content-encoding'];
34
47
  try {
35
- responseJson = await resp.body.json();
48
+ if (contentEncoding === 'gzip') {
49
+ const jsonBuffer = await gunzip(await resp.body.arrayBuffer());
50
+ responseJson = JSON.parse(jsonBuffer.toString('utf-8'));
51
+ } else {
52
+ responseJson = await resp.body.json();
53
+ }
36
54
  } catch {
37
55
  if (!responseOk) {
38
56
  throw new Error('HTTP ' + resp.statusCode);
39
57
  }
40
- throw new Error(`Failed to parse body as JSON: ${await resp.body.text()}`);
58
+ throw new Error(`Failed to parse body as JSON. encoding: ${contentEncoding}, body: ${await resp.body.text()}`);
41
59
  }
42
60
 
43
61
  if (!responseOk) {
@@ -35,7 +35,7 @@ export type SafeJsonRpcServerConfig = {
35
35
  const defaultServerConfig: SafeJsonRpcServerConfig = {
36
36
  http200OnError: false,
37
37
  maxBatchSize: 100,
38
- maxBodySizeBytes: '50mb',
38
+ maxBodySizeBytes: '1mb',
39
39
  };
40
40
 
41
41
  export class SafeJsonRpcServer {
@@ -5,7 +5,8 @@ import type { Writable } from 'stream';
5
5
  import { inspect } from 'util';
6
6
 
7
7
  import { compactArray } from '../collection/array.js';
8
- import { type EnvVar, parseBooleanEnv } from '../config/index.js';
8
+ import type { EnvVar } from '../config/index.js';
9
+ import { parseBooleanEnv } from '../config/parse-env.js';
9
10
  import { GoogleCloudLoggerConfig } from './gcloud-logger-config.js';
10
11
  import { getLogLevelFromFilters, parseEnv } from './log-filters.js';
11
12
  import type { LogLevel } from './log-levels.js';
@@ -103,3 +103,21 @@ export async function retryUntil<T>(
103
103
  }
104
104
  }
105
105
  }
106
+
107
+ /**
108
+ * Convenience wrapper around retryUntil with fast polling for tests.
109
+ * Uses 10s timeout and 100ms polling interval by default.
110
+ *
111
+ * @param fn - The function to retry until it returns a truthy value.
112
+ * @param name - Description of what we're waiting for (for error messages).
113
+ * @param timeout - Optional timeout in seconds. Defaults to 10s.
114
+ * @param interval - Optional interval in seconds. Defaults to 0.1s (100ms).
115
+ */
116
+ export function retryFastUntil<T>(
117
+ fn: () => (T | undefined) | Promise<T | undefined>,
118
+ name = '',
119
+ timeout = 10,
120
+ interval = 0.1,
121
+ ) {
122
+ return retryUntil(fn, name, timeout, interval);
123
+ }
@@ -4,10 +4,10 @@ import { EpochNumber, EpochNumberSchema } from '../branded-types/epoch.js';
4
4
  import { SlotNumber, SlotNumberSchema } from '../branded-types/slot.js';
5
5
  import { Buffer32 } from '../buffer/buffer32.js';
6
6
  import { SecretValue } from '../config/secret_value.js';
7
+ import { Fq, Fr } from '../curves/bn254/field.js';
8
+ import { Point } from '../curves/grumpkin/point.js';
7
9
  import { EthAddress } from '../eth-address/index.js';
8
- import { Fq, Fr } from '../fields/fields.js';
9
- import { Point } from '../fields/point.js';
10
- import { isHex, withoutHexPrefix } from '../string/index.js';
10
+ import { isHex, withHexPrefix, withoutHexPrefix } from '../string/index.js';
11
11
  import { bufferSchema, hexSchema } from './utils.js';
12
12
 
13
13
  export const schemas = {
@@ -58,6 +58,14 @@ export const schemas = {
58
58
  .max(2 ** 32 - 1),
59
59
  ),
60
60
 
61
+ /** Coerces input to UInt64. */
62
+ UInt64: z.union([z.bigint(), z.number(), z.string()]).pipe(
63
+ z.coerce
64
+ .bigint()
65
+ .min(0n)
66
+ .max(2n ** 64n - 1n),
67
+ ),
68
+
61
69
  /** Accepts a hex string as a Buffer32 type. */
62
70
  Buffer32: z.string().refine(isHex, 'Not a valid hex string').transform(Buffer32.fromString),
63
71
 
@@ -74,6 +82,9 @@ export const schemas = {
74
82
  /** Hex string with an optional 0x prefix which gets removed as part of the parsing. */
75
83
  HexString: hexSchema,
76
84
 
85
+ /** Hex string with an optional 0x prefix which gets enforced as part of the parsing. */
86
+ HexStringWith0x: z.string().refine(isHex, 'Not a valid hex string').transform(withHexPrefix),
87
+
77
88
  /** A secret config value */
78
89
  SecretValue: SecretValue.schema,
79
90
  };
@@ -1,3 +1,36 @@
1
1
  import type { ZodType } from 'zod';
2
2
 
3
3
  export type ZodFor<T> = ZodType<T, any, any>;
4
+
5
+ /**
6
+ * Creates a schema validator that enforces all properties of type T are present in the schema.
7
+ * This provides compile-time safety to ensure schemas don't miss optional properties.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * interface MyConfig {
12
+ * foo: string;
13
+ * bar?: number;
14
+ * }
15
+ *
16
+ * // ✅ This will work - all keys present
17
+ * const schema1 = zodFor<MyConfig>()(z.object({
18
+ * foo: z.string(),
19
+ * bar: z.number().optional(),
20
+ * }));
21
+ *
22
+ * // ❌ This will error - 'bar' is missing
23
+ * const schema2 = zodFor<MyConfig>()(z.object({
24
+ * foo: z.string(),
25
+ * }));
26
+ * ```
27
+ */
28
+ export function zodFor<T>() {
29
+ return (schema => schema) as <S extends ZodType<any, any, any>>(
30
+ schema: keyof T extends keyof S['_output']
31
+ ? keyof S['_output'] extends keyof T
32
+ ? S
33
+ : S & { __error__: 'Schema has extra keys not in type'; __extra__: Exclude<keyof S['_output'], keyof T> }
34
+ : S & { __error__: 'Schema is missing keys from type'; __missing__: Exclude<keyof T, keyof S['_output']> },
35
+ ) => S;
36
+ }
@@ -224,15 +224,22 @@ export class BufferReader {
224
224
  * deserializing each one using the 'fromBuffer' method of 'itemDeserializer'.
225
225
  *
226
226
  * @param itemDeserializer - Object with 'fromBuffer' method to deserialize vector elements.
227
+ * @param maxSize - Optional maximum allowed size for the vector. If the size exceeds this, an error is thrown.
227
228
  * @returns An array of deserialized elements of type T.
228
229
  */
229
- public readVector<T>(itemDeserializer: {
230
- /**
231
- * A method to deserialize data from a buffer.
232
- */
233
- fromBuffer: (reader: BufferReader) => T;
234
- }): T[] {
230
+ public readVector<T>(
231
+ itemDeserializer: {
232
+ /**
233
+ * A method to deserialize data from a buffer.
234
+ */
235
+ fromBuffer: (reader: BufferReader) => T;
236
+ },
237
+ maxSize?: number,
238
+ ): T[] {
235
239
  const size = this.readNumber();
240
+ if (maxSize !== undefined && size > maxSize) {
241
+ throw new Error(`Vector size ${size} exceeds maximum allowed ${maxSize}`);
242
+ }
236
243
  const result = new Array<T>(size);
237
244
  for (let i = 0; i < size; i++) {
238
245
  result[i] = itemDeserializer.fromBuffer(this);
@@ -344,10 +351,11 @@ export class BufferReader {
344
351
  * The method first reads the size of the string, then reads the corresponding
345
352
  * number of bytes from the buffer and converts them to a string.
346
353
  *
354
+ * @param maxSize - Optional maximum allowed size for the string buffer. If the size exceeds this, an error is thrown.
347
355
  * @returns The read string from the buffer.
348
356
  */
349
- public readString(): string {
350
- return this.readBuffer().toString();
357
+ public readString(maxSize?: number): string {
358
+ return this.readBuffer(maxSize).toString();
351
359
  }
352
360
 
353
361
  /**
@@ -356,10 +364,14 @@ export class BufferReader {
356
364
  * a Buffer with that size containing the bytes. Useful for reading variable-length
357
365
  * binary data encoded as (size, data) format.
358
366
  *
367
+ * @param maxSize - Optional maximum allowed size for the buffer. If the size exceeds this, an error is thrown.
359
368
  * @returns A Buffer containing the read bytes.
360
369
  */
361
- public readBuffer(): Buffer {
370
+ public readBuffer(maxSize?: number): Buffer {
362
371
  const size = this.readNumber();
372
+ if (maxSize !== undefined && size > maxSize) {
373
+ throw new Error(`Buffer size ${size} exceeds maximum allowed ${maxSize}`);
374
+ }
363
375
  this.#rangeCheck(size);
364
376
  return this.readBytes(size);
365
377
  }