c-kzg-4844/README.md

60 lines
1.6 KiB
Markdown

# C-KZG-4844
This is a minimal library for EIP-4844 that implements the [Polynomial
Commitments](https://github.com/ethereum/consensus-specs/blob/dev/specs/deneb/polynomial-commitments.md)
API. It was originally a stripped-down copy of
[C-KZG](https://github.com/benjaminion/c-kzg), but it has been heavily modified
since then.
## Interface functions
There are functions for KZG operations:
- `blob_to_kzg_commitment`
- `compute_kzg_proof`
- `compute_blob_kzg_proof`
- `verify_kzg_proof`
- `verify_blob_kzg_proof`
- `verify_blob_kzg_proof_batch`
There are functions for loading/freeing the trusted setup:
- `load_trusted_setup`
- `load_trusted_setup_file`
- `free_trusted_setup`
## Bindings
There are bindings for the following languages:
| Language | Link |
|----------|--------------------------------------|
| C# | [README](bindings/csharp/README.md) |
| Go | [README](bindings/go/README.md) |
| Java | [README](bindings/java/README.md) |
| Nim | [README](bindings/nim/README.md) |
| Node.js | [README](bindings/node.js/README.md) |
| Python | [README](bindings/python/README.md) |
| Rust | [README](bindings/rust/README.md) |
## Installation
### Prerequisites
The following must be installed:
* `git`
* `make`
* `clang`
### Build & test
To build `c_kzg_4844.o`, the object file that the bindings use, run `make` in
the `src` directory. This will ensure the `blst` submodule has been initialized,
build `blst`, build `c_kzg_4844`, and run the tests. From the project root, run
this:
```
cd src && make
```