@etherisc/gif-next 0.0.2-cc253b3 → 0.0.2-ce2fc91-485

package/contracts/types/Key32.sol

@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ObjectType} from "./ObjectType.sol";
+
+type Key32 is bytes32;
+type KeyId is bytes31;
+
+// type bindings
+using {
+    eqKey32 as ==, 
+    neKey32 as !=,
+    Key32Lib.toKey
+} for Key32 global;
+
+// @dev Returns true iff keys are identical
+function eqKey32(Key32 a, Key32 b) pure returns (bool isSame) {
+    return Key32.unwrap(a) == Key32.unwrap(b);
+}
+
+// @dev Returns true iff keys are different
+function neKey32(Key32 a, Key32 b) pure returns (bool isDifferent) {
+    return Key32.unwrap(a) != Key32.unwrap(b);
+}
+
+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
+
+    function toKey32(ObjectType objectType, KeyId id) public pure returns (Key32) {
+        uint256 uintObjectType = ObjectType.unwrap(objectType);
+        uint256 uintId = uint248(KeyId.unwrap(id));
+        uint256 uintKey = (uintObjectType << TYPE_SHIFT) + uintId;
+        return Key32.wrap(bytes32(uintKey));
+    }
+
+    function toKey(Key32 key) public pure returns (ObjectType objectType, KeyId id) {
+        bytes32 key32 = Key32.unwrap(key);
+        objectType = ObjectType.wrap(uint8(uint256(key32 & TYPE_MASK) >> TYPE_SHIFT));
+        id = KeyId.wrap(bytes31((key32 & ID_MASK) << ID_SHIFT));
+    }
+}

package/contracts/types/NftId.sol

@@ -1,26 +1,72 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {ObjectType} from "./ObjectType.sol";
+
 // uint96 allows for chain ids up to 13 digits
 type NftId is uint96;
 
 // type bindings
 using {
-    eqNftId as ==,
-    neNftId as !=,
-    NftIdLib.toInt
+    eqNftId as ==, 
+    neNftId as !=, 
+    NftIdLib.toInt,
+    NftIdLib.gtz,
+    NftIdLib.eqz,
+    NftIdLib.toKeyId,
+    NftIdLib.toKey32
 } for NftId global;
 
 // general pure free functions
-function toNftId(uint256 id) pure returns(NftId) { return NftId.wrap(uint96(id)); }
+/// @dev Converts the uint256 to a NftId.
+function toNftId(uint256 id) pure returns (NftId) {
+    return NftId.wrap(uint96(id));
+}
+
+/// @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); }
-function neNftId(NftId a, NftId b) pure returns(bool isDifferent) { return NftId.unwrap(a) != NftId.unwrap(b); }
+function eqNftId(NftId a, NftId b) pure returns (bool isSame) {
+    return NftId.unwrap(a) == NftId.unwrap(b);
+}
+
+function neNftId(NftId a, NftId b) pure returns (bool isDifferent) {
+    return NftId.unwrap(a) != NftId.unwrap(b);
+}
 
 // library functions that operate on user defined type
 library NftIdLib {
-    function toInt(NftId nftId) public pure returns(uint256) { return uint256(NftId.unwrap(nftId)); }
-    function gtz(NftId a) public pure returns(bool) { return NftId.unwrap(a) > 0; }
-    function eqz(NftId a) public pure returns(bool) { return NftId.unwrap(a) == 0; }
+    /// @dev Converts the NftId to a uint256.
+    function toInt(NftId nftId) public pure returns (uint96) {
+        return uint96(NftId.unwrap(nftId));
+    }
+
+    /// @dev Returns true if the value is non-zero (> 0).
+    function gtz(NftId a) public pure returns (bool) {
+        return NftId.unwrap(a) > 0;
+    }
+
+    /// @dev Returns true if the value is zero (== 0).
+    function eqz(NftId a) public pure returns (bool) {
+        return NftId.unwrap(a) == 0;
+    }
+
+    /// @dev Returns true if the values are equal (==).
+    function eq(NftId a, NftId b) public pure returns (bool isSame) {
+        return eqNftId(a, b);
+    }
+
+    /// @dev Returns the key32 value for the specified nft id and object type.
+    function toKey32(NftId id, ObjectType objectType) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(objectType, toKeyId(id));
+    }
+
+    /// @dev Returns the key id value for the specified nft id
+    function toKeyId(NftId id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(uint248(NftId.unwrap(id))));
+    }
 }

package/contracts/types/NftIdSet.sol

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../types/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;
+    }
+
+    function add(Set storage set, NftId nftId) external returns(bool added) {
+        if (set.at[nftId] == 0) {
+            set.ids.push(nftId);
+            set.at[nftId] = set.ids.length;
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    function remove(Set storage set, NftId nftId) external returns(bool removed) {
+        uint256 nftIdIndex = set.at[nftId];
+
+        if (nftIdIndex > 0) {
+            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];
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    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 getLength(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/types/ObjectType.sol

@@ -0,0 +1,119 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+type ObjectType is uint8;
+
+// type bindings
+using {
+    eqObjectType as ==,
+    neObjectType as !=,
+    ObjectTypeLib.toInt,
+    ObjectTypeLib.gtz
+} for ObjectType global;
+
+// general pure free functions
+
+function PROTOCOL() pure returns (ObjectType) {
+    return toObjectType(10);
+}
+
+function REGISTRY() pure returns (ObjectType) {
+    return toObjectType(20);
+}
+
+function TOKEN() pure returns (ObjectType) {
+    return toObjectType(30);
+}
+
+function SERVICE() pure returns (ObjectType) {
+    return toObjectType(40);
+}
+
+function INSTANCE() pure returns (ObjectType) {
+    return toObjectType(50);
+}
+
+function STAKE() pure returns (ObjectType) {
+    return toObjectType(60);
+}
+
+function COMPONENT() pure returns (ObjectType) {
+    return toObjectType(100);
+}
+
+function PRODUCT() pure returns (ObjectType) {
+    return toObjectType(110);
+}
+
+function COMPENSATION() pure returns (ObjectType) {
+    return toObjectType(120);
+}
+
+function ORACLE() pure returns (ObjectType) {
+    return toObjectType(130);
+}
+
+function POOL() pure returns (ObjectType) {
+    return toObjectType(140);
+}
+
+function POLICY() pure returns (ObjectType) {
+    return toObjectType(200);
+}
+
+function BUNDLE() pure returns (ObjectType) {
+    return toObjectType(210);
+}
+
+function CLAIM() pure returns (ObjectType) {
+    return toObjectType(201);
+}
+
+function PAYOUT() pure returns (ObjectType) {
+    return toObjectType(202);
+}
+
+/// @dev Converts the uint8 to a ObjectType.
+function toObjectType(uint256 objectType) pure returns (ObjectType) {
+    return ObjectType.wrap(uint8(objectType));
+}
+
+/// @dev Return the ObjectType zero (0)
+function zeroObjectType() pure returns (ObjectType) {
+    return ObjectType.wrap(0);
+}
+
+// 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) {
+    return ObjectType.unwrap(a) != ObjectType.unwrap(b);
+}
+
+// library functions that operate on user defined type
+library ObjectTypeLib {
+    /// @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 eqObjectType(a, b);
+    }
+}

package/contracts/types/RoleId.sol

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+type RoleId is bytes8;
+
+// type bindings
+using {
+    eqRoleId as ==, 
+    neRoleId as !=
+} for RoleId global;
+
+// general pure free functions
+function DISTRIBUTOR_OWNER_ROLE_NAME() pure returns (string memory) { return "DistributorOwnerRole"; }
+function ORACLE_OWNER_ROLE_NAME() pure returns (string memory) { return "OracleOwnerRole"; }
+function POOL_OWNER_ROLE_NAME() pure returns (string memory) { return "PoolOwnerRole"; }
+function PRODUCT_OWNER_ROLE_NAME() pure returns (string memory) { return "ProductOwnerRole"; }
+
+function DISTRIBUTOR_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("DistributorOwnerRole"); }
+function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("OracleOwnerRole"); }
+function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("PoolOwnerRole"); }
+function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("ProductOwnerRole"); }
+
+// @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);
+}
+
+library RoleIdLib {
+    // @dev Converts a role string into a role id.
+    function toRoleId(string memory role) public pure returns (RoleId) {
+        return RoleId.wrap(bytes8(keccak256(abi.encode(role))));
+    }
+}

package/contracts/types/StateId.sol

@@ -0,0 +1,101 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+// uint96 allows for chain ids up to 13 digits
+type StateId is uint8;
+
+// type bindings
+using {
+    eqStateId as ==, 
+    neStateId as !=, 
+    StateIdLib.eqz,
+    StateIdLib.gtz,
+    StateIdLib.toInt
+} for StateId global;
+
+// general pure free functions
+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 UNDERWRITTEN() pure returns (StateId) {
+    return toStateId(40);
+}
+
+function CONFIRMED() pure returns (StateId) {
+    return toStateId(50);
+}
+
+function EXPECTED() pure returns (StateId) {
+    return toStateId(60);
+}
+
+function ACTIVE() pure returns (StateId) {
+    return toStateId(100);
+}
+
+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);
+}
+
+/// @dev Converts the uint8 to a StateId.
+function toStateId(uint256 id) pure returns (StateId) {
+    return StateId.wrap(uint8(id));
+}
+
+/// @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 {
+    /// @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/types/Timestamp.sol

@@ -0,0 +1,123 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+type Timestamp is uint40;
+
+using {
+    gtTimestamp as >,
+    gteTimestamp as >=,
+    ltTimestamp as <,
+    lteTimestamp as <=,
+    eqTimestamp as ==,
+    neTimestamp as !=,
+    TimestampLib.gtz,
+    TimestampLib.eqz,
+    TimestampLib.addSeconds
+} for Timestamp global;
+
+/// @dev return true if Timestamp a is after Timestamp b
+function gtTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
+    return Timestamp.unwrap(a) > Timestamp.unwrap(b);
+}
+
+/// @dev return true if Timestamp a is after or equal to Timestamp b
+function gteTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
+    return Timestamp.unwrap(a) >= Timestamp.unwrap(b);
+}
+
+/// @dev return true if Timestamp a is before Timestamp b
+function ltTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
+    return Timestamp.unwrap(a) < Timestamp.unwrap(b);
+}
+
+/// @dev return true if Timestamp a is before or equal to Timestamp b
+function lteTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
+    return Timestamp.unwrap(a) <= Timestamp.unwrap(b);
+}
+
+/// @dev return true if Timestamp a is equal to Timestamp b
+function eqTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
+    return Timestamp.unwrap(a) == Timestamp.unwrap(b);
+}
+
+/// @dev return true if Timestamp a is not equal to Timestamp b
+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));
+}
+
+function blockTimestamp() view returns (Timestamp) {
+    return toTimestamp(block.timestamp);
+}
+
+/// @dev Return the Timestamp zero (0)
+function zeroTimestamp() pure returns (Timestamp) {
+    return toTimestamp(0);
+}
+
+library TimestampLib {
+    /// @dev return true if Timestamp a is after Timestamp b
+    function gt(Timestamp a, Timestamp b) public pure returns (bool isAfter) {
+        return gtTimestamp(a, b);
+    }
+
+    /// @dev return true if Timestamp a is after or the same than Timestamp b
+    function gte(
+        Timestamp a,
+        Timestamp b
+    ) public pure returns (bool isAfterOrSame) {
+        return gteTimestamp(a, b);
+    }
+
+    /// @dev return true if Timestamp a is before Timestamp b
+    function lt(Timestamp a, Timestamp b) public pure returns (bool isBefore) {
+        return ltTimestamp(a, b);
+    }
+
+    /// @dev return true if Timestamp a is before or the same than Timestamp b
+    function lte(
+        Timestamp a,
+        Timestamp b
+    ) public pure returns (bool isBeforeOrSame) {
+        return lteTimestamp(a, b);
+    }
+
+    /// @dev return true if Timestamp a is equal to Timestamp b
+    function eq(Timestamp a, Timestamp b) public pure returns (bool isSame) {
+        return eqTimestamp(a, b);
+    }
+
+    /// @dev return true if Timestamp a is not equal to Timestamp b
+    function ne(
+        Timestamp a,
+        Timestamp b
+    ) public pure returns (bool isDifferent) {
+        return neTimestamp(a, b);
+    }
+
+    /// @dev return true if Timestamp is larger than 0
+    function gtz(Timestamp timestamp) public pure returns (bool) {
+        return Timestamp.unwrap(timestamp) > 0;
+    }
+
+    /// @dev return true if Timestamp equals 0
+    function eqz(Timestamp timestamp) public pure returns (bool) {
+        return Timestamp.unwrap(timestamp) == 0;
+    }
+
+    /// @dev return true if Timestamp a is not equal to Timestamp b
+    function addSeconds(
+        Timestamp timestamp,
+        uint256 timeDelta
+    ) public pure returns (Timestamp) {
+        return toTimestamp(Timestamp.unwrap(timestamp) + uint40(timeDelta));
+    }
+
+    function toInt(Timestamp timestamp) public pure returns (uint256) {
+        return uint256(uint40(Timestamp.unwrap(timestamp)));
+    }
+}