@etherisc/gif-next 0.0.2-8b116c2-371 → 0.0.2-8c1d8cd-727

package/contracts/staking/Staking.sol

@@ -1,30 +1,28 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount, AmountLib} from "../type/Amount.sol";
-import {ChainNft} from "../registry/ChainNft.sol";
-import {Component} from "../shared/Component.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryService} from "../registry/IRegistryService.sol";
 import {IStaking} from "./IStaking.sol";
-import {IVersionable} from "../shared/IVersionable.sol";
-import {Key32} from "../type/Key32.sol";
-import {KEEP_STATE} from "../type/StateId.sol";
-import {LibNftIdSet} from "../type/NftIdSet.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
-import {NftIdSetManager} from "../shared/NftIdSetManager.sol";
-import {ObjectType, INSTANCE, PROTOCOL, STAKE, STAKING, TARGET} from "../type/ObjectType.sol";
-import {Seconds, SecondsLib} from "../type/Seconds.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {Component} from "../shared/Component.sol";
+import {IComponent} from "../shared/IComponent.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, STAKING} from "../type/ObjectType.sol";
+import {Seconds} from "../type/Seconds.sol";
 import {StakeManagerLib} from "./StakeManagerLib.sol";
 import {StakingReader} from "./StakingReader.sol";
 import {StakingStore} from "./StakingStore.sol";
 import {TargetManagerLib} from "./TargetManagerLib.sol";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
+import {TokenHandlerDeployerLib} from "../shared/TokenHandlerDeployerLib.sol";
 import {TokenRegistry} from "../registry/TokenRegistry.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
+import {UFixed} from "../type/UFixed.sol";
 import {Version, VersionLib} from "../type/Version.sol";
-import {Versionable} from "../shared/Versionable.sol";
+import {Versionable} from "../upgradeability/Versionable.sol";
 
 contract Staking is 
     Component,
@@ -32,7 +30,6 @@ contract Staking is
     IStaking
 {
     string public constant CONTRACT_NAME = "Staking";
-    uint8 private constant GIF_MAJOR_VERSION = 3;
 
     // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.component.Staking.sol")) - 1)) & ~bytes32(uint256(0xff));
     bytes32 public constant STAKING_LOCATION_V1 = 0xafe8d4462b2ed26a47154f4b8f6d1497d2f772496965791d25bd456e342b7f00;
@@ -40,6 +37,7 @@ contract Staking is
     struct StakingStorage {
         IRegistryService _registryService;
         TokenRegistry _tokenRegistry;
+        TokenHandler _tokenHandler;
         StakingStore _store;
         StakingReader _reader;
         NftId _protocolNftId;
@@ -55,28 +53,17 @@ contract Staking is
 
 
     modifier onlyTarget(NftId targetNftId) {
-        if (!_getStakingStorage()._store.getTargetManager().exists(targetNftId)) {
+        if (!_getStakingStorage()._store.getTargetNftIdSet().exists(targetNftId)) {
             revert ErrorStakingNotTarget(targetNftId);
         }
         _;
     }
 
-
-    // from Versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
-    }
-
     // set/update staking reader
     function setStakingReader(StakingReader stakingReader)
         external
         virtual
-        onlyOwner
+        onlyOwner()
     {
         if(stakingReader.getStaking() != IStaking(this)) {
             revert ErrorStakingStakingReaderStakingMismatch(address(stakingReader.getStaking()));
@@ -90,7 +77,7 @@ contract Staking is
     function setStakingRate(uint256 chainId, address token, UFixed stakingRate)
         external
         virtual
-        onlyOwner
+        onlyOwner()
     {
         StakingStorage storage $ = _getStakingStorage();
         
@@ -104,8 +91,6 @@ contract Staking is
         emit LogStakingStakingRateSet(chainId, token, oldStakingRate, stakingRate);
     }
 
-    // reward management 
-
     // target management
 
     function registerTarget(
@@ -117,7 +102,7 @@ contract Staking is
     )
         external
         virtual
-        // restricted // staking service access
+        restricted()
     {
         TargetManagerLib.checkTargetParameters(
             getRegistry(), 
@@ -143,7 +128,7 @@ contract Staking is
     )
         external
         virtual
-        // TODO add restricted // only staking service
+        restricted()
         onlyTarget(targetNftId)
     {
         (
@@ -165,7 +150,7 @@ contract Staking is
     function setRewardRate(NftId targetNftId, UFixed rewardRate)
         external
         virtual
-        // TODO add restricted // only staking service
+        restricted()
         onlyTarget(targetNftId)
     {
         (
@@ -185,7 +170,7 @@ contract Staking is
     function refillRewardReserves(NftId targetNftId, Amount dipAmount)
         external
         virtual
-        // TODO add restricted // only for target locking
+        restricted()
         returns (Amount newBalance)
     {
         // update book keeping of reward reserves
@@ -197,8 +182,7 @@ contract Staking is
     function withdrawRewardReserves(NftId targetNftId, Amount dipAmount)
         external
         virtual
-        // TODO add restricted // only staking service
-        // onlyNftOwner(targetNftId)
+        restricted()
         returns (Amount newBalance)
     {
         // update book keeping of reward reserves
@@ -210,7 +194,7 @@ contract Staking is
     function increaseTotalValueLocked(NftId targetNftId, address token, Amount amount)
         external
         virtual
-        // restricted() // only pool service
+        restricted() // only pool service
         returns (Amount newBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
@@ -223,7 +207,7 @@ contract Staking is
     function decreaseTotalValueLocked(NftId targetNftId, address token, Amount amount)
         external
         virtual
-        // restricted() // only pool service
+        restricted() // only pool service
         returns (Amount newBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
@@ -236,6 +220,7 @@ contract Staking is
     function registerRemoteTarget(NftId targetNftId, TargetInfo memory targetInfo)
         external
         virtual
+        restricted()
         onlyOwner // or CCIP
     {
         
@@ -244,6 +229,7 @@ contract Staking is
     function updateRemoteTvl(NftId targetNftId, address token, Amount amount)
         external
         virtual
+        restricted()
         onlyOwner // or CCIP
     {
         
@@ -258,7 +244,7 @@ contract Staking is
     )
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
     {
         StakingStorage storage $ = _getStakingStorage();
         Timestamp lockedUntil = StakeManagerLib.checkCreateParameters(
@@ -286,51 +272,17 @@ contract Staking is
     )
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
         returns (Amount stakeBalance)
     {
         StakingStorage storage $ = _getStakingStorage();
-
-        // check that target is active for staking
-        (
-            UFixed rewardRate,
-            Seconds lockingPeriod
-        ) = StakeManagerLib.checkStakeParameters(
-            $._reader, 
-            stakeNftId);        
-
-        // calculate new rewards (if any)
-        (
-            Amount rewardIncrementAmount, 
-            Amount currentTotalDipAmount
-        ) = StakeManagerLib.calculateRewardIncrease(
-            $._reader, 
+        stakeBalance = StakeManagerLib.stake(
+            getRegistry(),
+            $._reader,
+            $._store,
             stakeNftId,
-            rewardRate);
-
-        stakeBalance = currentTotalDipAmount + stakeAmount;
-
-        // TODO check that additional dip, rewards and rewards increment 
-        // are still ok with max target staking amount
-        NftId targetNftId = getRegistry().getObjectInfo(stakeNftId).parentNftId;
-
-        $._store.restakeRewards(
-            stakeNftId, 
-            targetNftId, 
-            rewardIncrementAmount);
-
-        $._store.increaseStake(
-            stakeNftId, 
-            targetNftId, 
             stakeAmount);
-
-        // update locked until with target locking period
-        $._store.update(
-            stakeNftId, 
-            StakeInfo({
-                lockedUntil: TimestampLib.blockTimestamp().addSeconds(
-                    lockingPeriod)}));
     }
 
 
@@ -340,7 +292,7 @@ contract Staking is
     )
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
         returns (NftId newStakeNftId)
     {
@@ -348,13 +300,13 @@ contract Staking is
         StakingStorage storage $ = _getStakingStorage();
 
         // TODO implement
-   }
+    }
 
 
     function updateRewards(NftId stakeNftId)
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
     {
         StakingStorage storage $ = _getStakingStorage();
@@ -365,7 +317,7 @@ contract Staking is
     function claimRewards(NftId stakeNftId)
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
         returns (
             Amount rewardsClaimedAmount
@@ -390,16 +342,17 @@ contract Staking is
     function unstake(NftId stakeNftId)
         external
         virtual
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
         onlyStake(stakeNftId)
         returns (
             Amount unstakedAmount,
             Amount rewardsClaimedAmount
         )
     {
-        // TODO add check that stake locking is in the past
         StakingStorage storage $ = _getStakingStorage();
-
+        
+        StakeManagerLib.checkUnstakeParameters($._reader, stakeNftId);
+        
         // update rewards since last update
         NftId targetNftId = _updateRewards($._reader, $._store, stakeNftId);
 
@@ -419,63 +372,21 @@ contract Staking is
 
 
 
-    function _updateRewards(
-        StakingReader reader,
-        StakingStore store,
-        NftId stakeNftId
-    )
-        internal
-        virtual
-        returns (NftId targetNftId)
-    {
-        UFixed rewardRate;
-
-        (targetNftId, rewardRate) = reader.getTargetRewardRate(stakeNftId);
-        (Amount rewardIncrement, ) = StakeManagerLib.calculateRewardIncrease(
-            reader, 
-            stakeNftId,
-            rewardRate);
-
-        store.updateRewards(
-            stakeNftId, 
-            targetNftId,
-            rewardIncrement);
-    }
-
-
     //--- other functions ---------------------------------------------------//
 
     function collectDipAmount(address from, Amount dipAmount)
         external
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
     {
-        TokenHandler tokenHandler = getTokenHandler();
-        address stakingWallet = getWallet();
-
-        StakeManagerLib.checkDipBalanceAndAllowance(
-            getToken(), 
-            from, 
-            address(tokenHandler), 
-            dipAmount);
-
-        tokenHandler.transfer(from, stakingWallet, dipAmount);
+        getTokenHandler().collectTokens(from, getWallet(), dipAmount);
     }
 
 
     function transferDipAmount(address to, Amount dipAmount)
         external
-        // TODO add restricted() // only staking service
+        restricted() // only staking service
     {
-        TokenHandler tokenHandler = getTokenHandler();
-        address stakingWallet = getWallet();
-
-        StakeManagerLib.checkDipBalanceAndAllowance(
-            getToken(), 
-            stakingWallet, 
-            address(tokenHandler), 
-            dipAmount);
-
-        tokenHandler.transfer(stakingWallet, to, dipAmount);
+        getTokenHandler().distributeTokens(getWallet(), to, dipAmount);
     }
 
 
@@ -493,15 +404,53 @@ contract Staking is
         return address(_getStakingStorage()._tokenRegistry);
     }
 
+    function getTokenHandler() public virtual override(Component, IComponent) view returns (TokenHandler tokenHandler) {
+        return _getStakingStorage()._tokenHandler;
+    }
+
+    // from Versionable
+    function getVersion()
+        public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(GIF_RELEASE,0,0);
+    }
+
     //--- internal functions ------------------------------------------------//
 
+    function _updateRewards(
+        StakingReader reader,
+        StakingStore store,
+        NftId stakeNftId
+    )
+        internal
+        virtual
+        returns (NftId targetNftId)
+    {
+        UFixed rewardRate;
+
+        (targetNftId, rewardRate) = reader.getTargetRewardRate(stakeNftId);
+        (Amount rewardIncrement, ) = StakeManagerLib.calculateRewardIncrease(
+            reader, 
+            stakeNftId,
+            rewardRate);
+
+        store.updateRewards(
+            stakeNftId, 
+            targetNftId,
+            rewardIncrement);
+    }
+
+
     function _initialize(
         address owner, 
         bytes memory data
     )
         internal
         virtual override
-        initializer
+        initializer()
     {
         (
             address registryAddress,
@@ -516,10 +465,10 @@ contract Staking is
         TokenRegistry tokenRegistry = TokenRegistry(tokenRegistryAddress);
         address dipTokenAddress = tokenRegistry.getDipTokenAddress();
 
-        initializeComponent(
+        _initializeComponent(
             authority,
             registryAddress, 
-            registry.getNftId(), 
+            registry.getNftId(), // parent nft id
             CONTRACT_NAME,
             dipTokenAddress,
             STAKING(), 
@@ -528,17 +477,15 @@ contract Staking is
             "", // registry data
             ""); // component data
 
-        _createAndSetTokenHandler();
-
-
         // wiring to external contracts
         StakingStorage storage $ = _getStakingStorage();
         $._protocolNftId = getRegistry().getProtocolNftId();
         $._store = StakingStore(stakingStoreAddress);
         $._reader = StakingStore(stakingStoreAddress).getStakingReader();
         $._tokenRegistry = TokenRegistry(tokenRegistryAddress);
+        $._tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(dipTokenAddress, authority);
 
-        registerInterface(type(IStaking).interfaceId);
+        _registerInterface(type(IStaking).interfaceId);
     }
 
 
@@ -547,5 +494,4 @@ contract Staking is
             $.slot := STAKING_LOCATION_V1
         }
     }
-
 }

package/contracts/staking/StakingLifecycle.sol

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {TARGET, COMPONENT, STAKE} from "../type/ObjectType.sol";
+import {INITIAL} from "../type/StateId.sol";
+import {Lifecycle} from "../shared/Lifecycle.sol";
+
+contract StakingLifecycle is
+    Lifecycle
+{
+    constructor() {
+        _setupLifecycle();
+    }
+
+    function _setupLifecycle()
+        internal
+        override
+    {
+        setInitialState(TARGET(), INITIAL());
+        setInitialState(COMPONENT(), INITIAL());
+        setInitialState(STAKE(), INITIAL());
+    }
+}

package/contracts/staking/StakingManager.sol

@@ -1,14 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
-import {ReleaseManager} from "../registry/ReleaseManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {Staking} from "./Staking.sol";
-import {StakingReader} from "./StakingReader.sol";
-import {StakingStore} from "./StakingStore.sol";
 
-import {RegistryAdmin} from "../registry/RegistryAdmin.sol";
 
 contract StakingManager is
     ProxyManager
@@ -22,9 +18,9 @@ contract StakingManager is
         address registry,
         address tokenRegistry,
         address stakingStore,
-        address initialOwner
+        address initialOwner,
+        bytes32 salt
     )
-        ProxyManager(registry)
     {
         Staking stakingImplementation = new Staking();
 
@@ -34,10 +30,12 @@ contract StakingManager is
             tokenRegistry,
             stakingStore,
             initialOwner);
-
-        IVersionable versionable = deploy(
-            _initialImplementation, 
-            _initializationData);
+        
+        IVersionable versionable = initialize(
+            registry,
+            _initialImplementation,
+            _initializationData,
+            salt);
 
         _staking = Staking(address(versionable));
     }

package/contracts/staking/StakingReader.sol

@@ -1,35 +1,34 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount} from "../type/Amount.sol";
-import {Blocknumber}  from "../type/Blocknumber.sol";
-import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
-import {IComponent} from "../shared/IComponent.sol";
-import {InitializableCustom} from "../shared/InitializableCustom.sol";
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
+
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryLinked} from "../shared/IRegistryLinked.sol";
 import {IStaking} from "../staking/IStaking.sol";
-import {IVersionable} from "../shared/IVersionable.sol";
+
+import {Amount} from "../type/Amount.sol";
+import {Blocknumber}  from "../type/Blocknumber.sol";
 import {NftId} from "../type/NftId.sol";
-import {NftIdSetManager} from "../shared/NftIdSetManager.sol";
-import {ObjectType, STAKE, TARGET} from "../type/ObjectType.sol";
-import {Seconds} from "../type/Seconds.sol";
+import {STAKE, TARGET} from "../type/ObjectType.sol";
 import {StakingStore} from "./StakingStore.sol";
 import {Timestamp} from "../type/Timestamp.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
+import {UFixed} from "../type/UFixed.sol";
 
 contract StakingReader is
     IRegistryLinked,
-    InitializableCustom
+    Initializable
 {
 
-    error ErrorStakingReaderDependenciesAlreadySet();
+    error ErrorStakingReaderUnauthorizedCaler();
 
+    address private _initializeOwner;
     IRegistry private _registry;
     IStaking private _staking;
     StakingStore private _store;
 
-    constructor(IRegistry registry, address initialOwner) InitializableCustom(initialOwner) {
+    constructor(IRegistry registry) {
+        _initializeOwner = msg.sender;
         _registry = registry;
     }
 
@@ -38,8 +37,12 @@ contract StakingReader is
         address stakingStoreAddress
     )
         external
-        initializer
+        initializer()
     {
+        if (msg.sender != _initializeOwner) {
+            revert ErrorStakingReaderUnauthorizedCaler();
+        }
+
         _staking = IStaking(stakingAddress);
         _store = StakingStore(stakingStoreAddress);
     }
@@ -60,32 +63,32 @@ contract StakingReader is
 
 
     function isTarget(NftId targetNftId) external view returns (bool) {
-        return _store.getTargetManager().exists(targetNftId);
+        return _store.getTargetNftIdSet().exists(targetNftId);
     }
 
 
     function targets() external view returns (uint256) {
-        return _store.getTargetManager().nftIds();
+        return _store.getTargetNftIdSet().nftIds();
     }
 
 
     function getTargetNftId(uint256 idx) external view returns (NftId) {
-        return _store.getTargetManager().getNftId(idx);
+        return _store.getTargetNftIdSet().getNftId(idx);
     }
 
 
     function isActive(NftId targetNftId) external view returns (bool) {
-        return _store.getTargetManager().isActive(targetNftId);
+        return _store.getTargetNftIdSet().isActive(targetNftId);
     }
 
 
     function activeTargets() external view returns (uint256) {
-        return _store.getTargetManager().activeNftIds();
+        return _store.getTargetNftIdSet().activeNftIds();
     }
 
 
     function getActiveTargetNftId(uint256 idx) external view returns (NftId) {
-        return _store.getTargetManager().getActiveNftId(idx);
+        return _store.getTargetNftIdSet().getActiveNftId(idx);
     }