/hardhat-upgrades-fcc

Learning from FCC and Patrick Collins about Smart Contracts and Full Stack Web3

Primary LanguageJavaScriptMIT LicenseMIT

Hardhat Smart Contract Upgrades

MIT License LinkedIn

About The Project

All the code was developed for learning purposes and is from Learn Blockchain, Solidity, and Full Stack Web3 Development with JavaScript – 32-Hour Course by freeCodeCamp.org and Patrick Collins

The project represents an upgradable Smart Contract through a Proxy.

It implements the Openzeppelin Transparent Proxy Smart Contract as a Proxy.

Thanks to this proxy we can change the implementation (logic) of the smart contract.

This project demonstrates an advanced Hardhat use case, integrating other tools commonly used alongside Hardhat in the ecosystem.

(back to top)

Etherscan verification

This project also includes automatic verification of the contract for real networks. The verification is only executed when running on real networks

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Make sure you have already installed Node.js in your device. Also make sure you have yarn installed, in case you don't, install it:

  • yarn 
    npm install --global yarn

Installation

  1. Clone the repo 
    git clone https://github.com/alvaro-8a/hardhat-upgrades-fcc.git
  2. Install YARN packages 
    yarn install

(back to top)

Usage

You can use this code it as a template to develop your own upgradable smart contract, there are many improvements that can be done so feel free to make any change.

You can also use it to deploy your own upgradable smart contract to a Solidity supported Blockchain (Ethereum, Polygon, BSC...).

Note: This project is a demo and I don't recommend using it without changes, there are many things that can be improved so take in consideration before using it.

(back to top)

Roadmap

  1. Upgrade Box -> BoxV2

  2. Proxy Box -> BoxV2

  3. Deploy a Proxy

    1. Manually --Subleson--
    2. hardhat-deploy's built-in proxies <-
    3. Openzeppelin upgrades plugin
  • [✔️] Develop different contract implementations (Box & BoxV)
  • [✔️] Develop ProxyAdmin contract (Admin of the proxy)
  • [✔️] Deploy scripts
  • [✔️] Upgrade script

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion or an improvement that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @alvaro_8a_ - alvaroblanco8a@gmail.com

Project Link: https://github.com/alvaro-8a/hardhat-upgrades-fcc

(back to top)

Acknowledgments

(back to top)