Test and Upgrade functions tested

Author: Logic-gate-sys

.gitmodules

@@ -1,3 +1,12 @@
 [submodule "lib/forge-std"]
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/openzeppelin-contracts-upgradeable"]
+	path = lib/openzeppelin-contracts-upgradeable
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+[submodule "lib/foundry-devops"]
+	path = lib/foundry-devops
+	url = https://github.com/Cyfrin/foundry-devops

README.md

@@ -1 +1,48 @@
 Upgradable smart-contracts
+# Upgradable Smart Contracts
+
+This repository demonstrates the use of upgradable smart contracts using [OpenZeppelin Contracts Upgradeable](https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable) and [Foundry](https://github.com/foundry-rs/foundry). It provides example contracts, deployment scripts, and tests to help you get started with secure and maintainable upgradeable contract development.
+
+## Features
+
+- Example implementation of upgradeable contracts (`BoxV1`, `BoxV2`)
+- Deployment and upgrade scripts using Foundry
+- Automated tests for deployment and upgrade flows
+- Integration with OpenZeppelin's upgradeable libraries
+
+## Getting Started
+
+### Prerequisites
+
+- [Foundry](https://getfoundry.sh/) (for `forge` and `cast`)
+- [Git](https://git-scm.com/)
+
+### Installation
+
+Clone the repository and install dependencies:
+
+```sh
+git clone https://github.com/your-username/upgradable_contract.git
+cd upgradable_contract
+forge install
+* Compile Contracts
+forge build
+* Run Tests
+forge test
+** Deploy and Upgrade
+* Deployment and upgrade scripts are located in the script/ directory:
+* DeployBox.s.sol: Deploys the initial version of the contract.
+* UpgradeBox.sol: Upgrades the contract to a new version.
+* You can run these scripts using Foundry's forge script command.
+
+src/        # Solidity contract sources
+script/     # Deployment and upgrade scripts
+test/       # Test contracts
+lib/        # External dependencies (OpenZeppelin, Forge Std, etc.)
+
+*References
+** OpenZeppelin Contracts Upgradeable Documentation
+** Foundry Book
+** License
+** This project is licensed under the MIT License.
+

foundry.toml

@@ -2,5 +2,8 @@
 src = "src"
 out = "out"
 libs = ["lib"]
-
+remappings = [
+  "@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts",
+    "@openzeppelin/contracts=lib/openzeppelin-contracts/contracts"
+]
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

lib/foundry-devops

@@ -0,0 +1,35 @@
+//SPDX-License-Identifier:MIT
+pragma solidity ^0.8.18;
+
+import {ERC1967Proxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
+import {Script} from "forge-std/Script.sol";
+import {BoxV1} from "../src/BoxV1.sol";
+
+/*
+ Steps of deployment: 
+   Deploy BoxV1
+   Get an address
+   Deploy Proxy with BoxV1 address
+   Verify that everything works
+   Deploy BoxV2
+   Point Proxy to BoxV2
+ */
+contract DeployBox is Script {
+    function run() external returns (address) {
+        address proxy = deployBox();
+        return proxy;
+    }
+
+    /**
+     * @notice deploys the proxy contract
+     * @return address : address of the proxy contract
+     */
+    function deployBox() public returns (address) {
+        vm.startBroadcast();
+        BoxV1 box = new BoxV1(); // Implementation
+        ERC1967Proxy proxy = new ERC1967Proxy(address(box), "");
+        BoxV1(address(proxy)).initialize();
+        vm.stopBroadcast();
+        return address(proxy);
+    }
+}

lib/openzeppelin-contracts

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.18;
+
+import {Script} from "forge-std/Script.sol";
+import {DevOpsTools} from "lib/foundry-devops/src/DevOpsTools.sol";
+import {BoxV2} from "../src/BoxV2.sol";
+import {BoxV1} from "../src/BoxV1.sol";
+
+contract UpgradeBox is Script {
+    function run() external returns (address) {
+        address mostRecentDeployment = DevOpsTools.get_most_recent_deployment("ERC1967Proxy", block.chainid);
+        vm.startBroadcast();
+        BoxV2 newBox = new BoxV2();
+        vm.stopBroadcast();
+
+        address proxy = upgradeBox(mostRecentDeployment, address(newBox));
+        return proxy;
+    }
+
+    function upgradeBox(address proxyAddress, address newBox) public returns (address) {
+        vm.startBroadcast();
+        BoxV1 proxy = BoxV1(proxyAddress);
+        proxy.upgradeTo(address(newBox));
+        vm.stopBroadcast();
+        return address(proxy);
+    }
+}

lib/openzeppelin-contracts-upgradeable

@@ -0,0 +1,38 @@
+//SPDX-License-Identifier:MIT
+pragma solidity ^0.8.18;
+
+import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
+import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
+
+contract BoxV1 is Initializable, UUPSUpgradeable, OwnableUpgradeable {
+    uint256 internal number;
+
+    constructor() {
+        // do not allow constructor initialisation/reinitialisation
+        _disableInitializers();
+    }
+
+    /**
+     * @param newImplementation: new implementation to upgradet to
+     * @notice specification of the new implementation to upgrade to and how
+     */
+    function _authorizeUpgrade(address newImplementation) internal override {}
+
+    /**
+     * @notice defining how our V1 should be initialised
+    * caller of this function is the one authorised perform criticall functions relating to upgrades 
+     */
+    function initialize() public initializer {
+        __Ownable_init();
+        __UUPSUpgradeable_init();
+    }
+
+    function getNumber() external view returns (uint256) {
+        return number;
+    }
+
+    function version() external pure returns (uint256) {
+        return 1;
+    }
+}

script/DeployBox.s.sol

@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.18;
+
+import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
+import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
+
+contract BoxV2 is Initializable, UUPSUpgradeable, OwnableUpgradeable {
+    uint256 internal number;
+
+    /// @custom:oz-upgrades-unsafe-allow constructor
+    constructor() {
+        _disableInitializers();
+    }
+
+    function initialize() public initializer {
+        __Ownable_init();
+        __UUPSUpgradeable_init();
+    }
+
+  // new function added that's not in BOXV1.sol
+    function setNumber(uint256 _number) external {
+        number = _number;
+    }
+
+    function getNumber() external view returns (uint256) {
+        return number;
+    }
+
+    function version() external pure returns (uint256) {
+        return 2;
+    }
+
+    function _authorizeUpgrade(address newImplementation) internal override {}
+}