@etherisc/gif-next 0.0.2-dc7e4cb-141 → 0.0.2-de0a1d3-009

package/contracts/components/Product.sol

@@ -1,42 +1,138 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {IRisk} from "../instance/module/risk/IRisk.sol";
+import {ITreasury} from "../instance/module/treasury/ITreasury.sol";
 import {IProductService} from "../instance/service/IProductService.sol";
 import {IProductComponent} from "./IProductComponent.sol";
 import {NftId} from "../types/NftId.sol";
 import {ObjectType, PRODUCT} from "../types/ObjectType.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+import {RiskId, RiskIdLib} from "../types/RiskId.sol";
+import {StateId} from "../types/StateId.sol";
 import {Timestamp} from "../types/Timestamp.sol";
 import {Fee} from "../types/Fee.sol";
 import {BaseComponent} from "./BaseComponent.sol";
 
 contract Product is BaseComponent, IProductComponent {
-    IProductService private _productService;
-    address private _pool;
+    IProductService internal _productService;
+    address internal _pool;
+    address internal _distribution;
+    Fee internal _initialProductFee;
+    Fee internal _initialProcessingFee;
 
     constructor(
         address registry,
         NftId instanceNftid,
         address token,
-        address pool
+        address pool,
+        address distribution,
+        Fee memory productFee,
+        Fee memory processingFee
     ) BaseComponent(registry, instanceNftid, token) {
         // TODO add validation
         _productService = _instance.getProductService();
         _pool = pool;
+        _distribution = distribution;
+        _initialProductFee = productFee;
+        _initialProcessingFee = processingFee;        
+    }
+
+
+    function calculatePremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData,
+        ReferralId referralId,
+        NftId bundleNftId
+    )
+        external 
+        view 
+        override 
+        returns (uint256 premiumAmount)
+    {
+        (premiumAmount,,,,) = _productService.calculatePremium(
+            riskId,
+            sumInsuredAmount,
+            lifetime,
+            applicationData,
+            bundleNftId,
+            referralId
+        );
+    }
+
+
+    function calculateNetPremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData
+    )
+        external
+        view
+        virtual override
+        returns (uint256 netPremiumAmount)
+    {
+        // default 10% of sum insured
+        return sumInsuredAmount / 10;
+    }
+
+    function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
+        return RiskIdLib.toRiskId(riskName);
+    }
+
+    function _createRisk(
+        RiskId id,
+        bytes memory data
+    ) internal {
+        _productService.createRisk(
+            id,
+            data
+        );
+    }
+
+    function _setRiskInfo(
+        RiskId id,
+        IRisk.RiskInfo memory info
+    ) internal {
+        _productService.setRiskInfo(
+            id,
+            info
+        );
+    }
+
+    function _updateRiskState(
+        RiskId id,
+        StateId state
+    ) internal {
+        _productService.updateRiskState(
+            id,
+            state
+        );
+    }
+
+    function _getRiskInfo(RiskId id) internal view returns (IRisk.RiskInfo memory info) {
+        return _instance.getRiskInfo(id);
     }
 
     function _createApplication(
         address applicationOwner,
+        RiskId riskId,
         uint256 sumInsuredAmount,
-        uint256 premiumAmount,
         uint256 lifetime,
-        NftId bundleNftId
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
     ) internal returns (NftId nftId) {
         nftId = _productService.createApplication(
             applicationOwner,
+            riskId,
             sumInsuredAmount,
-            premiumAmount,
             lifetime,
-            bundleNftId
+            applicationData,
+            bundleNftId,
+            referralId
         );
     }
 
@@ -79,26 +175,35 @@ contract Product is BaseComponent, IProductComponent {
         return _registry.getNftId(_pool);
     }
 
+    function getDistributionNftId() external view override returns (NftId distributionNftId) {
+        return _registry.getNftId(_distribution);
+    }
+
     // from product component
     function setFees(
-        Fee memory policyFee,
+        Fee memory productFee,
         Fee memory processingFee
     )
         external
         onlyOwner
         override
     {
-        _productService.setFees(policyFee, processingFee);
+        _productService.setFees(productFee, processingFee);
     }
 
 
-    function getPolicyFee()
+    function getProductFee()
         external
         view
         override
-        returns (Fee memory policyFee)
+        returns (Fee memory productFee)
     {
-        return _instance.getProductSetup(getNftId()).policyFee;
+        NftId productNftId = getNftId();
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).productFee;
+        } else {
+            return _initialProductFee;
+        }
     }
 
     function getProcessingFee()
@@ -107,7 +212,12 @@ contract Product is BaseComponent, IProductComponent {
         override
         returns (Fee memory processingFee)
     {
-        return _instance.getProductSetup(getNftId()).processingFee;
+        NftId productNftId = getNftId();
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).processingFee;
+        } else {
+            return _initialProcessingFee;
+        }
     }
 
     // from registerable

package/contracts/instance/IInstance.sol

@@ -3,7 +3,6 @@ pragma solidity ^0.8.19;
 
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
-
 import {IVersionable} from "../shared/IVersionable.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IOwnable} from "../shared/IOwnable.sol";
@@ -11,21 +10,21 @@ import {RoleId} from "../types/RoleId.sol";
 
 import {IAccessModule} from "./module/access/IAccess.sol";
 import {IBundleModule} from "./module/bundle/IBundle.sol";
-import {ICompensationModule} from "./module/compensation/ICompensation.sol";
-import {ILifecycleModule} from "./module/lifecycle/ILifecycle.sol";
+import {IDistributionModule} from "./module/distribution/IDistribution.sol";
 import {IComponentModule} from "./module/component/IComponent.sol";
 import {IPolicyModule} from "./module/policy/IPolicy.sol";
 import {IPoolModule} from "./module/pool/IPoolModule.sol";
 import {IRiskModule} from "./module/risk/IRisk.sol";
 import {ITreasuryModule} from "./module/treasury/ITreasury.sol";
 
+import {IKeyValueStore} from "./base/IKeyValueStore.sol";
 import {IRegistry, IRegistryLinked} from "../registry/IRegistryLinked.sol";
-import {IServiceLinked} from "./IServiceLinked.sol";
 
 import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IDistributionService} from "./service/IDistributionService.sol";
 import {IProductService} from "./service/IProductService.sol";
 import {IPoolService} from "./service/IPoolService.sol";
-
+import {IInstanceBase} from "./base/IInstanceBase.sol";
 
 // solhint-disable-next-line no-empty-blocks
 interface IInstance is
@@ -33,21 +32,22 @@ interface IInstance is
     IVersionable,
     IRegisterable,
     IAccessModule,
-    ILifecycleModule,
     IPolicyModule,
     IPoolModule,
+    IRiskModule,
     IBundleModule,
     IComponentModule,
     ITreasuryModule,
-    ICompensationModule,
-    IServiceLinked
+    IDistributionModule,
+    IInstanceBase
 {
-    function getRegistry() external view override (IBundleModule, IComponentModule, IPolicyModule, IRegisterable) returns (IRegistry registry);
-    function hasRole(RoleId role, address member) external view override (IAccessModule, IComponentModule) returns (bool hasRole);    
+    function getRegistry() external view override (IPolicyModule, IRegisterable) returns (IRegistry registry);
+    function getOwner() external view override (IOwnable, IAccessModule) returns(address owner);
 
-    function getComponentOwnerService() external view override (IServiceLinked, IComponentModule) returns(IComponentOwnerService);
-    function getProductService() external view override (IServiceLinked, IBundleModule, IPolicyModule) returns(IProductService);
-    function getPoolService() external view override (IServiceLinked, IBundleModule, IPoolModule) returns(IPoolService);
+    function getKeyValueStore() external view override (IInstanceBase) returns (IKeyValueStore keyValueStore);
+    function getComponentOwnerService() external view override (IInstanceBase, IComponentModule) returns(IComponentOwnerService);
+    function getDistributionService() external view override returns(IDistributionService);
+    function getProductService() external view override (IInstanceBase, IBundleModule, IPolicyModule) returns(IProductService);
+    function getPoolService() external view override (IInstanceBase, IBundleModule, IPoolModule) returns(IPoolService);
 
-    function getOwner() external view override (IOwnable, IAccessModule) returns(address owner);
 }

package/contracts/instance/Instance.sol

@@ -4,11 +4,10 @@ pragma solidity ^0.8.19;
 import {NftId} from "../types/NftId.sol";
 import {RoleId} from "../types/RoleId.sol";
 
-import {InstanceBase} from "./InstanceBase.sol";
+import {InstanceBase} from "./base/InstanceBase.sol";
 import {AccessModule} from "./module/access/Access.sol";
-import {CompensationModule} from "./module/compensation/CompensationModule.sol";
-import {LifecycleModule} from "./module/lifecycle/LifecycleModule.sol";
 import {ComponentModule} from "./module/component/ComponentModule.sol";
+import {DistributionModule} from "./module/distribution/DistributionModule.sol";
 import {PolicyModule} from "./module/policy/PolicyModule.sol";
 import {PoolModule} from "./module/pool/PoolModule.sol";
 import {RiskModule} from "./module/risk/RiskModule.sol";
@@ -22,19 +21,21 @@ import {IBundleModule} from "./module/bundle/IBundle.sol";
 import {IComponentModule} from "./module/component/IComponent.sol";
 import {IPoolModule} from "./module/pool/IPoolModule.sol";
 import {IPolicyModule} from "./module/policy/IPolicy.sol";
-import {IServiceLinked} from "./IServiceLinked.sol";
+import {IInstanceBase} from "./base/IInstanceBase.sol";
 
 import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IDistributionService} from "./service/IDistributionService.sol";
 import {IProductService} from "./service/IProductService.sol";
 import {IPoolService} from "./service/IPoolService.sol";
 
+import {IKeyValueStore} from "./base/IKeyValueStore.sol";
+
 contract Instance is
     InstanceBase,
     AccessModule,
     BundleModule,
     ComponentModule,
-    CompensationModule,
-    LifecycleModule,
+    DistributionModule,
     PolicyModule,
     PoolModule,
     RiskModule,
@@ -47,20 +48,27 @@ contract Instance is
         InstanceBase(registry, registryNftId)
         AccessModule()
         BundleModule()
+        DistributionModule()
         ComponentModule()
         PolicyModule()
         PoolModule()
         TreasuryModule()
     {
+        initializeBundleModule(_keyValueStore);
+        initializeComponentModule(_keyValueStore);
+        initializeDistributionModule(_keyValueStore);
+        initializePolicyModule(_keyValueStore);
+        initializePoolModule(_keyValueStore);
+        initializeRiskModule(_keyValueStore);
     }
 
-    function getRegistry() public view override (Registerable, IBundleModule, IComponentModule, IPolicyModule) returns (IRegistry registry) { return super.getRegistry(); }
-
-    function hasRole(RoleId role, address member) public view override (AccessModule, IComponentModule) returns (bool) { return super.hasRole(role, member); }
+    function getRegistry() public view override (Registerable, IPolicyModule) returns (IRegistry registry) { return super.getRegistry(); }
+    function getKeyValueStore() public view override (InstanceBase) returns (IKeyValueStore keyValueStore) { return super.getKeyValueStore(); }
 
-    function getComponentOwnerService() external view override (IComponentModule, IServiceLinked) returns(IComponentOwnerService service) { return _componentOwnerService; }
-    function getProductService() external view override (IBundleModule, IPolicyModule, IServiceLinked) returns(IProductService service) { return _productService; }
-    function getPoolService() external view override (IBundleModule, IPoolModule, IServiceLinked) returns(IPoolService service) { return _poolService; }
+    function getComponentOwnerService() external view override (IComponentModule, IInstanceBase) returns(IComponentOwnerService service) { return _componentOwnerService; }
+    function getDistributionService() external view override (IInstanceBase) returns(IDistributionService service) { return _distributionService; }
+    function getProductService() external view override (IBundleModule, IPolicyModule, IInstanceBase) returns(IProductService service) { return _productService; }
+    function getPoolService() external view override (IBundleModule, IPoolModule, IInstanceBase) returns(IPoolService service) { return _poolService; }
 
     function getOwner() public view override (IAccessModule, Registerable) returns(address owner) { return super.getOwner(); }
 }

package/contracts/instance/{service → base}/ComponentServiceBase.sol

@@ -15,6 +15,7 @@ abstract contract ComponentServiceBase is ServiceBase {
         NftId registryNftId
     )
         ServiceBase(registry, registryNftId)
+    // solhint-disable-next-line no-empty-blocks
     {
     }
 

package/contracts/instance/base/IInstanceBase.sol

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Key32} from "../../types/Key32.sol";
+import {StateId} from "../../types/StateId.sol";
+
+import {IKeyValueStore} from "./IKeyValueStore.sol";
+import {IComponentOwnerService} from "../service/IComponentOwnerService.sol";
+import {IDistributionService} from "../service/IDistributionService.sol";
+import {IProductService} from "../service/IProductService.sol";
+import {IPoolService} from "../service/IPoolService.sol";
+
+interface IInstanceBase {
+    function getKeyValueStore() external view returns (IKeyValueStore keyValueStore);
+    function updateState(Key32 key, StateId state) external;
+    function getState(Key32 key) external view returns (StateId state);
+
+    function getComponentOwnerService() external view returns(IComponentOwnerService service);
+    function getDistributionService() external view returns(IDistributionService);
+    function getProductService() external view returns(IProductService service);
+    function getPoolService() external view returns(IPoolService service);
+}

package/contracts/instance/base/IKeyValueStore.sol

@@ -0,0 +1,50 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../../types/Blocknumber.sol";
+import {Key32, KeyId} from "../../types/Key32.sol";
+import {NftId} from "../../types/NftId.sol";
+import {ObjectType} from "../../types/ObjectType.sol";
+import {StateId} from "../../types/StateId.sol";
+
+import {ILifecycle} from "./ILifecycle.sol";
+
+interface IKeyValueStore is ILifecycle {
+
+    struct Key {
+        ObjectType objectType;
+        KeyId id;
+    }
+
+    struct Value {
+        Metadata metadata;
+        bytes data;
+    }
+
+    struct Metadata {
+        ObjectType objectType;
+        StateId state;
+        address updatedBy;
+        Blocknumber updatedIn;
+        Blocknumber createdIn;
+    }
+
+    event LogInfoCreated(Key key, StateId state, address createdBy, address txOrigin);
+    event LogInfoUpdated(Key key, StateId state, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
+    event LogStateUpdated(Key key, StateId stateOld, StateId stateNew, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
+
+    // generic state changing functions
+    function create(Key32 key, ObjectType objectType, bytes memory data) external;
+    function update(Key32 key, StateId state, bytes memory data) external;
+    function updateData(Key32 key, bytes memory data) external;
+    function updateState(Key32 key, StateId state) external;
+
+    function exists(Key32 key) external view returns (bool);
+    function get(Key32 key) external view returns (Value memory value);
+    function getData(Key32 key) external view returns (bytes memory data);
+    function getMetadata(Key32 key) external view returns (Metadata memory metadata);
+    function getState(Key32 key) external view returns (StateId state);
+
+    function toKey32(ObjectType objectType, KeyId id) external pure returns(Key32);
+    function toKey(Key32 key32) external pure returns(Key memory key);
+}

package/contracts/instance/base/ILifecycle.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ObjectType} from "../../types/ObjectType.sol";
+import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
+import {NftId} from "../../types/NftId.sol";
+
+interface ILifecycle {
+
+    error ErrorNoLifecycle(NftId nftId, ObjectType objectType);
+    error ErrorInvalidStateTransition(
+        ObjectType objectType,
+        StateId fromStateId,
+        StateId toStateId
+    );
+
+    function hasLifecycle(
+        ObjectType objectType
+    ) external view returns (bool);
+
+    function getInitialState(
+        ObjectType objectType
+    ) external view returns (StateId);
+
+    function isValidTransition(
+        ObjectType objectType,
+        StateId fromId,
+        StateId toId
+    ) external view returns (bool);
+}

package/contracts/instance/{InstanceBase.sol → base/InstanceBase.sol}

@@ -1,28 +1,35 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {Versionable} from "../shared/Versionable.sol";
-import {Registerable} from "../shared/Registerable.sol";
-// import {IRegistry} from "../registry/IRegistry.sol";
+import {Versionable} from "../../shared/Versionable.sol";
+import {Registerable} from "../../shared/Registerable.sol";
 
-// import {IInstance} from "./IInstance.sol";
-import {ObjectType, INSTANCE} from "../types/ObjectType.sol";
-import {NftId} from "../types/NftId.sol";
-import {Version, VersionPart, VersionLib} from "../types/Version.sol";
+import {ObjectType, INSTANCE} from "../../types/ObjectType.sol";
+import {Key32} from "../../types/Key32.sol";
+import {NftId} from "../../types/NftId.sol";
+import {StateId} from "../../types/StateId.sol";
+import {Version, VersionPart, VersionLib} from "../../types/Version.sol";
 
-import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
-import {IProductService} from "./service/IProductService.sol";
-import {IPoolService} from "./service/IPoolService.sol";
+import {IComponentOwnerService} from "../service/IComponentOwnerService.sol";
+import {IDistributionService} from "../service/IDistributionService.sol";
+import {IProductService} from "../service/IProductService.sol";
+import {IPoolService} from "../service/IPoolService.sol";
 
-import {IServiceLinked} from "./IServiceLinked.sol";
-import {IInstance} from "./IInstance.sol";
+import {IKeyValueStore} from "./IKeyValueStore.sol";
+import {IInstance} from "../IInstance.sol";
+import {IInstanceBase} from "./IInstanceBase.sol";
+
+import {KeyValueStore} from "./KeyValueStore.sol";
 
 abstract contract InstanceBase is
     Versionable,
     Registerable,
-    IServiceLinked
+    IInstanceBase
 {
+    IKeyValueStore internal _keyValueStore;
+
     IComponentOwnerService internal _componentOwnerService;
+    IDistributionService internal _distributionService;
     IProductService internal _productService;
     IPoolService internal _poolService;
 
@@ -33,10 +40,22 @@ abstract contract InstanceBase is
         Registerable(registry, registryNftId)
         Versionable()
     {
+        _keyValueStore = new KeyValueStore();
+
         _registerInterface(type(IInstance).interfaceId);
         _linkToServicesInRegistry();
     }
 
+    function getKeyValueStore() public view virtual override returns (IKeyValueStore keyValueStore) { return _keyValueStore; }
+
+    function updateState(Key32 key, StateId state) external override {
+        _keyValueStore.updateState(key, state);
+    }
+
+    function getState(Key32 key) external view override returns (StateId state) {
+        return _keyValueStore.getState(key);
+    }
+
     // from versionable
     function getVersion()
         public 
@@ -57,6 +76,7 @@ abstract contract InstanceBase is
     function _linkToServicesInRegistry() internal {
         VersionPart majorVersion = getVersion().toMajorPart();
         _componentOwnerService = IComponentOwnerService(_getAndCheck("ComponentOwnerService", majorVersion));
+        _distributionService = IDistributionService(_getAndCheck("DistributionService", majorVersion));
         _productService = IProductService(_getAndCheck("ProductService", majorVersion));
         _poolService = IPoolService(_getAndCheck("PoolService", majorVersion));
     }