@etherisc/gif-next 0.0.2-2296e6c-721 → 0.0.2-2298fe6-554

package/contracts/product/IClaimService.sol

@@ -23,14 +23,16 @@ interface IClaimService is
     event LogClaimServiceClaimSubmitted(NftId policyNftId, ClaimId claimId, Amount claimAmount);
     event LogClaimServiceClaimConfirmed(NftId policyNftId, ClaimId claimId, Amount confirmedAmount);
     event LogClaimServiceClaimDeclined(NftId policyNftId, ClaimId claimId);
+    event LogClaimServiceClaimRevoked(NftId policyNftId, ClaimId claimId);
     event LogClaimServiceClaimClosed(NftId policyNftId, ClaimId claimId);
 
     event LogClaimServicePayoutCreated(NftId policyNftId, PayoutId payoutId, Amount amount);
-    event LogClaimServicePayoutProcessed(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary, Amount netAmount);
+    event LogClaimServicePayoutProcessed(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary, Amount netAmount, Amount processingFeeAmount);
 
     error ErrorClaimServicePolicyProductMismatch(NftId policyNftId, NftId expectedProduct, NftId actualProduct);
     error ErrorClaimServicePolicyNotOpen(NftId policyNftId);
     error ErrorClaimServiceClaimExceedsSumInsured(NftId policyNftId, Amount sumInsured, Amount payoutsIncludingClaimAmount);
+    error ErrorClaimServiceBeneficiaryIsZero(NftId policyNftId, ClaimId claimId);
     error ErrorClaimsServicePayoutAmountIsZero(NftId policyNftId, PayoutId payoutId);
 
     error ErrorClaimServiceClaimWithOpenPayouts(NftId policyNftId, ClaimId claimId, uint8 openPayouts);
@@ -47,9 +49,6 @@ interface IClaimService is
     ) external returns (ClaimId claimId);
 
 
-    // TODO add claim revoke functionality
-
-
     /// @dev declines the specified claim
     /// function can only be called by product, policy needs to match with calling product
     function decline(
@@ -59,6 +58,14 @@ interface IClaimService is
     ) external;
 
 
+    /// @dev revokes the specified claim
+    /// function can only be called by product, policy needs to match with calling product
+    function revoke(
+        NftId policyNftId, 
+        ClaimId claimId
+    ) external;
+
+
     /// @dev confirms the specified claim and specifies the payout amount
     /// function can only be called by product, policy needs to match with calling product
     function confirm(
@@ -77,7 +84,8 @@ interface IClaimService is
     ) external;
 
 
-    /// @dev creates a new payout for the specified claim
+    /// @dev Creates a new payout for the specified claim.
+    /// The beneficiary is the holder of the policy NFT
     /// returns the id of the newly created payout, this id is unique for the specified policy
     /// function can only be called by product, policy needs to match with calling product
     function createPayout(
@@ -90,6 +98,20 @@ interface IClaimService is
         returns (PayoutId payoutId);
 
 
+    /// @dev Creates a new payout for the specified claim and beneficiary.
+    /// returns the id of the newly created payout, this id is unique for the specified policy
+    /// function can only be called by product, policy needs to match with calling product
+    function createPayoutForBeneficiary(
+        NftId policyNftId, 
+        ClaimId claimId,
+        Amount amount,
+        address beneficiary,
+        bytes memory data
+    )
+        external
+        returns (PayoutId payoutId);
+
+
     /// @dev processes the specified payout
     /// this includes moving the payout token to the beneficiary (default: policy holder)
     /// function can only be called by product, policy needs to match with calling product

package/contracts/product/IPolicyService.sol

@@ -10,6 +10,13 @@ import {Timestamp} from "../type/Timestamp.sol";
 
 interface IPolicyService is IService {
 
+    event LogPolicyServicePolicyCreated(NftId policyNftId, Amount premiumAmount, Timestamp activatedAt);
+    event LogPolicyServicePolicyDeclined(NftId policyNftId);
+    event LogPolicyServicePolicyPremiumCollected(NftId policyNftId, Amount premiumAmount);
+    event LogPolicyServicePolicyActivated(NftId policyNftId, Timestamp activatedAt);
+    event LogPolicyServicePolicyExpirationUpdated(NftId policyNftId, Timestamp originalExpiredAt, Timestamp expiredAt);
+    event LogPolicyServicePolicyClosed(NftId policyNftId);
+
     error ErrorPolicyServicePolicyProductMismatch(NftId applicationNftId, NftId expectedProductNftId, NftId actualProductNftId);
     error ErrorPolicyServicePolicyStateNotApplied(NftId applicationNftId);
     error ErrorPolicyServicePolicyStateNotCollateralized(NftId applicationNftId);
@@ -19,11 +26,11 @@ interface IPolicyService is IService {
     error ErrorPolicyServiceAllowanceInsufficient(address policyOwner, address tokenHandler, uint256 premiumAmount, uint256 allowance);
 
     error ErrorPolicyServiceInsufficientAllowance(address customer, address tokenHandlerAddress, uint256 amount);
-    error ErrorPolicyServicePremiumAlreadyPaid(NftId policyNftId, Amount premiumPaidAmount);
+    error ErrorPolicyServicePremiumAlreadyPaid(NftId policyNftId);
     error ErrorPolicyServicePolicyNotActivated(NftId policyNftId);
     error ErrorPolicyServicePolicyAlreadyClosed(NftId policyNftId);
     error ErrorPolicyServicePolicyNotActive(NftId policyNftId, StateId state);
-    error ErrorPolicyServicePremiumNotFullyPaid(NftId policyNftId, Amount premiumAmount, Amount premiumPaidAmount);
+    error ErrorPolicyServicePremiumNotPaid(NftId policyNftId, Amount premiumAmount);
     error ErrorPolicyServiceOpenClaims(NftId policyNftId, uint16 openClaimsCount);
     error ErrorPolicyServicePolicyHasNotExpired(NftId policyNftId, Timestamp expiredAt);
     error ErrorPolicyServicePolicyExpirationTooLate(NftId policyNftId, Timestamp upperLimit, Timestamp expiredAt);
@@ -32,9 +39,6 @@ interface IPolicyService is IService {
     error ErrorPolicyServicePremiumMismatch(NftId policyNftId, Amount expectedPremiumAmount, Amount recalculatedPremiumAmount);
     error ErrorPolicyServiceTransferredPremiumMismatch(NftId policyNftId, Amount expectedPremiumAmount, Amount transferredPremiumAmount);
 
-    event LogPolicyServicePolicyDeclined(NftId policyNftId);
-    event LogPolicyServicePolicyExpirationUpdated(NftId policyNftId, Timestamp expiredAt);
-
     /// @dev creates the policy from {applicationNftId}. 
     /// After successful completion of the function the policy can be referenced using the application NftId.
     /// Locks the sum insured amount in the pool, but does not transfer tokens. Call collectPremium to transfer tokens. 

package/contracts/product/PolicyService.sol

@@ -14,13 +14,14 @@ import {TokenHandler} from "../shared/TokenHandler.sol";
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {Timestamp, TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
 import {ObjectType, APPLICATION, COMPONENT, DISTRIBUTION, PRODUCT, POOL, POLICY, BUNDLE, CLAIM, PRICE} from "../type/ObjectType.sol";
-import {APPLIED, COLLATERALIZED, KEEP_STATE, CLOSED, DECLINED} from "../type/StateId.sol";
+import {APPLIED, COLLATERALIZED, KEEP_STATE, CLOSED, DECLINED, PAID} from "../type/StateId.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {StateId} from "../type/StateId.sol";
 import {VersionPart} from "../type/Version.sol";
 
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
 import {IApplicationService} from "./IApplicationService.sol";
 import {IBundleService} from "../pool/IBundleService.sol";
 import {IClaimService} from "./IClaimService.sol";
@@ -28,6 +29,7 @@ import {IComponentService} from "../shared/IComponentService.sol";
 import {IDistributionService} from "../distribution/IDistributionService.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
+import {IPolicyHolder} from "../shared/IPolicyHolder.sol";
 import {IPolicyService} from "./IPolicyService.sol";
 import {IPoolService} from "../pool/IPoolService.sol";
 import {IPricingService} from "./IPricingService.sol";
@@ -56,12 +58,11 @@ contract PolicyService is
         initializer
     {
         (
-            address registryAddress,, 
-            //address managerAddress
+            address registryAddress,
             address authority
-        ) = abi.decode(data, (address, address, address));
+        ) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, authority, owner);
+        _initializeService(registryAddress, authority, owner);
 
         VersionPart majorVersion = getVersion().toMajorPart();
         _applicationService = IApplicationService(getRegistry().getServiceAddress(APPLICATION(), majorVersion));
@@ -72,7 +73,7 @@ contract PolicyService is
         _distributionService = IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), majorVersion));
         _pricingService = IPricingService(getRegistry().getServiceAddress(PRICE(), majorVersion));
 
-        registerInterface(type(IPolicyService).interfaceId);
+        _registerInterface(type(IPolicyService).interfaceId);
     }
 
 
@@ -80,7 +81,8 @@ contract PolicyService is
         NftId applicationNftId // = policyNftId
     )
         external
-        virtual override
+        virtual
+        nonReentrant()
     {
         (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -115,7 +117,8 @@ contract PolicyService is
         Timestamp activateAt
     )
         external 
-        virtual override
+        virtual
+        nonReentrant()
     {
         // check caller is registered product
         (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
@@ -175,16 +178,21 @@ contract PolicyService is
         // update referral counter 
         {
             IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
-            _distributionService.processReferral(
-                productInfo.distributionNftId, 
-                applicationInfo.referralId);
+
+            if (! productInfo.distributionNftId.eqz()) { // only call distribution service if a distribution component is connected to the product    
+                _distributionService.processReferral(
+                    productInfo.distributionNftId, 
+                    applicationInfo.referralId);
+            }
         }
-        
-        // TODO add calling pool contract if it needs to validate application
 
-        // TODO: add logging
+        // log policy creation before interactions with token and policy holder
+        emit LogPolicyServicePolicyCreated(applicationNftId, premium.premiumAmount, activateAt);
 
-        // TODO: add callback IPolicyHolder.policyActivated() if applicable
+        // TODO add calling pool contract if it needs to validate application
+
+        // callback to policy holder if applicable
+        _policyHolderPolicyActivated(applicationNftId, activateAt);
     }
 
 
@@ -195,6 +203,7 @@ contract PolicyService is
     )
         external 
         virtual
+        nonReentrant()
     {
         // check caller is registered product
         (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
@@ -206,16 +215,14 @@ contract PolicyService is
             revert ErrorPolicyServicePolicyStateNotCollateralized(policyNftId);
         }
 
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
-
         // check if premium is already collected
-        if (policyInfo.premiumPaidAmount.gtz()) {
-            revert ErrorPolicyServicePremiumAlreadyPaid(policyNftId, policyInfo.premiumPaidAmount);
+        if (instanceReader.getPremiumInfoState(policyNftId) == PAID()) {
+            revert ErrorPolicyServicePremiumAlreadyPaid(policyNftId);
         }
 
+        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
         IPolicy.PremiumInfo memory premium = instanceReader.getPremiumInfo(policyNftId); 
-        policyInfo.premiumPaidAmount = premium.premiumAmount;
-
+        
         _processPremium(
             instance,
             policyNftId,
@@ -228,16 +235,20 @@ contract PolicyService is
         }
 
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, KEEP_STATE());
+        instance.getInstanceStore().updatePremiumState(policyNftId, PAID());
 
-        // TODO: add logging
+        // log premium collection before interactions with token
+        emit LogPolicyServicePolicyPremiumCollected(policyNftId, premium.premiumAmount);
 
         _transferFunds(instanceReader, policyNftId, policyInfo.productNftId, premium);
-
-        // TODO: add callback IPolicyHolder.policyActivated() if applicable
     }
 
     /// @inheritdoc IPolicyService
-    function activate(NftId policyNftId, Timestamp activateAt) public override {
+    function activate(NftId policyNftId, Timestamp activateAt)
+        external
+        virtual
+        nonReentrant()
+ {
         // check caller is registered product
         (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -247,9 +258,11 @@ contract PolicyService is
 
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, KEEP_STATE());
 
-        // TODO: add logging
+        // log policy activation before interactions with policy holder
+        emit LogPolicyServicePolicyActivated(policyNftId, activateAt);
 
-        // TODO: add callback IPolicyHolder.policyActivated() if applicable
+        // callback to policy holder if applicable
+        _policyHolderPolicyActivated(policyNftId, activateAt);
     }
 
 
@@ -259,8 +272,8 @@ contract PolicyService is
         Timestamp expireAt
     )
         external
-        override
         virtual
+        nonReentrant()
         returns (Timestamp expiredAt)
     {
         (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
@@ -298,12 +311,14 @@ contract PolicyService is
         }
 
         // update policyInfo with new expiredAt timestamp
+        Timestamp originalExpiredAt = policyInfo.expiredAt;
         policyInfo.expiredAt = expiredAt;
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, KEEP_STATE());
 
-        emit LogPolicyServicePolicyExpirationUpdated(policyNftId, expiredAt);
+        emit LogPolicyServicePolicyExpirationUpdated(policyNftId, originalExpiredAt, expiredAt);
 
-        // TODO: add callback IPolicyHolder.policyExpired() if applicable
+        // callback to policy holder if applicable
+        _policyHolderPolicyExpired(policyNftId, expiredAt);
     }
 
 
@@ -311,7 +326,8 @@ contract PolicyService is
         NftId policyNftId
     )
         external 
-        override
+        virtual
+        nonReentrant()
     {
         (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -335,8 +351,8 @@ contract PolicyService is
 
         // TODO consider to allow for underpaid premiums (with the effects of reducing max payouts accordingly)
         // TODO consider to remove requirement for fully paid premiums altogether
-        if (!(policyInfo.premiumAmount == policyInfo.premiumPaidAmount)) {
-            revert ErrorPolicyServicePremiumNotFullyPaid(policyNftId, policyInfo.premiumAmount, policyInfo.premiumPaidAmount);
+        if (! instanceReader.getPremiumInfoState(policyNftId).eq(PAID())) {
+            revert ErrorPolicyServicePremiumNotPaid(policyNftId, policyInfo.premiumAmount);
         }
 
         // release (remaining) collateral that was blocked by policy
@@ -352,7 +368,7 @@ contract PolicyService is
         policyInfo.closedAt = TimestampLib.blockTimestamp();
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, CLOSED());
 
-        // TODO add logging
+        emit LogPolicyServicePolicyClosed(policyNftId);
     }
 
 
@@ -440,10 +456,12 @@ contract PolicyService is
             premium.productFeeVarAmount + premium.productFeeFixAmount);
 
         // update distribution fees and distributor commission and pool fees 
-        _distributionService.processSale(
-            distributionNftId, 
-            referralId, 
-            premium);
+        if (!distributionNftId.eqz()) { // only call distribution service if a distribution component is connected to the product
+            _distributionService.processSale(
+                distributionNftId, 
+                referralId, 
+                premium);
+        }
 
         // update pool and bundle fees 
         _poolService.processSale(
@@ -526,6 +544,64 @@ contract PolicyService is
     }
 
 
+    function _policyHolderPolicyActivated(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+        virtual
+    {
+        // immediately return if policy is not activated
+        if (activateAt.eqz()) {
+            return;
+        }
+
+        // get policy holder address
+        IPolicyHolder policyHolder = _getPolicyHolder(policyNftId);
+
+        // execute callback if policy holder implements IPolicyHolder
+        if (address(policyHolder) != address(0)) {
+            policyHolder.policyActivated(policyNftId, activateAt);
+        }
+    }
+
+
+    function _policyHolderPolicyExpired(
+        NftId policyNftId,
+        Timestamp expiredAt
+    )
+        internal
+        virtual
+    {
+        // immediately return if policy is not activated
+        if (expiredAt.eqz()) {
+            return;
+        }
+
+        // get policy holder address
+        IPolicyHolder policyHolder = _getPolicyHolder(policyNftId);
+
+        // execute callback if policy holder implements IPolicyHolder
+        if (address(policyHolder) != address(0)) {
+            policyHolder.policyExpired(policyNftId, expiredAt);
+        }
+    }
+
+
+    function _getPolicyHolder(NftId policyNftId)
+        internal 
+        view 
+        returns (IPolicyHolder policyHolder)
+    {
+        address policyHolderAddress = getRegistry().ownerOf(policyNftId);
+        policyHolder = IPolicyHolder(policyHolderAddress);
+
+        if (!ContractLib.isPolicyHolder(policyHolderAddress)) {
+            policyHolder = IPolicyHolder(address(0));
+        }
+    }
+
+
     function _getTokenHandler(
         InstanceReader instanceReader,
         NftId productNftId
@@ -540,6 +616,7 @@ contract PolicyService is
         tokenHandler = instanceReader.getComponentInfo(productNftId).tokenHandler;
     }
 
+
     function _getDistributionNftAndWallets(
         InstanceReader instanceReader,
         NftId productNftId

package/contracts/product/PolicyServiceManager.sol

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

package/contracts/product/PricingService.sol

@@ -45,13 +45,12 @@ contract PricingService is
         initializer()
     {
         (
-            address registryAddress,, 
-            //address managerAddress
+            address registryAddress, 
             address authority
-        ) = abi.decode(data, (address, address, address));
+        ) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, authority, owner);
-        registerInterface(type(IPricingService).interfaceId);
+        _initializeService(registryAddress, authority, owner);
+        _registerInterface(type(IPricingService).interfaceId);
 
         _distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION()));
     }

package/contracts/product/PricingServiceManager.sol

@@ -15,11 +15,11 @@ contract PricingServiceManager is ProxyManager {
         address registryAddress,
         bytes32 salt
     )
-        ProxyManager(registryAddress)
     {
         PricingService pricingSrv = new PricingService{salt: salt}();
-        bytes memory data = abi.encode(registryAddress, address(this), authority);
-        IVersionable versionable = deployDetermenistic(
+        bytes memory data = abi.encode(registryAddress, authority);
+        IVersionable versionable = initialize(
+            registryAddress,
             address(pricingSrv), 
             data,
             salt);

package/contracts/product/Product.sol

@@ -123,11 +123,11 @@ abstract contract Product is
     }
 
     function getPoolNftId() external view override returns (NftId poolNftId) {
-        return getRegistry().getNftId(address(_getProductStorage()._pool));
+        return getRegistry().getNftIdForAddress(address(_getProductStorage()._pool));
     }
 
     function getDistributionNftId() external view override returns (NftId distributionNftId) {
-        return getRegistry().getNftId(address(_getProductStorage()._distribution));
+        return getRegistry().getNftIdForAddress(address(_getProductStorage()._distribution));
     }
 
     function _initializeProduct(
@@ -171,10 +171,10 @@ abstract contract Product is
         $._componentService = IComponentService(_getServiceAddress(COMPONENT()));
         $._pool = Pool(pool);
         $._distribution = Distribution(distribution);
-        $._poolNftId = getRegistry().getNftId(pool);
-        $._distributionNftId = getRegistry().getNftId(distribution);
+        $._poolNftId = getRegistry().getNftIdForAddress(pool);
+        $._distributionNftId = getRegistry().getNftIdForAddress(distribution);
 
-        registerInterface(type(IProductComponent).interfaceId);  
+        _registerInterface(type(IProductComponent).interfaceId);  
     }
 
 
@@ -380,6 +380,24 @@ abstract contract Product is
             data);
     }
 
+    function _createPayoutForBeneficiary(
+        NftId policyNftId,
+        ClaimId claimId,
+        Amount amount,
+        address beneficiary,
+        bytes memory data
+    )
+        internal
+        returns (PayoutId)
+    {
+        return _getProductStorage()._claimService.createPayoutForBeneficiary(
+            policyNftId, 
+            claimId, 
+            amount, 
+            beneficiary,
+            data);
+    }
+
     function _processPayout(
         NftId policyNftId,
         PayoutId payoutId

package/contracts/product/RiskService.sol

@@ -33,18 +33,17 @@ contract RiskService is
         virtual override
     {
         (
-            address registryAddress,, 
-            //address managerAddress
+            address registryAddress,
             address authority
-        ) = abi.decode(data, (address, address, address));
+        ) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, authority, owner);
+        _initializeService(registryAddress, authority, owner);
 
         _instanceService = IInstanceService(_getServiceAddress(INSTANCE()));
         _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
 
-        registerInterface(type(IRiskService).interfaceId);
+        _registerInterface(type(IRiskService).interfaceId);
     }
 
 

package/contracts/product/RiskServiceManager.sol

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