@etherisc/gif-next 0.0.2-f36fd21-685 → 0.0.2-f3b4c66-505

package/contracts/type/ClaimId.sol

@@ -12,6 +12,7 @@ import {NftId} from "./NftId.sol";
 using {
     eqClaimId as ==, 
     neClaimId as !=, 
+    ClaimIdLib.eq,
     ClaimIdLib.eqz,
     ClaimIdLib.gtz,
     ClaimIdLib.toInt,
@@ -21,7 +22,7 @@ using {
 
 // pure free functions for operators
 function eqClaimId(ClaimId a, ClaimId b) pure returns (bool isSame) {
-    return ClaimId.unwrap(a) == ClaimId.unwrap(b);
+    return ClaimIdLib.eq(a, b);
 }
 
 function neClaimId(ClaimId a, ClaimId b) pure returns (bool isDifferent) {
@@ -68,6 +69,10 @@ library ClaimIdLib {
         return ClaimId.unwrap(a) > 0;
     }
 
+    function eq(ClaimId a, ClaimId b) public pure returns (bool) {
+        return ClaimId.unwrap(a) == ClaimId.unwrap(b);
+    }
+
     /// @dev Returns true if the value is zero (== 0).
     function eqz(ClaimId a) public pure returns (bool) {
         return ClaimId.unwrap(a) == 0;

package/contracts/type/Key32.sol

@@ -28,8 +28,8 @@ library Key32Lib {
 
     uint8 public constant TYPE_SHIFT = 31 * 8;
     uint8 public constant ID_SHIFT = uint8(32 * 8 - TYPE_SHIFT);
-    bytes32 public constant TYPE_MASK = bytes32(bytes1(type(uint8).max)); // first byte in bytes32
-    bytes32 public constant ID_MASK = bytes32(~TYPE_MASK); // remaining bytes in bytes32
+    bytes32 public constant TYPE_MASK = bytes32(bytes1(type(uint8).max)); // [32] byte in bytes32
+    bytes32 public constant ID_MASK = bytes32(~TYPE_MASK); // [0..31] bytes in bytes32
 
     function toKey32(ObjectType objectType, KeyId id) public pure returns (Key32) {
         uint256 uintObjectType = ObjectType.unwrap(objectType);

package/contracts/type/Key32Set.sol

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

package/contracts/type/NftId.sol

@@ -14,6 +14,7 @@ using {
     NftIdLib.toInt,
     NftIdLib.gtz,
     NftIdLib.eqz,
+    NftIdLib.eq,
     NftIdLib.toKeyId,
     NftIdLib.toKey32
 } for NftId global;
@@ -75,4 +76,10 @@ library NftIdLib {
     function toKeyId(NftId id) public pure returns (KeyId keyId) {
         return KeyId.wrap(bytes31(uint248(NftId.unwrap(id))));
     }
+
+    function toNftId(KeyId keyId) public pure returns (NftId nftId) {
+       uint248 keyIdInt = uint248(bytes31(KeyId.unwrap(keyId)));
+       assert(keyIdInt < type(uint96).max);
+       return NftId.wrap(uint96(keyIdInt));
+    }
 }

package/contracts/type/ObjectType.sol

@@ -9,6 +9,7 @@ using {
     neObjectType as !=,
     ObjectTypeLib.toInt,
     ObjectTypeLib.eqz,
+    ObjectTypeLib.eq,
     ObjectTypeLib.gtz
 } for ObjectType global;
 
@@ -43,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);
 }
@@ -63,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);
 }
@@ -71,50 +80,69 @@ function POLICY() pure returns (ObjectType) {
     return ObjectType.wrap(21);
 }
 
-function CLAIM() pure returns (ObjectType) {
+function BUNDLE() pure returns (ObjectType) {
     return ObjectType.wrap(22);
 }
 
-function PAYOUT() pure returns (ObjectType) {
-    return ObjectType.wrap(23); 
+function DISTRIBUTOR() pure returns (ObjectType) {
+    return ObjectType.wrap(23);
 }
 
-function RISK() 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);
+}
+
+/// @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(25);
+    return ObjectType.wrap(42);
 }
 
-function REQUEST() pure returns (ObjectType) {
-    return ObjectType.wrap(26);
+function PREMIUM() pure returns (ObjectType) {
+    return ObjectType.wrap(43);
 }
 
-function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
-    return ObjectType.wrap(27);
+function RISK() pure returns (ObjectType) {
+    return ObjectType.wrap(44);
 }
 
-function DISTRIBUTOR() pure returns (ObjectType) {
-    return ObjectType.wrap(28);
+function CLAIM() pure returns (ObjectType) {
+    return ObjectType.wrap(45);
 }
 
-function REFERRAL() pure returns (ObjectType) {
-    return ObjectType.wrap(29);
+function PAYOUT() pure returns (ObjectType) {
+    return ObjectType.wrap(46); 
 }
 
-function BUNDLE() pure returns (ObjectType) {
-    return ObjectType.wrap(30);
+function REQUEST() pure returns (ObjectType) {
+    return ObjectType.wrap(47);
 }
 
-function TARGET() pure returns (ObjectType) {
-    return ObjectType.wrap(31);
+function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
+    return ObjectType.wrap(48);
 }
 
-function STAKE() pure returns (ObjectType) {
-    return ObjectType.wrap(32);
+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) {
@@ -197,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/PayoutId.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-// uint24 allows for 65'535 claims with 255 payouts each per policy
-type PayoutId is uint24;
+// uint40 allows for 65'535 claims with 16'777'216 payouts each per policy
+type PayoutId is uint40;
 
 import {ClaimId} from "./ClaimId.sol";
 import {PAYOUT} from "./ObjectType.sol";
@@ -39,21 +39,21 @@ library PayoutIdLib {
     }
 
     /// @dev Converts an uint into a PayoutId.
-    function toPayoutId(ClaimId claimId, uint8 payoutNo) public pure returns (PayoutId) {
-        return PayoutId.wrap((ClaimId.unwrap(claimId) << 8) + payoutNo);
+    function toPayoutId(ClaimId claimId, uint24 payoutNo) public pure returns (PayoutId) {
+        return PayoutId.wrap((uint40(ClaimId.unwrap(claimId)) << 24) + payoutNo);
     }
 
     function toClaimId(PayoutId payoutId) public pure returns (ClaimId) {
-        return ClaimId.wrap(uint16(PayoutId.unwrap(payoutId) >> 8));
+        return ClaimId.wrap(uint16(PayoutId.unwrap(payoutId) >> 24));
     }
 
-    function toPayoutNo(PayoutId payoutId) public pure returns (uint8) {
-        return uint8(PayoutId.unwrap(payoutId) & 255);
+    function toPayoutNo(PayoutId payoutId) public pure returns (uint24) {
+        return uint24(PayoutId.unwrap(payoutId) & 16777215);
     }
 
     /// @dev Converts the PayoutId to a uint.
-    function toInt(PayoutId a) public pure returns (uint24) {
-        return uint24(PayoutId.unwrap(a));
+    function toInt(PayoutId a) public pure returns (uint40) {
+        return PayoutId.unwrap(a);
     }
 
     /// @dev Returns true if the value is non-zero (> 0).
@@ -77,6 +77,6 @@ library PayoutIdLib {
             bytes31(
                 bytes15(
                     uint120(
-                        (NftId.unwrap(policyNftId) << 24) + PayoutId.unwrap(payoutId)))));
+                        (NftId.unwrap(policyNftId) << 40) + PayoutId.unwrap(payoutId)))));
     }
 }

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,6 +11,11 @@ type RiskId is bytes8;
 using {
     eqRiskId as ==, 
     neRiskId as !=,
+    RiskIdLib.eq,
+    RiskIdLib.eqz,
+    RiskIdLib.gtz,
+    RiskIdLib.toInt,
+    RiskIdLib.toKeyId,
     RiskIdLib.toKey32
 } for RiskId global;
 
@@ -26,18 +32,44 @@ function neRiskId(RiskId a, RiskId b) pure returns (bool isDifferent) {
 }
 
 library RiskIdLib {
-    // @dev Converts a role string into a role id.
-    function toRiskId(string memory risk) public pure returns (RiskId) {
-        return RiskId.wrap(bytes8(keccak256(abi.encode(risk))));
+    function zero() public pure returns (RiskId) {
+        return RiskId.wrap(bytes8(0));
     }
 
-    /// @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 into a uint256.
+    function toInt(RiskId riskId) public pure returns (uint256) {
+        return uint64(RiskId.unwrap(riskId));
+    }
+
+    // @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
     function toKeyId(RiskId id) public pure returns (KeyId keyId) {
         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);
+    }
+
+    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,17 +56,8 @@ 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); }
-
-/// @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 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
@@ -84,6 +77,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
@@ -104,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) {
@@ -124,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.
@@ -162,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/Seconds.sol

@@ -6,9 +6,14 @@ type Seconds is uint40;
 using {
     SecondsEq 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) {
@@ -19,6 +24,11 @@ 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);
@@ -70,6 +80,16 @@ 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 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/Timestamp.sol

@@ -12,6 +12,12 @@ 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,
@@ -48,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 Timestamp.wrap(uint40(timestamp));
-}
-
 // TODO move to TimestampLib and rename to zero()
 /// @dev Return the Timestamp zero (0)
 function zeroTimestamp() pure returns (Timestamp) {
@@ -72,6 +73,10 @@ library TimestampLib {
     function blockTimestamp() 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) {