@etherisc/gif-next 0.0.2-f13c010-035 → 0.0.2-f13fd28-503

package/contracts/type/ObjectType.sol

@@ -44,10 +44,16 @@ function INSTANCE() pure returns (ObjectType) {
     return ObjectType.wrap(10);
 }
 
+/// @dev Generic component object type.
+/// Component role id range is 11-19.
+/// Stick to this range for new component object types.
 function COMPONENT() pure returns (ObjectType) {
     return ObjectType.wrap(11);
 }
 
+/// @dev Product object type.
+/// IMPORTANT the actual value has an influence on the corresponding role id (RoleIdLib.sol). 
+/// Do not change this value without updating the corresponding role id calculation.
 function PRODUCT() pure returns (ObjectType) {
     return ObjectType.wrap(12);
 }
@@ -64,6 +70,8 @@ function POOL() pure returns (ObjectType) {
     return ObjectType.wrap(15);
 }
 
+/// @dev Application object type.
+/// Range for NFT objects created thorugh components is 20-29.
 function APPLICATION() pure returns (ObjectType) {
     return ObjectType.wrap(20);
 }
@@ -72,54 +80,69 @@ function POLICY() pure returns (ObjectType) {
     return ObjectType.wrap(21);
 }
 
-function PREMIUM() pure returns (ObjectType) {
+function BUNDLE() pure returns (ObjectType) {
     return ObjectType.wrap(22);
 }
 
-function CLAIM() pure returns (ObjectType) {
+function DISTRIBUTOR() pure returns (ObjectType) {
     return ObjectType.wrap(23);
 }
 
-function PAYOUT() pure returns (ObjectType) {
-    return ObjectType.wrap(24); 
+/// @dev Stake object type.
+/// NFT object type is 30
+function STAKE() pure returns (ObjectType) {
+    return ObjectType.wrap(30);
 }
 
-function RISK() pure returns (ObjectType) {
-    return ObjectType.wrap(25);
+/// @dev Staking target object type.
+function TARGET() pure returns (ObjectType) {
+    return ObjectType.wrap(31);
+}
+
+/// @dev Accounting object type.
+/// Range for non-NFT types created through components is 40+
+function ACCOUNTING() pure returns (ObjectType) {
+    return ObjectType.wrap(40);
+}
+
+function FEE() pure returns (ObjectType) {
+    return ObjectType.wrap(41);
 }
 
 function PRICE() pure returns (ObjectType) {
-    return ObjectType.wrap(26);
+    return ObjectType.wrap(42);
 }
 
-function REQUEST() pure returns (ObjectType) {
-    return ObjectType.wrap(27);
+function PREMIUM() pure returns (ObjectType) {
+    return ObjectType.wrap(43);
 }
 
-function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
-    return ObjectType.wrap(28);
+function RISK() pure returns (ObjectType) {
+    return ObjectType.wrap(44);
 }
 
-function DISTRIBUTOR() pure returns (ObjectType) {
-    return ObjectType.wrap(29);
+function CLAIM() pure returns (ObjectType) {
+    return ObjectType.wrap(45);
 }
 
-function REFERRAL() pure returns (ObjectType) {
-    return ObjectType.wrap(30);
+function PAYOUT() pure returns (ObjectType) {
+    return ObjectType.wrap(46); 
 }
 
-function BUNDLE() pure returns (ObjectType) {
-    return ObjectType.wrap(31);
+function REQUEST() pure returns (ObjectType) {
+    return ObjectType.wrap(47);
 }
 
-function TARGET() pure returns (ObjectType) {
-    return ObjectType.wrap(32);
+function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
+    return ObjectType.wrap(48);
 }
 
-function STAKE() pure returns (ObjectType) {
-    return ObjectType.wrap(33);
+function REFERRAL() pure returns (ObjectType) {
+    return ObjectType.wrap(49);
 }
 
+
+
 /// @dev Object type that includes any other object type.
 /// Note that eq()/'==' does not take this property into account.
 function ALL() pure returns (ObjectType) {
@@ -202,6 +225,10 @@ library ObjectTypeLib {
             return "Price";
         } else if (objectType == BUNDLE()) {
             return "Bundle";
+        } else if (objectType == RISK()) {
+            return "Risk";
+        } else if (objectType == ACCOUNTING()) {
+            return "Accounting";
         }
 
         // fallback: ObjectType<obect-type-int>

package/contracts/type/RiskId.sol

@@ -10,9 +10,12 @@ type RiskId is bytes8;
 using {
     eqRiskId as ==, 
     neRiskId as !=,
-    RiskIdLib.toKey32,
     RiskIdLib.eq,
-    RiskIdLib.eqz
+    RiskIdLib.eqz,
+    RiskIdLib.gtz,
+    RiskIdLib.toInt,
+    RiskIdLib.toKeyId,
+    RiskIdLib.toKey32
 } for RiskId global;
 
 // general pure free functions
@@ -32,14 +35,19 @@ library RiskIdLib {
         return RiskId.wrap(bytes8(0));
     }
 
-    // @dev Converts a role string into a role id.
+    // @dev Converts a risk id into a uint256.
+    function toInt(RiskId riskId) public pure returns (uint256) {
+        return uint64(RiskId.unwrap(riskId));
+    }
+
+    // @dev Converts a risk id string into a risk id.
     function toRiskId(string memory risk) public pure returns (RiskId) {
         return RiskId.wrap(bytes8(keccak256(abi.encode(risk))));
     }
 
-    /// @dev Returns the key32 value for the specified nft id and object type.
-    function toKey32(RiskId id) public pure returns (Key32 key) {
-        return Key32Lib.toKey32(RISK(), toKeyId(id));
+    /// @dev Returns the key32 value for the specified risk id.
+    function toKey32(RiskId riskId) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(RISK(), toKeyId(riskId));
     }
 
     /// @dev Returns the key id value for the specified nft id
@@ -47,6 +55,11 @@ library RiskIdLib {
         return KeyId.wrap(bytes31(RiskId.unwrap(id)));
     }
 
+    function toRiskId(KeyId keyId) public pure returns (RiskId riskId) {
+        riskId = RiskId.wrap(bytes8(KeyId.unwrap(keyId)));
+        assert(toInt(riskId) < 2**64);
+    }
+
     function eq(RiskId a, RiskId b) public pure returns (bool isSame) {
         return eqRiskId(a, b);
     }
@@ -54,4 +67,8 @@ library RiskIdLib {
     function eqz(RiskId a) public pure returns (bool isZero) {
         return eqRiskId(a, zero());
     }
+
+    function gtz(RiskId a) public pure returns (bool isZero) {
+        return uint64(RiskId.unwrap(a)) > 0;
+    }
 }

package/contracts/type/RoleId.sol

@@ -11,9 +11,11 @@ type RoleId is uint64;
 using {
     eqRoleId as ==, 
     neRoleId as !=,
+    RoleIdLib.toInt,
     RoleIdLib.eqz,
     RoleIdLib.gtz,
-    RoleIdLib.toInt
+    RoleIdLib.isComponentRole,
+    RoleIdLib.isCustomRole
     // RoleIdLib.toKey32
 } for RoleId global;
 
@@ -54,6 +56,9 @@ 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(3); } 
 
+/// @dev role assigned to release registry, release specfic to lock/unlock a release
+function RELEASE_REGISTRY_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(4); }
+
 //--- 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
@@ -72,6 +77,8 @@ function GIF_REMOTE_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRo
 // - application service role (version 3): 2003
 
 //--- GIF component contract roles (range 12'001 - 19'099) ------------------//
+// the min value of 12'001 is based on the following calculation:
+// object type * 1000 + 1 where the lowest object type is 12 (product) 
 // assigned at component registration time
 // object type * 1000 + instane specific component counter
 // on any instance a maximum number of 999 components may be deployed
@@ -92,8 +99,10 @@ library RoleIdLib {
 
     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;
+    uint64 public constant COMPONENT_ROLE_FACTOR = 1000;
+    uint64 public constant COMPONENT_ROLE_MIN_INT = 12000;
+    uint64 public constant COMPONENT_ROLE_MAX_INT = 19000;
+    uint64 public constant CUSTOM_ROLE_MIN_INT = 1000000;
 
     /// @dev Converts the RoleId to a uint.
     function zero() public pure returns (RoleId) {
@@ -112,7 +121,7 @@ library RoleIdLib {
 
     /// @dev Converts an uint into a custom role id.
     function toCustomRoleId(uint64 index) public pure returns (RoleId) {
-        return toRoleId(CUSTOM_ROLE_MIN + index);
+        return toRoleId(CUSTOM_ROLE_MIN_INT + index);
     }
 
     /// @dev Converts the role id to a uint.
@@ -150,6 +159,17 @@ library RoleIdLib {
         return RoleId.unwrap(a) == 0;
     }
 
+    /// @dev Returns true iff the role id is a component role.
+    function isComponentRole(RoleId roleId) public pure returns (bool) {
+        uint64 roleIdInt = RoleId.unwrap(roleId);
+        return roleIdInt >= COMPONENT_ROLE_MIN_INT && roleIdInt <= COMPONENT_ROLE_MAX_INT;
+    }
+
+    /// @dev Returns true iff the role id is a custom role.
+    function isCustomRole(RoleId roleId) public pure returns (bool) {
+        return RoleId.unwrap(roleId) >= CUSTOM_ROLE_MIN_INT;
+    }
+
     /// @dev Returns the key32 value for the specified id and object type.
     function toKey32(RoleId a) public pure returns (Key32 key) {
         return Key32Lib.toKey32(ROLE(), toKeyId(a));

package/contracts/type/Selector.sol

@@ -8,6 +8,7 @@ using {
     eqSelector as ==, 
     neSelector as !=, 
     SelectorLib.toBytes4,
+    SelectorLib.toString,
     SelectorLib.eqz
 } for Selector global;
 
@@ -46,6 +47,10 @@ library SelectorLib {
     function toBytes4(Selector s) public pure returns (bytes4) {
         return Selector.unwrap(s);
     }
+
+    function toString(Selector s) public pure returns (string memory) {
+        return string(abi.encode(Selector.unwrap(s)));
+    }
 }
 
 // selector specific set library

package/contracts/type/Timestamp.sol

@@ -54,11 +54,6 @@ function neTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
     return Timestamp.unwrap(a) != Timestamp.unwrap(b);
 }
 
-/// @dev Converts the uint256 to a Timestamp.
-function toTimestamp(uint256 timestamp) pure returns (Timestamp) {
-    return TimestampLib.toTimestamp(timestamp);
-}
-
 // TODO move to TimestampLib and rename to zero()
 /// @dev Return the Timestamp zero (0)
 function zeroTimestamp() pure returns (Timestamp) {

package/contracts/type/UFixed.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
+
 /// @dev UFixed is a fixed point number with 18 decimals precision.
 type UFixed is uint256;
 
@@ -39,7 +41,7 @@ function subUFixed(UFixed a, UFixed b) pure returns (UFixed) {
 
 function mulUFixed(UFixed a, UFixed b) pure returns (UFixed) {
     return
-        UFixed.wrap(MathLib.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
+        UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
 }
 
 function divUFixed(UFixed a, UFixed b) pure returns (UFixed) {
@@ -48,7 +50,7 @@ function divUFixed(UFixed a, UFixed b) pure returns (UFixed) {
     }
     
     return
-        UFixed.wrap(MathLib.mulDiv(UFixed.unwrap(a), 10 ** 18, UFixed.unwrap(b)));
+        UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), 10 ** 18, UFixed.unwrap(b)));
 }
 
 function gtUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
@@ -91,118 +93,6 @@ function deltaUFixed(UFixed a, UFixed b) pure returns (UFixed) {
     return b - a;
 }
 
-/// @dev copied from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.3/contracts/utils/math/Math.sol
-library MathLib {
-
-    error MathLigMulDivOverflow();
-
-    enum Rounding {
-        Down, // Toward negative infinity
-        Up, // Toward infinity
-        Zero // Toward zero
-    }
-
-    /**
-     * @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
-     * @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)
-     * with further edits by Uniswap Labs also under MIT license.
-     */
-    function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
-        unchecked {
-            // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
-            // use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
-            // variables such that product = prod1 * 2^256 + prod0.
-            uint256 prod0; // Least significant 256 bits of the product
-            uint256 prod1; // Most significant 256 bits of the product
-            assembly {
-                let mm := mulmod(x, y, not(0))
-                prod0 := mul(x, y)
-                prod1 := sub(sub(mm, prod0), lt(mm, prod0))
-            }
-
-            // Handle non-overflow cases, 256 by 256 division.
-            if (prod1 == 0) {
-                // Solidity will revert if denominator == 0, unlike the div opcode on its own.
-                // The surrounding unchecked block does not change this fact.
-                // See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
-                return prod0 / denominator;
-            }
-
-            // Make sure the result is less than 2^256. Also prevents denominator == 0.
-            if (denominator <= prod1) {
-                revert MathLigMulDivOverflow();
-            }
-            
-            ///////////////////////////////////////////////
-            // 512 by 256 division.
-            ///////////////////////////////////////////////
-
-            // Make division exact by subtracting the remainder from [prod1 prod0].
-            uint256 remainder;
-            assembly {
-                // Compute remainder using mulmod.
-                remainder := mulmod(x, y, denominator)
-
-                // Subtract 256 bit number from 512 bit number.
-                prod1 := sub(prod1, gt(remainder, prod0))
-                prod0 := sub(prod0, remainder)
-            }
-
-            // Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.
-            // See https://cs.stackexchange.com/q/138556/92363.
-
-            // Does not overflow because the denominator cannot be zero at this stage in the function.
-            uint256 twos = denominator & (~denominator + 1);
-            assembly {
-                // Divide denominator by twos.
-                denominator := div(denominator, twos)
-
-                // Divide [prod1 prod0] by twos.
-                prod0 := div(prod0, twos)
-
-                // Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
-                twos := add(div(sub(0, twos), twos), 1)
-            }
-
-            // Shift in bits from prod1 into prod0.
-            prod0 |= prod1 * twos;
-
-            // Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
-            // that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
-            // four bits. That is, denominator * inv = 1 mod 2^4.
-            uint256 inverse = (3 * denominator) ^ 2;
-
-            // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
-            // in modular arithmetic, doubling the correct bits in each step.
-            inverse *= 2 - denominator * inverse; // inverse mod 2^8
-            inverse *= 2 - denominator * inverse; // inverse mod 2^16
-            inverse *= 2 - denominator * inverse; // inverse mod 2^32
-            inverse *= 2 - denominator * inverse; // inverse mod 2^64
-            inverse *= 2 - denominator * inverse; // inverse mod 2^128
-            inverse *= 2 - denominator * inverse; // inverse mod 2^256
-
-            // Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
-            // This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
-            // less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
-            // is no longer required.
-            result = prod0 * inverse;
-            return result;
-        }
-    }
-
-    /**
-     * @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
-     */
-    function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
-        uint256 result = mulDiv(x, y, denominator);
-        if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {
-            result += 1;
-        }
-        return result;
-    }
-
-}
-
 library UFixedLib {
     error UFixedLibNegativeResult();
     error UFixedLibDivisionByZero();
@@ -265,23 +155,23 @@ library UFixedLib {
     function toIntWithRounding(UFixed a, uint8 rounding) public pure returns (uint256) {
         if (rounding == ROUNDING_HALF_UP()) {
             return
-                MathLib.mulDiv(
+                Math.mulDiv(
                     UFixed.unwrap(a) + MULTIPLIER_HALF,
                     1,
                     MULTIPLIER,
-                    MathLib.Rounding.Down
+                    Math.Rounding.Floor
                 );
         } else if (rounding == ROUNDING_DOWN()) {
             return
-                MathLib.mulDiv(
+                Math.mulDiv(
                     UFixed.unwrap(a),
                     1,
                     MULTIPLIER,
-                    MathLib.Rounding.Down
+                    Math.Rounding.Floor
                 );
         } else {
             return
-                MathLib.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, MathLib.Rounding.Up);
+                Math.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, Math.Rounding.Ceil);
         }
     }
 

package/contracts/type/Version.sol

@@ -8,7 +8,8 @@ using {
     versionPartEq as ==,
     versionPartNe as !=,
     VersionPartLib.eqz,
-    VersionPartLib.toInt
+    VersionPartLib.toInt,
+    VersionPartLib.isValidRelease
 }
     for VersionPart global;
 
@@ -17,9 +18,17 @@ 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 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 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)); }
+    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 +47,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 +85,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/ProxyManager.sol

@@ -193,7 +193,7 @@ contract ProxyManager is
         }
 
         address initialOwner = msg.sender;
-        _initializeNftOwnable(registry, initialOwner);
+        __NftOwnable_init(registry, initialOwner);
 
         currentProxyOwner = getOwner(); // used by implementation
         initialProxyAdminOwner = address(this); // used by proxy

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-f13c010-035",
+  "version": "0.0.2-f13fd28-503",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {
@@ -32,8 +32,8 @@
     "@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",

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

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