@etherisc/gif-next 0.0.2-95b223b-528 → 0.0.2-95f0eec-843

package/contracts/pool/BasicPoolAuthorization.sol

@@ -1,14 +1,16 @@
 // 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 {Authorization} from "../authorization/Authorization.sol";
+import {BasicPool} from "./BasicPool.sol"; 
+import {COMPONENT, POOL} from "../type/ObjectType.sol";
 import {PUBLIC_ROLE} from "../../contracts/type/RoleId.sol";
 import {RoleId} from "../type/RoleId.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 
 
 contract BasicPoolAuthorization
@@ -16,23 +18,36 @@ contract BasicPoolAuthorization
 {
 
      constructor(string memory poolName)
-          Authorization(poolName)
+          Authorization(
+               poolName, 
+               POOL(), 
+               3,
+               COMMIT_HASH,
+               true, 
+               true)
      {}
 
      function _setupServiceTargets()
           internal
           virtual override
      {
-          _addServiceTargetWithRole(POOL());
+          _authorizeServiceDomain(COMPONENT(), address(11));
+          _authorizeServiceDomain(POOL(), address(12));
      }
 
-     function _setupTargets()
-          internal
-          virtual override
-     {
-          _addComponentTargetWithRole(POOL()); // basic pool target
-     }
+     function _setupTokenHandlerAuthorizations() internal virtual override {
+          // authorize token handler functions for component service role
+          IAccess.FunctionInfo[] storage functions;
+          functions = _authorizeForTarget(getTokenHandlerName(), getServiceRole(COMPONENT()));
+          _authorize(functions, TokenHandler.approve.selector, "approve");
+          _authorize(functions, TokenHandler.setWallet.selector, "setWallet");
+          _authorize(functions, TokenHandler.pushFeeToken.selector, "pushFeeToken");
 
+          // authorize token handler functions for pool service role
+          functions = _authorizeForTarget(getTokenHandlerName(), getServiceRole(POOL()));
+          _authorize(functions, TokenHandler.pullToken.selector, "pullToken");
+          _authorize(functions, TokenHandler.pushToken.selector, "pushToken");
+     }
 
      function _setupTargetAuthorizations()
           internal
@@ -41,12 +56,11 @@ contract BasicPoolAuthorization
           IAccess.FunctionInfo[] storage functions;
 
           // authorize public role (open access to any account, only allows to lock target)
-          functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+          functions = _authorizeForTarget(getMainTargetName(), 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.setBundleLocked.selector, "setBundleLocked");
           _authorize(functions, BasicPool.closeBundle.selector, "closeBundle");
           _authorize(functions, BasicPool.setBundleFee.selector, "setBundleFee");
 
@@ -57,11 +71,10 @@ contract BasicPoolAuthorization
           _authorize(functions, BasicPool.extend.selector, "extend");
 
           _authorize(functions, IInstanceLinkedComponent.withdrawFees.selector, "withdrawFees");
-
           _authorize(functions, BasicPool.withdrawBundleFees.selector, "withdrawBundleFees");
 
           // authorize pool service
-          functions = _authorizeForTarget(getTargetName(), getServiceRole(POOL()));
+          functions = _authorizeForTarget(getMainTargetName(), getServiceRole(POOL()));
           _authorize(functions, IPoolComponent.verifyApplication.selector, "verifyApplication");
      }
 }

package/contracts/pool/BundleService.sol

@@ -4,7 +4,6 @@ pragma solidity ^0.8.20;
 import {IAccountingService} from "../accounting/IAccountingService.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";
@@ -13,19 +12,19 @@ import {InstanceStore} from "../instance/InstanceStore.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, ACCOUNTING, COMPONENT, POOL, BUNDLE, POLICY, REGISTRY} from "../type/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED, CLOSED, KEEP_STATE} from "../type/StateId.sol";
+import {PoolLib} from "./PoolLib.sol";
 import {Seconds} from "../type/Seconds.sol";
+import {Service} from "../shared/Service.sol";
+import {StateId, ACTIVE, PAUSED, CLOSED, KEEP_STATE} from "../type/StateId.sol";
 import {Timestamp, TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
 
-string constant BUNDLE_SERVICE_NAME = "BundleService";
 
 contract BundleService is 
-    ComponentVerifyingService, 
+    Service, 
     IBundleService 
 {
     
@@ -45,11 +44,11 @@ contract BundleService is
         initializer()
     {
         (
-            address registryAddress,
-            address authority
+            address authority,
+            address registry
         ) = abi.decode(data, (address, address));
 
-        _initializeService(registryAddress, authority, owner);
+        __Service_init(authority, registry, owner);
 
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
         _accountingService = IAccountingService(_getServiceAddress(ACCOUNTING()));
@@ -69,7 +68,7 @@ contract BundleService is
     {
         _checkNftType(bundleNftId, BUNDLE());
 
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
         InstanceReader instanceReader = instance.getInstanceReader();
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
         if(bundleInfo.poolNftId.eqz()) {
@@ -82,6 +81,8 @@ contract BundleService is
 
         bundleInfo.fee = fee;
         instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+
+        emit LogBundleServiceBundleFeeUpdated(bundleNftId, fee.fixedFee, fee.fractionalFee);
     }
 
 
@@ -96,7 +97,7 @@ contract BundleService is
         restricted()
         returns(NftId bundleNftId)
     {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
 
         // register bundle with registry
         bundleNftId = _registryService.registerBundle(
@@ -129,7 +130,7 @@ contract BundleService is
         BundleSet bundleManager = instance.getBundleSet();
         bundleManager.add(bundleNftId);
 
-        emit LogBundleServiceBundleCreated(bundleNftId, poolNftId);
+        emit LogBundleServiceBundleCreated(bundleNftId, poolNftId, lifetime);
     }
 
 
@@ -144,6 +145,7 @@ contract BundleService is
         virtual
         restricted()
     {
+        // checks
         _checkNftType(policyNftId, POLICY());
         _checkNftType(bundleNftId, BUNDLE());
 
@@ -175,50 +177,37 @@ contract BundleService is
             }
         }
 
+        // effects
         // updated locked amount
         instanceStore.increaseLocked(bundleNftId, collateralAmount);
-    }
-
-
-    function lock(NftId bundleNftId) 
-        external
-        virtual
-        restricted()
-    {
-        _checkNftType(bundleNftId, BUNDLE());
-
-        (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
-
-        // udpate bundle state
-        instance.getInstanceStore().updateBundleState(bundleNftId, PAUSED());
-
-        // update set of active bundles
-        BundleSet bundleManager = instance.getBundleSet();
-        bundleManager.lock(bundleNftId);
 
-        emit LogBundleServiceBundleLocked(bundleNftId);
+        emit LogBundleServiceCollateralLocked(bundleNftId, policyNftId, collateralAmount);
     }
 
 
-    function unlock(NftId bundleNftId) 
+    function setLocked(NftId bundleNftId, bool locked) 
         external
         virtual
         restricted()
     {
+        // checks
         _checkNftType(bundleNftId, BUNDLE());
 
-        (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
-
-        // udpate bundle state
-        instance.getInstanceStore().updateBundleState(bundleNftId, ACTIVE());
+        (, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
 
+        // effects
         // update set of active bundles
         BundleSet bundleManager = instance.getBundleSet();
-        bundleManager.unlock(bundleNftId);
 
-        emit LogBundleServiceBundleActivated(bundleNftId);
+        if (locked) {
+            bundleManager.lock(bundleNftId);
+            emit LogBundleServiceBundleLocked(bundleNftId);
+        } else {
+            bundleManager.unlock(bundleNftId);
+            emit LogBundleServiceBundleUnlocked(bundleNftId);
+        }
     }
-
+    
 
     function close(
         IInstance instance,
@@ -229,6 +218,7 @@ contract BundleService is
         restricted()
         returns (Amount unstakedAmount, Amount feeAmount)
     {
+        // checks
         _checkNftType(bundleNftId, BUNDLE());
 
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -240,6 +230,7 @@ contract BundleService is
             revert ErrorBundleServiceBundleWithOpenPolicies(bundleNftId, openPolicies);
         }
 
+        // effects
         {
             // update bundle state
             InstanceStore instanceStore = instance.getInstanceStore();
@@ -252,11 +243,14 @@ contract BundleService is
             unstakedAmount = balanceAmountWithFees - feeAmount;
             _accountingService.decreaseBundleBalance(instanceStore, bundleNftId, unstakedAmount, feeAmount);
         }
+
+        emit LogBundleServiceBundleClosed(bundleNftId);
     }
 
     /// @inheritdoc IBundleService
     function stake(
-        IInstance instance,
+        InstanceReader instanceReader,
+        InstanceStore instanceStore,
         NftId bundleNftId, 
         Amount amount
     ) 
@@ -264,10 +258,11 @@ contract BundleService is
         virtual
         restricted()
     {
+        // checks
         _checkNftType(bundleNftId, BUNDLE());
 
-        IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
-        StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
+        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+        StateId bundleState = instanceReader.getBundleState(bundleNftId);
 
         if( (bundleState != ACTIVE() && bundleState != PAUSED()) // locked bundles can be staked
             || bundleInfo.expiredAt < TimestampLib.blockTimestamp() 
@@ -275,16 +270,19 @@ contract BundleService is
             revert ErrorBundleServiceBundleNotOpen(bundleNftId, bundleState, bundleInfo.expiredAt);
         }
 
+        // effects
         _accountingService.increaseBundleBalance(
-            instance.getInstanceStore(), 
+            instanceStore, 
             bundleNftId, 
             amount, 
             AmountLib.zero());
+
+        emit LogBundleServiceBundleStaked(bundleNftId, amount);
     }
 
     /// @inheritdoc IBundleService
     function unstake(
-        IInstance instance, 
+        InstanceStore instanceStore,
         NftId bundleNftId, 
         Amount amount
     ) 
@@ -293,9 +291,9 @@ contract BundleService is
         restricted()
         returns (Amount unstakedAmount)
     {
+        // checks
         _checkNftType(bundleNftId, BUNDLE());
 
-        InstanceStore instanceStore = instance.getInstanceStore();
         (
             Amount balanceAmount,
             Amount lockedAmount,
@@ -315,11 +313,14 @@ contract BundleService is
             revert ErrorBundleServiceUnstakeAmountExceedsLimit(amount, availableAmount);
         }
 
+        // effects
         _accountingService.decreaseBundleBalance(
             instanceStore, 
             bundleNftId, 
             unstakedAmount, 
             AmountLib.zero());
+        
+        emit LogBundleServiceBundleUnstaked(bundleNftId, unstakedAmount);
     }
 
     /// @inheritdoc IBundleService
@@ -329,9 +330,10 @@ contract BundleService is
         restricted()
         returns (Timestamp extendedExpiredAt) 
     {
+        // checks
         _checkNftType(bundleNftId, BUNDLE());
 
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
         IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
         StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
 
@@ -349,17 +351,18 @@ contract BundleService is
             revert ErrorBundleServiceExtensionLifetimeIsZero();
         }
 
+        // effects
         bundleInfo.expiredAt = bundleInfo.expiredAt.addSeconds(lifetimeExtension);
-        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+        extendedExpiredAt = bundleInfo.expiredAt;
 
-        emit LogBundleServiceBundleExtended(bundleNftId, lifetimeExtension, bundleInfo.expiredAt);
+        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
 
-        return bundleInfo.expiredAt;
+        emit LogBundleServiceBundleExtended(bundleNftId, lifetimeExtension, extendedExpiredAt);
     }
 
 
     function releaseCollateral(
-        IInstance instance,
+        InstanceStore instanceStore,
         NftId policyNftId, 
         NftId bundleNftId, 
         Amount collateralAmount
@@ -371,54 +374,12 @@ contract BundleService is
         _checkNftType(policyNftId, POLICY());
         _checkNftType(bundleNftId, BUNDLE());
 
-        instance.getInstanceStore().decreaseLocked(bundleNftId, collateralAmount);
-    }
-
-
-    /// @inheritdoc IBundleService
-    function withdrawBundleFees(NftId bundleNftId, Amount amount) 
-        public 
-        virtual
-        restricted()
-        returns (Amount withdrawnAmount) 
-    {
-        _checkNftType(bundleNftId, BUNDLE());
+        instanceStore.decreaseLocked(bundleNftId, collateralAmount);
 
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
-        InstanceReader reader = instance.getInstanceReader();
-        
-        IComponents.ComponentInfo memory poolInfo = reader.getComponentInfo(poolNftId);
-        address poolWallet = poolInfo.tokenHandler.getWallet();
-        
-        // 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));
-            }
-        }
-
-        // decrease fee counters by withdrawnAmount
-        {
-            InstanceStore store = instance.getInstanceStore();
-            // decrease fee amount of the bundle
-            _accountingService.decreaseBundleBalance(store, bundleNftId, AmountLib.zero(), withdrawnAmount);
-            // decrease pool balance 
-            _accountingService.decreasePoolBalance(store, poolNftId, withdrawnAmount, AmountLib.zero());
-        }
-
-        // transfer amount to bundle owner
-        {
-            address owner = getRegistry().ownerOf(bundleNftId);
-            emit LogBundleServiceFeesWithdrawn(bundleNftId, owner, address(poolInfo.token), withdrawnAmount);
-            poolInfo.tokenHandler.distributeTokens(poolWallet, owner, withdrawnAmount);
-        }
+        emit LogBundleServiceCollateralReleased(bundleNftId, policyNftId, collateralAmount);
     }
 
+
     function _getDomain() internal pure override returns(ObjectType) {
         return BUNDLE();
     }

package/contracts/pool/BundleServiceManager.sol

@@ -17,7 +17,7 @@ contract BundleServiceManager is ProxyManager {
     ) 
     {
         BundleService svc = new BundleService{salt: salt}();
-        bytes memory data = abi.encode(registry, authority);
+        bytes memory data = abi.encode(authority, registry);
         IVersionable versionable = initialize(
             registry,
             address(svc), 

package/contracts/pool/IBundleService.sol

@@ -1,21 +1,21 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IService} from "../shared/IService.sol";
+import {IInstance} from "../instance/IInstance.sol";
+
 import {Amount} from "../type/Amount.sol";
 import {NftId} from "../type/NftId.sol";
 import {Fee} from "../type/Fee.sol";
-import {IService} from "../shared/IService.sol";
-import {IInstance} from "../instance/IInstance.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {InstanceStore} from "../instance/InstanceStore.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {StateId} from "../type/StateId.sol";
 import {Timestamp} from "../type/Timestamp.sol";
+import {UFixed} from "../type/UFixed.sol";
 
 interface IBundleService is IService {
 
-    event LogBundleServiceBundleCreated(NftId bundleNftId, NftId poolNftId);
-    event LogBundleServiceBundleActivated(NftId bundleNftId);
-    event LogBundleServiceBundleLocked(NftId bundleNftId);
-
     error ErrorBundleServiceInsufficientAllowance(address bundleOwner, address tokenHandlerAddress, Amount amount);
     error ErrorBundleServiceBundleNotOpen(NftId bundleNftId, StateId state, Timestamp expiredAt);
     error ErrorBundleServiceCapacityInsufficient(NftId bundleNftId, Amount capacityAmount, Amount collateralAmount);
@@ -25,15 +25,21 @@ interface IBundleService is IService {
     error ErrorBundleServiceBundlePoolMismatch(NftId bundleNftId, NftId expectedPool, NftId actualPool);
 
     error ErrorBundleServicePolicyNotCloseable(NftId policyNftId);
-
-    error ErrorBundleServiceFeesWithdrawAmountExceedsLimit(Amount amount, Amount limit);
     
     error ErrorBundleServiceUnstakeAmountExceedsLimit(Amount amount, Amount limit);
 
     error ErrorBundleServiceExtensionLifetimeIsZero();
 
-    event LogBundleServiceFeesWithdrawn(NftId bundleNftId, address recipient, address tokenAddress, Amount amount);
+    event LogBundleServiceBundleCreated(NftId bundleNftId, NftId poolNftId, Seconds lifetime);
+    event LogBundleServiceBundleClosed(NftId bundleNftId);
+    event LogBundleServiceBundleLocked(NftId bundleNftId);
+    event LogBundleServiceBundleUnlocked(NftId bundleNftId);
     event LogBundleServiceBundleExtended(NftId bundleNftId, Seconds lifetimeExtension, Timestamp extendedExpiredAt);
+    event LogBundleServiceBundleFeeUpdated(NftId bundleNftId, Amount fixedFee, UFixed fractionalFee);
+    event LogBundleServiceCollateralLocked(NftId bundleNftId, NftId policyNftId, Amount collateralAmount);
+    event LogBundleServiceCollateralReleased(NftId bundleNftId, NftId policyNftId, Amount collateralAmount);
+    event LogBundleServiceBundleStaked(NftId bundleNftId, Amount amount);
+    event LogBundleServiceBundleUnstaked(NftId bundleNftId, Amount amount);
 
     /// @dev Create a new bundle for the specified attributes.
     function create(
@@ -48,28 +54,24 @@ interface IBundleService is IService {
 
     /// @dev increase bundle stakes by the specified amount. bundle must not be expired or closed
     /// may only be called by the pool service
-    function stake(IInstance instance, NftId bundleNftId, Amount amount) external;
+    function stake(
+        InstanceReader instanceReader,
+        InstanceStore instanceStore,
+        NftId bundleNftId, 
+        Amount amount
+    ) external;
 
     /// @dev decrease bundle stakes by the specified amount
     /// may only be called by the pool service
-    /// @param instance the instance relevant for the bundle
-    /// @param bundleNftId the bundle nft id
-    /// @param amount the amount to unstake (set to AmountLib.max() to unstake all available stakes)
-    /// @return unstakedAmount the effective unstaked amount
-    function unstake(IInstance instance, NftId bundleNftId, Amount amount) external returns (Amount unstakedAmount);
+    function unstake(InstanceStore instanceStore, NftId bundleNftId, Amount amount) external returns (Amount unstakedAmount);
 
     /// @dev extend the lifetime of the bundle by the specified time in seconds
     function extend(NftId bundleNftId, Seconds lifetimeExtension) external returns (Timestamp extendedExpiredAt);
 
-    /// @dev locks the specified bundle, locked bundles are not available to collateralize new policies
-    /// only active bundles may be locked
-    /// may only be called by registered and unlocked pool components
-    function lock(NftId bundleNftId) external;
-
-    /// @dev activates the specified bundle
-    /// only locked bundles may be unlocked
-    /// may only be called by registered and unlocked pool components
-    function unlock(NftId bundleNftId) external;
+    /// @dev locks/unlocks the specified bundle. 
+    /// locked bundles are not available to collateralize new policies.
+    /// may only be called by registered and unlocked pool components.
+    function setLocked(NftId bundleNftId, bool locked) external;
 
     /// @dev closes the specified bundle
     /// only open bundles (active or locked) may be closed
@@ -106,16 +108,9 @@ interface IBundleService is IService {
     /// @dev releases the specified collateral in the bundle
     /// may only be called by pool service
     function releaseCollateral(
-        IInstance instance, 
+        InstanceStore instanceStore, 
         NftId policyNftId, 
         NftId bundleNftId, 
         Amount collateralAmount
     ) external;
-
-    // FIXME: move to pool service
-    /// @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);
 }