@etherisc/gif-next 0.0.2-79d46a9-598 → 0.0.2-7a0dfe9-847

package/contracts/pool/Pool.sol

@@ -2,15 +2,16 @@
 pragma solidity ^0.8.20;
 
 import {Amount, AmountLib} from "../type/Amount.sol";
-import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.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, COMPONENT, 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";
@@ -38,29 +39,122 @@ 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);
+    }
+
+
+    /// @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();
+        _approveTokenHandler(type(uint256).max);
+    }
+
+    /// @inheritdoc IPoolComponent
+    function withdrawBundleFees(NftId bundleNftId, Amount amount) 
+        external 
+        virtual
+        restricted()
+        onlyBundleOwner(bundleNftId)
+        returns (Amount withdrawnAmount) 
+    {
+        return _withdrawBundleFees(bundleNftId, amount);
+    }
+
+
+    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(
+    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 componentData // component specifidc data 
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeInstanceLinkedComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, registryData, componentData);
+        _initializeInstanceLinkedComponent(
+            registry, 
+            instanceNftId, 
+            name, 
+            token, 
+            POOL(), 
+            authorization, 
+            isInterceptingNftTransfers, 
+            initialOwner, 
+            registryData, 
+            componentData);
 
         PoolStorage storage $ = _getPoolStorage();
         $._poolService = IPoolService(_getServiceAddress(POOL())); 
@@ -70,201 +164,132 @@ abstract contract Pool is
         registerInterface(type(IPoolComponent).interfaceId);
     }
 
-
-    function register()
-        external
-        virtual
-        onlyOwner()
-    {
-        _getPoolStorage()._componentService.registerPool();
-    }
-
-
-    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)
+        returns(Amount netAmount) 
     {
-        // TODO add implementation
+        _getPoolStorage()._poolService.stake(bundleNftId, amount);
     }
 
 
-    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)
+        returns(Amount netAmount) 
     {
-        // TODO add implementation
+        return _getPoolStorage()._poolService.unstake(bundleNftId, amount);
     }
 
 
-    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
+        internal
         virtual
-        restricted()
-        onlyOwner()
     {
         _getPoolStorage()._componentService.setPoolFees(poolFee, stakingFee, performanceFee);
     }
 
-
-    /// @dev see {IPool.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);
-    }
-
-
-    /// @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 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
-
+    /// @dev Creates a new bundle using the provided parameter values.
     function _createBundle(
         address bundleOwner,
         Fee memory fee,
@@ -290,6 +315,12 @@ abstract contract Pool is
         return keccak256(abi.encode(uint256(keccak256(name)) - 1)) & ~bytes32(uint256(0xff));
     }
 
+    function _withdrawBundleFees(NftId bundleNftId, Amount amount) 
+        internal
+        returns (Amount withdrawnAmount) 
+    {
+        return _getPoolStorage()._bundleService.withdrawBundleFees(bundleNftId, amount);
+    }
 
     function _getPoolStorage() private pure returns (PoolStorage storage $) {
         assembly {

package/contracts/pool/PoolService.sol

@@ -1,46 +1,30 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Pool} from "./Pool.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {IBundle} from "../instance/module/IBundle.sol";
+import {IBundleService} from "./IBundleService.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {IInstance} from "../instance/IInstance.sol";
+import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
-
-import {IVersionable} from "../shared/IVersionable.sol";
-import {Versionable} from "../shared/Versionable.sol";
-import {INftOwnable} from "../shared/INftOwnable.sol";
+import {IPoolService} from "./IPoolService.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
+import {IStaking} from "../staking/IStaking.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {Fee, FeeLib} from "../type/Fee.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
-import {ObjectType, POOL, BUNDLE, COMPONENT, INSTANCE, REGISTRY, STAKING} from "../type/ObjectType.sol";
-import {PUBLIC_ROLE, POOL_OWNER_ROLE, POLICY_SERVICE_ROLE, RoleId} from "../type/RoleId.sol";
+import {ObjectType, POOL, BUNDLE, COMPONENT, INSTANCE, REGISTRY} from "../type/ObjectType.sol";
+import {RoleId, PUBLIC_ROLE} from "../type/RoleId.sol";
 import {Fee, FeeLib} from "../type/Fee.sol";
-import {Version, VersionLib} from "../type/Version.sol";
-import {KEEP_STATE, StateId} from "../type/StateId.sol";
+import {KEEP_STATE} from "../type/StateId.sol";
 import {Seconds} from "../type/Seconds.sol";
-import {TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {UFixed} from "../type/UFixed.sol";
-import {Version, VersionLib} from "../type/Version.sol";
-
-import {IService} from "../shared/IService.sol";
-import {Service} from "../shared/Service.sol";
-import {BundleManager} from "../instance/BundleManager.sol";
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
-import {IBundleService} from "./IBundleService.sol";
-import {IComponentService} from "../shared/IComponentService.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
-import {IPoolService} from "./IPoolService.sol";
-import {IRegistryService} from "../registry/IRegistryService.sol";
-import {IStaking} from "../staking/IStaking.sol";
-import {InstanceService} from "../instance/InstanceService.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
-import {IComponent} from "../shared/IComponent.sol";
-import {IPoolComponent} from "./IPoolComponent.sol";
 
 string constant POOL_SERVICE_NAME = "PoolService";
 
@@ -48,9 +32,6 @@ contract PoolService is
     ComponentVerifyingService, 
     IPoolService 
 {
-    using NftIdLib for NftId;
-    using AmountLib for Amount;
-
     IBundleService internal _bundleService;
     IComponentService internal _componentService;
     IInstanceService private _instanceService;
@@ -219,6 +200,25 @@ contract PoolService is
         emit LogPoolServiceBundleClosed(instance.getNftId(), poolNftId, bundleNftId);
     }
 
+    function stake(NftId bundleNftId, Amount amount) 
+        external 
+        virtual
+        restricted()
+        returns(Amount netAmount) 
+    {
+        // TODO: implement
+        revert();
+    }
+
+    function unstake(NftId bundleNftId, Amount amount) 
+        external 
+        virtual
+        restricted()
+        returns(Amount netAmount) 
+    {
+        // TODO: implement
+        revert();
+    }
 
     function processSale(
         NftId bundleNftId, 
@@ -439,6 +439,7 @@ contract PoolService is
         address poolWallet = componentInfo.wallet;
 
         if(amount.gtz()) {
+            // TODO: centralize token handling (issue #471)
             tokenHandler.transfer(
                 bundleOwner,
                 poolWallet,

package/contracts/pool/PoolServiceManager.sol

@@ -1,12 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {PoolService} from "./PoolService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {REGISTRY} from "../type/ObjectType.sol";
 
 contract PoolServiceManager is ProxyManager {
 

package/contracts/product/ApplicationService.sol

@@ -1,51 +1,27 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IApplicationService} from "./IApplicationService.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
+import {IInstance} from "../instance/IInstance.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IPolicy} from "../instance/module/IPolicy.sol";
+import {IDistributionService} from "../distribution/IDistributionService.sol";
+import {IPricingService} from "./IPricingService.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
+
 import {AmountLib} from "../type/Amount.sol";
 import {Seconds} from "../type/Seconds.sol";
-import {Timestamp, TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
-import {Blocknumber, blockNumber} from "../type/Blocknumber.sol";
-import {ObjectType, DISTRIBUTION, INSTANCE, PRODUCT, POOL, REGISTRY, APPLICATION, POLICY, BUNDLE, PRICE} from "../type/ObjectType.sol";
-import {APPLIED, REVOKED, ACTIVE, KEEP_STATE} from "../type/StateId.sol";
+import {zeroTimestamp} from "../type/Timestamp.sol";
+import {ObjectType, DISTRIBUTION, PRODUCT, REGISTRY, APPLICATION, POLICY, PRICE} from "../type/ObjectType.sol";
+import {REVOKED} from "../type/StateId.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {RiskId} from "../type/RiskId.sol";
-import {StateId} from "../type/StateId.sol";
-import {Version, VersionLib} from "../type/Version.sol";
 import {Amount, AmountLib} from "../type/Amount.sol";
-
-import {TokenHandler} from "../shared/TokenHandler.sol";
-import {IVersionable} from "../shared/IVersionable.sol";
-import {Versionable} from "../shared/Versionable.sol";
-import {IService} from "../shared/IService.sol";
-import {Service} from "../shared/Service.sol";
-
-import {IRegistry} from "../registry/IRegistry.sol";
-
-import {IProductComponent} from "./IProductComponent.sol";
-import {IPoolComponent} from "../pool/IPoolComponent.sol";
-import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
-import {Product} from "./Product.sol";
-
-import {IComponents} from "../instance/module/IComponents.sol";
-import {IPolicy} from "../instance/module/IPolicy.sol";
-import {IRisk} from "../instance/module/IRisk.sol";
-import {IBundle} from "../instance/module/IBundle.sol";
-import {IProductService} from "./IProductService.sol";
-
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
-
-import {IInstance} from "../instance/IInstance.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 
-import {IApplicationService} from "./IApplicationService.sol";
-import {IBundleService} from "../pool/IBundleService.sol";
-import {IDistributionService} from "../distribution/IDistributionService.sol";
-import {IPoolService} from "../pool/IPoolService.sol";
-import {IPricingService} from "./IPricingService.sol";
-import {IRegistryService} from "../registry/IRegistryService.sol";
 
 
 contract ApplicationService is 

package/contracts/product/ApplicationServiceManager.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {ApplicationService} from "./ApplicationService.sol";
 
 contract ApplicationServiceManager is ProxyManager {