Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publishing Package changes #44

Merged
merged 6 commits into from
Jan 31, 2025
Merged

Publishing Package changes #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
23e8e09
needed description
anupsv Jan 30, 2025
e8be30e
adding verifier description
anupsv Jan 30, 2025
3be3f1b
removing path
anupsv Jan 30, 2025
72ce5b9
removing the include cause both include and exclude can't be present.…
anupsv Jan 30, 2025
20de9c4
fixing path
anupsv Jan 30, 2025
b26fbe4
fixing readme
anupsv Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions primitives/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[package]
name = "rust-kzg-bn254-primitives"
version = "0.1.0"
description = "This library offers a set of structs, traits and functions for generating Blobs and Polynomials which are used to interact with rust-kzg-bn254-prover and rust-kzg-bn254-verifier crates."
edition.workspace = true
repository.workspace = true
license-file.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion primitives/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# rust-kzg-bn254-primitives

[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254.svg)](https://crates.io/crates/rust-kzg-bn254-primitives)
[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254-primitives.svg)](https://crates.io/crates/rust-kzg-bn254-primitives)

This library offers primitive set of structures and functions for generating and interacting with bn254 KZG commitments and proofs in rust.

Expand Down
4 changes: 1 addition & 3 deletions prover/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,9 @@ readme = "README.md"
repository.workspace = true
license-file.workspace = true
exclude = ["tests/*", "benches/*"]
# TODO: is this needed for the image to show up in the rust docs?
include = ["./kzg_commitment_diagram.png"]

[dependencies]
rust-kzg-bn254-primitives = { path = "../primitives", version = "0.1.0" }
rust-kzg-bn254-primitives = { version = "0.1.0" }
ark-bn254 = "0.5.0"
ark-ec = { version = "0.5.0", features = ["parallel"] }
ark-ff = { version = "0.5.0", features = ["parallel"] }
Expand Down
6 changes: 3 additions & 3 deletions prover/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# rust-kzg-bn254

[![Docs](https://docs.rs/rust-kzg-bn254/badge.svg)](https://docs.rs/rust-kzg-bn254/latest/rust_kzg_bn254/)
[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254.svg)](https://crates.io/crates/rust-kzg-bn254)
[![Docs](https://docs.rs/rust-kzg-bn254-prover/badge.svg)](https://docs.rs/rust-kzg-bn254-prover/latest/rust_kzg_bn254_prover/)
[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254-prover.svg)](https://crates.io/crates/rust-kzg-bn254-prover)

This library offers a set of functions for generating and interacting with bn254 KZG commitments and proofs in rust, with the motivation of supporting fraud and validity proof logic in EigenDA rollup integrations.

Expand All @@ -15,7 +15,7 @@ This library offers a set of functions for generating and interacting with bn254

See the `test_compute_kzg_proof` function in [./tests/kzg_test.rs](./tests/kzg_test.rs) for an end to end usage of the library.

Also make sure to check out the examples in our [docs](https://docs.rs/rust-kzg-bn254/latest/rust_kzg_bn254/).
Also make sure to check out the examples in our [docs](https://docs.rs/rust-kzg-bn254-prover/latest/rust_kzg_bn254_prover/).

## Setup for testing

Expand Down
5 changes: 3 additions & 2 deletions verifier/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
[package]
name = "rust-kzg-bn254-verifier"
version = "0.1.0"
description = "This library offers a set of functions for verifying KZG commitments and proofs in bn254, with the motivation of supporting fraud and validity proof logic in EigenDA rollup integrations."
license-file.workspace = true
edition.workspace = true
rust-version.workspace = true
repository.workspace = true

[dependencies]
rust-kzg-bn254-primitives = { path = "../primitives", version = "0.1.0" }
rust-kzg-bn254-primitives = { version = "0.1.0" }
ark-bn254 = "0.5.0"
ark-ec = { version = "0.5.0", features = ["parallel"] }
ark-ff = { version = "0.5.0", features = ["parallel"] }
Expand All @@ -18,7 +19,7 @@ rand = "0.8.5"
criterion = "0.5"
lazy_static = "1.5"
ark-std = { version = "0.5.0", features = ["parallel"] }
rust-kzg-bn254-prover = { path = "../prover", version = "0.1.0" }
rust-kzg-bn254-prover = { version = "0.1.0" }

[[bench]]
name = "bench_kzg_verify"
Expand Down
6 changes: 3 additions & 3 deletions verifier/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# rust-kzg-bn254-batch-verification
# rust-kzg-bn254-verification

[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254.svg)](https://crates.io/crates/rust-kzg-bn254-batch-verification)
[![Crate](https://img.shields.io/crates/v/rust-kzg-bn254-verifier.svg)](https://crates.io/crates/rust-kzg-bn254-verifier)

This library offers batch verification functions for KZG.
This library offers verification functions, including batch verification, for KZG.

## Warning & Disclaimer

Expand Down