refactor: make VERSION a string

PaulRBerg · Mar 3, 2023 · 699f76b · 699f76b
1 parent aedc5c9
commit 699f76b
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 13 deletions.
diff --git a/src/PRBProxyHelpers.sol b/src/PRBProxyHelpers.sol
@@ -16,7 +16,7 @@ contract PRBProxyHelpers is
     //////////////////////////////////////////////////////////////////////////*/
 
     /// @inheritdoc IPRBProxyHelpers
-    uint256 public constant override VERSION = 4;
+    string public constant override VERSION = "4.0.0";
 
     /*//////////////////////////////////////////////////////////////////////////
                                NON-CONSTANT FUNCTIONS

diff --git a/src/PRBProxyRegistry.sol b/src/PRBProxyRegistry.sol
@@ -13,7 +13,7 @@ contract PRBProxyRegistry is IPRBProxyRegistry {
     //////////////////////////////////////////////////////////////////////////*/
 
     /// @inheritdoc IPRBProxyRegistry
-    uint256 public constant override VERSION = 4;
+    string public constant override VERSION = "4.0.0";
 
     /*//////////////////////////////////////////////////////////////////////////
                                    PUBLIC STORAGE

diff --git a/src/interfaces/IPRBProxyHelpers.sol b/src/interfaces/IPRBProxyHelpers.sol
@@ -37,9 +37,9 @@ interface IPRBProxyHelpers {
                               PUBLIC CONSTANT FUNCTIONS
     //////////////////////////////////////////////////////////////////////////*/
 
-    /// @notice The release version of the {PRBProxy} protocol.
-    /// @dev This version is mirrored here to serve as a link to the proxy registry.
-    function VERSION() external view returns (uint256);
+    /// @notice The semantic version of the {PRBProxy} release.
+    /// @dev This is mirrored here to serve as a link to the proxy registry.
+    function VERSION() external view returns (string memory);
 
     /*//////////////////////////////////////////////////////////////////////////
                             PUBLIC NON-CONSTANT FUNCTIONS

diff --git a/src/interfaces/IPRBProxyRegistry.sol b/src/interfaces/IPRBProxyRegistry.sol
@@ -38,9 +38,9 @@ interface IPRBProxyRegistry {
                               PUBLIC CONSTANT FUNCTIONS
     //////////////////////////////////////////////////////////////////////////*/
 
-    /// @notice The release version of the {PRBProxy} system.
+    /// @notice The semantic version of the {PRBProxy} release.
     /// @dev This is stored in the registry rather than the proxy to save gas for end users.
-    function VERSION() external view returns (uint256);
+    function VERSION() external view returns (string memory);
 
     /// @notice Returns the next seed that will be used to deploy the proxy.
     /// @param origin The externally owned account (EOA) that is part of the CREATE2 salt.

diff --git a/test/helpers/version/version.t.sol b/test/helpers/version/version.t.sol
@@ -5,8 +5,8 @@ import { Helpers_Test } from "../Helpers.t.sol";
 
 contract Version_Test is Helpers_Test {
     function test_Versions() external {
-        uint256 registryVersion = registry.VERSION();
-        uint256 helpersVersion = helpers.VERSION();
+        string memory registryVersion = registry.VERSION();
+        string memory helpersVersion = helpers.VERSION();
         assertEq(registryVersion, helpersVersion, "Registry version does not match helpers version");
     }
 }
diff --git a/test/registry/version/version.t.sol b/test/registry/version/version.t.sol
@@ -4,10 +4,10 @@ pragma solidity >=0.8.19 <=0.9.0;
 import { Registry_Test } from "../Registry.t.sol";
 
 contract Version_Test is Registry_Test {
-    /// @dev it should return the release version.
+    /// @dev it should return the correct version.
     function test_Version() external {
-        uint256 actualVersion = registry.VERSION();
-        uint256 expectedVersion = 4;
+        string memory actualVersion = registry.VERSION();
+        string memory expectedVersion = "4.0.0";
         assertEq(actualVersion, expectedVersion, "VERSION");
     }
 }
diff --git a/test/registry/version/version.tree b/test/registry/version/version.tree
@@ -1,2 +1,2 @@
 version.t.sol
-└── it should return the release version
+└── it should return the correct version