Pie Proxy
Generic proxy pattern which can be used with any smart contract.
This project uses Buidler and Ethers.
🚨 Reserved Storage Slots 🚨
Using these slots in the implementation by accident would be an issue.
bytes32 constant IMPLEMENTATION_SLOT = keccak256(abi.encodePacked("IMPLEMENTATION_SLOT"));
bytes32 constant OWNER_SLOT = keccak256(abi.encodePacked("OWNER_SLOT"));
bytes32 constant PAUSED_SLOT = keccak256(abi.encodePacked("PAUSED_SLOT"));
bytes32 constant PAUZER_SLOT = keccak256(abi.encodePacked("PAUZER_SLOT"));
Features
Upgradeability
The proxy owner can update the implementation and the overrides contract
Pauzing
Allows the pauser address to pause the contract in case of emergency
Installing dependencies
Clone this repository, then install the dependencies with yarn.
Available Functionality
Build Contracts
yarn compile
Generate TypeChain Typings
yarn build
Run Contract Tests
yarn test
Run Coverage Report for Tests
yarn coverage
Deploy to Ethereum
Modify network config in buidler.config.ts and add API key and private key, then run:
npx buidler run --network rinkeby scripts/deploy.ts
Verify on Etherscan
Add Etherscan API key to buidler.config.ts, then run:
npx buidler verify-contract --contract-name Counter --address <DEPLOYED ADDRESS>