@etherisc/gif-next 0.0.2-f12cf4d-104 → 0.0.2-f13d67f-541

package/contracts/type/ObjectType.sol

@@ -1,6 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {StrLib} from "./String.sol";
+import {VersionPart} from "./Version.sol";
+
 type ObjectType is uint8;
 
 // type bindings
@@ -8,6 +11,7 @@ using {
     eqObjectType as ==,
     neObjectType as !=,
     ObjectTypeLib.toInt,
+    ObjectTypeLib.toName,
     ObjectTypeLib.eqz,
     ObjectTypeLib.eq,
     ObjectTypeLib.gtz
@@ -44,10 +48,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 +74,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,52 +84,76 @@ 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 for GIF core target roles.
+function CORE() pure returns (ObjectType) {
+    return ObjectType.wrap(97);
+}
+
+/// @dev Object type for target roles of contracts outside the GIF framework.
+/// Example: Custom supporting contracts for a product component.
+function CUSTOM() pure returns (ObjectType) {
+    return ObjectType.wrap(98);
 }
 
 /// @dev Object type that includes any other object type.
@@ -138,8 +174,6 @@ 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);
     }
@@ -180,6 +214,8 @@ library ObjectTypeLib {
             return "Registry";
         } else if (objectType == STAKING()) {
             return "Staking";
+        } else if (objectType == RELEASE()) {
+            return "Release";
         } else if (objectType == INSTANCE()) {
             return "Instance";
         } else if (objectType == COMPONENT()) {
@@ -202,33 +238,34 @@ 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>
         return string(
             abi.encodePacked(
                 "ObjectType",
-                toString(
+                StrLib.uintToString(
                     toInt(objectType))));
     }
 
+    // TODO move to IService
     function toVersionedName(
         string memory name, 
         string memory suffix, 
-        uint256 version
+        VersionPart release
     )
         external
         pure
         returns (string memory versionedName)
     {
-        if (version > maxNumReleases()) {
-            revert ErrorVersionTooBig(version);
-        }
-
-        string memory versionName = "_v0";
+        string memory versionName = "V0";
 
-        if (version >= 10) {
-            versionName = "_v";
+        if (release.toInt() >= 10) {
+            versionName = "V";
         }
 
         versionedName = string(
@@ -236,41 +273,6 @@ library ObjectTypeLib {
                 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) {
-
-        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);
+                release.toString()));
     }
 }

package/contracts/type/Referral.sol

@@ -13,6 +13,7 @@ using {
     eqReferralId as ==, 
     neReferralId as !=,
     ReferralLib.eqz,
+    ReferralLib.toInt,
     ReferralLib.toKey32
 } for ReferralId global;
 
@@ -74,6 +75,11 @@ library ReferralLib {
         return ReferralStatus.wrap(status);
     }
 
+    /// @dev Converts a referral id into a uint256.
+    function toInt(ReferralId referralId) public pure returns (uint256) {
+        return uint64(ReferralId.unwrap(referralId));
+    }
+
     /// @dev Returns the key32 value for the specified nft id and object type.
     function toKey32(ReferralId id) public pure returns (Key32 key) {
         return Key32Lib.toKey32(REFERRAL(), toKeyId(id));

package/contracts/type/RequestIdSet.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {RequestId} from "../type/RequestId.sol";
+
+// based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol
+library LibRequestIdSet {
+
+    struct Set {
+        RequestId[] ids;
+        mapping(RequestId requestId => uint256 index) at;
+    }
+
+    error ErrorRequestIdSetAlreadyAdded(RequestId requestId);
+    error ErrorRequestIdSetNotInSet(RequestId requestId);
+
+
+    function add(Set storage set, RequestId requestId) external {
+        if (set.at[requestId] > 0) {
+            revert ErrorRequestIdSetAlreadyAdded(requestId);
+        }
+
+        set.ids.push(requestId);
+        set.at[requestId] = set.ids.length;
+    }
+
+    function remove(Set storage set, RequestId requestId) external {
+        uint256 requestIdIndex = set.at[requestId];
+
+        if (requestIdIndex == 0) {
+            revert ErrorRequestIdSetNotInSet(requestId);
+        }
+
+        uint256 toDeleteIndex = requestIdIndex - 1;
+        uint256 lastIndex = set.ids.length - 1;
+
+        if (lastIndex != toDeleteIndex) {
+            RequestId lastId = set.ids[lastIndex];
+            set.ids[toDeleteIndex] = lastId;
+            set.at[lastId] = requestIdIndex; // Replace lastValue's index to valueIndex
+        }
+
+        set.ids.pop();
+        delete set.at[requestId];
+    }
+
+    function isEmpty(Set storage set) external view returns(bool empty) {
+        return set.ids.length == 0;
+    }
+
+    function contains(Set storage set, RequestId requestId) external view returns(bool inSet) {
+        return set.at[requestId] > 0;
+    }
+
+    function size(Set storage set) external view returns(uint256 length) {
+        return set.ids.length;
+    }
+
+    function getElementAt(Set storage set, uint256 index) external view returns(RequestId requestId) {
+        return set.ids[index];
+    }
+}

package/contracts/type/RiskId.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {NftId} from "./NftId.sol";
 import {RISK} from "./ObjectType.sol";
 
 type RiskId is bytes8;
@@ -10,9 +11,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 +36,19 @@ library RiskIdLib {
         return RiskId.wrap(bytes8(0));
     }
 
-    // @dev Converts a string into a risk id.
-    function toRiskId(string memory risk) public pure returns (RiskId) {
-        return RiskId.wrap(bytes8(keccak256(abi.encode(risk))));
+    // @dev Converts a risk id into a uint256.
+    function toInt(RiskId riskId) public pure returns (uint256) {
+        return uint64(RiskId.unwrap(riskId));
     }
 
-    /// @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 Converts a risk id string with a product NftId into a risk id.
+    function toRiskId(NftId productNftId, bytes32 risk) public pure returns (RiskId) {
+        return RiskId.wrap(bytes8(keccak256(abi.encode(productNftId, risk))));
+    }
+
+    /// @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 +56,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 +68,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

@@ -3,7 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Key32, KeyId, Key32Lib} from "./Key32.sol";
 import {ObjectType, ROLE} from "./ObjectType.sol";
-import {VersionPart} from "./Version.sol";
+import {VersionPart, VersionPartLib} from "./Version.sol";
 
 type RoleId is uint64;
 
@@ -11,10 +11,10 @@ type RoleId is uint64;
 using {
     eqRoleId as ==, 
     neRoleId as !=,
+    RoleIdLib.toInt,
+    RoleIdLib.isServiceRole,
     RoleIdLib.eqz,
-    RoleIdLib.gtz,
-    RoleIdLib.toInt
-    // RoleIdLib.toKey32
+    RoleIdLib.gtz
 } for RoleId global;
 
 // general pure free functions
@@ -54,6 +54,14 @@ 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); } 
 
+// TODO check if/where this is really needed
+/// @dev role assigned to release registry, release specfic to lock/unlock a release
+function RELEASE_REGISTRY_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(4); }
+
+/// @dev role assigned to every instance owner
+function INSTANCE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(5); }  
+
+// TODO upate role id ranges
 //--- 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 +80,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
@@ -90,54 +100,72 @@ function CUSTOM_ROLE_MIN() pure returns (RoleId) { return RoleIdLib.toRoleId(100
 
 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;
+    error ErrorRoleIdTooBig(uint256 roleId);
+
+    // constant values need to match with AccessAdminLib.SERVICE_ROLE_*
+    uint64 public constant SERVICE_ROLE_MIN =  1000;
+    uint64 public constant SERVICE_ROLE_MAX = 99099; // 99 (max object type) * 1000 + 99
+
+    uint64 public constant SERVICE_ROLE_FACTOR = 1000;
 
     /// @dev Converts the RoleId to a uint.
     function zero() public pure returns (RoleId) {
         return RoleId.wrap(0);
     }
 
+
     /// @dev Converts an uint into a role id.
-    function toRoleId(uint64 a) public pure returns (RoleId) {
-        return RoleId.wrap(a);
-    }
+    function toRoleId(uint256 a) public pure returns (RoleId) {
+        if (a > type(uint64).max) {
+            revert ErrorRoleIdTooBig(a);
+        }
 
-    /// @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);
+        return RoleId.wrap(uint64(a));
     }
 
-    /// @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));
+    function isServiceRole(RoleId roleId)
+        public
+        pure
+        returns (bool)
+    {
+        uint256 roleIdInt = RoleId.unwrap(roleId);
+        return roleIdInt >= SERVICE_ROLE_MIN && roleIdInt <= SERVICE_ROLE_MAX;
     }
 
-    /// @dev Converts an uint into a role id.
-    /// Used for GIF core contracts.
-    function roleForType(ObjectType objectType) public pure returns (RoleId) {
-        return RoleId.wrap(SERVICE_DOMAIN_ROLE_FACTOR * uint64(objectType.toInt()));
+
+    function toGenericServiceRoleId(
+        ObjectType objectType
+    )
+        public 
+        pure 
+        returns (RoleId)
+    {
+        return toServiceRoleId(
+            objectType, 
+            VersionPartLib.releaseMax());
     }
 
-    /// @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(SERVICE_DOMAIN_ROLE_FACTOR * objectType.toInt() + majorVersion.toInt()));
+
+    function toServiceRoleId(
+        ObjectType serviceDomain, 
+        VersionPart release
+    )
+        public 
+        pure 
+        returns (RoleId serviceRoleId)
+    {
+        uint256 serviceRoleIdInt = 
+            SERVICE_ROLE_MIN 
+            + SERVICE_ROLE_FACTOR * (serviceDomain.toInt() - 1)
+            + release.toInt();
+
+        return toRoleId(serviceRoleIdInt);
     }
 
-    /// @dev Converts an uint into a RoleId.
-    /// Used for GIF core contracts.
-    function roleForTypeAndAllVersions(ObjectType objectType) public pure returns (RoleId) {
-        return RoleId.wrap(
-            uint64(SERVICE_DOMAIN_ROLE_FACTOR * objectType.toInt() + ALL_VERSIONS));
+    /// @dev Converts the role id to a uint.
+    function toInt(RoleId a) public pure returns (uint64) {
+        return uint64(RoleId.unwrap(a));
     }
 
     /// @dev Returns true if the value is non-zero (> 0).
@@ -149,14 +177,4 @@ library RoleIdLib {
     function eqz(RoleId a) public pure returns (bool) {
         return RoleId.unwrap(a) == 0;
     }
-
-    /// @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));
-    }
-
-    /// @dev Returns the key id value for the specified id
-    function toKeyId(RoleId a) public pure returns (KeyId keyId) {
-        return KeyId.wrap(bytes31(uint248(RoleId.unwrap(a))));
-    }
 }

package/contracts/type/Seconds.sol

@@ -1,10 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+/// @dev Target: Cover durations of 1000 years.
 type Seconds is uint40;
 
 using {
     SecondsEq as ==,
+    SecondsLt as <,
     SecondsGt as >,
     SecondsAdd as +,
     SecondsLib.eqz,
@@ -20,6 +22,10 @@ function SecondsEq(Seconds duration1, Seconds duration2) pure returns (bool) {
     return SecondsLib.eq(duration1, duration2);
 }
 
+function SecondsLt(Seconds duration1, Seconds duration2) pure returns (bool) {
+    return SecondsLib.lt(duration1, duration2);
+}
+
 function SecondsGt(Seconds duration1, Seconds duration2) pure returns (bool) {
     return SecondsLib.gt(duration1, duration2);
 }
@@ -41,10 +47,18 @@ library SecondsLib {
         return Seconds.wrap(_max());
     }
 
+    function fromHours(uint32 numberOfHours) public pure returns (Seconds duration) {
+        return Seconds.wrap(numberOfHours * 3600);
+    }
+
     function oneDay() public pure returns (Seconds duration) {
         return Seconds.wrap(24 * 3600);
     }
 
+    function fromDays(uint32 numberOfDays) public pure returns (Seconds duration) {
+        return Seconds.wrap(numberOfDays * 24 * 3600);
+    }
+
     function oneYear() public pure returns (Seconds duration) {
         return Seconds.wrap(365 * 24 * 3600);
     }
@@ -85,6 +99,15 @@ library SecondsLib {
         return Seconds.unwrap(duration1) < Seconds.unwrap(duration2);
     }
 
+    /// @dev returns the smaller of the duration
+    function min(Seconds duration1, Seconds duration2) public pure returns (Seconds) {
+        if (Seconds.unwrap(duration1) < Seconds.unwrap(duration2)) {
+            return duration1;
+        } 
+        
+        return duration2;
+    }   
+
     /// @dev return add duration1 and duration2
     function add(Seconds duration1, Seconds duration2) public pure returns (Seconds) {
         return Seconds.wrap(Seconds.unwrap(duration1) + Seconds.unwrap(duration2));

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