@etherisc/gif-next 0.0.2-b244df3-779 → 0.0.2-b38343e-249

package/contracts/components/Product.sol

@@ -4,22 +4,19 @@ pragma solidity ^0.8.19;
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IRisk} from "../instance/module/IRisk.sol";
-import {ITreasury} from "../instance/module/ITreasury.sol";
-import {IProductService} from "../instance/service/IProductService.sol";
+import {IApplicationService} from "../instance/service/IApplicationService.sol";
 import {IPolicyService} from "../instance/service/IPolicyService.sol";
+import {IClaimService} from "../instance/service/IClaimService.sol";
 import {IProductComponent} from "./IProductComponent.sol";
-import {NftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
-import {ObjectType, PRODUCT} from "../types/ObjectType.sol";
+import {NftId, NftIdLib} from "../types/NftId.sol";
+import {PRODUCT, APPLICATION, POLICY, CLAIM } from "../types/ObjectType.sol";
 import {ReferralId} from "../types/Referral.sol";
 import {RiskId, RiskIdLib} from "../types/RiskId.sol";
 import {StateId} from "../types/StateId.sol";
 import {Timestamp} from "../types/Timestamp.sol";
-import {Fee, FeeLib} from "../types/Fee.sol";
-import {BaseComponent} from "./BaseComponent.sol";
+import {Fee} from "../types/Fee.sol";
+import {Component} from "./Component.sol";
 
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {Registerable} from "../shared/Registerable.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 
 import {InstanceReader} from "../instance/InstanceReader.sol";
@@ -27,47 +24,60 @@ import {ISetup} from "../instance/module/ISetup.sol";
 import {Pool} from "../components/Pool.sol";
 import {Distribution} from "../components/Distribution.sol";
 
-import {zeroNftId} from "../types/NftId.sol";
-
-contract Product is BaseComponent, IProductComponent {
-    using NftIdLib for NftId;
-
-    IProductService internal _productService;
-    IPolicyService internal _policyService;
-    Pool internal _pool;
-    Distribution internal _distribution;
-    Fee internal _initialProductFee;
-    Fee internal _initialProcessingFee;
-    TokenHandler internal _tokenHandler;
-
-    NftId internal _poolNftId;
-    NftId internal _distributionNftId;
+abstract contract Product is
+    Component, 
+    IProductComponent
+{
+    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Product")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant PRODUCT_STORAGE_LOCATION_V1 = 0x0bb7aafdb8e380f81267337bc5b5dfdf76e6d3a380ecadb51ec665246d9d6800;
+
+    struct ProductStorage {
+        IApplicationService _applicationService;
+        IPolicyService _policyService;
+        IClaimService _claimService;
+        Pool _pool;
+        Distribution _distribution;
+        Fee _initialProductFee;
+        Fee _initialProcessingFee;
+        TokenHandler _tokenHandler;
+        NftId _poolNftId;
+        NftId _distributionNftId;
+    }
 
-    constructor(
+    function initializeProduct(
         address registry,
-        NftId instanceNftid,
+        NftId instanceNftId,
+        string memory name,
         address token,
         bool isInterceptor,
         address pool,
         address distribution,
         Fee memory productFee,
         Fee memory processingFee,
-        address initialOwner
-    ) BaseComponent(registry, instanceNftid, token, PRODUCT(), isInterceptor, initialOwner) {
-        // TODO add validation
-        _productService = _instance.getProductService();
-        _policyService = _instance.getPolicyService(); 
-        _pool = Pool(pool);
-        _distribution = Distribution(distribution);
-        _initialProductFee = productFee;
-        _initialProcessingFee = processingFee;  
-
-        _tokenHandler = new TokenHandler(token);
-
-        _poolNftId = getRegistry().getNftId(address(_pool));
-        _distributionNftId = getRegistry().getNftId(address(_distribution));
+        address initialOwner,
+        bytes memory data
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        initializeComponent(registry, instanceNftId, name, token, PRODUCT(), isInterceptor, initialOwner, data);
 
-        _registerInterface(type(IProductComponent).interfaceId);  
+        ProductStorage storage $ = _getProductStorage();
+        // TODO add validation
+        // TODO refactor to go via registry
+        $._applicationService = IApplicationService(getServiceAddress(APPLICATION())); 
+        $._policyService = IPolicyService(getServiceAddress(POLICY())); 
+        $._claimService = IClaimService(getServiceAddress(CLAIM())); 
+        $._pool = Pool(pool);
+        $._distribution = Distribution(distribution);
+        $._initialProductFee = productFee;
+        $._initialProcessingFee = processingFee;  
+        $._tokenHandler = new TokenHandler(token);
+        $._poolNftId = getRegistry().getNftId(pool);
+        $._distributionNftId = getRegistry().getNftId(distribution);
+
+        registerInterface(type(IProductComponent).interfaceId);  
     }
 
 
@@ -76,15 +86,15 @@ contract Product is BaseComponent, IProductComponent {
         RiskId riskId,
         uint256 lifetime,
         bytes memory applicationData,
-        ReferralId referralId,
-        NftId bundleNftId
+        NftId bundleNftId,
+        ReferralId referralId
     )
         external 
         view 
         override 
         returns (uint256 premiumAmount)
     {
-        (premiumAmount,,,,) = _policyService.calculatePremium(
+        (premiumAmount,,,,) = _getProductStorage()._policyService.calculatePremium(
             riskId,
             sumInsuredAmount,
             lifetime,
@@ -118,7 +128,7 @@ contract Product is BaseComponent, IProductComponent {
         RiskId id,
         bytes memory data
     ) internal {
-        _productService.createRisk(
+        getProductService().createRisk(
             id,
             data
         );
@@ -128,7 +138,7 @@ contract Product is BaseComponent, IProductComponent {
         RiskId id,
         bytes memory data
     ) internal {
-        _productService.updateRisk(
+        getProductService().updateRisk(
             id,
             data
         );
@@ -138,14 +148,14 @@ contract Product is BaseComponent, IProductComponent {
         RiskId id,
         StateId state
     ) internal {
-        _productService.updateRiskState(
+        getProductService().updateRiskState(
             id,
             state
         );
     }
 
     function _getRiskInfo(RiskId id) internal view returns (IRisk.RiskInfo memory info) {
-        return _instance.getInstanceReader().getRiskInfo(id);
+        return getInstance().getInstanceReader().getRiskInfo(id);
     }
 
     function _createApplication(
@@ -153,18 +163,21 @@ contract Product is BaseComponent, IProductComponent {
         RiskId riskId,
         uint256 sumInsuredAmount,
         uint256 lifetime,
-        bytes memory applicationData,
         NftId bundleNftId,
-        ReferralId referralId
-    ) internal returns (NftId nftId) {
-        nftId = _policyService.createApplication(
+        ReferralId referralId,
+        bytes memory applicationData
+    )
+        internal
+        returns (NftId applicationNftId) 
+    {
+        return _getProductStorage()._applicationService.create(
             applicationOwner,
             riskId,
             sumInsuredAmount,
             lifetime,
-            applicationData,
             bundleNftId,
-            referralId
+            referralId,
+            applicationData
         );
     }
 
@@ -175,7 +188,7 @@ contract Product is BaseComponent, IProductComponent {
     )
         internal
     {
-        _policyService.underwrite(
+        _getProductStorage()._policyService.underwrite(
             policyNftId, 
             requirePremiumPayment, 
             activateAt);
@@ -187,7 +200,7 @@ contract Product is BaseComponent, IProductComponent {
     )
         internal
     {
-        _policyService.collectPremium(
+        _getProductStorage()._policyService.collectPremium(
             policyNftId, 
             activateAt);
     }
@@ -198,17 +211,25 @@ contract Product is BaseComponent, IProductComponent {
     )
         internal
     {
-        _policyService.activate(
+        _getProductStorage()._policyService.activate(
             policyNftId, 
             activateAt);
     }
 
+    function _close(
+        NftId policyNftId
+    )
+        internal
+    {
+        _getProductStorage()._policyService.close(policyNftId);
+    }
+
     function getPoolNftId() external view override returns (NftId poolNftId) {
-        return getRegistry().getNftId(address(_pool));
+        return getRegistry().getNftId(address(_getProductStorage()._pool));
     }
 
     function getDistributionNftId() external view override returns (NftId distributionNftId) {
-        return getRegistry().getNftId(address(_distribution));
+        return getRegistry().getNftId(address(_getProductStorage()._distribution));
     }
 
     // from product component
@@ -218,75 +239,47 @@ contract Product is BaseComponent, IProductComponent {
     )
         external
         onlyOwner
+        restricted()
         override
     {
-        _productService.setFees(productFee, processingFee);
+        getProductService().setFees(productFee, processingFee);
     }
 
     function getSetupInfo() public view returns (ISetup.ProductSetupInfo memory setupInfo) {
-        InstanceReader reader = _instance.getInstanceReader();
-        return reader.getProductSetupInfo(getNftId());
-    }
+        InstanceReader reader = getInstance().getInstanceReader();
+        setupInfo = reader.getProductSetupInfo(getNftId());
 
-    // from IRegisterable
+        // fallback to initial setup info (wallet is always != address(0))
+        if(setupInfo.wallet == address(0)) {
+            setupInfo = _getInitialSetupInfo();
+        }
+    }
 
-    function getInitialInfo() 
-        public
-        view 
-        override (IRegisterable, Registerable)
-        returns (IRegistry.ObjectInfo memory, bytes memory)
-    {
-        // from Registerable
-        (
-            IRegistry.ObjectInfo memory productInfo, 
-            bytes memory data
-        ) = super.getInitialInfo();
-        
-        // TODO read pool & distribution fees
-        // 1) from pool -> the only option -> pool must be registered first?
-        // 2) from instance -> all fees are set into instance at product registration which is ongoing here
-        // checks are done in registryProduct() where THIS function is called
-        //require(getRegistry().getObjectInfo(_poolNftId).objectType == POOL(), "POOL_NOT_REGISTERED");
-        //require(getRegistry().getObjectInfo(_distributionNftId).objectType == DISTRIBUTION(), "DISTRIBUTION_NOT_REGISTERED");
-        
-        // from PoolComponent
-        (
-            , 
-            bytes memory poolData
-        ) = _pool.getInitialInfo();
-        
-        (
-            ISetup.PoolSetupInfo memory poolSetupInfo
-        )  = abi.decode(poolData, (ISetup.PoolSetupInfo));
-
-        // from DistributionComponent
-        (
-            , 
-            bytes memory distributionData
-        ) = _distribution.getInitialInfo();
-
-        (
-            ISetup.DistributionSetupInfo memory distributionSetupInfo
-        )  = abi.decode(distributionData, (ISetup.DistributionSetupInfo));
-
-        return (
-            productInfo,
-            abi.encode(
-                ISetup.ProductSetupInfo(
-                    _token,
-                    _tokenHandler,
-                    _distributionNftId,
-                    _poolNftId,
-                    distributionSetupInfo.distributionFee, 
-                    _initialProductFee,
-                    _initialProcessingFee,
-                    poolSetupInfo.poolFee, 
-                    poolSetupInfo.stakingFee, 
-                    poolSetupInfo.performanceFee,
-                    false,
-                    _wallet
-                )
-            )
+    function _getInitialSetupInfo() internal view returns (ISetup.ProductSetupInfo memory setupInfo) {
+        ProductStorage storage $ = _getProductStorage();
+
+        ISetup.DistributionSetupInfo memory distributionSetupInfo = $._distribution.getSetupInfo();
+        ISetup.PoolSetupInfo memory poolSetupInfo = $._pool.getSetupInfo();
+
+        return ISetup.ProductSetupInfo(
+            getToken(),
+            $._tokenHandler,
+            $._distributionNftId,
+            $._poolNftId,
+            distributionSetupInfo.distributionFee, 
+            $._initialProductFee,
+            $._initialProcessingFee,
+            poolSetupInfo.poolFee, 
+            poolSetupInfo.stakingFee, 
+            poolSetupInfo.performanceFee,
+            false,
+            getWallet()
         );
     }
+
+    function _getProductStorage() private pure returns (ProductStorage storage $) {
+        assembly {
+            $.slot := PRODUCT_STORAGE_LOCATION_V1
+        }
+    }
 }

package/contracts/instance/BundleManager.sol

@@ -32,17 +32,13 @@ contract BundleManager is
 
     mapping(NftId bundleNftId => LibNftIdSet.Set policies) internal _activePolicies;
 
-    constructor() ObjectManager() {
-    }
-
-
     /// @dev links a policy with 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
     function linkPolicy(NftId policyNftId) external restricted() {
-        NftId bundleNftId = _instanceReader.getPolicyInfo(policyNftId).bundleNftId;
+        NftId bundleNftId = _instance.getInstanceReader().getPolicyInfo(policyNftId).bundleNftId;
         // decision will likely depend on the decision what to check here and what in the service
-        NftId poolNftId = _instanceReader.getBundleInfo(bundleNftId).poolNftId;
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
 
         // ensure bundle is unlocked (in active set) and registered with this instance
         if (!_isActive(poolNftId, bundleNftId)) {
@@ -59,11 +55,11 @@ contract BundleManager is
     // - the policy MUST be past its expiry period and it MUST NOT have any open claims
     // - the policy's payoutAmount MUST be equal to its sumInsuredAmount and MUST NOT have any open claims
     function unlinkPolicy(NftId policyNftId) external restricted() {
-        IPolicy.PolicyInfo memory policyInfo = _instanceReader.getPolicyInfo(policyNftId);
+        IPolicy.PolicyInfo memory policyInfo = _instance.getInstanceReader().getPolicyInfo(policyNftId);
 
         NftId bundleNftId = policyInfo.bundleNftId;
         // decision will likely depend on the decision what to check here and what in the service
-        NftId poolNftId = _instanceReader.getBundleInfo(bundleNftId).poolNftId;
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
 
         // ensure bundle is registered with this instance
         if (!_contains(poolNftId, bundleNftId)) {
@@ -78,7 +74,7 @@ contract BundleManager is
     /// @dev add a new bundle to a riskpool registerd with this instance
     // the corresponding pool is fetched via instance reader
     function add(NftId bundleNftId) external restricted() {
-        NftId poolNftId = _instanceReader.getBundleInfo(bundleNftId).poolNftId;
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
 
         // ensure pool is registered with instance
         if(poolNftId.eqz()) {
@@ -91,14 +87,14 @@ contract BundleManager is
 
     /// @dev unlocked (active) bundles are available to underwrite new policies
     function unlock(NftId bundleNftId) external restricted() {
-        NftId poolNftId = _instanceReader.getBundleInfo(bundleNftId).poolNftId;
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
         _activate(poolNftId, bundleNftId);
         emit LogBundleManagerBundleUnlocked(poolNftId, bundleNftId);
     }
 
     /// @dev locked (deactivated) bundles may not underwrite any new policies
     function lock(NftId bundleNftId) external restricted() {
-        NftId poolNftId = _instanceReader.getBundleInfo(bundleNftId).poolNftId;
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
         _deactivate(poolNftId, bundleNftId);
         emit LogBundleManagerBundleLocked(poolNftId, bundleNftId);
     }

package/contracts/instance/IInstance.sol

@@ -1,30 +1,43 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
+import {NftId} from "../types/NftId.sol";
+import {StateId} from "../types/StateId.sol";
+import {RiskId} from "../types/RiskId.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+
+import {InstanceAccessManager} from "./InstanceAccessManager.sol";
 import {BundleManager} from "./BundleManager.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 
-import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IBundle} from "./module/IBundle.sol";
+import {IBundleService} from "./service/IBundleService.sol";
 import {IDistributionService} from "./service/IDistributionService.sol";
+import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {IKeyValueStore} from "./base/IKeyValueStore.sol";
+import {IPolicy} from "./module/IPolicy.sol";
+import {IDistribution} from "./module/IDistribution.sol";
+import {IPolicyService} from "./service/IPolicyService.sol";
 import {IPoolService} from "./service/IPoolService.sol";
 import {IProductService} from "./service/IProductService.sol";
 import {IPolicyService} from "./service/IPolicyService.sol";
 import {IBundleService} from "./service/IBundleService.sol";
-import {IBundle} from "./module/IBundle.sol";
+import {IRisk} from "./module/IRisk.sol";
 import {ISetup} from "./module/ISetup.sol";
 import {NftId} from "../types/NftId.sol";
-import {StateId} from "../types/StateId.sol";
 import {RiskId} from "../types/RiskId.sol";
-import {IRisk} from "./module/IRisk.sol";
-import {IPolicy} from "./module/IPolicy.sol";
-import {IKeyValueStore} from "./base/IKeyValueStore.sol";
+import {StateId} from "../types/StateId.sol";
+import {VersionPart} from "../types/Version.sol";
+import {Key32} from "../types/Key32.sol";
+
 
 
-interface IInstance is IERC165, IKeyValueStore {
 
-    function getComponentOwnerService() external view returns (IComponentOwnerService);
+interface IInstance is IRegisterable, IKeyValueStore, IAccessManaged {
+
     function getDistributionService() external view returns (IDistributionService);
     function getProductService() external view returns (IProductService);
     function getPoolService() external view returns (IPoolService);
@@ -47,14 +60,33 @@ interface IInstance is IERC165, IKeyValueStore {
     function updateProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup, StateId newState) external;
     function updateProductSetupState(NftId productNftId, StateId newState) external;
 
+    function createDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info) external;
+    function updateDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info, StateId newState) external;
+    function updateDistributorTypeState(Key32 distributorKey, StateId newState) external;
+
+    function createDistributor(NftId nftId, IDistribution.DistributorInfo memory info) external;
+    function updateDistributor(NftId nftId, IDistribution.DistributorInfo memory info, StateId newState) external;
+    function updateDistributorState(NftId nftId, StateId newState) external;
+
+    function createReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo) external;
+    function updateReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo, StateId newState) external;
+    function updateReferralState(Key32 referralKey, StateId newState) external;
+
     function createRisk(RiskId riskId, IRisk.RiskInfo memory risk) external;
     function updateRisk(RiskId riskId, IRisk.RiskInfo memory risk, StateId newState) external;
     function updateRiskState(RiskId riskId, StateId newState) external;
 
-    function createPolicy(NftId policyNftId, IPolicy.PolicyInfo memory policy) external;
+    function createApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy) external;
+    function updateApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
+    function updateApplicationState(NftId applicationNftId, StateId newState) external;
+
     function updatePolicy(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
     function updatePolicyState(NftId policyNftId, StateId newState) external;
 
+    // TODO add claims/payouts function to instance
+    // function updateClaims(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
+
+    function getMajorVersion() external pure returns (VersionPart majorVersion);
     function getInstanceReader() external view returns (InstanceReader);
     function getBundleManager() external view returns (BundleManager);
 }

package/contracts/instance/IInstanceService.sol

@@ -8,7 +8,7 @@ import {IService} from "../shared/IService.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IBaseComponent} from "../components/IBaseComponent.sol";
+import {IComponent} from "../components/IComponent.sol";
 
 import {InstanceAccessManager} from "./InstanceAccessManager.sol";
 import {Instance} from "./Instance.sol";
@@ -17,8 +17,29 @@ import {BundleManager} from "./BundleManager.sol";
 
 interface IInstanceService is IService {
 
-    error ErrorInstanceServiceRequestUnauhorized(address caller);
+    error ErrorInstanceServiceMasterInstanceAlreadySet();
+    error ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet();
+    error ErrorInstanceServiceMasterBundleManagerAlreadySet();
+    error ErrorInstanceServiceInstanceAddressZero();
+
+    error ErrorInstanceServiceMasterInstanceReaderNotSet();
+    error ErrorInstanceServiceInstanceReaderAddressZero();
+    error ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch();
+
+    error ErrorInstanceServiceAccessManagerZero();
+    error ErrorInstanceServiceInstanceReaderZero();
+    error ErrorInstanceServiceBundleManagerZero();
+
+    error ErrorInstanceServiceInstanceAuthorityMismatch();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch2();
+    error ErrorInstanceServiceBundleMangerInstanceMismatch();
 
+    error ErrorInstanceServiceRequestUnauhorized(address caller);
+    error ErrorInstanceServiceNotInstanceOwner(address caller, NftId instanceNftId);
+    error ErrorInstanceServiceComponentNotRegistered(address componentAddress);
+    error ErrorInstanceServiceInvalidComponentType(address componentAddress, ObjectType expectedType, ObjectType componentType);
+    
     event LogInstanceCloned(address clonedAccessManagerAddress, address clonedInstanceAddress, address clonedInstanceReaderAddress, NftId clonedInstanceNftId);
 
     function createInstanceClone()
@@ -30,5 +51,9 @@ interface IInstanceService is IService {
             InstanceReader clonedInstanceReader,
             BundleManager clonedBundleManager
         );
+
+    function hasRole(address account, RoleId role, address instanceAddress) external returns (bool);
+    function setTargetLocked(string memory targetName, bool locked) external;
+
 }