From 8683fac75a582ca4217dfd03d5fdde18fb052f8b Mon Sep 17 00:00:00 2001 From: dancoffman Date: Fri, 4 Nov 2022 16:56:16 -0700 Subject: [PATCH] Basic setup instructions in README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 1f2be84..ec0668e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # C-KZG-4844: A minimal library for EIP-4844 Polynomial Commitments This is a copy of C-KZG stripped down to support the [Polynomial Commitments](https://github.com/ethereum/consensus-specs/blob/dev/specs/eip4844/polynomial-commitments.md) API: + - `compute_aggregate_kzg_proof` - `verify_aggregate_kzg_proof` - `blob_to_kzg_commitment` @@ -9,3 +10,25 @@ This is a copy of C-KZG stripped down to support the [Polynomial Commitments](ht We also provide `load_trusted_setup` and `free_trusted_setup` to load the trusted setup data from a file into an object that can be passed to the API functions, and functions for converting commitments/proofs/points to/from bytes. + +## Installation + +Install the blst submodule + +``` +git submodule update --init +``` + +Build blst + +``` +cd src +make blst +``` + +Build the C-KZG code + +``` +cd src +make +```