Help needed: smart contract upgradeability page

[samajammin]

As part of an initiative to expand content resources for developers, we need domain experts who can help write these resources!

This page is an "entry-level" overview of smart contract upgradeability – and how it's relevant to building a dapp. This page should be as agnostic as possible when it comes to the languages & tools used (showing examples of multiple approaches is always a great solution to this).

• Here is a loose template to follow
• Here is the overview page on smart contracts for inspiration and reference: https://ethereum.org/en/developers/docs/smart-contracts/
• Here is the page as it exists today: https://ethereum.org/en/developers/docs/smart-contracts/deploying/

Acceptance criteria

• There are clear prerequisites as per the template
• No knowledge is assumed, so concepts are explained or linked out to explanations
• Pros & cons of using smart contracts upgradeability mechanisms
• Relevant tools / resources are explained and examples are provided when necessary
• Content is clearly separated into manageable sections with clear headers (h2s and h3s)
• There are links to further reading for those that want to learn more
• There are links to related topics within the ethereum.org developers section
• As a new dapp buidler, I understand how to use upgradeable smart contracts when developing my dapp after reading this

Bonus points

• Link to this page from wherever relevant across the site! e.g. are there tutorials or other documentation pages that reference this topic? Add a link!

How to contribute

• Create an index.md files insrc > content > docs > smart-contracts > upgradeability
• Submit PRs to the dev branch
• More on the contribution process

Useful references/resources

• https://blog.openzeppelin.com/the-state-of-smart-contract-upgrades/
• https://docs.openzeppelin.com/learn/upgrading-smart-contracts#how-upgrades-work
• https://blog.trailofbits.com/2018/09/05/contract-upgrade-anti-patterns/

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

[fulldecent]

Bibliography:

• https://underhanded.soliditylang.org

[fulldecent]

I see this issue has been open for a while. If it is important, the core salaried team is not available, and cash bounties are being offered then please add a note.

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

[emmanuel-awosika]

Happy to help create this page, @samajammin. :)

[emmanuel-awosika]

I opened a PR for the page, @samajammin. Let me know if it's good to go.

[minimalsm]

Hey @emmanuel-awosika, thanks for the PR 😎 GitHub tip: if you can cross-reference an issue in your PR by adding the issue number like this: #1511. This will automatically link them.

[emmanuel-awosika]

Hey @emmanuel-awosika, thanks for the PR 😎 GitHub tip: if you can cross-reference an issue in your PR by adding the issue number like this: #1511. This will automatically link them.

Hey @minimalsm, thanks for the tip. I should get it to try it out soon.

[github-actions]

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