@etherisc/gif-next 0.0.2-f347f00-614 → 0.0.2-f36fd21-685

package/contracts/pool/BasicPoolAuthorization.sol

@@ -0,0 +1,55 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Authorization} from "../authorization/Authorization.sol";
+import {BasicPool} from "./BasicPool.sol"; 
+import {IAccess} from "../authorization/IAccess.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+import {IPoolComponent} from "./IPoolComponent.sol";
+import {POOL} from "../type/ObjectType.sol";
+import {PUBLIC_ROLE} from "../../contracts/type/RoleId.sol";
+import {RoleId} from "../type/RoleId.sol";
+
+
+contract BasicPoolAuthorization
+     is Authorization
+{
+
+     constructor(string memory poolName)
+          Authorization(poolName)
+     {}
+
+     function _setupTargets()
+          internal
+          virtual override
+     {
+          _addComponentTargetWithRole(POOL()); // basic pool target
+     }
+
+
+     function _setupTargetAuthorizations()
+          internal
+          virtual override
+     {
+          IAccess.FunctionInfo[] storage functions;
+
+          // authorize public role (open access to any account, only allows to lock target)
+          functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+          _authorize(functions, BasicPool.stake.selector, "stake");
+          _authorize(functions, BasicPool.unstake.selector, "unstake");
+          _authorize(functions, BasicPool.extend.selector, "extend");
+          _authorize(functions, BasicPool.lockBundle.selector, "lockBundle");
+          _authorize(functions, BasicPool.unlockBundle.selector, "unlockBundle");
+          _authorize(functions, BasicPool.close.selector, "close");
+          _authorize(functions, BasicPool.setBundleFee.selector, "setBundleFee");
+
+          _authorize(functions, BasicPool.setMaxCapitalAmount.selector, "setMaxCapitalAmount");
+          _authorize(functions, BasicPool.setBundleOwnerRole.selector, "setBundleOwnerRole");
+          _authorize(functions, BasicPool.setFees.selector, "setFees");
+
+          _authorize(functions, IInstanceLinkedComponent.withdrawFees.selector, "withdrawFees");
+
+          _authorize(functions, IPoolComponent.withdrawBundleFees.selector, "withdrawBundleFees");
+     }
+}
+

package/contracts/pool/BundleService.sol

@@ -1,37 +1,28 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.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 {IRegistry} from "../registry/IRegistry.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {INftOwnable} from "../shared/INftOwnable.sol";
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {BundleSet} from "../instance/BundleSet.sol";
+import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+import {Fee} from "../type/Fee.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {ObjectType, COMPONENT, POOL, BUNDLE, REGISTRY} from "../type/ObjectType.sol";
-import {POOL_OWNER_ROLE, RoleId} from "../type/RoleId.sol";
-import {Pool} from "./Pool.sol";
-
-import {Amount, AmountLib} from "../type/Amount.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
 import {StateId, ACTIVE, PAUSED, CLOSED, KEEP_STATE} from "../type/StateId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
-import {Version, VersionLib} from "../type/Version.sol";
-import {Versionable} from "../shared/Versionable.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 {IRegistryService} from "../registry/IRegistryService.sol";
-import {InstanceService} from "../instance/InstanceService.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
 
 string constant BUNDLE_SERVICE_NAME = "BundleService";
 
@@ -39,8 +30,7 @@ contract BundleService is
     ComponentVerifyingService, 
     IBundleService 
 {
-    using NftIdLib for NftId;
-
+    
     string public constant NAME = "BundleService";
 
     address private _registryAddress;
@@ -139,7 +129,7 @@ contract BundleService is
             AmountLib.zero()); // fee amount
 
         // put bundle under bundle managemet
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         bundleManager.add(bundleNftId);
 
         // TODO add logging
@@ -197,7 +187,7 @@ contract BundleService is
         instance.getInstanceStore().updateBundleState(bundleNftId, PAUSED());
 
         // update set of active bundles
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         bundleManager.lock(bundleNftId);
 
         emit LogBundleServiceBundleLocked(bundleNftId);
@@ -214,7 +204,7 @@ contract BundleService is
         instance.getInstanceStore().updateBundleState(bundleNftId, ACTIVE());
 
         // update set of active bundles
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         bundleManager.unlock(bundleNftId);
 
         emit LogBundleServiceBundleActivated(bundleNftId);
@@ -233,7 +223,7 @@ contract BundleService is
         instance.getInstanceStore().updateBundleState(bundleNftId, CLOSED());
 
         // ensure no open policies attached to bundle
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         uint256 openPolicies = bundleManager.activePolicies(bundleNftId);
         if(openPolicies > 0) {
             revert ErrorBundleServiceBundleWithOpenPolicies(bundleNftId, openPolicies);
@@ -271,7 +261,62 @@ contract BundleService is
             revert ErrorBundleServicePolicyNotCloseable(policyNftId);
         }
 
-        instance.getBundleManager().unlinkPolicy(policyNftId);
+        instance.getBundleSet().unlinkPolicy(policyNftId);
+    }
+
+    /// @inheritdoc IBundleService
+    function withdrawBundleFees(NftId bundleNftId, Amount amount) 
+        public 
+        virtual
+        // TODO: restricted() (once #462 is done)
+        returns (Amount withdrawnAmount) 
+    {
+        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        InstanceReader reader = instance.getInstanceReader();
+        
+        IComponents.ComponentInfo memory poolInfo = reader.getComponentInfo(poolNftId);
+        address poolWallet = poolInfo.wallet;
+        
+        IBundle.BundleInfo memory bundleInfo = reader.getBundleInfo(bundleNftId);
+        
+        // determine withdrawn amount
+        withdrawnAmount = amount;
+        if (withdrawnAmount.gte(AmountLib.max())) {
+            withdrawnAmount = reader.getFeeAmount(bundleNftId);
+        } else {
+            if (withdrawnAmount.gt(reader.getFeeAmount(bundleNftId))) {
+                revert ErrorBundleServiceFeesWithdrawAmountExceedsLimit(withdrawnAmount, reader.getFeeAmount(bundleNftId));
+            }
+        }
+
+        if (withdrawnAmount.eqz()) {
+            revert ErrorBundleServiceFeesWithdrawAmountIsZero();
+        }
+
+        // check allowance
+        IERC20Metadata token = IERC20Metadata(poolInfo.token);
+        uint256 tokenAllowance = token.allowance(poolWallet, address(poolInfo.tokenHandler));
+        if (tokenAllowance < withdrawnAmount.toInt()) {
+            revert ErrorBundleServiceWalletAllowanceTooSmall(poolWallet, address(poolInfo.tokenHandler), tokenAllowance, withdrawnAmount.toInt());
+        }
+
+        // decrease fee counters by withdrawnAmount
+        {
+            InstanceStore store = instance.getInstanceStore();
+            // decrease fee amount of the bundle
+            _componentService.decreaseBundleBalance(store, bundleNftId, AmountLib.zero(), withdrawnAmount);
+            // decrease pool balance 
+            _componentService.decreasePoolBalance(store, poolNftId, withdrawnAmount, AmountLib.zero());
+        }
+
+        // transfer amount to bundle owner
+        {
+            address owner = getRegistry().ownerOf(bundleNftId);
+            // TODO: centralize token handling (issue #471)
+            poolInfo.tokenHandler.transfer(poolWallet, owner, withdrawnAmount);
+
+            emit LogBundleServiceFeesWithdrawn(bundleNftId, owner, address(token), withdrawnAmount);
+        }
     }
 
     /// @dev links policy to bundle
@@ -283,10 +328,10 @@ contract BundleService is
 
         // ensure policy has not yet been activated in a previous tx already
         if (policyInfo.activatedAt.gtz() && policyInfo.activatedAt < TimestampLib.blockTimestamp()) {
-            revert BundleManager.ErrorBundleManagerPolicyAlreadyActivated(policyNftId);
+            revert BundleSet.ErrorBundleSetPolicyAlreadyActivated(policyNftId);
         }
         
-        BundleManager bundleManager = instance.getBundleManager();
+        BundleSet bundleManager = instance.getBundleSet();
         bundleManager.linkPolicy(policyNftId);
     }
 

package/contracts/pool/BundleServiceManager.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 {BundleService} from "./BundleService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {ObjectType, REGISTRY} from "../type/ObjectType.sol";
 
 contract BundleServiceManager is ProxyManager {
 

package/contracts/pool/IBundleService.sol

@@ -26,6 +26,13 @@ interface IBundleService is IService {
 
     error ErrorBundleServicePolicyNotCloseable(NftId policyNftId);
 
+    // error ErrorBundleServiceBundleNotActive(NftId distributorNftId);
+    error ErrorBundleServiceFeesWithdrawAmountExceedsLimit(Amount amount, Amount limit);
+    error ErrorBundleServiceFeesWithdrawAmountIsZero();
+    error ErrorBundleServiceWalletAllowanceTooSmall(address wallet, address tokenHandler, uint256 allowance, uint256 amount);
+
+    event LogBundleServiceFeesWithdrawn(NftId bundleNftId, address recipient, address tokenAddress, Amount amount);
+
     /// @dev create a new bundle for the specified attributes
     /// may only be called by pool service
     function create(
@@ -103,4 +110,11 @@ interface IBundleService is IService {
         IInstance instance, 
         NftId policyNftId
     ) external;
+
+    /// @dev Withdraw bundle feeds for the given bundle
+    /// @param bundleNftId the bundle Nft Id
+    /// @param amount the amount to withdraw. If set to AMOUNT_MAX, the full commission available is withdrawn
+    /// @return withdrawnAmount the effective withdrawn amount
+    function withdrawBundleFees(NftId bundleNftId, Amount amount) external returns (Amount withdrawnAmount);
+
 }

package/contracts/pool/IPoolComponent.sol

@@ -16,70 +16,10 @@ interface IPoolComponent is IInstanceLinkedComponent {
 
     error ErrorPoolNotBundleOwner(NftId bundleNftId, address caller);
     error ErrorPoolNotPoolService(address caller);
-
     error ErrorPoolApplicationBundleMismatch(NftId applicationNftId);
 
     event LogPoolVerifiedByPool(address pool, NftId applicationNftId, Amount collateralizationAmount);
 
-    /// @dev increases the staked tokens by the specified amount
-    /// only the bundle owner may stake tokens
-    /// bundle MUST be in active or locked state
-    function stake(NftId bundleNftId, Amount amount) external;
-
-    /// @dev decreases the staked tokens by the specified amount
-    /// only the bundle owner may unstake tokens from the bundle
-    /// bundle MUST be in active, locked or closed state
-    function unstake(NftId bundleNftId, Amount amount) external;
-
-    /// @dev extends the bundle lifetime of the bundle by the specified time
-    /// only the bundle owner may extend the bundle's lifetime
-    /// bundle MUST be in active or locked state
-    function extend(NftId bundleNftId, Seconds lifetimeExtension) external;
-
-    /// @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) external;
-
-    /// @dev unlocks the specified bundle
-    /// a bundle to be unlocked MUST be in locked state
-    function unlockBundle(NftId bundleNftId) external;
-
-    /// @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) external;
-
-    /// @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
-    ) external;
-
-    /// @dev sets the maximum overall capital amound held by this pool
-    /// function may only be called by pool owner
-    function setMaxCapitalAmount(Amount maxCapitalAmount) external;
-
-    /// @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) external;
-
-    /// @dev update pool fees to the specified values
-    /// pool fees: are deducted from the premium amount and goes to the pool owner
-    /// staking fees: are deducted from the staked tokens by a bundle owner and goes to the pool owner
-    /// performance fees: 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 setFees(
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
-
     /// @dev this is a callback function that is called by the product service when underwriting a policy.
     /// the pool has the option to check the details and object to underwriting by reverting.
     /// the function is only called for "active" pools that ask to be involved/notified
@@ -106,6 +46,12 @@ interface IPoolComponent is IInstanceLinkedComponent {
         view
         returns (bool isMatching);
 
+    /// @dev Withdraw bundle feeds for the given bundle
+    /// @param bundleNftId the bundle Nft Id
+    /// @param amount the amount to withdraw. If set to AMOUNT_MAX, the full commission available is withdrawn
+    /// @return withdrawnAmount the effective withdrawn amount
+    function withdrawBundleFees(NftId bundleNftId, Amount amount) external returns (Amount withdrawnAmount);
+
     /// @dev returns initial pool specific infos for this pool
     function getInitialPoolInfo() external view returns (IComponents.PoolInfo memory info);