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.

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

fix: docs #9

Merged
merged 8 commits into from
Oct 17, 2024
Merged

fix: docs #9

merged 8 commits into from
Oct 17, 2024

Conversation

yuwen01
Copy link
Collaborator

@yuwen01 yuwen01 commented Oct 17, 2024

  1. Add more docs and comments to all files.
  2. Refactor group compression / serialization methods to a utils file.
  3. Refactor vkey hash to take a string as input, since that's what vk.bytes32() outputs.
  4. Remove the unsupported v1.2.0 vkey and add the new v3.0.0rc4 groth16 vkey

let (pk, _vk) = client.setup(ELF);
let (pk, vk) = client.setup(ELF);

println!("vkey bytes {:?}", sp1_sdk::HashableKey::bytes32(&vk));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "Verification Key: "

//! This crate contains utilities for verifying SP1 Groth16 proofs on Solana.
//!
//! # Example
//! ```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to have the tag like ```rust on it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to run as a doctest, no, since it's in a rust file

Copy link
Member

@ratankaliani ratankaliani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some small comments, but looks way cleaner! LGTM

Can you add a PR description?

@yuwen01 yuwen01 merged commit 8902b2b into succinctlabs:master Oct 17, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants