@etherisc/gif-next 0.0.2-f1fe735-758 → 0.0.2-f2a5ca7-763

package/contracts/type/ObjectType.sol

@@ -27,20 +27,16 @@ function STAKING() pure returns (ObjectType) {
     return ObjectType.wrap(3);
 }
 
-function TOKEN() pure returns (ObjectType) {
-    return ObjectType.wrap(6);
-}
-
 function RELEASE() pure returns (ObjectType) {
-    return ObjectType.wrap(7);
+    return ObjectType.wrap(6);
 }
 
 function ROLE() pure returns (ObjectType) {
-    return ObjectType.wrap(8);
+    return ObjectType.wrap(7);
 }
 
 function SERVICE() pure returns (ObjectType) {
-    return ObjectType.wrap(9);
+    return ObjectType.wrap(8);
 }
 
 function INSTANCE() pure returns (ObjectType) {
@@ -137,6 +133,8 @@ function neObjectType(ObjectType a, ObjectType b) pure returns (bool isSame) {
 // library functions that operate on user defined type
 library ObjectTypeLib {
 
+    error ErrorVersionTooBig(uint256 version);
+
     function zero() public pure returns (ObjectType) {
         return ObjectType.wrap(0);
     }
@@ -209,6 +207,38 @@ library ObjectTypeLib {
                     toInt(objectType))));
     }
 
+    function toVersionedName(
+        string memory name, 
+        string memory suffix, 
+        uint256 version
+    )
+        external
+        pure
+        returns (string memory versionedName)
+    {
+        if (version > maxNumReleases()) {
+            revert ErrorVersionTooBig(version);
+        }
+
+        string memory versionName = "_v0";
+
+        if (version >= 10) {
+            versionName = "_v";
+        }
+
+        versionedName = string(
+            abi.encodePacked(
+                name,
+                suffix,
+                versionName,
+                toString(version)));
+    }
+
+    /// @dev returns the max number of releases (major versions) this gif setup can handle.
+    function maxNumReleases() public pure returns (uint8) {
+        return 99;
+    }
+
     /// @dev returns the provied int as a string
     function toString(uint256 value) public pure returns (string memory name) {
 

package/contracts/type/RoleId.sol

@@ -19,6 +19,16 @@ using {
 
 // general pure free functions
 
+// @dev Returns true iff role ids a and b are identical
+function eqRoleId(RoleId a, RoleId b) pure returns (bool isSame) {
+    return RoleId.unwrap(a) == RoleId.unwrap(b);
+}
+
+// @dev Returns true iff role ids a and b are different
+function neRoleId(RoleId a, RoleId b) pure returns (bool isDifferent) {
+    return RoleId.unwrap(a) != RoleId.unwrap(b);
+}
+
 //--- OpenZeppelin provided roles -------------------------------------------//
 
 /// @dev Role ID needs to match with oz AccessManager.ADMIN_ROLE
@@ -27,30 +37,22 @@ function ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(type(uin
 /// @dev Role ID needs to match with oz AccessManager.PUBLIC_ROLE
 function PUBLIC_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(type(uint64).max); }
 
-/// @dev Default access admin (registry admin, instance admin) role with rights to manage roles
-function MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1); } 
-
-//--- Core GIF roles (range: 1-99) ------------------------------------------//
+//--- GIF roles (range: 1-99) ----------------------------------------------//
 
 /// @dev cental role for gif release management.
 /// this role is necessary to call ReleaseManager.createNextRelease/activateNextRelease
 /// the actual deployment of a release requires the GIF_MANAGER_ROLE.
 /// GIF_ADMIN_ROLE is the admin of the GIF_MANAGER_ROLE.
 /// only a single holder may hold this role at any time
-function GIF_ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2); } 
+function GIF_ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1); } 
 
 /// @dev role for token whith/blacklisting, deploying and registering the services for a new major release
 /// registering services for a new major release is only possible after a new initial release has been created by the GIF_ADMIN_ROLE
 /// token white/blacklisting is possible for any active release
-function GIF_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(3); } 
+function GIF_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2); } 
 
 /// @dev role for registering remote staking targets and reporting remote total value locked amounts.
-function GIF_REMOTE_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(4); } 
-
-/// @dev required role to own an instance.
-/// Role is granted by instance service when cloning a new instance.
-/// allows instance specific target, role and access management 
-function INSTANCE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10); }
+function GIF_REMOTE_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(3); } 
 
 /// @dev instance specific  role to register/own a product component
 function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(11); }
@@ -64,119 +66,90 @@ function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRo
 /// @dev instance specific  role to register/own a pool component
 function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(14); }
 
-//--- GIF contract roles (range: 200 - 9900) --------------------------------//
+//--- GIF core contract roles (range: 200 - 9'900) --------------------------//
 // created and assigned during initial deployment for registry and staking
 // granting for instances and components in instance service
 // object type * 100 + 0, examples:
 // - registry contract role: 200 
 // - staking contract role: 300 
 // - instance contract role: 1000
-// - product contract role: 1200
 
-//--- GIF service roles (range 201 - 99xx) ----------------------------------//
+//--- GIF service roles (range 201 - 9'9xx) ---------------------------------//
 // created and assigned by release manager contract
 // object type * 100 + 1/major version, examples:
-// - registry service role (any version): 201
+// - registry service role (any version): 299
 // - registry service role (version 3): 203
-// - registry service role (any version): 301
+// - registry service role (any version): 399
 // - staking service role: (version 3): 303
 // - application service role (version 3): 2003
 
-//--- Custom roles (range > 10000) ------------------------------------------//
-
-/// @dev role associated with the staking contract
-/// this role is the admin role for the INSTANCE_OWNER_ROLE
-function STAKING_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1313); }
-
-/// @dev role associated with an instance contract
-/// this role is the admin role for the INSTANCE_OWNER_ROLE
-function INSTANCE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2600); }
-
-function REGISTRY_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1800); }
-
-/// @dev instance specific role for instance service
-function INSTANCE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2000); }
-
-/// @dev role for creating gif target on instance service
-function CAN_CREATE_GIF_TARGET__ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1700); }
-
-/// @dev role for registering gif components
-function COMPONENT_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2001); }
-
-/// @dev instance specific role for distribution service
-function DISTRIBUTION_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2100); }
-
-/// @dev instance specific role for oracle service
-function ORACLE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2150); }
-
-/// @dev instance specific role for pool service
-function POOL_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2200); }
-
-/// @dev instance specific role for product service
-function PRODUCT_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2300); }
+//--- GIF component contract roles (range 12'001 - 19'099) ------------------//
+// assigned at component registration time
+// object type * 1000 + instane specific component counter
+// on any instance a maximum number of 999 components may be deployed
+// examples:
+// - 1st pool on instance: 15001
+// - 1st distribution on instance: 14002
+// - 1st product on instance: 12003
+// - 2nd pool on instance: 15004
+// - 2nd distribution on instance: 14005
+// - 2nd product on instance: 12006
 
-/// @dev instance specific role for application service
-function APPLICATION_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2400); }
 
-/// @dev instance specific role for policy service
-function POLICY_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2410); }
+//--- Custom roles (range >= 1'000'000) -------------------------------------//
 
-/// @dev instance specific role for claim service
-function CLAIM_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2420); }
+function CUSTOM_ROLE_MIN() pure returns (RoleId) { return RoleIdLib.toRoleId(1000000); }
 
-/// @dev instance specific role for bundle service
-function BUNDLE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2500); }
-
-/// @dev instance specific role for pricing service
-function PRICING_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2800); }
+library RoleIdLib {
 
-/// @dev instance specific role for staking service
-function STAKING_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2900); }
+    uint64 public constant ALL_VERSIONS = 99;
+    uint64 public constant SERVICE_DOMAIN_ROLE_FACTOR = 100;
+    uint64 public constant COMPONENT_ROLE_FACTOR = 100;
+    uint64 public constant CUSTOM_ROLE_MIN = 1000000;
 
-// @dev Returns true iff role ids a and b are identical
-function eqRoleId(RoleId a, RoleId b) pure returns (bool isSame) {
-    return RoleId.unwrap(a) == RoleId.unwrap(b);
-}
-
-// @dev Returns true iff role ids a and b are different
-function neRoleId(RoleId a, RoleId b) pure returns (bool isDifferent) {
-    return RoleId.unwrap(a) != RoleId.unwrap(b);
-}
-
-library RoleIdLib {
-/// @dev Converts the RoleId to a uint.
+    /// @dev Converts the RoleId to a uint.
     function zero() public pure returns (RoleId) {
         return RoleId.wrap(0);
     }
 
-    /// @dev Converts an uint into a RoleId.
-    function toRoleId(uint256 a) public pure returns (RoleId) {
-        return RoleId.wrap(uint64(a));
+    /// @dev Converts an uint into a role id.
+    function toRoleId(uint64 a) public pure returns (RoleId) {
+        return RoleId.wrap(a);
     }
 
-    /// @dev Converts the RoleId to a uint.
+    /// @dev Converts an uint into a component role id.
+    function toComponentRoleId(ObjectType objectType, uint64 index) public pure returns (RoleId) {
+        return toRoleId(COMPONENT_ROLE_FACTOR * uint64(objectType.toInt()) + index);
+    }
+
+    /// @dev Converts an uint into a custom role id.
+    function toCustomRoleId(uint64 index) public pure returns (RoleId) {
+        return toRoleId(CUSTOM_ROLE_MIN + index);
+    }
+
+    /// @dev Converts the role id to a uint.
     function toInt(RoleId a) public pure returns (uint64) {
         return uint64(RoleId.unwrap(a));
     }
 
-    /// @dev Converts an uint into a RoleId.
+    /// @dev Converts an uint into a role id.
     /// Used for GIF core contracts.
     function roleForType(ObjectType objectType) public pure returns (RoleId) {
-        return RoleId.wrap(100 * uint64(objectType.toInt()));
+        return RoleId.wrap(SERVICE_DOMAIN_ROLE_FACTOR * uint64(objectType.toInt()));
     }
 
     /// @dev Converts an uint into a RoleId.
     /// Used for GIF core contracts.
     function roleForTypeAndVersion(ObjectType objectType, VersionPart majorVersion) public pure returns (RoleId) {
         return RoleId.wrap(
-            uint64(100 * objectType.toInt() + majorVersion.toInt()));
+            uint64(SERVICE_DOMAIN_ROLE_FACTOR * objectType.toInt() + majorVersion.toInt()));
     }
 
     /// @dev Converts an uint into a RoleId.
     /// Used for GIF core contracts.
     function roleForTypeAndAllVersions(ObjectType objectType) public pure returns (RoleId) {
         return RoleId.wrap(
-            uint64(100 * objectType.toInt() + 99));
+            uint64(SERVICE_DOMAIN_ROLE_FACTOR * objectType.toInt() + ALL_VERSIONS));
     }
 
     /// @dev Returns true if the value is non-zero (> 0).

package/contracts/type/UFixed.sol

@@ -16,6 +16,7 @@ using {
     eqUFixed as ==,
     neUFixed as !=,
     UFixedLib.toInt,
+    UFixedLib.toInt1000,
     UFixedLib.gtz
 } for UFixed global;
 
@@ -236,6 +237,11 @@ library UFixedLib {
         return toIntWithRounding(a, ROUNDING_HALF_UP());
     }
 
+    /// @dev Converts a UFixed to a uint256.
+    function toInt1000(UFixed a) public pure returns (uint256) {
+        return toIntWithRounding(toUFixed(1000) * a, ROUNDING_HALF_UP());
+    }
+
     /// @dev Converts a UFixed to a uint256 with given rounding mode.
     function toIntWithRounding(UFixed a, uint8 rounding) public pure returns (uint256) {
         if (rounding == ROUNDING_HALF_UP()) {

package/contracts/type/Version.sol

@@ -7,6 +7,7 @@ using {
     versionPartGt as >,
     versionPartEq as ==,
     versionPartNe as !=,
+    VersionPartLib.eqz,
     VersionPartLib.toInt
 }
     for VersionPart global;
@@ -16,7 +17,8 @@ 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 {
-    function toInt(VersionPart a) external pure returns(uint) { return VersionPart.unwrap(a); }
+    function eqz(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)); }
 }
 

package/contracts/{shared → upgradeability}/ProxyManager.sol

@@ -1,17 +1,16 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
 import {ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
 
 import {Blocknumber, blockNumber} from "../type/Blocknumber.sol";
 import {IVersionable} from "./IVersionable.sol";
-import {NftOwnable} from "./NftOwnable.sol";
-import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
-import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.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 {NftId} from "../type/NftId.sol";
 
 /// @dev manages proxy deployments for upgradable contracs of type IVersionable
 contract ProxyManager is

package/contracts/{shared → upgradeability}/UpgradableProxyWithAdmin.sol

@@ -2,9 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
-import {TransparentUpgradeableProxy, ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
-
-import {IVersionable} from "./IVersionable.sol";
+import {TransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
 
 contract UpgradableProxyWithAdmin is TransparentUpgradeableProxy {
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-f1fe735-758",
+  "version": "0.0.2-f2a5ca7-763",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {
@@ -43,8 +43,8 @@
     "typescript": "^5"
   },
   "dependencies": {
-    "@openzeppelin/contracts": "5.0.0",
-    "@openzeppelin/contracts-upgradeable": "5.0.0",
+    "@openzeppelin/contracts": "5.0.2",
+    "@openzeppelin/contracts-upgradeable": "5.0.2",
     "@openzeppelin/upgrades-core": "^1.34.1",
     "abi-coder": "^5.0.0",
     "antlr4ng": "^3.0.4",

package/artifacts/contracts/instance/BundleManager.sol/BundleManager.dbg.json

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