Add example upgrades

Author: ilitteri

claim_contracts/script/UpgradeToAlignedTokenV2.s.sol

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.19;
+
+// import "../src/TestToken.sol";
+import "../src/ExampleAlignedTokenV2.sol";
+import "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
+import "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+import {ERC1967Utils} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Utils.sol";
+import "forge-std/Script.sol";
+import {Vm} from "forge-std/Vm.sol";
+import {Utils} from "./Utils.sol";
+
+/// @notice This script upgrades the ClaimableAirdrop contract to ClaimableAirdropV2.
+/// @dev The `ProxyAdmin` owner must be the runner of this script since it is the
+/// one that will call the upgradeAndCall function of the `ProxyAdmin`.
+contract UpgradeToAlignedTokenV2 is Script {
+    function run(string memory config) public {
+        string memory root = vm.projectRoot();
+        string memory path = string.concat(
+            root,
+            "/script-config/config.",
+            config,
+            ".json"
+        );
+        string memory config_json = vm.readFile(path);
+
+        address _currentTokenProxy = stdJson.readAddress(
+            config_json,
+            ".tokenProxy"
+        );
+
+        vm.broadcast();
+        ExampleAlignedTokenV2 _newToken = new ExampleAlignedTokenV2();
+
+        bytes memory _tokenUpgradeData = abi.encodeCall(
+            ProxyAdmin.upgradeAndCall,
+            (
+                ITransparentUpgradeableProxy(_currentTokenProxy),
+                address(_newToken),
+                abi.encodeCall(ExampleAlignedTokenV2.reinitialize, ())
+            )
+        );
+
+        console.log(
+            "To finalize the upgrade, call",
+            getAdminAddress(_currentTokenProxy),
+            "with the following calldata"
+        );
+        console.logBytes(_tokenUpgradeData);
+    }
+
+    function getAdminAddress(address proxy) internal view returns (address) {
+        address CHEATCODE_ADDRESS = 0x7109709ECfa91a80626fF3989D68f67F5b1DD12D;
+        Vm vm = Vm(CHEATCODE_ADDRESS);
+
+        bytes32 adminSlot = vm.load(proxy, ERC1967Utils.ADMIN_SLOT);
+        return address(uint160(uint256(adminSlot)));
+    }
+}

claim_contracts/script/UpgradeToAlignedTokenV3.s.sol

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.19;
+
+// import "../src/TestToken.sol";
+import "../src/ExampleAlignedTokenV3.sol";
+import "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
+import "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+import {ERC1967Utils} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Utils.sol";
+import "forge-std/Script.sol";
+import {Vm} from "forge-std/Vm.sol";
+import {Utils} from "./Utils.sol";
+
+/// @notice This script upgrades the ClaimableAirdrop contract to ClaimableAirdropV2.
+/// @dev The `ProxyAdmin` owner must be the runner of this script since it is the
+/// one that will call the upgradeAndCall function of the `ProxyAdmin`.
+contract UpgradeToAlignedTokenV3 is Script {
+    function run(string memory config) public {
+        string memory root = vm.projectRoot();
+        string memory path = string.concat(
+            root,
+            "/script-config/config.",
+            config,
+            ".json"
+        );
+        string memory config_json = vm.readFile(path);
+
+        address _currentTokenProxy = stdJson.readAddress(
+            config_json,
+            ".tokenProxy"
+        );
+
+        vm.broadcast();
+        ExampleAlignedTokenV3 _newToken = new ExampleAlignedTokenV3();
+
+        bytes memory _tokenUpgradeData = abi.encodeCall(
+            ProxyAdmin.upgradeAndCall,
+            (
+                ITransparentUpgradeableProxy(_currentTokenProxy),
+                address(_newToken),
+                abi.encodeCall(ExampleAlignedTokenV3.reinitialize, ())
+            )
+        );
+
+        console.log(
+            "To finalize the upgrade, call",
+            getAdminAddress(_currentTokenProxy),
+            "with the following calldata"
+        );
+        console.logBytes(_tokenUpgradeData);
+    }
+
+    function getAdminAddress(address proxy) internal view returns (address) {
+        address CHEATCODE_ADDRESS = 0x7109709ECfa91a80626fF3989D68f67F5b1DD12D;
+        Vm vm = Vm(CHEATCODE_ADDRESS);
+
+        bytes32 adminSlot = vm.load(proxy, ERC1967Utils.ADMIN_SLOT);
+        return address(uint160(uint256(adminSlot)));
+    }
+}

claim_contracts/src/ExampleAlignedTokenV3.sol

@@ -0,0 +1,63 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.19;
+
+import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
+import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20PermitUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20BurnableUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/access/Ownable2StepUpgradeable.sol";
+
+contract ExampleAlignedTokenV3 is
+    Initializable,
+    ERC20Upgradeable,
+    ERC20PermitUpgradeable,
+    ERC20BurnableUpgradeable,
+    Ownable2StepUpgradeable
+{
+    /// @notice Name of the token.
+    string public constant NAME = "Test Token";
+
+    /// @notice Symbol of the token.
+    string public constant SYMBOL = "TESTITO";
+
+    /// @custom:oz-upgrades-unsafe-allow constructor
+    constructor() {
+        _disableInitializers();
+    }
+
+    /// @notice Initializes the contract.
+    /// @dev This initializer should be called only once.
+    /// @dev The _foundation must accept the ownership of the contract
+    /// after deployment in another transaction.
+    /// @param _foundation address of the foundation.
+    /// @param _claimSupplier address of the claim supplier. This is the address
+    /// that will give the tokens to the users that claim them.
+    function initialize(
+        address _foundation,
+        address _claimSupplier
+    ) public initializer {
+        require(
+            _foundation != address(0) && _claimSupplier != address(0),
+            "Invalid _foundation or _claimSupplier"
+        );
+        __ERC20_init(NAME, SYMBOL);
+        __ERC20Permit_init(NAME);
+        __ERC20Burnable_init();
+        __Ownable2Step_init(); // default is msg.sender
+        _transferOwnership(_foundation);
+        _mint(_foundation, 7_300_000_000e18); // 7.3 billion
+        _mint(_claimSupplier, 2_700_000_000e18); // 2.7 billion
+    }
+
+    function reinitialize() public reinitializer(3) {}
+
+    /// @notice Mints `amount` of tokens.
+    function mint(address to, uint256 amount) external onlyOwner {
+        _mint(to, amount * 2);
+    }
+
+    /// @notice Prevents the owner from renouncing ownership.
+    function renounceOwnership() public view override onlyOwner {
+        revert("Cannot renounce ownership");
+    }
+}