@etherisc/gif-next 3.0.0-cf1abe2-268 → 3.0.0-cf20ffd-765

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

@@ -1,21 +1,21 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
+import {Version} from "../type/Version.sol";
 
 /// IMPORTANT
 // Upgradeable contract MUST:
-// 1) inherit Upgradeable
-// 2) implement getVersion() function
+// 1) inherit from Versionable
+// 2) implement version() 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() 
-// 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)
+// 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 
 // 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 functions
+//    otherwise, it is still possible to upgrade contract, but everyone who is using it will have to switch to a new fucntions
 //    in some cases this ok but not in the others...
 //
 // IMPORTANT
@@ -26,25 +26,31 @@ import {IVersionable} from "../shared/IVersionable.sol";
 // 2) ALWAYS define private getter if accessing storage
 //      - MUST use default implementation, CAN change ONLY return type
 
-interface IUpgradeable is IVersionable {
+interface 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 initialize(address activatedBy, bytes memory activationData) external;
+    function initializeVersionable(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 upgrade(bytes memory upgradeData) external;
+    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);
+
 }

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

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

@@ -3,40 +3,39 @@ pragma solidity ^0.8.20;
 
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 
-import {IUpgradeable} from "./IUpgradeable.sol";
-import {Version} from "../type/Version.sol";
-import {Versionable} from "../shared/Versionable.sol";
+import {IVersionable} from "./IVersionable.sol";
+import {Version, VersionLib} from "../type/Version.sol";
 
-abstract contract Upgradeable is
-    Initializable, 
-    Versionable,
-    IUpgradeable 
+
+abstract contract Versionable is 
+    Initializable,
+    IVersionable 
 {
     constructor() {
         _disableInitializers();
     }
 
-    function initialize(
+    function initializeVersionable(
         address activatedBy,
         bytes memory data
     )
-        external
+        public
+        initializer()
     {
-        if(_getInitializedVersion() != 0) {
-            revert InvalidInitialization();
-        }
-        __Upgradeable_init(activatedBy, data);
+        _initialize(activatedBy, data);
     }
 
-    function upgrade(
+    function upgradeVersionable(
         bytes memory data
     )
         external
-        reinitializer(getVersion().toInt())
+        reinitializer(VersionLib.toUint64(getVersion()))
     {
         _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...
@@ -60,14 +59,4 @@ abstract contract Upgradeable 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-cf1abe2-268",
+  "version": "3.0.0-cf20ffd-765",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {
@@ -43,13 +43,14 @@
     "typescript": "^5"
   },
   "dependencies": {
-    "@openzeppelin/contracts": "5.0.2",
-    "@openzeppelin/contracts-upgradeable": "5.0.2",
+    "@openzeppelin/contracts": "5.1.0",
+    "@openzeppelin/contracts-upgradeable": "5.1.0",
     "@openzeppelin/upgrades-core": "^1.34.1",
     "abi-coder": "^5.0.0",
     "antlr4ng": "^3.0.4",
     "ethers": "^6.7.1",
     "ethers-decode-error": "^2.1.3",
+    "simple-git": "^3.27.0",
     "solidity-docgen": "^0.6.0-beta.36",
     "winston": "^3.10.0"
   }

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

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

package/artifacts/contracts/shared/IVersionable.sol/IVersionable.json

@@ -1,74 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "IVersionable",
-  "sourceName": "contracts/shared/IVersionable.sol",
-  "abi": [
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "target",
-          "type": "address"
-        },
-        {
-          "internalType": "VersionPart",
-          "name": "invalidRelease",
-          "type": "uint8"
-        }
-      ],
-      "name": "ErrorVersionableReleaseInvalid",
-      "type": "error"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "target",
-          "type": "address"
-        },
-        {
-          "internalType": "VersionPart",
-          "name": "expected",
-          "type": "uint8"
-        },
-        {
-          "internalType": "VersionPart",
-          "name": "actual",
-          "type": "uint8"
-        }
-      ],
-      "name": "ErrorVersionableReleaseMismatch",
-      "type": "error"
-    },
-    {
-      "inputs": [],
-      "name": "getRelease",
-      "outputs": [
-        {
-          "internalType": "VersionPart",
-          "name": "",
-          "type": "uint8"
-        }
-      ],
-      "stateMutability": "pure",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getVersion",
-      "outputs": [
-        {
-          "internalType": "Version",
-          "name": "",
-          "type": "uint24"
-        }
-      ],
-      "stateMutability": "pure",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

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

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

package/artifacts/contracts/shared/Versionable.sol/Versionable.json

@@ -1,74 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "Versionable",
-  "sourceName": "contracts/shared/Versionable.sol",
-  "abi": [
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "target",
-          "type": "address"
-        },
-        {
-          "internalType": "VersionPart",
-          "name": "invalidRelease",
-          "type": "uint8"
-        }
-      ],
-      "name": "ErrorVersionableReleaseInvalid",
-      "type": "error"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "target",
-          "type": "address"
-        },
-        {
-          "internalType": "VersionPart",
-          "name": "expected",
-          "type": "uint8"
-        },
-        {
-          "internalType": "VersionPart",
-          "name": "actual",
-          "type": "uint8"
-        }
-      ],
-      "name": "ErrorVersionableReleaseMismatch",
-      "type": "error"
-    },
-    {
-      "inputs": [],
-      "name": "getRelease",
-      "outputs": [
-        {
-          "internalType": "VersionPart",
-          "name": "",
-          "type": "uint8"
-        }
-      ],
-      "stateMutability": "pure",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getVersion",
-      "outputs": [
-        {
-          "internalType": "Version",
-          "name": "",
-          "type": "uint24"
-        }
-      ],
-      "stateMutability": "pure",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

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

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

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

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

package/contracts/shared/IVersionable.sol

@@ -1,19 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Version, VersionPart} from "../type/Version.sol";
-
-interface IVersionable {
-
-    error ErrorVersionableReleaseInvalid(address target, VersionPart invalidRelease);
-    error ErrorVersionableReleaseMismatch(address target, VersionPart expected, VersionPart actual);
-
-    /**
-     * @dev returns version of this contract
-     * implementation MUST define version in this function
-     * version number MUST increase 
-     */
-    function getVersion() external pure returns(Version);
-
-    function getRelease() external pure returns(VersionPart);
-}

package/contracts/shared/Versionable.sol

@@ -1,47 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IVersionable} from "./IVersionable.sol";
-import {GIF_INITIAL_RELEASE} from "../registry/Registry.sol";
-import {Version, VersionPart, VersionLib, VersionPartLib} from "../type/Version.sol";
-
-
-abstract contract Versionable is
-    IVersionable 
-{
-    // TODO use arg of type Version
-    function __Versionable_init(
-        VersionPart release // wants to initialize to this release version
-    )
-        internal
-        view
-        virtual
-    {
-        VersionPart currentRelease = getRelease();
-        if (!currentRelease.isValidRelease()) {
-            revert ErrorVersionableReleaseInvalid(address(this), currentRelease);
-        }
-
-        //Version initializedVersion = VersionLib.toVersion(_getInitializedVersion());
-        //if(initializedVersion != getVersion()) {}
-
-        _checkRelease(release);
-    }
-
-    function getVersion() public pure virtual returns(Version)
-    {
-        return VersionLib.toVersion(GIF_INITIAL_RELEASE().toInt(), 0, 0);
-    }
-
-    function getRelease() public pure returns(VersionPart)
-    {
-        return getVersion().toMajorPart();
-    }
-
-    function _checkRelease(VersionPart release) internal view {
-        VersionPart currentRelease = getRelease();
-        if(currentRelease != release) {
-            revert ErrorVersionableReleaseMismatch(address(this), release, currentRelease);
-        }
-    }
-}