@etherisc/gif-next 0.0.2-b2910e7-757 → 0.0.2-b2e620f-736

package/contracts/shared/Service.sol

@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
 
@@ -19,14 +18,13 @@ import {Versionable} from "../upgradeability/Versionable.sol";
 abstract contract Service is 
     Registerable,
     Versionable,
-    AccessManagedUpgradeable,
     ReentrancyGuardUpgradeable,
     IService
 {
 
-    function _initializeService(
-        address registry, 
+    function __Service_init(
         address authority, // real authority for registry service adress(0) for other services
+        address registry, 
         address initialOwner
     )
         internal
@@ -35,17 +33,8 @@ abstract contract Service is
     {
         __ReentrancyGuard_init();
 
-        // externally provided authority
-        if(authority != address(0)) {
-            __AccessManaged_init(authority);
-        } else {
-            address registryServiceAddress = _getServiceAddress(REGISTRY());
-
-            // copy authority from already registered registry services
-            __AccessManaged_init(IAccessManaged(registryServiceAddress).authority());
-        }
-
-        _initializeRegisterable(
+        __Registerable_init(
+            authority,
             registry, 
             IRegistry(registry).getNftId(), 
             SERVICE(), 
@@ -53,8 +42,6 @@ abstract contract Service is
             initialOwner, 
             ""); // data
 
-
-        _registerInterface(type(IAccessManaged).interfaceId);
         _registerInterface(type(IService).interfaceId);
     }
 
@@ -62,18 +49,12 @@ abstract contract Service is
         return _getDomain();
     }
 
-    function getRoleId() external virtual pure returns(RoleId serviceRoleId) {
-        return RoleIdLib.roleForTypeAndVersion(_getDomain(), getRelease());
+    function getVersion() public pure virtual override (IVersionable, Versionable) returns(Version) {
+        return VersionLib.toVersion(3, 0, 0);
     }
 
-    /// @inheritdoc IVersionable
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(GIF_RELEASE,0,0);
+    function getRoleId() external virtual view returns(RoleId serviceRoleId) {
+        return RoleIdLib.roleForTypeAndVersion(_getDomain(), getRelease());
     }
 
     function _getDomain() internal virtual pure returns (ObjectType);

package/contracts/shared/TokenHandler.sol

@@ -12,6 +12,10 @@ import {NftId} from "../type/NftId.sol";
 import {SERVICE} from "../type/ObjectType.sol";
 
 
+/// @dev Token specific transfer helper base contract.
+/// A default token contract is provided via contract constructor.
+/// Relies internally on OpenZeppelin SafeERC20.safeTransferFrom.
+/// This base contract simplifies writing tests.
 contract TokenHandlerBase {
 
     // _setWallet
@@ -36,10 +40,6 @@ contract TokenHandlerBase {
     // _approveTokenHandler
     error ErrorTokenHandlerNotWallet(NftId nftId, address tokenHandler, address wallet);
 
-    // _pullAndPullToken
-    error ErrorTokenHandlerWalletsNotDistinct(address from, address to1, address to2);
-    error ErrorTokenHandlerPushAmountsTooLarge(Amount pushAmount, Amount pullAmount);
-
     // _checkPreconditions
     error ErrorTokenHandlerBalanceTooLow(address token, address from, uint256 balance, uint256 expectedBalance);
     error ErrorTokenHandlerAllowanceTooSmall(address token, address from, address spender, uint256 allowance, uint256 expectedAllowance);
@@ -75,6 +75,23 @@ contract TokenHandlerBase {
         }
 
         TOKEN = IERC20Metadata(token);
+
+        // self approval of token handler to max amount
+        _approve(TOKEN, AmountLib.max());
+    }
+
+
+    /// @dev Checks the balance and allowance for the from address and amount.
+    /// When requiring amount > 0 set checkAmount to true.
+    function checkBalanceAndAllowance(
+        address from,
+        Amount amount,
+        bool checkAmount
+    )
+        external
+        view
+    {
+        _checkBalanceAndAllowance(from, amount, checkAmount);
     }
 
 
@@ -159,33 +176,6 @@ contract TokenHandlerBase {
     }
 
 
-    function _pullAndPushToken(
-        address from, 
-        Amount pullAmount,
-        address to1,
-        Amount amount1,
-        address to2,
-        Amount amount2
-    )
-        internal
-    {
-        address wallet = getWallet();
-
-        if (wallet == to1 || wallet == to2 || to1 == to2) {
-            revert ErrorTokenHandlerWalletsNotDistinct(wallet, to1, to2);
-        }
-
-        if (amount1 + amount2 > pullAmount) {
-            revert ErrorTokenHandlerPushAmountsTooLarge(amount1 + amount2, pullAmount);
-        }
-
-        _pullToken(from, pullAmount);
-
-        if (amount1.gtz()) { _pushToken(to1, amount1); }
-        if (amount2.gtz()) { _pushToken(to2, amount2); }
-    }
-
-
     function _pullToken(address from, Amount amount)
         internal
     {
@@ -209,8 +199,8 @@ contract TokenHandlerBase {
         internal
     {
         if (checkPreconditions) {
-            // check amount > 0, balance >= amount and allowance >= amount
-            _checkPreconditions(from, amount);
+            bool checkAmount = true;
+            _checkBalanceAndAllowance(from, amount, checkAmount);
         }
 
         // transfer the tokens
@@ -224,15 +214,16 @@ contract TokenHandlerBase {
     }
 
 
-    function _checkPreconditions(
+    function _checkBalanceAndAllowance(
         address from,
-        Amount amount
+        Amount amount,
+        bool checkAmount
     ) 
         internal
         view
     {
         // amount must be greater than zero
-        if (amount.eqz()) {
+        if (checkAmount && amount.eqz()) {
             revert ErrorTokenHandlerAmountIsZero();
         }
 
@@ -251,9 +242,9 @@ contract TokenHandlerBase {
 }
 
 
-/// @dev Token specific transfer helper
-/// a default token contract is provided via contract constructor
-/// relies internally on oz SafeERC20.safeTransferFrom
+/// @dev Token specific transfer helper.
+/// Contract is derived from TokenHandlerBase and adds 
+/// authorization based on OpenZeppelin AccessManaged.
 contract TokenHandler is
     AccessManaged,
     TokenHandlerBase
@@ -262,17 +253,6 @@ contract TokenHandler is
     // onlyService
     error ErrorTokenHandlerNotService(address service);
 
-
-    error ErrorTokenHandlerRecipientWalletsMustBeDistinct(address to, address to2, address to3);
-
-    // TODO cleanup
-    // IRegistry public immutable REGISTRY;
-    // IERC20Metadata public immutable TOKEN;
-    // address public immutable COMPONENT;
-    // NftId public immutable NFT_ID;
-
-    // address private _wallet;
-
     modifier onlyService() {
         if (!REGISTRY.isObjectType(msg.sender, SERVICE())) {
             revert ErrorTokenHandlerNotService(msg.sender);
@@ -297,7 +277,7 @@ contract TokenHandler is
     /// covers the current component balance must exist
     function setWallet(address newWallet)
         external
-        // restricted() // TODO re-activate
+        restricted()
         onlyService()
     {
         _setWallet(newWallet);
@@ -313,7 +293,7 @@ contract TokenHandler is
         Amount amount
     )
         external
-        // restricted() // TODO re-activate
+        restricted()
         onlyService()
     {
         _approve(token, amount);
@@ -321,69 +301,34 @@ contract TokenHandler is
 
     /// @dev Collect tokens from outside of GIF and transfer them to the wallet.
     /// This method also checks balance and allowance and makes sure the amount is greater than zero.
-    function collectTokens(
+    function pullToken(
         address from,
         Amount amount
     )
         external
-        // restricted() // TODO re-activate
+        restricted()
         onlyService()
     {
         _pullToken(from, amount);
     }
 
 
-    /// @dev Collect tokens from outside of GIF and transfer them to the wallet.
-    /// This method also checks balance and allowance and makes sure the amount is greater than zero.
+    /// @dev Distribute tokens from a wallet within the scope of gif to some address.
     function pushToken(
-        address from,
-        Amount amount
-    )
-        external
-        // restricted() // TODO re-activate
-        onlyService()
-    {
-        _pushToken(from, amount);
-    }
-
-
-    /// @dev collect tokens from outside of the gif and transfer them to three distinct wallets within the scope of gif
-    /// This method also checks balance and allowance and makes sure the amount is greater than zero.
-    function collectTokensToThreeRecipients( 
-        address from,
         address to,
-        Amount amount,
-        address to2,
-        Amount amount2,
-        address to3,
-        Amount amount3
+        Amount amount
     )
         external
         restricted()
         onlyService()
     {
-        if (to == to2 || to == to3 || to2 == to3) {
-            revert ErrorTokenHandlerRecipientWalletsMustBeDistinct(to, to2, to3);
-        }
-
-        _checkPreconditions(from, amount + amount2 + amount3);
-
-        if (amount.gtz()) {
-            _transfer(from, to, amount, false);
-        }
-        if (amount2.gtz()) {
-            _transfer(from, to2, amount2, false);
-        }
-        if (amount3.gtz()) {
-            _transfer(from, to3, amount3, false);
-        }
+        _pushToken(to, amount);
     }
 
 
-    /// @dev distribute tokens from a wallet within the scope of gif to an external address.
-    /// This method also checks balance and allowance and makes sure the amount is greater than zero.
-    function distributeTokens(
-        address from,
+    /// @dev Distribute fee tokens from a wallet within the scope of gif to some address.
+    /// Separate push function for component service.
+    function pushFeeToken(
         address to,
         Amount amount
     )
@@ -391,7 +336,6 @@ contract TokenHandler is
         restricted()
         onlyService()
     {
-        // _transfer(from, to, amount, true);
         _pushToken(to, amount);
     }
 }

package/contracts/staking/IStaking.sol

@@ -158,14 +158,6 @@ interface IStaking is
             Amount rewardsClaimedAmount
         );
 
-    //--- helper functions --------------------------------------------------//
-
-    // /// @dev transfers the specified amount of dips from the from address to the staking wallet.
-    // function collectDipAmount(address from, Amount dipAmount) external;
-
-    // /// @dev transfers the specified amount of dips from the staking wallet to the to addess.
-    // function transferDipAmount(address to, Amount dipAmount) external;
-
     //--- view and pure functions -------------------------------------------//
 
     function getStakingStore() external view returns (StakingStore stakingStore);

package/contracts/staking/IStakingService.sol

@@ -31,6 +31,7 @@ interface IStakingService is IService
     event LogStakingServiceRewardsClaimed(NftId stakeNftId, address stakeOwner, Amount rewardsClaimedAmount);
 
     // modifiers
+    error ErrorStakingServiceNotStakingOwner(address account);
     error ErrorStakingServiceNotStaking(address stakingAddress);
     error ErrorStakingServiceNotSupportingIStaking(address stakingAddress);
 
@@ -48,6 +49,13 @@ interface IStakingService is IService
     // function setProtocolLockingPeriod(Seconds lockingPeriod) external;
     // TODO also make sure that protocol rewards can be refilled and withdrawn
 
+    /// @dev Approves the staking token handler.
+    /// Reverts if the staking token handler wallet is not the token handler itself.
+    function approveTokenHandler(
+        IERC20Metadata token,
+        Amount amount
+    ) external;
+
     /// @dev creates/registers an on-chain instance staking target.
     /// function granted to instance service
     function createInstanceTarget(

package/contracts/staking/StakeManagerLib.sol

@@ -51,7 +51,7 @@ library StakeManagerLib {
 
         // TODO check that additional dip, rewards and rewards increment 
         // are still ok with max target staking amount
-        NftId targetNftId = registry.getObjectInfo(stakeNftId).parentNftId;
+        NftId targetNftId = registry.getParentNftId(stakeNftId);
 
         stakingStore.restakeRewards(
             stakeNftId, 

package/contracts/staking/Staking.sol

@@ -5,6 +5,7 @@ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IER
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryService} from "../registry/IRegistryService.sol";
+import {IRelease} from "../registry/IRelease.sol";
 import {IStaking} from "./IStaking.sol";
 import {IVersionable} from "../upgradeability/IVersionable.sol";
 
@@ -15,6 +16,7 @@ import {IComponentService} from "../shared/IComponentService.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType, COMPONENT, STAKING} from "../type/ObjectType.sol";
 import {Seconds} from "../type/Seconds.sol";
+import {Registerable} from "../shared/Registerable.sol";
 import {StakeManagerLib} from "./StakeManagerLib.sol";
 import {StakingReader} from "./StakingReader.sol";
 import {StakingStore} from "./StakingStore.sol";
@@ -24,7 +26,7 @@ import {TokenHandler} from "../shared/TokenHandler.sol";
 import {TokenHandlerDeployerLib} from "../shared/TokenHandlerDeployerLib.sol";
 import {TokenRegistry} from "../registry/TokenRegistry.sol";
 import {UFixed} from "../type/UFixed.sol";
-import {Version, VersionLib} from "../type/Version.sol";
+import {Version, VersionLib, VersionPart, VersionPartLib} from "../type/Version.sol";
 import {Versionable} from "../upgradeability/Versionable.sol";
 
 contract Staking is 
@@ -38,7 +40,6 @@ contract Staking is
     bytes32 public constant STAKING_LOCATION_V1 = 0xafe8d4462b2ed26a47154f4b8f6d1497d2f772496965791d25bd456e342b7f00;
 
     struct StakingStorage {
-        IRegistryService _registryService;
         TokenRegistry _tokenRegistry;
         TokenHandler _tokenHandler;
         StakingStore _store;
@@ -77,6 +78,16 @@ contract Staking is
             getRegistry().getAuthority());
     }
 
+
+    function approveTokenHandler(IERC20Metadata token, Amount amount)
+        public
+        restricted()
+        onlyOwner()
+    {
+        _approveTokenHandler(token, amount);
+    }
+
+
     // set/update staking reader
     function setStakingReader(StakingReader stakingReader)
         external
@@ -407,14 +418,24 @@ contract Staking is
         return _getStakingStorage()._tokenHandler;
     }
 
-    // from Versionable
+    // from IRegisterable
+    function getRelease()
+        public 
+        pure 
+        virtual override (IRelease, Registerable)
+        returns(VersionPart)
+    {
+        return VersionPartLib.toVersionPart(3);
+    }
+
+    // from IVersionable
     function getVersion()
         public 
         pure 
-        virtual override (IVersionable, Versionable)
+        virtual override (Component, IVersionable, Versionable)
         returns(Version)
     {
-        return VersionLib.toVersion(GIF_RELEASE,0,0);
+        return VersionLib.toVersion(3,0,0);
     }
 
     //--- internal functions ------------------------------------------------//
@@ -447,7 +468,7 @@ contract Staking is
         internal
         virtual override
     {
-        IComponentService(_getServiceAddress(COMPONENT())).approveStakingTokenHandler(
+        IComponentService(_getServiceAddress(STAKING())).approveTokenHandler(
             token, 
             amount);
     }
@@ -474,6 +495,13 @@ contract Staking is
         TokenRegistry tokenRegistry = TokenRegistry(tokenRegistryAddress);
         address dipTokenAddress = tokenRegistry.getDipTokenAddress();
 
+        // wiring to external contracts
+        StakingStorage storage $ = _getStakingStorage();
+        $._protocolNftId = registry.getProtocolNftId();
+        $._store = StakingStore(stakingStoreAddress);
+        $._reader = StakingStore(stakingStoreAddress).getStakingReader();
+        $._tokenRegistry = TokenRegistry(tokenRegistryAddress);
+
         _initializeComponent(
             authority,
             registryAddress, 
@@ -486,13 +514,6 @@ contract Staking is
             "", // registry data
             ""); // component data
 
-        // wiring to external contracts
-        StakingStorage storage $ = _getStakingStorage();
-        $._protocolNftId = getRegistry().getProtocolNftId();
-        $._store = StakingStore(stakingStoreAddress);
-        $._reader = StakingStore(stakingStoreAddress).getStakingReader();
-        $._tokenRegistry = TokenRegistry(tokenRegistryAddress);
-
         _registerInterface(type(IStaking).interfaceId);
     }
 

package/contracts/staking/StakingReader.sol

@@ -93,7 +93,7 @@ contract StakingReader is
 
 
     function getTargetNftId(NftId stakeNftId) public view returns (NftId targetNftId) {
-        return _registry.getObjectInfo(stakeNftId).parentNftId;
+        return _registry.getParentNftId(stakeNftId);
     }
 
 

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,
@@ -113,8 +135,7 @@ contract StakingService is
         // transfer withdrawal amount to target owner
         address instanceOwner = getRegistry().ownerOf(instanceNftId);
         emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
-        _distributeToken(
-            $._staking.getTokenHandler(),
+        $._tokenHandler.pushToken(
             instanceOwner,
             dipAmount);
     }
@@ -162,44 +183,9 @@ contract StakingService is
         emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
 
         // collect staked dip by staking
-        _collectToken(
-            $._staking.getTokenHandler(),
+        $._tokenHandler.pullToken(
             stakeOwner, 
             dipAmount);
-
-        // TODO cleanup
-        // TokenHandler tokenHandler = $._staking.getTokenHandler();
-        // tokenHandler.collectTokens(
-        //     stakeOwner, 
-        //     tokenHandler.getWallet(), 
-        //     dipAmount);
-    }
-
-    function _collectToken(
-        TokenHandler tokenHandler,
-        address from,
-        Amount amount
-    )
-        internal
-        virtual
-    {
-        tokenHandler.collectTokens(
-            from, 
-            amount);
-    }
-
-    function _distributeToken(
-        TokenHandler tokenHandler,
-        address to,
-        Amount amount
-    )
-        internal
-        virtual
-    {
-        tokenHandler.distributeTokens(
-            tokenHandler.getWallet(), 
-            to, 
-            amount);
     }
 
 
@@ -225,8 +211,7 @@ contract StakingService is
         // collect staked dip by staking
         if (dipAmount.gtz()) {
             emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
-            _collectToken(
-                $._staking.getTokenHandler(),
+        $._tokenHandler.pullToken(
                 stakeOwner,
                 dipAmount);
         }
@@ -281,8 +266,7 @@ contract StakingService is
 
         Amount rewardsClaimedAmount = $._staking.claimRewards(stakeNftId);
         emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
-        _distributeToken(
-            $._staking.getTokenHandler(),
+        $._tokenHandler.pushToken(
             stakeOwner,
             rewardsClaimedAmount);
     }
@@ -307,15 +291,9 @@ contract StakingService is
         Amount totalAmount = unstakedAmount + rewardsClaimedAmount;
         emit LogStakingServiceUnstaked(stakeNftId, stakeOwner, totalAmount);
 
-        $._staking.getTokenHandler().pushToken(
+        $._tokenHandler.pushToken(
             stakeOwner, 
             totalAmount);
-
-        // TODO cleanup
-        // _distributeToken(
-        //     $._staking.getTokenHandler(),
-        //     stakeOwner,
-        //     totalAmount);
     }
 
 
@@ -372,15 +350,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();
 
@@ -433,8 +411,7 @@ contract StakingService is
         emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
 
         // collect reward dip from provider
-        _collectToken(
-            $._staking.getTokenHandler(),
+        $._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/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);