c-kzg-4844/README.md

# c-kzg - work in progress

The very beginnings of a simple implementation of [KZG commitments](https://dankradfeist.de/ethereum/2020/06/16/kate-polynomial-commitments.html) in C, using the [Blst library](https://github.com/supranational/blst) from Supranational for field and curve operations.

Initially, at least, this largely follows the [go-kzg](https://github.com/protolambda/go-kzg) implementation.

Done so far:
  - Rough and ready FFT and inverse FFT over the finite field.
  - Ditto for FFTs over the G1 group

## Installation

Build the [Blst library](https://github.com/supranational/blst) following the instructions there. Then,

1. Copy the resulting `libblst.a` file into the `lib/` directory here.
2. From Blst's `bindings/` directory copy `blst.h` and `blst_aux.h` to `inc/`

That is,

```
cp ../blst/libblast.a lib/
cp ../blst/bindings/*.h inc/
```

There's no library to make here yet, but you can run the tests.

## Run tests

```
cd src
make test
```

Thanks to [Acutest](https://github.com/mity/acutest) for the unit test harness, which is used here under the MIT licence.

## Prerequisites

 - Blst library (see above)
 - `clang` compiler. I'm using Clang 10.0.0. I'll likely add `gcc` options in future.
 - I'm developing on Ubuntu 20.04. Will check portability later.
Insert lib/ directory and update Readme 2021-02-02 11:36:36 +00:00			`# c-kzg - work in progress`
Initial commit 2021-02-01 20:15:45 +00:00
			`The very beginnings of a simple implementation of [KZG commitments](https://dankradfeist.de/ethereum/2020/06/16/kate-polynomial-commitments.html) in C, using the [Blst library](https://github.com/supranational/blst) from Supranational for field and curve operations.`

			`Initially, at least, this largely follows the [go-kzg](https://github.com/protolambda/go-kzg) implementation.`

			`Done so far:`
			`- Rough and ready FFT and inverse FFT over the finite field.`
Implement FFT with G1 elements 2021-02-02 23:06:42 +00:00			`- Ditto for FFTs over the G1 group`
Initial commit 2021-02-01 20:15:45 +00:00
			`## Installation`

			`Build the [Blst library](https://github.com/supranational/blst) following the instructions there. Then,`

			1. Copy the resulting `libblst.a` file into the `lib/` directory here.
			2. From Blst's `bindings/` directory copy `blst.h` and `blst_aux.h` to `inc/`

			`That is,`

			```
			`cp ../blst/libblast.a lib/`
			`cp ../blst/bindings/*.h inc/`
			```

			`There's no library to make here yet, but you can run the tests.`

			`## Run tests`

			```
Create src/ directory and move source files in 2021-02-02 11:42:56 +00:00			`cd src`
Initial commit 2021-02-01 20:15:45 +00:00			`make test`
			```

			`Thanks to [Acutest](https://github.com/mity/acutest) for the unit test harness, which is used here under the MIT licence.`
Insert lib/ directory and update Readme 2021-02-02 11:36:36 +00:00
			`## Prerequisites`

			`- Blst library (see above)`
			- `clang` compiler. I'm using Clang 10.0.0. I'll likely add `gcc` options in future.
			`- I'm developing on Ubuntu 20.04. Will check portability later.`