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 on smart contract source code verification #6308

Closed
samajammin opened this issue May 12, 2022 · 3 comments
Closed
Labels
content 🖋️ This involves copy additions or edits feature ✨ This is enhancing something existing or creating something new

Comments

@samajammin
Copy link
Member

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

I feel this is not currently a well documented aspect of smart contracts - the importance of & ability to verify smart contract source code.

Describe the solution you'd like

  • Create a new documentation page: "Verifying smart contracts" page
    • Right after the "Deploying smart contracts" page
    • Provide general intro to source code verification as a concept (what is it, why it matters, how it's done)
    • List projects/tools that help devs (& smart contract users) accomplish this

Describe alternatives you've considered

  • Considered this as a section within compiling or deploying smart contract pages but this topic seems worthy of its own page...
  • Naming it “Source code verification” may be more descriptive (also to not confuse it with formal verification of smart contracts - Create new documentation page introducing formal verification #6194) but it seems to make sense as "Verifying smart contracts" to fit in with the smart contract section ("Compiling", "Deploying" etc.)

Additional context

Chatted with @kuzdogan on this who is willing to help write it 😄

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 12, 2022
@samajammin
Copy link
Member Author

Some notes from discussions w/ more context: https://notes.ethereum.org/YARNcIFpS16zL9X1qYydDw?view

@github-actions
Copy link
Contributor

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 Jun 27, 2022
@corwintines
Copy link
Member

Since #6575 was merged I think we can close this @samajammin.

@github-actions github-actions bot removed the Status: Stale This issue is stale because it has been open 30 days with no activity. label Jul 21, 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
Projects
None yet
Development

No branches or pull requests

2 participants