@etherisc/gif-next 0.0.2-8c1d8cd-727 → 0.0.2-8c6c3ef-628

package/contracts/staking/StakingService.sol

@@ -32,6 +32,28 @@ contract StakingService is
         TokenHandler _tokenHandler;
     }
 
+
+    modifier onlyStaking() {
+        if (msg.sender != address(_getStakingServiceStorage()._staking)) {
+            revert ErrorStakingServiceNotStaking(msg.sender);
+        }
+        _;
+    }
+
+
+    function approveTokenHandler(
+        IERC20Metadata token,
+        Amount amount
+    )
+        external
+        virtual
+        onlyStaking()
+    {
+        _getStakingServiceStorage()._tokenHandler.approve(
+            token, amount);
+    }
+
+
     function createInstanceTarget(
         NftId targetNftId,
         Seconds initialLockingPeriod,
@@ -58,6 +80,7 @@ contract StakingService is
         virtual
         restricted()
     {
+        _checkNftType(instanceNftId, INSTANCE());
         _getStakingServiceStorage()._staking.setLockingPeriod(
             instanceNftId, 
             lockingPeriod);
@@ -69,11 +92,23 @@ contract StakingService is
         virtual
         restricted()
     {
+        _checkNftType(instanceNftId, INSTANCE());
         _getStakingServiceStorage()._staking.setRewardRate(
             instanceNftId, 
             rewardRate);
     }
 
+    function setInstanceMaxStakedAmount(NftId instanceNftId, Amount maxStakingAmount)
+        external
+        virtual
+        restricted()
+    {
+        _checkNftType(instanceNftId, INSTANCE());
+        _getStakingServiceStorage()._staking.setMaxStakedAmount(
+            instanceNftId, 
+            maxStakingAmount);
+    }
+
 
     function refillInstanceRewardReserves(NftId instanceNftId, address rewardProvider, Amount dipAmount)
         external
@@ -81,6 +116,7 @@ contract StakingService is
         restricted()
         returns (Amount newBalance)
     {
+        _checkNftType(instanceNftId, INSTANCE());
         return _refillRewardReserves(instanceNftId, rewardProvider, dipAmount);
     }
 
@@ -102,6 +138,7 @@ contract StakingService is
         restricted()
         returns (Amount newBalance)
     {
+        _checkNftType(instanceNftId, INSTANCE());
         // update reward reserve book keeping
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         newBalance = $._staking.withdrawRewardReserves(instanceNftId, dipAmount);
@@ -109,7 +146,7 @@ contract StakingService is
         // transfer withdrawal amount to target owner
         address instanceOwner = getRegistry().ownerOf(instanceNftId);
         emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
-        $._staking.transferDipAmount(
+        $._tokenHandler.pushToken(
             instanceOwner,
             dipAmount);
     }
@@ -157,8 +194,8 @@ contract StakingService is
         emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
 
         // collect staked dip by staking
-        $._staking.collectDipAmount(
-            stakeOwner,
+        $._tokenHandler.pullToken(
+            stakeOwner, 
             dipAmount);
     }
 
@@ -172,6 +209,8 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         address stakeOwner = msg.sender;
 
@@ -183,7 +222,7 @@ contract StakingService is
         // collect staked dip by staking
         if (dipAmount.gtz()) {
             emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
-            $._staking.collectDipAmount(
+        $._tokenHandler.pullToken(
                 stakeOwner,
                 dipAmount);
         }
@@ -199,11 +238,36 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
         returns (
-            NftId newStakeNftId
+            NftId newStakeNftId,
+            Amount newStakeBalance
         )
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
-        // TODO implement
+        address stakeOwner = msg.sender;
+
+        if (! getRegistry().isRegistered(newTargetNftId)) {
+            revert ErrorStakingServiceTargetUnknown(newTargetNftId);
+        }
+
+        // register new stake object with registry
+        newStakeNftId = $._registryService.registerStake(
+            IRegistry.ObjectInfo({
+                nftId: NftIdLib.zero(),
+                parentNftId: newTargetNftId,
+                objectType: STAKE(),
+                isInterceptor: false,
+                objectAddress: address(0),
+                initialOwner: stakeOwner,
+                data: ""
+            }));
+
+        newStakeBalance = $._staking.restake(
+            stakeNftId, 
+            newStakeNftId);
+
+        emit LogStakingServiceStakeRestaked(stakeOwner, stakeNftId, newStakeNftId, newTargetNftId, newStakeBalance);
     } 
 
 
@@ -214,6 +278,8 @@ contract StakingService is
         virtual
         restricted()
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._staking.updateRewards(stakeNftId);
 
@@ -227,12 +293,14 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
     {
+        _checkNftType(stakeNftId, STAKE());
+
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         address stakeOwner = msg.sender;
 
         Amount rewardsClaimedAmount = $._staking.claimRewards(stakeNftId);
         emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
-        $._staking.transferDipAmount(
+        $._tokenHandler.pushToken(
             stakeOwner,
             rewardsClaimedAmount);
     }
@@ -244,6 +312,8 @@ contract StakingService is
         restricted()
         onlyNftOwner(stakeNftId)
     {
+        _checkNftType(stakeNftId, STAKE());
+        
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         address stakeOwner = msg.sender;
 
@@ -254,8 +324,9 @@ contract StakingService is
 
         Amount totalAmount = unstakedAmount + rewardsClaimedAmount;
         emit LogStakingServiceUnstaked(stakeNftId, stakeOwner, totalAmount);
-        $._staking.transferDipAmount(
-            stakeOwner,
+
+        $._tokenHandler.pushToken(
+            stakeOwner, 
             totalAmount);
     }
 
@@ -277,6 +348,7 @@ contract StakingService is
 
     function getDipToken()
         external
+        view
         virtual
         returns (IERC20Metadata dip)
     {
@@ -286,6 +358,7 @@ contract StakingService is
 
     function getTokenHandler()
         external
+        view
         virtual
         returns (TokenHandler tokenHandler)
     {
@@ -295,6 +368,7 @@ contract StakingService is
 
     function getStaking()
         external
+        view
         virtual
         returns (IStaking staking)
     {
@@ -313,15 +387,15 @@ contract StakingService is
     {
         (
             address authority,
-            address registryAddress,
-            address stakingAddress
+            address registry,
+            address staking
         ) = abi.decode(data, (address, address, address));
 
-        _initializeService(registryAddress, authority, owner);
+        __Service_init(authority, registry, owner);
 
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         $._registryService = RegistryService(_getServiceAddress(REGISTRY()));
-        $._staking = _registerStaking(stakingAddress);
+        $._staking = _registerStaking(staking);
         $._dip = $._staking.getToken();
         $._tokenHandler = $._staking.getTokenHandler();
 
@@ -374,7 +448,7 @@ contract StakingService is
         emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
 
         // collect reward dip from provider
-        $._staking.collectDipAmount(
+        $._tokenHandler.pullToken(
             rewardProvider,
             dipAmount);
     }

package/contracts/staking/StakingServiceManager.sol

@@ -15,17 +15,18 @@ contract StakingServiceManager is
     /// @dev initializes proxy manager with service implementation 
     constructor(
         address authority,
-        address registryAddress,
+        address registry,
         bytes32 salt
     )
     {
         StakingService svc = new StakingService();
         bytes memory data = abi.encode(
             authority, 
-            registryAddress, 
-            IRegistry(registryAddress).getStakingAddress());
+            registry, 
+            IRegistry(registry).getStakingAddress());
+
         IVersionable versionable = initialize(
-            registryAddress,
+            registry,
             address(svc), 
             data,
             salt);

package/contracts/staking/StakingStore.sol

@@ -91,7 +91,8 @@ contract StakingStore is
                 objectType: PROTOCOL(),
                 chainId: 1,
                 lockingPeriod: TargetManagerLib.getDefaultLockingPeriod(),
-                rewardRate: TargetManagerLib.getDefaultRewardRate()}));
+                rewardRate: TargetManagerLib.getDefaultRewardRate(),
+                maxStakedAmount: AmountLib.max()}));
     }
 
 

package/contracts/type/Fee.sol

@@ -5,16 +5,16 @@ import {Amount, AmountLib} from "./Amount.sol";
 import {UFixed, UFixedLib} from "./UFixed.sol";
 
 struct Fee {
+    // slot 0
     UFixed fractionalFee;
-    // TODO migrate fixed fee to Amount
-    uint256 fixedFee;
+    Amount fixedFee;
 }
 
 library FeeLib {
 
     /// @dev Return a zero fee struct (0, 0)
     function zero() public pure returns (Fee memory fee) {
-        return Fee(UFixed.wrap(0), 0);
+        return Fee(UFixed.wrap(0), AmountLib.zero());
     }
 
     /// @dev Converts the uint256 to a fee struct.
@@ -22,7 +22,7 @@ library FeeLib {
         UFixed fractionalFee,
         uint256 fixedFee
     ) public pure returns (Fee memory fee) {
-        return Fee(fractionalFee, fixedFee);
+        return Fee(fractionalFee, AmountLib.toAmount(fixedFee));
     }
 
     /// @dev Calculates fee and net amounts for the provided parameters
@@ -41,14 +41,14 @@ library FeeLib {
         if(gtz(fee)) {
             UFixed fractionalAmount = 
                 amount.toUFixed() * fee.fractionalFee;
-            feeAmount = AmountLib.toAmount(fractionalAmount.toInt() + fee.fixedFee);
+            feeAmount = AmountLib.toAmount(fractionalAmount.toInt()) + fee.fixedFee;
             netAmount = netAmount - feeAmount;
         }
     }
 
     /// @dev Return the percent fee struct (x%, 0)
     function percentageFee(uint8 percent) public pure returns (Fee memory fee) {
-        return Fee(UFixedLib.toUFixed(percent, -2), 0);
+        return Fee(UFixedLib.toUFixed(percent, -2), AmountLib.zero());
     }
 
     // pure free functions for operators
@@ -57,10 +57,10 @@ library FeeLib {
     }
 
     function gtz(Fee memory fee) public pure returns (bool) {
-        return UFixed.unwrap(fee.fractionalFee) > 0 || fee.fixedFee > 0;
+        return UFixed.unwrap(fee.fractionalFee) > 0 || fee.fixedFee.gtz();
     }
 
     function eqz(Fee memory fee) public pure returns (bool) {
-        return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
+        return fee.fixedFee.eqz() && UFixed.unwrap(fee.fractionalFee) == 0;
     }
 }

package/contracts/type/Key32.sol

@@ -28,8 +28,8 @@ 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
+    bytes32 public constant TYPE_MASK = bytes32(bytes1(type(uint8).max)); // [32] byte in bytes32
+    bytes32 public constant ID_MASK = bytes32(~TYPE_MASK); // [0..31] bytes in bytes32
 
     function toKey32(ObjectType objectType, KeyId id) public pure returns (Key32) {
         uint256 uintObjectType = ObjectType.unwrap(objectType);

package/contracts/type/Key32Set.sol

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

package/contracts/type/NftId.sol

@@ -76,4 +76,10 @@ library NftIdLib {
     function toKeyId(NftId id) public pure returns (KeyId keyId) {
         return KeyId.wrap(bytes31(uint248(NftId.unwrap(id))));
     }
+
+    function toNftId(KeyId keyId) public pure returns (NftId nftId) {
+       uint248 keyIdInt = uint248(bytes31(KeyId.unwrap(keyId)));
+       assert(keyIdInt < type(uint96).max);
+       return NftId.wrap(uint96(keyIdInt));
+    }
 }

package/contracts/type/ObjectType.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {VersionPart} from "./Version.sol";
+
 type ObjectType is uint8;
 
 // type bindings
@@ -44,10 +46,16 @@ function INSTANCE() pure returns (ObjectType) {
     return ObjectType.wrap(10);
 }
 
+/// @dev Generic component object type.
+/// Component role id range is 11-19.
+/// Stick to this range for new component object types.
 function COMPONENT() pure returns (ObjectType) {
     return ObjectType.wrap(11);
 }
 
+/// @dev Product object type.
+/// IMPORTANT the actual value has an influence on the corresponding role id (RoleIdLib.sol). 
+/// Do not change this value without updating the corresponding role id calculation.
 function PRODUCT() pure returns (ObjectType) {
     return ObjectType.wrap(12);
 }
@@ -64,6 +72,8 @@ function POOL() pure returns (ObjectType) {
     return ObjectType.wrap(15);
 }
 
+/// @dev Application object type.
+/// Range for NFT objects created thorugh components is 20-29.
 function APPLICATION() pure returns (ObjectType) {
     return ObjectType.wrap(20);
 }
@@ -72,54 +82,69 @@ function POLICY() pure returns (ObjectType) {
     return ObjectType.wrap(21);
 }
 
-function PREMIUM() pure returns (ObjectType) {
+function BUNDLE() pure returns (ObjectType) {
     return ObjectType.wrap(22);
 }
 
-function CLAIM() pure returns (ObjectType) {
+function DISTRIBUTOR() pure returns (ObjectType) {
     return ObjectType.wrap(23);
 }
 
-function PAYOUT() pure returns (ObjectType) {
-    return ObjectType.wrap(24); 
+/// @dev Stake object type.
+/// NFT object type is 30
+function STAKE() pure returns (ObjectType) {
+    return ObjectType.wrap(30);
 }
 
-function RISK() pure returns (ObjectType) {
-    return ObjectType.wrap(25);
+/// @dev Staking target object type.
+function TARGET() pure returns (ObjectType) {
+    return ObjectType.wrap(31);
+}
+
+/// @dev Accounting object type.
+/// Range for non-NFT types created through components is 40+
+function ACCOUNTING() pure returns (ObjectType) {
+    return ObjectType.wrap(40);
+}
+
+function FEE() pure returns (ObjectType) {
+    return ObjectType.wrap(41);
 }
 
 function PRICE() pure returns (ObjectType) {
-    return ObjectType.wrap(26);
+    return ObjectType.wrap(42);
 }
 
-function REQUEST() pure returns (ObjectType) {
-    return ObjectType.wrap(27);
+function PREMIUM() pure returns (ObjectType) {
+    return ObjectType.wrap(43);
 }
 
-function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
-    return ObjectType.wrap(28);
+function RISK() pure returns (ObjectType) {
+    return ObjectType.wrap(44);
 }
 
-function DISTRIBUTOR() pure returns (ObjectType) {
-    return ObjectType.wrap(29);
+function CLAIM() pure returns (ObjectType) {
+    return ObjectType.wrap(45);
 }
 
-function REFERRAL() pure returns (ObjectType) {
-    return ObjectType.wrap(30);
+function PAYOUT() pure returns (ObjectType) {
+    return ObjectType.wrap(46); 
 }
 
-function BUNDLE() pure returns (ObjectType) {
-    return ObjectType.wrap(31);
+function REQUEST() pure returns (ObjectType) {
+    return ObjectType.wrap(47);
 }
 
-function TARGET() pure returns (ObjectType) {
-    return ObjectType.wrap(32);
+function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
+    return ObjectType.wrap(48);
 }
 
-function STAKE() pure returns (ObjectType) {
-    return ObjectType.wrap(33);
+function REFERRAL() pure returns (ObjectType) {
+    return ObjectType.wrap(49);
 }
 
+
+
 /// @dev Object type that includes any other object type.
 /// Note that eq()/'==' does not take this property into account.
 function ALL() pure returns (ObjectType) {
@@ -138,8 +163,6 @@ function neObjectType(ObjectType a, ObjectType b) pure returns (bool isSame) {
 // library functions that operate on user defined type
 library ObjectTypeLib {
 
-    error ErrorVersionTooBig(uint256 version);
-
     function zero() public pure returns (ObjectType) {
         return ObjectType.wrap(0);
     }
@@ -202,6 +225,10 @@ library ObjectTypeLib {
             return "Price";
         } else if (objectType == BUNDLE()) {
             return "Bundle";
+        } else if (objectType == RISK()) {
+            return "Risk";
+        } else if (objectType == ACCOUNTING()) {
+            return "Accounting";
         }
 
         // fallback: ObjectType<obect-type-int>
@@ -215,19 +242,15 @@ library ObjectTypeLib {
     function toVersionedName(
         string memory name, 
         string memory suffix, 
-        uint256 version
+        VersionPart release
     )
         external
         pure
         returns (string memory versionedName)
     {
-        if (version > maxNumReleases()) {
-            revert ErrorVersionTooBig(version);
-        }
-
         string memory versionName = "_v0";
 
-        if (version >= 10) {
+        if (release.toInt() >= 10) {
             versionName = "_v";
         }
 
@@ -236,12 +259,7 @@ library ObjectTypeLib {
                 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;
+                release.toString()));
     }
 
     /// @dev returns the provied int as a string

package/contracts/type/RiskId.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {NftId} from "./NftId.sol";
 import {RISK} from "./ObjectType.sol";
 
 type RiskId is bytes8;
@@ -10,9 +11,12 @@ type RiskId is bytes8;
 using {
     eqRiskId as ==, 
     neRiskId as !=,
-    RiskIdLib.toKey32,
     RiskIdLib.eq,
-    RiskIdLib.eqz
+    RiskIdLib.eqz,
+    RiskIdLib.gtz,
+    RiskIdLib.toInt,
+    RiskIdLib.toKeyId,
+    RiskIdLib.toKey32
 } for RiskId global;
 
 // general pure free functions
@@ -32,14 +36,19 @@ library RiskIdLib {
         return RiskId.wrap(bytes8(0));
     }
 
-    // @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 Converts a risk id into a uint256.
+    function toInt(RiskId riskId) public pure returns (uint256) {
+        return uint64(RiskId.unwrap(riskId));
     }
 
-    /// @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 Converts a risk id string with a product NftId into a risk id.
+    function toRiskId(NftId productNftId, bytes32 risk) public pure returns (RiskId) {
+        return RiskId.wrap(bytes8(keccak256(abi.encode(productNftId, risk))));
+    }
+
+    /// @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
@@ -47,6 +56,11 @@ library RiskIdLib {
         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);
     }
@@ -54,4 +68,8 @@ library RiskIdLib {
     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;
+    }
 }