@etherisc/gif-next 0.0.2-fe77319 → 0.0.2-ff282a4-523

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.19;
+
+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/RiskId.sol

@@ -0,0 +1,43 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {RISK} from "./ObjectType.sol";
+
+type RiskId is bytes8;
+
+// type bindings
+using {
+    eqRiskId as ==, 
+    neRiskId as !=,
+    RiskIdLib.toKey32
+} for RiskId global;
+
+// general pure free functions
+
+// @dev Returns true iff risk ids a and b are identical
+function eqRiskId(RiskId a, RiskId b) pure returns (bool isSame) {
+    return RiskId.unwrap(a) == RiskId.unwrap(b);
+}
+
+// @dev Returns true iff risk ids a and b are different
+function neRiskId(RiskId a, RiskId b) pure returns (bool isDifferent) {
+    return RiskId.unwrap(a) != RiskId.unwrap(b);
+}
+
+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))));
+    }
+
+    /// @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 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)));
+    }
+}

package/contracts/type/RoleId.sol

@@ -0,0 +1,132 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {ROLE} from "./ObjectType.sol";
+
+type RoleId is uint64;
+
+// type bindings
+using {
+    eqRoleId as ==, 
+    neRoleId as !=,
+    RoleIdLib.eqz,
+    RoleIdLib.gtz,
+    RoleIdLib.toInt,
+    RoleIdLib.toKey32
+} for RoleId global;
+
+
+/// @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); }
+
+// general pure free functions
+
+/// @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(1500); } 
+
+/// @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(1600); } 
+
+/// @dev role associated with the ReleaseManager contract
+function RELEASE_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1700); } 
+
+/// @dev instance specific role to register/own a distribution component
+function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2); }
+
+/// @dev instance specific  role to register/own an oracle component
+function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(3); }
+
+/// @dev instance specific  role to register/own a pool component
+function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(4); }
+
+/// @dev instance specific  role to register/own a product component
+function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(5); }
+
+/// @dev role associated with an instance contract
+/// this role is the admin role for the INSTANCE_OWNER_ROLE
+function INSTANCE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2600); }
+
+/// @dev required role to register/own an instance
+/// allows instance specific target, role and access management 
+function INSTANCE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1900); }
+
+/// @dev instance specific role for instance service
+function INSTANCE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2000); }
+
+/// @dev instance specific role for distribution service
+function DISTRIBUTION_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2100); }
+
+/// @dev instance specific role for pool service
+function POOL_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2200); }
+
+/// @dev instance specific role for product service
+function PRODUCT_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2300); }
+
+/// @dev instance specific role for application service
+function APPLICATION_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2400); }
+
+/// @dev instance specific role for policy service
+function POLICY_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2410); }
+
+/// @dev instance specific role for claim service
+function CLAIM_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2420); }
+
+/// @dev instance specific role for bundle service
+function BUNDLE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2500); }
+
+// @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 the RoleId to a uint.
+    function zero() public pure returns (RoleId) {
+        return RoleId.wrap(0);
+    }
+
+    /// @dev Converts an uint into a RoleId.
+    function toRoleId(uint256 a) public pure returns (RoleId) {
+        return RoleId.wrap(uint64(a));
+    }
+
+    /// @dev Converts the RoleId 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;
+    }
+
+    /// @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));
+    }
+
+    /// @dev Returns the key id value for the specified id
+    function toKeyId(RoleId a) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(uint248(RoleId.unwrap(a))));
+    }
+}

package/contracts/type/Seconds.sol

@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+type Seconds is uint40;
+
+using {
+    SecondsLib.eqz,
+    SecondsLib.gtz,
+    SecondsLib.toInt
+} for Seconds global;
+
+
+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());
+    }
+
+    /// @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;
+    }
+
+    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/StateId.sol

@@ -0,0 +1,110 @@
+// 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.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 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 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);
+}
+
+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 {
+    /// @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/Timestamp.sol

@@ -0,0 +1,132 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Seconds} from "./Seconds.sol";
+
+type Timestamp is uint40;
+
+using {
+    gtTimestamp as >,
+    gteTimestamp as >=,
+    ltTimestamp as <,
+    lteTimestamp as <=,
+    eqTimestamp as ==,
+    neTimestamp as !=,
+    TimestampLib.gtz,
+    TimestampLib.eqz,
+    TimestampLib.addSeconds,
+    TimestampLib.toInt
+} 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));
+}
+
+// TODO move to TimestampLib and rename to zero()
+/// @dev Return the Timestamp zero (0)
+function zeroTimestamp() pure returns (Timestamp) {
+    return toTimestamp(0);
+}
+
+library TimestampLib {
+
+    function zero() public pure returns (Timestamp) {
+        return toTimestamp(0);
+    }
+    
+    function blockTimestamp() public view returns (Timestamp) {
+        return Timestamp.wrap(uint40(block.timestamp));
+    }
+    
+    /// @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 equals 0
+    function eqz(Timestamp timestamp) public pure returns (bool) {
+        return Timestamp.unwrap(timestamp) == 0;
+    }
+
+    /// @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 a is not equal to Timestamp b
+    function addSeconds(
+        Timestamp timestamp,
+        Seconds duration
+    ) public pure returns (Timestamp) {
+        return toTimestamp(Timestamp.unwrap(timestamp) + duration.toInt());
+    }
+
+    function toInt(Timestamp timestamp) public pure returns (uint256) {
+        return uint256(uint40(Timestamp.unwrap(timestamp)));
+    }
+}