c-kzg-4844/bindings/node.js
dancoffman 72f696e119
File order matters to the linker. GCC demands this order.
2022-11-08 12:47:19 -08:00
..
.gitignore gyp that maybe works on yarn install 2022-11-05 00:28:36 -07:00
.npmignore Required to publish blst/build 2022-11-05 00:36:38 -07:00
.prettierignore Do not run prettier on dist 2022-11-03 22:37:56 -07:00
.prettierrc.json Messy publish but it works 2022-11-05 00:46:26 -07:00
Makefile Make publish less able to leave files in bad state 2022-11-07 14:37:46 -08:00
README.md Patch blst submodule sha 2022-11-04 00:13:02 -07:00
babel.config.js Cleanup 2022-11-03 15:13:49 -07:00
binding.dist.gyp File order matters to the linker. GCC demands this order. 2022-11-08 12:47:19 -08:00
binding.gyp File order matters to the linker. GCC demands this order. 2022-11-08 12:47:19 -08:00
jest.config.js Cleanup 2022-11-03 15:13:49 -07:00
kzg.cxx free earlier when both subsequent branches will free. Throw appropriately on verify_kzg_proof failure 2022-11-04 14:12:11 -07:00
kzg.ts Be better at TypeScript 2022-11-04 13:29:52 -07:00
package.json File order matters to the linker. GCC demands this order. 2022-11-08 12:47:19 -08:00
rollup.config.js Start working on NPM publish 2022-11-04 18:48:52 -07:00
test.ts Use BYTES_PER_FIELD_ELEMENT 2022-11-04 11:44:57 -07:00
tsconfig.json Do not run prettier on dist 2022-11-03 22:37:56 -07:00
yarn.lock Always make, never package.json scripts 2022-11-03 22:49:06 -07:00

README.md

This directory contains the code necessary to generate NodeJS bindings for C-KZG.


  loadTrustedSetup: (filePath: string) => SetupHandle;

  freeTrustedSetup: (setupHandle: SetupHandle) => void;

  blobToKzgCommitment: (blob: Blob, setupHandle: SetupHandle) => KZGCommitment;

  computeAggregateKzgProof: (
    blobs: Blob[],
    setupHandle: SetupHandle
  ) => KZGProof;

  verifyAggregateKzgProof: (
    blobs: Blob[],
    expectedKzgCommitments: KZGCommitment[],
    kzgAggregatedProof: KZGProof,
    setupHandle: SetupHandle
  ) => boolean;

Spec: https://github.com/ethereum/consensus-specs/blob/dev/specs/eip4844/polynomial-commitments.md

First, npm install -g yarn if you don't have it.

Install the blst submodule

git submodule update --init

Build blst and c_kzg_4844.c

cd src && make blst lib

Generate NodeJS bindings and run the TypeScript tests against them

cd ../bindings/node.js && yarn install && make test

After doing this once, you can re-build (if necessary) and re-run the tests with

make build test

After making changes, regenerate the distributable JS and type defs

make bundle