@etherisc/gif-next 0.0.2-dc95063-418 → 0.0.2-dd40550-413

package/contracts/components/IComponent.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IComponents} from "../instance/module/IComponents.sol";
@@ -11,12 +12,14 @@ import {IRegisterable} from "../shared/IRegisterable.sol";
 import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
 import {NftId} from "../types/NftId.sol";
 import {ObjectType} from "../types/ObjectType.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 
 /// @dev component base class
 /// component examples are product, distribution, pool and oracle
 interface IComponent is 
     IRegisterable,
-    ITransferInterceptor
+    ITransferInterceptor,
+    IAccessManaged
 {
     error ErrorComponentNotChainNft(address caller);
     error ErrorComponentNotProductService(address caller);
@@ -27,9 +30,13 @@ interface IComponent is
     error ErrorComponentWalletAddressIsSameAsCurrent();
     error ErrorComponentWalletAllowanceTooSmall(address oldWallet, address newWallet, uint256 allowance, uint256 balance);
 
+    error ErrorComponentWalletNotComponent();
+
     event LogComponentWalletAddressChanged(address oldWallet, address newWallet);
     event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
 
+    event LogComponentTokenHandlerApproved(uint256 limit);
+
     /// @dev locks component to disable functions that may change state related to this component, the only exception is function "unlock"
     /// only component owner (nft holder) is authorizes to call this function
     function lock() external;
@@ -38,6 +45,11 @@ interface IComponent is
     /// only component owner (nft holder) is authorizes to call this function
     function unlock() external;
 
+    /// @dev approves token hanlder to spend up to the specified amount of tokens
+    /// reverts if component wallet is not component itself
+    /// only component owner (nft holder) is authorizes to call this function
+    function approveTokenHandler(uint256 spendingLimitAmount) external;
+
     /// @dev sets the wallet address for the component
     /// if the current wallet has tokens, these will be transferred
     /// if the new wallet address is externally owned, an approval from the 
@@ -47,6 +59,9 @@ interface IComponent is
     /// @dev only product service may set product nft id during registration of product setup
     function setProductNftId(NftId productNftId) external;
 
+    /// @dev defines the instance to which this component is linked to
+    function getInstance() external view returns (IInstance instance);
+
     /// @dev returns the name of this component
     /// to successfully register the component with an instance the name MUST be unique in the linked instance
     function getName() external view returns (string memory name);
@@ -54,8 +69,9 @@ interface IComponent is
     /// @dev defines which ERC20 token is used by this component
     function getToken() external view returns (IERC20Metadata token);
 
-    /// @dev defines the instance to which this component is linked to
-    function getInstance() external view returns (IInstance instance);
+    /// @dev returns token handler for this component
+    /// only registered components return a non zero token handler
+    function getTokenHandler() external view returns (TokenHandler tokenHandler);
 
     /// @dev defines the wallet address used to hold the ERC20 tokens related to this component
     /// the default address is the component token address

package/contracts/components/IPoolComponent.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {Amount} from "../types/Amount.sol";
 import {Fee} from "../types/Fee.sol";
 import {IComponent} from "./IComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
@@ -18,17 +19,17 @@ interface IPoolComponent is IComponent {
 
     error ErrorPoolApplicationBundleMismatch(NftId applicationNftId);
 
-    event LogPoolVerifiedByPool(address pool, NftId applicationNftId, uint256 collateralizationAmount);
+    event LogPoolVerifiedByPool(address pool, NftId applicationNftId, Amount collateralizationAmount);
 
     /// @dev increases the staked tokens by the specified amount
     /// only the bundle owner may stake tokens
     /// bundle MUST be in active or locked state
-    function stake(NftId bundleNftId, uint256 amount) external;
+    function stake(NftId bundleNftId, Amount amount) external;
 
     /// @dev decreases the staked tokens by the specified amount
     /// only the bundle owner may unstake tokens from the bundle
     /// bundle MUST be in active, locked or closed state
-    function unstake(NftId bundleNftId, uint256 amount) external;
+    function unstake(NftId bundleNftId, Amount amount) external;
 
     /// @dev extends the bundle lifetime of the bundle by the specified time
     /// only the bundle owner may extend the bundle's lifetime
@@ -37,7 +38,7 @@ interface IPoolComponent is IComponent {
 
     /// @dev locks the specified bundle
     /// a bundle to be locked MUST be in active state
-    /// locked bundles may not be used to underwrite any new policy
+    /// locked bundles may not be used to collateralize any new policy
     function lockBundle(NftId bundleNftId) external;
 
     /// @dev unlocks the specified bundle
@@ -61,7 +62,7 @@ interface IPoolComponent is IComponent {
 
     /// @dev sets the maximum overall capital amound held by this pool
     /// function may only be called by pool owner
-    function setMaxCapitalAmount(uint256 maxCapitalAmount) external;
+    function setMaxCapitalAmount(Amount maxCapitalAmount) external;
 
     /// @dev sets the required role to create/own bundles
     /// may only be called once after setting up a pool
@@ -88,7 +89,7 @@ interface IPoolComponent is IComponent {
         bytes memory applicationData,
         NftId bundleNftId, 
         bytes memory bundleFilter,
-        uint256 collateralizationAmount
+        Amount collateralizationAmount
     ) external;
 
     /// @dev returns true iff the application matches with the bundle 
@@ -99,7 +100,7 @@ interface IPoolComponent is IComponent {
         bytes memory applicationData,
         NftId bundleNftId, 
         bytes memory bundleFilter,
-        uint256 collateralizationAmount
+        Amount collateralizationAmount
     )
         external
         view

package/contracts/components/IProductComponent.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {Amount} from "../types/Amount.sol";
 import {Fee} from "../types/Fee.sol";
 import {IComponent} from "./IComponent.sol";
 import {ISetup} from "../instance/module/ISetup.sol";
@@ -19,20 +20,20 @@ interface IProductComponent is IComponent {
     ) external;
 
     function calculatePremium(
-        uint256 sumInsuredAmount,
+        Amount sumInsuredAmount,
         RiskId riskId,
         Seconds lifetime,
         bytes memory applicationData,
         NftId bundleNftId,
         ReferralId referralId
-    ) external view returns (uint256 premiumAmount);
+    ) external view returns (Amount premiumAmount);
 
     function calculateNetPremium(
-        uint256 sumInsuredAmount,
+        Amount sumInsuredAmount,
         RiskId riskId,
         Seconds lifetime,
         bytes memory applicationData
-    ) external view returns (uint256 netPremiumAmount);    
+    ) external view returns (Amount netPremiumAmount);    
 
     
     function getPoolNftId() external view returns (NftId poolNftId);

package/contracts/components/Pool.sol

@@ -1,21 +1,20 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {Amount, AmountLib} from "../types/Amount.sol";
 import {Component} from "./Component.sol";
 import {Fee, FeeLib} from "../types/Fee.sol";
 import {IBundleService} from "../instance/service/IBundleService.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IPoolComponent} from "./IPoolComponent.sol";
 import {IPoolService} from "../instance/service/IPoolService.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {NftId, NftIdLib} from "../types/NftId.sol";
-import {POOL} from "../types/ObjectType.sol";
+import {BUNDLE, POOL} from "../types/ObjectType.sol";
 import {RoleId, PUBLIC_ROLE} from "../types/RoleId.sol";
 import {Seconds} from "../types/Seconds.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {UFixed, UFixedLib} from "../types/UFixed.sol";
 
-
 abstract contract Pool is
     Component, 
     IPoolComponent 
@@ -61,8 +60,8 @@ abstract contract Pool is
         initializeComponent(registry, instanceNftId, name, token, POOL(), isInterceptingNftTransfers, initialOwner, registryData);
 
         PoolStorage storage $ = _getPoolStorage();
-        $._poolService = getInstance().getPoolService();
-        $._bundleService = getInstance().getBundleService();
+        $._poolService = IPoolService(_getServiceAddress(POOL())); 
+        $._bundleService = IBundleService(_getServiceAddress(BUNDLE()));
 
         registerInterface(type(IPoolComponent).interfaceId);
     }
@@ -70,7 +69,7 @@ abstract contract Pool is
 
     function stake(
         NftId bundleNftId, 
-        uint256 amount
+        Amount amount
     )
         public
         virtual
@@ -83,7 +82,7 @@ abstract contract Pool is
 
     function unstake(
         NftId bundleNftId, 
-        uint256 amount
+        Amount amount
     )
         public
         virtual
@@ -133,7 +132,7 @@ abstract contract Pool is
         //restricted()
         onlyBundleOwner(bundleNftId)
     {
-        _getPoolStorage()._bundleService.close(bundleNftId);
+        _getPoolStorage()._poolService.closeBundle(bundleNftId);
     }
 
 
@@ -150,7 +149,7 @@ abstract contract Pool is
     }
 
 
-    function setMaxCapitalAmount(uint256 maxCapitalAmount)
+    function setMaxCapitalAmount(Amount maxCapitalAmount)
         public
         virtual
         restricted()
@@ -190,7 +189,7 @@ abstract contract Pool is
         bytes memory applicationData,
         NftId bundleNftId, 
         bytes memory bundleFilter,
-        uint256 collateralizationAmount
+        Amount collateralizationAmount
     )
         public
         virtual
@@ -219,7 +218,7 @@ abstract contract Pool is
         bytes memory applicationData,
         NftId bundleNftId, 
         bytes memory bundleFilter,
-        uint256 collateralizationAmount
+        Amount collateralizationAmount
     )
         public
         view
@@ -239,14 +238,14 @@ abstract contract Pool is
     function _createBundle(
         address bundleOwner,
         Fee memory fee,
-        uint256 amount,
+        Amount amount,
         Seconds lifetime, 
         bytes memory filter
     )
         internal
         returns(NftId bundleNftId)
     {
-        bundleNftId = _getPoolStorage()._bundleService.create(
+        bundleNftId = _getPoolStorage()._poolService.createBundle(
             bundleOwner,
             fee,
             amount,
@@ -274,11 +273,15 @@ abstract contract Pool is
             getToken(),
             TokenHandler(address(0)), // will be created by GIF service during registration
             address(this), // contract is its own wallet
+            AmountLib.zero(), // balance amount
+            AmountLib.zero(), // fee amount
             abi.encode(
                 IComponents.PoolInfo(
                     NftIdLib.zero(), // will be set when GIF registers the related product
                     PUBLIC_ROLE(), // bundleOwnerRole
-                    type(uint256).max, // maxCapitalAmount,
+                    AmountLib.max(), // maxCapitalAmount,
+                    AmountLib.zero(), // initial balance amount
+                    AmountLib.zero(), // initial fee amount
                     isNftInterceptor(), // isInterceptingBundleTransfers
                     false, // isExternallyManaged,
                     false, // isVerifyingApplications,

package/contracts/components/Product.sol

@@ -3,21 +3,25 @@ pragma solidity ^0.8.19;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
+import {Amount, AmountLib} from "../types/Amount.sol";
+import {ClaimId} from "../types/ClaimId.sol";
+import {Component} from "./Component.sol";
+import {Fee} from "../types/Fee.sol";
 import {IRisk} from "../instance/module/IRisk.sol";
 import {IApplicationService} from "../instance/service/IApplicationService.sol";
 import {IPolicyService} from "../instance/service/IPolicyService.sol";
 import {IProductService} from "../instance/service/IProductService.sol";
 import {IClaimService} from "../instance/service/IClaimService.sol";
+import {IPricingService} from "../instance/service/IPricingService.sol";
 import {IProductComponent} from "./IProductComponent.sol";
 import {NftId, NftIdLib} from "../types/NftId.sol";
-import {PRODUCT, APPLICATION, POLICY, CLAIM } from "../types/ObjectType.sol";
+import {PayoutId} from "../types/PayoutId.sol";
+import {PRODUCT, APPLICATION, POLICY, CLAIM, PRICE } from "../types/ObjectType.sol";
 import {ReferralId} from "../types/Referral.sol";
 import {RiskId, RiskIdLib} from "../types/RiskId.sol";
 import {Seconds} from "../types/Seconds.sol";
 import {StateId} from "../types/StateId.sol";
 import {Timestamp} from "../types/Timestamp.sol";
-import {Fee} from "../types/Fee.sol";
-import {Component} from "./Component.sol";
 
 import {TokenHandler} from "../shared/TokenHandler.sol";
 
@@ -40,6 +44,7 @@ abstract contract Product is
         IApplicationService _applicationService;
         IPolicyService _policyService;
         IClaimService _claimService;
+        IPricingService _pricingService;
         Pool _pool;
         Distribution _distribution;
         Fee _initialProductFee;
@@ -70,11 +75,12 @@ abstract contract Product is
 
         ProductStorage storage $ = _getProductStorage();
         // TODO add validation
-        // TODO refactor to go via registry
+        // TODO refactor to go via registry ?
         $._productService = IProductService(_getServiceAddress(PRODUCT())); 
         $._applicationService = IApplicationService(_getServiceAddress(APPLICATION())); 
         $._policyService = IPolicyService(_getServiceAddress(POLICY())); 
         $._claimService = IClaimService(_getServiceAddress(CLAIM())); 
+        $._pricingService = IPricingService(_getServiceAddress(PRICE()));
         $._pool = Pool(pool);
         $._distribution = Distribution(distribution);
         $._initialProductFee = productFee;
@@ -86,50 +92,17 @@ abstract contract Product is
         registerInterface(type(IProductComponent).interfaceId);  
     }
 
-
-    function calculatePremium(
-        uint256 sumInsuredAmount,
-        RiskId riskId,
-        Seconds lifetime,
-        bytes memory applicationData,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        external 
-        view 
-        override 
-        returns (uint256 premiumAmount)
-    {
-        IPolicy.Premium memory premium = _getProductStorage()._applicationService.calculatePremium(
-            getNftId(),
-            riskId,
-            sumInsuredAmount,
-            lifetime,
-            applicationData,
-            bundleNftId,
-            referralId
-        );
-        premiumAmount = premium.premiumAmount;
-    }
-
-
-    function calculateNetPremium(
-        uint256 sumInsuredAmount,
-        RiskId riskId,
-        Seconds lifetime,
-        bytes memory applicationData
+    // from product component
+    function setFees(
+        Fee memory productFee,
+        Fee memory processingFee
     )
         external
-        view
-        virtual override
-        returns (uint256 netPremiumAmount)
+        onlyOwner
+        restricted()
+        override
     {
-        // default 10% of sum insured
-        return sumInsuredAmount / 10;
-    }
-
-    function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
-        return RiskIdLib.toRiskId(riskName);
+        _getProductService().setFees(productFee, processingFee);
     }
 
     function _createRisk(
@@ -169,7 +142,7 @@ abstract contract Product is
     function _createApplication(
         address applicationOwner,
         RiskId riskId,
-        uint256 sumInsuredAmount,
+        Amount sumInsuredAmount,
         Seconds lifetime,
         NftId bundleNftId,
         ReferralId referralId,
@@ -189,14 +162,14 @@ abstract contract Product is
         );
     }
 
-    function _underwrite(
+    function _collateralize(
         NftId policyNftId,
         bool requirePremiumPayment,
         Timestamp activateAt
     )
         internal
     {
-        _getProductStorage()._policyService.underwrite(
+        _getProductStorage()._policyService.collateralize(
             policyNftId, 
             requirePremiumPayment, 
             activateAt);
@@ -229,28 +202,137 @@ abstract contract Product is
     )
         internal
     {
-        _getProductStorage()._policyService.close(policyNftId);
+        _getProductStorage()._policyService.close(
+            policyNftId);
     }
 
-    function getPoolNftId() external view override returns (NftId poolNftId) {
-        return getRegistry().getNftId(address(_getProductStorage()._pool));
+    function _submitClaim(
+        NftId policyNftId,
+        Amount claimAmount,
+        bytes memory claimData
+    )
+        internal
+        returns(ClaimId)
+    {
+        return _getProductStorage()._claimService.submit(
+            policyNftId,
+            claimAmount,
+            claimData);
     }
 
-    function getDistributionNftId() external view override returns (NftId distributionNftId) {
-        return getRegistry().getNftId(address(_getProductStorage()._distribution));
+    function _confirmClaim(
+        NftId policyNftId,
+        ClaimId claimId,
+        Amount confirmedAmount
+    )
+        internal
+    {
+        _getProductStorage()._claimService.confirm(
+            policyNftId,
+            claimId,
+            confirmedAmount);
     }
 
-    // from product component
-    function setFees(
-        Fee memory productFee,
-        Fee memory processingFee
+    function _declineClaim(
+        NftId policyNftId,
+        ClaimId claimId
+    )
+        internal
+    {
+        _getProductStorage()._claimService.decline(
+            policyNftId,
+            claimId);
+    }
+
+    function _closeClaim(
+        NftId policyNftId,
+        ClaimId claimId
+    )
+        internal
+    {
+        _getProductStorage()._claimService.close(
+            policyNftId,
+            claimId);
+    }
+
+    function _createPayout(
+        NftId policyNftId,
+        ClaimId claimId,
+        Amount amount,
+        bytes memory data
+    )
+        internal
+        returns (PayoutId)
+    {
+        return _getProductStorage()._claimService.createPayout(
+            policyNftId, 
+            claimId, 
+            amount, 
+            data);
+    }
+
+    function _processPayout(
+        NftId policyNftId,
+        PayoutId payoutId
+    )
+        internal
+    {
+        _getProductStorage()._claimService.processPayout(
+            policyNftId,
+            payoutId);
+    }
+
+    function calculatePremium(
+        Amount sumInsuredAmount,
+        RiskId riskId,
+        Seconds lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
+    )
+        external 
+        view 
+        override 
+        returns (Amount premiumAmount)
+    {
+        IPolicy.Premium memory premium = _getProductStorage()._pricingService.calculatePremium(
+            getNftId(),
+            riskId,
+            sumInsuredAmount,
+            lifetime,
+            applicationData,
+            bundleNftId,
+            referralId
+        );
+
+        return AmountLib.toAmount(premium.premiumAmount);
+    }
+
+    function calculateNetPremium(
+        Amount sumInsuredAmount,
+        RiskId riskId,
+        Seconds lifetime,
+        bytes memory applicationData
     )
         external
-        onlyOwner
-        restricted()
-        override
+        view
+        virtual override
+        returns (Amount netPremiumAmount)
     {
-        _getProductService().setFees(productFee, processingFee);
+        // default 10% of sum insured
+        return AmountLib.toAmount(sumInsuredAmount.toInt() / 10);
+    }
+
+    function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
+        return RiskIdLib.toRiskId(riskName);
+    }
+
+    function getPoolNftId() external view override returns (NftId poolNftId) {
+        return getRegistry().getNftId(address(_getProductStorage()._pool));
+    }
+
+    function getDistributionNftId() external view override returns (NftId distributionNftId) {
+        return getRegistry().getNftId(address(_getProductStorage()._distribution));
     }
 
     function getSetupInfo() public view returns (ISetup.ProductSetupInfo memory setupInfo) {
@@ -290,4 +372,4 @@ abstract contract Product is
     function _getProductService() internal view returns (IProductService) {
         return _getProductStorage()._productService;
     }
-}
+}

package/contracts/instance/BundleManager.sol

@@ -34,8 +34,7 @@ contract BundleManager is
     mapping(NftId bundleNftId => LibNftIdSet.Set policies) internal _activePolicies;
 
     /// @dev links a policy to its bundle
-    // to link a policy it MUST NOT yet have been activated
-    // the bundle MUST be unlocked (active) for linking (underwriting) and registered with this instance
+    // to link a policy it MUST NOT yet have been linked
     function linkPolicy(NftId policyNftId) external restricted() {
         NftId bundleNftId = _instance.getInstanceReader().getPolicyInfo(policyNftId).bundleNftId;
         // decision will likely depend on the decision what to check here and what in the service
@@ -87,14 +86,14 @@ contract BundleManager is
     }
 
 
-    /// @dev unlocked (active) bundles are available to underwrite new policies
+    /// @dev unlocked (active) bundles are available to collateralize new policies
     function unlock(NftId bundleNftId) external restricted() {
         NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
         _activate(poolNftId, bundleNftId);
         emit LogBundleManagerBundleUnlocked(poolNftId, bundleNftId);
     }
 
-    /// @dev locked (deactivated) bundles may not underwrite any new policies
+    /// @dev locked (deactivated) bundles may not collateralize any new policies
     function lock(NftId bundleNftId) external restricted() {
         NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
         _deactivate(poolNftId, bundleNftId);