@aztec/foundation 0.0.1-commit.21ecf947b → 0.0.1-commit.2448fdb

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 (86) hide show
  1. package/dest/branded-types/slot.d.ts +4 -1
  2. package/dest/branded-types/slot.d.ts.map +1 -1
  3. package/dest/branded-types/slot.js +3 -0
  4. package/dest/buffer/index.d.ts +2 -1
  5. package/dest/buffer/index.d.ts.map +1 -1
  6. package/dest/buffer/index.js +1 -0
  7. package/dest/buffer/utils.d.ts +3 -0
  8. package/dest/buffer/utils.d.ts.map +1 -0
  9. package/dest/buffer/utils.js +7 -0
  10. package/dest/collection/array.d.ts +3 -1
  11. package/dest/collection/array.d.ts.map +1 -1
  12. package/dest/collection/array.js +15 -0
  13. package/dest/config/env_var.d.ts +2 -2
  14. package/dest/config/env_var.d.ts.map +1 -1
  15. package/dest/config/index.d.ts +1 -1
  16. package/dest/config/index.d.ts.map +1 -1
  17. package/dest/config/index.js +15 -0
  18. package/dest/config/network_config.d.ts +19 -1
  19. package/dest/config/network_config.d.ts.map +1 -1
  20. package/dest/config/network_config.js +4 -1
  21. package/dest/crypto/poseidon/index.d.ts +1 -1
  22. package/dest/crypto/poseidon/index.d.ts.map +1 -1
  23. package/dest/crypto/poseidon/index.js +40 -33
  24. package/dest/crypto/secp256k1-signer/utils.d.ts +12 -1
  25. package/dest/crypto/secp256k1-signer/utils.d.ts.map +1 -1
  26. package/dest/crypto/secp256k1-signer/utils.js +26 -0
  27. package/dest/curves/bn254/field.d.ts +2 -1
  28. package/dest/curves/bn254/field.d.ts.map +1 -1
  29. package/dest/curves/bn254/field.js +5 -2
  30. package/dest/curves/grumpkin/point.d.ts +4 -4
  31. package/dest/curves/grumpkin/point.d.ts.map +1 -1
  32. package/dest/curves/grumpkin/point.js +7 -4
  33. package/dest/eth-signature/eth_signature.d.ts +2 -1
  34. package/dest/eth-signature/eth_signature.d.ts.map +1 -1
  35. package/dest/eth-signature/eth_signature.js +7 -2
  36. package/dest/json-rpc/client/safe_json_rpc_client.d.ts +2 -1
  37. package/dest/json-rpc/client/safe_json_rpc_client.d.ts.map +1 -1
  38. package/dest/json-rpc/client/safe_json_rpc_client.js +1 -1
  39. package/dest/json-rpc/server/api_key_auth.d.ts +19 -0
  40. package/dest/json-rpc/server/api_key_auth.d.ts.map +1 -0
  41. package/dest/json-rpc/server/api_key_auth.js +57 -0
  42. package/dest/json-rpc/server/index.d.ts +2 -1
  43. package/dest/json-rpc/server/index.d.ts.map +1 -1
  44. package/dest/json-rpc/server/index.js +1 -0
  45. package/dest/log/bigint-utils.d.ts +5 -0
  46. package/dest/log/bigint-utils.d.ts.map +1 -0
  47. package/dest/log/bigint-utils.js +21 -0
  48. package/dest/log/gcloud-logger-config.d.ts +1 -1
  49. package/dest/log/gcloud-logger-config.d.ts.map +1 -1
  50. package/dest/log/gcloud-logger-config.js +3 -0
  51. package/dest/log/pino-logger.d.ts +1 -1
  52. package/dest/log/pino-logger.d.ts.map +1 -1
  53. package/dest/log/pino-logger.js +4 -0
  54. package/dest/schemas/api.d.ts +2 -2
  55. package/dest/schemas/api.d.ts.map +1 -1
  56. package/dest/serialize/buffer_reader.d.ts +20 -7
  57. package/dest/serialize/buffer_reader.d.ts.map +1 -1
  58. package/dest/serialize/buffer_reader.js +18 -5
  59. package/dest/serialize/field_reader.d.ts +13 -5
  60. package/dest/serialize/field_reader.d.ts.map +1 -1
  61. package/dest/serialize/field_reader.js +13 -0
  62. package/dest/transport/transport_client.js +2 -2
  63. package/package.json +2 -2
  64. package/src/branded-types/slot.ts +5 -0
  65. package/src/buffer/index.ts +1 -0
  66. package/src/buffer/utils.ts +8 -0
  67. package/src/collection/array.ts +14 -0
  68. package/src/config/env_var.ts +20 -4
  69. package/src/config/index.ts +15 -0
  70. package/src/config/network_config.ts +3 -0
  71. package/src/crypto/poseidon/index.ts +42 -34
  72. package/src/crypto/secp256k1-signer/utils.ts +32 -0
  73. package/src/curves/bn254/field.ts +6 -2
  74. package/src/curves/grumpkin/point.ts +6 -3
  75. package/src/eth-signature/eth_signature.ts +7 -1
  76. package/src/json-rpc/client/safe_json_rpc_client.ts +2 -0
  77. package/src/json-rpc/server/api_key_auth.ts +63 -0
  78. package/src/json-rpc/server/index.ts +1 -0
  79. package/src/log/bigint-utils.ts +25 -0
  80. package/src/log/gcloud-logger-config.ts +5 -0
  81. package/src/log/pino-logger.ts +4 -0
  82. package/src/schemas/api.ts +4 -1
  83. package/src/serialize/buffer_reader.ts +29 -6
  84. package/src/serialize/field_reader.ts +22 -4
  85. package/src/transport/transport_client.ts +2 -2
  86. package/src/trees/membership_witness.ts +2 -2
@@ -224,15 +224,28 @@ import { toBigIntBE } from '../bigint-buffer/index.js';
224
224
  return result;
225
225
  }
226
226
  /**
227
- * Read an array of a fixed size with elements of type T from the buffer.
228
- * The 'itemDeserializer' object should have a 'fromBuffer' method that takes a BufferReader instance as input,
229
- * and returns an instance of the desired deserialized data type T.
230
- * This method will call the 'fromBuffer' method for each element in the array and return the resulting array.
227
+ * Read an array from the buffer using lazy allocation (new Array + loop).
228
+ * Safe for use with untrusted sizes does not pre-allocate memory proportional to size.
231
229
  *
232
- * @param size - The fixed number of elements in the array.
230
+ * @param size - The number of elements to read.
233
231
  * @param itemDeserializer - An object with a 'fromBuffer' method to deserialize individual elements of type T.
234
232
  * @returns An array of instances of type T.
235
233
  */ readArray(size, itemDeserializer) {
234
+ const result = new Array(size);
235
+ for(let i = 0; i < size; i++){
236
+ result[i] = itemDeserializer.fromBuffer(this);
237
+ }
238
+ return result;
239
+ }
240
+ /**
241
+ * Read a fixed-size tuple from the buffer using dense allocation (Array.from).
242
+ * Only use with compile-time constant sizes — the size parameter MUST NOT come from untrusted input
243
+ * as Array.from pre-allocates memory proportional to size.
244
+ *
245
+ * @param size - The fixed number of elements (must be a compile-time constant).
246
+ * @param itemDeserializer - An object with a 'fromBuffer' method to deserialize individual elements of type T.
247
+ * @returns A densely-allocated tuple of instances of type T.
248
+ */ readTuple(size, itemDeserializer) {
236
249
  const result = Array.from({
237
250
  length: size
238
251
  }, ()=>itemDeserializer.fromBuffer(this));
@@ -93,10 +93,18 @@ export declare class FieldReader {
93
93
  * @param itemDeserializer - An object with a 'fromFields' method to deserialize individual elements of type T.
94
94
  * @returns An array of instances of type T.
95
95
  */
96
- readArray<T, N extends number>(size: N, itemDeserializer: {
97
- /**
98
- * A function for deserializing data from a FieldReader instance.
99
- */
96
+ /**
97
+ * Read an array from the field array using lazy allocation (new Array + loop).
98
+ * Safe for use with untrusted sizes.
99
+ */
100
+ readArray<T>(size: number, itemDeserializer: {
101
+ fromFields: (reader: FieldReader) => T;
102
+ }): T[];
103
+ /**
104
+ * Read a fixed-size tuple from the field array using dense allocation (Array.from).
105
+ * Only use with compile-time constant sizes — the size parameter MUST NOT come from untrusted input.
106
+ */
107
+ readTuple<T, N extends number>(size: N, itemDeserializer: {
100
108
  fromFields: (reader: FieldReader) => T;
101
109
  }): Tuple<T, N>;
102
110
  /**
@@ -118,4 +126,4 @@ export declare class FieldReader {
118
126
  */
119
127
  isFinished(): boolean;
120
128
  }
121
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZmllbGRfcmVhZGVyLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvc2VyaWFsaXplL2ZpZWxkX3JlYWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsRUFBRSxFQUFFLEtBQUssRUFBRSxFQUFFLE1BQU0sMEJBQTBCLENBQUM7QUFDdkQsT0FBTyxLQUFLLEVBQUUsS0FBSyxFQUFFLE1BQU0sWUFBWSxDQUFDO0FBRXhDOzs7Ozs7O0dBT0c7QUFDSCxxQkFBYSxXQUFXO0lBS3BCLE9BQU8sQ0FBQyxNQUFNO0lBSmhCLE9BQU8sQ0FBQyxLQUFLLENBQVM7SUFDdEIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQVM7SUFFaEMsWUFDVSxNQUFNLEVBQUUsRUFBRSxFQUFFLEVBQ3BCLE1BQU0sU0FBSSxFQU9YO0lBRUQ7Ozs7O09BS0c7SUFDSCxPQUFjLFFBQVEsQ0FBQyxNQUFNLEVBQUUsRUFBRSxFQUFFLEdBQUcsV0FBVyxHQUFHLFdBQVcsQ0FNOUQ7SUFFRDs7OztPQUlHO0lBQ0gsSUFBVyxNQUFNLFdBRWhCO0lBRU0sZUFBZSxJQUFJLE1BQU0sQ0FFL0I7SUFFRDs7OztPQUlHO0lBQ0ksSUFBSSxDQUFDLENBQUMsRUFBRSxNQUFNLFFBS3BCO0lBRUQ7Ozs7T0FJRztJQUNJLFNBQVMsSUFBSSxFQUFFLENBS3JCO0lBRUQ7Ozs7T0FJRztJQUNJLFNBQVMsSUFBSSxFQUFFLENBS3JCO0lBRUQ7Ozs7T0FJRztJQUNJLE1BQU0sSUFBSSxFQUFFLENBRWxCO0lBRUQ7Ozs7Ozs7T0FPRztJQUNJLFdBQVcsSUFBSSxPQUFPLENBTzVCO0lBRUQ7Ozs7OztPQU1HO0lBQ0ksT0FBTyxJQUFJLE1BQU0sQ0FPdkI7SUFFRDs7Ozs7O09BTUc7SUFDSSxPQUFPLElBQUksTUFBTSxDQU92QjtJQUVEOzs7OztPQUtHO0lBQ0ksY0FBYyxDQUFDLENBQUMsU0FBUyxNQUFNLEVBQUUsSUFBSSxFQUFFLENBQUMsR0FBRyxLQUFLLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxDQU03RDtJQUVEOzs7Ozs7Ozs7T0FTRztJQUNJLFNBQVMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxTQUFTLE1BQU0sRUFDbEMsSUFBSSxFQUFFLENBQUMsRUFDUCxnQkFBZ0IsRUFBRTtRQUNoQjs7V0FFRztRQUNILFVBQVUsRUFBRSxDQUFDLE1BQU0sRUFBRSxXQUFXLEtBQUssQ0FBQyxDQUFDO0tBQ3hDLEdBQ0EsS0FBSyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FHYjtJQUVEOzs7Ozs7T0FNRztJQUNJLFVBQVUsQ0FBQyxDQUFDLEVBQUUsWUFBWSxFQUFFO1FBQ2pDOztXQUVHO1FBQ0gsVUFBVSxFQUFFLENBQUMsTUFBTSxFQUFFLFdBQVcsS0FBSyxDQUFDLENBQUM7S0FDeEMsR0FBRyxDQUFDLENBRUo7SUFFRDs7O09BR0c7SUFDSSxVQUFVLElBQUksT0FBTyxDQUUzQjtDQUNGIn0=
129
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZmllbGRfcmVhZGVyLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvc2VyaWFsaXplL2ZpZWxkX3JlYWRlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsRUFBRSxFQUFFLEtBQUssRUFBRSxFQUFFLE1BQU0sMEJBQTBCLENBQUM7QUFDdkQsT0FBTyxLQUFLLEVBQUUsS0FBSyxFQUFFLE1BQU0sWUFBWSxDQUFDO0FBRXhDOzs7Ozs7O0dBT0c7QUFDSCxxQkFBYSxXQUFXO0lBS3BCLE9BQU8sQ0FBQyxNQUFNO0lBSmhCLE9BQU8sQ0FBQyxLQUFLLENBQVM7SUFDdEIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQVM7SUFFaEMsWUFDVSxNQUFNLEVBQUUsRUFBRSxFQUFFLEVBQ3BCLE1BQU0sU0FBSSxFQU9YO0lBRUQ7Ozs7O09BS0c7SUFDSCxPQUFjLFFBQVEsQ0FBQyxNQUFNLEVBQUUsRUFBRSxFQUFFLEdBQUcsV0FBVyxHQUFHLFdBQVcsQ0FNOUQ7SUFFRDs7OztPQUlHO0lBQ0gsSUFBVyxNQUFNLFdBRWhCO0lBRU0sZUFBZSxJQUFJLE1BQU0sQ0FFL0I7SUFFRDs7OztPQUlHO0lBQ0ksSUFBSSxDQUFDLENBQUMsRUFBRSxNQUFNLFFBS3BCO0lBRUQ7Ozs7T0FJRztJQUNJLFNBQVMsSUFBSSxFQUFFLENBS3JCO0lBRUQ7Ozs7T0FJRztJQUNJLFNBQVMsSUFBSSxFQUFFLENBS3JCO0lBRUQ7Ozs7T0FJRztJQUNJLE1BQU0sSUFBSSxFQUFFLENBRWxCO0lBRUQ7Ozs7Ozs7T0FPRztJQUNJLFdBQVcsSUFBSSxPQUFPLENBTzVCO0lBRUQ7Ozs7OztPQU1HO0lBQ0ksT0FBTyxJQUFJLE1BQU0sQ0FPdkI7SUFFRDs7Ozs7O09BTUc7SUFDSSxPQUFPLElBQUksTUFBTSxDQU92QjtJQUVEOzs7OztPQUtHO0lBQ0ksY0FBYyxDQUFDLENBQUMsU0FBUyxNQUFNLEVBQUUsSUFBSSxFQUFFLENBQUMsR0FBRyxLQUFLLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxDQU03RDtJQUVEOzs7Ozs7Ozs7T0FTRztJQUNIOzs7T0FHRztJQUNJLFNBQVMsQ0FBQyxDQUFDLEVBQ2hCLElBQUksRUFBRSxNQUFNLEVBQ1osZ0JBQWdCLEVBQUU7UUFDaEIsVUFBVSxFQUFFLENBQUMsTUFBTSxFQUFFLFdBQVcsS0FBSyxDQUFDLENBQUM7S0FDeEMsR0FDQSxDQUFDLEVBQUUsQ0FNTDtJQUVEOzs7T0FHRztJQUNJLFNBQVMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxTQUFTLE1BQU0sRUFDbEMsSUFBSSxFQUFFLENBQUMsRUFDUCxnQkFBZ0IsRUFBRTtRQUNoQixVQUFVLEVBQUUsQ0FBQyxNQUFNLEVBQUUsV0FBVyxLQUFLLENBQUMsQ0FBQztLQUN4QyxHQUNBLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBR2I7SUFFRDs7Ozs7O09BTUc7SUFDSSxVQUFVLENBQUMsQ0FBQyxFQUFFLFlBQVksRUFBRTtRQUNqQzs7V0FFRztRQUNILFVBQVUsRUFBRSxDQUFDLE1BQU0sRUFBRSxXQUFXLEtBQUssQ0FBQyxDQUFDO0tBQ3hDLEdBQUcsQ0FBQyxDQUVKO0lBRUQ7OztPQUdHO0lBQ0ksVUFBVSxJQUFJLE9BQU8sQ0FFM0I7Q0FDRiJ9
@@ -1 +1 @@
1
- {"version":3,"file":"field_reader.d.ts","sourceRoot":"","sources":["../../src/serialize/field_reader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;GAOG;AACH,qBAAa,WAAW;IAKpB,OAAO,CAAC,MAAM;IAJhB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC,YACU,MAAM,EAAE,EAAE,EAAE,EACpB,MAAM,SAAI,EAOX;IAED;;;;;OAKG;IACH,OAAc,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,GAAG,WAAW,GAAG,WAAW,CAM9D;IAED;;;;OAIG;IACH,IAAW,MAAM,WAEhB;IAEM,eAAe,IAAI,MAAM,CAE/B;IAED;;;;OAIG;IACI,IAAI,CAAC,CAAC,EAAE,MAAM,QAKpB;IAED;;;;OAIG;IACI,SAAS,IAAI,EAAE,CAKrB;IAED;;;;OAIG;IACI,SAAS,IAAI,EAAE,CAKrB;IAED;;;;OAIG;IACI,MAAM,IAAI,EAAE,CAElB;IAED;;;;;;;OAOG;IACI,WAAW,IAAI,OAAO,CAO5B;IAED;;;;;;OAMG;IACI,OAAO,IAAI,MAAM,CAOvB;IAED;;;;;;OAMG;IACI,OAAO,IAAI,MAAM,CAOvB;IAED;;;;;OAKG;IACI,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAM7D;IAED;;;;;;;;;OASG;IACI,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,EAClC,IAAI,EAAE,CAAC,EACP,gBAAgB,EAAE;QAChB;;WAEG;QACH,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAAC,CAAC;KACxC,GACA,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAGb;IAED;;;;;;OAMG;IACI,UAAU,CAAC,CAAC,EAAE,YAAY,EAAE;QACjC;;WAEG;QACH,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAAC,CAAC;KACxC,GAAG,CAAC,CAEJ;IAED;;;OAGG;IACI,UAAU,IAAI,OAAO,CAE3B;CACF"}
1
+ {"version":3,"file":"field_reader.d.ts","sourceRoot":"","sources":["../../src/serialize/field_reader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;;;;;;GAOG;AACH,qBAAa,WAAW;IAKpB,OAAO,CAAC,MAAM;IAJhB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC,YACU,MAAM,EAAE,EAAE,EAAE,EACpB,MAAM,SAAI,EAOX;IAED;;;;;OAKG;IACH,OAAc,QAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,GAAG,WAAW,GAAG,WAAW,CAM9D;IAED;;;;OAIG;IACH,IAAW,MAAM,WAEhB;IAEM,eAAe,IAAI,MAAM,CAE/B;IAED;;;;OAIG;IACI,IAAI,CAAC,CAAC,EAAE,MAAM,QAKpB;IAED;;;;OAIG;IACI,SAAS,IAAI,EAAE,CAKrB;IAED;;;;OAIG;IACI,SAAS,IAAI,EAAE,CAKrB;IAED;;;;OAIG;IACI,MAAM,IAAI,EAAE,CAElB;IAED;;;;;;;OAOG;IACI,WAAW,IAAI,OAAO,CAO5B;IAED;;;;;;OAMG;IACI,OAAO,IAAI,MAAM,CAOvB;IAED;;;;;;OAMG;IACI,OAAO,IAAI,MAAM,CAOvB;IAED;;;;;OAKG;IACI,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAM7D;IAED;;;;;;;;;OASG;IACH;;;OAGG;IACI,SAAS,CAAC,CAAC,EAChB,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE;QAChB,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAAC,CAAC;KACxC,GACA,CAAC,EAAE,CAML;IAED;;;OAGG;IACI,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,EAClC,IAAI,EAAE,CAAC,EACP,gBAAgB,EAAE;QAChB,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAAC,CAAC;KACxC,GACA,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAGb;IAED;;;;;;OAMG;IACI,UAAU,CAAC,CAAC,EAAE,YAAY,EAAE;QACjC;;WAEG;QACH,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,CAAC,CAAC;KACxC,GAAG,CAAC,CAEJ;IAED;;;OAGG;IACI,UAAU,IAAI,OAAO,CAE3B;CACF"}
@@ -140,7 +140,20 @@ import { Fq } from '../curves/bn254/field.js';
140
140
  * @param size - The fixed number of elements in the array.
141
141
  * @param itemDeserializer - An object with a 'fromFields' method to deserialize individual elements of type T.
142
142
  * @returns An array of instances of type T.
143
+ */ /**
144
+ * Read an array from the field array using lazy allocation (new Array + loop).
145
+ * Safe for use with untrusted sizes.
143
146
  */ readArray(size, itemDeserializer) {
147
+ const result = new Array(size);
148
+ for(let i = 0; i < size; i++){
149
+ result[i] = itemDeserializer.fromFields(this);
150
+ }
151
+ return result;
152
+ }
153
+ /**
154
+ * Read a fixed-size tuple from the field array using dense allocation (Array.from).
155
+ * Only use with compile-time constant sizes — the size parameter MUST NOT come from untrusted input.
156
+ */ readTuple(size, itemDeserializer) {
144
157
  const result = Array.from({
145
158
  length: size
146
159
  }, ()=>itemDeserializer.fromFields(this));
@@ -55,7 +55,7 @@ const log = createLogger('foundation:transport_client');
55
55
  msgId,
56
56
  payload
57
57
  };
58
- log.debug(format(`->`, msg));
58
+ log.trace(format(`->`, msg));
59
59
  return new Promise((resolve, reject)=>{
60
60
  this.pendingRequests.push({
61
61
  resolve,
@@ -77,7 +77,7 @@ const log = createLogger('foundation:transport_client');
77
77
  this.close();
78
78
  return;
79
79
  }
80
- log.debug(format(`<-`, msg));
80
+ log.trace(format(`<-`, msg));
81
81
  if (isEventMessage(msg)) {
82
82
  this.emit('event_msg', msg.payload);
83
83
  return;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aztec/foundation",
3
- "version": "0.0.1-commit.21ecf947b",
3
+ "version": "0.0.1-commit.2448fdb",
4
4
  "type": "module",
5
5
  "main": "./dest/index.js",
6
6
  "types": "./dest/index.d.ts",
@@ -144,7 +144,7 @@
144
144
  "testEnvironment": "../../foundation/src/jest/env.mjs"
145
145
  },
146
146
  "dependencies": {
147
- "@aztec/bb.js": "0.0.1-commit.21ecf947b",
147
+ "@aztec/bb.js": "0.0.1-commit.2448fdb",
148
148
  "@koa/cors": "^5.0.0",
149
149
  "@noble/curves": "=1.7.0",
150
150
  "@noble/hashes": "^1.6.1",
@@ -73,6 +73,11 @@ SlotNumber.isValid = function (value: unknown): value is SlotNumber {
73
73
  return typeof value === 'number' && Number.isInteger(value) && value >= 0;
74
74
  };
75
75
 
76
+ /** Increments a SlotNumber by a given value. */
77
+ SlotNumber.add = function (sn: SlotNumber, increment: number): SlotNumber {
78
+ return SlotNumber(sn + increment);
79
+ };
80
+
76
81
  /**
77
82
  * The zero slot value.
78
83
  */
@@ -1,2 +1,3 @@
1
1
  export * from './buffer32.js';
2
2
  export * from './buffer16.js';
3
+ export * from './utils.js';
@@ -0,0 +1,8 @@
1
+ /** Returns the number of bytes in the buffer, excluding any trailing zero bytes. */
2
+ export function trimmedBytesLength(buf: Uint8Array): number {
3
+ let end = buf.length;
4
+ while (end > 0 && buf[end - 1] === 0) {
5
+ end--;
6
+ }
7
+ return end;
8
+ }
@@ -315,3 +315,17 @@ export function partition<T>(items: T[], predicate: (item: T) => boolean): [T[],
315
315
  }
316
316
  return [pass, fail];
317
317
  }
318
+
319
+ /** Partitions the given iterable into two arrays based on the predicate. */
320
+ export async function partitionAsync<T>(items: T[], predicate: (item: T) => Promise<boolean>): Promise<[T[], T[]]> {
321
+ const pass: T[] = [];
322
+ const fail: T[] = [];
323
+ for (const item of items) {
324
+ if (await predicate(item)) {
325
+ pass.push(item);
326
+ } else {
327
+ fail.push(item);
328
+ }
329
+ }
330
+ return [pass, fail];
331
+ }
@@ -12,6 +12,10 @@ export type EnvVar =
12
12
  | 'ARCHIVER_VIEM_POLLING_INTERVAL_MS'
13
13
  | 'ARCHIVER_BATCH_SIZE'
14
14
  | 'AZTEC_ADMIN_PORT'
15
+ | 'AZTEC_NODE_DEBUG'
16
+ | 'AZTEC_ADMIN_API_KEY_HASH'
17
+ | 'AZTEC_DISABLE_ADMIN_API_KEY'
18
+ | 'AZTEC_RESET_ADMIN_API_KEY'
15
19
  | 'AZTEC_NODE_ADMIN_URL'
16
20
  | 'AZTEC_NODE_URL'
17
21
  | 'AZTEC_PORT'
@@ -67,6 +71,7 @@ export type EnvVar =
67
71
  | 'PUBLIC_DATA_TREE_MAP_SIZE_KB'
68
72
  | 'DEBUG'
69
73
  | 'DEBUG_P2P_DISABLE_COLOCATION_PENALTY'
74
+ | 'ENABLE_PROVER_NODE'
70
75
  | 'ETHEREUM_HOSTS'
71
76
  | 'ETHEREUM_DEBUG_HOSTS'
72
77
  | 'ETHEREUM_ALLOW_NO_DEBUG_HOSTS'
@@ -76,6 +81,7 @@ export type EnvVar =
76
81
  | 'KEY_STORE_DIRECTORY'
77
82
  | 'L1_CHAIN_ID'
78
83
  | 'L1_CONSENSUS_HOST_URLS'
84
+ | 'ETHEREUM_HTTP_TIMEOUT_MS'
79
85
  | 'L1_CONSENSUS_HOST_API_KEYS'
80
86
  | 'L1_CONSENSUS_HOST_API_KEY_HEADERS'
81
87
  | 'LOG_JSON'
@@ -85,7 +91,6 @@ export type EnvVar =
85
91
  | 'MNEMONIC'
86
92
  | 'NETWORK'
87
93
  | 'NETWORK_CONFIG_LOCATION'
88
- | 'NO_PXE'
89
94
  | 'USE_GCLOUD_LOGGING'
90
95
  | 'OTEL_EXPORTER_OTLP_METRICS_ENDPOINT'
91
96
  | 'OTEL_EXPORTER_OTLP_TRACES_ENDPOINT'
@@ -148,6 +153,7 @@ export type EnvVar =
148
153
  | 'P2P_DROP_TX_CHANCE'
149
154
  | 'P2P_TX_POOL_DELETE_TXS_AFTER_REORG'
150
155
  | 'P2P_MIN_TX_POOL_AGE_MS'
156
+ | 'P2P_RPC_PRICE_BUMP_PERCENTAGE'
151
157
  | 'DEBUG_P2P_INSTRUMENT_MESSAGES'
152
158
  | 'PEER_ID_PRIVATE_KEY'
153
159
  | 'PEER_ID_PRIVATE_KEY_PATH'
@@ -163,6 +169,7 @@ export type EnvVar =
163
169
  | 'PROVER_BROKER_MAX_EPOCHS_TO_KEEP_RESULTS_FOR'
164
170
  | 'PROVER_BROKER_DEBUG_REPLAY_ENABLED'
165
171
  | 'PROVER_CANCEL_JOBS_ON_STOP'
172
+ | 'PROVER_ENQUEUE_CONCURRENCY'
166
173
  | 'PROVER_COORDINATION_NODE_URLS'
167
174
  | 'PROVER_PROOF_STORE'
168
175
  | 'PROVER_FAILED_PROOF_STORE'
@@ -196,12 +203,14 @@ export type EnvVar =
196
203
  | 'SENTINEL_ENABLED'
197
204
  | 'SENTINEL_HISTORY_LENGTH_IN_EPOCHS'
198
205
  | 'SENTINEL_HISTORIC_PROVEN_PERFORMANCE_LENGTH_IN_EPOCHS'
199
- | 'SEQ_MAX_BLOCK_SIZE_IN_BYTES'
200
206
  | 'SEQ_MAX_TX_PER_BLOCK'
207
+ | 'SEQ_MAX_TX_PER_CHECKPOINT'
201
208
  | 'SEQ_MIN_TX_PER_BLOCK'
202
209
  | 'SEQ_PUBLISH_TXS_WITH_PROPOSALS'
203
210
  | 'SEQ_MAX_DA_BLOCK_GAS'
204
211
  | 'SEQ_MAX_L2_BLOCK_GAS'
212
+ | 'SEQ_PER_BLOCK_ALLOCATION_MULTIPLIER'
213
+ | 'SEQ_REDISTRIBUTE_CHECKPOINT_BUDGET'
205
214
  | 'SEQ_PUBLISHER_PRIVATE_KEY'
206
215
  | 'SEQ_PUBLISHER_PRIVATE_KEYS'
207
216
  | 'SEQ_PUBLISHER_ADDRESSES'
@@ -212,9 +221,11 @@ export type EnvVar =
212
221
  | 'SEQ_L1_PUBLISHING_TIME_ALLOWANCE_IN_SLOT'
213
222
  | 'SEQ_ATTESTATION_PROPAGATION_TIME'
214
223
  | 'SEQ_BLOCK_DURATION_MS'
224
+ | 'SEQ_EXPECTED_BLOCK_PROPOSALS_PER_SLOT'
215
225
  | 'SEQ_BUILD_CHECKPOINT_IF_EMPTY'
216
226
  | 'SEQ_SECONDS_BEFORE_INVALIDATING_BLOCK_AS_COMMITTEE_MEMBER'
217
227
  | 'SEQ_SECONDS_BEFORE_INVALIDATING_BLOCK_AS_NON_COMMITTEE_MEMBER'
228
+ | 'SEQ_SKIP_CHECKPOINT_PUBLISH_PERCENT'
218
229
  | 'SLASH_MIN_PENALTY_PERCENTAGE'
219
230
  | 'SLASH_MAX_PENALTY_PERCENTAGE'
220
231
  | 'SLASH_VALIDATORS_ALWAYS'
@@ -241,6 +252,7 @@ export type EnvVar =
241
252
  | 'TELEMETRY'
242
253
  | 'TEST_ACCOUNTS'
243
254
  | 'SPONSORED_FPC'
255
+ | 'PREFUND_ADDRESSES'
244
256
  | 'TX_COLLECTION_FAST_NODES_TIMEOUT_BEFORE_REQ_RESP_MS'
245
257
  | 'TX_COLLECTION_SLOW_NODES_INTERVAL_MS'
246
258
  | 'TX_COLLECTION_SLOW_REQ_RESP_INTERVAL_MS'
@@ -270,6 +282,10 @@ export type EnvVar =
270
282
  | 'TRANSACTIONS_DISABLED'
271
283
  | 'VALIDATOR_ATTESTATIONS_POLLING_INTERVAL_MS'
272
284
  | 'VALIDATOR_DISABLED'
285
+ | 'VALIDATOR_MAX_DA_BLOCK_GAS'
286
+ | 'VALIDATOR_MAX_L2_BLOCK_GAS'
287
+ | 'VALIDATOR_MAX_TX_PER_BLOCK'
288
+ | 'VALIDATOR_MAX_TX_PER_CHECKPOINT'
273
289
  | 'VALIDATOR_PRIVATE_KEYS'
274
290
  | 'VALIDATOR_PRIVATE_KEY'
275
291
  | 'VALIDATOR_REEXECUTE'
@@ -279,6 +295,7 @@ export type EnvVar =
279
295
  | 'WS_BLOCK_REQUEST_BATCH_SIZE'
280
296
  | 'L1_READER_VIEM_POLLING_INTERVAL_MS'
281
297
  | 'WS_DATA_DIRECTORY'
298
+ | 'WS_NUM_HISTORIC_CHECKPOINTS'
282
299
  | 'WS_NUM_HISTORIC_BLOCKS'
283
300
  | 'ETHEREUM_SLOT_DURATION'
284
301
  | 'AZTEC_SLOT_DURATION'
@@ -333,9 +350,8 @@ export type EnvVar =
333
350
  | 'K8S_POD_NAME'
334
351
  | 'K8S_POD_UID'
335
352
  | 'K8S_NAMESPACE_NAME'
353
+ | 'ENABLE_VERSION_CHECK'
336
354
  | 'VALIDATOR_REEXECUTE_DEADLINE_MS'
337
- | 'AUTO_UPDATE'
338
- | 'AUTO_UPDATE_URL'
339
355
  | 'WEB3_SIGNER_URL'
340
356
  | 'SKIP_ARCHIVER_INITIAL_SYNC'
341
357
  | 'BLOB_ALLOW_EMPTY_SOURCES'
@@ -177,6 +177,21 @@ export function bigintConfigHelper(defaultVal?: bigint): Pick<ConfigMapping, 'pa
177
177
  if (val === '') {
178
178
  return defaultVal;
179
179
  }
180
+ // Handle scientific notation (e.g. "1e+23", "2E23") which BigInt() doesn't accept directly.
181
+ // We parse it losslessly using bigint arithmetic instead of going through float64.
182
+ if (/[eE]/.test(val)) {
183
+ const match = val.match(/^(-?\d+(?:\.(\d+))?)[eE]([+-]?\d+)$/);
184
+ if (!match) {
185
+ throw new Error(`Cannot convert '${val}' to a BigInt`);
186
+ }
187
+ const digits = match[1].replace('.', '');
188
+ const decimalPlaces = match[2]?.length ?? 0;
189
+ const exponent = parseInt(match[3], 10) - decimalPlaces;
190
+ if (exponent < 0) {
191
+ throw new Error(`Cannot convert '${val}' to a BigInt: result is not an integer`);
192
+ }
193
+ return BigInt(digits) * 10n ** BigInt(exponent);
194
+ }
180
195
  return BigInt(val);
181
196
  },
182
197
  defaultValue: defaultVal,
@@ -5,10 +5,13 @@ export const NetworkConfigSchema = z
5
5
  bootnodes: z.array(z.string()),
6
6
  snapshots: z.array(z.string()),
7
7
  blobFileStoreUrls: z.array(z.string()).optional(),
8
+ txCollectionFileStoreUrls: z.array(z.string()).optional(),
8
9
  registryAddress: z.string(),
9
10
  feeAssetHandlerAddress: z.string().optional(),
10
11
  l1ChainId: z.number(),
11
12
  blockDurationMs: z.number().positive().optional(),
13
+ nodeVersion: z.string().optional(),
14
+ txPublicSetupAllowListExtend: z.string().optional(),
12
15
  })
13
16
  .passthrough(); // Allow additional unknown fields to pass through
14
17
 
@@ -1,21 +1,35 @@
1
- import { BarretenbergSync } 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 BarretenbergSync.initSingleton();
14
- const api = BarretenbergSync.getSingleton();
15
- const response = 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 BarretenbergSync.initSingleton();
31
- const api = BarretenbergSync.getSingleton();
32
- const response = 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 BarretenbergSync.initSingleton();
48
- const api = BarretenbergSync.getSingleton();
49
- const response = 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 BarretenbergSync.initSingleton();
69
- const api = BarretenbergSync.getSingleton();
70
- const response = 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
  }
@@ -210,3 +210,35 @@ export function recoverPublicKey(hash: Buffer32, signature: Signature, opts: Rec
210
210
  const publicKey = sig.recoverPublicKey(hash.buffer).toHex(false);
211
211
  return Buffer.from(publicKey, 'hex');
212
212
  }
213
+
214
+ /** Arbitrary hash used for testing signature recoverability. */
215
+ const PROBE_HASH = Buffer32.fromBuffer(keccak256(Buffer.from('signature-recoverability-probe')));
216
+
217
+ /**
218
+ * Generates a random valid ECDSA signature that is recoverable to some address.
219
+ * Since Signature.random() produces real signatures via secp256k1 signing, the result is always
220
+ * recoverable, but we verify defensively by checking tryRecoverAddress.
221
+ */
222
+ export function generateRecoverableSignature(): Signature {
223
+ for (let i = 0; i < 100; i++) {
224
+ const sig = Signature.random();
225
+ if (tryRecoverAddress(PROBE_HASH, sig) !== undefined) {
226
+ return sig;
227
+ }
228
+ }
229
+ throw new Secp256k1Error('Failed to generate a recoverable signature after 100 attempts');
230
+ }
231
+
232
+ /**
233
+ * Generates a random signature where ECDSA address recovery fails.
234
+ * Uses random r/s values (not from real signing) so that r is unlikely to be a valid secp256k1 x-coordinate.
235
+ */
236
+ export function generateUnrecoverableSignature(): Signature {
237
+ for (let i = 0; i < 100; i++) {
238
+ const sig = new Signature(Buffer32.random(), Buffer32.random(), 27);
239
+ if (tryRecoverAddress(PROBE_HASH, sig) === undefined) {
240
+ return sig;
241
+ }
242
+ }
243
+ throw new Secp256k1Error('Failed to generate an unrecoverable signature after 100 attempts');
244
+ }
@@ -118,14 +118,18 @@ abstract class BaseField {
118
118
  }
119
119
 
120
120
  cmp(rhs: BaseField): -1 | 0 | 1 {
121
- const rhsBigInt = rhs.asBigInt;
122
- return this.asBigInt === rhsBigInt ? 0 : this.asBigInt < rhsBigInt ? -1 : 1;
121
+ return BaseField.cmpAsBigInt(this.asBigInt, rhs.asBigInt);
123
122
  }
124
123
 
125
124
  static cmp(lhs: BaseField, rhs: BaseField): -1 | 0 | 1 {
126
125
  return lhs.cmp(rhs);
127
126
  }
128
127
 
128
+ // Actual bigint comparison. Arguments must have been validated previously.
129
+ static cmpAsBigInt(lhs: bigint, rhs: bigint): -1 | 0 | 1 {
130
+ return lhs === rhs ? 0 : lhs < rhs ? -1 : 1;
131
+ }
132
+
129
133
  isZero(): boolean {
130
134
  return this.asBigInt === 0n;
131
135
  }
@@ -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
  }
@@ -1,8 +1,10 @@
1
1
  import { Buffer32 } from '@aztec/foundation/buffer';
2
2
  import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
3
3
 
4
+ import { secp256k1 } from '@noble/curves/secp256k1';
4
5
  import { z } from 'zod';
5
6
 
7
+ import { randomBytes } from '../crypto/random/index.js';
6
8
  import { hasHexPrefix, hexToBuffer } from '../string/index.js';
7
9
 
8
10
  /**
@@ -77,8 +79,12 @@ export class Signature {
77
79
  return new Signature(Buffer32.fromBuffer(hexToBuffer(sig.r)), Buffer32.fromBuffer(hexToBuffer(sig.s)), sig.yParity);
78
80
  }
79
81
 
82
+ /** Generates a random valid ECDSA signature with a low s-value by signing a random message with a random key. */
80
83
  static random(): Signature {
81
- return new Signature(Buffer32.random(), Buffer32.random(), 1);
84
+ const privateKey = randomBytes(32);
85
+ const message = randomBytes(32);
86
+ const { r, s, recovery } = secp256k1.sign(message, privateKey);
87
+ return new Signature(Buffer32.fromBigInt(r), Buffer32.fromBigInt(s), recovery ? 28 : 27);
82
88
  }
83
89
 
84
90
  static empty(): Signature {
@@ -24,6 +24,7 @@ export type SafeJsonRpcClientOptions = {
24
24
  batchWindowMS?: number;
25
25
  maxBatchSize?: number;
26
26
  maxRequestBodySize?: number;
27
+ extraHeaders?: Record<string, string>;
27
28
  onResponse?: (res: {
28
29
  response: any;
29
30
  headers: { get: (header: string) => string | null | undefined };
@@ -129,6 +130,7 @@ export function createSafeJsonRpcClient<T extends object>(
129
130
  const { response, headers } = await fetch(
130
131
  host,
131
132
  rpcCalls.map(({ request }) => request),
133
+ config.extraHeaders,
132
134
  );
133
135
 
134
136
  if (config.onResponse) {
@@ -0,0 +1,63 @@
1
+ import { timingSafeEqual } from 'crypto';
2
+ import type Koa from 'koa';
3
+
4
+ import { sha256 } from '../../crypto/sha256/index.js';
5
+ import { createLogger } from '../../log/index.js';
6
+
7
+ const log = createLogger('json-rpc:api-key-auth');
8
+
9
+ /**
10
+ * Computes the SHA-256 hash of a string and returns it as a Buffer.
11
+ * @param input - The input string to hash.
12
+ * @returns The SHA-256 hash as a Buffer.
13
+ */
14
+ export function sha256Hash(input: string): Buffer {
15
+ return sha256(Buffer.from(input));
16
+ }
17
+
18
+ /**
19
+ * Creates a Koa middleware that enforces API key authentication on all requests
20
+ * except the health check endpoint (GET /status).
21
+ *
22
+ * The API key can be provided via the `x-api-key` header or the `Authorization: Bearer <key>` header.
23
+ * Comparison is done by hashing the provided key with SHA-256 and comparing against the stored hash.
24
+ *
25
+ * @param apiKeyHash - The SHA-256 hash of the expected API key as a Buffer.
26
+ * @returns A Koa middleware that rejects requests without a valid API key.
27
+ */
28
+ export function getApiKeyAuthMiddleware(
29
+ apiKeyHash: Buffer,
30
+ ): (ctx: Koa.Context, next: () => Promise<void>) => Promise<void> {
31
+ return async (ctx: Koa.Context, next: () => Promise<void>) => {
32
+ // Allow health check through without auth
33
+ if (ctx.path === '/status' && ctx.method === 'GET') {
34
+ return next();
35
+ }
36
+
37
+ const providedKey = ctx.get('x-api-key') || ctx.get('authorization')?.replace(/^Bearer\s+/i, '');
38
+ if (!providedKey) {
39
+ log.warn(`Rejected admin RPC request from ${ctx.ip}: missing API key`);
40
+ ctx.status = 401;
41
+ ctx.body = {
42
+ jsonrpc: '2.0',
43
+ id: null,
44
+ error: { code: -32000, message: 'Unauthorized: invalid or missing API key' },
45
+ };
46
+ return;
47
+ }
48
+
49
+ const providedHashBuf = sha256Hash(providedKey);
50
+ if (!timingSafeEqual(apiKeyHash, providedHashBuf)) {
51
+ log.warn(`Rejected admin RPC request from ${ctx.ip}: invalid API key`);
52
+ ctx.status = 401;
53
+ ctx.body = {
54
+ jsonrpc: '2.0',
55
+ id: null,
56
+ error: { code: -32000, message: 'Unauthorized: invalid or missing API key' },
57
+ };
58
+ return;
59
+ }
60
+
61
+ await next();
62
+ };
63
+ }
@@ -1 +1,2 @@
1
+ export * from './api_key_auth.js';
1
2
  export * from './safe_json_rpc_server.js';