feat: upgrade existing tokens (experimental)

BuildOnBeam · Mar 4, 2024 · 69d0a7c · 69d0a7c
1 parent 3c6e22b
commit 69d0a7c
Show file tree

Hide file tree

Showing 5 changed files with 484 additions and 4 deletions.
diff --git a/contracts/contracts-upgradable/examples/AvaxOFT.sol b/contracts/contracts-upgradable/examples/AvaxOFT.sol
@@ -2,9 +2,15 @@
 
 pragma solidity ^0.8.18;
 
+import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20PermitUpgradeable.sol";
 import "../token/oft/v2/fee/OFTWithFeeUpgradeable.sol";
 import "../token/oft/v2/fee/NativeOFTWithFeeUpgradeable.sol";
 
-contract AvaxOFT is OFTWithFeeUpgradeable {}
+contract AvaxOFTv1 is OFTWithFeeUpgradeable {}
 
 contract AvaxNativeOFT is NativeOFTWithFeeUpgradeable {}
+
+/// @custom:oz-upgrades-from AvaxOFTv1
+contract AvaxOFT is AvaxOFTv1, ERC20PermitUpgradeable {
+
+}
diff --git a/contracts/contracts-upgradable/examples/UsdcOFT.sol b/contracts/contracts-upgradable/examples/UsdcOFT.sol
@@ -2,13 +2,21 @@
 
 pragma solidity ^0.8.18;
 
+import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20PermitUpgradeable.sol";
 import "../token/oft/v2/fee/OFTWithFeeUpgradeable.sol";
 import "../token/oft/v2/fee/ProxyOFTWithFeeUpgradeable.sol";
 
-contract UsdcOFT is OFTWithFeeUpgradeable {
+contract UsdcOFTv1 is OFTWithFeeUpgradeable {
     function decimals() public view virtual override returns (uint8) {
         return 6;
     }
 }
 
 contract UsdcProxyOFT is ProxyOFTWithFeeUpgradeable {}
+
+/// @custom:oz-upgrades-from UsdcOFTv1
+contract UsdcOFT is UsdcOFTv1, ERC20PermitUpgradeable {
+    function decimals() public view virtual override(UsdcOFTv1, ERC20Upgradeable) returns (uint8) {
+        return 6;
+    }
+}
diff --git a/hardhat.config.js b/hardhat.config.js
@@ -260,6 +260,13 @@ module.exports = {
                 },
             },
         ],
+        settings: {
+            outputSelection: {
+                "*": {
+                    "*": ["storageLayout"],
+                },
+            },
+        },
     },
 
     contractSizer: {

diff --git a/package.json b/package.json
@@ -12,7 +12,9 @@
     "test": "npx hardhat test --parallel",
     "prettier": "prettier --write test/**/*.js && prettier --write test/*/*/*.js && prettier --write deploy/*.js && prettier --write tasks/*.js && prettier --write contracts/**/*.sol && prettier --write contracts/**/**/*.sol && prettier --write contracts/**/**/**/*.sol",
     "lint": "yarn prettier && solhint 'contracts/*.sol' && solhint 'contracts/**/*.sol' && solhint 'contracts/**/**/*.sol' && solhint 'contracts/**/**/**/*.sol'",
-    "compile": "npx hardhat compile"
+    "compile": "npx hardhat compile",
+    "clean": "npx hardhat clean",
+    "validate": "npx @openzeppelin/upgrades-core validate"
   },
   "engines": {
     "node": "==18"
@@ -38,6 +40,7 @@
     "@nomiclabs/hardhat-ethers": "^2.0.3",
     "@nomiclabs/hardhat-etherscan": "^3.1.0",
     "@nomiclabs/hardhat-waffle": "^2.0.1",
+    "@openzeppelin/upgrades-core": "^1.32.5",
     "chai": "^4.3.4",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^3.4.1",