@etherisc/gif-next 0.0.2-e5a2253-213 → 0.0.2-e69072e-892

package/contracts/components/Pool.sol

@@ -1,258 +1,378 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {POOL} from "../types/ObjectType.sol";
-import {IPoolService} from "../instance/service/IPoolService.sol";
+import {Component} from "./Component.sol";
+import {Fee, FeeLib} from "../types/Fee.sol";
 import {IBundleService} from "../instance/service/IBundleService.sol";
-import {NftId, NftIdLib} from "../types/NftId.sol";
-import {Fee} from "../types/Fee.sol";
-import {UFixed} from "../types/UFixed.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IPoolComponent} from "./IPoolComponent.sol";
-import {BaseComponent} from "./BaseComponent.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
+import {IPoolService} from "../instance/service/IPoolService.sol";
 import {ISetup} from "../instance/module/ISetup.sol";
+import {NftId, NftIdLib} from "../types/NftId.sol";
+import {POOL} from "../types/ObjectType.sol";
+import {RoleId, PUBLIC_ROLE} from "../types/RoleId.sol";
+import {Seconds} from "../types/Seconds.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+import {UFixed} from "../types/UFixed.sol";
 
-import {IRegistry} from "../registry/IRegistry.sol";
 
-import {ISetup} from "../instance/module/ISetup.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
+abstract contract Pool is
+    Component, 
+    IPoolComponent 
+{
+    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Pool")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant POOL_STORAGE_LOCATION_V1 = 0x25e3e51823fbfffb988e0a2744bb93722d9f3e906c07cc0a9e77884c46c58300;
 
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {Registerable} from "../shared/Registerable.sol";
+    struct PoolStorage {
+        UFixed _collateralizationLevel;
+        UFixed _retentionLevel;
+        uint256 _maxCapitalAmount;
+        
+        bool _isExternallyManaged;
+        bool _isVerifyingApplications;
 
-abstract contract Pool is BaseComponent, IPoolComponent {
-    using NftIdLib for NftId;
+        RoleId _bundleOwnerRole;
+        bool _isInterceptingBundleTransfers;
 
-    bool internal _isConfirmingApplication;
-    UFixed internal _collateralizationLevel;
+        Fee _initialPoolFee;
+        Fee _initialStakingFee;
+        Fee _initialPerformanceFee;
 
-    Fee internal _initialPoolFee;
-    Fee internal _initialStakingFee;
-    Fee internal _initialPerformanceFee;
+        TokenHandler _tokenHandler;
+
+        // may be used to interact with instance by derived contracts
+        IPoolService _poolService;
+        IBundleService _bundleService;
+    }
 
-    TokenHandler internal _tokenHandler;
 
-    // may be used to interact with instance by derived contracts
-    IPoolService internal _poolService;
-    IBundleService private _bundleService;
+    modifier onlyBundleOwner(NftId bundleNftId) {
+        if(msg.sender != getRegistry().ownerOf(bundleNftId)) {
+            revert ErrorPoolNotBundleOwner(bundleNftId, msg.sender);
+        }
+        _;
+    }
+
 
     modifier onlyPoolService() {
-        require(
-            msg.sender == address(_poolService), 
-            "ERROR:POL-001:NOT_POOL_SERVICE");
+        if(msg.sender != address(_getPoolStorage()._poolService)) {
+            revert ErrorPoolNotPoolService(msg.sender);
+        }
         _;
     }
 
-    constructor(
+
+    function initializePool(
         address registry,
         NftId instanceNftId,
-        // TODO refactor into tokenNftId
+        string memory name,
         address token,
-        bool isInterceptor,
-        bool isConfirmingApplication,
+        bool isInterceptingNftTransfers,
+        bool isExternallyManaging,
+        bool isVerifying,
         UFixed collateralizationLevel,
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee,
-        address initialOwner
+        UFixed retentionLevel,
+        address initialOwner,
+        bytes memory registryData // writeonly data that will saved in the object info record of the registry
     )
-        BaseComponent(registry, instanceNftId, token, POOL(), isInterceptor, initialOwner)
+        public
+        virtual
+        onlyInitializing()
     {
-        _isConfirmingApplication = isConfirmingApplication;
+        initializeComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, registryData);
+
+        PoolStorage storage $ = _getPoolStorage();
         // TODO add validation
-        _collateralizationLevel = collateralizationLevel;
-        _initialPoolFee = poolFee;
-        _initialStakingFee = stakingFee;
-        _initialPerformanceFee = performanceFee;
+        $._tokenHandler = new TokenHandler(token);
+        $._maxCapitalAmount = type(uint256).max;
+        $._isExternallyManaged = isExternallyManaging;
+        $._isVerifyingApplications = isVerifying;
+        $._bundleOwnerRole = PUBLIC_ROLE();
+        $._collateralizationLevel = collateralizationLevel;
+        $._retentionLevel = retentionLevel;
+        $._initialPoolFee = FeeLib.zeroFee();
+        $._initialStakingFee = FeeLib.zeroFee();
+        $._initialPerformanceFee = FeeLib.zeroFee();
+        $._poolService = getInstance().getPoolService();
+        $._bundleService = getInstance().getBundleService();
+
+        registerInterface(type(IPoolComponent).interfaceId);
+    }
+
 
-        _tokenHandler = new TokenHandler(token);
+    function stake(
+        NftId bundleNftId, 
+        uint256 amount
+    )
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+    {
+        // TODO add implementation
+    }
 
-        _poolService = _instance.getPoolService();
-        // _productService = _instance.getProductService();
-        _bundleService = _instance.getBundleService();
 
-        _registerInterface(type(IPoolComponent).interfaceId);
+    function unstake(
+        NftId bundleNftId, 
+        uint256 amount
+    )
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+    {
+        // TODO add implementation
     }
 
-    function createBundle(
-        Fee memory fee,
-        uint256 initialAmount,
-        uint256 lifetime,
-        bytes memory filter
+
+    function extend(
+        NftId bundleNftId, 
+        Seconds lifetimeExtension
     )
-        external
-        virtual override
-        returns(NftId bundleNftId)
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
     {
-        address owner = msg.sender;
-        bundleNftId = _bundleService.createBundle(
-            owner,
-            fee,
-            initialAmount,
-            lifetime,
-            filter
-        );
+        // TODO add implementation
+    }
 
-        // TODO add logging
+
+    function lockBundle(NftId bundleNftId)
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+    {
+        _getPoolStorage()._bundleService.lockBundle(bundleNftId);
     }
 
-    /**
-     * @dev see {IPool.underwrite}. 
-     * Default implementation that only writes a {LogUnderwrittenByPool} entry.
-     */
-    function underwrite(
-        NftId policyNftId, 
-        bytes memory policyData,
-        bytes memory bundleFilter,
-        uint256 collateralizationAmount
-    )
-        external
-        onlyProductService
-        virtual override 
+
+    function unlockBundle(NftId bundleNftId)
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+    {
+        _getPoolStorage()._bundleService.unlockBundle(bundleNftId);
+    }
+
+
+    function close(NftId bundleNftId)
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
     {
-        _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
+        // TODO add implementation
     }
 
-    /**
-     * @dev see {IPoolComponent.policyMatchesBundle}. 
-     * Default implementation always returns true
-     */
-    function policyMatchesBundle(
-        bytes memory, // policyData
-        bytes memory // bundleFilter
+
+    function setBundleFee(
+        NftId bundleNftId, 
+        Fee memory fee
     )
         public
-        view
-        virtual override
-        returns (bool isMatching)
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
     {
-        return true;
+        _getPoolStorage()._bundleService.setBundleFee(bundleNftId, fee);
     }
 
 
-    function isConfirmingApplication() external view override returns (bool isConfirmingApplication) {
-        return _isConfirmingApplication;
+    function setMaxCapitalAmount(uint256 maxCapitalAmount)
+        public
+        virtual
+        restricted()
+        onlyOwner()
+    {
+        // TODO refactor to use pool service
+        // _getPoolStorage()._poolService.setMaxCapitalAmount(...);
+
+        uint256 previousMaxCapitalAmount = _getPoolStorage()._maxCapitalAmount;
+        _getPoolStorage()._maxCapitalAmount = maxCapitalAmount;
+
+        emit LogPoolBundleMaxCapitalAmountUpdated(previousMaxCapitalAmount, maxCapitalAmount);
     }
 
-    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
-        return _collateralizationLevel;
+
+    function setBundleOwnerRole(RoleId bundleOwnerRole)
+        public
+        virtual
+        restricted()
+        onlyOwner()
+    {
+        // TODO refactor to use pool service
+        // _getPoolStorage()._poolService.setBundleOwnerRole(...);
+
+        if(_getPoolStorage()._bundleOwnerRole != PUBLIC_ROLE()) {
+            revert ErrorPoolBundleOwnerRoleAlreadySet();
+        }
+
+        _getPoolStorage()._bundleOwnerRole = bundleOwnerRole;
+
+        emit LogPoolBundleOwnerRoleSet(bundleOwnerRole);
     }
 
+
     function setFees(
         Fee memory poolFee,
         Fee memory stakingFee,
         Fee memory performanceFee
     )
-        external
-        onlyOwner
-        override
+        public
+        virtual
+        restricted()
+        onlyOwner()
     {
-        _poolService.setFees(poolFee, stakingFee, performanceFee);
+        _getPoolStorage()._poolService.setFees(poolFee, stakingFee, performanceFee);
     }
 
-    function setBundleFee(
+
+    /// @dev see {IPool.verifyApplication}
+    function verifyApplication(
+        NftId applicationNftId, 
+        bytes memory applicationData,
         NftId bundleNftId, 
-        Fee memory fee
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
     )
-        external
-        override
-        // TODO add onlyBundleOwner
+        public
+        virtual
+        restricted()
     {
-        _bundleService.setBundleFee(bundleNftId, fee);
+        // validate application data against bundle filter
+        if(!applicationMatchesBundle(
+            applicationNftId,
+            applicationData, 
+            bundleNftId, 
+            bundleFilter,
+            collateralizationAmount)
+        )
+        {
+            revert ErrorPoolApplicationBundleMismatch(applicationNftId);
+        }
+
+        emit LogPoolVerifiedByPool(address(this), applicationNftId, collateralizationAmount);
     }
 
-    function lockBundle(
-        NftId bundleNftId
-    )
-        external
-        override
-        // TODO add onlyBundleOwner
-    {
-        _bundleService.lockBundle(bundleNftId);
+
+    function getCollateralizationLevel() public view virtual returns (UFixed collateralizationLevel) {
+        return _getPoolStorage()._collateralizationLevel;
     }
 
-    function unlockBundle(
-        NftId bundleNftId
-    )
-        external
-        override
-        // TODO add onlyBundleOwner
-    {
-        _bundleService.unlockBundle(bundleNftId);
+
+    function getRetentionLevel() public view virtual returns (UFixed retentionLevel) {
+        return _getPoolStorage()._retentionLevel;
     }
 
-    function getSetupInfo() public view returns (ISetup.PoolSetupInfo memory setupInfo) {
-        InstanceReader reader = _instance.getInstanceReader();
-        return reader.getPoolSetupInfo(getNftId());
+
+    function isExternallyManaged() public view virtual returns (bool) {
+        return _getPoolStorage()._isExternallyManaged;
     }
 
-    // from IRegisterable
 
-    // TODO used only once, occupies space
-    // TODO do not use super
-    function getInitialInfo() 
-        public
-        view
-        override (IRegisterable, Registerable)
-        returns (IRegistry.ObjectInfo memory, bytes memory)
-    {
-        (
-            IRegistry.ObjectInfo memory info, 
-        ) = super.getInitialInfo();
-
-        return (
-            info,
-            abi.encode(
-                getName(),
-                ISetup.PoolSetupInfo(
-                    _productNftId,
-                    _tokenHandler,
-                    _collateralizationLevel,
-                    _initialPoolFee,
-                    _initialStakingFee,
-                    _initialPerformanceFee,
-                    false,
-                    _isConfirmingApplication,
-                    _wallet
-                )
-            )
-        );
+    function isVerifyingApplications() public view virtual returns (bool isConfirmingApplication) {
+        return _getPoolStorage()._isVerifyingApplications;
     }
 
-    // Internals
 
-    function _underwrite(
-        NftId policyNftId, 
-        bytes memory policyData,
+    function getMaxCapitalAmount() public view virtual returns (uint256 maxCapitalAmount) {
+        return _getPoolStorage()._maxCapitalAmount;
+    }
+
+
+    function isInterceptingBundleTransfers() public view virtual returns (bool) {
+        return isNftInterceptor();
+    }
+
+
+    function getBundleOwnerRole() public view returns (RoleId bundleOwnerRole) {
+        return _getPoolStorage()._bundleOwnerRole;
+    }
+
+
+    /// @dev see {IPoolComponent.applicationMatchesBundle}
+    /// Override this function to implement any custom application verification 
+    /// Default implementation always returns true
+    function applicationMatchesBundle(
+        NftId applicationNftId, 
+        bytes memory applicationData,
+        NftId bundleNftId, 
         bytes memory bundleFilter,
         uint256 collateralizationAmount
     )
-        internal 
+        public
+        view
+        virtual override
+        returns (bool isMatching)
     {
-        require(
-            policyMatchesBundle(policyData, bundleFilter),
-            "ERROR:POL-020:POLICY_BUNDLE_MISMATCH"
-        );
+        return true;
+    }
 
-        emit LogUnderwrittenByPool(policyNftId, collateralizationAmount, address(this));
+
+    function getSetupInfo() public view returns (ISetup.PoolSetupInfo memory setupInfo) {
+        InstanceReader reader = getInstance().getInstanceReader();
+        setupInfo = reader.getPoolSetupInfo(getNftId());
+
+        // fallback to initial setup info (wallet is always != address(0))
+        if(setupInfo.wallet == address(0)) {
+            setupInfo = _getInitialSetupInfo();
+        }
     }
 
+    // Internals
+
     function _createBundle(
         address bundleOwner,
         Fee memory fee,
         uint256 amount,
-        uint256 lifetime, 
-        bytes calldata filter
+        Seconds lifetime, 
+        bytes memory filter
     )
         internal
         returns(NftId bundleNftId)
     {
-        bundleNftId = _bundleService.createBundle(
+        bundleNftId = _getPoolStorage()._bundleService.createBundle(
             bundleOwner,
             fee,
             amount,
             lifetime,
-            filter
+            filter);
+
+        // TODO add logging
+    }
+
+    // TODO remove function once this is no longer used to produce contract locations on the fly ...
+    function getContractLocation(bytes memory name) external pure returns (bytes32 hash) {
+        return keccak256(abi.encode(uint256(keccak256(name)) - 1)) & ~bytes32(uint256(0xff));
+    }
+
+
+    function _getInitialSetupInfo() internal view returns (ISetup.PoolSetupInfo memory) {
+        PoolStorage storage $ = _getPoolStorage();
+        return ISetup.PoolSetupInfo(
+            getProductNftId(),
+            $._tokenHandler,
+            $._maxCapitalAmount,
+            isNftInterceptor(),
+            $._isExternallyManaged,
+            $._isVerifyingApplications,
+            $._collateralizationLevel,
+            $._retentionLevel,
+            $._initialPoolFee,
+            $._initialStakingFee,
+            $._initialPerformanceFee,
+            getWallet()
         );
     }
+
+
+    function _getPoolStorage() private pure returns (PoolStorage storage $) {
+        assembly {
+            $.slot := POOL_STORAGE_LOCATION_V1
+        }
+    }
 }