@etherisc/gif-next 0.0.2-b657d4e-837 → 0.0.2-b6a85fa-854

package/contracts/pool/BundleService.sol

@@ -1,33 +1,30 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
+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";
 import {IInstance} from "../instance/IInstance.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
-import {IPolicy} from "../instance/module/IPolicy.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 {StateId, ACTIVE, PAUSED, CLOSED, KEEP_STATE} from "../type/StateId.sol";
+import {ObjectType, ACCOUNTING, COMPONENT, POOL, BUNDLE, POLICY, REGISTRY} from "../type/ObjectType.sol";
+import {PoolLib} from "./PoolLib.sol";
 import {Seconds} from "../type/Seconds.sol";
-import {TimestampLib, zeroTimestamp} from "../type/Timestamp.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 
 {
     
@@ -35,6 +32,7 @@ contract BundleService is
 
     address private _registryAddress;
     IRegistryService private _registryService;
+    IAccountingService private _accountingService;
     IComponentService private _componentService;
 
     function _initialize(
@@ -42,20 +40,21 @@ contract BundleService is
         bytes memory data
     )
         internal
-        initializer
         virtual override
+        initializer()
     {
-        address registryAddress;
-        address initialOwner;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-        // TODO while PoolService is not deployed in PoolServiceManager constructor
-        //      owner is PoolServiceManager deployer
-        initializeService(registryAddress, address(0), owner);
+        (
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
+
+        __Service_init(authority, registry, owner);
 
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
+        _accountingService = IAccountingService(_getServiceAddress(ACCOUNTING()));
         _componentService = IComponentService(_getServiceAddress(COMPONENT()));
 
-        registerInterface(type(IBundleService).interfaceId);
+        _registerInterface(type(IBundleService).interfaceId);
     }
 
 
@@ -65,8 +64,11 @@ contract BundleService is
     )
         external
         virtual
+        restricted()
     {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        _checkNftType(bundleNftId, BUNDLE());
+
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
         InstanceReader instanceReader = instance.getInstanceReader();
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
         if(bundleInfo.poolNftId.eqz()) {
@@ -79,23 +81,24 @@ contract BundleService is
 
         bundleInfo.fee = fee;
         instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+
+        emit LogBundleServiceBundleFeeUpdated(bundleNftId, fee.fixedFee, fee.fractionalFee);
     }
 
 
     function create(
-        IInstance instance,
-        NftId poolNftId,
         address owner, 
         Fee memory bundleFee, 
-        Amount stakingAmount, 
         Seconds lifetime, 
         bytes calldata filter
     )
         external
-        override
-        restricted
+        virtual
+        restricted()
         returns(NftId bundleNftId)
     {
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
+
         // register bundle with registry
         bundleNftId = _registryService.registerBundle(
             IRegistry.ObjectInfo(
@@ -113,26 +116,21 @@ contract BundleService is
         InstanceStore instanceStore = instance.getInstanceStore();
         instanceStore.createBundle(
             bundleNftId, 
-            IBundle.BundleInfo(
-                poolNftId,
-                bundleFee,
-                filter,
-                lifetime,
-                TimestampLib.blockTimestamp().addSeconds(lifetime),
-                zeroTimestamp()));
-
-        // bundle book keeping
-        _componentService.increaseBundleBalance(
-            instanceStore, 
-            bundleNftId, 
-            stakingAmount, 
-            AmountLib.zero()); // fee amount
+            IBundle.BundleInfo({
+                poolNftId: poolNftId,
+                fee: bundleFee,
+                filter: filter,
+                activatedAt: TimestampLib.current(),
+                expiredAt: TimestampLib.current().addSeconds(lifetime),
+                closedAt: zeroTimestamp()
+            })
+        );
 
         // put bundle under bundle managemet
         BundleSet bundleManager = instance.getBundleSet();
         bundleManager.add(bundleNftId);
 
-        // TODO add logging
+        emit LogBundleServiceBundleCreated(bundleNftId, poolNftId, lifetime);
     }
 
 
@@ -147,69 +145,69 @@ contract BundleService is
         virtual
         restricted()
     {
+        // checks
+        _checkNftType(policyNftId, POLICY());
+        _checkNftType(bundleNftId, BUNDLE());
+
         InstanceReader instanceReader = instance.getInstanceReader();
-        StateId bundleState = instanceReader.getMetadata(bundleNftId.toKey32(BUNDLE())).state;
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
 
-        // ensure bundle is active and not yet expired
-        if(bundleState != ACTIVE() || bundleInfo.expiredAt < TimestampLib.blockTimestamp()) {
-            revert ErrorBundleServiceBundleNotOpen(bundleNftId, bundleState, bundleInfo.expiredAt);
+        {
+            StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
+            IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+
+            // ensure bundle is active and not yet expired
+            if(bundleState != ACTIVE() || bundleInfo.expiredAt < TimestampLib.current()) {
+                revert ErrorBundleServiceBundleNotOpen(bundleNftId, bundleState, bundleInfo.expiredAt);
+            }
         }
 
-        // ensure bundle capacity is sufficent to collateralize policy
         InstanceStore instanceStore = instance.getInstanceStore();
-        (
-            Amount balanceAmount,
-            Amount lockedAmount,
-            Amount feeAmount
-        ) = instanceStore.getAmounts(bundleNftId);
 
-        Amount capacity = balanceAmount - (lockedAmount + feeAmount);
-        if(capacity < collateralAmount) {
-            revert ErrorBundleServiceCapacityInsufficient(bundleNftId, capacity, collateralAmount);
+        {
+            // ensure bundle capacity is sufficent to collateralize policy
+            (
+                Amount balanceAmount,
+                Amount lockedAmount,
+                Amount feeAmount
+            ) = instanceStore.getAmounts(bundleNftId);
+
+            Amount capacity = balanceAmount - (lockedAmount + feeAmount);
+            if(capacity < collateralAmount) {
+                revert ErrorBundleServiceCapacityInsufficient(bundleNftId, capacity, collateralAmount);
+            }
         }
 
+        // effects
         // updated locked amount
         instanceStore.increaseLocked(bundleNftId, collateralAmount);
-        
-        // link policy to bundle in bundle manger
-        _linkPolicy(instance, policyNftId);
-    }
-
-
-    function lock(NftId bundleNftId) 
-        external
-        virtual
-    {
-        (,, 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()
     {
-        (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        // checks
+        _checkNftType(bundleNftId, BUNDLE());
 
-        // 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,
@@ -217,10 +215,13 @@ contract BundleService is
     ) 
         external
         virtual
-        restricted
+        restricted()
+        returns (Amount unstakedAmount, Amount feeAmount)
     {
-        // udpate bundle state
-        instance.getInstanceStore().updateBundleState(bundleNftId, CLOSED());
+        // checks
+        _checkNftType(bundleNftId, BUNDLE());
+
+        InstanceReader instanceReader = instance.getInstanceReader();
 
         // ensure no open policies attached to bundle
         BundleSet bundleManager = instance.getBundleSet();
@@ -229,112 +230,156 @@ contract BundleService is
             revert ErrorBundleServiceBundleWithOpenPolicies(bundleNftId, openPolicies);
         }
 
-        // update set of active bundles
-        bundleManager.lock(bundleNftId);
-    }
+        // effects
+        {
+            // update bundle state
+            InstanceStore instanceStore = instance.getInstanceStore();
+            instanceStore.updateBundleState(bundleNftId, CLOSED());
+            bundleManager.lock(bundleNftId);
+
+            // decrease bundle counters
+            Amount balanceAmountWithFees = instanceReader.getBalanceAmount(bundleNftId);
+            feeAmount = instanceReader.getFeeAmount(bundleNftId);
+            unstakedAmount = balanceAmountWithFees - feeAmount;
+            _accountingService.decreaseBundleBalance(instanceStore, bundleNftId, unstakedAmount, feeAmount);
+        }
 
+        emit LogBundleServiceBundleClosed(bundleNftId);
+    }
 
-    function releaseCollateral(
-        IInstance instance,
-        NftId policyNftId, 
+    /// @inheritdoc IBundleService
+    function stake(
+        InstanceReader instanceReader,
+        InstanceStore instanceStore,
         NftId bundleNftId, 
-        Amount collateralAmount
+        Amount amount
     ) 
-        external
+        external 
         virtual
         restricted()
     {
-        instance.getInstanceStore().decreaseLocked(bundleNftId, collateralAmount);
+        // checks
+        _checkNftType(bundleNftId, BUNDLE());
+
+        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.current() 
+            || bundleInfo.closedAt.gtz()) {
+            revert ErrorBundleServiceBundleNotOpen(bundleNftId, bundleState, bundleInfo.expiredAt);
+        }
+
+        // effects
+        _accountingService.increaseBundleBalance(
+            instanceStore, 
+            bundleNftId, 
+            amount, 
+            AmountLib.zero());
+
+        emit LogBundleServiceBundleStaked(bundleNftId, amount);
     }
 
-    /// @dev unlinks policy from bundle
-    function unlinkPolicy(
-        IInstance instance, 
-        NftId policyNftId
+    /// @inheritdoc IBundleService
+    function unstake(
+        InstanceStore instanceStore,
+        NftId bundleNftId, 
+        Amount amount
     ) 
-        external
+        external 
         virtual
-        restricted
+        restricted()
+        returns (Amount unstakedAmount)
     {
-        // ensure policy is closeable
-        if (!instance.getInstanceReader().policyIsCloseable(policyNftId)) {
-            revert ErrorBundleServicePolicyNotCloseable(policyNftId);
+        // checks
+        _checkNftType(bundleNftId, BUNDLE());
+
+        (
+            Amount balanceAmount,
+            Amount lockedAmount,
+            Amount feeAmount
+        ) = instanceStore.getAmounts(bundleNftId);
+
+        unstakedAmount = amount;
+        Amount availableAmount = balanceAmount - (lockedAmount + feeAmount);
+
+        // if amount is max, then unstake all available 
+        if (amount.gte(AmountLib.max())) {
+            unstakedAmount = availableAmount;
+        }
+        
+        // ensure unstaked amount does not exceed available amount
+        if (unstakedAmount > availableAmount) {
+            revert ErrorBundleServiceUnstakeAmountExceedsLimit(amount, availableAmount);
         }
 
-        instance.getBundleSet().unlinkPolicy(policyNftId);
+        // effects
+        _accountingService.decreaseBundleBalance(
+            instanceStore, 
+            bundleNftId, 
+            unstakedAmount, 
+            AmountLib.zero());
+        
+        emit LogBundleServiceBundleUnstaked(bundleNftId, unstakedAmount);
     }
 
     /// @inheritdoc IBundleService
-    function withdrawBundleFees(NftId bundleNftId, Amount amount) 
-        public 
+    function extend(NftId bundleNftId, Seconds lifetimeExtension) 
+        external 
         virtual
-        // TODO: restricted() (once #462 is done)
-        returns (Amount withdrawnAmount) 
+        restricted()
+        returns (Timestamp extendedExpiredAt) 
     {
-        (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));
-            }
-        }
+        // checks
+        _checkNftType(bundleNftId, BUNDLE());
 
-        if (withdrawnAmount.eqz()) {
-            revert ErrorBundleServiceFeesWithdrawAmountIsZero();
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
+        IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
+        StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
+
+        // ensure bundle belongs to the pool
+        if (bundleInfo.poolNftId != poolNftId) {
+            revert ErrorBundleServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, poolNftId);
         }
 
-        // 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());
+        // ensure bundle is active and not yet expired
+        if(bundleState != ACTIVE() || bundleInfo.expiredAt < TimestampLib.current()) {
+            revert ErrorBundleServiceBundleNotOpen(bundleNftId, bundleState, bundleInfo.expiredAt);
         }
 
-        // 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());
+        if (lifetimeExtension.eqz()) {
+            revert ErrorBundleServiceExtensionLifetimeIsZero();
         }
 
-        // transfer amount to bundle owner
-        {
-            address owner = getRegistry().ownerOf(bundleNftId);
-            // TODO: centralize token handling (issue #471)
-            poolInfo.tokenHandler.transfer(poolWallet, owner, withdrawnAmount);
+        // effects
+        bundleInfo.expiredAt = bundleInfo.expiredAt.addSeconds(lifetimeExtension);
+        extendedExpiredAt = bundleInfo.expiredAt;
 
-            emit LogBundleServiceFeesWithdrawn(bundleNftId, owner, address(token), withdrawnAmount);
-        }
+        instance.getInstanceStore().updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
+
+        emit LogBundleServiceBundleExtended(bundleNftId, lifetimeExtension, extendedExpiredAt);
     }
 
-    /// @dev links policy to bundle
-    function _linkPolicy(IInstance instance, NftId policyNftId) 
-        internal
+
+    function releaseCollateral(
+        InstanceStore instanceStore,
+        NftId policyNftId, 
+        NftId bundleNftId, 
+        Amount collateralAmount
+    ) 
+        external
+        virtual
+        restricted()
     {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
+        _checkNftType(policyNftId, POLICY());
+        _checkNftType(bundleNftId, BUNDLE());
 
-        // ensure policy has not yet been activated in a previous tx already
-        if (policyInfo.activatedAt.gtz() && policyInfo.activatedAt < TimestampLib.blockTimestamp()) {
-            revert BundleSet.ErrorBundleSetPolicyAlreadyActivated(policyNftId);
-        }
-        
-        BundleSet bundleManager = instance.getBundleSet();
-        bundleManager.linkPolicy(policyNftId);
+        instanceStore.decreaseLocked(bundleNftId, collateralAmount);
+
+        emit LogBundleServiceCollateralReleased(bundleNftId, policyNftId, collateralAmount);
     }
 
+
     function _getDomain() internal pure override returns(ObjectType) {
         return BUNDLE();
     }

package/contracts/pool/BundleServiceManager.sol

@@ -12,15 +12,15 @@ contract BundleServiceManager is ProxyManager {
     /// @dev initializes proxy manager with pool service implementation 
     constructor(
         address authority, 
-        address registryAddress,
+        address registry,
         bytes32 salt
     ) 
-        ProxyManager(registryAddress)
     {
-        BundleService bundleSrv = new BundleService{salt: salt}();
-        bytes memory data = abi.encode(registryAddress, address(this), authority);
-        IVersionable versionable = deployDetermenistic(
-            address(bundleSrv), 
+        BundleService svc = new BundleService{salt: salt}();
+        bytes memory data = abi.encode(authority, registry);
+        IVersionable versionable = initialize(
+            registry,
+            address(svc), 
             data,
             salt);