Awesome
Foundry UUPS Upgradeable Contracts
This is a section of the Cyfrin Foundry Solidity Course.
⭐️ (4:47:00) | Lesson 13: Foundry Upgradable Contracts
*This is for demo purposes only. Upgradeable contracts are a menance and in general should be avoided for
- Foundry UUPS Upgradeable Contracts
- Getting Started
- Usage
- Deployment to a testnet or mainnet
- 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 likegit version x.x.x
- You'll know you did it right if you can run
- foundry
- You'll know you did it right if you can run
forge --version
and you see a response likeforge 0.2.0 (816e00b 2023-03-16T00:05:26.396218Z)
- You'll know you did it right if you can run
Quickstart
git clone https://github.com/Cyfrin/foundry-upgrades-cu
cd foundry-upgrades-cu
forge build
Optional Gitpod
If you can't or don't want to run and install locally, you can work with this repo in Gitpod. If you do this, you can skip the clone this repo
part.
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
Testing
forge test
Test Coverage
forge coverage
and for coverage based testing:
forge coverage --report debug
Deployment to a testnet or mainnet
- 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.
- Get testnet ETH
Head over to faucets.chain.link and get some tesnet ETH. You should see the ETH show up in your metamask.
- 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
Thank you!
If you appreciated this, feel free to follow me or donate!
ETH/Arbitrum/Optimism/Polygon/etc Address: 0x9680201d9c93d65a3603d2088d125e955c73BD65