@etherisc/gif-next 0.0.2-858f0b8-208 → 0.0.2-85e1eb3-876

package/contracts/type/Version.sol

@@ -8,7 +8,10 @@ using {
     versionPartEq as ==,
     versionPartNe as !=,
     VersionPartLib.eqz,
-    VersionPartLib.toInt
+    VersionPartLib.gtz,
+    VersionPartLib.toInt,
+    VersionPartLib.toString,
+    VersionPartLib.isValidRelease
 }
     for VersionPart global;
 
@@ -17,9 +20,54 @@ function versionPartEq(VersionPart a, VersionPart b) pure returns(bool isSame) {
 function versionPartNe(VersionPart a, VersionPart b) pure returns(bool isSame) { return VersionPart.unwrap(a) != VersionPart.unwrap(b); }
 
 library VersionPartLib {
+
+    error ErrorReleaseTooBig(VersionPart releaseMax, VersionPart release);
+
+    function releaseMin() public pure returns (VersionPart) { return toVersionPart(3); }
+    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; 
+    } 
+
+    function toString(VersionPart a) external pure returns (string memory) {
+        if (a > releaseMax()) {
+            revert ErrorReleaseTooBig(releaseMax(), a);
+        }
+
+        uint256 value = VersionPart.unwrap(a);
+        if (value == 0) {
+            return "0";
+        }
+
+        uint256 temp = value;
+        uint256 digits = 0;
+        while (temp != 0) {
+            digits++;
+            temp /= 10;
+        }
+
+        bytes memory buffer = new bytes(digits);
+        uint index = digits - 1;
+
+        temp = value;
+        while (temp != 0) {
+            buffer[index] = bytes1(uint8(48 + temp % 10));
+            temp /= 10;
+
+            if (index > 0) {
+                index--;
+            }
+        }
+
+        return string(buffer);
+    }
+
     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) external pure returns(VersionPart) { return VersionPart.wrap(uint8(a)); }
+    function toVersionPart(uint256 a) public pure returns(VersionPart) { return VersionPart.wrap(uint8(a)); }
 }
 
 type Version is uint24; // contains major,minor,patch version parts
@@ -38,6 +86,7 @@ function versionGt(Version a, Version b) pure returns(bool isGreaterThan) { retu
 function versionEq(Version a, Version b) pure returns(bool isSame) { return Version.unwrap(a) == Version.unwrap(b); }
 
 library VersionLib {
+
     function toInt(Version version) external pure returns(uint) { return Version.unwrap(version); }
 
     function toUint64(Version version) external pure returns(uint64) { return Version.unwrap(version); }
@@ -75,9 +124,9 @@ library VersionLib {
         );
     }
 
-    function toVersionPart(uint256 versionPart) external pure returns(VersionPart) { 
-        return VersionPart.wrap(uint8(versionPart)); 
-    }
+    // function toVersionPart(uint256 versionPart) public pure returns(VersionPart) { 
+    //     return VersionPart.wrap(uint8(versionPart)); 
+    // }
 
     function toVersion(
         uint256 major,

package/contracts/upgradeability/IVersionable.sol

@@ -28,6 +28,9 @@ import {Version} from "../type/Version.sol";
 
 interface IVersionable {
 
+    error ErrorVersionableInitializeNotImplemented();
+    error ErrorVersionableUpgradeNotImplemented();
+
     /**
      * @dev IMPORTANT
      * implementation MUST be guarded by initializer modifier

package/contracts/upgradeability/ProxyManager.sol

@@ -18,11 +18,13 @@ contract ProxyManager is
 {
 
     struct VersionInfo {
-        Version version;
+        // slot 0
         address implementation;
-        address activatedBy;
         Timestamp activatedAt;
         Blocknumber activatedIn;
+        Version version;
+        // slot 1
+        address activatedBy;
     }
 
     event LogProxyManagerVersionableDeployed(address indexed proxy, address initialImplementation);
@@ -37,60 +39,71 @@ contract ProxyManager is
     UpgradableProxyWithAdmin internal _proxy;
 
     // state to keep version history
-    mapping(Version version => VersionInfo info) _versionHistory;
-    Version [] _versions;
-
-    /// @dev only used to capture proxy owner
-    constructor(address registry)
-    { 
-        initializeProxyManager(registry);
-    }
+    mapping(Version version => VersionInfo info) internal _versionHistory;
+    Version [] internal _versions;
 
-    function initializeProxyManager(address registry)
+    /// @dev convencience initializer
+    function initialize(
+        address registry,
+        address implementation,
+        bytes memory data,
+        bytes32 salt
+    )
         public
         initializer()
+        returns (IVersionable versionable)
     {
-        initializeNftOwnable(msg.sender, registry);
+        versionable = deployDetermenistic(
+            registry,
+            implementation, 
+            data,
+            salt);
     }
 
     /// @dev deploy initial contract
-    function deploy(address initialImplementation, bytes memory initializationData)
+    function deploy(
+        address registry, 
+        address initialImplementation, 
+        bytes memory initializationData
+    )
         public
         virtual
-        onlyOwner()
+        onlyInitializing()
         returns (IVersionable versionable)
     {
-        if (_versions.length > 0) {
-            revert ErrorProxyManagerAlreadyDeployed();
-        }
+        (
+            address currentProxyOwner, 
+            address initialProxyAdminOwner
+        ) = _preDeployChecksAndSetup(registry);
 
-        address currentProxyOwner = getOwner(); // used by implementation
-        address initialProxyAdminOwner = address(this); // used by proxy
-        
         _proxy = new UpgradableProxyWithAdmin(
             initialImplementation,
             initialProxyAdminOwner,
             getDeployData(currentProxyOwner, initializationData)
         );
 
-        versionable = IVersionable(address(_proxy));
-        _updateVersionHistory(versionable.getVersion(), initialImplementation, currentProxyOwner);
+        versionable = _updateVersionHistory(
+            initialImplementation, 
+            currentProxyOwner);
 
-        emit LogProxyManagerVersionableDeployed(address(_proxy), initialImplementation);
+        emit LogProxyManagerVersionableDeployed(address(versionable), initialImplementation);
     }
 
-    function deployDetermenistic(address initialImplementation, bytes memory initializationData, bytes32 salt)
+    function deployDetermenistic(
+        address registry, 
+        address initialImplementation, 
+        bytes memory initializationData, 
+        bytes32 salt
+    )
         public
         virtual
-        onlyOwner()
+        onlyInitializing()
         returns (IVersionable versionable)
     {
-        if (_versions.length > 0) {
-            revert ErrorProxyManagerAlreadyDeployed();
-        }
-
-        address currentProxyOwner = getOwner();
-        address initialProxyAdminOwner = address(this);
+        (
+            address currentProxyOwner, 
+            address initialProxyAdminOwner
+        ) = _preDeployChecksAndSetup(registry);
 
         _proxy = new UpgradableProxyWithAdmin{salt: salt}(
             initialImplementation,
@@ -98,10 +111,23 @@ contract ProxyManager is
             getDeployData(currentProxyOwner, initializationData)
         );
 
-        versionable = IVersionable(address(_proxy));
-        _updateVersionHistory(versionable.getVersion(), initialImplementation, currentProxyOwner);
+        versionable = _updateVersionHistory(
+            initialImplementation, 
+            currentProxyOwner);
 
-        emit LogProxyManagerVersionableDeployed(address(_proxy), initialImplementation);
+        emit LogProxyManagerVersionableDeployed(address(versionable), initialImplementation);
+    }
+
+    /// @dev upgrade existing contract.
+    /// convenience method using empty data
+    function upgrade(address newImplementation) 
+        public
+        virtual
+        onlyOwner()
+        returns (IVersionable versionable)
+    {
+        bytes memory emptyUpgradeData;
+        return upgrade(newImplementation, emptyUpgradeData);
     }
 
     /// @dev upgrade existing contract
@@ -124,10 +150,11 @@ contract ProxyManager is
             newImplementation, 
             getUpgradeData(upgradeData));
 
-        versionable = IVersionable(address(_proxy));
-        _updateVersionHistory(versionable.getVersion(), newImplementation, currentProxyOwner);
+        versionable = _updateVersionHistory(
+            newImplementation, 
+            currentProxyOwner);
 
-        emit LogProxyManagerVersionableUpgraded(address(_proxy), newImplementation);
+        emit LogProxyManagerVersionableUpgraded(address(versionable), newImplementation);
 
     }
 
@@ -168,13 +195,34 @@ 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(
-        Version newVersion,
         address implementation,
         address activatedBy
     )
         private
+        returns (IVersionable versionable)
     {
+        versionable = IVersionable(address(_proxy));
+        Version newVersion = versionable.getVersion();
+
         if(newVersion == VersionLib.zeroVersion()) {
             revert ErrorProxyManagerZeroVersion();
         }
@@ -187,12 +235,12 @@ contract ProxyManager is
 
         // update version history
         _versions.push(newVersion);
-        _versionHistory[newVersion] = VersionInfo(
-            newVersion,
-            implementation,
-            activatedBy,
-            TimestampLib.blockTimestamp(),
-            blockNumber()
-        );
+        _versionHistory[newVersion] = VersionInfo({
+            version: newVersion,
+            implementation: implementation,
+            activatedBy: activatedBy,
+            activatedAt: TimestampLib.current(),
+            activatedIn: blockNumber()
+        });
     }
 }

package/contracts/upgradeability/UpgradableProxyWithAdmin.sol

@@ -6,9 +6,19 @@ import {TransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transpa
 
 contract UpgradableProxyWithAdmin is TransparentUpgradeableProxy {
 
+    bytes internal _initializationData;
+    
     constructor(address implementation, address initialProxyAdminOwner, bytes memory data)
         TransparentUpgradeableProxy(implementation, initialProxyAdminOwner, data)
-    {}
+    {
+        _initializationData = data;
+    }
 
-    function getProxyAdmin() external returns (ProxyAdmin) { return ProxyAdmin(_proxyAdmin()); }
+    function getProxyAdmin() external returns (ProxyAdmin) { 
+        return ProxyAdmin(_proxyAdmin()); 
+    }
+
+    function getInitializationData() external view returns (bytes memory) { 
+        return _initializationData; 
+    }
 }

package/contracts/upgradeability/Versionable.sol

@@ -20,7 +20,7 @@ abstract contract Versionable is
         bytes memory data
     )
         public
-        initializer
+        initializer()
     {
         _initialize(activatedBy, data);
     }
@@ -39,12 +39,15 @@ abstract contract Versionable is
     // IMPORTANT each version must implement this function 
     // each implementation MUST use onlyInitialising modifier
     // each implementation MUST call intializers of all base contracts...
-    function _initialize(address owner, bytes memory data) 
+    function _initialize(
+        address, // owner
+        bytes memory // data
+    ) 
         internal
-        onlyInitializing
+        onlyInitializing()
         virtual 
     {
-        revert();
+        revert ErrorVersionableInitializeNotImplemented();
     }
 
     // IMPORTANT each version except version "1" must implement this function 
@@ -54,6 +57,6 @@ abstract contract Versionable is
         onlyInitializing
         virtual
     {
-        revert();
+        revert ErrorVersionableUpgradeNotImplemented();
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-858f0b8-208",
+  "version": "0.0.2-85e1eb3-876",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {
@@ -32,11 +32,11 @@
     "@nomicfoundation/hardhat-foundry": "^1.1.1",
     "@nomicfoundation/hardhat-toolbox": "^5.0.0",
     "@nomicfoundation/hardhat-verify": "^2.0.1",
-    "@typescript-eslint/eslint-plugin": "^7.1.0",
-    "@typescript-eslint/parser": "^7.1.0",
+    "@typescript-eslint/eslint-plugin": "^8.1.0",
+    "@typescript-eslint/parser": "^8.1.0",
     "antlr4ng-cli": "^2.0.0",
     "dotenv": "^16.3.1",
-    "eslint": "^8.50.0",
+    "eslint": "^9.9.1",
     "hardhat": "^2.17.2",
     "prettier": "^3.0.3",
     "prettier-plugin-solidity": "^1.1.3",
@@ -49,6 +49,7 @@
     "abi-coder": "^5.0.0",
     "antlr4ng": "^3.0.4",
     "ethers": "^6.7.1",
+    "ethers-decode-error": "^2.1.3",
     "solidity-docgen": "^0.6.0-beta.36",
     "winston": "^3.10.0"
   }

package/artifacts/contracts/authorization/IModuleAuthorization.sol/IModuleAuthorization.dbg.json

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

package/artifacts/contracts/authorization/IModuleAuthorization.sol/IModuleAuthorization.json

@@ -1,290 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "IModuleAuthorization",
-  "sourceName": "contracts/authorization/IModuleAuthorization.sol",
-  "abi": [
-    {
-      "inputs": [
-        {
-          "internalType": "Str",
-          "name": "target",
-          "type": "bytes32"
-        },
-        {
-          "internalType": "RoleId",
-          "name": "roleId",
-          "type": "uint64"
-        }
-      ],
-      "name": "getAuthorizedFunctions",
-      "outputs": [
-        {
-          "components": [
-            {
-              "internalType": "Str",
-              "name": "name",
-              "type": "bytes32"
-            },
-            {
-              "internalType": "Selector",
-              "name": "selector",
-              "type": "bytes4"
-            },
-            {
-              "internalType": "Timestamp",
-              "name": "createdAt",
-              "type": "uint40"
-            }
-          ],
-          "internalType": "struct IAccess.FunctionInfo[]",
-          "name": "authorizatedFunctions",
-          "type": "tuple[]"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "Str",
-          "name": "target",
-          "type": "bytes32"
-        }
-      ],
-      "name": "getAuthorizedRoles",
-      "outputs": [
-        {
-          "internalType": "RoleId[]",
-          "name": "roleIds",
-          "type": "uint64[]"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getRelease",
-      "outputs": [
-        {
-          "internalType": "VersionPart",
-          "name": "release",
-          "type": "uint8"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "RoleId",
-          "name": "roleId",
-          "type": "uint64"
-        }
-      ],
-      "name": "getRoleInfo",
-      "outputs": [
-        {
-          "components": [
-            {
-              "internalType": "RoleId",
-              "name": "adminRoleId",
-              "type": "uint64"
-            },
-            {
-              "internalType": "enum IAccess.RoleType",
-              "name": "roleType",
-              "type": "uint8"
-            },
-            {
-              "internalType": "uint32",
-              "name": "maxMemberCount",
-              "type": "uint32"
-            },
-            {
-              "internalType": "Str",
-              "name": "name",
-              "type": "bytes32"
-            },
-            {
-              "internalType": "Timestamp",
-              "name": "createdAt",
-              "type": "uint40"
-            }
-          ],
-          "internalType": "struct IAccess.RoleInfo",
-          "name": "roleInfo",
-          "type": "tuple"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getRoles",
-      "outputs": [
-        {
-          "internalType": "RoleId[]",
-          "name": "roles",
-          "type": "uint64[]"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getServiceDomains",
-      "outputs": [
-        {
-          "internalType": "ObjectType[]",
-          "name": "serviceDomains",
-          "type": "uint8[]"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "ObjectType",
-          "name": "serviceDomain",
-          "type": "uint8"
-        }
-      ],
-      "name": "getServiceRole",
-      "outputs": [
-        {
-          "internalType": "RoleId",
-          "name": "serviceRoleId",
-          "type": "uint64"
-        }
-      ],
-      "stateMutability": "pure",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "ObjectType",
-          "name": "serviceDomain",
-          "type": "uint8"
-        }
-      ],
-      "name": "getServiceTarget",
-      "outputs": [
-        {
-          "internalType": "Str",
-          "name": "serviceTarget",
-          "type": "bytes32"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getTarget",
-      "outputs": [
-        {
-          "internalType": "Str",
-          "name": "target",
-          "type": "bytes32"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getTargetName",
-      "outputs": [
-        {
-          "internalType": "string",
-          "name": "name",
-          "type": "string"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "Str",
-          "name": "target",
-          "type": "bytes32"
-        }
-      ],
-      "name": "getTargetRole",
-      "outputs": [
-        {
-          "internalType": "RoleId",
-          "name": "roleId",
-          "type": "uint64"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getTargets",
-      "outputs": [
-        {
-          "internalType": "Str[]",
-          "name": "targets",
-          "type": "bytes32[]"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "RoleId",
-          "name": "roleId",
-          "type": "uint64"
-        }
-      ],
-      "name": "roleExists",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "exists",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "Str",
-          "name": "target",
-          "type": "bytes32"
-        }
-      ],
-      "name": "targetExists",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "exists",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}