@etherisc/gif-next 0.0.2-8d47fa1-080 → 0.0.2-8d6e553-386

package/contracts/type/NftIdSet.sol

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

package/contracts/type/ObjectType.sol

@@ -0,0 +1,271 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+type ObjectType is uint8;
+
+// type bindings
+using {
+    eqObjectType as ==,
+    neObjectType as !=,
+    ObjectTypeLib.toInt,
+    ObjectTypeLib.eqz,
+    ObjectTypeLib.gtz
+} for ObjectType global;
+
+
+//--- GIF object types/domains (rage: 1 - 99) -------------------------------//
+
+function PROTOCOL() pure returns (ObjectType) {
+    return ObjectType.wrap(1);
+}
+
+function REGISTRY() pure returns (ObjectType) {
+    return ObjectType.wrap(2);
+}
+
+function STAKING() pure returns (ObjectType) {
+    return ObjectType.wrap(3);
+}
+
+function RELEASE() pure returns (ObjectType) {
+    return ObjectType.wrap(6);
+}
+
+function ROLE() pure returns (ObjectType) {
+    return ObjectType.wrap(7);
+}
+
+function SERVICE() pure returns (ObjectType) {
+    return ObjectType.wrap(8);
+}
+
+function INSTANCE() pure returns (ObjectType) {
+    return ObjectType.wrap(10);
+}
+
+function COMPONENT() pure returns (ObjectType) {
+    return ObjectType.wrap(11);
+}
+
+function PRODUCT() pure returns (ObjectType) {
+    return ObjectType.wrap(12);
+}
+
+function ORACLE() pure returns (ObjectType) {
+    return ObjectType.wrap(13);
+}
+
+function DISTRIBUTION() pure returns (ObjectType) {
+    return ObjectType.wrap(14);
+}
+
+function POOL() pure returns (ObjectType) {
+    return ObjectType.wrap(15);
+}
+
+function APPLICATION() pure returns (ObjectType) {
+    return ObjectType.wrap(20);
+}
+
+function POLICY() pure returns (ObjectType) {
+    return ObjectType.wrap(21);
+}
+
+function CLAIM() pure returns (ObjectType) {
+    return ObjectType.wrap(22);
+}
+
+function PAYOUT() pure returns (ObjectType) {
+    return ObjectType.wrap(23); 
+}
+
+function RISK() pure returns (ObjectType) {
+    return ObjectType.wrap(24);
+}
+
+function PRICE() pure returns (ObjectType) {
+    return ObjectType.wrap(25);
+}
+
+function REQUEST() pure returns (ObjectType) {
+    return ObjectType.wrap(26);
+}
+
+function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
+    return ObjectType.wrap(27);
+}
+
+function DISTRIBUTOR() pure returns (ObjectType) {
+    return ObjectType.wrap(28);
+}
+
+function REFERRAL() pure returns (ObjectType) {
+    return ObjectType.wrap(29);
+}
+
+function BUNDLE() pure returns (ObjectType) {
+    return ObjectType.wrap(30);
+}
+
+function TARGET() pure returns (ObjectType) {
+    return ObjectType.wrap(31);
+}
+
+function STAKE() pure returns (ObjectType) {
+    return ObjectType.wrap(32);
+}
+
+/// @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);
+}
+
+// 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 isSame) {
+    return ObjectType.unwrap(a) != ObjectType.unwrap(b);
+}
+
+// library functions that operate on user defined type
+library ObjectTypeLib {
+
+    error ErrorVersionTooBig(uint256 version);
+
+    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));
+    }
+
+    /// @dev Returns true if the value is non-zero (> 0).
+    function gtz(ObjectType a) public pure returns (bool) {
+        return ObjectType.unwrap(a) > 0;
+    }
+
+    /// @dev Returns true if the value is zero (== 0).
+    function eqz(ObjectType a) public pure returns (bool) {
+        return ObjectType.unwrap(a) == 0;
+    }
+
+    /// @dev Returns true if the values are equal (==).
+    function eq(ObjectType a, ObjectType b) public pure returns (bool isSame) {
+        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 == 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";
+        }
+
+        // fallback: ObjectType<obect-type-int>
+        return string(
+            abi.encodePacked(
+                "ObjectType",
+                toString(
+                    toInt(objectType))));
+    }
+
+    function toVersionedName(
+        string memory name, 
+        string memory suffix, 
+        uint256 version
+    )
+        external
+        pure
+        returns (string memory versionedName)
+    {
+        if (version > maxNumReleases()) {
+            revert ErrorVersionTooBig(version);
+        }
+
+        string memory versionName = "_v0";
+
+        if (version >= 10) {
+            versionName = "_v";
+        }
+
+        versionedName = string(
+            abi.encodePacked(
+                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);
+    }
+}

package/contracts/type/PayoutId.sol

@@ -0,0 +1,82 @@
+// 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;
+
+import {ClaimId} from "./ClaimId.sol";
+import {PAYOUT} from "./ObjectType.sol";
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {NftId} from "./NftId.sol";
+
+// type bindings
+using {
+    eqPayoutId as ==, 
+    nePayoutId as !=, 
+    PayoutIdLib.eqz,
+    PayoutIdLib.gtz,
+    PayoutIdLib.toInt,
+    PayoutIdLib.toClaimId,
+    PayoutIdLib.toPayoutNo,
+    PayoutIdLib.toKey32
+} for PayoutId global;
+
+
+// pure free functions for operators
+function eqPayoutId(PayoutId a, PayoutId b) pure returns (bool isSame) {
+    return PayoutId.unwrap(a) == PayoutId.unwrap(b);
+}
+
+function nePayoutId(PayoutId a, PayoutId b) pure returns (bool isDifferent) {
+    return PayoutId.unwrap(a) != PayoutId.unwrap(b);
+}
+
+// library functions that operate on user defined type
+library PayoutIdLib {
+    /// @dev Converts the PayoutId to a uint.
+    function zero() public pure returns (PayoutId) {
+        return PayoutId.wrap(0);
+    }
+
+    /// @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 toClaimId(PayoutId payoutId) public pure returns (ClaimId) {
+        return ClaimId.wrap(uint16(PayoutId.unwrap(payoutId) >> 8));
+    }
+
+    function toPayoutNo(PayoutId payoutId) public pure returns (uint8) {
+        return uint8(PayoutId.unwrap(payoutId) & 255);
+    }
+
+    /// @dev Converts the PayoutId to a uint.
+    function toInt(PayoutId a) public pure returns (uint24) {
+        return uint24(PayoutId.unwrap(a));
+    }
+
+    /// @dev Returns true if the value is non-zero (> 0).
+    function gtz(PayoutId a) public pure returns (bool) {
+        return PayoutId.unwrap(a) > 0;
+    }
+
+    /// @dev Returns true if the value is zero (== 0).
+    function eqz(PayoutId a) public pure returns (bool) {
+        return PayoutId.unwrap(a) == 0;
+    }
+
+    /// @dev Converts the PayoutId and NftId to a Key32.
+    function toKey32(PayoutId payoutId, NftId policyNftId) public pure returns (Key32) {
+        return Key32Lib.toKey32(PAYOUT(), toKeyId(payoutId, policyNftId));
+    }
+
+    /// @dev Converts the PayoutId and NftId to a Key32.
+    function toKeyId(PayoutId payoutId, NftId policyNftId) public pure returns (KeyId) {
+        return KeyId.wrap(
+            bytes31(
+                bytes15(
+                    uint120(
+                        (NftId.unwrap(policyNftId) << 24) + PayoutId.unwrap(payoutId)))));
+    }
+}

package/contracts/type/Referral.sol

@@ -0,0 +1,89 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {NftId} from "./NftId.sol";
+import {REFERRAL} from "./ObjectType.sol";
+
+type ReferralId is bytes8;
+type ReferralStatus is uint8;
+
+// type bindings
+using {
+    eqReferralId as ==, 
+    neReferralId as !=,
+    ReferralLib.toKey32
+} for ReferralId global;
+
+using {
+    eqReferralStatus as ==, 
+    neReferralStatus as !=
+} for ReferralStatus global;
+
+// general pure free functions
+
+// @dev Returns true iff a and b are identical
+function eqReferralId(ReferralId a, ReferralId b) pure returns (bool isSame) {
+    return ReferralId.unwrap(a) == ReferralId.unwrap(b);
+}
+
+// @dev Returns true iff a and b are different
+function neReferralId(ReferralId a, ReferralId b) pure returns (bool isDifferent) {
+    return ReferralId.unwrap(a) != ReferralId.unwrap(b);
+}
+
+// @dev Returns true iff a and b are identical
+function eqReferralStatus(ReferralStatus a, ReferralStatus b) pure returns (bool isSame) {
+    return ReferralStatus.unwrap(a) == ReferralStatus.unwrap(b);
+}
+
+// @dev Returns true iff a and b are different
+function neReferralStatus(ReferralStatus a, ReferralStatus b) pure returns (bool isDifferent) {
+    return ReferralStatus.unwrap(a) != ReferralStatus.unwrap(b);
+}
+
+function REFERRAL_OK() pure returns (ReferralStatus) {
+    return ReferralStatus.wrap(10);
+}
+
+function REFERRAL_ERROR_UNKNOWN() pure returns (ReferralStatus) {
+    return ReferralStatus.wrap(100);
+}
+
+function REFERRAL_ERROR_EXPIRED() pure returns (ReferralStatus) {
+    return ReferralStatus.wrap(110);
+}
+
+function REFERRAL_ERROR_EXHAUSTED() pure returns (ReferralStatus) {
+    return ReferralStatus.wrap(120);
+}
+
+library ReferralLib {
+
+    function zero() public pure returns (ReferralId) {
+        return ReferralId.wrap(bytes8(0));
+    }
+
+    // @dev Converts a referral string into an id.
+    function toReferralId(NftId distributionNftId, string memory referral) public pure returns (ReferralId) {
+        return ReferralId.wrap(bytes8(keccak256(abi.encode(distributionNftId, referral))));
+    }
+
+    function toReferralStatus(uint8 status) public pure returns (ReferralStatus) {
+        return ReferralStatus.wrap(status);
+    }
+
+    /// @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));
+    }
+
+    /// @dev Returns the key id value for the specified nft id
+    function toKeyId(ReferralId id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(ReferralId.unwrap(id)));
+    }
+
+    function eqz(ReferralId id) public pure returns (bool) {
+        return eqReferralId(id, zero());
+    }
+}

package/contracts/type/RequestId.sol

@@ -0,0 +1,75 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {REQUEST} from "./ObjectType.sol";
+
+type RequestId is uint64;
+
+// type bindings
+using {
+    eqRequestId as ==, 
+    neRequestId as !=,
+    RequestIdLib.eqz,
+    RequestIdLib.gtz,
+    RequestIdLib.toInt,
+    RequestIdLib.toKey32
+} for RequestId global;
+
+// general pure free functions
+
+function eqRequestId(RequestId a, RequestId b) pure returns (bool isSame) {
+    return RequestIdLib.eq(a, b);
+}
+
+function neRequestId(RequestId a, RequestId b) pure returns (bool isSame) {
+    return RequestIdLib.ne(a, b);
+}
+
+library RequestIdLib {
+
+    // @dev zero element to refer to a non existing/initialized request
+    function zero() public pure returns (RequestId) {
+        return RequestId.wrap(0);
+    }
+
+    // @dev Converts an int id into a request id.
+    function toRequestId(uint256 id) public pure returns (RequestId) {
+        return RequestId.wrap(uint64(id));
+    }
+
+    // @dev Converts a request id back to an int value.
+    function toInt(RequestId requestId) public pure returns (uint256) {
+        return RequestId.unwrap(requestId);
+    }
+
+    // @dev Returns true iff request id a == 0
+    function eqz(RequestId a) public pure returns (bool) {
+        return RequestId.unwrap(a) == 0;
+    }
+
+    // @dev Returns true iff request id a > 0
+    function gtz(RequestId a) public pure returns (bool) {
+        return RequestId.unwrap(a) > 0;
+    }
+
+    // @dev Returns true iff risk ids a and b are identical
+    function eq(RequestId a, RequestId b) public pure returns (bool isSame) {
+        return RequestId.unwrap(a) == RequestId.unwrap(b);
+    }
+
+    // @dev Returns true iff risk ids a and b are different
+    function ne(RequestId a, RequestId b) public pure returns (bool isSame) {
+        return RequestId.unwrap(a) != RequestId.unwrap(b);
+    }
+
+    /// @dev Returns the key32 value for the specified nft id and object type.
+    function toKey32(RequestId id) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(REQUEST(), toKeyId(id));
+    }
+
+    /// @dev Returns the key id value for the specified nft id
+    function toKeyId(RequestId id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(uint248(RequestId.unwrap(id))));
+    }
+}

package/contracts/{types → type}/RiskId.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 {RISK} from "./ObjectType.sol";