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

WEB3-66: Add version string to RiscZeroGroth16Verifier.sol #187

Merged
merged 3 commits into from
Aug 7, 2024

Conversation

nategraf
Copy link
Contributor

@nategraf nategraf commented Aug 7, 2024

In order to make it easier to determine which version a given verifier contract is, this PR adds a semantic version string.

Note that this does mean an additional step in the release process. I couldn't think of a way to make this automatic.

@nategraf nategraf requested a review from a team as a code owner August 7, 2024 00:26
@github-actions github-actions bot changed the title Add version string to RiscZeroGroth16Verifier.sol WEB3-66: Add version string to RiscZeroGroth16Verifier.sol Aug 7, 2024
@nategraf nategraf requested a review from capossele August 7, 2024 00:27
@@ -53,6 +53,9 @@ contract RiscZeroGroth16Verifier is IRiscZeroVerifier, Groth16Verifier {
using OutputLib for Output;
using SafeCast for uint256;

/// Semantic version of the the RISC Zero system of which this contract is part.
string constant VERSION = "1.1.0-alpha.1";
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder though, let's say no changes in the verifier contract between x.x.0 and x.x.5 are required, does that mean the deployed contract will keep an older version than the latest crate version?

Copy link
Contributor Author

@nategraf nategraf Aug 7, 2024

Choose a reason for hiding this comment

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

That's a good question. I think both changing it or not changing it is fine but I'm not sure which is better. Mostly it's there to make it easier to find the source code in GitHub when you are looking at the contract source in Etherscan.

@nategraf nategraf enabled auto-merge (squash) August 7, 2024 18:22
@nategraf nategraf merged commit 959f0c2 into main Aug 7, 2024
9 checks passed
@nategraf nategraf deleted the victor/add-version-string-to-verifier-contract branch August 7, 2024 18:35
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