feat!: napi-rs binding (#149)

* chore: add node 22 support

* chore: release v0.2.11

* feat: explore napi-rs binding

* feat: use signature sets in verifyMultipleAggregateSignatures

* chore: fix batchVerify benchmark

* feat: simplify signature set handling, async functions

* wip

* err handling

* chore: more cleanup

* chore: use threads in blst crate

* chore: add multithread benchmarks

* feat rough out sigVerify and perf test

* chore: more cleanup

* feat: add keyValidate

* chore: refresh index.d.ts

* feat: add eip 2333 fns

* feat: add aggregateSerialized fns

* feat: add validation to from_bytes

* chore: refresh index.d.ts

* chore: more cleanup

* chore: fix blstOpts benchmark

* chore: more cleanup

* feat: add hex helpers

* fix: validation in factories

* fix: default to sig_infcheck if sig_validate

* chore: fmt

* feat: stringify BLST_ERROR

* feat: async aggregate* fns

* chore: remove stray comment

* feat: switch blst to matthewkeil fork for multiply_by

* chore: update blst

* chore: add settings.json so rust displays correctly

* feat: add aggregate_with_randomness

* chore: update blst

* refactor: change aggregate_with_randomness implementation

* chore: use MultiPoint ops to do aggregate_with_randomness

* chore: bench aggregation vs aggregate_with_randomness

* chore: add test aggregateWithMsm fn

* chore: update blst

* chore: use blst bindings

* feat: implement to/from affine

* feat: add verify_multiple_aggregate_signatures_same_message

* chore: cleanup

* chore: sig to Uint8Array everywhere

* chore: update napi-rs deps

* feat: add verify_multiple_signatures_same_message_with_retries

* fix: fix struct definition

* feat: add verify_multiple_signatures_same_messages_with_retries

* chore: change the shape of same message set

* fix: stray ref

* chore: tweak shape of same msg set

* chore: add index.d.ts

* chore: update same msg shape

* chore: use Signature instead of Uint8Array

* chore: optimize aggregate fns

* chore: update submodule

* Revert "chore: optimize aggregate fns"

This reverts commit 0beec38.

* chore: fmt

* chore: move napi-rs bindings to root

* chore: replace tests

* chore: start package.json cleanup

* chore: start fixing CI

* chore: fix blst path

* chore: get spec tests passing

* chore: remove experimental fns

* chore: better error codes

* chore: cleanup

* chore: rebuild bindings

* chore: simplify spec tests

* chore: comments

* chore: simplify

* chore: start fixing tests

* chore: more test updates

* chore: pass unit tests

* chore: fix lint

* chore: fix perf test

* chore: fix up package.json and CI

* chore: more CI work

* chore: more ci

* chore: more ci

* chore: add test console.log

* chore: update test

* chore: tweak test

* chore: remove unused files

* feat: add compress for to_bytes and to_hex

* test: add back tests for compressed/uncompressed

* test: add bindings.test

* test: add case for showing which aggregate index is invalid

* chore: wip spec tests

* feat: build to_vec and fix to_hex

* chore: fix spec test functions

* chore: fix spec tests

* chore: fix some unit tests

* chore: remove stray import

* test: check aggregateWithRandomness

* test: add invalid test case to verifyMultipleAggregateSignatures.test

* test: fix fuzz tests to get working

* test: fix perf tests

* fix: remove Promise.all from runWorkRequest

* chore: some cleanup

* chore: add separate invalid hex error status

* chore: move fns

* chore: remove verify_multiple_signatures_same_message

* chore: better hex error msgs

* fix: create_rand_slice

* fix: bindings test

* chore: revert license change

* fix: add compress false in __fixtures__

* Apply suggestions from code review

Co-authored-by: Matthew Keil <me@matthewkeil.com>

* chore: remove yarn files

* chore: use napi8

* chore: update yarn lock

* chore: remove unused scripts

* chore: remove todo

* chore: refactor blst_error_to_reason

* chore: cleanup spec test compatibility layer

* chore: remove default

* chore: add check for unstaged changes

* chore: pin node 22.4

* chore: tweak workflow

* chore: use to_le_bytes

* chore: remove aggregate_with_randomness_native

* chore: update release workflow

* chore: tweak workflow job names

* fix: package.json engines node16+

* chore: remove root utils folder

* chore: cleanup .eslintrc.js

* chore: touch up tsconfig.json

* docs: update CONTRIBUTING.md

* Update README.md

Co-authored-by: Matthew Keil <me@matthewkeil.com>

* Update src/lib.rs

Co-authored-by: Matthew Keil <me@matthewkeil.com>

* chore: tweak aggregate_with

* chore: use to_ne_bytes

* Update src/lib.rs

Co-authored-by: Matthew Keil <me@matthewkeil.com>

* chore: tweak comment

* chore: remove multithreading tests

* chore: update index.d.ts

* chore: fix lint error

* chore: update comment

---------

Co-authored-by: Eric Tu <tu.eric@hotmail.com>
Co-authored-by: matthewkeil <me@matthewkeil.com>

.cargo/config.toml

@@ -0,0 +1,2 @@
+[target.x86_64-pc-windows-msvc]
+rustflags = ["-C", "target-feature=+crt-static"]

.eslintrc.js

@@ -82,17 +82,6 @@ module.exports = {
     "import/core-modules": ["node:child_process", "node:crypto", "node:fs", "node:os", "node:path", "node:util"],
   },
   overrides: [
-    {
-      files: ["lib/index.mjs"],
-      parserOptions: {
-        sourceType: "module"
-      },
-      rules: {
-        // The imports are all resolved via tsconfig.mjs.json but the root tsconfig that eslint uses
-        // shows them as unresolved.
-        "import/no-unresolved": "off",
-      },
-    }, 
     {
       files: ["test/**/*.ts"],
       rules: {
@@ -101,10 +90,9 @@ module.exports = {
       },
     }, 
     {
-      // Is a dev file and squacks about chokidar being a devDependency
-      files: ["scripts/watch.ts"],
+      files: ["test/utils/testSets.ts"],
       rules: {
-        "import/no-extraneous-dependencies": "off"
+        "no-console": "off",
       },
     },
   ],

.github/workflows/CI.yml

@@ -0,0 +1,284 @@
+name: CI
+env:
+  DEBUG: napi:*
+  APP_NAME: blst
+  MACOSX_DEPLOYMENT_TARGET: '10.13'
+permissions:
+  contents: write
+  id-token: write
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        settings:
+          - host: macos-latest
+            target: x86_64-apple-darwin
+            build: yarn build --target x86_64-apple-darwin
+          - host: windows-latest
+            build: yarn build --target x86_64-pc-windows-msvc
+            target: x86_64-pc-windows-msvc
+          - host: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian
+            build: yarn build --target x86_64-unknown-linux-gnu
+          - host: macos-latest
+            target: aarch64-apple-darwin
+            build: yarn build --target aarch64-apple-darwin
+          - host: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+            docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian-aarch64
+            build: yarn build --target aarch64-unknown-linux-gnu
+    name: Build - ${{ matrix.settings.target }} - node@22
+    runs-on: ${{ matrix.settings.host }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Setup node
+        uses: actions/setup-node@v4
+        if: ${{ !matrix.settings.docker }}
+        with:
+          node-version: '22.4.x'
+          cache: yarn
+      - name: Install
+        uses: dtolnay/rust-toolchain@stable
+        if: ${{ !matrix.settings.docker }}
+        with:
+          toolchain: stable
+          targets: ${{ matrix.settings.target }}
+      - name: Cache cargo
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            .cargo-cache
+            target/
+          key: ${{ matrix.settings.target }}-cargo-${{ matrix.settings.host }}
+      - uses: goto-bus-stop/setup-zig@v2
+        if: ${{ matrix.settings.target == 'armv7-unknown-linux-gnueabihf' || matrix.settings.target == 'armv7-unknown-linux-musleabihf' }}
+        with:
+          version: 0.11.0
+      - name: Setup toolchain
+        run: ${{ matrix.settings.setup }}
+        if: ${{ matrix.settings.setup }}
+        shell: bash
+      - name: Setup node x86
+        if: matrix.settings.target == 'i686-pc-windows-msvc'
+        run: yarn config set supportedArchitectures.cpu "ia32"
+        shell: bash
+      - name: Install dependencies
+        run: yarn install
+      - name: Setup node x86
+        uses: actions/setup-node@v4
+        if: matrix.settings.target == 'i686-pc-windows-msvc'
+        with:
+          node-version: '22.4.x'
+          cache: yarn
+          architecture: x86
+      - name: Build in docker
+        uses: addnab/docker-run-action@v3
+        if: ${{ matrix.settings.docker }}
+        with:
+          image: ${{ matrix.settings.docker }}
+          options: '--user 0:0 -v ${{ github.workspace }}/.cargo-cache/git/db:/usr/local/cargo/git/db -v ${{ github.workspace }}/.cargo/registry/cache:/usr/local/cargo/registry/cache -v ${{ github.workspace }}/.cargo/registry/index:/usr/local/cargo/registry/index -v ${{ github.workspace }}:/build -w /build'
+          run: ${{ matrix.settings.build }}
+      - name: Build
+        run: ${{ matrix.settings.build }}
+        if: ${{ !matrix.settings.docker }}
+        shell: bash
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: bindings-${{ matrix.settings.target }}
+          path: ${{ env.APP_NAME }}.*.node
+          if-no-files-found: error
+  test-macOS-windows-binding:
+    name: Test - ${{ matrix.settings.target }} - node@${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        settings:
+          - host: macos-latest
+            target: x86_64-apple-darwin
+          - host: windows-latest
+            target: x86_64-pc-windows-msvc
+        node:
+          - '18'
+          - '22.4.x'
+    runs-on: ${{ matrix.settings.host }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+          cache: yarn
+          architecture: x64
+      - name: Install dependencies
+        run: yarn install
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: bindings-${{ matrix.settings.target }}
+          path: .
+      - name: List packages
+        run: ls -R .
+        shell: bash
+      - name: Test bindings
+        run: yarn test:unit
+      - name: Download spec tests
+        run: yarn download-spec-tests
+      - name: Spec tests
+        run: yarn test:spec
+
+  test-linux-x64-gnu-binding:
+    name: Test - Linux-x64-gnu - node@${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        node:
+          - '18'
+          - '22.4.x'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+          cache: yarn
+      - name: Install dependencies
+        run: yarn install
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: bindings-x86_64-unknown-linux-gnu
+          path: .
+      - name: List packages
+        run: ls -R .
+        shell: bash
+      - name: Lint project
+        run: yarn lint
+      - name: Run napi version
+        run: yarn run version
+      - name: Ensure there are no unstaged changes
+        run: git diff --exit-code
+      - name: Test bindings
+        run: yarn test:unit
+      - name: Download spec tests
+        run: yarn download-spec-tests
+      - name: Spec tests
+        run: yarn test:spec
+
+  test-linux-aarch64-gnu-binding:
+    name: Test - aarch64-unknown-linux-gnu - node@${{ matrix.node }}
+    needs:
+      - build
+    strategy:
+      fail-fast: false
+      matrix:
+        node:
+          - '18'
+          - 22.4
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: bindings-aarch64-unknown-linux-gnu
+          path: .
+      - name: List packages
+        run: ls -R .
+        shell: bash
+      - name: Install dependencies
+        run: |
+          yarn config set supportedArchitectures.cpu "arm64"
+          yarn config set supportedArchitectures.libc "glibc"
+          yarn install
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+        with:
+          platforms: arm64
+      - run: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+      - name: Setup and run tests
+        uses: addnab/docker-run-action@v3
+        with:
+          image: node:${{ matrix.node }}-slim
+          options: '--platform linux/arm64 -v ${{ github.workspace }}:/build -w /build'
+          run: |
+            set -e
+            yarn test:unit
+            yarn download-spec-tests
+            yarn test:spec
+            ls -la
+  publish:
+    if: github.event_name != 'pull_request' && github.ref == 'refs/heads/master'
+    name: Publish
+    runs-on: ubuntu-latest
+    needs:
+      - test-macOS-windows-binding
+      - test-linux-x64-gnu-binding
+      - test-linux-aarch64-gnu-binding
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22.4.x'
+          cache: yarn
+      - name: Create tag
+        id: tag
+        uses: butlerlogic/action-autotag@1.1.2
+        with:
+          strategy: package
+          tag_prefix: "v"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Exit if no version change
+        if: steps.tag.outputs.tagcreated == 'no'
+        uses: actions/github-script@v3
+        with:
+          script: core.setFailed('The package.json version did not change. Workflow will not create a release.')
+      - name: Install dependencies
+        run: yarn install
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+      - name: Move artifacts
+        run: yarn artifacts
+      - name: List packages
+        run: ls -R ./npm
+        shell: bash
+      - name: Publish
+        run: |
+          npm config set provenance true
+          if node -e "console.log(require('./package.json').version)" | grep "v[0-9]\+\.[0-9]\+\.[0-9]\+$";
+          then
+            echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+            npm publish --access public
+          elif node -e "console.log(require('./package.json').version)" | grep "^[0-9]\+\.[0-9]\+\.[0-9]\+";
+          then
+            echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+            npm publish --tag next --access public
+          else
+            echo "Not a release, skipping publish"
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}