@etherisc/gif-next 0.0.2-ff282a4-523 → 0.0.2-ff596ab-857

package/contracts/type/Fee.sol

@@ -1,16 +1,31 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {Amount, AmountLib} from "./Amount.sol";
 import {UFixed, UFixedLib} from "./UFixed.sol";
 
 struct Fee {
+    // slot 0
     UFixed fractionalFee;
-    uint256 fixedFee;
+    Amount fixedFee;
 }
 
 library FeeLib {
 
+    /// @dev Return a zero fee struct (0, 0)
+    function zero() public pure returns (Fee memory fee) {
+        return Fee(UFixed.wrap(0), AmountLib.zero());
+    }
+
+    /// @dev Converts the uint256 to a fee struct.
+    function toFee(
+        UFixed fractionalFee,
+        uint256 fixedFee
+    ) public pure returns (Fee memory fee) {
+        return Fee(fractionalFee, AmountLib.toAmount(fixedFee));
+    }
+
+    /// @dev Calculates fee and net amounts for the provided parameters
     function calculateFee(
         Fee memory fee,
         Amount amount
@@ -26,40 +41,26 @@ library FeeLib {
         if(gtz(fee)) {
             UFixed fractionalAmount = 
                 amount.toUFixed() * fee.fractionalFee;
-            feeAmount = AmountLib.toAmount(fractionalAmount.toInt() + fee.fixedFee);
+            feeAmount = AmountLib.toAmount(fractionalAmount.toInt()) + fee.fixedFee;
             netAmount = netAmount - feeAmount;
         }
     }
 
-    /// @dev Converts the uint256 to a fee struct.
-    function toFee(
-        UFixed fractionalFee,
-        uint256 fixedFee
-    ) public pure returns (Fee memory fee) {
-        return Fee(fractionalFee, fixedFee);
-    }
-
     /// @dev Return the percent fee struct (x%, 0)
     function percentageFee(uint8 percent) public pure returns (Fee memory fee) {
-        return Fee(UFixedLib.toUFixed(percent, -2), 0);
-    }
-
-    // TODO rename to zero
-    /// @dev Return a zero fee struct (0, 0)
-    function zeroFee() public pure returns (Fee memory fee) {
-        return Fee(UFixed.wrap(0), 0);
+        return Fee(UFixedLib.toUFixed(percent, -2), AmountLib.zero());
     }
 
     // pure free functions for operators
-    function feeIsSame(Fee memory a, Fee memory b) public pure returns (bool isSame) {
+    function eq(Fee memory a, Fee memory b) public pure returns (bool isSame) {
         return a.fixedFee == b.fixedFee && a.fractionalFee == b.fractionalFee;
     }
 
     function gtz(Fee memory fee) public pure returns (bool) {
-        return UFixed.unwrap(fee.fractionalFee) > 0 || fee.fixedFee > 0;
+        return UFixed.unwrap(fee.fractionalFee) > 0 || fee.fixedFee.gtz();
     }
 
     function eqz(Fee memory fee) public pure returns (bool) {
-        return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
+        return fee.fixedFee.eqz() && UFixed.unwrap(fee.fractionalFee) == 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

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {Key32, KeyId, Key32Lib} from "./Key32.sol";
 import {ObjectType} from "./ObjectType.sol";
@@ -14,29 +14,18 @@ using {
     NftIdLib.toInt,
     NftIdLib.gtz,
     NftIdLib.eqz,
+    NftIdLib.eq,
     NftIdLib.toKeyId,
     NftIdLib.toKey32
 } for NftId global;
 
-// general pure free functions
-/// @dev Converts the uint256 to a NftId.
-function toNftId(uint256 id) pure returns (NftId) {
-    return NftId.wrap(uint96(id));
-}
-
-// TODO move to NftIdLib and rename to zero()
-/// @dev Return the NftId zero (0)
-function zeroNftId() pure returns (NftId) {
-    return NftId.wrap(0);
-}
-
 // pure free functions for operators
 function eqNftId(NftId a, NftId b) pure returns (bool isSame) {
-    return NftId.unwrap(a) == NftId.unwrap(b);
+    return NftIdLib.eq(a, b);
 }
 
 function neNftId(NftId a, NftId b) pure returns (bool isDifferent) {
-    return NftId.unwrap(a) != NftId.unwrap(b);
+    return NftIdLib.ne(a, b);
 }
 
 // library functions that operate on user defined type
@@ -48,6 +37,11 @@ library NftIdLib {
         return NftId.wrap(0);
     }
 
+    /// @dev Converts the uint256 to a NftId.
+    function toNftId(uint256 id) public pure returns (NftId) {
+        return NftId.wrap(uint96(id));
+    }
+
     /// @dev Converts the NftId to a uint256.
     function toInt(NftId nftId) public pure returns (uint96) {
         return uint96(NftId.unwrap(nftId));
@@ -65,7 +59,12 @@ library NftIdLib {
 
     /// @dev Returns true if the values are equal (==).
     function eq(NftId a, NftId b) public pure returns (bool isSame) {
-        return eqNftId(a, b);
+        return NftId.unwrap(a) == NftId.unwrap(b);
+    }
+
+    /// @dev Returns true if the values are not equal (!=).
+    function ne(NftId a, NftId b) public pure returns (bool isSame) {
+        return NftId.unwrap(a) != NftId.unwrap(b);
     }
 
     /// @dev Returns the key32 value for the specified nft id and object type.
@@ -77,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/NftIdSet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {NftId} from "../type/NftId.sol";
 

package/contracts/type/ObjectType.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {VersionPart} from "./Version.sol";
+
 type ObjectType is uint8;
 
 // type bindings
@@ -8,142 +10,178 @@ using {
     eqObjectType as ==,
     neObjectType as !=,
     ObjectTypeLib.toInt,
+    ObjectTypeLib.toName,
     ObjectTypeLib.eqz,
+    ObjectTypeLib.eq,
     ObjectTypeLib.gtz
 } for ObjectType global;
 
-// general pure free functions
 
-function PROTOCOL() pure returns (ObjectType) {
-    return toObjectType(10);
-}
+//--- GIF object types/domains (rage: 1 - 99) -------------------------------//
 
-function ROLE() pure returns (ObjectType) {
-    return toObjectType(20);
-}
-
-function TARGET() pure returns (ObjectType) {
-    return toObjectType(30);
+function PROTOCOL() pure returns (ObjectType) {
+    return ObjectType.wrap(1);
 }
 
 function REGISTRY() pure returns (ObjectType) {
-    return toObjectType(40);
+    return ObjectType.wrap(2);
 }
 
 function STAKING() pure returns (ObjectType) {
-    return toObjectType(45);
+    return ObjectType.wrap(3);
 }
 
-function TOKEN() pure returns (ObjectType) {
-    return toObjectType(50);
+function RELEASE() pure returns (ObjectType) {
+    return ObjectType.wrap(6);
+}
+
+function ROLE() pure returns (ObjectType) {
+    return ObjectType.wrap(7);
 }
 
 function SERVICE() pure returns (ObjectType) {
-    return toObjectType(60);
+    return ObjectType.wrap(8);
 }
 
 function INSTANCE() pure returns (ObjectType) {
-    return toObjectType(70);
+    return ObjectType.wrap(10);
 }
 
-function STAKE() pure returns (ObjectType) {
-    return toObjectType(80);
+/// @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);
 }
 
-function COMPONENT() pure returns (ObjectType) {
-    return toObjectType(100);
+/// @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);
 }
 
-// TODO replace by PRODUCT_SETUP
-function TREASURY() pure returns (ObjectType) {
-    return toObjectType(101);
+function ORACLE() pure returns (ObjectType) {
+    return ObjectType.wrap(13);
 }
 
-function PRODUCT_SETUP() pure returns (ObjectType) {
-    return toObjectType(101);
+function DISTRIBUTION() pure returns (ObjectType) {
+    return ObjectType.wrap(14);
 }
 
-function PRODUCT() pure returns (ObjectType) {
-    return toObjectType(110);
+function POOL() pure returns (ObjectType) {
+    return ObjectType.wrap(15);
 }
 
-function DISTRIBUTION() pure returns (ObjectType) {
-    return toObjectType(120);
+/// @dev Application object type.
+/// Range for NFT objects created thorugh components is 20-29.
+function APPLICATION() pure returns (ObjectType) {
+    return ObjectType.wrap(20);
 }
 
-function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
-    return toObjectType(121);
+function POLICY() pure returns (ObjectType) {
+    return ObjectType.wrap(21);
+}
+
+function BUNDLE() pure returns (ObjectType) {
+    return ObjectType.wrap(22);
 }
 
 function DISTRIBUTOR() pure returns (ObjectType) {
-    return toObjectType(122);
+    return ObjectType.wrap(23);
 }
 
-function REFERRAL() pure returns (ObjectType) {
-    return toObjectType(123);
+/// @dev Stake object type.
+/// NFT object type is 30
+function STAKE() pure returns (ObjectType) {
+    return ObjectType.wrap(30);
 }
 
-function ORACLE() pure returns (ObjectType) {
-    return toObjectType(130);
+/// @dev Staking target object type.
+function TARGET() pure returns (ObjectType) {
+    return ObjectType.wrap(31);
 }
 
-function POOL() pure returns (ObjectType) {
-    return toObjectType(140);
+/// @dev Accounting object type.
+/// Range for non-NFT types created through components is 40+
+function ACCOUNTING() pure returns (ObjectType) {
+    return ObjectType.wrap(40);
 }
 
-function BUNDLE() pure returns (ObjectType) {
-    return toObjectType(220);
+function FEE() pure returns (ObjectType) {
+    return ObjectType.wrap(41);
 }
 
-function RISK() pure returns (ObjectType) {
-    return toObjectType(200);
+function PRICE() pure returns (ObjectType) {
+    return ObjectType.wrap(42);
 }
 
-function APPLICATION() pure returns (ObjectType) {
-    return toObjectType(210);
+function PREMIUM() pure returns (ObjectType) {
+    return ObjectType.wrap(43);
 }
 
-function POLICY() pure returns (ObjectType) {
-    return toObjectType(211);
+function RISK() pure returns (ObjectType) {
+    return ObjectType.wrap(44);
 }
 
 function CLAIM() pure returns (ObjectType) {
-    return toObjectType(212);
+    return ObjectType.wrap(45);
 }
 
 function PAYOUT() pure returns (ObjectType) {
-    return toObjectType(213); 
+    return ObjectType.wrap(46); 
 }
 
-function PRICE() pure returns (ObjectType) {
-    return toObjectType(230);
+function REQUEST() pure returns (ObjectType) {
+    return ObjectType.wrap(47);
+}
+
+function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
+    return ObjectType.wrap(48);
 }
 
-/// @dev Converts the uint8 to a ObjectType.
-function toObjectType(uint256 objectType) pure returns (ObjectType) {
-    return ObjectType.wrap(uint8(objectType));
+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);
 }
 
-// TODO move to ObjecTypeLib and rename to zero()
-/// @dev Return the ObjectType zero (0)
-function zeroObjectType() pure returns (ObjectType) {
-    return ObjectType.wrap(0);
+/// @dev Object type that includes any other object type.
+/// Note that eq()/'==' does not take this property into account.
+function ALL() pure returns (ObjectType) {
+    return ObjectType.wrap(99);
 }
 
-// pure free functions for operators
+// other pure free functions for operators
 function eqObjectType(ObjectType a, ObjectType b) pure returns (bool isSame) {
     return ObjectType.unwrap(a) == ObjectType.unwrap(b);
 }
 
-function neObjectType(
-    ObjectType a,
-    ObjectType b
-) pure returns (bool isDifferent) {
+function neObjectType(ObjectType a, ObjectType b) pure returns (bool isSame) {
     return ObjectType.unwrap(a) != ObjectType.unwrap(b);
 }
 
 // library functions that operate on user defined type
 library ObjectTypeLib {
+
+    function zero() public pure returns (ObjectType) {
+        return ObjectType.wrap(0);
+    }
+
+    /// @dev Converts the uint256 into ObjectType.
+    function toObjectType(uint256 objectType) public pure returns (ObjectType) {
+        return ObjectType.wrap(uint8(objectType));
+    }
+
     /// @dev Converts the NftId to a uint256.
     function toInt(ObjectType objectType) public pure returns (uint96) {
         return uint96(ObjectType.unwrap(objectType));
@@ -161,6 +199,109 @@ library ObjectTypeLib {
 
     /// @dev Returns true if the values are equal (==).
     function eq(ObjectType a, ObjectType b) public pure returns (bool isSame) {
-        return eqObjectType(a, b);
+        return ObjectType.unwrap(a) == ObjectType.unwrap(b);
+    }
+
+    /// @dev Returns true if the values are not equal (!=).
+    function ne(ObjectType a, ObjectType b) public pure returns (bool isSame) {
+        return ObjectType.unwrap(a) != ObjectType.unwrap(b);
+    }
+
+    /// @dev Returns the type/domain name for the provided object type
+    function toName(ObjectType objectType) public pure returns (string memory name) {
+        if (objectType == REGISTRY()) {
+            return "Registry";
+        } else if (objectType == STAKING()) {
+            return "Staking";
+        } else if (objectType == RELEASE()) {
+            return "Release";
+        } else if (objectType == INSTANCE()) {
+            return "Instance";
+        } else if (objectType == COMPONENT()) {
+            return "Component";
+        } else if (objectType == PRODUCT()) {
+            return "Product";
+        } else if (objectType == ORACLE()) {
+            return "Oracle";
+        } else if (objectType == DISTRIBUTION()) {
+            return "Distribution";
+        } else if (objectType == POOL()) {
+            return "Pool";
+        } else if (objectType == APPLICATION()) {
+            return "Application";
+        } else if (objectType == POLICY()) {
+            return "Policy";
+        } else if (objectType == CLAIM()) {
+            return "Claim";
+        } else if (objectType == PRICE()) {
+            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(
+                    toInt(objectType))));
+    }
+
+    // TODO move to IService
+    function toVersionedName(
+        string memory name, 
+        string memory suffix, 
+        VersionPart release
+    )
+        external
+        pure
+        returns (string memory versionedName)
+    {
+        string memory versionName = "V0";
+
+        if (release.toInt() >= 10) {
+            versionName = "V";
+        }
+
+        versionedName = string(
+            abi.encodePacked(
+                name,
+                suffix,
+                versionName,
+                release.toString()));
+    }
+
+    /// @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);
+        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/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/Referral.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {Key32, KeyId, Key32Lib} from "./Key32.sol";
 import {NftId} from "./NftId.sol";
@@ -12,6 +12,7 @@ type ReferralStatus is uint8;
 using {
     eqReferralId as ==, 
     neReferralId as !=,
+    ReferralLib.eqz,
     ReferralLib.toKey32
 } for ReferralId global;