@etherisc/gif-next 0.0.2-fd4931b-974 → 0.0.2-fd4ee14-428

package/contracts/staking/TargetManagerLib.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {Component} from "../shared/Component.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
@@ -22,11 +24,11 @@ library TargetManagerLib {
         Seconds lockingPeriod
     )
         external
+        view
         returns (
-            Key32 targetKey,
-            bytes memory targetData
+            Seconds oldLockingPeriod,
+            IStaking.TargetInfo memory targetInfo
         )
-
     {
         StakingReader reader = staking.getStakingReader();
 
@@ -37,11 +39,38 @@ library TargetManagerLib {
 
         checkLockingPeriod(targetNftId, lockingPeriod);
 
-        IStaking.TargetInfo memory info = reader.getTargetInfo(targetNftId);
-        info.lockingPeriod = lockingPeriod;
+        targetInfo = reader.getTargetInfo(targetNftId);
+        oldLockingPeriod = targetInfo.lockingPeriod;
+
+        targetInfo.lockingPeriod = lockingPeriod;
+    }
+
+
+    function updateRewardRate(
+        IStaking staking,
+        NftId targetNftId, 
+        UFixed rewardRate
+    )
+        external
+        view
+        returns (
+            UFixed oldRewardRate,
+            IStaking.TargetInfo memory targetInfo
+        )
+    {
+        StakingReader reader = staking.getStakingReader();
+
+        // check target exists
+        if(!reader.isTarget(targetNftId)) {
+            revert IStaking.ErrorStakingTargetNotFound(targetNftId);
+        }
+
+        checkRewardRate(targetNftId, rewardRate);
 
-        targetKey = toTargetKey(targetNftId);
-        targetData = abi.encode(info);
+        targetInfo = reader.getTargetInfo(targetNftId);
+        oldRewardRate = targetInfo.rewardRate;
+
+        targetInfo.rewardRate = rewardRate;
     }
 
 
@@ -54,6 +83,7 @@ library TargetManagerLib {
         UFixed initialRewardRate
     )
         external
+        view
     {
         // target nft id must not be zero
         if (targetNftId.eqz()) {
@@ -86,7 +116,11 @@ library TargetManagerLib {
     }
 
 
-    function isTargetTypeSupported(ObjectType objectType) public pure returns (bool isSupported) {
+    function isTargetTypeSupported(ObjectType objectType)
+        public 
+        pure 
+        returns (bool isSupported)
+    {
         if(objectType == PROTOCOL()) { return true; }
         if(objectType == INSTANCE()) { return true; }
 
@@ -94,7 +128,10 @@ library TargetManagerLib {
     }
 
 
-    function checkLockingPeriod(NftId targetNftId, Seconds lockingPeriod) internal view {
+    function checkLockingPeriod(NftId targetNftId, Seconds lockingPeriod)
+        public 
+        pure
+    {
         // check locking period is > 0
         if (lockingPeriod.eqz()) {
             revert IStaking.ErrorStakingLockingPeriodZero(targetNftId);
@@ -107,7 +144,10 @@ library TargetManagerLib {
     }
 
 
-    function checkRewardRate(NftId targetNftId, UFixed rewardRate) internal view {
+    function checkRewardRate(NftId targetNftId, UFixed rewardRate)
+        public
+        pure
+    {
         // check reward rate <= max reward rate
         if (rewardRate > getMaxRewardRate()) {
             revert IStaking.ErrorStakingRewardRateTooHigh(targetNftId, getMaxRewardRate(), rewardRate);
@@ -115,6 +155,32 @@ library TargetManagerLib {
     }
 
 
+    function calculateRequiredDipAmount(
+        Amount tokenAmount,
+        UFixed stakingRate
+    )
+        public
+        view
+        returns (Amount dipAmount)
+    {
+        dipAmount = tokenAmount.multiplyWith(stakingRate);
+    }
+
+
+    function calculateStakingRate(
+        IERC20Metadata dipToken,
+        IERC20Metadata token,
+        UFixed requiredDipPerToken
+    )
+        public
+        view
+        returns (UFixed stakingRate)
+    {
+        UFixed decimalsFactor = UFixedLib.toUFixed(1, int8(dipToken.decimals() - token.decimals()));
+        stakingRate = requiredDipPerToken * decimalsFactor;
+    }
+
+
     function getMaxLockingPeriod() public pure returns (Seconds maxLockingPeriod) {
         return SecondsLib.toSeconds(5 * 365 * 24 * 3600);
     }

package/contracts/type/AddressSet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 // based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol
 library LibAddressSet {

package/contracts/type/Amount.sol

@@ -17,7 +17,8 @@ using {
     AmountLib.gtz,
     AmountLib.toInt,
     AmountLib.add,
-    AmountLib.toUFixed
+    AmountLib.toUFixed,
+    AmountLib.multiplyWith
 } for Amount global;
 
 function addAmount(Amount a, Amount b) pure returns (Amount) {
@@ -86,6 +87,15 @@ library AmountLib {
         return Amount.unwrap(a1) > Amount.unwrap(a2);
     }
 
+    /// @dev return minimum of a1 and a2.
+    function min(Amount a1, Amount a2) public pure returns (Amount) {
+        if (Amount.unwrap(a1) < Amount.unwrap(a2)) {
+            return a1;
+        }
+
+        return a2;
+    }
+
     /// @dev return true if amount is larger than 0
     function gtz(Amount amount) public pure returns (bool) {
         return Amount.unwrap(amount) > 0;
@@ -107,6 +117,10 @@ library AmountLib {
         return UFixedLib.toUFixed(Amount.unwrap(amount));
     }
 
+    function multiplyWith(Amount amount, UFixed factor) public pure returns (Amount) {
+        return toAmount((factor * UFixedLib.toUFixed(Amount.unwrap(amount))).toInt());
+    }
+
     function _max() internal pure returns (uint96) {
         // IMPORTANT: type nees to match with actual definition for Amount
         return type(uint96).max;

package/contracts/type/Blocknumber.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 type Blocknumber is uint32;
 
@@ -10,7 +10,9 @@ using {
     lteBlocknumber as <=,
     eqBlocknumber as ==,
     neBlocknumber as !=,
-    BlocknumberLib.toInt
+    BlocknumberLib.toInt,
+    BlocknumberLib.eqz,
+    BlocknumberLib.gtz
 } for Blocknumber global;
 
 /// @dev return true if Blocknumber a is greater than Blocknumber b
@@ -69,6 +71,16 @@ library BlocknumberLib {
         return Blocknumber.wrap(uint32(block.number));
     }
 
+    /// @dev return true iff blocknumber is 0
+    function eqz(Blocknumber blocknumber) public pure returns (bool) {
+        return Blocknumber.unwrap(blocknumber) == 0;
+    }
+
+    /// @dev return true iff blocknumber is 0
+    function gtz(Blocknumber blocknumber) public pure returns (bool) {
+        return Blocknumber.unwrap(blocknumber) > 0;
+    }
+
     /// @dev return true if Blocknumber a is greater than Blocknumber b
     function gt(
         Blocknumber a,

package/contracts/type/Fee.sol

@@ -1,5 +1,5 @@
 // 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";

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";
@@ -20,16 +20,11 @@ using {
 
 // 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);
-}
-
-// @dev Converts the uint256 to a NftId.
-function toNftId(uint256 id) pure returns (NftId) {
-    return NftId.wrap(uint96(id));
+    return NftIdLib.ne(a, b);
 }
 
 // library functions that operate on user defined type
@@ -63,7 +58,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.

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

@@ -12,141 +12,140 @@ using {
     ObjectTypeLib.gtz
 } for ObjectType global;
 
-// general pure free functions
 
-function RELEASE() pure returns (ObjectType) {
-    return toObjectType(1);
-}
+//--- GIF object types/domains (rage: 1 - 99) -------------------------------//
 
 function PROTOCOL() pure returns (ObjectType) {
-    return toObjectType(10);
+    return ObjectType.wrap(1);
 }
 
-function ROLE() pure returns (ObjectType) {
-    return toObjectType(20);
+function REGISTRY() pure returns (ObjectType) {
+    return ObjectType.wrap(2);
 }
 
-function TARGET() pure returns (ObjectType) {
-    return toObjectType(30);
+function STAKING() pure returns (ObjectType) {
+    return ObjectType.wrap(3);
 }
 
-function REGISTRY() pure returns (ObjectType) {
-    return toObjectType(40);
+function TOKEN() pure returns (ObjectType) {
+    return ObjectType.wrap(6);
 }
 
-function STAKING() pure returns (ObjectType) {
-    return toObjectType(45);
+function RELEASE() pure returns (ObjectType) {
+    return ObjectType.wrap(7);
 }
 
-function TOKEN() pure returns (ObjectType) {
-    return toObjectType(50);
+function ROLE() pure returns (ObjectType) {
+    return ObjectType.wrap(8);
 }
 
 function SERVICE() pure returns (ObjectType) {
-    return toObjectType(60);
+    return ObjectType.wrap(9);
 }
 
 function INSTANCE() pure returns (ObjectType) {
-    return toObjectType(70);
-}
-
-function STAKE() pure returns (ObjectType) {
-    return toObjectType(80);
+    return ObjectType.wrap(10);
 }
 
 function COMPONENT() pure returns (ObjectType) {
-    return toObjectType(100);
+    return ObjectType.wrap(11);
 }
 
-function FEE() pure returns (ObjectType) {
-    return toObjectType(101);
+function PRODUCT() pure returns (ObjectType) {
+    return ObjectType.wrap(12);
 }
 
-function PRODUCT_SETUP() pure returns (ObjectType) {
-    return toObjectType(101);
+function ORACLE() pure returns (ObjectType) {
+    return ObjectType.wrap(13);
 }
 
-function PRODUCT() pure returns (ObjectType) {
-    return toObjectType(110);
+function DISTRIBUTION() pure returns (ObjectType) {
+    return ObjectType.wrap(14);
 }
 
-function DISTRIBUTION() pure returns (ObjectType) {
-    return toObjectType(120);
+function POOL() pure returns (ObjectType) {
+    return ObjectType.wrap(15);
 }
 
-function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
-    return toObjectType(121);
+function APPLICATION() pure returns (ObjectType) {
+    return ObjectType.wrap(20);
 }
 
-function DISTRIBUTOR() pure returns (ObjectType) {
-    return toObjectType(122);
+function POLICY() pure returns (ObjectType) {
+    return ObjectType.wrap(21);
 }
 
-function REFERRAL() pure returns (ObjectType) {
-    return toObjectType(123);
+function CLAIM() pure returns (ObjectType) {
+    return ObjectType.wrap(22);
 }
 
-function ORACLE() pure returns (ObjectType) {
-    return toObjectType(130);
+function PAYOUT() pure returns (ObjectType) {
+    return ObjectType.wrap(23); 
 }
 
-function POOL() pure returns (ObjectType) {
-    return toObjectType(140);
+function RISK() pure returns (ObjectType) {
+    return ObjectType.wrap(24);
 }
 
-function BUNDLE() pure returns (ObjectType) {
-    return toObjectType(220);
+function PRICE() pure returns (ObjectType) {
+    return ObjectType.wrap(25);
 }
 
-function RISK() pure returns (ObjectType) {
-    return toObjectType(200);
+function REQUEST() pure returns (ObjectType) {
+    return ObjectType.wrap(26);
 }
 
-function APPLICATION() pure returns (ObjectType) {
-    return toObjectType(210);
+function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
+    return ObjectType.wrap(27);
 }
 
-function POLICY() pure returns (ObjectType) {
-    return toObjectType(211);
+function DISTRIBUTOR() pure returns (ObjectType) {
+    return ObjectType.wrap(28);
 }
 
-function CLAIM() pure returns (ObjectType) {
-    return toObjectType(212);
+function REFERRAL() pure returns (ObjectType) {
+    return ObjectType.wrap(29);
 }
 
-function PAYOUT() pure returns (ObjectType) {
-    return toObjectType(213); 
+function BUNDLE() pure returns (ObjectType) {
+    return ObjectType.wrap(30);
 }
 
-function PRICE() pure returns (ObjectType) {
-    return toObjectType(230);
+function TARGET() pure returns (ObjectType) {
+    return ObjectType.wrap(31);
 }
 
-/// @dev Converts the uint8 to a ObjectType.
-function toObjectType(uint256 objectType) pure returns (ObjectType) {
-    return ObjectType.wrap(uint8(objectType));
+function STAKE() pure returns (ObjectType) {
+    return ObjectType.wrap(32);
 }
 
-// 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));
@@ -164,6 +163,79 @@ 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 == 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))));
+    }
+
+    /// @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/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";

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/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";