@etherisc/gif-next 0.0.2-7631288 → 0.0.2-764b9d9-026

package/contracts/product/Product.sol

@@ -0,0 +1,493 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Amount, AmountLib} from "../type/Amount.sol";
+import {ClaimId} from "../type/ClaimId.sol";
+import {Fee} from "../type/Fee.sol";
+import {IApplicationService} from "./IApplicationService.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
+import {IPolicyService} from "./IPolicyService.sol";
+import {IRiskService} from "./IRiskService.sol";
+import {IClaimService} from "./IClaimService.sol";
+import {IPricingService} from "./IPricingService.sol";
+import {IProductComponent} from "./IProductComponent.sol";
+import {NftId} from "../type/NftId.sol";
+import {COMPONENT, PRODUCT, BUNDLE, APPLICATION, POLICY, CLAIM, PRICE } from "../type/ObjectType.sol";
+import {PayoutId} from "../type/PayoutId.sol";
+import {COMPONENT, PRODUCT, APPLICATION, POLICY, CLAIM, PRICE, BUNDLE, RISK } from "../type/ObjectType.sol";
+import {ReferralId} from "../type/Referral.sol";
+import {RiskId} from "../type/RiskId.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {StateId} from "../type/StateId.sol";
+import {Timestamp} from "../type/Timestamp.sol";
+
+import {IPolicy} from "../instance/module/IPolicy.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
+
+abstract contract Product is
+    InstanceLinkedComponent, 
+    IProductComponent
+{
+    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Product")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant PRODUCT_STORAGE_LOCATION_V1 = 0x0bb7aafdb8e380f81267337bc5b5dfdf76e6d3a380ecadb51ec665246d9d6800;
+
+    struct ProductStorage {
+        IComponents.ProductInfo _productInfo;
+        IComponents.FeeInfo _feeInfo;
+        IComponentService _componentService;
+        IRiskService _riskService;
+        IApplicationService _applicationService;
+        IPolicyService _policyService;
+        IClaimService _claimService;
+        IPricingService _pricingService;
+    }
+
+
+    function registerComponent(address component)
+        external
+        virtual
+        restricted()
+        onlyOwner()
+        returns (NftId componentNftId)
+    {
+        return _getProductStorage()._componentService.registerComponent(component);
+    }
+
+
+    function processFundedClaim(
+        NftId policyNftId, 
+        ClaimId claimId, 
+        Amount availableAmount
+    )
+        external
+        virtual
+        restricted() // pool service role
+        onlyNftOfType(policyNftId, POLICY())
+    {
+        // default implementation does nothing
+    }
+
+
+    function calculatePremium(
+        Amount sumInsuredAmount,
+        RiskId riskId,
+        Seconds lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
+    )
+        public 
+        view 
+        virtual
+        override 
+        onlyNftOfType(bundleNftId, BUNDLE())
+        returns (Amount premiumAmount)
+    {
+        IPolicy.PremiumInfo memory premium = _getProductStorage()._pricingService.calculatePremium(
+            getNftId(),
+            riskId,
+            sumInsuredAmount,
+            lifetime,
+            applicationData,
+            bundleNftId,
+            referralId
+        );
+
+        return premium.premiumAmount;
+    }
+
+    function calculateNetPremium(
+        Amount sumInsuredAmount,
+        RiskId,
+        Seconds,
+        bytes memory
+    )
+        external
+        view
+        virtual override
+        returns (Amount netPremiumAmount)
+    {
+        // default 10% of sum insured
+        return AmountLib.toAmount(sumInsuredAmount.toInt() / 10);
+    }
+
+
+    function getInitialProductInfo()
+        public 
+        virtual 
+        view 
+        returns (IComponents.ProductInfo memory poolInfo)
+    {
+        return _getProductStorage()._productInfo;
+    }
+
+    function getInitialFeeInfo()
+        public 
+        virtual 
+        view 
+        returns (IComponents.FeeInfo memory feeInfo)
+    {
+        return _getProductStorage()._feeInfo;
+    }
+
+
+    function _initializeProduct(
+        address registry,
+        NftId instanceNftId,
+        string memory name,
+        IComponents.ProductInfo memory productInfo,
+        IComponents.FeeInfo memory feeInfo,
+        IAuthorization authorization,
+        address initialOwner,
+        bytes memory componentData // writeonly data that will saved in the object info record of the registry
+    )
+        internal
+        virtual
+        onlyInitializing()
+    {
+        _initializeInstanceLinkedComponent(
+            registry, 
+            instanceNftId, 
+            name, 
+            PRODUCT(), 
+            authorization, 
+            productInfo.isInterceptingPolicyTransfers, 
+            initialOwner, 
+            componentData);
+
+        ProductStorage storage $ = _getProductStorage();
+        $._productInfo = productInfo;
+        $._feeInfo = feeInfo;
+        $._riskService = IRiskService(_getServiceAddress(RISK())); 
+        $._applicationService = IApplicationService(_getServiceAddress(APPLICATION())); 
+        $._policyService = IPolicyService(_getServiceAddress(POLICY())); 
+        $._claimService = IClaimService(_getServiceAddress(CLAIM())); 
+        $._pricingService = IPricingService(_getServiceAddress(PRICE()));
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT()));
+
+        _registerInterface(type(IProductComponent).interfaceId);  
+    }
+
+
+    function _setFees(
+        Fee memory productFee,
+        Fee memory processingFee
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._componentService.setProductFees(productFee, processingFee);
+    }
+
+
+    function _createRisk(
+        bytes32 id,
+        bytes memory data
+    )
+        internal
+        virtual
+        returns (RiskId riskId)
+    {
+        return _getProductStorage()._riskService.createRisk(
+            id,
+            data
+        );
+    }
+
+    function _updateRisk(
+        RiskId id,
+        bytes memory data
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._riskService.updateRisk(
+            id,
+            data
+        );
+    }
+
+    function _setRiskLocked(
+        RiskId id,
+        bool locked
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._riskService.setRiskLocked(
+            id,
+            locked
+        );
+    }
+
+    function _closeRisk(
+        RiskId id
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._riskService.closeRisk(
+            id
+        );
+    }
+
+
+    function _createApplication(
+        address applicationOwner,
+        RiskId riskId,
+        Amount sumInsuredAmount,
+        Amount premiumAmount,
+        Seconds lifetime,
+        NftId bundleNftId,
+        ReferralId referralId,
+        bytes memory applicationData
+    )
+        internal
+        virtual
+        returns (NftId applicationNftId) 
+    {
+        return _getProductStorage()._applicationService.create(
+            applicationOwner,
+            riskId,
+            sumInsuredAmount,
+            premiumAmount,
+            lifetime,
+            bundleNftId,
+            referralId,
+            applicationData
+        );
+    }
+
+    function _revoke(
+        NftId applicationNftId
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._applicationService.revoke(
+            applicationNftId);
+    }
+
+    function _createPolicy(
+        NftId applicationNftId,
+        Timestamp activateAt,
+        Amount maxPremiumAmount
+    )
+        internal
+        virtual
+        returns (Amount premiumAmount)
+    {
+        premiumAmount = _getProductStorage()._policyService.createPolicy(
+            applicationNftId, 
+            activateAt,
+            maxPremiumAmount);
+    }
+
+    function _decline(
+        NftId policyNftId
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._policyService.decline(
+            policyNftId);
+    }
+
+    function _expire(
+        NftId policyNftId,
+        Timestamp expireAt
+    )
+        internal
+        virtual
+        returns (Timestamp expiredAt)
+    {
+        expiredAt = _getProductStorage()._policyService.expire(policyNftId, expireAt);
+    }
+
+    /// @dev adjust the activation date of the policy. 
+    /// The policy must already have an activation date set.
+    /// Allowed values are from the current blocktime to the expiration date of the policy.
+    function _adjustActivation(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._policyService.adjustActivation(
+            policyNftId, 
+            activateAt);
+    }
+
+    function _collectPremium(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._policyService.collectPremium(
+            policyNftId, 
+            activateAt);
+    }
+
+    function _activate(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._policyService.activate(
+            policyNftId, 
+            activateAt);
+    }
+
+    function _close(
+        NftId policyNftId
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._policyService.close(
+            policyNftId);
+    }
+
+    function _submitClaim(
+        NftId policyNftId,
+        Amount claimAmount,
+        bytes memory claimData
+    )
+        internal
+        virtual
+        returns(ClaimId)
+    {
+        return _getProductStorage()._claimService.submit(
+            policyNftId,
+            claimAmount,
+            claimData);
+    }
+
+    function _revokeClaim(
+        NftId policyNftId,
+        ClaimId claimId
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._claimService.revoke(
+            policyNftId,
+            claimId);
+    }
+
+    function _confirmClaim(
+        NftId policyNftId,
+        ClaimId claimId,
+        Amount confirmedAmount,
+        bytes memory data
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._claimService.confirm(
+            policyNftId,
+            claimId,
+            confirmedAmount,
+            data);
+    }
+
+    function _declineClaim(
+        NftId policyNftId,
+        ClaimId claimId,
+        bytes memory data
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._claimService.decline(
+            policyNftId,
+            claimId,
+            data);
+    }
+
+    function _cancelConfirmedClaim(
+        NftId policyNftId,
+        ClaimId claimId
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._claimService.cancelConfirmedClaim(
+            policyNftId,
+            claimId);
+    }
+
+    function _createPayout(
+        NftId policyNftId,
+        ClaimId claimId,
+        Amount amount,
+        bytes memory data
+    )
+        internal
+        virtual
+        returns (PayoutId)
+    {
+        return _getProductStorage()._claimService.createPayout(
+            policyNftId, 
+            claimId, 
+            amount, 
+            data);
+    }
+
+    function _createPayoutForBeneficiary(
+        NftId policyNftId,
+        ClaimId claimId,
+        Amount amount,
+        address beneficiary,
+        bytes memory data
+    )
+        internal
+        virtual
+        returns (PayoutId)
+    {
+        return _getProductStorage()._claimService.createPayoutForBeneficiary(
+            policyNftId, 
+            claimId, 
+            amount, 
+            beneficiary,
+            data);
+    }
+
+    function _processPayout(
+        NftId policyNftId,
+        PayoutId payoutId
+    )
+        internal
+        virtual
+        returns (Amount netPayoutAmount, Amount processingFeeAmount)
+    {
+        (netPayoutAmount, processingFeeAmount) = _getProductStorage()._claimService.processPayout(
+            policyNftId,
+            payoutId);
+    }
+
+    function _cancelPayout(
+        NftId policyNftId,
+        PayoutId payoutId
+    )
+        internal
+        virtual
+    {
+        _getProductStorage()._claimService.cancelPayout(
+            policyNftId,
+            payoutId);
+    }
+
+    function _getProductStorage() internal virtual pure returns (ProductStorage storage $) {
+        assembly {
+            $.slot := PRODUCT_STORAGE_LOCATION_V1
+        }
+    }
+}

package/contracts/product/RiskService.sol

@@ -0,0 +1,190 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IInstance} from "../instance/IInstance.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRisk} from "../instance/module/IRisk.sol";
+import {IRiskService} from "./IRiskService.sol";
+
+import {ContractLib} from "../shared/ContractLib.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {ObjectType, COMPONENT, PRODUCT, RISK} from "../type/ObjectType.sol";
+import {ACTIVE, KEEP_STATE, CLOSED} from "../type/StateId.sol";
+import {NftId} from "../type/NftId.sol";
+import {RiskId, RiskIdLib} from "../type/RiskId.sol";
+import {StateId} from "../type/StateId.sol";
+import {RiskSet} from "../instance/RiskSet.sol";
+import {Service} from "../shared/Service.sol";
+import {TimestampLib} from "../type/Timestamp.sol";
+
+contract RiskService is
+    Service,
+    IRiskService 
+{
+
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        initializer
+        virtual override
+    {
+        (
+            address authority,
+            address registry
+        ) = abi.decode(data, (address, address));
+
+        __Service_init(authority, registry, owner);
+        _registerInterface(type(IRiskService).interfaceId);
+    }
+
+    /// @inheritdoc IRiskService
+    function createRisk(
+        bytes32 id,
+        bytes memory data
+    )
+        external 
+        virtual
+        restricted()
+        returns (RiskId riskId)
+    {
+        // checks
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+
+        // effects
+        riskId = RiskIdLib.toRiskId(productNftId, id);
+        IRisk.RiskInfo memory riskInfo = IRisk.RiskInfo({
+            productNftId: productNftId, 
+            createdAt: TimestampLib.blockTimestamp(),
+            data: data});
+
+        instance.getInstanceStore().createRisk(
+            riskId,
+            riskInfo
+        );
+
+        // add risk to RiskSet
+        RiskSet riskSet = instance.getRiskSet();
+        riskSet.add(riskId);
+
+        emit LogRiskServiceRiskCreated(productNftId, riskId);
+    }
+
+
+    function updateRisk(
+        RiskId riskId,
+        bytes memory data
+    )
+        external 
+        virtual
+        restricted()
+    {
+        // checks
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+
+        // effects
+        InstanceReader instanceReader = instance.getInstanceReader();
+        IRisk.RiskInfo memory riskInfo = instanceReader.getRiskInfo(riskId);
+
+        if (riskInfo.productNftId != productNftId) {
+            revert ErrorRiskServiceRiskProductMismatch(riskId, riskInfo.productNftId, productNftId);
+        }
+
+        riskInfo.data = data;
+        instance.getInstanceStore().updateRisk(riskId, riskInfo, KEEP_STATE());
+
+        emit LogRiskServiceRiskUpdated(productNftId, riskId);
+    }
+
+
+    /// @inheritdoc IRiskService
+    function setRiskLocked(
+        RiskId riskId,
+        bool locked
+    )
+        external 
+        virtual
+        restricted()
+    {
+        // checks
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+
+        if (!instance.getRiskSet().hasRisk(productNftId, riskId)) {
+            revert ErrorRiskServiceUnknownRisk(productNftId, riskId);
+        }
+
+        if (instance.getInstanceReader().getRiskState(riskId) != ACTIVE()) {
+            revert ErrorRiskServiceRiskNotActive(productNftId, riskId);
+        }
+
+        if (locked) {
+            instance.getRiskSet().deactivate(riskId);
+            emit LogRiskServiceRiskLocked(productNftId, riskId);
+        } else {
+            instance.getRiskSet().activate(riskId);
+            emit LogRiskServiceRiskUnlocked(productNftId, riskId);
+        }
+    }
+
+    /// @inheritdoc IRiskService
+    function closeRisk(
+        RiskId riskId
+    )
+        external 
+        virtual
+        restricted()
+    {
+        // checks
+        (NftId productNftId, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+        (bool exists, bool active) = instance.getRiskSet().checkRisk(productNftId, riskId);
+
+        if (!exists) {
+            revert ErrorRiskServiceUnknownRisk(productNftId, riskId);
+        }
+
+        if (active) {
+            revert ErrorRiskServiceRiskNotLocked(productNftId, riskId);
+        }
+
+        // effects
+        instance.getInstanceStore().updateRiskState(riskId, CLOSED());
+
+        emit LogRiskServiceRiskClosed(productNftId, riskId);
+    }
+
+    function _getAndVerifyActiveComponent(ObjectType expectedType) 
+        internal 
+        view 
+        returns (
+            NftId componentNftId,
+            IInstance instance
+        )
+    {
+        IRegistry.ObjectInfo memory info;
+        address instanceAddress;
+        bool isActive = true;
+
+        if (expectedType != COMPONENT()) {
+            (info, instanceAddress) = ContractLib.getAndVerifyComponent(
+                getRegistry(),
+                msg.sender, // caller
+                expectedType,
+                isActive); 
+        } else {
+            (info, instanceAddress) = ContractLib.getAndVerifyAnyComponent(
+                getRegistry(),
+                msg.sender,
+                isActive); 
+        }
+
+        // get component nft id and instance
+        componentNftId = info.nftId;
+        instance = IInstance(instanceAddress);
+    }
+
+
+    function _getDomain() internal pure override returns(ObjectType) {
+        return RISK();
+    }
+}

package/contracts/product/RiskServiceManager.sol

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
+import {RiskService} from "./RiskService.sol";
+
+contract RiskServiceManager is ProxyManager {
+
+    RiskService private _riskService;
+
+    /// @dev initializes proxy manager with product service implementation 
+    constructor(
+        address authority, 
+        address registry,
+        bytes32 salt
+    ) 
+    {
+        RiskService svc = new RiskService{salt: salt}();
+        bytes memory data = abi.encode(authority, registry);
+        IVersionable versionable = initialize(
+            registry,
+            address(svc), 
+            data,
+            salt);
+
+        _riskService = RiskService(address(versionable));
+    }
+
+    //--- view functions ----------------------------------------------------//
+    function getRiskService()
+        external
+        view
+        returns (RiskService riskService)
+    {
+        return _riskService;
+    }
+
+}