61 lines
2.0 KiB
Markdown
61 lines
2.0 KiB
Markdown
## go-eth-kzg
|
|
|
|
This library provides the necessary cryptographic functions for EIP-4844. If one
|
|
is not familiar with EIP-4844, you can think of this library as a KZG library
|
|
where the polynomial degree is set to 4095 and opening proofs are computed on
|
|
polynomials in lagrange form (4096 evaluations at 4096'th roots of unity).
|
|
|
|
## Installation
|
|
|
|
```
|
|
go get github.com/crate-crypto/go-eth-kzg
|
|
```
|
|
|
|
## Example
|
|
|
|
Check out [`examples_test.go`](./examples_test.go) for an example of how to use
|
|
this library.
|
|
|
|
## Benchmarks
|
|
|
|
To run the benchmarks, execute the following command:
|
|
|
|
```
|
|
go test -bench=.
|
|
```
|
|
|
|
## Consensus specs
|
|
|
|
This version of the code is conformant with the consensus-specs as of the
|
|
following commit: `017a8495f7671f5fff2075a9bfc9238c1a0982f8`
|
|
|
|
## Security
|
|
|
|
- For security bugs in this library, email <kev@the.dev>.
|
|
- This library uses
|
|
[gnark-crypto](https://github.com/ConsenSys/gnark-crypto/tree/master) for
|
|
elliptic curve operations. An audit of gnark can be seen
|
|
[here](https://github.com/ConsenSys/gnark-crypto/blob/master/audit_oct2022.pdf).
|
|
This library uses a more recent version than the audited version, since that
|
|
version had a serialization bug.
|
|
We only rely on gnark-crypto's underlying group operations and pairing code
|
|
for bls12-381. For code that we do need to use, that has not been audited, we
|
|
have copied it into this library so that it can be a part of this libraries
|
|
audit. We have noted in the comments which functions we have done this for.
|
|
|
|
### Panics
|
|
|
|
Panics can be a DoS vector when running code in a node. This library endeavors
|
|
to only panic on startup; only methods which are called when we create the
|
|
`Context` object should panic.
|
|
|
|
## Minimum Supported Golang Version
|
|
|
|
Because we use generics, the minimum golang version needs to be 1.18 or above. Since Golang only back ports security fixes to the latest version and one version behind latest, this library will at most be one version behind latest.
|
|
|
|
Tests are ran against the current version and the latest version.
|
|
|
|
## License
|
|
|
|
This project is licensed under the APACHE-2 license.
|