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

Create new documentation page introducing formal verification #6194

Closed
samajammin opened this issue May 3, 2022 · 4 comments
Closed

Create new documentation page introducing formal verification #6194

samajammin opened this issue May 3, 2022 · 4 comments
Labels
content 🖋️ This involves copy additions or edits feature ✨ This is enhancing something existing or creating something new Status: Stale This issue is stale because it has been open 30 days with no activity.

Comments

@samajammin
Copy link
Member

Is your feature request related to a problem? Please describe.

We have a couple resources on formal verification, mostly as it relates to smart contract security:
https://ethereum.org/en/developers/docs/smart-contracts/security/#formal-verification

Formal verification is a broader field than just the Ethereum context but I feel like for many developers (including myself), Ethereum is their first exposure to the concept of formal verification. Currently we don't offer much of an introduction to what it is & why it's valuable, or how to get involved with various projects within the Ethereum ecosystem.

Describe the solution you'd like

I think it'd be useful to create an "Introduction to Formal Verification" page within our documentation to:

  • explain formal verification at a high level (maybe formal methods as well)
  • how it applies to Ethereum (e.g. both for optimization & security)
  • list resources & tools to learn more or use
  • list projects to potentially get involved with

Additional context

Some resources we may want to reference:

If those folks are ok with us using (with attribution) some of the content in those posts, I think that could provide most of the content we'd want for this page. From there, we could easily translate this into multiple languages.

People who may be able to help write this page :)
https://runtimeverification.com/events/formalverificationeth/

Want to contribute?

We love contributions from the Ethereum community! Please comment on an issue if you're interested in helping out with a PR.

@samajammin samajammin added feature ✨ This is enhancing something existing or creating something new content 🖋️ This involves copy additions or edits labels May 3, 2022
@leonardoalt
Copy link
Member

That's a great idea!

@samajammin
Copy link
Member Author

Glad to hear @leonardoalt - let us know if you'd like to be involved at all! Otherwise happy to share a draft with you to make sure you sign off on any content we grab from your resources 👍

@emmanuel-awosika
Copy link
Contributor

Hi @samajammin. I opened a new PR for this issue. Let me know what you think!

@github-actions
Copy link
Contributor

github-actions bot commented Jul 4, 2022

This issue is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label Jul 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content 🖋️ This involves copy additions or edits feature ✨ This is enhancing something existing or creating something new Status: Stale This issue is stale because it has been open 30 days with no activity.
Projects
None yet
Development

No branches or pull requests

4 participants