@etherisc/gif-next 0.0.2-a66c9a8-623 → 0.0.2-a6a9eeb-432

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,18 +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); } 
 
-/// @dev instance specific  role to register/own a product component
-function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(11); }
+// 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 instance specific  role to register/own an oracle component
-function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(12); }
-
-/// @dev instance specific role to register/own a distribution component
-function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(13); }
-
-/// @dev instance specific  role to register/own a pool component
-function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(14); }
+/// @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
@@ -84,6 +80,8 @@ function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(14)
 // - 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
@@ -102,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).
@@ -161,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,24 +1,40 @@
 // 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,
     SecondsLib.gtz,
-    SecondsLib.toInt
+    SecondsLib.eq,
+    SecondsLib.gt,
+    SecondsLib.lt,
+    SecondsLib.toInt,
+    SecondsLib.add
 } for Seconds global;
 
 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);
 }
 
+function SecondsAdd(Seconds duration1, Seconds duration2) pure returns (Seconds) {
+    return SecondsLib.add(duration1, duration2);
+}
+
+
 library SecondsLib {
 
     error ErrorSecondsLibDurationTooBig(uint256 duration);
@@ -31,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);
     }
@@ -70,6 +94,25 @@ library SecondsLib {
         return Seconds.unwrap(duration1) > Seconds.unwrap(duration2);
     }
 
+    /// @dev return true if duration1 is smaller than duration2
+    function lt(Seconds duration1, Seconds duration2) public pure returns (bool) {
+        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));
+    }
+
     function toInt(Seconds duration) public pure returns (uint256) {
         return uint256(uint40(Seconds.unwrap(duration)));
     }

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/StateId.sol

@@ -9,6 +9,7 @@ using {
     eqStateId as ==, 
     neStateId as !=, 
     StateIdLib.eqz,
+    StateIdLib.eq,
     StateIdLib.gtz,
     StateIdLib.toInt
 } for StateId global;
@@ -27,10 +28,18 @@ function DEPLOYING() pure returns (StateId) {
     return toStateId(3);
 }
 
-function ACTIVE() pure returns (StateId) {
+function DEPLOYED() pure returns (StateId) {
     return toStateId(4);
 }
 
+function ACTIVE() pure returns (StateId) {
+    return toStateId(5);
+}
+
+function SKIPPED() pure returns (StateId) {
+    return toStateId(6);
+}
+
 function APPLIED() pure returns (StateId) {
     return toStateId(10);
 }
@@ -113,6 +122,11 @@ function neStateId(StateId a, StateId b) pure returns (bool isDifferent) {
 
 // library functions that operate on user defined type
 library StateIdLib {
+
+    function zero() public pure returns (StateId) {
+        return StateId.wrap(0);
+    }
+
     /// @dev Converts the NftId to a uint256.
     function toInt(StateId stateId) public pure returns (uint96) {
         return uint96(StateId.unwrap(stateId));

package/contracts/type/String.sol

@@ -12,10 +12,12 @@ using {
     StrLib.length
 } for Str global;
 
+// pure free function needed for the operator overloading
 function StrEq(Str s1, Str s2) pure returns (bool) {
     return StrLib.eq(s1, s2);
 }
 
+// pure free function needed for the operator overloading
 function StrNe(Str s1, Str s2) pure returns (bool) {
     return StrLib.ne(s1, s2);
 }
@@ -39,6 +41,16 @@ library StrLib {
         return Str.unwrap(s1) != Str.unwrap(s2);
     }
 
+    /// @dev return true iff s1 equals from s2
+    function eq(string memory s1, string memory s2) public pure returns (bool) {
+        return keccak256(bytes(s1)) == keccak256(bytes(s2));
+    }
+
+    /// @dev return true iff s1 differs s2
+    function ne(string memory s1, string memory s2) public pure returns (bool) {
+        return !eq(s1, s2);
+    }
+
     /// @dev converts the provided short string into a string.
     /// uses ShortStrings.toString
     function toString(Str str) public pure returns (string memory) {
@@ -50,4 +62,34 @@ library StrLib {
     function length(Str str) public pure returns (uint256 byteLength) {
         return ShortStrings.byteLength(ShortString.wrap(Str.unwrap(str)));
     }
+
+    /// @dev Returns the provied int as a string
+    function uintToString(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);
+        uint256 index = digits - 1;
+
+        temp = value;
+        while (temp != 0) {
+            buffer[index] = bytes1(uint8(48 + temp % 10));
+            temp /= 10;
+
+            if (index > 0) {
+                index--;
+            }
+        }
+
+        return string(buffer);
+    }
 }

package/contracts/type/Timestamp.sol

@@ -3,6 +3,8 @@ pragma solidity ^0.8.20;
 
 import {Seconds} from "./Seconds.sol";
 
+/// @dev Target: Cover 10 years with 1 ms block time resolution.
+/// Typical block time resolution is 1s.
 type Timestamp is uint40;
 
 using {
@@ -12,9 +14,16 @@ using {
     lteTimestamp as <=,
     eqTimestamp as ==,
     neTimestamp as !=,
+    TimestampLib.eq,
+    TimestampLib.ne,
+    TimestampLib.gt,
+    TimestampLib.gte,
+    TimestampLib.lt,
+    TimestampLib.lte,
     TimestampLib.gtz,
     TimestampLib.eqz,
     TimestampLib.addSeconds,
+    TimestampLib.subtractSeconds,
     TimestampLib.toInt
 } for Timestamp global;
 
@@ -48,11 +57,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 Timestamp.wrap(uint40(timestamp));
-}
-
 // TODO move to TimestampLib and rename to zero()
 /// @dev Return the Timestamp zero (0)
 function zeroTimestamp() pure returns (Timestamp) {
@@ -68,10 +72,14 @@ library TimestampLib {
     function max() public pure returns (Timestamp) {
         return Timestamp.wrap(type(uint40).max);
     }
-    
-    function blockTimestamp() public view returns (Timestamp) {
+
+    function current() public view returns (Timestamp) {
         return Timestamp.wrap(uint40(block.timestamp));
     }
+
+    function toTimestamp(uint256 timestamp) public pure returns (Timestamp) {
+        return Timestamp.wrap(uint40(timestamp));
+    }
     
     /// @dev return true if Timestamp a is after Timestamp b
     function gt(Timestamp a, Timestamp b) public pure returns (bool isAfter) {
@@ -122,7 +130,7 @@ library TimestampLib {
         return Timestamp.unwrap(timestamp) > 0;
     }
 
-    /// @dev return true if Timestamp a is not equal to Timestamp b
+    /// @dev return a new timestamp that is duration seconds later than the provided timestamp.
     function addSeconds(
         Timestamp timestamp,
         Seconds duration
@@ -130,6 +138,14 @@ library TimestampLib {
         return toTimestamp(Timestamp.unwrap(timestamp) + duration.toInt());
     }
 
+    /// @dev return a new timestamp that is duration seconds earlier than the provided timestamp.
+    function subtractSeconds(
+        Timestamp timestamp,
+        Seconds duration
+    ) public pure returns (Timestamp) {
+        return toTimestamp(Timestamp.unwrap(timestamp) - duration.toInt());
+    }
+
     function toInt(Timestamp timestamp) public pure returns (uint256) {
         return uint256(uint40(Timestamp.unwrap(timestamp)));
     }