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

Add documentation for the contract version management solution #107

Merged
merged 12 commits into from
May 11, 2024

Conversation

nategraf
Copy link
Contributor

This PR adds documentation describing the design of the verifier contract version management solution implemented in #80. It is intended to provide detailed information to help security-minded application developers make an informed decision about how to use the verifier contracts.

@nategraf nategraf force-pushed the victor/version-management-design-doc branch from 9995380 to 1863554 Compare May 10, 2024 22:02
multisig["RISC Zero Multisig"]
appAdmin[App Admin]

timelock -- admin --> router
Copy link
Contributor

Choose a reason for hiding this comment

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

Curiosity: Are the terms admin, proposer, and guardian standard in smart contract development, or are those our terms?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Guardian I've seen before in this usage. Proposer is the name used in the TimelockController interface. Admin is a term I chose for this.

Copy link
Contributor

@pdg744 pdg744 left a comment

Choose a reason for hiding this comment

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

Looks great!

@nategraf nategraf enabled auto-merge (squash) May 11, 2024 00:52
@nategraf nategraf merged commit 54ede0d into main May 11, 2024
8 of 9 checks passed
@nategraf nategraf deleted the victor/version-management-design-doc branch May 11, 2024 01:05
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