@etherisc/gif-next 3.0.0-1a7e54a-113 → 3.0.0-1b49bd6-565

package/contracts/type/Version.sol

@@ -5,6 +5,9 @@ type VersionPart is uint8;
 
 using {
     versionPartGt as >,
+    versionPartGte as >=,
+    versionPartLt as <,
+    versionPartLte as <=,
     versionPartEq as ==,
     versionPartNe as !=,
     VersionPartLib.eqz,
@@ -16,6 +19,9 @@ using {
     for VersionPart global;
 
 function versionPartGt(VersionPart a, VersionPart b) pure returns(bool isGreaterThan) { return VersionPart.unwrap(a) > VersionPart.unwrap(b); }
+function versionPartGte(VersionPart a, VersionPart b) pure returns(bool isGreaterThan) { return VersionPart.unwrap(a) >= VersionPart.unwrap(b); }
+function versionPartLt(VersionPart a, VersionPart b) pure returns(bool isLessThan) { return VersionPart.unwrap(a) < VersionPart.unwrap(b); }
+function versionPartLte(VersionPart a, VersionPart b) pure returns(bool isLessThan) { return VersionPart.unwrap(a) <= VersionPart.unwrap(b); }
 function versionPartEq(VersionPart a, VersionPart b) pure returns(bool isSame) { return VersionPart.unwrap(a) == VersionPart.unwrap(b); }
 function versionPartNe(VersionPart a, VersionPart b) pure returns(bool isSame) { return VersionPart.unwrap(a) != VersionPart.unwrap(b); }
 
@@ -27,8 +33,7 @@ library VersionPartLib {
     function releaseMax() public pure returns (VersionPart) { return toVersionPart(99); }
 
     function isValidRelease(VersionPart release) external pure returns(bool) { 
-        uint256 releaseInt = VersionPart.unwrap(release);
-        return 3 <= releaseInt && releaseInt <= 99; 
+        return releaseMin() <= release && release <= releaseMax(); 
     } 
 
     function toString(VersionPart a) external pure returns (string memory) {
@@ -66,8 +71,9 @@ library VersionPartLib {
 
     function eqz(VersionPart a) external pure returns(bool) { return VersionPart.unwrap(a) == 0; }
     function gtz(VersionPart a) external pure returns(bool) { return VersionPart.unwrap(a) > 0; }
-    function toInt(VersionPart a) external pure returns(uint256) { return VersionPart.unwrap(a); }
-    function toVersionPart(uint256 a) public pure returns(VersionPart) { return VersionPart.wrap(uint8(a)); }
+    function toInt(VersionPart a) external pure returns(uint8) { return VersionPart.unwrap(a); }
+    function toVersionPart(uint8 a) public pure returns(VersionPart) { return VersionPart.wrap(uint8(a)); }
+    function zero() external pure returns(VersionPart) { return VersionPart.wrap(0); }
 }
 
 type Version is uint24; // contains major,minor,patch version parts
@@ -87,7 +93,7 @@ function versionEq(Version a, Version b) pure returns(bool isSame) { return Vers
 
 library VersionLib {
 
-    function toInt(Version version) external pure returns(uint) { return Version.unwrap(version); }
+    function toInt(Version version) external pure returns(uint24) { return Version.unwrap(version); }
 
     function toUint64(Version version) external pure returns(uint64) { return Version.unwrap(version); }
 
@@ -124,26 +130,19 @@ library VersionLib {
         );
     }
 
-    // function toVersionPart(uint256 versionPart) public pure returns(VersionPart) { 
-    //     return VersionPart.wrap(uint8(versionPart)); 
-    // }
-
     function toVersion(
-        uint256 major,
-        uint256 minor,
-        uint256 patch
+        uint8 major,
+        uint8 minor,
+        uint8 patch
     )
         external
         pure
         returns(Version)
     {
-        require(
-            major < 256 && minor < 256 && patch < 256,
-            "ERROR:VRS-010:VERSION_PART_TOO_BIG");
 
         return Version.wrap(
             uint24(
-                (major << 16) + (minor << 8) + patch));
+                (uint24(major) << 16) + (uint24(minor) << 8) + patch));
     }
 
     // TODO check for overflow?

package/contracts/upgradeability/{IVersionable.sol → IUpgradeable.sol}

@@ -1,21 +1,21 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Version} from "../type/Version.sol";
+import {IVersionable} from "../shared/IVersionable.sol";
 
 /// IMPORTANT
 // Upgradeable contract MUST:
-// 1) inherit from Versionable
-// 2) implement version() function
+// 1) inherit Upgradeable
+// 2) implement getVersion() function
 // 3) implement internal _initialize() function with onlyInitializing modifier 
 // 4) implement internal _upgrade() function with onlyInitializing modifier (1st version MUST revert)
-// 5) have onlyInitialising modifier for each function callable inside _initialize()/_upgrade() (MUST use different functions for initialization/upgrade and normal operations)
-// 6) use default empty constructor -> _disableInitializer() is called from Versionable contructor
-// 7) use namespace storage (should this be needed)
-// 8) since now inheritance is used for upgradability, contract MUST BE inherited ONLY by the next version 
+// 5) have onlyInitialising modifier for each function callable inside _initialize()/_upgrade() 
+// 6) use different functions for initialization, upgrade and normal operations
+// 7) use default empty constructor -> _disableInitializer() is called from Upgradeable contructor
+// 8) use namespace storage (should storage be needed)
 // Upgradeable contract SHOULD:
 // 9) define all non private methods as virtual (in order to be able to upgrade them latter)
-//    otherwise, it is still possible to upgrade contract, but everyone who is using it will have to switch to a new fucntions
+//    otherwise, it is still possible to upgrade contract, but everyone who is using it will have to switch to a new functions
 //    in some cases this ok but not in the others...
 //
 // IMPORTANT
@@ -26,31 +26,25 @@ import {Version} from "../type/Version.sol";
 // 2) ALWAYS define private getter if accessing storage
 //      - MUST use default implementation, CAN change ONLY return type
 
-interface IVersionable {
+interface IUpgradeable is IVersionable {
 
     error ErrorVersionableInitializeNotImplemented();
     error ErrorVersionableUpgradeNotImplemented();
 
     /**
      * @dev IMPORTANT
+     * top level initializer for each upgradeable
      * implementation MUST be guarded by initializer modifier
      * new version MUST inherit from previous version
      */
-    function initializeVersionable(address activatedBy, bytes memory activationData) external;
+    function initialize(address activatedBy, bytes memory activationData) external;
 
     /**
      * @dev
+     * top level reinitializer for each upgradeable
      * implementation MUST be guarded by reinitializer(version().toUint64()) modifier
      * new version MUST inherit from previous version
      * the first verion MUST revert 
      */
-    function upgradeVersionable(bytes memory upgradeData) external;
-
-    /**
-     * @dev returns version of this contract
-     * each new implementation MUST implement this function
-     * version number MUST increase 
-     */
-    function getVersion() external pure returns(Version);
-
+    function upgrade(bytes memory upgradeData) external;
 }

package/contracts/upgradeability/ProxyManager.sol

@@ -5,14 +5,14 @@ import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.s
 import {ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
 
 import {Blocknumber, BlocknumberLib} from "../type/Blocknumber.sol";
-import {IVersionable} from "./IVersionable.sol";
+import {IUpgradeable} from "./IUpgradeable.sol";
 import {NftId} from "../type/NftId.sol";
 import {NftOwnable} from "../shared/NftOwnable.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 import {UpgradableProxyWithAdmin} from "./UpgradableProxyWithAdmin.sol";
-import {Version, VersionLib} from "../type/Version.sol";
+import {Version, VersionPart, VersionLib} from "../type/Version.sol";
 
-/// @dev manages proxy deployments for upgradable contracs of type IVersionable
+/// @dev manages proxy deployments for upgradable contracs of type IUpgradeable
 contract ProxyManager is
     NftOwnable
 {
@@ -27,14 +27,15 @@ contract ProxyManager is
         address activatedBy;
     }
 
-    event LogProxyManagerVersionableDeployed(address indexed proxy, address initialImplementation);
-    event LogProxyManagerVersionableUpgraded(address indexed proxy, address upgradedImplementation);
+    event LogProxyManagerProxyDeployed(address indexed proxy, address initialImplementation);
+    event LogProxyManagerProxyUpgraded(address indexed proxy, address upgradedImplementation);
 
     error ErrorProxyManagerAlreadyDeployed();
     error ErrorProxyManagerNotYetDeployed();
 
     error ErrorProxyManagerZeroVersion();
     error ErrorProxyManagerNextVersionNotIncreasing(Version nextVersion);
+    error ErrorProxyManagerNextVersionReleaseInvalid(Version nextVersion);
 
     UpgradableProxyWithAdmin internal _proxy;
 
@@ -44,17 +45,19 @@ contract ProxyManager is
 
     /// @dev convencience initializer
     function initialize(
-        address registry,
         address implementation,
         bytes memory data,
         bytes32 salt
     )
         public
         initializer()
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
-        versionable = deployDetermenistic(
-            registry,
+        address initialOwner = msg.sender;
+
+        __NftOwnable_init(initialOwner);
+
+        upgradeable = deployDetermenistic(
             implementation, 
             data,
             salt);
@@ -62,19 +65,20 @@ contract ProxyManager is
 
     /// @dev deploy initial contract
     function deploy(
-        address registry, 
         address initialImplementation, 
         bytes memory initializationData
     )
         public
         virtual
         onlyInitializing()
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
-        (
-            address currentProxyOwner, 
-            address initialProxyAdminOwner
-        ) = _preDeployChecksAndSetup(registry);
+        if (_versions.length > 0) {
+            revert ErrorProxyManagerAlreadyDeployed();
+        }
+
+        address currentProxyOwner = getOwner(); // used by implementation
+        address initialProxyAdminOwner = address(this); // used by proxy
 
         _proxy = new UpgradableProxyWithAdmin(
             initialImplementation,
@@ -82,15 +86,14 @@ contract ProxyManager is
             getDeployData(currentProxyOwner, initializationData)
         );
 
-        versionable = _updateVersionHistory(
+        upgradeable = _updateVersionHistory(
             initialImplementation, 
             currentProxyOwner);
 
-        emit LogProxyManagerVersionableDeployed(address(versionable), initialImplementation);
+        emit LogProxyManagerProxyDeployed(address(upgradeable), initialImplementation);
     }
 
     function deployDetermenistic(
-        address registry, 
         address initialImplementation, 
         bytes memory initializationData, 
         bytes32 salt
@@ -98,12 +101,14 @@ contract ProxyManager is
         public
         virtual
         onlyInitializing()
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
-        (
-            address currentProxyOwner, 
-            address initialProxyAdminOwner
-        ) = _preDeployChecksAndSetup(registry);
+        if (_versions.length > 0) {
+            revert ErrorProxyManagerAlreadyDeployed();
+        }
+
+        address currentProxyOwner = getOwner(); // used by implementation
+        address initialProxyAdminOwner = address(this); // used by proxy
 
         _proxy = new UpgradableProxyWithAdmin{salt: salt}(
             initialImplementation,
@@ -111,11 +116,11 @@ contract ProxyManager is
             getDeployData(currentProxyOwner, initializationData)
         );
 
-        versionable = _updateVersionHistory(
+        upgradeable = _updateVersionHistory(
             initialImplementation, 
             currentProxyOwner);
 
-        emit LogProxyManagerVersionableDeployed(address(versionable), initialImplementation);
+        emit LogProxyManagerProxyDeployed(address(upgradeable), initialImplementation);
     }
 
     /// @dev upgrade existing contract.
@@ -124,7 +129,7 @@ contract ProxyManager is
         public
         virtual
         onlyOwner()
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
         bytes memory emptyUpgradeData;
         return upgrade(newImplementation, emptyUpgradeData);
@@ -135,7 +140,7 @@ contract ProxyManager is
         public
         virtual
         onlyOwner()
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
         if (_versions.length == 0) { 
             revert ErrorProxyManagerNotYetDeployed();
@@ -150,11 +155,11 @@ contract ProxyManager is
             newImplementation, 
             getUpgradeData(upgradeData));
 
-        versionable = _updateVersionHistory(
+        upgradeable = _updateVersionHistory(
             newImplementation, 
             currentProxyOwner);
 
-        emit LogProxyManagerVersionableUpgraded(address(versionable), newImplementation);
+        emit LogProxyManagerProxyUpgraded(address(upgradeable), newImplementation);
 
     }
 
@@ -164,14 +169,14 @@ contract ProxyManager is
 
     function getDeployData(address proxyOwner, bytes memory deployData) public pure returns (bytes memory data) {
         return abi.encodeWithSelector(
-            IVersionable.initializeVersionable.selector, 
+            IUpgradeable.initialize.selector, 
             proxyOwner, 
             deployData);
     }
 
     function getUpgradeData(bytes memory upgradeData) public pure returns (bytes memory data) {
         return abi.encodeWithSelector(
-            IVersionable.upgradeVersionable.selector, 
+            IUpgradeable.upgrade.selector, 
             upgradeData);
     }
 
@@ -180,7 +185,7 @@ contract ProxyManager is
     }
 
     function getVersion() external view virtual returns(Version) {
-        return IVersionable(address(_proxy)).getVersion();
+        return _versionHistory[_versions[_versions.length]].version;
     }
 
     function getVersionCount() external view returns(uint256) {
@@ -195,42 +200,29 @@ contract ProxyManager is
         return _versionHistory[_version];
     }
 
-    function _preDeployChecksAndSetup(address registry)
-        private
-        returns (
-            address currentProxyOwner,
-            address initialProxyAdminOwner
-        )
-    {
-        if (_versions.length > 0) {
-            revert ErrorProxyManagerAlreadyDeployed();
-        }
-
-        address initialOwner = msg.sender;
-        __NftOwnable_init(registry, initialOwner);
-
-        currentProxyOwner = getOwner(); // used by implementation
-        initialProxyAdminOwner = address(this); // used by proxy
-    }
-
     function _updateVersionHistory(
         address implementation,
         address activatedBy
     )
         private
-        returns (IVersionable versionable)
+        returns (IUpgradeable upgradeable)
     {
-        versionable = IVersionable(address(_proxy));
-        Version newVersion = versionable.getVersion();
+        upgradeable = IUpgradeable(address(_proxy));
+        Version newVersion = upgradeable.getVersion();
 
         if(newVersion == VersionLib.zeroVersion()) {
             revert ErrorProxyManagerZeroVersion();
         }
 
         if(_versions.length > 0) {
-            if(newVersion.toInt() <= _versions[_versions.length-1].toInt()) {
+            Version version = _versions[_versions.length-1];
+            if(newVersion.toInt() <= version.toInt()) {
                 revert ErrorProxyManagerNextVersionNotIncreasing(newVersion);
             }
+
+            if(newVersion.toMajorPart() != version.toMajorPart()) {
+                revert ErrorProxyManagerNextVersionReleaseInvalid(newVersion);
+            }
         }
 
         // update version history

package/contracts/upgradeability/{Versionable.sol → Upgradeable.sol}

@@ -3,39 +3,40 @@ pragma solidity ^0.8.20;
 
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 
-import {IVersionable} from "./IVersionable.sol";
-import {Version, VersionLib} from "../type/Version.sol";
+import {IUpgradeable} from "./IUpgradeable.sol";
+import {Version} from "../type/Version.sol";
+import {Versionable} from "../shared/Versionable.sol";
 
-
-abstract contract Versionable is 
-    Initializable,
-    IVersionable 
+abstract contract Upgradeable is
+    Initializable, 
+    Versionable,
+    IUpgradeable 
 {
     constructor() {
         _disableInitializers();
     }
 
-    function initializeVersionable(
+    function initialize(
         address activatedBy,
         bytes memory data
     )
-        public
-        initializer()
+        external
     {
-        _initialize(activatedBy, data);
+        if(_getInitializedVersion() != 0) {
+            revert InvalidInitialization();
+        }
+        __Upgradeable_init(activatedBy, data);
     }
 
-    function upgradeVersionable(
+    function upgrade(
         bytes memory data
     )
         external
-        reinitializer(VersionLib.toUint64(getVersion()))
+        reinitializer(getVersion().toInt())
     {
         _upgrade(data);
     }
 
-    function getVersion() public pure virtual returns(Version);
-
     // IMPORTANT each version must implement this function 
     // each implementation MUST use onlyInitialising modifier
     // each implementation MUST call intializers of all base contracts...
@@ -59,4 +60,14 @@ abstract contract Versionable is
     {
         revert ErrorVersionableUpgradeNotImplemented();
     }
+
+    function __Upgradeable_init(
+        address activatedBy,
+        bytes memory data
+    )
+        private
+        reinitializer(getVersion().toInt())
+    {
+        _initialize(activatedBy, data);
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "3.0.0-1a7e54a-113",
+  "version": "3.0.0-1b49bd6-565",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {

package/artifacts/contracts/shared/ContractLib.sol/IInstanceAdminHelper.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/ff3fbb928285ca8eed6d2a3173f3605a.json"
-}

package/artifacts/contracts/shared/ContractLib.sol/IInstanceAdminHelper.json

@@ -1,24 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "IInstanceAdminHelper",
-  "sourceName": "contracts/shared/ContractLib.sol",
-  "abi": [
-    {
-      "inputs": [],
-      "name": "getInstanceAdmin",
-      "outputs": [
-        {
-          "internalType": "contract ITargetHelper",
-          "name": "",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/artifacts/contracts/shared/ContractLib.sol/ITokenRegistryHelper.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/ff3fbb928285ca8eed6d2a3173f3605a.json"
-}

package/artifacts/contracts/shared/ContractLib.sol/ITokenRegistryHelper.json

@@ -1,40 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "ITokenRegistryHelper",
-  "sourceName": "contracts/shared/ContractLib.sol",
-  "abi": [
-    {
-      "inputs": [
-        {
-          "internalType": "ChainId",
-          "name": "chainId",
-          "type": "uint96"
-        },
-        {
-          "internalType": "address",
-          "name": "token",
-          "type": "address"
-        },
-        {
-          "internalType": "VersionPart",
-          "name": "release",
-          "type": "uint8"
-        }
-      ],
-      "name": "isActive",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/artifacts/contracts/upgradeability/IVersionable.sol/IVersionable.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/ff3fbb928285ca8eed6d2a3173f3605a.json"
-}

package/artifacts/contracts/upgradeability/Versionable.sol/Versionable.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/ff3fbb928285ca8eed6d2a3173f3605a.json"
-}