@etherisc/gif-next 0.0.2-a714036-117 → 0.0.2-a78920e-322

package/contracts/pool/BundleService.sol

@@ -1,8 +1,6 @@
 // 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";
@@ -16,10 +14,10 @@ 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, FeeLib} from "../type/Fee.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 {ObjectType, COMPONENT, POOL, BUNDLE, POLICY, REGISTRY} from "../type/ObjectType.sol";
 import {StateId, ACTIVE, PAUSED, CLOSED, KEEP_STATE} from "../type/StateId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {Timestamp, TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
@@ -42,20 +40,20 @@ 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 registryAddress,
+            address authority
+        ) = abi.decode(data, (address, address));
+
+        _initializeService(registryAddress, authority, owner);
 
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
         _componentService = IComponentService(_getServiceAddress(COMPONENT()));
 
-        registerInterface(type(IBundleService).interfaceId);
+        _registerInterface(type(IBundleService).interfaceId);
     }
 
 
@@ -65,7 +63,10 @@ contract BundleService is
     )
         external
         virtual
+        restricted()
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
         InstanceReader instanceReader = instance.getInstanceReader();
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
@@ -83,19 +84,18 @@ contract BundleService is
 
 
     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) = _getAndVerifyActiveComponent(POOL());
+
         // register bundle with registry
         bundleNftId = _registryService.registerBundle(
             IRegistry.ObjectInfo(
@@ -113,26 +113,21 @@ contract BundleService is
         InstanceStore instanceStore = instance.getInstanceStore();
         instanceStore.createBundle(
             bundleNftId, 
-            IBundle.BundleInfo(
-                poolNftId,
-                bundleFee,
-                filter,
-                TimestampLib.blockTimestamp(),
-                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.blockTimestamp(),
+                expiredAt: TimestampLib.blockTimestamp().addSeconds(lifetime),
+                closedAt: zeroTimestamp()
+            })
+        );
 
         // put bundle under bundle managemet
         BundleSet bundleManager = instance.getBundleSet();
         bundleManager.add(bundleNftId);
 
-        // TODO add logging
+        emit LogBundleServiceBundleCreated(bundleNftId, poolNftId);
     }
 
 
@@ -147,26 +142,35 @@ contract BundleService is
         virtual
         restricted()
     {
+        _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.blockTimestamp()) {
+                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);
+            }
         }
 
         // updated locked amount
@@ -180,7 +184,10 @@ contract BundleService is
     function lock(NftId bundleNftId) 
         external
         virtual
+        restricted()
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
 
         // udpate bundle state
@@ -197,7 +204,10 @@ contract BundleService is
     function unlock(NftId bundleNftId) 
         external
         virtual
+        restricted()
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
 
         // udpate bundle state
@@ -217,10 +227,12 @@ contract BundleService is
     ) 
         external
         virtual
-        restricted
+        restricted()
+        returns (Amount unstakedAmount, Amount feeAmount)
     {
-        // udpate bundle state
-        instance.getInstanceStore().updateBundleState(bundleNftId, CLOSED());
+        _checkNftType(bundleNftId, BUNDLE());
+
+        InstanceReader instanceReader = instance.getInstanceReader();
 
         // ensure no open policies attached to bundle
         BundleSet bundleManager = instance.getBundleSet();
@@ -229,8 +241,18 @@ contract BundleService is
             revert ErrorBundleServiceBundleWithOpenPolicies(bundleNftId, openPolicies);
         }
 
-        // update set of active bundles
-        bundleManager.lock(bundleNftId);
+        {
+            // 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;
+            _componentService.decreaseBundleBalance(instanceStore, bundleNftId, unstakedAmount, feeAmount);
+        }
     }
 
     /// @inheritdoc IBundleService
@@ -241,12 +263,16 @@ contract BundleService is
     ) 
         external 
         virtual
-        // TODO: restricted() (once #462 is done)
+        restricted()
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
-        StateId bundleState = instance.getInstanceReader().getMetadata(bundleNftId.toKey32(BUNDLE())).state;
+        StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
 
-        if(bundleState != ACTIVE() || bundleInfo.expiredAt < TimestampLib.blockTimestamp() || bundleInfo.closedAt.gtz()) {
+        if( (bundleState != ACTIVE() && bundleState != PAUSED()) // locked bundles can be staked
+            || bundleInfo.expiredAt < TimestampLib.blockTimestamp() 
+            || bundleInfo.closedAt.gtz()) {
             revert ErrorBundleServiceBundleNotOpen(bundleNftId, bundleState, bundleInfo.expiredAt);
         }
 
@@ -265,9 +291,11 @@ contract BundleService is
     ) 
         external 
         virtual
-        // TODO: restricted() (once #462 is done)
+        restricted()
         returns (Amount unstakedAmount)
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         InstanceStore instanceStore = instance.getInstanceStore();
         (
             Amount balanceAmount,
@@ -275,7 +303,7 @@ contract BundleService is
             Amount feeAmount
         ) = instanceStore.getAmounts(bundleNftId);
 
-        Amount unstakedAmount = amount;
+        unstakedAmount = amount;
         Amount availableAmount = balanceAmount - (lockedAmount + feeAmount);
 
         // if amount is max, then unstake all available 
@@ -293,20 +321,20 @@ contract BundleService is
             bundleNftId, 
             unstakedAmount, 
             AmountLib.zero());
-
-        return unstakedAmount;
     }
 
     /// @inheritdoc IBundleService
     function extend(NftId bundleNftId, Seconds lifetimeExtension) 
         external 
         virtual
-        // TODO: restricted() (once #462 is done)
+        restricted()
         returns (Timestamp extendedExpiredAt) 
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
         IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
-        StateId bundleState = instance.getInstanceReader().getMetadata(bundleNftId.toKey32(BUNDLE())).state;
+        StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
 
         // ensure bundle belongs to the pool
         if (bundleInfo.poolNftId != poolNftId) {
@@ -341,6 +369,9 @@ contract BundleService is
         virtual
         restricted()
     {
+        _checkNftType(policyNftId, POLICY());
+        _checkNftType(bundleNftId, BUNDLE());
+
         instance.getInstanceStore().decreaseLocked(bundleNftId, collateralAmount);
     }
 
@@ -353,8 +384,10 @@ contract BundleService is
         virtual
         restricted
     {
+        _checkNftType(policyNftId, POLICY());
+
         // ensure policy is closeable
-        if (!instance.getInstanceReader().policyIsCloseable(policyNftId)) {
+        if (!policyIsCloseable(instance, policyNftId)) {
             revert ErrorBundleServicePolicyNotCloseable(policyNftId);
         }
 
@@ -365,16 +398,18 @@ contract BundleService is
     function withdrawBundleFees(NftId bundleNftId, Amount amount) 
         public 
         virtual
-        // TODO: restricted() (once #462 is done)
+        restricted()
         returns (Amount withdrawnAmount) 
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
         InstanceReader reader = instance.getInstanceReader();
         
         IComponents.ComponentInfo memory poolInfo = reader.getComponentInfo(poolNftId);
-        address poolWallet = poolInfo.wallet;
+        address poolWallet = poolInfo.tokenHandler.getWallet();
         
-        IBundle.BundleInfo memory bundleInfo = reader.getBundleInfo(bundleNftId);
+        // IBundle.BundleInfo memory bundleInfo = reader.getBundleInfo(bundleNftId);
         
         // determine withdrawn amount
         withdrawnAmount = amount;
@@ -386,17 +421,6 @@ contract BundleService is
             }
         }
 
-        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();
@@ -409,13 +433,36 @@ contract BundleService is
         // 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);
+            emit LogBundleServiceFeesWithdrawn(bundleNftId, owner, address(poolInfo.token), withdrawnAmount);
+            poolInfo.tokenHandler.distributeTokens(poolWallet, owner, withdrawnAmount);
         }
     }
 
+    /// @inheritdoc IBundleService
+    function policyIsCloseable(IInstance instance, NftId policyNftId)
+        public
+        view
+        returns (bool isCloseable)
+    {
+        _checkNftType(policyNftId, POLICY());
+
+        IPolicy.PolicyInfo memory info = instance.getInstanceReader().getPolicyInfo(policyNftId);
+        
+        if (info.productNftId.eqz()) { return false; } // not closeable: policy does not exist (or does not belong to this instance)
+        if (info.activatedAt.eqz()) { return false; } // not closeable: not yet activated
+        if (info.closedAt.gtz()) { return false; } // not closeable: already closed
+        if (info.openClaimsCount > 0) { return false; } // not closeable: has open claims
+
+        // closeable: if sum of claims matches sum insured a policy may be closed prior to the expiry date
+        if (info.claimAmount == info.sumInsuredAmount) { return true; }
+
+        // not closeable: not yet expired
+        if (TimestampLib.blockTimestamp() < info.expiredAt) { return false; }
+
+        // all conditionsl to close the policy are met
+        return true; 
+    }
+
     /// @dev links policy to bundle
     function _linkPolicy(IInstance instance, NftId policyNftId) 
         internal

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(registry, authority);
+        IVersionable versionable = initialize(
+            registry,
+            address(svc), 
             data,
             salt);
 

package/contracts/pool/IBundleService.sol

@@ -13,6 +13,7 @@ import {Timestamp} from "../type/Timestamp.sol";
 
 interface IBundleService is IService {
 
+    event LogBundleServiceBundleCreated(NftId bundleNftId, NftId poolNftId);
     event LogBundleServiceBundleActivated(NftId bundleNftId);
     event LogBundleServiceBundleLocked(NftId bundleNftId);
 
@@ -27,9 +28,7 @@ interface IBundleService is IService {
     error ErrorBundleServicePolicyNotCloseable(NftId policyNftId);
 
     error ErrorBundleServiceFeesWithdrawAmountExceedsLimit(Amount amount, Amount limit);
-    error ErrorBundleServiceFeesWithdrawAmountIsZero();
-    error ErrorBundleServiceWalletAllowanceTooSmall(address wallet, address tokenHandler, uint256 allowance, uint256 amount);
-
+    
     error ErrorBundleServiceUnstakeAmountExceedsLimit(Amount amount, Amount limit);
 
     error ErrorBundleServiceExtensionLifetimeIsZero();
@@ -37,14 +36,10 @@ interface IBundleService is IService {
     event LogBundleServiceFeesWithdrawn(NftId bundleNftId, address recipient, address tokenAddress, Amount amount);
     event LogBundleServiceBundleExtended(NftId bundleNftId, Seconds lifetimeExtension, Timestamp extendedExpiredAt);
 
-    /// @dev create a new bundle for the specified attributes
-    /// may only be called by pool service
+    /// @dev Create a new bundle for the specified attributes.
     function create(
-        IInstance instance, // instance relevant for bundle
-        NftId poolNftId, // the pool the bundle will be linked to
         address owner, // initial bundle owner
         Fee memory fee, // fees deducted from premium that go to bundle owner
-        Amount stakingAmount, // staking amount - staking fees result in initial bundle capital
         Seconds lifetime, // initial duration for which new policies are covered
         bytes calldata filter // optional use case specific criteria that define if a policy may be covered by this bundle
     )
@@ -52,7 +47,7 @@ interface IBundleService is IService {
         returns(NftId bundleNftId); // the nft id of the newly created bundle
 
 
-    /// @dev increase bundle stakes by the specified amount
+    /// @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;
 
@@ -81,10 +76,12 @@ interface IBundleService is IService {
     /// only open bundles (active or locked) may be closed
     /// to close a bundle it may not have any non-closed polices attached to it
     /// may only be called by registered and unlocked pool components
+    /// @return balanceAmount the unstaked amount that was remaining in the bundle
+    /// @return feeAmount the fee amount that was remaining for the bundle
     function close(
         IInstance instance, 
         NftId bundleNftId
-    ) external;
+    ) external returns (Amount balanceAmount, Amount feeAmount);
 
     /// @dev set bundle fee to provided value
     /// may only be called by registered and unlocked pool components
@@ -124,10 +121,20 @@ interface IBundleService is IService {
         NftId policyNftId
     ) 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);
 
+    /// @dev returns true iff policy may be closed
+    /// a policy can be closed all conditions below are met
+    /// - policy exists
+    /// - has been activated
+    /// - is not yet closed
+    /// - has no open claims
+    /// - claim amount matches sum insured amount or is expired
+    function policyIsCloseable(IInstance instance, NftId policyNftId) external view returns (bool isCloseable);
+
 }

package/contracts/pool/IPoolComponent.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
+import {ClaimId} from "../type/ClaimId.sol";
 import {Fee} from "../type/Fee.sol";
 import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
@@ -20,21 +21,19 @@ interface IPoolComponent is IInstanceLinkedComponent {
 
     event LogPoolVerifiedByPool(address pool, NftId applicationNftId, Amount collateralizationAmount);
 
-    /// @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
-    /// by product related state changes.
+    /// @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.
+    /// The default implementation is empty.
     function verifyApplication(
         NftId applicationNftId, 
-        bytes memory applicationData,
         NftId bundleNftId, 
-        bytes memory bundleFilter,
         Amount collateralizationAmount
     ) external;
 
-    /// @dev returns true iff the application matches with the bundle 
-    /// this is a callback function that is only called if a pool declares itself as a verifying pool
-    /// default implementation returns true
+    /// @dev Returns true iff the application matches with the bundle.
+    /// This is a callback function that is only called if a pool declares itself as a verifying pool
+    /// The default implementation returns true.
     function applicationMatchesBundle(
         NftId applicationNftId, 
         bytes memory applicationData,
@@ -46,13 +45,18 @@ 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
+    /// @dev This is a callback function that is called by the claim service when a claim is confirmed.
+    /// The pool has the option to implement custom behavirous such as triggering a reinsurance claim or blocking the claim confirmaation.
+    /// The default implementation is empty.
+    function processConfirmedClaim(
+        NftId policyNftId, 
+        ClaimId claimId, 
+        Amount amount
+    ) external;
+
+
+    /// @dev Returns initial pool specific infos for this pool
     function getInitialPoolInfo() external view returns (IComponents.PoolInfo memory info);
 
 }