@etherisc/gif-next 0.0.2-ffba655 → 3.0.0-06d5e8b-738

package/contracts/type/RoleId.sol

@@ -0,0 +1,180 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {ObjectType, ROLE} from "./ObjectType.sol";
+import {VersionPart, VersionPartLib} from "./Version.sol";
+
+type RoleId is uint64;
+
+// type bindings
+using {
+    eqRoleId as ==, 
+    neRoleId as !=,
+    RoleIdLib.toInt,
+    RoleIdLib.isServiceRole,
+    RoleIdLib.eqz,
+    RoleIdLib.gtz
+} for RoleId global;
+
+// 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
+function ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(type(uint64).min); }
+
+/// @dev Role ID needs to match with oz AccessManager.PUBLIC_ROLE
+function PUBLIC_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(type(uint64).max); }
+
+//--- 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(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(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
+// object type * 100 + 0, examples:
+// - registry contract role: 200 
+// - staking contract role: 300 
+// - instance contract role: 1000
+
+//--- 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): 299
+// - registry service role (version 3): 203
+// - registry service role (any version): 399
+// - staking service role: (version 3): 303
+// - 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
+// 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
+
+
+//--- Custom roles (range >= 1'000'000) -------------------------------------//
+
+function CUSTOM_ROLE_MIN() pure returns (RoleId) { return RoleIdLib.toRoleId(1000000); }
+
+library RoleIdLib {
+
+    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(uint256 a) public pure returns (RoleId) {
+        if (a > type(uint64).max) {
+            revert ErrorRoleIdTooBig(a);
+        }
+
+        return RoleId.wrap(uint64(a));
+    }
+
+
+    function isServiceRole(RoleId roleId)
+        public
+        pure
+        returns (bool)
+    {
+        uint256 roleIdInt = RoleId.unwrap(roleId);
+        return roleIdInt >= SERVICE_ROLE_MIN && roleIdInt <= SERVICE_ROLE_MAX;
+    }
+
+
+    function toGenericServiceRoleId(
+        ObjectType objectType
+    )
+        public 
+        pure 
+        returns (RoleId)
+    {
+        return toServiceRoleId(
+            objectType, 
+            VersionPartLib.releaseMax());
+    }
+
+
+    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 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).
+    function gtz(RoleId a) public pure returns (bool) {
+        return RoleId.unwrap(a) > 0;
+    }
+
+    /// @dev Returns true if the value is zero (== 0).
+    function eqz(RoleId a) public pure returns (bool) {
+        return RoleId.unwrap(a) == 0;
+    }
+}

package/contracts/type/Seconds.sol

@@ -0,0 +1,124 @@
+// 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.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);
+
+    function zero() public pure returns (Seconds) {
+        return Seconds.wrap(0);
+    }
+
+    function max() public pure returns (Seconds) {
+        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);
+    }
+
+    /// @dev converts the uint duration into Seconds
+    /// function reverts if duration is exceeding max Seconds value
+    function toSeconds(uint256 duration) public pure returns (Seconds) {
+        // if(duration > type(uint40).max) {
+        if(duration > _max()) {
+            revert ErrorSecondsLibDurationTooBig(duration);
+        }
+
+        return Seconds.wrap(uint40(duration));
+    }
+
+    /// @dev return true if duration equals 0
+    function eqz(Seconds duration) public pure returns (bool) {
+        return Seconds.unwrap(duration) == 0;
+    }
+
+    /// @dev return true if duration is larger than 0
+    function gtz(Seconds duration) public pure returns (bool) {
+        return Seconds.unwrap(duration) > 0;
+    }
+
+    /// @dev return true iff duration1 and duration2 are the same
+    function eq(Seconds duration1, Seconds duration2) public pure returns (bool) {
+        return Seconds.unwrap(duration1) == Seconds.unwrap(duration2);
+    }
+
+    /// @dev return true if duration1 is larger than duration2
+    function gt(Seconds duration1, Seconds duration2) public pure returns (bool) {
+        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)));
+    }
+
+    function _max() internal pure returns (uint40) {
+        // IMPORTANT: type nees to match with actual definition for Seconds
+        return type(uint40).max;
+    }
+}

package/contracts/type/Selector.sol

@@ -0,0 +1,107 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+type Selector is bytes4;
+
+// type bindings
+using {
+    eqSelector as ==, 
+    neSelector as !=, 
+    SelectorLib.toBytes4,
+    SelectorLib.toString,
+    SelectorLib.eqz
+} for Selector global;
+
+// pure free functions for operators
+function eqSelector(Selector s1, Selector s2) pure returns (bool isSame) {
+    return SelectorLib.eq(s1, s2);
+}
+
+function neSelector(Selector s1, Selector s2) pure returns (bool isDifferent) {
+    return SelectorLib.ne(s1, s2);
+}
+
+// library functions that operate on user defined type
+library SelectorLib {
+
+    function zero() public pure returns (Selector) {
+        return Selector.wrap("");
+    }
+
+    function eqz(Selector s) public pure returns (bool) {
+        return Selector.unwrap(s) == "";
+    }
+
+    function eq(Selector s1, Selector s2) public pure returns (bool isSame) {
+        return Selector.unwrap(s1) == Selector.unwrap(s2);
+    }
+
+    function ne(Selector s1, Selector s2) public pure returns (bool isDifferent) {
+        return Selector.unwrap(s1) != Selector.unwrap(s2);
+    }
+
+    function toSelector(bytes4 selector) public pure returns (Selector) {
+        return Selector.wrap(selector);
+    }
+
+    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
+// based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol
+library SelectorSetLib {
+
+    struct Set {
+        Selector[] selectors;
+        mapping(Selector selector => uint256 index) at;
+    }
+
+    function add(Set storage set, Selector selector) external {
+        // selector already in set
+        if (set.at[selector] > 0) { return; }
+
+        set.selectors.push(selector);
+        set.at[selector] = set.selectors.length;
+    }
+
+    function remove(Set storage set, Selector selector) external {
+        uint256 selectorIndex = set.at[selector];
+
+        // selector not in set
+        if (selectorIndex == 0) {return; }
+
+        uint256 toDeleteIndex = selectorIndex - 1;
+        uint256 lastIndex = set.selectors.length - 1;
+
+        if (lastIndex != toDeleteIndex) {
+            Selector lastSelector = set.selectors[lastIndex];
+            set.selectors[toDeleteIndex] = lastSelector;
+            set.at[lastSelector] = selectorIndex; // Replace lastValue's index to valueIndex
+        }
+
+        set.selectors.pop();
+        delete set.at[selector];
+    }
+
+    function isEmpty(Set storage set) external view returns(bool empty) {
+        return set.selectors.length == 0;
+    }
+
+    function contains(Set storage set, Selector selector) external view returns(bool inSet) {
+        return set.at[selector] > 0;
+    }
+
+    function size(Set storage set) external view returns(uint256 length) {
+        return set.selectors.length;
+    }
+
+    function at(Set storage set, uint256 index) external view returns(Selector selector) {
+        return set.selectors[index];
+    }
+}

package/contracts/type/StateId.sol

@@ -0,0 +1,149 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+// uint96 allows for chain ids up to 13 digits
+type StateId is uint8;
+
+// type bindings
+using {
+    eqStateId as ==, 
+    neStateId as !=, 
+    StateIdLib.eqz,
+    StateIdLib.eq,
+    StateIdLib.gtz,
+    StateIdLib.toInt
+} for StateId global;
+
+// general pure free functions
+
+function INITIAL() pure returns (StateId) {
+    return toStateId(1);
+}
+
+function SCHEDULED() pure returns (StateId) {
+    return toStateId(2);
+}
+
+function DEPLOYING() pure returns (StateId) {
+    return toStateId(3);
+}
+
+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);
+}
+
+function REVOKED() pure returns (StateId) {
+    return toStateId(20);
+}
+
+function DECLINED() pure returns (StateId) {
+    return toStateId(30);
+}
+
+function COLLATERALIZED() pure returns (StateId) {
+    return toStateId(40);
+}
+
+function SUBMITTED() pure returns (StateId) {
+    return toStateId(50);
+}
+
+function CONFIRMED() pure returns (StateId) {
+    return toStateId(51);
+}
+
+function EXPECTED() pure returns (StateId) {
+    return toStateId(60);
+}
+
+function FULFILLED() pure returns (StateId) {
+    return toStateId(70);
+}
+
+function FAILED() pure returns (StateId) {
+    return toStateId(7);
+}
+
+function CANCELLED() pure returns (StateId) {
+    return toStateId(72);
+}
+
+function PAUSED() pure returns (StateId) {
+    return toStateId(110);
+}
+
+function CLOSED() pure returns (StateId) {
+    return toStateId(200);
+}
+
+function ARCHIVED() pure returns (StateId) {
+    return toStateId(210);
+}
+
+function PAID() pure returns (StateId) {
+    return toStateId(220);
+}
+
+function KEEP_STATE() pure returns (StateId) {
+    return toStateId(type(uint8).max);
+}
+
+/// @dev Converts the uint8 to a StateId.
+function toStateId(uint256 id) pure returns (StateId) {
+    return StateId.wrap(uint8(id));
+}
+
+// TODO move to StateIdLib and rename to zero()
+/// @dev Return the StateId zero (0)
+function zeroStateId() pure returns (StateId) {
+    return StateId.wrap(0);
+}
+
+// pure free functions for operators
+function eqStateId(StateId a, StateId b) pure returns (bool isSame) {
+    return StateId.unwrap(a) == StateId.unwrap(b);
+}
+
+function neStateId(StateId a, StateId b) pure returns (bool isDifferent) {
+    return StateId.unwrap(a) != StateId.unwrap(b);
+}
+
+// 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));
+    }
+
+    /// @dev Returns true if the value is non-zero (> 0).
+    function gtz(StateId a) public pure returns (bool) {
+        return StateId.unwrap(a) > 0;
+    }
+
+    /// @dev Returns true if the value is zero (== 0).
+    function eqz(StateId a) public pure returns (bool) {
+        return StateId.unwrap(a) == 0;
+    }
+
+    /// @dev Returns true if the values are equal (==).
+    function eq(StateId a, StateId b) public pure returns (bool isSame) {
+        return eqStateId(a, b);
+    }
+}

package/contracts/type/String.sol

@@ -0,0 +1,95 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
+
+type Str is bytes32;
+
+using {
+    StrEq as ==,
+    StrNe as !=,
+    StrLib.toString,
+    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);
+}
+
+library StrLib {
+
+
+    /// @dev converts the provided string into a short string.
+    /// uses ShortStrings.toShortString
+    function toStr(string memory str) public pure returns (Str) {
+        return Str.wrap(ShortString.unwrap(ShortStrings.toShortString(str)));
+    }
+
+    /// @dev return true iff s1 equals s2
+    function eq(Str s1, Str s2) public pure returns (bool) {
+        return Str.unwrap(s1) == Str.unwrap(s2);
+    }
+
+    /// @dev return true iff s1 differs from s2
+    function ne(Str s1, Str s2) public pure returns (bool) {
+        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) {
+        return ShortStrings.toString(ShortString.wrap(Str.unwrap(str)));
+    }
+
+    /// @dev converts the provided short string into a string.
+    /// uses ShortStrings.byteLength
+    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);
+    }
+}