@aztec/native 4.0.0-nightly.20250907 → 4.0.0-nightly.20260107

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.
package/dest/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
1
  export * from './native_module.js';
2
2
  export { type RoundtripDuration, MsgpackChannel } from './msgpack_channel.js';
3
- //# sourceMappingURL=index.d.ts.map
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLG9CQUFvQixDQUFDO0FBQ25DLE9BQU8sRUFBRSxLQUFLLGlCQUFpQixFQUFFLGNBQWMsRUFBRSxNQUFNLHNCQUFzQixDQUFDIn0=
@@ -22,4 +22,4 @@ export declare class MsgpackChannel<M extends number = number, Req extends Messa
22
22
  }>;
23
23
  }
24
24
  export {};
25
- //# sourceMappingURL=msgpack_channel.d.ts.map
25
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibXNncGFja19jaGFubmVsLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvbXNncGFja19jaGFubmVsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU1BLE1BQU0sV0FBVyxlQUFlO0lBQzlCLElBQUksQ0FBQyxHQUFHLEVBQUUsTUFBTSxHQUFHLFVBQVUsR0FBRyxPQUFPLENBQUMsTUFBTSxHQUFHLFVBQVUsQ0FBQyxDQUFDO0NBQzlEO0FBRUQsTUFBTSxNQUFNLGlCQUFpQixHQUFHO0lBQzlCLFVBQVUsRUFBRSxNQUFNLENBQUM7SUFDbkIsTUFBTSxFQUFFLE1BQU0sQ0FBQztJQUNmLFVBQVUsRUFBRSxNQUFNLENBQUM7SUFDbkIsT0FBTyxFQUFFLE1BQU0sQ0FBQztDQUNqQixDQUFDO0FBWUYsS0FBSyxXQUFXLENBQUMsQ0FBQyxTQUFTLE1BQU0sSUFBSTtLQUFHLENBQUMsSUFBSSxDQUFDLEdBQUcsTUFBTSxHQUFHLElBQUk7Q0FBRSxDQUFDO0FBRWpFLHFCQUFhLGNBQWMsQ0FDekIsQ0FBQyxTQUFTLE1BQU0sR0FBRyxNQUFNLEVBQ3pCLEdBQUcsU0FBUyxXQUFXLENBQUMsQ0FBQyxDQUFDLEdBQUcsR0FBRyxFQUNoQyxJQUFJLFNBQVMsV0FBVyxDQUFDLENBQUMsQ0FBQyxHQUFHLEdBQUc7SUFZZCxPQUFPLENBQUMsSUFBSTtJQVYvQixtQ0FBbUM7SUFDbkMsT0FBTyxDQUFDLE9BQU8sQ0FLWjtJQUVILE9BQU8sQ0FBQyxLQUFLLENBQUs7SUFFbEIsWUFBMkIsSUFBSSxFQUFFLGVBQWUsRUFBSTtJQUV2QyxXQUFXLENBQUMsQ0FBQyxTQUFTLENBQUMsRUFDbEMsT0FBTyxFQUFFLENBQUMsRUFDVixJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQyxHQUNYLE9BQU8sQ0FBQztRQUFFLFFBQVEsRUFBRSxpQkFBaUIsQ0FBQztRQUFDLFFBQVEsRUFBRSxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUE7S0FBRSxDQUFDLENBMEQ3RDtDQUNGIn0=
@@ -1 +1 @@
1
- {"version":3,"file":"msgpack_channel.d.ts","sourceRoot":"","sources":["../src/msgpack_channel.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC;CAC9D;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAYF,KAAK,WAAW,CAAC,CAAC,SAAS,MAAM,IAAI;KAAG,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI;CAAE,CAAC;AAEjE,qBAAa,cAAc,CACzB,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,GAAG,SAAS,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,EAChC,IAAI,SAAS,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG;IAYd,OAAO,CAAC,IAAI;IAV/B,mCAAmC;IACnC,OAAO,CAAC,OAAO,CAKZ;IAEH,OAAO,CAAC,KAAK,CAAK;gBAES,IAAI,EAAE,eAAe;IAEnC,WAAW,CAAC,CAAC,SAAS,CAAC,EAClC,OAAO,EAAE,CAAC,EACV,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,GACX,OAAO,CAAC;QAAE,QAAQ,EAAE,iBAAiB,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC;CA2D/D"}
1
+ {"version":3,"file":"msgpack_channel.d.ts","sourceRoot":"","sources":["../src/msgpack_channel.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,CAAC;CAC9D;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAYF,KAAK,WAAW,CAAC,CAAC,SAAS,MAAM,IAAI;KAAG,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI;CAAE,CAAC;AAEjE,qBAAa,cAAc,CACzB,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,GAAG,SAAS,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,EAChC,IAAI,SAAS,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG;IAYd,OAAO,CAAC,IAAI;IAV/B,mCAAmC;IACnC,OAAO,CAAC,OAAO,CAKZ;IAEH,OAAO,CAAC,KAAK,CAAK;IAElB,YAA2B,IAAI,EAAE,eAAe,EAAI;IAEvC,WAAW,CAAC,CAAC,SAAS,CAAC,EAClC,OAAO,EAAE,CAAC,EACV,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,GACX,OAAO,CAAC;QAAE,QAAQ,EAAE,iBAAiB,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC,CA0D7D;CACF"}
@@ -1,4 +1,4 @@
1
- import { Fr } from '@aztec/foundation/fields';
1
+ import { Fr } from '@aztec/foundation/curves/bn254';
2
2
  import { MessageHeader, TypedMessage } from '@aztec/foundation/message';
3
3
  import { Encoder, addExtension } from 'msgpackr';
4
4
  import { isAnyArrayBuffer } from 'util/types';
@@ -1,8 +1,100 @@
1
+ import { type LogLevel } from '@aztec/foundation/log';
1
2
  import type { MessageReceiver } from './msgpack_channel.js';
2
3
  interface NativeClassCtor {
3
4
  new (...args: unknown[]): MessageReceiver;
4
5
  }
5
6
  export declare const NativeWorldState: NativeClassCtor;
6
7
  export declare const NativeLMDBStore: NativeClassCtor;
8
+ /**
9
+ * Contract provider interface for callbacks to fetch contract data.
10
+ * These callbacks are invoked by C++ during simulation when contract data is needed.
11
+ */
12
+ export interface ContractProvider {
13
+ /**
14
+ * Fetch a contract instance by address.
15
+ * @param address - The contract address as a string (hex format)
16
+ * @returns Promise resolving to msgpack-serialized ContractInstanceHint buffer, or undefined if not found
17
+ */
18
+ getContractInstance(address: string): Promise<Buffer | undefined>;
19
+ /**
20
+ * Fetch a contract class by class ID.
21
+ * @param classId - The contract class ID as a string (hex format)
22
+ * @returns Promise resolving to msgpack-serialized ContractClassHint buffer, or undefined if not found
23
+ */
24
+ getContractClass(classId: string): Promise<Buffer | undefined>;
25
+ /**
26
+ * Add contracts from deployment data.
27
+ * @param contractDeploymentData - Msgpack-serialized ContractDeploymentData buffer
28
+ * @returns Promise that resolves when contracts are added
29
+ */
30
+ addContracts(contractDeploymentData: Buffer): Promise<void>;
31
+ /**
32
+ * Fetch the bytecode commitment for a contract class.
33
+ * @param classId - The contract class ID as a string (hex format)
34
+ * @returns Promise resolving to msgpack-serialized Fr buffer, or undefined if not found
35
+ */
36
+ getBytecodeCommitment(classId: string): Promise<Buffer | undefined>;
37
+ /**
38
+ * Fetch the debug function name for a contract function.
39
+ * @param address - The contract address as a string (hex format)
40
+ * @param selector - The function selector as a string (hex format)
41
+ * @returns Promise resolving to function name string, or undefined if not found
42
+ */
43
+ getDebugFunctionName(address: string, selector: string): Promise<string | undefined>;
44
+ /**
45
+ * Create a new checkpoint for the contract database state.
46
+ * Enables rollback to current state in case of a revert.
47
+ * @returns Promise that resolves when checkpoint is created
48
+ */
49
+ createCheckpoint(): Promise<void>;
50
+ /**
51
+ * Commit the current checkpoint, accepting its state as latest.
52
+ * @returns Promise that resolves when checkpoint is committed
53
+ */
54
+ commitCheckpoint(): Promise<void>;
55
+ /**
56
+ * Revert the current checkpoint, discarding its state and rolling back.
57
+ * @returns Promise that resolves when checkpoint is reverted
58
+ */
59
+ revertCheckpoint(): Promise<void>;
60
+ }
61
+ /**
62
+ * Cancellation token handle used to cancel C++ AVM simulation.
63
+ * The token is created via createCancellationToken() and can be cancelled via cancelSimulation().
64
+ * Pass it to avmSimulate to enable cancellation support.
65
+ */
66
+ export type CancellationToken = any;
67
+ /**
68
+ * Create a new cancellation token for C++ simulation.
69
+ * This token can be passed to avmSimulate and later cancelled via cancelSimulation().
70
+ * @returns A handle to a cancellation token
71
+ */
72
+ export declare function createCancellationToken(): CancellationToken;
73
+ /**
74
+ * Signal cancellation to a C++ simulation.
75
+ * The simulation will stop at the next opcode or before the next WorldState write.
76
+ * @param token - The cancellation token previously passed to avmSimulate
77
+ */
78
+ export declare function cancelSimulation(token: CancellationToken): void;
79
+ /**
80
+ * AVM simulation function that takes serialized inputs and a contract provider.
81
+ * The contract provider enables C++ to callback to TypeScript for contract data during simulation.
82
+ * @param inputs - Msgpack-serialized AvmFastSimulationInputs buffer
83
+ * @param contractProvider - Object with callbacks for fetching contract instances and classes
84
+ * @param worldStateHandle - Native handle to WorldState instance
85
+ * @param logLevel - Log level to control C++ verbosity
86
+ * @param cancellationToken - Optional token to enable cancellation support
87
+ * @returns Promise resolving to msgpack-serialized AvmCircuitPublicInputs buffer
88
+ */
89
+ export declare function avmSimulate(inputs: Buffer, contractProvider: ContractProvider, worldStateHandle: any, logLevel?: LogLevel, cancellationToken?: CancellationToken): Promise<Buffer>;
90
+ /**
91
+ * AVM simulation function that uses pre-collected hints from TypeScript simulation.
92
+ * All contract data and merkle tree hints are included in the AvmCircuitInputs, so no runtime
93
+ * callbacks to TS or WS pointer are needed.
94
+ * @param inputs - Msgpack-serialized AvmCircuitInputs (AvmProvingInputs in C++) buffer
95
+ * @param logLevel - Log level to control C++ verbosity
96
+ * @returns Promise resolving to msgpack-serialized simulation results buffer
97
+ */
98
+ export declare function avmSimulateWithHintedDbs(inputs: Buffer, logLevel?: LogLevel): Promise<Buffer>;
7
99
  export {};
8
- //# sourceMappingURL=native_module.d.ts.map
100
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibmF0aXZlX21vZHVsZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL25hdGl2ZV9tb2R1bGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLEtBQUssUUFBUSxFQUFhLE1BQU0sdUJBQXVCLENBQUM7QUFLakUsT0FBTyxLQUFLLEVBQUUsZUFBZSxFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFFNUQsVUFBVSxlQUFlO0lBQ3ZCLEtBQUssR0FBRyxJQUFJLEVBQUUsT0FBTyxFQUFFLEdBQUcsZUFBZSxDQUFDO0NBQzNDO0FBYUQsZUFBTyxNQUFNLGdCQUFnQixFQUFFLGVBQTRELENBQUM7QUFDNUYsZUFBTyxNQUFNLGVBQWUsRUFBRSxlQUEyRCxDQUFDO0FBRTFGOzs7R0FHRztBQUNILE1BQU0sV0FBVyxnQkFBZ0I7SUFDL0I7Ozs7T0FJRztJQUNILG1CQUFtQixDQUFDLE9BQU8sRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLE1BQU0sR0FBRyxTQUFTLENBQUMsQ0FBQztJQUNsRTs7OztPQUlHO0lBQ0gsZ0JBQWdCLENBQUMsT0FBTyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsTUFBTSxHQUFHLFNBQVMsQ0FBQyxDQUFDO0lBRS9EOzs7O09BSUc7SUFDSCxZQUFZLENBQUMsc0JBQXNCLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUU1RDs7OztPQUlHO0lBQ0gscUJBQXFCLENBQUMsT0FBTyxFQUFFLE1BQU0sR0FBRyxPQUFPLENBQUMsTUFBTSxHQUFHLFNBQVMsQ0FBQyxDQUFDO0lBRXBFOzs7OztPQUtHO0lBQ0gsb0JBQW9CLENBQUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxRQUFRLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLENBQUM7SUFFckY7Ozs7T0FJRztJQUNILGdCQUFnQixJQUFJLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUVsQzs7O09BR0c7SUFDSCxnQkFBZ0IsSUFBSSxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7SUFFbEM7OztPQUdHO0lBQ0gsZ0JBQWdCLElBQUksT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO0NBQ25DO0FBbUJEOzs7O0dBSUc7QUFDSCxNQUFNLE1BQU0saUJBQWlCLEdBQUcsR0FBRyxDQUFDO0FBRXBDOzs7O0dBSUc7QUFDSCx3QkFBZ0IsdUJBQXVCLElBQUksaUJBQWlCLENBRTNEO0FBRUQ7Ozs7R0FJRztBQUNILHdCQUFnQixnQkFBZ0IsQ0FBQyxLQUFLLEVBQUUsaUJBQWlCLEdBQUcsSUFBSSxDQUUvRDtBQWlCRDs7Ozs7Ozs7O0dBU0c7QUFDSCx3QkFBc0IsV0FBVyxDQUMvQixNQUFNLEVBQUUsTUFBTSxFQUNkLGdCQUFnQixFQUFFLGdCQUFnQixFQUNsQyxnQkFBZ0IsRUFBRSxHQUFHLEVBQ3JCLFFBQVEsR0FBRSxRQUFpQixFQUMzQixpQkFBaUIsQ0FBQyxFQUFFLGlCQUFpQixHQUNwQyxPQUFPLENBQUMsTUFBTSxDQUFDLENBYWpCO0FBRUQ7Ozs7Ozs7R0FPRztBQUNILHdCQUFzQix3QkFBd0IsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLFFBQVEsR0FBRSxRQUFpQixHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FPM0cifQ==
@@ -1 +1 @@
1
- {"version":3,"file":"native_module.d.ts","sourceRoot":"","sources":["../src/native_module.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,UAAU,eAAe;IACvB,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;CAC3C;AAID,eAAO,MAAM,gBAAgB,EAAE,eAAyC,CAAC;AACzE,eAAO,MAAM,eAAe,EAAE,eAAwC,CAAC"}
1
+ {"version":3,"file":"native_module.d.ts","sourceRoot":"","sources":["../src/native_module.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,QAAQ,EAAa,MAAM,uBAAuB,CAAC;AAKjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,UAAU,eAAe;IACvB,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;CAC3C;AAaD,eAAO,MAAM,gBAAgB,EAAE,eAA4D,CAAC;AAC5F,eAAO,MAAM,eAAe,EAAE,eAA2D,CAAC;AAE1F;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAClE;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAE/D;;;;OAIG;IACH,YAAY,CAAC,sBAAsB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5D;;;;OAIG;IACH,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEpE;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAErF;;;;OAIG;IACH,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC;;;OAGG;IACH,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC;;;OAGG;IACH,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACnC;AAmBD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAEpC;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,iBAAiB,CAE3D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAE/D;AAiBD;;;;;;;;;GASG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,gBAAgB,EAClC,gBAAgB,EAAE,GAAG,EACrB,QAAQ,GAAE,QAAiB,EAC3B,iBAAiB,CAAC,EAAE,iBAAiB,GACpC,OAAO,CAAC,MAAM,CAAC,CAajB;AAED;;;;;;;GAOG;AACH,wBAAsB,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAE,QAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,CAO3G"}
@@ -1,4 +1,79 @@
1
- import bindings from 'bindings';
2
- const nativeModule = bindings('nodejs_module');
1
+ import { findNapiBinary } from '@aztec/bb.js';
2
+ import { LogLevels } from '@aztec/foundation/log';
3
+ import { Semaphore } from '@aztec/foundation/queue';
4
+ import { createRequire } from 'module';
5
+ function loadNativeModule() {
6
+ const require = createRequire(import.meta.url);
7
+ const napiPath = findNapiBinary();
8
+ if (!napiPath) {
9
+ throw new Error('NAPI binary not found for current platform.');
10
+ }
11
+ return require(napiPath);
12
+ }
13
+ const nativeModule = loadNativeModule();
3
14
  export const NativeWorldState = nativeModule.WorldState;
4
15
  export const NativeLMDBStore = nativeModule.LMDBStore;
16
+ // Internal native functions with numeric log level
17
+ const nativeAvmSimulate = nativeModule.avmSimulate;
18
+ const nativeAvmSimulateWithHintedDbs = nativeModule.avmSimulateWithHintedDbs;
19
+ const nativeCreateCancellationToken = nativeModule.createCancellationToken;
20
+ const nativeCancelSimulation = nativeModule.cancelSimulation;
21
+ /**
22
+ * Create a new cancellation token for C++ simulation.
23
+ * This token can be passed to avmSimulate and later cancelled via cancelSimulation().
24
+ * @returns A handle to a cancellation token
25
+ */ export function createCancellationToken() {
26
+ return nativeCreateCancellationToken();
27
+ }
28
+ /**
29
+ * Signal cancellation to a C++ simulation.
30
+ * The simulation will stop at the next opcode or before the next WorldState write.
31
+ * @param token - The cancellation token previously passed to avmSimulate
32
+ */ export function cancelSimulation(token) {
33
+ nativeCancelSimulation(token);
34
+ }
35
+ /**
36
+ * Concurrency limiting for C++ AVM simulation to prevent libuv thread pool exhaustion.
37
+ *
38
+ * The C++ simulator uses NAPI BlockingCall to callback to TypeScript for contract data.
39
+ * This blocks the libuv thread while waiting for the callback to complete. If all libuv
40
+ * threads are blocked waiting for callbacks, no threads remain to service those callbacks,
41
+ * causing deadlock.
42
+ *
43
+ * We limit concurrent simulations to UV_THREADPOOL_SIZE / 2 to ensure threads remain
44
+ * available for callback processing.
45
+ */ const UV_THREADPOOL_SIZE = parseInt(process.env.UV_THREADPOOL_SIZE ?? '4', 10);
46
+ const MAX_CONCURRENT_AVM_SIMULATIONS = Math.max(1, Math.floor(UV_THREADPOOL_SIZE / 2));
47
+ const avmSimulationSemaphore = new Semaphore(MAX_CONCURRENT_AVM_SIMULATIONS);
48
+ /**
49
+ * AVM simulation function that takes serialized inputs and a contract provider.
50
+ * The contract provider enables C++ to callback to TypeScript for contract data during simulation.
51
+ * @param inputs - Msgpack-serialized AvmFastSimulationInputs buffer
52
+ * @param contractProvider - Object with callbacks for fetching contract instances and classes
53
+ * @param worldStateHandle - Native handle to WorldState instance
54
+ * @param logLevel - Log level to control C++ verbosity
55
+ * @param cancellationToken - Optional token to enable cancellation support
56
+ * @returns Promise resolving to msgpack-serialized AvmCircuitPublicInputs buffer
57
+ */ export async function avmSimulate(inputs, contractProvider, worldStateHandle, logLevel = 'info', cancellationToken) {
58
+ await avmSimulationSemaphore.acquire();
59
+ try {
60
+ return await nativeAvmSimulate(inputs, contractProvider, worldStateHandle, LogLevels.indexOf(logLevel), cancellationToken);
61
+ } finally{
62
+ avmSimulationSemaphore.release();
63
+ }
64
+ }
65
+ /**
66
+ * AVM simulation function that uses pre-collected hints from TypeScript simulation.
67
+ * All contract data and merkle tree hints are included in the AvmCircuitInputs, so no runtime
68
+ * callbacks to TS or WS pointer are needed.
69
+ * @param inputs - Msgpack-serialized AvmCircuitInputs (AvmProvingInputs in C++) buffer
70
+ * @param logLevel - Log level to control C++ verbosity
71
+ * @returns Promise resolving to msgpack-serialized simulation results buffer
72
+ */ export async function avmSimulateWithHintedDbs(inputs, logLevel = 'info') {
73
+ await avmSimulationSemaphore.acquire();
74
+ try {
75
+ return await nativeAvmSimulateWithHintedDbs(inputs, LogLevels.indexOf(logLevel));
76
+ } finally{
77
+ avmSimulationSemaphore.release();
78
+ }
79
+ }
package/package.json CHANGED
@@ -1,33 +1,29 @@
1
1
  {
2
2
  "name": "@aztec/native",
3
- "version": "4.0.0-nightly.20250907",
3
+ "version": "4.0.0-nightly.20260107",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": "./dest/index.js"
7
7
  },
8
8
  "scripts": {
9
- "build": "yarn clean && yarn generate && tsc -b",
10
- "build:dev": "tsc -b --watch",
11
- "build:cpp": "PROJECT=$(pwd); cd $(git rev-parse --show-toplevel)/barretenberg/cpp; cmake --preset ${PRESET:-clang16-pic} && cmake --build --preset ${PRESET:-clang16-pic} --target nodejs_module && cd $PROJECT && yarn generate",
12
- "clean:cpp": "rm -rf $(git rev-parse --show-toplevel)/barretenberg/cpp/build-pic",
9
+ "build": "yarn clean && ../scripts/tsc.sh",
10
+ "build:dev": "../scripts/tsc.sh --watch",
13
11
  "clean": "rm -rf ./dest .tsbuildinfo",
14
- "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}",
15
- "generate": "mkdir -p build && cp -v $(git rev-parse --show-toplevel)/barretenberg/cpp/build-pic/lib/nodejs_module.node build"
12
+ "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}"
16
13
  },
17
14
  "inherits": [
18
- "../package.common.json",
19
- "./package.local.json"
15
+ "../package.common.json"
20
16
  ],
21
17
  "dependencies": {
22
- "@aztec/foundation": "4.0.0-nightly.20250907",
23
- "bindings": "^1.5.0",
18
+ "@aztec/bb.js": "4.0.0-nightly.20260107",
19
+ "@aztec/foundation": "4.0.0-nightly.20260107",
24
20
  "msgpackr": "^1.11.2"
25
21
  },
26
22
  "devDependencies": {
27
23
  "@jest/globals": "^30.0.0",
28
- "@types/bindings": "^1.5.5",
29
24
  "@types/jest": "^30.0.0",
30
25
  "@types/node": "^22.15.17",
26
+ "@typescript/native-preview": "7.0.0-dev.20251126.1",
31
27
  "jest": "^30.0.0",
32
28
  "ts-node": "^10.9.1",
33
29
  "typescript": "^5.3.3"
@@ -35,6 +31,7 @@
35
31
  "files": [
36
32
  "dest",
37
33
  "src",
34
+ "build",
38
35
  "!*.test.*"
39
36
  ],
40
37
  "engines": {
@@ -1,4 +1,4 @@
1
- import { Fr } from '@aztec/foundation/fields';
1
+ import { Fr } from '@aztec/foundation/curves/bn254';
2
2
  import { MessageHeader, TypedMessage } from '@aztec/foundation/message';
3
3
 
4
4
  import { Encoder, addExtension } from 'msgpackr';
@@ -1,4 +1,8 @@
1
- import bindings from 'bindings';
1
+ import { findNapiBinary } from '@aztec/bb.js';
2
+ import { type LogLevel, LogLevels } from '@aztec/foundation/log';
3
+ import { Semaphore } from '@aztec/foundation/queue';
4
+
5
+ import { createRequire } from 'module';
2
6
 
3
7
  import type { MessageReceiver } from './msgpack_channel.js';
4
8
 
@@ -6,7 +10,181 @@ interface NativeClassCtor {
6
10
  new (...args: unknown[]): MessageReceiver;
7
11
  }
8
12
 
9
- const nativeModule: Record<string, NativeClassCtor> = bindings('nodejs_module');
13
+ function loadNativeModule(): Record<string, NativeClassCtor> {
14
+ const require = createRequire(import.meta.url);
15
+ const napiPath = findNapiBinary();
16
+ if (!napiPath) {
17
+ throw new Error('NAPI binary not found for current platform.');
18
+ }
19
+ return require(napiPath);
20
+ }
21
+
22
+ const nativeModule: Record<string, NativeClassCtor | Function> = loadNativeModule();
23
+
24
+ export const NativeWorldState: NativeClassCtor = nativeModule.WorldState as NativeClassCtor;
25
+ export const NativeLMDBStore: NativeClassCtor = nativeModule.LMDBStore as NativeClassCtor;
26
+
27
+ /**
28
+ * Contract provider interface for callbacks to fetch contract data.
29
+ * These callbacks are invoked by C++ during simulation when contract data is needed.
30
+ */
31
+ export interface ContractProvider {
32
+ /**
33
+ * Fetch a contract instance by address.
34
+ * @param address - The contract address as a string (hex format)
35
+ * @returns Promise resolving to msgpack-serialized ContractInstanceHint buffer, or undefined if not found
36
+ */
37
+ getContractInstance(address: string): Promise<Buffer | undefined>;
38
+ /**
39
+ * Fetch a contract class by class ID.
40
+ * @param classId - The contract class ID as a string (hex format)
41
+ * @returns Promise resolving to msgpack-serialized ContractClassHint buffer, or undefined if not found
42
+ */
43
+ getContractClass(classId: string): Promise<Buffer | undefined>;
44
+
45
+ /**
46
+ * Add contracts from deployment data.
47
+ * @param contractDeploymentData - Msgpack-serialized ContractDeploymentData buffer
48
+ * @returns Promise that resolves when contracts are added
49
+ */
50
+ addContracts(contractDeploymentData: Buffer): Promise<void>;
51
+
52
+ /**
53
+ * Fetch the bytecode commitment for a contract class.
54
+ * @param classId - The contract class ID as a string (hex format)
55
+ * @returns Promise resolving to msgpack-serialized Fr buffer, or undefined if not found
56
+ */
57
+ getBytecodeCommitment(classId: string): Promise<Buffer | undefined>;
58
+
59
+ /**
60
+ * Fetch the debug function name for a contract function.
61
+ * @param address - The contract address as a string (hex format)
62
+ * @param selector - The function selector as a string (hex format)
63
+ * @returns Promise resolving to function name string, or undefined if not found
64
+ */
65
+ getDebugFunctionName(address: string, selector: string): Promise<string | undefined>;
66
+
67
+ /**
68
+ * Create a new checkpoint for the contract database state.
69
+ * Enables rollback to current state in case of a revert.
70
+ * @returns Promise that resolves when checkpoint is created
71
+ */
72
+ createCheckpoint(): Promise<void>;
73
+
74
+ /**
75
+ * Commit the current checkpoint, accepting its state as latest.
76
+ * @returns Promise that resolves when checkpoint is committed
77
+ */
78
+ commitCheckpoint(): Promise<void>;
79
+
80
+ /**
81
+ * Revert the current checkpoint, discarding its state and rolling back.
82
+ * @returns Promise that resolves when checkpoint is reverted
83
+ */
84
+ revertCheckpoint(): Promise<void>;
85
+ }
86
+
87
+ // Internal native functions with numeric log level
88
+ const nativeAvmSimulate = nativeModule.avmSimulate as (
89
+ inputs: Buffer,
90
+ contractProvider: ContractProvider,
91
+ worldStateHandle: any,
92
+ logLevel: number,
93
+ cancellationToken?: any,
94
+ ) => Promise<Buffer>;
95
+
96
+ const nativeAvmSimulateWithHintedDbs = nativeModule.avmSimulateWithHintedDbs as (
97
+ inputs: Buffer,
98
+ logLevel: number,
99
+ ) => Promise<Buffer>;
100
+
101
+ const nativeCreateCancellationToken = nativeModule.createCancellationToken as () => any;
102
+ const nativeCancelSimulation = nativeModule.cancelSimulation as (token: any) => void;
103
+
104
+ /**
105
+ * Cancellation token handle used to cancel C++ AVM simulation.
106
+ * The token is created via createCancellationToken() and can be cancelled via cancelSimulation().
107
+ * Pass it to avmSimulate to enable cancellation support.
108
+ */
109
+ export type CancellationToken = any;
110
+
111
+ /**
112
+ * Create a new cancellation token for C++ simulation.
113
+ * This token can be passed to avmSimulate and later cancelled via cancelSimulation().
114
+ * @returns A handle to a cancellation token
115
+ */
116
+ export function createCancellationToken(): CancellationToken {
117
+ return nativeCreateCancellationToken();
118
+ }
119
+
120
+ /**
121
+ * Signal cancellation to a C++ simulation.
122
+ * The simulation will stop at the next opcode or before the next WorldState write.
123
+ * @param token - The cancellation token previously passed to avmSimulate
124
+ */
125
+ export function cancelSimulation(token: CancellationToken): void {
126
+ nativeCancelSimulation(token);
127
+ }
128
+
129
+ /**
130
+ * Concurrency limiting for C++ AVM simulation to prevent libuv thread pool exhaustion.
131
+ *
132
+ * The C++ simulator uses NAPI BlockingCall to callback to TypeScript for contract data.
133
+ * This blocks the libuv thread while waiting for the callback to complete. If all libuv
134
+ * threads are blocked waiting for callbacks, no threads remain to service those callbacks,
135
+ * causing deadlock.
136
+ *
137
+ * We limit concurrent simulations to UV_THREADPOOL_SIZE / 2 to ensure threads remain
138
+ * available for callback processing.
139
+ */
140
+ const UV_THREADPOOL_SIZE = parseInt(process.env.UV_THREADPOOL_SIZE ?? '4', 10);
141
+ const MAX_CONCURRENT_AVM_SIMULATIONS = Math.max(1, Math.floor(UV_THREADPOOL_SIZE / 2));
142
+ const avmSimulationSemaphore = new Semaphore(MAX_CONCURRENT_AVM_SIMULATIONS);
10
143
 
11
- export const NativeWorldState: NativeClassCtor = nativeModule.WorldState;
12
- export const NativeLMDBStore: NativeClassCtor = nativeModule.LMDBStore;
144
+ /**
145
+ * AVM simulation function that takes serialized inputs and a contract provider.
146
+ * The contract provider enables C++ to callback to TypeScript for contract data during simulation.
147
+ * @param inputs - Msgpack-serialized AvmFastSimulationInputs buffer
148
+ * @param contractProvider - Object with callbacks for fetching contract instances and classes
149
+ * @param worldStateHandle - Native handle to WorldState instance
150
+ * @param logLevel - Log level to control C++ verbosity
151
+ * @param cancellationToken - Optional token to enable cancellation support
152
+ * @returns Promise resolving to msgpack-serialized AvmCircuitPublicInputs buffer
153
+ */
154
+ export async function avmSimulate(
155
+ inputs: Buffer,
156
+ contractProvider: ContractProvider,
157
+ worldStateHandle: any,
158
+ logLevel: LogLevel = 'info',
159
+ cancellationToken?: CancellationToken,
160
+ ): Promise<Buffer> {
161
+ await avmSimulationSemaphore.acquire();
162
+ try {
163
+ return await nativeAvmSimulate(
164
+ inputs,
165
+ contractProvider,
166
+ worldStateHandle,
167
+ LogLevels.indexOf(logLevel),
168
+ cancellationToken,
169
+ );
170
+ } finally {
171
+ avmSimulationSemaphore.release();
172
+ }
173
+ }
174
+
175
+ /**
176
+ * AVM simulation function that uses pre-collected hints from TypeScript simulation.
177
+ * All contract data and merkle tree hints are included in the AvmCircuitInputs, so no runtime
178
+ * callbacks to TS or WS pointer are needed.
179
+ * @param inputs - Msgpack-serialized AvmCircuitInputs (AvmProvingInputs in C++) buffer
180
+ * @param logLevel - Log level to control C++ verbosity
181
+ * @returns Promise resolving to msgpack-serialized simulation results buffer
182
+ */
183
+ export async function avmSimulateWithHintedDbs(inputs: Buffer, logLevel: LogLevel = 'info'): Promise<Buffer> {
184
+ await avmSimulationSemaphore.acquire();
185
+ try {
186
+ return await nativeAvmSimulateWithHintedDbs(inputs, LogLevels.indexOf(logLevel));
187
+ } finally {
188
+ avmSimulationSemaphore.release();
189
+ }
190
+ }