@etherisc/gif-next 0.0.2-9dd41ff-671 → 0.0.2-9ed3c41-176

package/contracts/pool/Pool.sol

@@ -2,27 +2,30 @@
 pragma solidity ^0.8.20;
 
 import {Amount, AmountLib} from "../type/Amount.sol";
-import {Component} from "../shared/Component.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
+import {BUNDLE, COMPONENT, POOL} from "../type/ObjectType.sol";
 import {IBundleService} from "./IBundleService.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IPoolComponent} from "./IPoolComponent.sol";
 import {IPoolService} from "./IPoolService.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
+import {Fee, FeeLib} from "../type/Fee.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
-import {BUNDLE, POOL} from "../type/ObjectType.sol";
 import {RoleId, PUBLIC_ROLE} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 abstract contract Pool is
-    Component, 
+    InstanceLinkedComponent, 
     IPoolComponent 
 {
     // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Pool")) - 1)) & ~bytes32(uint256(0xff));
     bytes32 public constant POOL_STORAGE_LOCATION_V1 = 0x25e3e51823fbfffb988e0a2744bb93722d9f3e906c07cc0a9e77884c46c58300;
 
     struct PoolStorage {
+        IComponentService _componentService;
         IPoolService _poolService;
         IBundleService _bundleService;
     }
@@ -36,205 +39,243 @@ abstract contract Pool is
     }
 
 
-    modifier onlyPoolService() {
-        if(msg.sender != address(_getPoolStorage()._poolService)) {
-            revert ErrorPoolNotPoolService(msg.sender);
+    /// @dev see {IPoolComponent.verifyApplication}
+    function verifyApplication(
+        NftId applicationNftId, 
+        bytes memory applicationData,
+        NftId bundleNftId, 
+        bytes memory bundleFilter,
+        Amount collateralizationAmount
+    )
+        public
+        virtual
+        restricted()
+    {
+        if(!applicationMatchesBundle(
+            applicationNftId,
+            applicationData, 
+            bundleNftId, 
+            bundleFilter,
+            collateralizationAmount)
+        )
+        {
+            revert ErrorPoolApplicationBundleMismatch(applicationNftId);
         }
-        _;
+
+        emit LogPoolVerifiedByPool(address(this), applicationNftId, collateralizationAmount);
     }
 
 
-    function initializePool(
+    /// @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,
+        Amount collateralizationAmount
+    )
+        public
+        virtual
+        view
+        returns (bool isMatching)
+    {
+        return true;
+    }
+
+
+    function register()
+        external
+        virtual
+        onlyOwner()
+    {
+        _getPoolStorage()._componentService.registerPool();
+    }
+
+
+    function getInitialPoolInfo()
+        public 
+        virtual 
+        view 
+        returns (IComponents.PoolInfo memory poolInfo)
+    {
+        return IComponents.PoolInfo(
+            NftIdLib.zero(), // will be set when GIF registers the related product
+            PUBLIC_ROLE(), // bundleOwnerRole
+            AmountLib.max(), // maxCapitalAmount,
+            isNftInterceptor(), // isInterceptingBundleTransfers
+            false, // isExternallyManaged,
+            false, // isVerifyingApplications,
+            UFixedLib.toUFixed(1), // collateralizationLevel,
+            UFixedLib.toUFixed(1), // retentionLevel,
+            FeeLib.zero(), // initialPoolFee,
+            FeeLib.zero(), // initialStakingFee,
+            FeeLib.zero() // initialPerformanceFee,
+        );
+    }
+
+    // Internals
+
+    function _initializePool(
         address registry,
         NftId instanceNftId,
         string memory name,
         address token,
+        IAuthorization authorization,
         bool isInterceptingNftTransfers,
         address initialOwner,
-        bytes memory registryData // writeonly data that will saved in the object info record of the registry
+        bytes memory registryData, // writeonly data that will saved in the object info record of the registry
+        bytes memory componentData // component specifidc data 
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, registryData);
+        _initializeInstanceLinkedComponent(
+            registry, 
+            instanceNftId, 
+            name, 
+            token, 
+            POOL(), 
+            authorization, 
+            isInterceptingNftTransfers, 
+            initialOwner, 
+            registryData, 
+            componentData);
 
         PoolStorage storage $ = _getPoolStorage();
         $._poolService = IPoolService(_getServiceAddress(POOL())); 
         $._bundleService = IBundleService(_getServiceAddress(BUNDLE()));
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
 
         registerInterface(type(IPoolComponent).interfaceId);
     }
 
-
-    function stake(
+    /// @dev increases the staked tokens by the specified amount
+    /// bundle MUST be in active or locked state
+    function _stake(
         NftId bundleNftId, 
         Amount amount
     )
-        public
+        internal
         virtual
-        restricted()
-        onlyBundleOwner(bundleNftId)
     {
         // TODO add implementation
     }
 
 
-    function unstake(
+    /// @dev decreases the staked tokens by the specified amount
+    /// bundle MUST be in active, locked or closed state
+    function _unstake(
         NftId bundleNftId, 
         Amount amount
     )
-        public
+        internal
         virtual
-        restricted()
-        onlyBundleOwner(bundleNftId)
     {
         // TODO add implementation
     }
 
 
-    function extend(
+    /// @dev extends the bundle lifetime of the bundle by the specified time
+    /// bundle MUST be in active or locked state
+    function _extend(
         NftId bundleNftId, 
         Seconds lifetimeExtension
     )
-        public
+        internal
         virtual
-        restricted()
-        onlyBundleOwner(bundleNftId)
     {
         // TODO add implementation
     }
 
 
-    function lockBundle(NftId bundleNftId)
-        public
+    /// @dev Locks the specified bundle.
+    /// A bundle to be locked MUST be in active state.
+    /// Locked bundles may not be used to collateralize any new policy.
+    function _lockBundle(NftId bundleNftId)
+        internal
         virtual
-        //restricted() // TODO consider adding this back
-        onlyBundleOwner(bundleNftId)
     {
         _getPoolStorage()._bundleService.lock(bundleNftId);
     }
 
 
-    function unlockBundle(NftId bundleNftId)
-        public
+    /// @dev Unlocks the specified bundle.
+    /// A bundle to be unlocked MUST be in locked state.
+    function _unlockBundle(NftId bundleNftId)
+        internal
         virtual
-        //restricted()
-        onlyBundleOwner(bundleNftId)
     {
         _getPoolStorage()._bundleService.unlock(bundleNftId);
     }
 
 
-    function close(NftId bundleNftId)
-        public
+    /// @dev Close the specified bundle.
+    /// A bundle to be closed MUST be in active or locked state.
+    /// To close a bundle all all linked policies MUST be in closed state as well.
+    /// Closing a bundle finalizes the bundle bookkeeping including overall profit calculation.
+    /// Once a bundle is closed this action cannot be reversed.
+    function _close(NftId bundleNftId)
+        internal
         virtual
-        //restricted()
-        onlyBundleOwner(bundleNftId)
     {
         _getPoolStorage()._poolService.closeBundle(bundleNftId);
     }
 
 
-    function setBundleFee(
+    /// @dev Sets the fee for the specified bundle.
+    /// The fee is added on top of the poolFee and deducted from the premium amounts
+    /// Via these fees individual bundler owner may earn income per policy in the context of peer to peer pools.
+    function _setBundleFee(
         NftId bundleNftId, 
         Fee memory fee
     )
-        public
+        internal
         virtual
-        restricted()
-        onlyBundleOwner(bundleNftId)
     {
         _getPoolStorage()._bundleService.setFee(bundleNftId, fee);
     }
 
 
-    function setMaxCapitalAmount(Amount maxCapitalAmount)
-        public
+    /// @dev Sets the maximum overall capital amound held by this pool.
+    /// Function may only be called by pool owner.
+    function _setMaxCapitalAmount(Amount maxCapitalAmount)
+        internal
         virtual
-        restricted()
-        onlyOwner()
     {
         _getPoolStorage()._poolService.setMaxCapitalAmount(maxCapitalAmount);
     }
 
-
-    function setBundleOwnerRole(RoleId bundleOwnerRole)
-        public
+    /// @dev Sets the required role to create/own bundles.
+    /// May only be called once after setting up a pool.
+    /// May only be called by pool owner.
+    function _setBundleOwnerRole(RoleId bundleOwnerRole)
+        internal
         virtual
-        restricted()
-        onlyOwner()
     {
         _getPoolStorage()._poolService.setBundleOwnerRole(bundleOwnerRole);
     }
 
 
-    function setFees(
+    /// @dev Update pool fees to the specified values.
+    /// Pool fee: are deducted from the premium amount and goes to the pool owner.
+    /// Staking fee: are deducted from the staked tokens by a bundle owner and goes to the pool owner.
+    /// Performance fee: when a bundle is closed a bundle specific profit is calculated.
+    /// The performance fee is deducted from this profit and goes to the pool owner.
+    function _setPoolFees(
         Fee memory poolFee,
         Fee memory stakingFee,
         Fee memory performanceFee
     )
-        public
-        virtual
-        restricted()
-        onlyOwner()
-    {
-        _getPoolStorage()._poolService.setFees(poolFee, stakingFee, performanceFee);
-    }
-
-
-    /// @dev see {IPool.verifyApplication}
-    function verifyApplication(
-        NftId applicationNftId, 
-        bytes memory applicationData,
-        NftId bundleNftId, 
-        bytes memory bundleFilter,
-        Amount collateralizationAmount
-    )
-        public
+        internal
         virtual
-        restricted()
-    {
-        if(!applicationMatchesBundle(
-            applicationNftId,
-            applicationData, 
-            bundleNftId, 
-            bundleFilter,
-            collateralizationAmount)
-        )
-        {
-            revert ErrorPoolApplicationBundleMismatch(applicationNftId);
-        }
-
-        emit LogPoolVerifiedByPool(address(this), applicationNftId, collateralizationAmount);
-    }
-
-
-    /// @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,
-        Amount collateralizationAmount
-    )
-        public
-        view
-        virtual override
-        returns (bool isMatching)
     {
-        return true;
-    }
-
-
-    function getPoolInfo() external view returns (IComponents.PoolInfo memory poolInfo) {
-        poolInfo = abi.decode(getComponentInfo().data, (IComponents.PoolInfo));
+        _getPoolStorage()._componentService.setPoolFees(poolFee, stakingFee, performanceFee);
     }
 
-    // Internals
-
+    /// @dev Creates a new bundle using the provided parameter values.
     function _createBundle(
         address bundleOwner,
         Fee memory fee,
@@ -255,44 +296,12 @@ abstract contract Pool is
         // 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));
     }
 
-    /// @dev defines initial pool specification
-    /// overwrite this function according to your use case
-    function _getInitialInfo()
-        internal
-        view 
-        virtual override
-        returns (IComponents.ComponentInfo memory info)
-    {
-        return IComponents.ComponentInfo(
-            getName(),
-            getToken(),
-            TokenHandler(address(0)), // will be created by GIF service during registration
-            address(this), // contract is its own wallet
-            AmountLib.zero(), // balance amount
-            AmountLib.zero(), // fee amount
-            abi.encode(
-                IComponents.PoolInfo(
-                    NftIdLib.zero(), // will be set when GIF registers the related product
-                    PUBLIC_ROLE(), // bundleOwnerRole
-                    AmountLib.max(), // maxCapitalAmount,
-                    AmountLib.zero(), // initial balance amount
-                    AmountLib.zero(), // initial fee amount
-                    isNftInterceptor(), // isInterceptingBundleTransfers
-                    false, // isExternallyManaged,
-                    false, // isVerifyingApplications,
-                    UFixedLib.toUFixed(1), // collateralizationLevel,
-                    UFixedLib.toUFixed(1), // retentionLevel,
-                    FeeLib.zeroFee(), // initialPoolFee,
-                    FeeLib.zeroFee(), // initialStakingFee,
-                    FeeLib.zeroFee() // initialPerformanceFee,
-                )));
-    }
-
 
     function _getPoolStorage() private pure returns (PoolStorage storage $) {
         assembly {