@etherisc/gif-next 0.0.2-9addcc0-107 → 0.0.2-9b4e378-274

package/contracts/{instance/service → product}/ClaimService.sol

@@ -1,54 +1,26 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRisk} from "../module/IRisk.sol";
-import {IService} from "./IApplicationService.sol";
-
-import {IComponents} from "../module/IComponents.sol";
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IProductComponent} from "../../components/IProductComponent.sol";
-import {Product} from "../../components/Product.sol";
-import {IPoolComponent} from "../../components/IPoolComponent.sol";
-import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
-import {IInstance} from "../IInstance.sol";
-import {IPolicy} from "../module/IPolicy.sol";
-import {IRisk} from "../module/IRisk.sol";
-import {IBundle} from "../module/IBundle.sol";
-import {IProductService} from "./IProductService.sol";
-import {ITreasury} from "../module/ITreasury.sol";
-import {ISetup} from "../module/ISetup.sol";
-
-import {TokenHandler} from "../../shared/TokenHandler.sol";
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {Amount, AmountLib} from "../../types/Amount.sol";
-import {Timestamp, TimestampLib, zeroTimestamp} from "../../types/Timestamp.sol";
-import {UFixed, UFixedLib} from "../../types/UFixed.sol";
-import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
-import {ObjectType, INSTANCE, PRODUCT, POOL, APPLICATION, POLICY, CLAIM, BUNDLE} from "../../types/ObjectType.sol";
-import {SUBMITTED, ACTIVE, KEEP_STATE, DECLINED, CONFIRMED, CLOSED, PAID} from "../../types/StateId.sol";
-import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {Fee, FeeLib} from "../../types/Fee.sol";
-import {ReferralId} from "../../types/Referral.sol";
-import {RiskId} from "../../types/RiskId.sol";
-import {StateId} from "../../types/StateId.sol";
-import {ClaimId, ClaimIdLib} from "../../types/ClaimId.sol";
-import {PayoutId, PayoutIdLib} from "../../types/PayoutId.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-
-import {ComponentService} from "../base/ComponentService.sol";
-import {InstanceReader} from "../InstanceReader.sol";
-import {IBundleService} from "./IBundleService.sol";
+pragma solidity ^0.8.20;
+
+import {IComponents} from "../instance/module/IComponents.sol";
+import {IInstance} from "../instance/IInstance.sol";
+import {IPolicy} from "../instance/module/IPolicy.sol";
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {TimestampLib} from "../type/Timestamp.sol";
+import {ObjectType, CLAIM, PRODUCT, POOL} from "../type/ObjectType.sol";
+import {SUBMITTED, KEEP_STATE, DECLINED, REVOKED, CONFIRMED, CLOSED, PAID} from "../type/StateId.sol";
+import {NftId} from "../type/NftId.sol";
+import {FeeLib} from "../type/Fee.sol";
+import {StateId} from "../type/StateId.sol";
+import {ClaimId, ClaimIdLib} from "../type/ClaimId.sol";
+import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
+import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IClaimService} from "./IClaimService.sol";
-import {IPoolService} from "./IPoolService.sol";
-import {IService} from "../../shared/IService.sol";
-import {Service} from "../../shared/Service.sol";
+import {IPoolService} from "../pool/IPoolService.sol";
 
 
 contract ClaimService is 
-    ComponentService, 
+    ComponentVerifyingService, 
     IClaimService
 {
 
@@ -62,27 +34,23 @@ contract ClaimService is
         virtual override
         initializer()
     {
-        // TODO check this, might no longer be the way, refactor if necessary
-        address registryAddress;
-        address initialOwner;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
+        (
+            address registryAddress,, 
+            //address managerAddress
+            address authority
+        ) = abi.decode(data, (address, address, address));
 
-        initializeService(registryAddress, address(0), owner);
+        initializeService(registryAddress, authority, owner);
 
         _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
 
         registerInterface(type(IClaimService).interfaceId);
     }
 
-
-    function getDomain() public pure override returns(ObjectType) {
-        return CLAIM();
-    }
-
     function submit(
         NftId policyNftId, 
         Amount claimAmount,
-        bytes memory claimData
+        bytes memory claimData // claim submission data
     )
         external
         virtual
@@ -99,6 +67,7 @@ contract ClaimService is
             revert ErrorClaimServicePolicyNotOpen(policyNftId);
         }
 
+        // TODO check claim amount > 0
         // check policy including this claim is still within sum insured
         if(policyInfo.payoutAmount + claimAmount > policyInfo.sumInsuredAmount) {
             revert ErrorClaimServiceClaimExceedsSumInsured(
@@ -109,22 +78,23 @@ contract ClaimService is
 
         // create new claim
         claimId = ClaimIdLib.toClaimId(policyInfo.claimsCount + 1);
-        instance.createClaim(
+        instance.getInstanceStore().createClaim(
             policyNftId, 
             claimId, 
-            IPolicy.ClaimInfo(
-                claimAmount,
-                AmountLib.zero(), // paidAmount
-                0, // payoutsCount
-                0, // openPayoutsCount
-                claimData,
-                TimestampLib.zero())); // closedAt
+            IPolicy.ClaimInfo({
+                claimAmount: claimAmount,
+                paidAmount: AmountLib.zero(),
+                payoutsCount: 0,
+                openPayoutsCount: 0,
+                submissionData: claimData,
+                processData: "",
+                closedAt: TimestampLib.zero()}));
 
         // update and save policy info with instance
         policyInfo.claimsCount += 1;
         policyInfo.openClaimsCount += 1;
         // policy claim amount is only updated when claim is confirmed
-        instance.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
         emit LogClaimServiceClaimSubmitted(policyNftId, claimId, claimAmount);
     }
@@ -133,7 +103,8 @@ contract ClaimService is
     function confirm(
         NftId policyNftId, 
         ClaimId claimId,
-        Amount confirmedAmount
+        Amount confirmedAmount,
+        bytes memory data // claim processing data
     )
         external
         virtual
@@ -144,21 +115,28 @@ contract ClaimService is
             IPolicy.PolicyInfo memory policyInfo
         ) = _verifyCallerWithPolicy(policyNftId);
 
+        // TODO add check for confirmedAmount > 0 and does not lead to exceeding sum insured
+
         // check/update claim info
         IPolicy.ClaimInfo memory claimInfo = _verifyClaim(instanceReader, policyNftId, claimId, SUBMITTED());
         claimInfo.claimAmount = confirmedAmount;
-        instance.updateClaim(policyNftId, claimId, claimInfo, CONFIRMED());
+        claimInfo.processData = data;
+        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, CONFIRMED());
+
+        // TODO test if claim results in total claim amount == sum insured amount
+        // should policy still be active it needs to automatically become expired
 
         // update and save policy info with instance
-        policyInfo.claimAmount = policyInfo.claimAmount.add(confirmedAmount);
-        instance.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+        policyInfo.claimAmount = policyInfo.claimAmount + confirmedAmount;
+        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
         emit LogClaimServiceClaimConfirmed(policyNftId, claimId, confirmedAmount);
     }
 
     function decline(
         NftId policyNftId, 
-        ClaimId claimId
+        ClaimId claimId,
+        bytes memory data // claim processing data
     )
         external
         virtual
@@ -171,16 +149,45 @@ contract ClaimService is
 
         // check/update claim info
         IPolicy.ClaimInfo memory claimInfo = _verifyClaim(instanceReader, policyNftId, claimId, SUBMITTED());
+        claimInfo.processData = data;
         claimInfo.closedAt = TimestampLib.blockTimestamp();
-        instance.updateClaim(policyNftId, claimId, claimInfo, DECLINED());
+        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, DECLINED());
 
         // update and save policy info with instance
         policyInfo.openClaimsCount -= 1;
-        instance.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
         emit LogClaimServiceClaimDeclined(policyNftId, claimId);
     }
 
+
+    // TODO add test case
+    function revoke(
+        NftId policyNftId, 
+        ClaimId claimId
+    )
+        external
+        virtual
+    {
+        (
+            IInstance instance,
+            InstanceReader instanceReader,
+            IPolicy.PolicyInfo memory policyInfo
+        ) = _verifyCallerWithPolicy(policyNftId);
+
+        // check/update claim info
+        IPolicy.ClaimInfo memory claimInfo = _verifyClaim(instanceReader, policyNftId, claimId, SUBMITTED());
+        claimInfo.closedAt = TimestampLib.blockTimestamp();
+        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, REVOKED());
+
+        // update and save policy info with instance
+        policyInfo.openClaimsCount -= 1;
+        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+
+        emit LogClaimServiceClaimRevoked(policyNftId, claimId);
+    }
+
+
     function close(
         NftId policyNftId, 
         ClaimId claimId
@@ -215,13 +222,31 @@ contract ClaimService is
         }
 
         claimInfo.closedAt = TimestampLib.blockTimestamp();
-        instance.updateClaim(policyNftId, claimId, claimInfo, CLOSED());
+        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, CLOSED());
+    }
 
-        // update and save policy info with instance
-        policyInfo.openClaimsCount -= 1;
-        instance.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+    // TODO add test
+    function createPayoutForBeneficiary(
+        NftId policyNftId, 
+        ClaimId claimId,
+        Amount amount,
+        address beneficiary,
+        bytes memory data
+    )
+        external
+        virtual
+        returns (PayoutId payoutId)
+    {
+        if (beneficiary == address(0)) {
+            revert ErrorClaimServiceBeneficiaryIsZero(policyNftId, claimId);
+        }
 
-        emit LogClaimServiceClaimClosed(policyNftId, claimId);
+        return _createPayout(
+            policyNftId, 
+            claimId, 
+            amount, 
+            beneficiary,
+            data);
     }
 
 
@@ -232,6 +257,26 @@ contract ClaimService is
         bytes memory data
     )
         external
+        virtual
+        returns (PayoutId payoutId)
+    {
+        return _createPayout(
+            policyNftId, 
+            claimId, 
+            amount, 
+            address(0), // defaults to owner of policy nft
+            data);
+    }
+
+    function _createPayout(
+        NftId policyNftId, 
+        ClaimId claimId,
+        Amount amount,
+        address beneficiary,
+        bytes memory data
+    )
+        internal
+        virtual
         returns (PayoutId payoutId)
     {
         (
@@ -251,23 +296,24 @@ contract ClaimService is
         // create payout info with instance
         uint8 claimNo = claimInfo.payoutsCount + 1;
         payoutId = PayoutIdLib.toPayoutId(claimId, claimNo);
-        instance.createPayout(
+        instance.getInstanceStore().createPayout(
             policyNftId, 
             payoutId, 
-            IPolicy.PayoutInfo(
-                payoutId.toClaimId(),
-                amount,
-                data,
-                TimestampLib.zero()));
+            IPolicy.PayoutInfo({
+                claimId: payoutId.toClaimId(),
+                amount: amount,
+                beneficiary: beneficiary,
+                data: data,
+                paidAt: TimestampLib.zero()}));
 
         // update and save claim info with instance
         claimInfo.payoutsCount += 1;
         claimInfo.openPayoutsCount += 1;
-        instance.updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
+        instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
 
         // update and save policy info with instance
         policyInfo.payoutAmount.add(amount);
-        instance.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
         emit LogClaimServicePayoutCreated(policyNftId, payoutId, amount);
     }
@@ -291,7 +337,7 @@ contract ClaimService is
 
         // update and save payout info with instance
         payoutInfo.paidAt = TimestampLib.blockTimestamp();
-        instance.updatePayout(policyNftId, payoutId, payoutInfo, PAID());
+        instance.getInstanceStore().updatePayout(policyNftId, payoutId, payoutInfo, PAID());
 
         // TODO update and save claim info with instance
         ClaimId claimId = payoutId.toClaimId();
@@ -304,37 +350,50 @@ contract ClaimService is
         // update claim and policy info accordingly
         if(claimInfo.openPayoutsCount == 0 && claimInfo.paidAmount == claimInfo.claimAmount) {
             claimInfo.closedAt == TimestampLib.blockTimestamp();
-            instance.updateClaim(policyNftId, claimId, claimInfo, CLOSED());
+            instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, CLOSED());
 
             policyInfo.openClaimsCount -= 1;
         } else {
-            instance.updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
+            instance.getInstanceStore().updateClaim(policyNftId, claimId, claimInfo, KEEP_STATE());
         }
 
         // update and save policy info with instance
         policyInfo.payoutAmount = policyInfo.payoutAmount.add(payoutAmount);
-        instance.updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
+        instance.getInstanceStore().updatePolicyClaims(policyNftId, policyInfo, KEEP_STATE());
 
         // inform pool about payout
-        _poolService.reduceCollateral(instance, policyNftId, policyInfo, payoutAmount);
+        _poolService.reduceCollateral(
+            instance, 
+            address(instanceReader.getComponentInfo(policyInfo.productNftId).token),
+            policyNftId, 
+            policyInfo, 
+            payoutAmount);
 
         // transfer payout token and fee
         (
             Amount netPayoutAmount,
+            Amount processingFeeAmount,
             address beneficiary
-        ) = _transferPayoutAmount(
+        ) = _calculatePayoutAmount(
             instanceReader,
             policyNftId,
             policyInfo,
             payoutInfo);
 
-        // TODO callback IPolicyHolder
+        emit LogClaimServicePayoutProcessed(policyNftId, payoutId, payoutAmount, beneficiary, netPayoutAmount, processingFeeAmount);
 
-        emit LogClaimServicePayoutProcessed(policyNftId, payoutId, payoutAmount, beneficiary, netPayoutAmount);
+        {
+            NftId poolNftId = getRegistry().getObjectInfo(policyInfo.bundleNftId).parentNftId;
+            IComponents.ComponentInfo memory poolInfo = instanceReader.getComponentInfo(poolNftId);
+            poolInfo.tokenHandler.distributeTokens(poolInfo.wallet, beneficiary, netPayoutAmount);
+
+            // TODO add 2nd token tx if processingFeeAmount > 0
+        }
+
+        // TODO callback IPolicyHolder
     }
 
-    // TODO create (I)TreasuryService that deals with all gif related token transfers
-    function _transferPayoutAmount(
+    function _calculatePayoutAmount(
         InstanceReader instanceReader,
         NftId policyNftId,
         IPolicy.PolicyInfo memory policyInfo,
@@ -343,6 +402,7 @@ contract ClaimService is
         internal
         returns (
             Amount netPayoutAmount,
+            Amount processingFeeAmount,
             address beneficiary
         )
     {
@@ -350,49 +410,34 @@ contract ClaimService is
 
         if(payoutAmount.gtz()) {
             NftId productNftId = policyInfo.productNftId;
-            ISetup.ProductSetupInfo memory setupInfo = instanceReader.getProductSetupInfo(productNftId);
 
             // get pool component info from policy or product
             NftId poolNftId = getRegistry().getObjectInfo(policyInfo.bundleNftId).parentNftId;
             IComponents.ComponentInfo memory poolInfo = instanceReader.getComponentInfo(poolNftId);
 
             netPayoutAmount = payoutAmount;
-            beneficiary = _getBeneficiary(policyNftId, payoutInfo.claimId);
 
-            if(FeeLib.gtz(setupInfo.processingFee)) {
-                // TODO calculate net payout and processing fees
-                // TODO transfer processing fees to product wallet
-                // TODO inform product to update fee book keeping
+            if (payoutInfo.beneficiary == address(0)) {
+                beneficiary = getRegistry().ownerOf(policyNftId);
+            } else { 
+                beneficiary = payoutInfo.beneficiary;
             }
 
-            poolInfo.tokenHandler.transfer(
-                poolInfo.wallet,
-                beneficiary,
-                netPayoutAmount);
+            IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
+            if(FeeLib.gtz(productInfo.processingFee)) {
+                // TODO calculate and set net payout and processing fees
+            }
         }
     }
 
     // internal functions
 
-    function _getBeneficiary(
-        NftId policyNftId,
-        ClaimId claimId
-    )
-        internal
-        returns (address beneficiary)
-    {
-        // TODO check if owner is IPolicyHolder
-        // if so, obtain beneficiary from this contract
-
-        // default beneficiary is policy nft owner
-        beneficiary = getRegistry().ownerOf(policyNftId);
-    }
-
-
     function _verifyCallerWithPolicy(
         NftId policyNftId
     )
         internal
+        view
+        virtual
         returns (
             IInstance instance,
             InstanceReader instanceReader,
@@ -400,7 +445,7 @@ contract ClaimService is
         )
     {
         NftId productNftId;
-        (productNftId,, instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        (productNftId,, instance) = _getAndVerifyActiveComponent(PRODUCT());
         instanceReader = instance.getInstanceReader();
 
         // check caller(product) policy match
@@ -435,9 +480,8 @@ contract ClaimService is
         claimInfo = instanceReader.getClaimInfo(policyNftId, claimId);
     }
 
-    function _getAndVerifyInstanceAndProduct() internal view returns (Product product) {
-        IRegistry.ObjectInfo memory productInfo;
-        (, productInfo,) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        product = Product(productInfo.objectAddress);
+
+    function _getDomain() internal pure override returns(ObjectType) {
+        return CLAIM();
     }
-}
+}

package/contracts/{instance/service → product}/ClaimServiceManager.sol

@@ -1,8 +1,8 @@
 // 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 {ClaimService} from "./ClaimService.sol";
 
 contract ClaimServiceManager is ProxyManager {
@@ -11,15 +11,18 @@ contract ClaimServiceManager is ProxyManager {
 
     /// @dev initializes proxy manager with service implementation 
     constructor(
-        address registryAddress
-    )
+        address authority, 
+        address registryAddress,
+        bytes32 salt
+    ) 
         ProxyManager(registryAddress)
     {
-        ClaimService svc = new ClaimService();
-        bytes memory data = abi.encode(registryAddress, address(this));
-        IVersionable versionable = deploy(
+        ClaimService svc = new ClaimService{salt: salt}();
+        bytes memory data = abi.encode(registryAddress, address(this), authority);
+        IVersionable versionable = deployDetermenistic(
             address(svc), 
-            data);
+            data,
+            salt);
 
         _claimService = ClaimService(address(versionable));
     }

package/contracts/{instance/service → product}/IApplicationService.sol

@@ -1,15 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {IPolicy} from "../module/IPolicy.sol";
-import {IService} from "../../shared/IService.sol";
+import {IPolicy} from "../instance/module/IPolicy.sol";
+import {IService} from "../shared/IService.sol";
 
-import {Amount} from "../../types/Amount.sol";
-import {NftId} from "../../types/NftId.sol";
-import {ObjectType} from "../../types/ObjectType.sol";
-import {ReferralId} from "../../types/Referral.sol";
-import {RiskId} from "../../types/RiskId.sol";
-import {Seconds} from "../../types/Seconds.sol";
+import {Amount} from "../type/Amount.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {ReferralId} from "../type/Referral.sol";
+import {RiskId} from "../type/RiskId.sol";
+import {Seconds} from "../type/Seconds.sol";
 
 /// @dev gif service responsible for creating applications
 /// only product components may call transaction functions
@@ -24,6 +24,7 @@ interface IApplicationService is IService {
         address applicationOwner,
         RiskId riskId,
         Amount sumInsuredAmount,
+        Amount premiumAmount,
         Seconds lifetime,
         NftId bundleNftId,
         ReferralId referralId,
@@ -59,21 +60,4 @@ interface IApplicationService is IService {
     /// an application can only be revoked in applied state
     /// only the application holder may revoke an application
     function revoke(NftId policyNftId) external;
-
-    /// @dev calculates the premium amount for the specified attributes
-    /// also returns the various fee components involved with creating a policy
-    function calculatePremium(
-        NftId productNftId,
-        RiskId riskId,
-        Amount sumInsuredAmount,
-        Seconds lifetime,
-        bytes memory applicationData,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        external
-        view
-        returns (
-            IPolicy.Premium memory premium
-        );
-}
+}