feat: versioning of upgradable contracts implementation

jaybuidl · jaybuidl · commit b4d925a71eb0 · 2025-01-21T19:37:02.000Z
diff --git a/contracts/deploy/upgrade-dispute-kit.ts b/contracts/deploy/upgrade-dispute-kit.ts
@@ -14,7 +14,7 @@ const deployUpgradeDisputeKit: DeployFunction = async (hre: HardhatRuntimeEnviro
   try {
     console.log("upgrading DisputeKitClassicNeo...");
     await deployUpgradable(deployments, "DisputeKitClassicNeo", {
-      newImplementation: "DisputeKitGated",
+      contract: "DisputeKitClassic",
       initializer: "initialize",
       from: deployer,
       // Warning: do not reinitialize everything, only the new variables
diff --git a/contracts/src/arbitration/DisputeTemplateRegistry.sol b/contracts/src/arbitration/DisputeTemplateRegistry.sol
@@ -8,6 +8,8 @@ import "./interfaces/IDisputeTemplateRegistry.sol";
 /// @title Dispute Template Registry
 /// @dev A contract to maintain a registry of dispute templates.
 contract DisputeTemplateRegistry is IDisputeTemplateRegistry, UUPSProxiable, Initializable {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *             Storage               * //
     // ************************************* //
diff --git a/contracts/src/arbitration/KlerosCore.sol b/contracts/src/arbitration/KlerosCore.sol
@@ -14,6 +14,8 @@ import {KlerosCoreBase, IDisputeKit, ISortitionModule, IERC20} from "./KlerosCor
 /// Core arbitrator contract for Kleros v2.
 /// Note that this contract trusts the PNK token, the dispute kit and the sortition module contracts.
 contract KlerosCore is KlerosCoreBase {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *            Constructor            * //
     // ************************************* //
diff --git a/contracts/src/arbitration/KlerosCoreNeo.sol b/contracts/src/arbitration/KlerosCoreNeo.sol
@@ -15,6 +15,8 @@ import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 /// Core arbitrator contract for Kleros v2.
 /// Note that this contract trusts the PNK token, the dispute kit and the sortition module contracts.
 contract KlerosCoreNeo is KlerosCoreBase {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *             Storage               * //
     // ************************************* //
diff --git a/contracts/src/arbitration/PolicyRegistry.sol b/contracts/src/arbitration/PolicyRegistry.sol
@@ -7,6 +7,8 @@ import "../proxy/Initializable.sol";
 /// @title PolicyRegistry
 /// @dev A contract to maintain a policy for each court.
 contract PolicyRegistry is UUPSProxiable, Initializable {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *              Events               * //
     // ************************************* //
diff --git a/contracts/src/arbitration/SortitionModule.sol b/contracts/src/arbitration/SortitionModule.sol
@@ -15,6 +15,8 @@ import {SortitionModuleBase, KlerosCore, RNG} from "./SortitionModuleBase.sol";
 /// @title SortitionModule
 /// @dev A factory of trees that keeps track of staked values for sortition.
 contract SortitionModule is SortitionModuleBase {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *            Constructor            * //
     // ************************************* //
diff --git a/contracts/src/arbitration/SortitionModuleNeo.sol b/contracts/src/arbitration/SortitionModuleNeo.sol
@@ -15,6 +15,8 @@ import {SortitionModuleBase, KlerosCore, RNG, StakingResult} from "./SortitionMo
 /// @title SortitionModuleNeo
 /// @dev A factory of trees that keeps track of staked values for sortition.
 contract SortitionModuleNeo is SortitionModuleBase {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *             Storage               * //
     // ************************************* //
diff --git a/contracts/src/arbitration/devtools/KlerosCoreRuler.sol b/contracts/src/arbitration/devtools/KlerosCoreRuler.sol
@@ -13,6 +13,8 @@ import "../../libraries/Constants.sol";
 contract KlerosCoreRuler is IArbitratorV2, UUPSProxiable, Initializable {
     using SafeERC20 for IERC20;
 
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *         Enums / Structs           * //
     // ************************************* //
diff --git a/contracts/src/arbitration/dispute-kits/DisputeKitClassic.sol b/contracts/src/arbitration/dispute-kits/DisputeKitClassic.sol
@@ -17,6 +17,8 @@ import {DisputeKitClassicBase, KlerosCore} from "./DisputeKitClassicBase.sol";
 /// - an incentive system: equal split between coherent votes,
 /// - an appeal system: fund 2 choices only, vote on any choice.
 contract DisputeKitClassic is DisputeKitClassicBase {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *            Constructor            * //
     // ************************************* //
diff --git a/contracts/src/arbitration/dispute-kits/DisputeKitGated.sol b/contracts/src/arbitration/dispute-kits/DisputeKitGated.sol
@@ -32,6 +32,8 @@ interface IERC1155 {
 /// - an incentive system: equal split between coherent votes,
 /// - an appeal system: fund 2 choices only, vote on any choice.
 contract DisputeKitGated is DisputeKitClassicBase {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *             Storage               * //
     // ************************************* //
diff --git a/contracts/src/arbitration/dispute-kits/DisputeKitSybilResistant.sol b/contracts/src/arbitration/dispute-kits/DisputeKitSybilResistant.sol
@@ -24,6 +24,8 @@ interface IProofOfHumanity {
 /// - an incentive system: equal split between coherent votes,
 /// - an appeal system: fund 2 choices only, vote on any choice.
 contract DisputeKitSybilResistant is DisputeKitClassicBase {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *             Storage               * //
     // ************************************* //
diff --git a/contracts/src/arbitration/evidence/EvidenceModule.sol b/contracts/src/arbitration/evidence/EvidenceModule.sol
@@ -16,6 +16,8 @@ import "../../proxy/Initializable.sol";
 
 /// @title Evidence Module
 contract EvidenceModule is IEvidence, Initializable, UUPSProxiable {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *             Storage               * //
     // ************************************* //
diff --git a/contracts/src/arbitration/university/KlerosCoreUniversity.sol b/contracts/src/arbitration/university/KlerosCoreUniversity.sol
@@ -15,6 +15,8 @@ import {Initializable} from "../../proxy/Initializable.sol";
 contract KlerosCoreUniversity is IArbitratorV2, UUPSProxiable, Initializable {
     using SafeERC20 for IERC20;
 
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *         Enums / Structs           * //
     // ************************************* //
diff --git a/contracts/src/arbitration/university/SortitionModuleUniversity.sol b/contracts/src/arbitration/university/SortitionModuleUniversity.sol
@@ -20,6 +20,8 @@ import "../../libraries/Constants.sol";
 /// @title SortitionModuleUniversity
 /// @dev An adapted version of the SortitionModule contract for educational purposes.
 contract SortitionModuleUniversity is ISortitionModuleUniversity, UUPSProxiable, Initializable {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *         Enums / Structs           * //
     // ************************************* //
diff --git a/contracts/src/gateway/ForeignGateway.sol b/contracts/src/gateway/ForeignGateway.sol
@@ -16,6 +16,8 @@ import "../libraries/Constants.sol";
 /// Foreign Gateway
 /// Counterpart of `HomeGateway`
 contract ForeignGateway is IForeignGateway, UUPSProxiable, Initializable {
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *         Enums / Structs           * //
     // ************************************* //
diff --git a/contracts/src/gateway/HomeGateway.sol b/contracts/src/gateway/HomeGateway.sol
@@ -20,6 +20,8 @@ import "../proxy/Initializable.sol";
 contract HomeGateway is IHomeGateway, UUPSProxiable, Initializable {
     using SafeERC20 for IERC20;
 
+    string public constant override version = "0.8.0";
+
     // ************************************* //
     // *         Enums / Structs           * //
     // ************************************* //
diff --git a/contracts/src/proxy/UUPSProxiable.sol b/contracts/src/proxy/UUPSProxiable.sol
@@ -148,6 +148,12 @@ abstract contract UUPSProxiable {
         return IMPLEMENTATION_SLOT;
     }
 
+    /**
+     * @notice Returns the version of the contract.
+     * @return Version string.
+     */
+    function version() external view virtual returns (string memory);
+
     // ************************************* //
     // *           Internal Views          * //
     // ************************************* //
diff --git a/contracts/src/proxy/mock/UUPSUpgradeableMocks.sol b/contracts/src/proxy/mock/UUPSUpgradeableMocks.sol
@@ -16,10 +16,6 @@ contract NonUpgradeableMock {
     function increment() external {
         _counter++;
     }
-
-    function version() external pure virtual returns (string memory) {
-        return "NonUpgradeableMock 0.0.0";
-    }
 }
 
 contract UUPSUpgradeableMock is UUPSProxiable, NonUpgradeableMock {
diff --git a/contracts/src/proxy/mock/by-inheritance/UpgradedByInheritance.sol b/contracts/src/proxy/mock/by-inheritance/UpgradedByInheritance.sol
@@ -33,7 +33,7 @@ contract UpgradedByInheritanceV1 is UUPSProxiable, Initializable {
         ++counter;
     }
 
-    function version() external pure virtual returns (string memory) {
+    function version() external pure virtual override returns (string memory) {
         return "V1";
     }
 }
diff --git a/contracts/src/proxy/mock/by-rewrite/UpgradedByRewrite.sol b/contracts/src/proxy/mock/by-rewrite/UpgradedByRewrite.sol
@@ -36,7 +36,7 @@ contract UpgradedByRewrite is UUPSProxiable, Initializable {
         ++counter;
     }
 
-    function version() external pure virtual returns (string memory) {
+    function version() external pure virtual override returns (string memory) {
         return "V1";
     }
 }
diff --git a/contracts/src/proxy/mock/by-rewrite/UpgradedByRewriteV2.sol b/contracts/src/proxy/mock/by-rewrite/UpgradedByRewriteV2.sol
@@ -36,7 +36,7 @@ contract UpgradedByRewrite is UUPSProxiable, Initializable {
         ++counter;
     }
 
-    function version() external pure virtual returns (string memory) {
+    function version() external pure virtual override returns (string memory) {
         return "V2";
     }
 }
