Skip to content

Commit 1c04fa1

Browse files
committed
Update README
- Remove security analysis sentence & point to audit repository - Clarify alloc sentence
1 parent b25c18e commit 1c04fa1

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@
55

66
_This is a pure Rust implementation of the PLONK proving system over BLS12-381._
77

8-
This library contains a modular implementation of KZG10 as the default polynomial commitment scheme. Moreover, it includes custom gates for efficiency purposes. The details on our specific implementation can be found [here](docs/dusk-plonk-specs.pdf).
9-
10-
**DISCLAIMER**: This library is currently unstable and still needs to undergo an exhaustive security analysis. Use at your own risk.
8+
This library contains a modular implementation of KZG10 as the default polynomial commitment scheme. Moreover, it includes custom gates for efficiency purposes. The details on our specific implementation can be found [here](docs/dusk-plonk-specs.pdf). An audit can be found [here](https://github.com/dusk-network/audits).
119

1210
## Usage
1311

@@ -17,7 +15,7 @@ To see how to use this library, check the 'examples' directory.
1715

1816
This crate includes a variety of features which are briefly explained below:
1917
- `alloc`: Enables the usage of an allocator, allowing for `Proof` constructions and verifications. Without this feature it **IS NOT** possible to prove or verify anything.
20-
Its absence only makes `dusk-plonk` export certain fixed-size data structures such as `Proof`, which can be useful in no_std environments where we don't have allocators available.
18+
Its absence only makes `dusk-plonk` export certain fixed-size data structures such as `Proof`. This is useful in no_std environments that also do not make use of an allocator.
2119
- `std`: Enables `std` usage as well as `rayon` parallelization in some proving and verifying operations.
2220
It also uses the `std` versions of the elliptic curve dependencies, utilizing the `parallel` feature
2321
from `dusk-bls12-381`. This feature is enabled by default.

0 commit comments

Comments
 (0)