c-kzg-4844

History

dancoffman fe622a7171 Bump package version. npmignore testing_trusted_setups.json		2022-11-17 16:41:09 -08:00
..
.gitignore	Add ability to parse JSON trusted setup to text format expected by C-KZG	2022-11-17 16:41:09 -08:00
.npmignore	Bump package version. npmignore testing_trusted_setups.json	2022-11-17 16:41:09 -08: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
Dockerfile	Add ability to parse JSON trusted setup to text format expected by C-KZG	2022-11-17 16:41:09 -08:00
Makefile	Add ability to parse JSON trusted setup to text format expected by C-KZG	2022-11-17 16:41:09 -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	Turn CPP exceptions back off to see if that fixes the ELF problem	2022-11-16 16:23:06 -08:00
binding.gyp	Turn CPP exceptions back off to see if that fixes the ELF problem	2022-11-16 16:23:06 -08:00
jest.config.js	Cleanup	2022-11-03 15:13:49 -07:00
kzg.cxx	Add ability to parse JSON trusted setup to text format expected by C-KZG	2022-11-17 16:41:09 -08:00
kzg.ts	Add ability to parse JSON trusted setup to text format expected by C-KZG	2022-11-17 16:41:09 -08:00
package.json	Bump package version. npmignore testing_trusted_setups.json	2022-11-17 16:41:09 -08:00
rollup.config.js	Start working on NPM publish	2022-11-04 18:48:52 -07:00
test.ts	Add ability to parse JSON trusted setup to text format expected by C-KZG	2022-11-17 16:41:09 -08:00
testing_trusted_setups.json	Add ability to parse JSON trusted setup to text format expected by C-KZG	2022-11-17 16:41:09 -08: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