Foundry UUPS Upgradeable Contracts

This is a section of the Cyfrin Foundry Solidity Course. ⭐️ (4:47:00) | Lesson 13: Foundry Upgradable Contracts

There are many patterns for making upgradeable contracts. This project uses the UUPS proxy which is the current openzeppelin recommendation. In UUPS proxies the upgrade is handled by the implementation, and can eventually be removed

This is for demo purposes only. Upgradeable contracts are a menace and in general should be avoided

• Foundry UUPS Upgradeable Contracts
• Getting Started
  • Requirements
  • Quickstart
• Usage
  • Start a local node
  • Deploy
  • Deploy - Other Network
  • Testing
    • Test Coverage
• Deployment to a testnet or mainnet
  • Estimate gas
• Formatting
• Thank you!

Getting Started

Requirements

• git
  • You'll know you did it right if you can run git --version and you see a response like git version x.x.x
• foundry
  • You'll know you did it right if you can run forge --version and you see a response like forge 0.2.0 (816e00b 2023-03-16T00:05:26.396218Z)

Quickstart

git clone https://github.com/ibourn/foundry-upgrades
cd foundry-upgrades
forge build

Usage

Start a local node

make anvil

Deploy

This will default to your local node. You need to have it running in another terminal in order for it to deploy.

make deploy

Deploy - Other Network

See below

Testing

forge test

Test Coverage

forge coverage

and for coverage based testing:

forge coverage --report debug

Deployment to a testnet or mainnet

1. Setup environment variables

You'll want to set your SEPOLIA_RPC_URL and PRIVATE_KEY as environment variables. You can add them to a .env file, similar to what you see in .env.example.

• PRIVATE_KEY: The private key of your account (like from metamask). NOTE: FOR DEVELOPMENT, PLEASE USE A KEY THAT DOESN'T HAVE ANY REAL FUNDS ASSOCIATED WITH IT.
  • You can learn how to export it here.
• SEPOLIA_RPC_URL: This is url of the goerli testnet node you're working with. You can get setup with one for free from Alchemy

Optionally, add your ETHERSCAN_API_KEY if you want to verify your contract on Etherscan.

1. Get testnet ETH

Head over to faucets.chain.link and get some tesnet ETH. You should see the ETH show up in your metamask.

2. Deploy

make deploy ARGS="--network sepolia"

Estimate gas

You can estimate how much gas things cost by running:

forge snapshot

And you'll see and output file called .gas-snapshot

Formatting

To run code formatting:

forge fmt