@etherisc/gif-next 0.0.2-efef0ea-320 → 0.0.2-f034782-101

package/contracts/components/Pool.sol

@@ -1,235 +1,299 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {ObjectType, POOL} from "../types/ObjectType.sol";
-import {IProductService} from "../instance/service/IProductService.sol";
-import {IPoolService} from "../instance/service/IPoolService.sol";
-import {NftId} from "../types/NftId.sol";
-import {Fee} from "../types/Fee.sol";
-import {UFixed} from "../types/UFixed.sol";
+import {Component} from "./Component.sol";
+import {Fee, FeeLib} from "../types/Fee.sol";
+import {IBundleService} from "../instance/service/IBundleService.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IPoolComponent} from "./IPoolComponent.sol";
-import {BaseComponent} from "./BaseComponent.sol";
-
-contract Pool is BaseComponent, IPoolComponent {
+import {IPoolService} from "../instance/service/IPoolService.sol";
+import {IComponents} from "../instance/module/IComponents.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, UFixedLib} from "../types/UFixed.sol";
 
-    bool internal _isVerifying;
-    UFixed internal _collateralizationLevel;
 
-    Fee internal _initialPoolFee;
-    Fee internal _initialStakingFee;
-    Fee internal _initialPerformanceFee;
+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;
 
-    // may be used to interact with instance by derived contracts
-    IPoolService internal _poolService;
+    struct PoolStorage {
+        IPoolService _poolService;
+        IBundleService _bundleService;
+    }
 
-    // only relevant to protect callback functions for "active" pools
-    IProductService private _productService;
 
-    modifier onlyPoolService() {
-        require(
-            msg.sender == address(_poolService), 
-            "ERROR:POL-001:NOT_POOL_SERVICE");
+    modifier onlyBundleOwner(NftId bundleNftId) {
+        if(msg.sender != getRegistry().ownerOf(bundleNftId)) {
+            revert ErrorPoolNotBundleOwner(bundleNftId, msg.sender);
+        }
         _;
     }
 
-    modifier onlyProductService() {
-        require(
-            msg.sender == address(_productService), 
-            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
+
+    modifier onlyPoolService() {
+        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 verifying,
-        UFixed collateralizationLevel,
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
+        bool isInterceptingNftTransfers,
+        address initialOwner,
+        bytes memory registryData // writeonly data that will saved in the object info record of the registry
     )
-        BaseComponent(registry, instanceNftId, token)
+        public
+        virtual
+        onlyInitializing()
     {
-        _isVerifying = verifying;
-        // TODO add validation
-        _collateralizationLevel = collateralizationLevel;
-        _initialPoolFee = poolFee;
-        _initialStakingFee = stakingFee;
-        _initialPerformanceFee = performanceFee;
+        initializeComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, registryData);
 
-        _poolService = _instance.getPoolService();
-        _productService = _instance.getProductService();
+        PoolStorage storage $ = _getPoolStorage();
+        $._poolService = getInstance().getPoolService();
+        $._bundleService = getInstance().getBundleService();
+
+        registerInterface(type(IPoolComponent).interfaceId);
     }
 
-    function setFees(
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
+
+    function stake(
+        NftId bundleNftId, 
+        uint256 amount
     )
-        external
-        onlyOwner
-        override
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
     {
-        _poolService.setFees(poolFee, stakingFee, performanceFee);
+        // TODO add implementation
     }
 
-    function createBundle(
-        Fee memory fee,
-        uint256 initialAmount,
-        uint256 lifetime,
-        bytes memory filter
+
+    function unstake(
+        NftId bundleNftId, 
+        uint256 amount
     )
-        external
-        virtual override
-        returns(NftId bundleNftId)
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
     {
-        address owner = msg.sender;
-        bundleNftId = _poolService.createBundle(
-            owner,
-            fee,
-            initialAmount,
-            lifetime,
-            filter
-        );
+        // TODO add implementation
+    }
 
-        // TODO add logging
+
+    function extend(
+        NftId bundleNftId, 
+        Seconds lifetimeExtension
+    )
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+    {
+        // TODO add implementation
     }
 
+
+    function lockBundle(NftId bundleNftId)
+        public
+        virtual
+        //restricted() // TODO consider adding this back
+        onlyBundleOwner(bundleNftId)
+    {
+        _getPoolStorage()._bundleService.lock(bundleNftId);
+    }
+
+
+    function unlockBundle(NftId bundleNftId)
+        public
+        virtual
+        //restricted()
+        onlyBundleOwner(bundleNftId)
+    {
+        _getPoolStorage()._bundleService.unlock(bundleNftId);
+    }
+
+
+    function close(NftId bundleNftId)
+        public
+        virtual
+        //restricted()
+        onlyBundleOwner(bundleNftId)
+    {
+        _getPoolStorage()._bundleService.close(bundleNftId);
+    }
+
+
     function setBundleFee(
         NftId bundleNftId, 
         Fee memory fee
     )
-        external
-        override
-        // TODO add onlyBundleOwner
+        public
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
     {
-        _poolService.setBundleFee(bundleNftId, fee);
+        _getPoolStorage()._bundleService.setFee(bundleNftId, fee);
     }
 
-    /**
-     * @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 setMaxCapitalAmount(uint256 maxCapitalAmount)
+        public
+        virtual
+        restricted()
+        onlyOwner()
     {
-        _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
+        _getPoolStorage()._poolService.setMaxCapitalAmount(maxCapitalAmount);
     }
 
-    /**
-     * @dev see {IPoolComponent.policyMatchesBundle}. 
-     * Default implementation always returns true
-     */
-    function policyMatchesBundle(
-        bytes memory, // policyData
-        bytes memory // bundleFilter
-    )
+
+    function setBundleOwnerRole(RoleId bundleOwnerRole)
         public
-        view
-        virtual override
-        returns (bool isMatching)
+        virtual
+        restricted()
+        onlyOwner()
     {
-        return true;
+        _getPoolStorage()._poolService.setBundleOwnerRole(bundleOwnerRole);
     }
 
 
-    function isVerifying() external view override returns (bool verifying) {
-        return _isVerifying;
+    function setFees(
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    )
+        public
+        virtual
+        restricted()
+        onlyOwner()
+    {
+        _getPoolStorage()._poolService.setFees(poolFee, stakingFee, performanceFee);
     }
 
-    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
-        return _collateralizationLevel;
+
+    /// @dev see {IPool.verifyApplication}
+    function verifyApplication(
+        NftId applicationNftId, 
+        bytes memory applicationData,
+        NftId bundleNftId, 
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
+    )
+        public
+        virtual
+        restricted()
+    {
+        if(!applicationMatchesBundle(
+            applicationNftId,
+            applicationData, 
+            bundleNftId, 
+            bundleFilter,
+            collateralizationAmount)
+        )
+        {
+            revert ErrorPoolApplicationBundleMismatch(applicationNftId);
+        }
+
+        emit LogPoolVerifiedByPool(address(this), applicationNftId, collateralizationAmount);
     }
 
-    function _underwrite(
-        NftId policyNftId, 
-        bytes memory policyData,
+
+    /// @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 getPoolInfo() external view returns (IComponents.PoolInfo memory poolInfo) {
+        poolInfo = abi.decode(getComponentInfo().data, (IComponents.PoolInfo));
     }
 
+    // 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 = _poolService.createBundle(
+        bundleNftId = _getPoolStorage()._bundleService.create(
             bundleOwner,
             fee,
             amount,
             lifetime,
-            filter
-        );
-    }
+            filter);
 
-    // from pool component
-    function getPoolFee()
-        external
-        view
-        override
-        returns (Fee memory poolFee)
-    {
-        NftId productNftId = _instance.getProductNftId(getNftId());
-        if (_instance.hasTreasuryInfo(productNftId)) {
-            return _instance.getTreasuryInfo(productNftId).poolFee;
-        } else {
-            return _initialPoolFee;
-        }
+        // TODO add logging
     }
 
-    function getStakingFee()
-        external
-        view
-        override
-        returns (Fee memory stakingFee)
-    {
-        NftId productNftId = _instance.getProductNftId(getNftId());
-        if (_instance.hasTreasuryInfo(productNftId)) {
-            return _instance.getTreasuryInfo(productNftId).stakingFee;
-        } else {
-            return _initialStakingFee;
-        }
+    // 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 getPerformanceFee()
-        external
-        view
-        override
-        returns (Fee memory performanceFee)
+    /// @dev defines initial pool specification
+    /// overwrite this function according to your use case
+    function _getInitialInfo()
+        internal
+        view 
+        virtual override
+        returns (IComponents.ComponentInfo memory info)
     {
-        NftId productNftId = _instance.getProductNftId(getNftId());
-        if (_instance.hasTreasuryInfo(productNftId)) {
-            return _instance.getTreasuryInfo(productNftId).performanceFee;
-        } else {
-            return _initialPerformanceFee;
-        }
+        return IComponents.ComponentInfo(
+            getName(),
+            getToken(),
+            TokenHandler(address(0)), // will be created by GIF service during registration
+            address(this), // contract is its own wallet
+            abi.encode(
+                IComponents.PoolInfo(
+                    NftIdLib.zero(), // will be set when GIF registers the related product
+                    PUBLIC_ROLE(), // bundleOwnerRole
+                    type(uint256).max, // maxCapitalAmount,
+                    isNftInterceptor(), // isInterceptingBundleTransfers
+                    false, // isExternallyManaged,
+                    false, // isVerifyingApplications,
+                    UFixedLib.toUFixed(1), // collateralizationLevel,
+                    UFixedLib.toUFixed(1), // retentionLevel,
+                    FeeLib.zeroFee(), // initialPoolFee,
+                    FeeLib.zeroFee(), // initialStakingFee,
+                    FeeLib.zeroFee() // initialPerformanceFee,
+                )));
     }
 
-    // from registerable
-    function getType() public pure override returns (ObjectType) {
-        return POOL();
+
+    function _getPoolStorage() private pure returns (PoolStorage storage $) {
+        assembly {
+            $.slot := POOL_STORAGE_LOCATION_V1
+        }
     }
 }