@etherisc/gif-next 0.0.2-fca9315-260 → 0.0.2-fd4931b-974

package/contracts/staking/Staking.sol

@@ -0,0 +1,348 @@
+// 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 {KeyValueStore} from "../shared/KeyValueStore.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 {StakingReader} from "./StakingReader.sol";
+import {TargetManagerLib} from "./TargetManagerLib.sol";
+import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
+import {TokenRegistry} from "../registry/TokenRegistry.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
+import {Version, VersionLib} from "../type/Version.sol";
+import {Versionable} from "../shared/Versionable.sol";
+
+// TODO split staking
+// candidate clusters
+// - strake management
+// - target management
+// - reward calculation
+// - read access
+contract Staking is 
+    KeyValueStore,
+    Component,
+    Versionable,
+    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;
+
+    struct StakingStorage {
+        IRegistryService _registryService;
+        TokenRegistry _tokenRegistry;
+        StakingReader _reader;
+
+        NftIdSetManager _targetManager;
+
+        mapping(uint256 chainId => mapping(address token => UFixed stakingRate)) _stakingRate;
+
+        mapping(NftId targetNftId => Amount stakedAmount) _stakedAmount;
+        mapping(NftId targetNftId => mapping(address token => Amount tvlAmount)) _tvlAmount;
+    }
+
+
+    modifier onlyNftOwner(NftId nftId) {
+        // TODO deal with special case protocol target (=owner = registry service owner)
+        if(msg.sender != getRegistry().ownerOf(nftId)) {
+            revert ErrorStakingNotNftOwner(nftId);
+        }
+        _;
+    }
+
+
+    // 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
+    {
+        if(stakingReader.getStaking() != IStaking(this)) {
+            revert ErrorStakingStakingReaderStakingMismatch(address(stakingReader.getStaking()));
+        }
+
+        _getStakingStorage()._reader = stakingReader;
+    }
+
+
+    // rate management 
+    function setStakingRate(uint256 chainId, address token, UFixed stakingRate)
+        external
+        virtual
+        onlyOwner
+    {
+
+    }
+
+    // reward management 
+    function setRewardRate(NftId targetNftId, UFixed rewardRate)
+        external
+        virtual
+        // onlyNftOwner(targetNftId)
+    {
+        
+    }
+
+    function refillRewardReserves(NftId targetNftId, Amount dipAmount)
+        external
+        virtual
+    {
+
+    }
+
+    function withdrawRewardReserves(NftId targetNftId, Amount dipAmount)
+        external
+        virtual
+        // onlyNftOwner(targetNftId)
+    {
+        
+    }
+
+    // target management
+
+    function registerTarget(
+        NftId targetNftId,
+        ObjectType expectedObjectType,
+        uint256 chainId,
+        Seconds initialLockingPeriod,
+        UFixed initialRewardRate
+    )
+        external
+        virtual
+        // restricted // staking service access
+    {
+        TargetManagerLib.checkTargetParameters(
+            getRegistry(), 
+            getStakingReader(),
+            targetNftId, 
+            expectedObjectType, 
+            initialLockingPeriod, 
+            initialRewardRate);
+
+        // record target info
+        _create(
+            targetNftId.toKey32(TARGET()),
+            abi.encode(
+                TargetInfo({
+                    objectType: expectedObjectType,
+                    chainId: chainId,
+                    lockingPeriod: initialLockingPeriod,
+                    rewardRate: initialRewardRate,
+                    rewardReserveAmount: AmountLib.zero()
+                })));
+
+        // add target nft id to all/active sets
+        _getStakingStorage()._targetManager.add(targetNftId);
+
+        emit LogStakingTargetAdded(targetNftId, expectedObjectType, chainId);
+    }
+
+
+    function setLockingPeriod(
+        NftId targetNftId, 
+        Seconds lockingPeriod
+    )
+        external
+        virtual
+        onlyNftOwner(targetNftId)
+    {
+        (
+            Key32 targetKey,
+            bytes memory targetData
+        ) = TargetManagerLib.updateLockingPeriod(
+            this,
+            targetNftId,
+            lockingPeriod);
+
+        _update(targetKey, targetData, KEEP_STATE());
+
+        emit LogStakingLockingPeriodSet(targetNftId, lockingPeriod);
+    }
+
+
+    function increaseTvl(NftId targetNftId, address token, Amount amount)
+        external
+        virtual
+        // restricted // service to service access
+    {
+
+    }
+
+    function decreaseTvl(NftId targetNftId, address token, Amount amount)
+        external
+        virtual
+        // restricted // service to service access
+    {
+
+    }
+
+
+    function registerRemoteTarget(NftId targetNftId, TargetInfo memory targetInfo)
+        external
+        virtual
+        onlyOwner // or CCIP
+    {
+        
+    }
+
+    function updateRemoteTvl(NftId targetNftId, address token, Amount amount)
+        external
+        virtual
+        onlyOwner // or CCIP
+    {
+        
+    }
+
+    // staking functions
+    function create(
+        NftId stakeNftId, 
+        NftId targetNftId, 
+        Amount dipAmount
+    )
+        external
+        virtual
+    {
+        Timestamp currentTime = TimestampLib.blockTimestamp();
+        Timestamp lockedUntil = currentTime.addSeconds(
+            _getStakingStorage()._reader.getTargetInfo(targetNftId).lockingPeriod);
+
+        _create(
+            stakeNftId.toKey32(STAKE()),
+            abi.encode(
+                StakeInfo({
+                    stakeAmount: dipAmount,
+                    rewardAmount: AmountLib.zero(),
+                    lockedUntil: lockedUntil,
+                    rewardsUpdatedAt: currentTime
+                })));
+    }
+
+
+    function stake(NftId stakeNftId, Amount dipAmount) external {}
+    function restakeRewards(NftId stakeNftId) external {}
+    function restakeToNewTarget(NftId stakeNftId, NftId newTarget) external {}
+    function unstake(NftId stakeNftId) external {}
+    function unstake(NftId stakeNftId, Amount dipAmount) external {}
+    function claimRewards(NftId stakeNftId) external {}
+
+
+    // view functions
+
+    function getStakingReader() public view returns (StakingReader reader) {
+        return _getStakingStorage()._reader;
+    }
+
+    function getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate) {
+        return _getStakingStorage()._stakingRate[chainId][token];
+    }
+
+    function getTargetManager() external view returns (NftIdSetManager targetManager) {
+        return _getStakingStorage()._targetManager;
+    }
+
+    function getTvlAmount(NftId targetNftId, address token) external view returns (Amount tvlAmount) {
+        return _getStakingStorage()._tvlAmount[targetNftId][token];
+    }
+
+    function getStakedAmount(NftId targetNftId) external view returns (Amount stakeAmount) {
+        return _getStakingStorage()._stakedAmount[targetNftId];
+    }
+
+    function getTokenRegistryAddress() external view returns (address tokenRegistry) {
+        return address(_getStakingStorage()._tokenRegistry);
+    }
+
+    function calculateRewardIncrementAmount(
+        NftId targetNftId,
+        Timestamp rewardsLastUpdatedAt
+    )
+        public 
+        virtual
+        view 
+        returns (Amount rewardIncrementAmount)
+    {
+
+    }
+
+
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        virtual override
+        initializer
+    {
+        (
+            address initialAuthority,
+            address registryAddress,
+            address targetManagerAddress,
+            address stakingReaderAddress,
+            address initialOwner
+        ) = abi.decode(data, (address, address, address, address, address));
+
+        IRegistry registry = IRegistry(registryAddress);
+        TokenRegistry tokenRegistry = TokenRegistry(registry.getTokenRegistryAddress());
+        address dipTokenAddress = address(tokenRegistry.getDipToken());
+
+        initializeComponent(
+            initialAuthority,
+            registryAddress, 
+            registry.getNftId(), 
+            CONTRACT_NAME,
+            dipTokenAddress,
+            STAKING(), 
+            false, // is interceptor
+            initialOwner, 
+            "", // registry data
+            ""); // component data
+
+        _createAndSetTokenHandler();
+
+        // wiring to external contracts
+        StakingStorage storage $ = _getStakingStorage();
+        $._targetManager = NftIdSetManager(targetManagerAddress);
+        $._reader = StakingReader(stakingReaderAddress);
+        $._tokenRegistry = TokenRegistry(
+            address(tokenRegistry));
+
+        // wiring to staking
+        $._targetManager.setOwner(address(this));
+        $._reader.setStaking(address(this));
+
+        registerInterface(type(IStaking).interfaceId);
+    }
+
+
+    function _getStakingStorage() private pure returns (StakingStorage storage $) {
+        assembly {
+            $.slot := STAKING_LOCATION_V1
+        }
+    }
+
+}

package/contracts/staking/StakingManager.sol

@@ -0,0 +1,52 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IVersionable} from "../shared/IVersionable.sol";
+import {NftIdSetManager} from "../shared/NftIdSetManager.sol";
+import {ProxyManager} from "../shared/ProxyManager.sol";
+import {Staking} from "./Staking.sol";
+import {StakingReader} from "./StakingReader.sol";
+
+contract StakingManager is
+    ProxyManager
+{
+
+    Staking private _staking;
+
+    /// @dev initializes proxy manager with service implementation 
+    constructor(
+        address initialAuthority,
+        address registryAddress
+    )
+        ProxyManager(registryAddress)
+    {
+        Staking stk = new Staking();
+        address stakingImplemenataion = address(stk);
+
+        NftIdSetManager targetManager = new NftIdSetManager();
+        StakingReader stakingReader = new StakingReader();
+        address initialOwner = msg.sender;
+
+        bytes memory data = abi.encode(
+            initialAuthority, 
+            registryAddress, 
+            address(targetManager),
+            address(stakingReader),
+            initialOwner);
+
+        IVersionable versionable = deploy(
+            stakingImplemenataion, 
+            data);
+
+        _staking = Staking(address(versionable));
+    }
+
+    //--- view functions ----------------------------------------------------//
+    function getStaking()
+        external
+        view
+        returns (Staking)
+    {
+        return _staking;
+    }
+}

package/contracts/staking/StakingReader.sol

@@ -0,0 +1,92 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Amount} from "../type/Amount.sol";
+import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
+import {IComponent} from "../shared/IComponent.sol";
+import {IVersionable} from "../shared/IVersionable.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, STAKE, TARGET} from "../type/ObjectType.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {IStaking} from "../staking/IStaking.sol";
+import {Timestamp} from "../type/Timestamp.sol";
+import {UFixed} from "../type/UFixed.sol";
+
+contract StakingReader {
+
+    error ErrorStakingReaderStakingAlreadySet(address staking);
+
+    IStaking private _staking;
+
+    function setStaking(address stakingAddress) external {
+        if (address(_staking) != address(0)) {
+            revert ErrorStakingReaderStakingAlreadySet(address(_staking));
+        }
+
+        _staking = IStaking(stakingAddress);
+    }
+
+    // view and pure functions (staking reader?)
+
+    function getStaking() external view returns (IStaking staking) {
+        return _staking;
+    }
+
+
+    function isTarget(NftId targetNftId) external view returns (bool) {
+        return _staking.getTargetManager().exists(targetNftId);
+    }
+
+
+    function targets() external view returns (uint256) {
+        return _staking.getTargetManager().nftIds();
+    }
+
+
+    function getTargetNftId(uint256 idx) external view returns (NftId) {
+        return _staking.getTargetManager().getNftId(idx);
+    }
+
+
+    function isActive(NftId targetNftId) external view returns (bool) {
+        return _staking.getTargetManager().isActive(targetNftId);
+    }
+
+
+    function activeTargets() external view returns (uint256) {
+        return _staking.getTargetManager().activeNftIds();
+    }
+
+
+    function getActiveTargetNftId(uint256 idx) external view returns (NftId) {
+        return _staking.getTargetManager().getActiveNftId(idx);
+    }
+
+
+    function getTargetInfo(NftId targetNftId) public view returns (IStaking.TargetInfo memory info) {
+        bytes memory data = _staking.getData(targetNftId.toKey32(TARGET()));
+        if (data.length > 0) {
+            return abi.decode(data, (IStaking.TargetInfo));
+        }
+    }
+
+
+    function getStakeInfo(NftId stakeNftId) external view returns (IStaking.StakeInfo memory stakeInfo) {
+        bytes memory data = _staking.getData(stakeNftId.toKey32(STAKE()));
+        if (data.length > 0) {
+            return abi.decode(data, (IStaking.StakeInfo));
+        }
+    }
+
+
+    // function getTvlAmount(NftId targetNftId, address token) external view returns (Amount tvlAmount);
+    // function getStakedAmount(NftId targetNftId) external view returns (Amount stakeAmount);
+
+    // function getStakingRate(uint256 chainId, address token) external view returns (UFixed stakingRate);
+
+    // function calculateRewardIncrementAmount(
+    //     NftId targetNftId,
+    //     Timestamp rewardsLastUpdatedAt
+    // ) external view returns (Amount rewardIncrementAmount);
+
+}