@aztec-labs/native 6.0.0-nightly.20260829

package/README.md

@@ -0,0 +1,3 @@
+# Native module
+
+A package containing all the native bindings needed to run Aztec.

package/dest/index.d.ts

@@ -0,0 +1,3 @@
+export * from './native_module.js';
+export { type RoundtripDuration, MsgpackChannel } from './msgpack_channel.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLG9CQUFvQixDQUFDO0FBQ25DLE9BQU8sRUFBRSxLQUFLLGlCQUFpQixFQUFFLGNBQWMsRUFBRSxNQUFNLHNCQUFzQixDQUFDIn0=

package/dest/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,KAAK,iBAAiB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC"}

package/dest/index.js

@@ -0,0 +1,2 @@
+export * from './native_module.js';
+export { MsgpackChannel } from './msgpack_channel.js';

package/dest/msgpack_channel.d.ts

@@ -0,0 +1,25 @@
+export interface MessageReceiver {
+    call(msg: Buffer | Uint8Array): Promise<Buffer | Uint8Array>;
+}
+export type RoundtripDuration = {
+    encodingUs: number;
+    callUs: number;
+    decodingUs: number;
+    totalUs: number;
+};
+type MessageBody<T extends number> = {
+    [K in T]: object | void;
+};
+export declare class MsgpackChannel<M extends number = number, Req extends MessageBody<M> = any, Resp extends MessageBody<M> = any> {
+    private dest;
+    /** A long-lived msgpack encoder */
+    private encoder;
+    private msgId;
+    constructor(dest: MessageReceiver);
+    sendMessage<T extends M>(msgType: T, body: Req[T]): Promise<{
+        duration: RoundtripDuration;
+        response: Resp[T];
+    }>;
+}
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibXNncGFja19jaGFubmVsLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvbXNncGFja19jaGFubmVsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUtBLE1BQU0sV0FBVyxlQUFlO0lBQzlCLElBQUksQ0FBQyxHQUFHLEVBQUUsTUFBTSxHQUFHLFVBQVUsR0FBRyxPQUFPLENBQUMsTUFBTSxHQUFHLFVBQVUsQ0FBQyxDQUFDO0NBQzlEO0FBRUQsTUFBTSxNQUFNLGlCQUFpQixHQUFHO0lBQzlCLFVBQVUsRUFBRSxNQUFNLENBQUM7SUFDbkIsTUFBTSxFQUFFLE1BQU0sQ0FBQztJQUNmLFVBQVUsRUFBRSxNQUFNLENBQUM7SUFDbkIsT0FBTyxFQUFFLE1BQU0sQ0FBQztDQUNqQixDQUFDO0FBWUYsS0FBSyxXQUFXLENBQUMsQ0FBQyxTQUFTLE1BQU0sSUFBSTtLQUFHLENBQUMsSUFBSSxDQUFDLEdBQUcsTUFBTSxHQUFHLElBQUk7Q0FBRSxDQUFDO0FBRWpFLHFCQUFhLGNBQWMsQ0FDekIsQ0FBQyxTQUFTLE1BQU0sR0FBRyxNQUFNLEVBQ3pCLEdBQUcsU0FBUyxXQUFXLENBQUMsQ0FBQyxDQUFDLEdBQUcsR0FBRyxFQUNoQyxJQUFJLFNBQVMsV0FBVyxDQUFDLENBQUMsQ0FBQyxHQUFHLEdBQUc7SUFZZCxPQUFPLENBQUMsSUFBSTtJQVYvQixtQ0FBbUM7SUFDbkMsT0FBTyxDQUFDLE9BQU8sQ0FLWjtJQUVILE9BQU8sQ0FBQyxLQUFLLENBQUs7SUFFbEIsWUFBMkIsSUFBSSxFQUFFLGVBQWUsRUFBSTtJQUV2QyxXQUFXLENBQUMsQ0FBQyxTQUFTLENBQUMsRUFDbEMsT0FBTyxFQUFFLENBQUMsRUFDVixJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQyxHQUNYLE9BQU8sQ0FBQztRQUFFLFFBQVEsRUFBRSxpQkFBaUIsQ0FBQztRQUFDLFFBQVEsRUFBRSxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUE7S0FBRSxDQUFDLENBMEQ3RDtDQUNGIn0=

package/dest/msgpack_channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"msgpack_channel.d.ts","sourceRoot":"","sources":["../src/msgpack_channel.ts"],"names":[],"mappings":"AAKA,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"}

package/dest/msgpack_channel.js

@@ -0,0 +1,69 @@
+import { Fr } from '@aztec-labs/foundation/curves/bn254';
+import { MessageHeader, TypedMessage } from '@aztec-labs/foundation/message';
+import { Encoder, addExtension } from 'msgpackr';
+import { isAnyArrayBuffer } from 'util/types';
+// small extension to pack an NodeJS Fr instance to a representation that the C++ code can understand
+// this only works for writes. Unpacking from C++ can't create Fr instances because the data is passed
+// as raw, untagged, buffers. On the NodeJS side we don't know what the buffer represents
+// Adding a tag would be a solution, but it would have to be done on both sides and it's unclear where else
+// C++ fr instances are sent/received/stored.
+addExtension({
+    Class: Fr,
+    write: (fr)=>fr.toBuffer()
+});
+export class MsgpackChannel {
+    dest;
+    /** A long-lived msgpack encoder */ encoder;
+    msgId;
+    constructor(dest){
+        this.dest = dest;
+        this.encoder = new Encoder({
+            // always encode JS objects as MessagePack maps
+            // this makes it compatible with other MessagePack decoders
+            useRecords: false,
+            int64AsType: 'bigint'
+        });
+        this.msgId = 1;
+    }
+    async sendMessage(msgType, body) {
+        const duration = {
+            callUs: 0,
+            totalUs: 0,
+            decodingUs: 0,
+            encodingUs: 0
+        };
+        const start = process.hrtime.bigint();
+        const requestId = this.msgId++;
+        const request = new TypedMessage(msgType, new MessageHeader({
+            requestId
+        }), body);
+        const encodedRequest = this.encoder.encode(request);
+        const encodingEnd = process.hrtime.bigint();
+        duration.encodingUs = Number((encodingEnd - start) / 1000n);
+        const encodedResponse = await this.dest.call(encodedRequest);
+        const callEnd = process.hrtime.bigint();
+        duration.callUs = Number((callEnd - encodingEnd) / 1000n);
+        const buf = Buffer.isBuffer(encodedResponse) ? encodedResponse : isAnyArrayBuffer(encodedResponse) ? Buffer.from(encodedResponse) : encodedResponse;
+        if (!Buffer.isBuffer(buf)) {
+            throw new TypeError('Invalid encoded response: expected Buffer or ArrayBuffer, got ' + (encodedResponse === null ? 'null' : typeof encodedResponse));
+        }
+        const decodedResponse = this.encoder.unpack(buf);
+        if (!TypedMessage.isTypedMessageLike(decodedResponse)) {
+            throw new TypeError('Invalid response: expected TypedMessageLike, got ' + (decodedResponse === null ? 'null' : typeof decodedResponse));
+        }
+        const response = TypedMessage.fromMessagePack(decodedResponse);
+        const decodingEnd = process.hrtime.bigint();
+        duration.decodingUs = Number((decodingEnd - callEnd) / 1000n);
+        if (response.header.requestId !== request.header.messageId) {
+            throw new Error('Response ID does not match request: ' + response.header.requestId + ' != ' + request.header.messageId);
+        }
+        if (response.msgType !== request.msgType) {
+            throw new Error('Invalid response message type: ' + response.msgType + ' != ' + response.msgType);
+        }
+        duration.totalUs = Number((process.hrtime.bigint() - start) / 1000n);
+        return {
+            duration,
+            response: response.value
+        };
+    }
+}

package/dest/native_module.d.ts

@@ -0,0 +1,7 @@
+import type { MessageReceiver } from './msgpack_channel.js';
+interface NativeClassCtor {
+    new (...args: unknown[]): MessageReceiver;
+}
+export declare const NativeLMDBStore: NativeClassCtor;
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibmF0aXZlX21vZHVsZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL25hdGl2ZV9tb2R1bGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBSUEsT0FBTyxLQUFLLEVBQUUsZUFBZSxFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFFNUQsVUFBVSxlQUFlO0lBQ3ZCLEtBQUssR0FBRyxJQUFJLEVBQUUsT0FBTyxFQUFFLEdBQUcsZUFBZSxDQUFDO0NBQzNDO0FBYUQsZUFBTyxNQUFNLGVBQWUsRUFBRSxlQUEyRCxDQUFDIn0=

package/dest/native_module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"native_module.d.ts","sourceRoot":"","sources":["../src/native_module.ts"],"names":[],"mappings":"AAIA,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,eAAe,EAAE,eAA2D,CAAC"}

package/dest/native_module.js

@@ -0,0 +1,12 @@
+import { findNapiBinary } from '@aztec/bb.js';
+import { createRequire } from 'module';
+function loadNativeModule() {
+    const require = createRequire(import.meta.url);
+    const napiPath = findNapiBinary();
+    if (!napiPath) {
+        throw new Error('NAPI binary not found for current platform.');
+    }
+    return require(napiPath);
+}
+const nativeModule = loadNativeModule();
+export const NativeLMDBStore = nativeModule.LMDBStore;

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@aztec-labs/native",
+  "version": "6.0.0-nightly.20260829",
+  "type": "module",
+  "exports": {
+    ".": "./dest/index.js"
+  },
+  "scripts": {
+    "build": "yarn clean && ../scripts/tsc.sh",
+    "build:dev": "../scripts/tsc.sh --watch",
+    "clean": "rm -rf ./dest .tsbuildinfo",
+    "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}"
+  },
+  "inherits": [
+    "../package.common.json"
+  ],
+  "dependencies": {
+    "@aztec-labs/foundation": "6.0.0-nightly.20260829",
+    "@aztec/bb.js": "6.0.0-nightly.20260826",
+    "msgpackr": "^1.11.2"
+  },
+  "devDependencies": {
+    "@jest/globals": "^30.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.15.17",
+    "@typescript/native-preview": "7.0.0-dev.20260113.1",
+    "jest": "^30.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.3.3"
+  },
+  "files": [
+    "dest",
+    "src",
+    "build",
+    "!*.test.*"
+  ],
+  "engines": {
+    "node": ">=20.10"
+  },
+  "jest": {
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
+    "transform": {
+      "^.+\\.tsx?$": [
+        "@swc/jest",
+        {
+          "jsc": {
+            "parser": {
+              "syntax": "typescript",
+              "decorators": true
+            },
+            "transform": {
+              "decoratorVersion": "2022-03"
+            }
+          }
+        }
+      ]
+    },
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.[cm]?js$": "$1"
+    },
+    "reporters": [
+      "default"
+    ],
+    "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
+    "rootDir": "./src",
+    "testTimeout": 120000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ],
+    "testEnvironment": "../../foundation/src/jest/env.mjs",
+    "setupFilesAfterEnv": [
+      "../../foundation/src/jest/setupAfterEnv.mjs"
+    ]
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './native_module.js';
+export { type RoundtripDuration, MsgpackChannel } from './msgpack_channel.js';

package/src/msgpack_channel.ts

@@ -0,0 +1,108 @@
+import { Fr } from '@aztec-labs/foundation/curves/bn254';
+import { MessageHeader, TypedMessage } from '@aztec-labs/foundation/message';
+import { Encoder, addExtension } from 'msgpackr';
+import { isAnyArrayBuffer } from 'util/types';
+
+export interface MessageReceiver {
+  call(msg: Buffer | Uint8Array): Promise<Buffer | Uint8Array>;
+}
+
+export type RoundtripDuration = {
+  encodingUs: number;
+  callUs: number;
+  decodingUs: number;
+  totalUs: number;
+};
+
+// small extension to pack an NodeJS Fr instance to a representation that the C++ code can understand
+// this only works for writes. Unpacking from C++ can't create Fr instances because the data is passed
+// as raw, untagged, buffers. On the NodeJS side we don't know what the buffer represents
+// Adding a tag would be a solution, but it would have to be done on both sides and it's unclear where else
+// C++ fr instances are sent/received/stored.
+addExtension({
+  Class: Fr,
+  write: fr => fr.toBuffer(),
+});
+
+type MessageBody<T extends number> = { [K in T]: object | void };
+
+export class MsgpackChannel<
+  M extends number = number,
+  Req extends MessageBody<M> = any,
+  Resp extends MessageBody<M> = any,
+> {
+  /** A long-lived msgpack encoder */
+  private encoder = new Encoder({
+    // always encode JS objects as MessagePack maps
+    // this makes it compatible with other MessagePack decoders
+    useRecords: false,
+    int64AsType: 'bigint',
+  });
+
+  private msgId = 1;
+
+  public constructor(private dest: MessageReceiver) {}
+
+  public async sendMessage<T extends M>(
+    msgType: T,
+    body: Req[T],
+  ): Promise<{ duration: RoundtripDuration; response: Resp[T] }> {
+    const duration: RoundtripDuration = {
+      callUs: 0,
+      totalUs: 0,
+      decodingUs: 0,
+      encodingUs: 0,
+    };
+
+    const start = process.hrtime.bigint();
+    const requestId = this.msgId++;
+
+    const request = new TypedMessage(msgType, new MessageHeader({ requestId }), body);
+    const encodedRequest = this.encoder.encode(request);
+    const encodingEnd = process.hrtime.bigint();
+    duration.encodingUs = Number((encodingEnd - start) / 1000n);
+
+    const encodedResponse = await this.dest.call(encodedRequest);
+    const callEnd = process.hrtime.bigint();
+    duration.callUs = Number((callEnd - encodingEnd) / 1000n);
+
+    const buf = Buffer.isBuffer(encodedResponse)
+      ? encodedResponse
+      : isAnyArrayBuffer(encodedResponse)
+        ? Buffer.from(encodedResponse)
+        : encodedResponse;
+
+    if (!Buffer.isBuffer(buf)) {
+      throw new TypeError(
+        'Invalid encoded response: expected Buffer or ArrayBuffer, got ' +
+          (encodedResponse === null ? 'null' : typeof encodedResponse),
+      );
+    }
+
+    const decodedResponse = this.encoder.unpack(buf);
+    if (!TypedMessage.isTypedMessageLike(decodedResponse)) {
+      throw new TypeError(
+        'Invalid response: expected TypedMessageLike, got ' +
+          (decodedResponse === null ? 'null' : typeof decodedResponse),
+      );
+    }
+
+    const response = TypedMessage.fromMessagePack<T, Resp[T]>(decodedResponse);
+    const decodingEnd = process.hrtime.bigint();
+    duration.decodingUs = Number((decodingEnd - callEnd) / 1000n);
+
+    if (response.header.requestId !== request.header.messageId) {
+      throw new Error(
+        'Response ID does not match request: ' + response.header.requestId + ' != ' + request.header.messageId,
+      );
+    }
+
+    if (response.msgType !== request.msgType) {
+      throw new Error('Invalid response message type: ' + response.msgType + ' != ' + response.msgType);
+    }
+
+    duration.totalUs = Number((process.hrtime.bigint() - start) / 1000n);
+
+    return { duration, response: response.value };
+  }
+}

package/src/native_module.ts

@@ -0,0 +1,22 @@
+import { findNapiBinary } from '@aztec/bb.js';
+
+import { createRequire } from 'module';
+
+import type { MessageReceiver } from './msgpack_channel.js';
+
+interface NativeClassCtor {
+  new (...args: unknown[]): MessageReceiver;
+}
+
+function loadNativeModule(): Record<string, NativeClassCtor> {
+  const require = createRequire(import.meta.url);
+  const napiPath = findNapiBinary();
+  if (!napiPath) {
+    throw new Error('NAPI binary not found for current platform.');
+  }
+  return require(napiPath);
+}
+
+const nativeModule: Record<string, NativeClassCtor | Function> = loadNativeModule();
+
+export const NativeLMDBStore: NativeClassCtor = nativeModule.LMDBStore as NativeClassCtor;