feat: refactor (#49)

* wip

* wip: refactor the refactor (#50)

* add blst/ to .gitignore

* fix test

* feat: remove sig_groupcheck

* fix(testSets): SECRET_KEY_LENGTH -> SECRET_KEY_SIZE

* fix(index): remove missing verify.js

* rebirth

* chore: a bit more restructuring on zig

* more updates

* feat: implement verifyMultipleAggregateSignatures

* remove redundant log

* chore: simplify signature and pk size consts

* update aggregateWithRandomness with writing pks and sigs

* simple test for AggregateSignature

* revert some changes

* fix(sig): fix fromBytes

* update bindings

* fix(verifyMultipleAggSigs): fix writers for
verifyMultipleAggregateSignatures

* uncomment tests

* missing *Signature

* chore(signature): remove unused sigValidate

* fix(signature.ts): do fromBytes first then validate

* fix test

* fix randomness

* fix: uncomment aggregateVerify test

* chore: simplify naming for signature length constants

* remove unused code

* add writeSignatures

* more test fixes

* test(pk): add test for aggregatePublicKeys

* define and use MAX_AGGREGATE_PER_JOB

* use pointers to PublicKey in aggregatePublicKey

* fix length for aggregate signatures

* remove redundant print

* AggregateSignature: fix rands input for aggregateWithRandomness

* fix scratch for aggsig and aggpk

* remove comment

* uncomment more checks

* chore: remove redundant SignatureSet

* fix rands input to aggregateWithRandomness

* fix stuff related to rands

* fixes

* remove redundant c abi code; mostly unused stuff

* update README

* chore(error): remove redundant error definitions

* chore(aggPk): cleanup AggregatePublicKey.zig

* small correciton

* more minor changes to aggPk

* chore(aggSig): doc comment and tidy up

* add dst as a const

* fix link for DST

* doc comments for pairing.zig

* finish doc comments

* fix comment

* remove comment

* remove unnecessary import

* pairing: remove unnecessary assert

* remove redundant portable

* pairing: explain that pairing owns memory

* remove all usage of c pointers in native zig code

* remove `min_pk.zig` and move declarations

Moved declarations to more appropriate places; for example for sizes of
`PublicKey` (serialize and compressed), moved their declarations to
`PublicKey`.

* fix bun lints

* pairing: refactor pairing as top-level struct

* secret_key: refactor secret_key as top-level struct

* pk: make PublicKey top level struct

* move fast verification to own file

* signature: make Signature top-level struct

* fix PublicKey.point

* move aggregateVerify test to Signature.zig

* move more tests around

* fix abi

* more descriptive errorFromInt

* chore: more descriptive namings

* fix and expose fast verif

* remove blst from gitignore now that we use zig package

* remove redundant rands

* use defined MAX_AGGREGATE_PER_JOB

* uncomment pk validation

* bun lint

* fix: use same rands for aggregateWithRandomness

* bun lint --fix

* fix incorrect usage of ptrCast

* public key back to extern struct

* bun lint fix

* signature back to extern struct

* bun lint --fix

* undo extern struct changes

* bun lint fix'

* minor AggregateSignature fixes

* do not copy pks

* bun lint

* use raw C types

* refactor entire eth_c_abi.zig to use raw C types as params

* bun lint --fix

* fix signature.zig

* bun lint --fix

* Update README

* fix aggregateVerify test count

* bun lint --fix

* expose c

---------

Co-authored-by: bing <[email protected]>

Author: wemeetagain

.gitignore

@@ -1,4 +1,4 @@
 zig-out/
 .zig-cache/
 bun/node_modules/
-bun/benchmark_data/
+bun/benchmark_data/

README.md

@@ -1,16 +1,45 @@
 # blst-z
-Zig wrapper for [supranational/blst](https://github.com/supranational/blst) native bindings, a highly performant BLS12-381 signature library.
+Zig bindings for [supranational's blst](https://github.com/supranational/blst) native bindings, a highly performant BLS12-381 signature library.
+
+This set of bindings only support the `min_pk` variant.
 
 ## Installation
-- clone blst to root: `git clone --recurse-submodules https://github.com/supranational/blst.git`
-- `zig build test`
+
+Run zig tests:
+
+```sh
+zig build test
+```
+
+Build zig library:
+
+```sh
+zig build -Doptimize=ReleaseSafe
+```
+
+Install and generate bun bindings:
+
+```sh
+cd bun && bun install && bun run build && bun generate
+```
+
+Run bun tests:
+
+```sh
+cd bun && bun test
+```
+
+Run bun benchmarks:
+
+```sh
+cd bun && bun benchmark 
+```
 
 ## Usage
-The below shows how to use min_pk namespace, should be the same for min_sig.
 
 ```zig
-pub const min_pk = @import("blst").min_pk;
-const SecretKey = min_pk.SecretKey;
+pub const blst = @import("blst");
+const SecretKey = blst.SecretKey;
 const ikm: [32]u8 = [_]u8{
     0x93, 0xad, 0x7e, 0x65, 0xde, 0xad, 0x05, 0x2a, 0x08, 0x3a,
     0x91, 0x0c, 0x8b, 0x72, 0x85, 0x91, 0x46, 0x4c, 0xca, 0x56,
@@ -27,4 +56,4 @@ const sig = sk.sign(msg[0..], dst[0..], null);
 
 // aug is null
 try sig.verify(true, msg[0..], dst[0..], null, &pk, true);
-```
+```

build.zig

@@ -12,6 +12,7 @@ pub fn build(b: *std.Build) !void {
     });
 
     const lib_blst_c = blst_c.artifact("blst");
+
     // blst module (for downstream zig consumers)
     const blst_mod = b.addModule("blst", .{
         .root_source_file = b.path("src/root.zig"),
@@ -25,7 +26,7 @@ pub fn build(b: *std.Build) !void {
     // blst dynamic library (for bun consumers)
     const blst_dylib = b.addLibrary(.{
         .root_module = b.createModule(.{
-            .root_source_file = b.path("src/root_c_abi_min_pk.zig"),
+            .root_source_file = b.path("src/eth_c_abi.zig"),
             .target = target,
             .optimize = optimize,
             // blst does not need libc, however we need to link it to enable threading
@@ -40,8 +41,6 @@ pub fn build(b: *std.Build) !void {
 
     b.installArtifact(blst_dylib);
 
-    // Creates a step for unit testing. This only builds the test executable
-    // but does not run it.
     const lib_unit_tests = b.addTest(.{
         .root_source_file = b.path("src/root.zig"),
         .target = target,
@@ -50,17 +49,6 @@ pub fn build(b: *std.Build) !void {
 
     lib_unit_tests.linkLibrary(lib_blst_c);
     const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests);
-
-    const exe_unit_tests = b.addTest(.{
-        .root_source_file = b.path("src/main.zig"),
-        .target = target,
-        .optimize = optimize,
-    });
-
-    exe_unit_tests.linkLibrary(lib_blst_c);
-    const run_exe_unit_tests = b.addRunArtifact(exe_unit_tests);
-
     const test_step = b.step("test", "Run unit tests");
     test_step.dependOn(&run_lib_unit_tests.step);
-    test_step.dependOn(&run_exe_unit_tests.step);
 }

bun/bun.lock

@@ -4,7 +4,7 @@
     "": {
       "name": "blst-bun",
       "dependencies": {
-        "@chainsafe/bun-ffi-z": "^v1.0.0",
+        "@chainsafe/bun-ffi-z": "^1.1.1",
       },
       "devDependencies": {
         "@biomejs/biome": "^1.9.3",
@@ -83,7 +83,7 @@
 
     "@chainsafe/benchmark": ["@chainsafe/[email protected]", "", { "dependencies": { "@actions/cache": "^4.0.0", "@actions/github": "^6.0.0", "@vitest/runner": "^2.1.8", "ajv": "^8.17.1", "aws-sdk": "^2.932.0", "cli-table3": "^0.6.5", "csv-parse": "^5.6.0", "csv-stringify": "^6.5.2", "debug": "^4.4.0", "glob": "^10.4.5", "log-symbols": "^7.0.0", "yaml": "^2.7.0", "yargs": "^17.7.2" }, "bin": { "benchmark": "bin/index.js" } }, "sha512-5rQKK2ar1k8DwqEMU5hTQlTrtrPzNdlfrMtbRgtrfYT/QpSADXGq1vBlywofY1D8HuEuv1LhRrn3p2rgibIXew=="],
 
-    "@chainsafe/bun-ffi-z": ["@chainsafe/bun-ffi-z@1.0.0", "", { "peerDependencies": { "typescript": "^5" }, "bin": { "bun-ffi-z": "src/cli.ts" } }, "sha512-IRQrGWvDVSWQOcNYPZqPeqMN8qRotad/84RHSxQ8xzIuhVhkpUp2lx4VeD92Tnkcwbp5Gr+tUT4Lb47nbIe1Xg=="],
+    "@chainsafe/bun-ffi-z": ["@chainsafe/bun-ffi-z@1.1.1", "", { "peerDependencies": { "typescript": "^5" }, "bin": { "bun-ffi-z": "src/cli.ts" } }, "sha512-RSJhdS8Ytj3NuEvwshAFRI/y9/GbD1IhVuYEjVt0u16Hw2owDvVUVAgiN4/g8WWcFMhs8i5a4VXiFzK25fARSA=="],
 
     "@colors/colors": ["@colors/[email protected]", "", {}, "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ=="],
 

bun/package.json

@@ -4,7 +4,7 @@
 	"module": "src/index.ts",
 	"type": "module",
 	"dependencies": {
-		"@chainsafe/bun-ffi-z": "^v1.0.0"
+		"@chainsafe/bun-ffi-z": "^1.1.1"
 	},
 	"devDependencies": {
 		"@types/bun": "latest",
@@ -20,6 +20,7 @@
 	},
 	"scripts": {
     "build": "bun ./node_modules/.bin/bun-ffi-z build",
+    "generate": "bun ./node_modules/.bin/bun-ffi-z generate-binding",
 		"prepublishOnly": "bun ./node_modules/.bin/bun-ffi-z prepublish --artifacts artifacts",
 		"publish": "bun ./node_modules/.bin/bun-ffi-z publish",
 		"test:unit": "bun test test/unit",
@@ -39,6 +40,9 @@
 			"darwin-arm64"
 		],
 		"optimize": "ReleaseSafe",
-		"zigCwd": ".."
+		"zigCwd": "..",
+		"zigExportFiles": [
+			"src/eth_c_abi.zig"
+		]
 	}
 }

bun/src/aggregate.ts

@@ -1,12 +1,13 @@
-import {binding, writeUint8ArrayArray} from "./binding.js";
-import {MAX_AGGREGATE_PER_JOB} from "./const.js";
-import {PublicKey, writePublicKeysReference} from "./publicKey.js";
-import {Signature, writeSignaturesReference} from "./signature.js";
+import {binding} from "./binding.js";
+import {pksU8, sigsU8, writePublicKeys, writeSignatures} from "./buffer.ts";
+import {MAX_AGGREGATE_PER_JOB, PUBLIC_KEY_SIZE, SIGNATURE_LENGTH} from "./const.js";
+import {PublicKey} from "./publicKey.js";
+import {Signature} from "./signature.js";
+import {writePublicKeysReference, writeSignaturesReference, writeUint8ArrayArray} from "./writers.ts";
 
 // global public keys reference to be reused across multiple calls
 // each 2 items are 8 bytes, store the reference of each public key
 const publicKeysRef = new Uint32Array(MAX_AGGREGATE_PER_JOB * 2);
-
 const signaturesRef = new Uint32Array(MAX_AGGREGATE_PER_JOB * 2);
 
 /**
@@ -23,9 +24,9 @@ export function aggregatePublicKeys(pks: Array<PublicKey>, pksValidate?: boolean
 
 	for (let i = 0; i < pks.length; i += MAX_AGGREGATE_PER_JOB) {
 		const pksBatch = pks.slice(i, Math.min(pks.length, i + MAX_AGGREGATE_PER_JOB));
-		const pksRef = writePublicKeysReference(pksBatch);
-		const outPk = PublicKey.defaultPublicKey();
-		const res = binding.aggregatePublicKeys(outPk.blst_point, pksRef, pksBatch.length, pksValidate ?? false);
+		writePublicKeys(pksBatch);
+		const outPk = new PublicKey(new Uint8Array(PUBLIC_KEY_SIZE));
+		const res = binding.publicKeyAggregate(outPk.ptr, pksU8, pksBatch.length, pksValidate ?? false);
 
 		if (res !== 0) {
 			throw new Error(`Failed to aggregate public keys: ${res}`);
@@ -50,9 +51,9 @@ export function aggregateSignatures(sigs: Array<Signature>, sigsGroupcheck?: boo
 
 	for (let i = 0; i < sigs.length; i += MAX_AGGREGATE_PER_JOB) {
 		const sigsBatch = sigs.slice(i, Math.min(sigs.length, i + MAX_AGGREGATE_PER_JOB));
-		const sigsRef = writeSignaturesReference(sigsBatch);
-		const outSig = Signature.defaultSignature();
-		const res = binding.aggregateSignatures(outSig.blst_point, sigsRef, sigsBatch.length, sigsGroupcheck ?? false);
+		writeSignatures(sigsBatch);
+		const outSig = new Signature(new Uint8Array(SIGNATURE_LENGTH));
+		const res = binding.signatureAggregate(outSig.ptr, sigsU8, sigsBatch.length, sigsGroupcheck ?? false);
 
 		if (res !== 0) {
 			throw new Error(`Failed to aggregate signatures: ${res}`);
@@ -81,14 +82,8 @@ export function aggregateSerializedPublicKeys(
 	for (let i = 0; i < pks.length; i += MAX_AGGREGATE_PER_JOB) {
 		const pksBatch = pks.slice(i, Math.min(pks.length, i + MAX_AGGREGATE_PER_JOB));
 		const pksRef = writeSerializedPublicKeysReference(pksBatch);
-		const outPk = PublicKey.defaultPublicKey();
-		const res = binding.aggregateSerializedPublicKeys(
-			outPk.blst_point,
-			pksRef,
-			pksBatch.length,
-			pks[0].length,
-			pksValidate ?? false
-		);
+		const outPk = new PublicKey(new Uint8Array(PUBLIC_KEY_SIZE));
+		const res = binding.aggregatePublicKeys(outPk.ptr, pksRef, pksBatch.length, pks[0].length, pksValidate ?? false);
 
 		if (res !== 0) {
 			throw new Error(`Failed to aggregate serialized public keys: ${res}`);
@@ -117,22 +112,18 @@ export function aggregateSerializedSignatures(
 	for (let i = 0; i < sigs.length; i += MAX_AGGREGATE_PER_JOB) {
 		const sigsBatch = sigs.slice(i, Math.min(sigs.length, i + MAX_AGGREGATE_PER_JOB));
 		const sigsRef = writeSerializedSignaturesReference(sigsBatch);
-		const outSig = Signature.defaultSignature();
-		const res = binding.aggregateSerializedSignatures(
-			outSig.blst_point,
-			sigsRef,
-			sigsBatch.length,
-			sigs[0].length,
-			sigsGroupcheck ?? false
-		);
+		const outSig = new Signature(new Uint8Array(SIGNATURE_LENGTH));
+		const res = binding.signatureAggregate(outSig.ptr, sigsRef, sigsBatch.length, sigsGroupcheck ?? false);
 
 		if (res !== 0) {
 			throw new Error(`Failed to aggregate serialized signatures: ${res}`);
 		}
 		resultSignatures.push(outSig);
 	}
 
-	return resultSignatures.length === 1 ? resultSignatures[0] : aggregateSignatures(resultSignatures, sigsGroupcheck);
+	return resultSignatures.length === 1
+		? resultSignatures[0]
+		: aggregateSerializedSignatures(resultSignatures, sigsGroupcheck);
 }
 
 function writeSerializedPublicKeysReference(pks: Uint8Array[]): Uint32Array {

bun/src/aggregateWithRandomness.ts

@@ -1,8 +1,10 @@
 import {JSCallback} from "bun:ffi";
-import {binding, writeNumber, writeReference} from "./binding.js";
-import {MAX_AGGREGATE_WITH_RANDOMNESS_PER_JOB} from "./const.js";
+import {binding} from "./binding.js";
+import {pksU8, writePublicKeys} from "./buffer.ts";
+import {MAX_AGGREGATE_WITH_RANDOMNESS_PER_JOB, PUBLIC_KEY_SIZE, SIGNATURE_LENGTH} from "./const.js";
 import {PublicKey} from "./publicKey.js";
 import {Signature} from "./signature.js";
+import {writeNumber, writePublicKeysReference, writeReference, writeSignaturesReference} from "./writers.ts";
 
 export interface PkAndSerializedSig {
 	pk: PublicKey;
@@ -14,10 +16,6 @@ export interface PkAndSig {
 	sig: Signature;
 }
 
-// global signature sets reference to be reused across multiple calls
-// each 2 tems are 8 bytes, store the reference of each PkAndSerializedSig
-const pkAndSerializedSigsRefs = new Uint32Array(MAX_AGGREGATE_WITH_RANDOMNESS_PER_JOB * 2);
-
 /**
  * Aggregate multiple public keys and multiple serialized signatures into a single blinded public key and blinded signature.
  *
@@ -33,14 +31,14 @@ export function aggregateWithRandomness(sets: Array<PkAndSerializedSig>): PkAndS
 		throw new Error("At least one PkAndSerializedSig is required");
 	}
 
-	const refs = pkAndSerializedSigsRefs.subarray(0, sets.length * 2);
-	writePkAndSerializedSigsReference(sets, refs);
-	const pkOut = PublicKey.defaultPublicKey();
-	const sigOut = Signature.defaultSignature();
+	const pksRef = writePublicKeysReference(sets.map((s) => s.pk));
+	const sigsRef = writeSignaturesReference(sets.map((s) => Signature.fromBytes(s.sig, true)));
+	const pkOut = new PublicKey(new Uint8Array(PUBLIC_KEY_SIZE));
+	const sigOut = new Signature(new Uint8Array(SIGNATURE_LENGTH));
 
-	const res = binding.aggregateWithRandomness(refs, sets.length, pkOut.blst_point, sigOut.blst_point);
+	const res = binding.aggregateWithRandomness(pkOut.ptr, sigOut.ptr, sets.length, pksRef, sigsRef, false, false);
 
-	if (res !== 0) {
+	if (res) {
 		throw new Error("Failed to aggregate with randomness res = " + res);
 	}
 
@@ -69,8 +67,8 @@ export function asyncAggregateWithRandomness(sets: Array<PkAndSerializedSig>): P
 
 	// 1s timeout
 	const TIMEOUT_MS = 1_000;
-	const pkOut = PublicKey.defaultPublicKey();
-	const sigOut = Signature.defaultSignature();
+	const pkOut = new PublicKey(new Uint8Array(PUBLIC_KEY_SIZE));
+	const sigOut = new Signature(new Uint8Array(SIGNATURE_LENGTH));
 
 	return new Promise((resolve, reject) => {
 		let jscallback: JSCallback | null = null;
@@ -107,15 +105,14 @@ export function asyncAggregateWithRandomness(sets: Array<PkAndSerializedSig>): P
 			}
 		);
 
-		// cannot reuse pkAndSerializedSigsRefs() due to async nature
 		const refs = new Uint32Array(sets.length * 2);
 		writePkAndSerializedSigsReference(sets, refs);
 
-		const res = binding.asyncAggregateWithRandomness(
+		const res = binding.aggregateWithRandomness(
 			refs,
 			sets.length,
-			pkOut.blst_point,
-			sigOut.blst_point,
+			pkOut.ptr,
+			sigOut.ptr,
 			// it's noted in bun:ffi doc that using JSCallback.prototype.ptr is faster than JSCallback object
 			jscallback.ptr
 		);
@@ -156,7 +153,7 @@ function writePkAndSerializedSigsReference(sets: PkAndSerializedSig[], out: Uint
  *
  */
 function writePkAndSerializedSigReference(set: PkAndSerializedSig, out: Uint32Array, offset: number): void {
-	set.pk.writeReference(out, offset);
+	writeReference(set.pk, out, offset);
 	writeReference(set.sig, out, offset + 2);
 	writeNumber(set.sig.length, out, offset + 4);
 }