@etherisc/gif-next 0.0.2-d696c44-627 → 0.0.2-d6a50e7-658

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

@@ -12,6 +12,7 @@ type ReferralStatus is uint8;
 using {
     eqReferralId as ==, 
     neReferralId as !=,
+    ReferralLib.eqz,
     ReferralLib.toKey32
 } for ReferralId global;
 

package/contracts/type/RiskId.sol

@@ -10,6 +10,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 +31,44 @@ function neRiskId(RiskId a, RiskId b) pure returns (bool isDifferent) {
 }
 
 library RiskIdLib {
-    // @dev Converts a role string into a role id.
+    function zero() public pure returns (RiskId) {
+        return RiskId.wrap(bytes8(0));
+    }
+
+    // @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 into a risk 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 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

@@ -54,17 +54,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
@@ -105,7 +96,7 @@ 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 CUSTOM_ROLE_MIN_INT = 1000000;
 
     /// @dev Converts the RoleId to a uint.
     function zero() public pure returns (RoleId) {
@@ -124,7 +115,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.

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/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) {

package/contracts/type/UFixed.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
+
 /// @dev UFixed is a fixed point number with 18 decimals precision.
 type UFixed is uint256;
 
@@ -15,9 +17,10 @@ using {
     lteUFixed as <=,
     eqUFixed as ==,
     neUFixed as !=,
+    UFixedLib.gt,
+    UFixedLib.gtz,
     UFixedLib.toInt,
-    UFixedLib.toInt1000,
-    UFixedLib.gtz
+    UFixedLib.toInt1000
 } for UFixed global;
 
 // TODO move to UFixedLib and rename to zero()
@@ -30,20 +33,24 @@ function addUFixed(UFixed a, UFixed b) pure returns (UFixed) {
 }
 
 function subUFixed(UFixed a, UFixed b) pure returns (UFixed) {
-    require(a >= b, "ERROR:UFM-010:NEGATIVE_RESULT");
+    if (a < b) {
+        revert UFixedLib.UFixedLibNegativeResult();
+    }
     return UFixed.wrap(UFixed.unwrap(a) - UFixed.unwrap(b));
 }
 
 function mulUFixed(UFixed a, UFixed b) pure returns (UFixed) {
     return
-        UFixed.wrap(MathLib.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
+        UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
 }
 
 function divUFixed(UFixed a, UFixed b) pure returns (UFixed) {
-    require(UFixed.unwrap(b) > 0, "ERROR:UFM-020:DIVISOR_ZERO");
-
+    if (UFixed.unwrap(b) == 0) {
+        revert UFixedLib.UFixedLibDivisionByZero();
+    }
+    
     return
-        UFixed.wrap(MathLib.mulDiv(UFixed.unwrap(a), 10 ** 18, UFixed.unwrap(b)));
+        UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), 10 ** 18, UFixed.unwrap(b)));
 }
 
 function gtUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
@@ -86,115 +93,13 @@ function deltaUFixed(UFixed a, UFixed b) pure returns (UFixed) {
     return b - a;
 }
 
-/// @dev copied from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.3/contracts/utils/math/Math.sol
-library MathLib {
-
-    enum Rounding {
-        Down, // Toward negative infinity
-        Up, // Toward infinity
-        Zero // Toward zero
-    }
-
-    /**
-     * @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
-     * @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)
-     * with further edits by Uniswap Labs also under MIT license.
-     */
-    function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
-        unchecked {
-            // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
-            // use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
-            // variables such that product = prod1 * 2^256 + prod0.
-            uint256 prod0; // Least significant 256 bits of the product
-            uint256 prod1; // Most significant 256 bits of the product
-            assembly {
-                let mm := mulmod(x, y, not(0))
-                prod0 := mul(x, y)
-                prod1 := sub(sub(mm, prod0), lt(mm, prod0))
-            }
-
-            // Handle non-overflow cases, 256 by 256 division.
-            if (prod1 == 0) {
-                // Solidity will revert if denominator == 0, unlike the div opcode on its own.
-                // The surrounding unchecked block does not change this fact.
-                // See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
-                return prod0 / denominator;
-            }
-
-            // Make sure the result is less than 2^256. Also prevents denominator == 0.
-            require(denominator > prod1, "Math: mulDiv overflow");
-
-            ///////////////////////////////////////////////
-            // 512 by 256 division.
-            ///////////////////////////////////////////////
-
-            // Make division exact by subtracting the remainder from [prod1 prod0].
-            uint256 remainder;
-            assembly {
-                // Compute remainder using mulmod.
-                remainder := mulmod(x, y, denominator)
-
-                // Subtract 256 bit number from 512 bit number.
-                prod1 := sub(prod1, gt(remainder, prod0))
-                prod0 := sub(prod0, remainder)
-            }
-
-            // Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.
-            // See https://cs.stackexchange.com/q/138556/92363.
-
-            // Does not overflow because the denominator cannot be zero at this stage in the function.
-            uint256 twos = denominator & (~denominator + 1);
-            assembly {
-                // Divide denominator by twos.
-                denominator := div(denominator, twos)
-
-                // Divide [prod1 prod0] by twos.
-                prod0 := div(prod0, twos)
-
-                // Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
-                twos := add(div(sub(0, twos), twos), 1)
-            }
-
-            // Shift in bits from prod1 into prod0.
-            prod0 |= prod1 * twos;
-
-            // Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
-            // that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
-            // four bits. That is, denominator * inv = 1 mod 2^4.
-            uint256 inverse = (3 * denominator) ^ 2;
-
-            // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
-            // in modular arithmetic, doubling the correct bits in each step.
-            inverse *= 2 - denominator * inverse; // inverse mod 2^8
-            inverse *= 2 - denominator * inverse; // inverse mod 2^16
-            inverse *= 2 - denominator * inverse; // inverse mod 2^32
-            inverse *= 2 - denominator * inverse; // inverse mod 2^64
-            inverse *= 2 - denominator * inverse; // inverse mod 2^128
-            inverse *= 2 - denominator * inverse; // inverse mod 2^256
-
-            // Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
-            // This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
-            // less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
-            // is no longer required.
-            result = prod0 * inverse;
-            return result;
-        }
-    }
-
-    /**
-     * @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
-     */
-    function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
-        uint256 result = mulDiv(x, y, denominator);
-        if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {
-            result += 1;
-        }
-        return result;
-    }
+library UFixedLib {
+    error UFixedLibNegativeResult();
+    error UFixedLibDivisionByZero();
 
-}
+    error UFixedLibExponentTooSmall(int8 exp);
+    error UFixedLibExponentTooLarge(int8 exp);
 
-library UFixedLib {
     int8 public constant EXP = 18;
     uint256 public constant MULTIPLIER = 10 ** uint256(int256(EXP));
     uint256 public constant MULTIPLIER_HALF = MULTIPLIER / 2;
@@ -221,9 +126,13 @@ library UFixedLib {
 
     /// @dev Converts the uint256 to a UFixed with given exponent.
     function toUFixed(uint256 a, int8 exp) public pure returns (UFixed) {
-        require(EXP + exp >= 0, "ERROR:FM-010:EXPONENT_TOO_SMALL");
-        require(EXP + exp <= 64, "ERROR:FM-011:EXPONENT_TOO_LARGE");
-
+        if (EXP + exp < 0) {
+            revert UFixedLibExponentTooSmall(exp);
+        }
+        if (EXP + exp > 64) {
+            revert UFixedLibExponentTooLarge(exp);
+        }
+        
         return UFixed.wrap(a * 10 ** uint8(EXP + exp));
     }
 
@@ -246,23 +155,23 @@ library UFixedLib {
     function toIntWithRounding(UFixed a, uint8 rounding) public pure returns (uint256) {
         if (rounding == ROUNDING_HALF_UP()) {
             return
-                MathLib.mulDiv(
+                Math.mulDiv(
                     UFixed.unwrap(a) + MULTIPLIER_HALF,
                     1,
                     MULTIPLIER,
-                    MathLib.Rounding.Down
+                    Math.Rounding.Floor
                 );
         } else if (rounding == ROUNDING_DOWN()) {
             return
-                MathLib.mulDiv(
+                Math.mulDiv(
                     UFixed.unwrap(a),
                     1,
                     MULTIPLIER,
-                    MathLib.Rounding.Down
+                    Math.Rounding.Floor
                 );
         } else {
             return
-                MathLib.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, MathLib.Rounding.Up);
+                Math.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, Math.Rounding.Ceil);
         }
     }
 
@@ -325,6 +234,10 @@ library UFixedLib {
         return UFixed.wrap(0);
     }
 
+    function one() public pure returns (UFixed) {
+        return UFixed.wrap(MULTIPLIER);
+    }
+
     /// @dev return the absolute delta between two UFixed numbers
     function delta(UFixed a, UFixed b) public pure returns (UFixed) {
         return deltaUFixed(a, b);

package/contracts/type/Version.sol

@@ -8,7 +8,8 @@ using {
     versionPartEq as ==,
     versionPartNe as !=,
     VersionPartLib.eqz,
-    VersionPartLib.toInt
+    VersionPartLib.toInt,
+    VersionPartLib.isValidRelease
 }
     for VersionPart global;
 
@@ -17,9 +18,17 @@ function versionPartEq(VersionPart a, VersionPart b) pure returns(bool isSame) {
 function versionPartNe(VersionPart a, VersionPart b) pure returns(bool isSame) { return VersionPart.unwrap(a) != VersionPart.unwrap(b); }
 
 library VersionPartLib {
+    function releaseMin() public pure returns (VersionPart) { return toVersionPart(3); }
+    function releaseMax() public pure returns (VersionPart) { return toVersionPart(99); }
+
+    function isValidRelease(VersionPart release) external pure returns(bool) { 
+        uint256 releaseInt = VersionPart.unwrap(release);
+        return 3 <= releaseInt && releaseInt <= 99; 
+    } 
+
     function eqz(VersionPart a) external pure returns(bool) { return VersionPart.unwrap(a) == 0; }
     function toInt(VersionPart a) external pure returns(uint256) { return VersionPart.unwrap(a); }
-    function toVersionPart(uint256 a) external pure returns(VersionPart) { return VersionPart.wrap(uint8(a)); }
+    function toVersionPart(uint256 a) public pure returns(VersionPart) { return VersionPart.wrap(uint8(a)); }
 }
 
 type Version is uint24; // contains major,minor,patch version parts
@@ -38,6 +47,7 @@ function versionGt(Version a, Version b) pure returns(bool isGreaterThan) { retu
 function versionEq(Version a, Version b) pure returns(bool isSame) { return Version.unwrap(a) == Version.unwrap(b); }
 
 library VersionLib {
+
     function toInt(Version version) external pure returns(uint) { return Version.unwrap(version); }
 
     function toUint64(Version version) external pure returns(uint64) { return Version.unwrap(version); }
@@ -75,9 +85,9 @@ library VersionLib {
         );
     }
 
-    function toVersionPart(uint256 versionPart) external pure returns(VersionPart) { 
-        return VersionPart.wrap(uint8(versionPart)); 
-    }
+    // function toVersionPart(uint256 versionPart) public pure returns(VersionPart) { 
+    //     return VersionPart.wrap(uint8(versionPart)); 
+    // }
 
     function toVersion(
         uint256 major,