@aztec/foundation 0.0.1-commit.0c875d939 → 0.0.1-commit.0ec55a70b

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 (202) hide show
  1. package/dest/branded-types/buffer32_hash.d.ts +24 -0
  2. package/dest/branded-types/buffer32_hash.d.ts.map +1 -0
  3. package/dest/branded-types/buffer32_hash.js +19 -0
  4. package/dest/branded-types/checkpoint_number.d.ts +4 -1
  5. package/dest/branded-types/checkpoint_number.d.ts.map +1 -1
  6. package/dest/branded-types/checkpoint_number.js +3 -0
  7. package/dest/branded-types/index.d.ts +2 -1
  8. package/dest/branded-types/index.d.ts.map +1 -1
  9. package/dest/branded-types/index.js +1 -0
  10. package/dest/branded-types/slot.d.ts +4 -1
  11. package/dest/branded-types/slot.d.ts.map +1 -1
  12. package/dest/branded-types/slot.js +3 -0
  13. package/dest/buffer/buffer16.d.ts +3 -1
  14. package/dest/buffer/buffer16.d.ts.map +1 -1
  15. package/dest/buffer/buffer32.d.ts +28 -61
  16. package/dest/buffer/buffer32.d.ts.map +1 -1
  17. package/dest/buffer/buffer32.js +26 -60
  18. package/dest/buffer/index.d.ts +2 -1
  19. package/dest/buffer/index.d.ts.map +1 -1
  20. package/dest/buffer/index.js +1 -0
  21. package/dest/buffer/utils.d.ts +3 -0
  22. package/dest/buffer/utils.d.ts.map +1 -0
  23. package/dest/buffer/utils.js +7 -0
  24. package/dest/collection/array.d.ts +3 -1
  25. package/dest/collection/array.d.ts.map +1 -1
  26. package/dest/collection/array.js +15 -0
  27. package/dest/collection/index.d.ts +2 -1
  28. package/dest/collection/index.d.ts.map +1 -1
  29. package/dest/collection/index.js +1 -0
  30. package/dest/collection/lru_set.d.ts +35 -0
  31. package/dest/collection/lru_set.d.ts.map +1 -0
  32. package/dest/collection/lru_set.js +95 -0
  33. package/dest/config/env_var.d.ts +2 -2
  34. package/dest/config/env_var.d.ts.map +1 -1
  35. package/dest/config/index.d.ts +48 -30
  36. package/dest/config/index.d.ts.map +1 -1
  37. package/dest/config/index.js +35 -29
  38. package/dest/config/network_config.d.ts +19 -1
  39. package/dest/config/network_config.d.ts.map +1 -1
  40. package/dest/config/network_config.js +4 -1
  41. package/dest/config/network_name.d.ts +2 -2
  42. package/dest/config/network_name.d.ts.map +1 -1
  43. package/dest/config/network_name.js +2 -0
  44. package/dest/crypto/aes128/index.d.ts +2 -1
  45. package/dest/crypto/aes128/index.d.ts.map +1 -1
  46. package/dest/crypto/aes128/index.js +11 -2
  47. package/dest/crypto/bls/bn254_keystore.d.ts +1 -10
  48. package/dest/crypto/bls/bn254_keystore.d.ts.map +1 -1
  49. package/dest/crypto/bls/bn254_keystore.js +0 -17
  50. package/dest/crypto/poseidon/index.d.ts +1 -1
  51. package/dest/crypto/poseidon/index.d.ts.map +1 -1
  52. package/dest/crypto/poseidon/index.js +40 -33
  53. package/dest/crypto/secp256k1-signer/utils.d.ts +12 -1
  54. package/dest/crypto/secp256k1-signer/utils.d.ts.map +1 -1
  55. package/dest/crypto/secp256k1-signer/utils.js +26 -0
  56. package/dest/curves/bls12/field.d.ts +1 -1
  57. package/dest/curves/bls12/field.d.ts.map +1 -1
  58. package/dest/curves/bls12/field.js +0 -5
  59. package/dest/curves/bn254/field.d.ts +18 -16
  60. package/dest/curves/bn254/field.d.ts.map +1 -1
  61. package/dest/curves/bn254/field.js +23 -15
  62. package/dest/curves/grumpkin/point.d.ts +4 -4
  63. package/dest/curves/grumpkin/point.d.ts.map +1 -1
  64. package/dest/curves/grumpkin/point.js +7 -4
  65. package/dest/eth-address/index.d.ts +1 -1
  66. package/dest/eth-address/index.d.ts.map +1 -1
  67. package/dest/eth-address/index.js +0 -3
  68. package/dest/eth-signature/eth_signature.d.ts +2 -1
  69. package/dest/eth-signature/eth_signature.d.ts.map +1 -1
  70. package/dest/eth-signature/eth_signature.js +7 -2
  71. package/dest/fifo/fifo_frame_reader.d.ts +41 -0
  72. package/dest/fifo/fifo_frame_reader.d.ts.map +1 -0
  73. package/dest/fifo/fifo_frame_reader.js +74 -0
  74. package/dest/fifo/index.d.ts +2 -0
  75. package/dest/fifo/index.d.ts.map +1 -0
  76. package/dest/fifo/index.js +1 -0
  77. package/dest/jest/setup.js +24 -0
  78. package/dest/json-rpc/client/fetch.d.ts +1 -1
  79. package/dest/json-rpc/client/fetch.d.ts.map +1 -1
  80. package/dest/json-rpc/client/fetch.js +4 -3
  81. package/dest/json-rpc/client/safe_json_rpc_client.d.ts +2 -1
  82. package/dest/json-rpc/client/safe_json_rpc_client.d.ts.map +1 -1
  83. package/dest/json-rpc/client/safe_json_rpc_client.js +1 -1
  84. package/dest/json-rpc/client/undici.d.ts +1 -1
  85. package/dest/json-rpc/client/undici.d.ts.map +1 -1
  86. package/dest/json-rpc/client/undici.js +5 -3
  87. package/dest/json-rpc/server/api_key_auth.d.ts +19 -0
  88. package/dest/json-rpc/server/api_key_auth.d.ts.map +1 -0
  89. package/dest/json-rpc/server/api_key_auth.js +57 -0
  90. package/dest/json-rpc/server/index.d.ts +2 -1
  91. package/dest/json-rpc/server/index.d.ts.map +1 -1
  92. package/dest/json-rpc/server/index.js +1 -0
  93. package/dest/log/bigint-utils.d.ts +5 -0
  94. package/dest/log/bigint-utils.d.ts.map +1 -0
  95. package/dest/log/bigint-utils.js +21 -0
  96. package/dest/log/gcloud-logger-config.d.ts +1 -1
  97. package/dest/log/gcloud-logger-config.d.ts.map +1 -1
  98. package/dest/log/gcloud-logger-config.js +3 -0
  99. package/dest/log/pino-logger.d.ts +1 -1
  100. package/dest/log/pino-logger.d.ts.map +1 -1
  101. package/dest/log/pino-logger.js +21 -2
  102. package/dest/queue/batch_queue.d.ts +1 -1
  103. package/dest/queue/batch_queue.d.ts.map +1 -1
  104. package/dest/queue/batch_queue.js +1 -0
  105. package/dest/retry/index.d.ts +12 -1
  106. package/dest/retry/index.d.ts.map +1 -1
  107. package/dest/retry/index.js +21 -0
  108. package/dest/schemas/api.d.ts +2 -2
  109. package/dest/schemas/api.d.ts.map +1 -1
  110. package/dest/sleep/index.d.ts +2 -1
  111. package/dest/sleep/index.d.ts.map +1 -1
  112. package/dest/sleep/index.js +10 -1
  113. package/dest/string/index.js +1 -1
  114. package/dest/timer/date.d.ts +3 -1
  115. package/dest/timer/date.d.ts.map +1 -1
  116. package/dest/timer/date.js +4 -0
  117. package/dest/transport/dispatch/create_dispatch_proxy.d.ts +11 -2
  118. package/dest/transport/dispatch/create_dispatch_proxy.d.ts.map +1 -1
  119. package/dest/transport/index.d.ts +1 -2
  120. package/dest/transport/index.d.ts.map +1 -1
  121. package/dest/transport/index.js +0 -1
  122. package/dest/transport/transport_client.js +2 -2
  123. package/dest/trees/balanced_merkle_tree_root.d.ts +2 -3
  124. package/dest/trees/balanced_merkle_tree_root.d.ts.map +1 -1
  125. package/dest/trees/balanced_merkle_tree_root.js +2 -3
  126. package/dest/trees/hasher.d.ts +3 -2
  127. package/dest/trees/hasher.d.ts.map +1 -1
  128. package/dest/trees/hasher.js +5 -5
  129. package/dest/trees/indexed_merkle_tree_calculator.d.ts +1 -1
  130. package/dest/trees/indexed_merkle_tree_calculator.d.ts.map +1 -1
  131. package/dest/trees/indexed_merkle_tree_calculator.js +5 -1
  132. package/dest/trees/merkle_tree_calculator.d.ts +4 -2
  133. package/dest/trees/merkle_tree_calculator.d.ts.map +1 -1
  134. package/dest/trees/merkle_tree_calculator.js +1 -5
  135. package/dest/trees/sibling_path.d.ts +2 -2
  136. package/dest/trees/sibling_path.d.ts.map +1 -1
  137. package/dest/trees/sibling_path.js +1 -5
  138. package/dest/trees/unbalanced_merkle_tree_root.d.ts +2 -3
  139. package/dest/trees/unbalanced_merkle_tree_root.d.ts.map +1 -1
  140. package/dest/trees/unbalanced_merkle_tree_root.js +2 -3
  141. package/dest/types/index.d.ts +9 -1
  142. package/dest/types/index.d.ts.map +1 -1
  143. package/package.json +3 -2
  144. package/src/branded-types/buffer32_hash.ts +42 -0
  145. package/src/branded-types/checkpoint_number.ts +5 -0
  146. package/src/branded-types/index.ts +1 -0
  147. package/src/branded-types/slot.ts +5 -0
  148. package/src/buffer/buffer16.ts +3 -0
  149. package/src/buffer/buffer32.ts +36 -65
  150. package/src/buffer/index.ts +1 -0
  151. package/src/buffer/utils.ts +8 -0
  152. package/src/collection/array.ts +14 -0
  153. package/src/collection/index.ts +1 -0
  154. package/src/collection/lru_set.ts +115 -0
  155. package/src/config/env_var.ts +34 -11
  156. package/src/config/index.ts +110 -83
  157. package/src/config/network_config.ts +3 -0
  158. package/src/config/network_name.ts +4 -1
  159. package/src/crypto/aes128/index.ts +11 -2
  160. package/src/crypto/bls/bn254_keystore.ts +0 -23
  161. package/src/crypto/poseidon/index.ts +42 -34
  162. package/src/crypto/secp256k1-signer/utils.ts +32 -0
  163. package/src/curves/bls12/field.ts +0 -7
  164. package/src/curves/bn254/field.ts +31 -33
  165. package/src/curves/grumpkin/point.ts +6 -3
  166. package/src/eth-address/index.ts +0 -4
  167. package/src/eth-signature/eth_signature.ts +7 -1
  168. package/src/fifo/fifo_frame_reader.ts +98 -0
  169. package/src/fifo/index.ts +1 -0
  170. package/src/jest/setup.mjs +27 -0
  171. package/src/json-rpc/client/fetch.ts +4 -3
  172. package/src/json-rpc/client/safe_json_rpc_client.ts +2 -0
  173. package/src/json-rpc/client/undici.ts +5 -3
  174. package/src/json-rpc/server/api_key_auth.ts +63 -0
  175. package/src/json-rpc/server/index.ts +1 -0
  176. package/src/log/bigint-utils.ts +25 -0
  177. package/src/log/gcloud-logger-config.ts +5 -0
  178. package/src/log/pino-logger.ts +23 -2
  179. package/src/queue/batch_queue.ts +1 -0
  180. package/src/retry/index.ts +30 -0
  181. package/src/schemas/api.ts +4 -1
  182. package/src/sleep/index.ts +10 -1
  183. package/src/string/index.ts +1 -1
  184. package/src/timer/date.ts +6 -0
  185. package/src/transport/dispatch/create_dispatch_proxy.ts +11 -1
  186. package/src/transport/index.ts +0 -1
  187. package/src/transport/transport_client.ts +2 -2
  188. package/src/trees/balanced_merkle_tree_root.ts +2 -5
  189. package/src/trees/hasher.ts +6 -3
  190. package/src/trees/indexed_merkle_tree_calculator.ts +5 -1
  191. package/src/trees/merkle_tree_calculator.ts +4 -10
  192. package/src/trees/sibling_path.ts +1 -2
  193. package/src/trees/unbalanced_merkle_tree_root.ts +2 -5
  194. package/src/types/index.ts +14 -0
  195. package/dest/crypto/serialize.d.ts +0 -51
  196. package/dest/crypto/serialize.d.ts.map +0 -1
  197. package/dest/crypto/serialize.js +0 -68
  198. package/dest/transport/dispatch/create_dispatch_fn.d.ts +0 -25
  199. package/dest/transport/dispatch/create_dispatch_fn.d.ts.map +0 -1
  200. package/dest/transport/dispatch/create_dispatch_fn.js +0 -17
  201. package/src/crypto/serialize.ts +0 -85
  202. package/src/transport/dispatch/create_dispatch_fn.ts +0 -35
@@ -1,5 +1,7 @@
1
1
  import type { pino } from 'pino';
2
2
 
3
+ import { convertBigintsToStrings } from './bigint-utils.js';
4
+
3
5
  /* eslint-disable camelcase */
4
6
 
5
7
  const GOOGLE_CLOUD_TRACE_ID = 'logging.googleapis.com/trace';
@@ -15,6 +17,9 @@ export const GoogleCloudLoggerConfig = {
15
17
  messageKey: 'message',
16
18
  formatters: {
17
19
  log(object: Record<string, unknown>): Record<string, unknown> {
20
+ // Convert bigints to strings recursively to avoid serialization issues
21
+ object = convertBigintsToStrings(object) as Record<string, unknown>;
22
+
18
23
  // Add trace context attributes following Cloud Logging structured log format described
19
24
  // in https://cloud.google.com/logging/docs/structured-logging#special-payload-fields
20
25
  const { trace_id, span_id, trace_flags, ...rest } = object;
@@ -7,6 +7,7 @@ import { inspect } from 'util';
7
7
  import { compactArray } from '../collection/array.js';
8
8
  import type { EnvVar } from '../config/index.js';
9
9
  import { parseBooleanEnv } from '../config/parse-env.js';
10
+ import { convertBigintsToStrings } from './bigint-utils.js';
10
11
  import { GoogleCloudLoggerConfig } from './gcloud-logger-config.js';
11
12
  import { getLogLevelFromFilters, parseLogLevelEnvVar } from './log-filters.js';
12
13
  import type { LogLevel } from './log-levels.js';
@@ -20,6 +21,8 @@ export type LoggerBindings = {
20
21
  instanceId?: string;
21
22
  };
22
23
 
24
+ const MAX_MODULE_NAME_LENGTH = 256;
25
+
23
26
  // Allow global hooks for providing default bindings.
24
27
  // Used by withLoggerBindings in pino-logger-server to propagate bindings via AsyncLocalStorage.
25
28
  type LogBindingsHandler = () => LoggerBindings | undefined;
@@ -47,7 +50,7 @@ function getBindingsFromHandlers(): LoggerBindings | undefined {
47
50
  }
48
51
 
49
52
  export function createLogger(module: string, bindings?: LoggerBindings): Logger {
50
- module = module.replace(/^aztec:/, '');
53
+ module = module.slice(0, MAX_MODULE_NAME_LENGTH).replace(/^aztec:/, '');
51
54
 
52
55
  const resolvedBindings = { ...getBindingsFromHandlers(), ...bindings };
53
56
  const actor = resolvedBindings?.actor;
@@ -165,6 +168,9 @@ const pinoOpts: pino.LoggerOptions<keyof typeof customLevels> = {
165
168
  ...redactedPaths.map(p => `opts.${p}`),
166
169
  ],
167
170
  },
171
+ formatters: {
172
+ log: obj => convertBigintsToStrings(obj) as Record<string, unknown>,
173
+ },
168
174
  ...(useGcloudLogging ? GoogleCloudLoggerConfig : {}),
169
175
  };
170
176
 
@@ -371,5 +377,20 @@ export type Logger = { [K in LogLevel]: LogFn } & { /** Error log function */ er
371
377
  * @returns A string with both the log message and the error message.
372
378
  */
373
379
  function formatErr(msg: string, err?: unknown): string {
374
- 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
+ }
375
396
  }
@@ -105,6 +105,7 @@ export class BatchQueue<T, K extends string | number> {
105
105
  return Promise.resolve();
106
106
  }
107
107
 
108
+ this.flushCurrentBatch();
108
109
  this.container.end();
109
110
  return runningPromise;
110
111
  }
@@ -104,6 +104,36 @@ export async function retryUntil<T>(
104
104
  }
105
105
  }
106
106
 
107
+ /**
108
+ * Retry an asynchronous function until it returns a truthy value or the maximum number of retries is exceeded.
109
+ * The function is retried periodically with a fixed interval between attempts.
110
+ *
111
+ * @param fn - The asynchronous function to be retried, which should return a truthy value upon success or undefined otherwise.
112
+ * @param name - The optional name of the operation, used for generating error messages.
113
+ * @param maxRetries - The maximum number of retry attempts before throwing an error.
114
+ * @param retryInterval - The optional interval, in seconds, between retry attempts. Defaults to 1 second.
115
+ * @returns A Promise that resolves with the successful (truthy) result of the provided function, or rejects if retries are exhausted.
116
+ */
117
+ export async function retryTimes<T>(
118
+ fn: () => (T | undefined) | Promise<T | undefined>,
119
+ name = '',
120
+ maxRetries: number,
121
+ retryInterval = 1,
122
+ ) {
123
+ for (let attempt = 0; attempt <= maxRetries; attempt++) {
124
+ const result = await fn();
125
+ if (result) {
126
+ return result;
127
+ }
128
+
129
+ if (attempt < maxRetries) {
130
+ await sleep(retryInterval * 1000);
131
+ }
132
+ }
133
+
134
+ throw new Error(name ? `Retries exhausted awaiting ${name}` : 'Retries exhausted');
135
+ }
136
+
107
137
  /**
108
138
  * Convenience wrapper around retryUntil with fast polling for tests.
109
139
  * Uses 10s timeout and 100ms polling interval by default.
@@ -37,7 +37,10 @@ export type ApiSchema = {
37
37
  };
38
38
 
39
39
  /** Return whether an API schema defines a valid function schema for a given method name. */
40
- export function schemaHasMethod(schema: ApiSchema, methodName: string) {
40
+ export function schemaHasMethod<T extends ApiSchema>(
41
+ schema: T,
42
+ methodName: string,
43
+ ): methodName is Extract<keyof T, string> {
41
44
  return (
42
45
  typeof methodName === 'string' &&
43
46
  Object.hasOwn(schema, methodName) &&
@@ -22,6 +22,7 @@ import { InterruptError } from '../error/index.js';
22
22
  */
23
23
  export class InterruptibleSleep {
24
24
  private interrupts: Array<(shouldThrow: boolean) => void> = [];
25
+ private timeoutIds: NodeJS.Timeout[] = [];
25
26
 
26
27
  /**
27
28
  * Sleep for a specified amount of time in milliseconds.
@@ -38,9 +39,15 @@ export class InterruptibleSleep {
38
39
  this.interrupts.push(resolve);
39
40
  });
40
41
 
41
- const timeoutPromise = new Promise<boolean>(resolve => setTimeout(() => resolve(false), ms));
42
+ let timeoutId: NodeJS.Timeout;
43
+ const timeoutPromise = new Promise<boolean>(resolve => {
44
+ timeoutId = setTimeout(() => resolve(false), ms);
45
+ this.timeoutIds.push(timeoutId);
46
+ });
42
47
  const shouldThrow = await Promise.race([interruptPromise, timeoutPromise]);
43
48
 
49
+ clearTimeout(timeoutId!);
50
+ this.timeoutIds = this.timeoutIds.filter(id => id !== timeoutId);
44
51
  this.interrupts = this.interrupts.filter(res => res !== interruptResolve);
45
52
 
46
53
  if (shouldThrow) {
@@ -58,6 +65,8 @@ export class InterruptibleSleep {
58
65
  public interrupt(sleepShouldThrow = false): void {
59
66
  this.interrupts.forEach(resolve => resolve(sleepShouldThrow));
60
67
  this.interrupts = [];
68
+ this.timeoutIds.forEach(id => clearTimeout(id));
69
+ this.timeoutIds = [];
61
70
  }
62
71
  }
63
72
 
@@ -58,7 +58,7 @@ export function urlJoin(...args: string[]): string {
58
58
  end--;
59
59
  }
60
60
 
61
- if (start < end) {
61
+ if (start <= end) {
62
62
  processed.push(arg.slice(start, end + 1));
63
63
  }
64
64
  }
package/src/timer/date.ts CHANGED
@@ -32,6 +32,12 @@ export class TestDateProvider extends DateProvider {
32
32
  this.logger.warn(`Time set to ${new Date(timeMs).toISOString()}`, { offset: this.offset, timeMs });
33
33
  }
34
34
 
35
+ /** Resets the time back to real time (offset = 0). */
36
+ public reset() {
37
+ this.offset = 0;
38
+ this.logger.warn('Time reset to real time');
39
+ }
40
+
35
41
  /** Advances the time by the given number of seconds. */
36
42
  public advanceTime(seconds: number) {
37
43
  this.offset += seconds * 1000;
@@ -2,7 +2,17 @@ import { EventEmitter } from 'events';
2
2
 
3
3
  import { type TransferDescriptor, isTransferDescriptor } from '../interface/transferable.js';
4
4
  import type { TransportClient } from '../transport_client.js';
5
- import type { DispatchMsg } from './create_dispatch_fn.js';
5
+
6
+ /**
7
+ * Represents a message object for dispatching function calls.
8
+ * Contains the function name ('fn') and an array of arguments ('args') required to call the target method.
9
+ */
10
+ export interface DispatchMsg {
11
+ /** Name of the target method to be called. */
12
+ fn: string;
13
+ /** An array of arguments to be passed to the target method. */
14
+ args: any[];
15
+ }
6
16
 
7
17
  /**
8
18
  * FilterOutAttributes type filters out all non-method properties of an object, leaving only the attributes
@@ -1,4 +1,3 @@
1
- export * from './dispatch/create_dispatch_fn.js';
2
1
  export * from './dispatch/create_dispatch_proxy.js';
3
2
  export * from './dispatch/messages.js';
4
3
  export * from './interface/connector.js';
@@ -91,7 +91,7 @@ export class TransportClient<Payload> extends EventEmitter {
91
91
  }
92
92
  const msgId = this.msgId++;
93
93
  const msg = { msgId, payload };
94
- log.debug(format(`->`, msg));
94
+ log.trace(format(`->`, msg));
95
95
  return new Promise<any>((resolve, reject) => {
96
96
  this.pendingRequests.push({ resolve, reject, msgId });
97
97
  this.socket!.send(msg, transfer).catch(reject);
@@ -111,7 +111,7 @@ export class TransportClient<Payload> extends EventEmitter {
111
111
  this.close();
112
112
  return;
113
113
  }
114
- log.debug(format(`<-`, msg));
114
+ log.trace(format(`<-`, msg));
115
115
  if (isEventMessage(msg)) {
116
116
  this.emit('event_msg', msg.payload);
117
117
  return;
@@ -1,10 +1,7 @@
1
- import { poseidonMerkleHash, shaMerkleHash } from './hasher.js';
1
+ import { shaMerkleHash } from './hasher.js';
2
2
 
3
3
  export const computeBalancedShaRoot = (leaves: Buffer[]) => computeBalancedMerkleTreeRoot(leaves);
4
4
 
5
- export const computeBalancedPoseidonRoot = async (leaves: Buffer[]) =>
6
- await computeBalancedMerkleTreeRootAsync(leaves, poseidonMerkleHash);
7
-
8
5
  /**
9
6
  * Computes the Merkle root with the provided leaves **synchronously**.
10
7
  * This method uses a synchronous hash function (defaults to `sha256Trunc`).
@@ -36,7 +33,7 @@ export function computeBalancedMerkleTreeRoot(leaves: Buffer[], hasher = shaMerk
36
33
  */
37
34
  export async function computeBalancedMerkleTreeRootAsync(
38
35
  leaves: Buffer[],
39
- hasher = poseidonMerkleHash,
36
+ hasher: (left: Buffer, right: Buffer) => Promise<Buffer<ArrayBuffer>>,
40
37
  ): Promise<Buffer> {
41
38
  const height = getTreeHeight(leaves);
42
39
  let nodes = leaves.slice();
@@ -1,4 +1,4 @@
1
- import { poseidon2Hash } from '../crypto/poseidon/index.js';
1
+ import { poseidon2HashWithSeparator } from '../crypto/poseidon/index.js';
2
2
  import { sha256Trunc } from '../crypto/sha256/index.js';
3
3
 
4
4
  /**
@@ -44,5 +44,8 @@ export interface AsyncHasher {
44
44
  export const shaMerkleHash: Hasher['hash'] = (left: Buffer, right: Buffer) =>
45
45
  sha256Trunc(Buffer.concat([left, right])) as Buffer<ArrayBuffer>;
46
46
 
47
- export const poseidonMerkleHash: AsyncHasher['hash'] = async (left: Buffer, right: Buffer) =>
48
- (await poseidon2Hash([left, right])).toBuffer() as Buffer<ArrayBuffer>;
47
+ /** Creates a poseidon2 merkle hasher with the given domain separator. */
48
+ export const makePoseidonMerkleHash =
49
+ (separator: number): AsyncHasher['hash'] =>
50
+ async (left: Buffer, right: Buffer) =>
51
+ (await poseidon2HashWithSeparator([left, right], separator)).toBuffer() as Buffer<ArrayBuffer>;
@@ -40,7 +40,11 @@ export class IndexedMerkleTreeCalculator<T extends IndexedTreeLeafPreimage, N ex
40
40
  }
41
41
  const sorted = values
42
42
  .map((v, i) => ({ value: v, index: i }))
43
- .sort((a, b) => Number(toBigIntBE(b.value) - toBigIntBE(a.value)));
43
+ .sort((a, b): -1 | 0 | 1 => {
44
+ const aBigInt = toBigIntBE(a.value);
45
+ const bBigInt = toBigIntBE(b.value);
46
+ return aBigInt < bBigInt ? 1 : aBigInt > bBigInt ? -1 : 0;
47
+ });
44
48
  const indexedLeaves = sorted.map((item, i) => ({
45
49
  leaf: this.factory.fromBuffer(
46
50
  Buffer.concat([
@@ -1,8 +1,7 @@
1
- import { poseidon2Hash } from '@aztec/foundation/crypto/poseidon';
2
-
3
- import type { AsyncHasher } from './hasher.js';
4
1
  import { MerkleTree } from './merkle_tree.js';
5
2
 
3
+ type MerkleHashFn = (left: Buffer, right: Buffer) => Promise<Buffer<ArrayBuffer>>;
4
+
6
5
  /**
7
6
  * Merkle tree calculator.
8
7
  */
@@ -10,17 +9,12 @@ export class MerkleTreeCalculator {
10
9
  private constructor(
11
10
  private height: number,
12
11
  private zeroHashes: Buffer[],
13
- private hasher: AsyncHasher['hash'],
12
+ private hasher: MerkleHashFn,
14
13
  ) {
15
14
  this.hasher = hasher;
16
15
  }
17
16
 
18
- static async create(
19
- height: number,
20
- zeroLeaf: Buffer = Buffer.alloc(32),
21
- hasher = async (left: Buffer, right: Buffer) =>
22
- (await poseidon2Hash([left, right])).toBuffer() as Buffer<ArrayBuffer>,
23
- ) {
17
+ static async create(height: number, zeroLeaf: Buffer = Buffer.alloc(32), hasher: MerkleHashFn) {
24
18
  const zeroHashes = [zeroLeaf];
25
19
  for (let i = 0; i < height; i++) {
26
20
  zeroHashes.push((await hasher(zeroHashes[i], zeroHashes[i])) as Buffer<ArrayBuffer>);
@@ -1,5 +1,4 @@
1
1
  import { makeTuple } from '../array/array.js';
2
- import { poseidon2Hash } from '../crypto/poseidon/index.js';
3
2
  import { Fr } from '../curves/bn254/index.js';
4
3
  import { schemas } from '../schemas/index.js';
5
4
  import {
@@ -172,7 +171,7 @@ export async function computeRootFromSiblingPath(
172
171
  leaf: Buffer,
173
172
  siblingPath: Buffer[],
174
173
  index: number,
175
- hasher = async (left: Buffer, right: Buffer) => (await poseidon2Hash([left, right])).toBuffer(),
174
+ hasher: (left: Buffer, right: Buffer) => Promise<Buffer>,
176
175
  ) {
177
176
  let result = leaf;
178
177
  for (const sibling of siblingPath) {
@@ -1,12 +1,9 @@
1
1
  import { computeBalancedMerkleTreeRoot, computeBalancedMerkleTreeRootAsync } from './balanced_merkle_tree_root.js';
2
- import { poseidonMerkleHash, shaMerkleHash } from './hasher.js';
2
+ import { shaMerkleHash } from './hasher.js';
3
3
  import { UnbalancedMerkleTreeCalculator } from './unbalanced_merkle_tree_calculator.js';
4
4
 
5
5
  export const computeUnbalancedShaRoot = (leaves: Buffer[]) => computeUnbalancedMerkleTreeRoot(leaves, shaMerkleHash);
6
6
 
7
- export const computeUnbalancedPoseidonRoot = async (leaves: Buffer[]) =>
8
- await computeUnbalancedMerkleTreeRootAsync(leaves, poseidonMerkleHash);
9
-
10
7
  export const computeWonkyShaRoot = (leaves: Buffer[]) => computeWonkyMerkleTreeRoot(leaves);
11
8
 
12
9
  /**
@@ -67,7 +64,7 @@ export function computeUnbalancedMerkleTreeRoot(
67
64
 
68
65
  export async function computeUnbalancedMerkleTreeRootAsync(
69
66
  leaves: Buffer[],
70
- hasher = poseidonMerkleHash,
67
+ hasher: (left: Uint8Array, right: Uint8Array) => Promise<Buffer<ArrayBuffer>>,
71
68
  emptyRoot = Buffer.alloc(32),
72
69
  ): Promise<Buffer> {
73
70
  if (!leaves.length) {
@@ -34,6 +34,20 @@ export type Prettify<T> = {
34
34
  [K in keyof T]: T[K];
35
35
  } & {};
36
36
 
37
+ /** Returns a type with fields conditionally required based on a flag */
38
+ export type IfFlag<
39
+ OptsSchema,
40
+ Opts extends OptsSchema,
41
+ Key extends keyof OptsSchema,
42
+ Field extends object,
43
+ > = Opts extends { [K in Key]: true }
44
+ ? Field
45
+ : Opts extends { [K in Key]: false }
46
+ ? {}
47
+ : Opts extends { [K in Key]?: boolean }
48
+ ? Partial<Field>
49
+ : {};
50
+
37
51
  /**
38
52
  * Type-safe Event Emitter type
39
53
  * @example
@@ -1,51 +0,0 @@
1
- import { Buffer } from 'buffer';
2
- /**
3
- * For serializing an array of fixed length buffers.
4
- * TODO move to foundation pkg.
5
- * @param arr - Array of bufffers.
6
- * @returns The serialized buffers.
7
- */
8
- export declare function serializeBufferArrayToVector(arr: Buffer[]): Buffer<ArrayBuffer>;
9
- /**
10
- * Helper function for deserializeArrayFromVector.
11
- */
12
- type DeserializeFn<T> = (buf: Buffer, offset: number) => {
13
- /**
14
- * The deserialized type.
15
- */
16
- elem: T;
17
- /**
18
- * How many bytes to advance by.
19
- */
20
- adv: number;
21
- };
22
- /**
23
- * For deserializing numbers to 32-bit little-endian form.
24
- * TODO move to foundation pkg.
25
- * @param n - The number.
26
- * @returns The endian-corrected number.
27
- */
28
- export declare function deserializeArrayFromVector<T>(deserialize: DeserializeFn<T>, vector: Buffer, offset?: number): {
29
- elem: T[];
30
- adv: number;
31
- };
32
- /**
33
- * For serializing numbers to 32 bit little-endian form.
34
- * TODO move to foundation pkg.
35
- * @param n - The number.
36
- * @returns The endian-corrected number.
37
- */
38
- export declare function numToUInt32LE(n: number, bufferSize?: number): Buffer<ArrayBuffer>;
39
- /**
40
- * Deserialize the 256-bit number at address `offset`.
41
- * @param buf - The buffer.
42
- * @param offset - The address.
43
- * @returns The derserialized 256-bit field.
44
- */
45
- export declare function deserializeField(buf: Buffer, offset?: number): {
46
- elem: Buffer<ArrayBuffer>;
47
- adv: number;
48
- };
49
- export declare function concatenateUint8Arrays(arrayOfUint8Arrays: Uint8Array[]): Uint8Array<ArrayBuffer>;
50
- export {};
51
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VyaWFsaXplLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY3J5cHRvL3NlcmlhbGl6ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQSxPQUFPLEVBQUUsTUFBTSxFQUFFLE1BQU0sUUFBUSxDQUFDO0FBRWhDOzs7OztHQUtHO0FBQ0gsd0JBQWdCLDRCQUE0QixDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsdUJBSXpEO0FBRUQ7O0dBRUc7QUFDSCxLQUFLLGFBQWEsQ0FBQyxDQUFDLElBQUksQ0FDdEIsR0FBRyxFQUFFLE1BQU0sRUFDWCxNQUFNLEVBQUUsTUFBTSxLQUNYO0lBQ0g7O09BRUc7SUFDSCxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBQ1I7O09BRUc7SUFDSCxHQUFHLEVBQUUsTUFBTSxDQUFDO0NBQ2IsQ0FBQztBQUVGOzs7OztHQUtHO0FBQ0gsd0JBQWdCLDBCQUEwQixDQUFDLENBQUMsRUFBRSxXQUFXLEVBQUUsYUFBYSxDQUFDLENBQUMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsTUFBTSxTQUFJOzs7RUFXdEc7QUFFRDs7Ozs7R0FLRztBQUNILHdCQUFnQixhQUFhLENBQUMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxVQUFVLFNBQUksdUJBSXREO0FBRUQ7Ozs7O0dBS0c7QUFDSCx3QkFBZ0IsZ0JBQWdCLENBQUMsR0FBRyxFQUFFLE1BQU0sRUFBRSxNQUFNLFNBQUk7OztFQUd2RDtBQUVELHdCQUFnQixzQkFBc0IsQ0FBQyxrQkFBa0IsRUFBRSxVQUFVLEVBQUUsMkJBU3RFIn0=
@@ -1 +0,0 @@
1
- {"version":3,"file":"serialize.d.ts","sourceRoot":"","sources":["../../src/crypto/serialize.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,MAAM,EAAE,uBAIzD;AAED;;GAEG;AACH,KAAK,aAAa,CAAC,CAAC,IAAI,CACtB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,KACX;IACH;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;IACR;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,SAAI;;;EAWtG;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,SAAI,uBAItD;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,SAAI;;;EAGvD;AAED,wBAAgB,sBAAsB,CAAC,kBAAkB,EAAE,UAAU,EAAE,2BAStE"}
@@ -1,68 +0,0 @@
1
- // TODO find a new home for this as we move to external bb.js
2
- // See https://github.com/AztecProtocol/aztec-packages/issues/782
3
- import { Buffer } from 'buffer';
4
- /**
5
- * For serializing an array of fixed length buffers.
6
- * TODO move to foundation pkg.
7
- * @param arr - Array of bufffers.
8
- * @returns The serialized buffers.
9
- */ export function serializeBufferArrayToVector(arr) {
10
- const lengthBuf = Buffer.alloc(4);
11
- lengthBuf.writeUInt32BE(arr.length, 0);
12
- return Buffer.concat([
13
- lengthBuf,
14
- ...arr
15
- ]);
16
- }
17
- /**
18
- * For deserializing numbers to 32-bit little-endian form.
19
- * TODO move to foundation pkg.
20
- * @param n - The number.
21
- * @returns The endian-corrected number.
22
- */ export function deserializeArrayFromVector(deserialize, vector, offset = 0) {
23
- let pos = offset;
24
- const size = vector.readUInt32BE(pos);
25
- pos += 4;
26
- const arr = new Array(size);
27
- for(let i = 0; i < size; ++i){
28
- const { elem, adv } = deserialize(vector, pos);
29
- pos += adv;
30
- arr[i] = elem;
31
- }
32
- return {
33
- elem: arr,
34
- adv: pos - offset
35
- };
36
- }
37
- /**
38
- * For serializing numbers to 32 bit little-endian form.
39
- * TODO move to foundation pkg.
40
- * @param n - The number.
41
- * @returns The endian-corrected number.
42
- */ export function numToUInt32LE(n, bufferSize = 4) {
43
- const buf = Buffer.alloc(bufferSize);
44
- buf.writeUInt32LE(n, bufferSize - 4);
45
- return buf;
46
- }
47
- /**
48
- * Deserialize the 256-bit number at address `offset`.
49
- * @param buf - The buffer.
50
- * @param offset - The address.
51
- * @returns The derserialized 256-bit field.
52
- */ export function deserializeField(buf, offset = 0) {
53
- const adv = 32;
54
- return {
55
- elem: buf.slice(offset, offset + adv),
56
- adv
57
- };
58
- }
59
- export function concatenateUint8Arrays(arrayOfUint8Arrays) {
60
- const totalLength = arrayOfUint8Arrays.reduce((prev, curr)=>prev + curr.length, 0);
61
- const result = new Uint8Array(totalLength);
62
- let length = 0;
63
- for (const array of arrayOfUint8Arrays){
64
- result.set(array, length);
65
- length += array.length;
66
- }
67
- return result;
68
- }
@@ -1,25 +0,0 @@
1
- /**
2
- * Represents a message object for dispatching function calls.
3
- * Contains the function name ('fn') and an array of arguments ('args') required to call the target method.
4
- */
5
- export interface DispatchMsg {
6
- /**
7
- * Name of the target method to be called.
8
- */
9
- fn: string;
10
- /**
11
- * An array of arguments to be passed to the target method.
12
- */
13
- args: any[];
14
- }
15
- /**
16
- * Creates a dispatch function that calls the target's specified method with provided arguments.
17
- * The created dispatch function takes a DispatchMsg object as input, which contains the name of
18
- * the method to be called ('fn') and an array of arguments to be passed to the method ('args').
19
- *
20
- * @param targetFn - A function that returns the target object containing the methods to be dispatched.
21
- * @param log - Optional logging function for debugging purposes.
22
- * @returns A dispatch function that accepts a DispatchMsg object and calls the target's method with provided arguments.
23
- */
24
- export declare function createDispatchFn(targetFn: () => any, log?: import("../../log/pino-logger.js").Logger): ({ fn, args }: DispatchMsg) => Promise<any>;
25
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY3JlYXRlX2Rpc3BhdGNoX2ZuLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdHJhbnNwb3J0L2Rpc3BhdGNoL2NyZWF0ZV9kaXNwYXRjaF9mbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFJQTs7O0dBR0c7QUFDSCxNQUFNLFdBQVcsV0FBVztJQUMxQjs7T0FFRztJQUNILEVBQUUsRUFBRSxNQUFNLENBQUM7SUFDWDs7T0FFRztJQUNILElBQUksRUFBRSxHQUFHLEVBQUUsQ0FBQztDQUNiO0FBRUQ7Ozs7Ozs7O0dBUUc7QUFDSCx3QkFBZ0IsZ0JBQWdCLENBQUMsUUFBUSxFQUFFLE1BQU0sR0FBRyxFQUFFLEdBQUcsNENBQXNDLCtDQU05RiJ9
@@ -1 +0,0 @@
1
- {"version":3,"file":"create_dispatch_fn.d.ts","sourceRoot":"","sources":["../../../src/transport/dispatch/create_dispatch_fn.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,GAAG,EAAE,CAAC;CACb;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,EAAE,GAAG,4CAAsC,+CAM9F"}
@@ -1,17 +0,0 @@
1
- import { format } from 'util';
2
- import { createLogger } from '../../log/index.js';
3
- /**
4
- * Creates a dispatch function that calls the target's specified method with provided arguments.
5
- * The created dispatch function takes a DispatchMsg object as input, which contains the name of
6
- * the method to be called ('fn') and an array of arguments to be passed to the method ('args').
7
- *
8
- * @param targetFn - A function that returns the target object containing the methods to be dispatched.
9
- * @param log - Optional logging function for debugging purposes.
10
- * @returns A dispatch function that accepts a DispatchMsg object and calls the target's method with provided arguments.
11
- */ export function createDispatchFn(targetFn, log = createLogger('foundation:dispatch')) {
12
- return async ({ fn, args })=>{
13
- const target = targetFn();
14
- log.debug(format(`dispatching to ${target}: ${fn}`, args));
15
- return await target[fn](...args);
16
- };
17
- }
@@ -1,85 +0,0 @@
1
- // TODO find a new home for this as we move to external bb.js
2
- // See https://github.com/AztecProtocol/aztec-packages/issues/782
3
- import { Buffer } from 'buffer';
4
-
5
- /**
6
- * For serializing an array of fixed length buffers.
7
- * TODO move to foundation pkg.
8
- * @param arr - Array of bufffers.
9
- * @returns The serialized buffers.
10
- */
11
- export function serializeBufferArrayToVector(arr: Buffer[]) {
12
- const lengthBuf = Buffer.alloc(4);
13
- lengthBuf.writeUInt32BE(arr.length, 0);
14
- return Buffer.concat([lengthBuf, ...arr]);
15
- }
16
-
17
- /**
18
- * Helper function for deserializeArrayFromVector.
19
- */
20
- type DeserializeFn<T> = (
21
- buf: Buffer,
22
- offset: number,
23
- ) => {
24
- /**
25
- * The deserialized type.
26
- */
27
- elem: T;
28
- /**
29
- * How many bytes to advance by.
30
- */
31
- adv: number;
32
- };
33
-
34
- /**
35
- * For deserializing numbers to 32-bit little-endian form.
36
- * TODO move to foundation pkg.
37
- * @param n - The number.
38
- * @returns The endian-corrected number.
39
- */
40
- export function deserializeArrayFromVector<T>(deserialize: DeserializeFn<T>, vector: Buffer, offset = 0) {
41
- let pos = offset;
42
- const size = vector.readUInt32BE(pos);
43
- pos += 4;
44
- const arr = new Array<T>(size);
45
- for (let i = 0; i < size; ++i) {
46
- const { elem, adv } = deserialize(vector, pos);
47
- pos += adv;
48
- arr[i] = elem;
49
- }
50
- return { elem: arr, adv: pos - offset };
51
- }
52
-
53
- /**
54
- * For serializing numbers to 32 bit little-endian form.
55
- * TODO move to foundation pkg.
56
- * @param n - The number.
57
- * @returns The endian-corrected number.
58
- */
59
- export function numToUInt32LE(n: number, bufferSize = 4) {
60
- const buf = Buffer.alloc(bufferSize);
61
- buf.writeUInt32LE(n, bufferSize - 4);
62
- return buf;
63
- }
64
-
65
- /**
66
- * Deserialize the 256-bit number at address `offset`.
67
- * @param buf - The buffer.
68
- * @param offset - The address.
69
- * @returns The derserialized 256-bit field.
70
- */
71
- export function deserializeField(buf: Buffer, offset = 0) {
72
- const adv = 32;
73
- return { elem: buf.slice(offset, offset + adv), adv };
74
- }
75
-
76
- export function concatenateUint8Arrays(arrayOfUint8Arrays: Uint8Array[]) {
77
- const totalLength = arrayOfUint8Arrays.reduce((prev, curr) => prev + curr.length, 0);
78
- const result = new Uint8Array(totalLength);
79
- let length = 0;
80
- for (const array of arrayOfUint8Arrays) {
81
- result.set(array, length);
82
- length += array.length;
83
- }
84
- return result;
85
- }