@etherisc/gif-next 0.0.2-abde86b-349 → 0.0.2-ac2f4a6-957

package/contracts/oracle/OracleService.sol

@@ -11,7 +11,7 @@ import {IOracleComponent} from "./IOracleComponent.sol";
 import {IOracleService} from "./IOracleService.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, ORACLE, INSTANCE} from "../type/ObjectType.sol";
+import {ObjectType, COMPONENT, ORACLE, PRODUCT} from "../type/ObjectType.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {StateId, ACTIVE, KEEP_STATE, FULFILLED, FAILED, CANCELLED} from "../type/StateId.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
@@ -48,6 +48,7 @@ contract OracleService is
         external 
         virtual 
         // restricted() // add authz
+        onlyNftOfType(oracleNftId, ORACLE())
         returns (
             RequestId requestId
         ) 
@@ -66,36 +67,45 @@ contract OracleService is
             ORACLE(), 
             true); // only active
 
-        // TODO move to stronger validation, requester and oracle need to belong to same product cluster
-        // check that requester and oracle share same instance
-        if (componentInfo.parentNftId != oracleInfo.parentNftId) {
-            revert ErrorOracleServiceInstanceMismatch(componentInfo.parentNftId, oracleInfo.parentNftId);
-        }
+        {
+            // check that requester and oracle share same product cluster
+            if (componentInfo.objectType == PRODUCT()) {
+                if (oracleInfo.parentNftId != componentInfo.nftId) {
+                    revert ErrorOracleServiceProductMismatch(componentInfo.objectType, componentInfo.nftId, oracleInfo.parentNftId);
+                }
+            } else {
+                if (oracleInfo.parentNftId != componentInfo.parentNftId) {
+                    revert ErrorOracleServiceProductMismatch(componentInfo.objectType, componentInfo.parentNftId, oracleInfo.parentNftId);
+                }
+            }
 
-        // check expiriyAt >= now
-        if (expiryAt < TimestampLib.blockTimestamp()) {
-            revert ErrorOracleServiceExpiryInThePast(TimestampLib.blockTimestamp(), expiryAt);
-        }
+            // check expiriyAt >= now
+            if (expiryAt < TimestampLib.blockTimestamp()) {
+                revert ErrorOracleServiceExpiryInThePast(TimestampLib.blockTimestamp(), expiryAt);
+            }
 
-        // check callbackMethodName.length > 0
-        if (bytes(callbackMethodName).length == 0) {
-            revert ErrorOracleServiceCallbackMethodNameEmpty();
+            // check callbackMethodName.length > 0
+            if (bytes(callbackMethodName).length == 0) {
+                revert ErrorOracleServiceCallbackMethodNameEmpty();
+            }
         }
 
-        // create request info
-        IOracle.RequestInfo memory request = IOracle.RequestInfo({
-            requesterNftId: componentNftId,
-            callbackMethodName: callbackMethodName,
-            oracleNftId: oracleNftId,
-            requestData: requestData,
-            responseData: "",
-            respondedAt: TimestampLib.zero(),
-            expiredAt: expiryAt,
-            isCancelled: false
-        });
-
-        // store request with instance
-        requestId = instance.getInstanceStore().createRequest(request);
+        {
+            // create request info
+            IOracle.RequestInfo memory request = IOracle.RequestInfo({
+                requesterNftId: componentNftId,
+                callbackMethodName: callbackMethodName,
+                oracleNftId: oracleNftId,
+                requestData: requestData,
+                responseData: "",
+                respondedAt: TimestampLib.zero(),
+                expiredAt: expiryAt,
+                isCancelled: false
+            });
+
+            // store request with instance
+            requestId = instance.getInstanceStore().createRequest(request);
+        }
 
         // call oracle component
         IOracleComponent(oracleInfo.objectAddress).request(

package/contracts/pool/BasicPool.sol

@@ -1,22 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
 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 {Amount} from "../type/Amount.sol";
+import {Fee} from "../type/Fee.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
-import {IBundleService} from "./IBundleService.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 {NftId, NftIdLib} from "../type/NftId.sol";
-import {BUNDLE, COMPONENT, POOL} from "../type/ObjectType.sol";
-import {RoleId, PUBLIC_ROLE} from "../type/RoleId.sol";
+import {NftId} from "../type/NftId.sol";
+import {BUNDLE} from "../type/ObjectType.sol";
+import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {Timestamp} from "../type/Timestamp.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 import {Pool} from "./Pool.sol";
 
@@ -26,7 +18,7 @@ abstract contract BasicPool is
 
     function _initializeBasicPool(
         address registry,
-        NftId instanceNftId,
+        NftId productNftId,
         IAuthorization authorization,
         address token,
         string memory name,
@@ -38,13 +30,12 @@ abstract contract BasicPool is
     {
         _initializePool(
             registry, 
-            instanceNftId, 
+            productNftId, 
             name, 
             token, 
             authorization,
             false, // isInterceptingNftTransfers, 
             initialOwner, 
-            "", // registryData
             ""); // componentData
     }
 
@@ -56,6 +47,7 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
         _stake(bundleNftId, amount);
     }
@@ -69,6 +61,7 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
         _unstake(bundleNftId, amount);
     }
@@ -82,6 +75,7 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
         returns(Timestamp newExpiredAt)
     {
         return _extend(bundleNftId, lifetimeExtension);
@@ -93,6 +87,7 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
         _lockBundle(bundleNftId);
     }
@@ -103,6 +98,7 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
         _unlockBundle(bundleNftId);
     }
@@ -113,6 +109,7 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
         _closeBundle(bundleNftId);
     }
@@ -126,6 +123,7 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
     {
         _setBundleFee(bundleNftId, fee);
     }
@@ -141,16 +139,6 @@ abstract contract BasicPool is
     }
 
 
-    function setBundleOwnerRole(RoleId bundleOwnerRole)
-        public
-        virtual
-        restricted()
-        onlyOwner()
-    {
-        _setBundleOwnerRole(bundleOwnerRole);
-    }
-
-
     function setFees(
         Fee memory poolFee,
         Fee memory stakingFee,

package/contracts/pool/BasicPoolAuthorization.sol

@@ -44,7 +44,6 @@ contract BasicPoolAuthorization
           _authorize(functions, BasicPool.setBundleFee.selector, "setBundleFee");
 
           _authorize(functions, BasicPool.setMaxBalanceAmount.selector, "setMaxBalanceAmount");
-          _authorize(functions, BasicPool.setBundleOwnerRole.selector, "setBundleOwnerRole");
           _authorize(functions, BasicPool.setFees.selector, "setFees");
           _authorize(functions, BasicPool.stake.selector, "stake");
           _authorize(functions, BasicPool.unstake.selector, "unstake");

package/contracts/pool/BundleService.sol

@@ -17,7 +17,7 @@ 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 {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";
@@ -64,6 +64,8 @@ contract BundleService is
         external
         virtual
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
         InstanceReader instanceReader = instance.getInstanceReader();
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
@@ -94,6 +96,8 @@ contract BundleService is
         restricted
         returns(NftId bundleNftId)
     {
+        _checkNftType(poolNftId, POOL());
+
         // register bundle with registry
         bundleNftId = _registryService.registerBundle(
             IRegistry.ObjectInfo(
@@ -148,26 +152,35 @@ contract BundleService is
         virtual
         restricted()
     {
+        _checkNftType(policyNftId, POLICY());
+        _checkNftType(bundleNftId, BUNDLE());
+
         InstanceReader instanceReader = instance.getInstanceReader();
-        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);
+        {
+            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
@@ -182,6 +195,8 @@ contract BundleService is
         external
         virtual
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
 
         // udpate bundle state
@@ -199,6 +214,8 @@ contract BundleService is
         external
         virtual
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
 
         // udpate bundle state
@@ -221,6 +238,8 @@ contract BundleService is
         restricted
         returns (Amount unstakedAmount, Amount feeAmount)
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         InstanceReader instanceReader = instance.getInstanceReader();
 
         // ensure no open policies attached to bundle
@@ -254,6 +273,8 @@ contract BundleService is
         virtual
         // TODO: restricted() (once #462 is done)
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
         StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
 
@@ -281,6 +302,8 @@ contract BundleService is
         // TODO: restricted() (once #462 is done)
         returns (Amount unstakedAmount)
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         InstanceStore instanceStore = instance.getInstanceStore();
         (
             Amount balanceAmount,
@@ -288,7 +311,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 
@@ -306,8 +329,6 @@ contract BundleService is
             bundleNftId, 
             unstakedAmount, 
             AmountLib.zero());
-
-        return unstakedAmount;
     }
 
     /// @inheritdoc IBundleService
@@ -317,6 +338,8 @@ contract BundleService is
         // TODO: restricted() (once #462 is done)
         returns (Timestamp extendedExpiredAt) 
     {
+        _checkNftType(bundleNftId, BUNDLE());
+
         (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
         IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
         StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
@@ -354,6 +377,9 @@ contract BundleService is
         virtual
         restricted()
     {
+        _checkNftType(policyNftId, POLICY());
+        _checkNftType(bundleNftId, BUNDLE());
+
         instance.getInstanceStore().decreaseLocked(bundleNftId, collateralAmount);
     }
 
@@ -366,8 +392,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);
         }
 
@@ -381,13 +409,15 @@ contract BundleService is
         // TODO: restricted() (once #462 is done)
         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;
         
-        IBundle.BundleInfo memory bundleInfo = reader.getBundleInfo(bundleNftId);
+        // IBundle.BundleInfo memory bundleInfo = reader.getBundleInfo(bundleNftId);
         
         // determine withdrawn amount
         withdrawnAmount = amount;
@@ -416,6 +446,31 @@ contract BundleService is
         }
     }
 
+    /// @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/IBundleService.sol

@@ -131,4 +131,13 @@ interface IBundleService is IService {
     /// @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/IPoolService.sol

@@ -34,10 +34,6 @@ interface IPoolService is IService {
     error ErrorPoolServiceInvalidTransferAmount(Amount expectedAmount, Amount actualAmount);
     error ErrorPoolServiceBundlePoolMismatch(NftId bundleNftId, NftId poolNftId);
     error ErrorPoolServiceMaxBalanceAmountExceeded(NftId poolNftId, Amount maxBalanceAmount, Amount currentBalanceAmount, Amount transferAmount);
-    
-    /// @dev defines the required role for bundle owners for the calling pool
-    /// default implementation returns PUBLIC ROLE
-    function setBundleOwnerRole(RoleId bundleOwnerRole) external;
 
     /// @dev sets the max balance amount for the calling pool
     function setMaxBalanceAmount(Amount maxBalanceAmount) external;
@@ -72,10 +68,10 @@ interface IPoolService is IService {
     ) external;
 
 
-    /// @dev reduces the locked collateral in the bundle associated with the specified policy
+    /// @dev reduces the locked collateral in the bundle associated with the specified policy and updates pool/bundle counters
     /// every payout of a policy reduces the collateral by the payout amount
     /// may only be called by the claim service for unlocked pool components
-    function reduceCollateral(
+    function processPayout(
         IInstance instance, 
         address token,
         NftId policyNftId, 

package/contracts/pool/Pool.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {Amount, AmountLib} from "../type/Amount.sol";
-import {BUNDLE, COMPONENT, POOL} from "../type/ObjectType.sol";
+import {BUNDLE, COMPONENT, POLICY, POOL} from "../type/ObjectType.sol";
 import {ClaimId} from "../type/ClaimId.sol";
 import {IBundleService} from "./IBundleService.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
@@ -11,13 +11,12 @@ 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 {Fee} from "../type/Fee.sol";
+import {NftId} from "../type/NftId.sol";
 import {RoleId, PUBLIC_ROLE} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {Timestamp} from "../type/Timestamp.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
+import {UFixedLib} from "../type/UFixed.sol";
 
 abstract contract Pool is
     InstanceLinkedComponent, 
@@ -41,16 +40,6 @@ abstract contract Pool is
     }
 
 
-    function register()
-        external
-        virtual
-        onlyOwner()
-    {
-        _getPoolStorage()._componentService.registerPool();
-        _approveTokenHandler(type(uint256).max);
-    }
-
-
     /// @dev see {IPoolComponent.verifyApplication}
     function verifyApplication(
         NftId applicationNftId, 
@@ -62,6 +51,7 @@ abstract contract Pool is
         public
         virtual
         restricted()
+        onlyNftOfType(applicationNftId, POLICY())
     {
         if(!applicationMatchesBundle(
             applicationNftId,
@@ -87,6 +77,7 @@ abstract contract Pool is
         public
         virtual
         restricted()
+        onlyNftOfType(policyNftId, POLICY())
     {
         // default implementation is empty
     }
@@ -105,6 +96,8 @@ abstract contract Pool is
         public
         virtual
         view
+        onlyNftOfType(applicationNftId, POLICY())
+        onlyNftOfType(bundleNftId, BUNDLE())
         returns (bool isMatching)
     {
         return true;
@@ -116,6 +109,7 @@ abstract contract Pool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        onlyNftOfType(bundleNftId, BUNDLE())
         returns (Amount withdrawnAmount) 
     {
         return _withdrawBundleFees(bundleNftId, amount);
@@ -144,13 +138,12 @@ abstract contract Pool is
 
     function _initializePool(
         address registry,
-        NftId instanceNftId,
+        NftId productNftId,
         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 
     )
         internal
@@ -159,14 +152,13 @@ abstract contract Pool is
     {
         _initializeInstanceLinkedComponent(
             registry, 
-            instanceNftId, 
+            productNftId,  
             name, 
             token, 
             POOL(), 
             authorization, 
             isInterceptingNftTransfers, 
             initialOwner, 
-            registryData, 
             componentData);
 
         PoolStorage storage $ = _getPoolStorage();
@@ -276,16 +268,6 @@ abstract contract Pool is
         _getPoolStorage()._poolService.setMaxBalanceAmount(maxBalanceAmount);
     }
 
-    /// @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
-    {
-        _getPoolStorage()._poolService.setBundleOwnerRole(bundleOwnerRole);
-    }
-
 
     /// @dev Update pool fees to the specified values.
     /// Pool fee: are deducted from the premium amount and goes to the pool owner.