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

package/contracts/instance/module/component/ComponentModule.sol

@@ -2,31 +2,21 @@
 pragma solidity ^0.8.19;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
+import {IComponentModule} from "./IComponent.sol";
 
-import {IRegistry} from "../../../registry/IRegistry.sol";
-import {IInstance} from "../../IInstance.sol";
+import {NftId} from "../../../types/NftId.sol";
+import {ObjectType, COMPONENT} from "../../../types/ObjectType.sol";
+import {StateId} from "../../../types/StateId.sol";
+import {ModuleBase} from "../../base/ModuleBase.sol";
 
-import {LifecycleModule} from "../lifecycle/LifecycleModule.sol";
-import {IComponent, IComponentModule} from "./IComponent.sol";
-import {IComponentOwnerService} from "../../service/IComponentOwnerService.sol";
-import {ObjectType, PRODUCT, ORACLE, POOL} from "../../../types/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED} from "../../../types/StateId.sol";
-import {NftId, NftIdLib, zeroNftId} from "../../../types/NftId.sol";
-import {Fee} from "../../../types/Fee.sol";
-
-abstract contract ComponentModule is
+abstract contract ComponentModule is 
+    ModuleBase,
     IComponentModule
 {
-    using NftIdLib for NftId;
 
-    mapping(NftId nftId => ComponentInfo info) private _componentInfo;
     NftId[] private _nftIds;
 
-    mapping(ObjectType cType => bytes32 role) private _componentOwnerRole;
-
-    // TODO maybe move this to Instance contract as internal variable?
-    LifecycleModule private _lifecycleModule;
-
     modifier onlyComponentOwnerService() {
         require(
             msg.sender == address(this.getComponentOwnerService()),
@@ -35,49 +25,32 @@ abstract contract ComponentModule is
         _;
     }
 
-    constructor() {
-        address componentAddress = address(this);
-        _lifecycleModule = LifecycleModule(componentAddress);
+    function initializeComponentModule(IKeyValueStore keyValueStore) internal {
+        _initialize(keyValueStore);
     }
 
     function registerComponent(
         NftId nftId,
-        ObjectType objectType,
-        IERC20Metadata token
-    ) external override onlyComponentOwnerService {
-
-        // create component info
-        _componentInfo[nftId] = ComponentInfo(
-            nftId,
-            _lifecycleModule.getInitialState(objectType),
-            token
-        );
-
+        IERC20Metadata token,
+        address wallet
+    )
+        external
+        onlyComponentOwnerService
+        override
+    {
+        ComponentInfo memory info = ComponentInfo(token, wallet);
         _nftIds.push(nftId);
-
-        // TODO add logging
+        _create(COMPONENT(), nftId, abi.encode(info));
     }
 
-    function setComponentInfo(
-        ComponentInfo memory info
-    ) external onlyComponentOwnerService returns (NftId nftId) {
-        nftId = info.nftId;
-        require(
-            nftId.gtz() && _componentInfo[nftId].nftId.eq(nftId),
-            "ERROR:CMP-006:COMPONENT_UNKNOWN"
-        );
+    function getComponentToken(NftId nftId) external view override returns(IERC20Metadata token) {
+        ComponentInfo memory info = abi.decode(_getData(COMPONENT(), nftId), (ComponentInfo));
+        return info.token;
+    }
 
-        // TODO decide if state changes should have explicit functions and not
-        // just a generic setXYZInfo and implicit state transitions
-        // when in doubt go for the explicit approach ...
-        ObjectType objectType = this.getRegistry().getObjectInfo(nftId).objectType;
-        _lifecycleModule.checkAndLogTransition(
-            nftId,
-            objectType,
-            _componentInfo[nftId].state,
-            info.state
-        );
-        _componentInfo[nftId] = info;
+    function getComponentWallet(NftId nftId) external view override returns (address wallet) {
+        ComponentInfo memory info = abi.decode(_getData(COMPONENT(), nftId), (ComponentInfo));
+        return info.wallet;
     }
 
     function getComponentCount()
@@ -94,10 +67,4 @@ abstract contract ComponentModule is
     ) external view override returns (NftId componentNftId) {
         return _nftIds[idx];
     }
-
-    function getComponentInfo(
-        NftId nftId
-    ) external view override returns (ComponentInfo memory) {
-        return _componentInfo[nftId];
-    }
-}
+}

package/contracts/instance/module/component/IComponent.sol

@@ -2,52 +2,27 @@
 pragma solidity ^0.8.19;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IComponentOwnerService} from "../../service/IComponentOwnerService.sol";
 
-
-import {IRegistry} from "../../../registry/IRegistry.sol";
-import {IInstance} from "../../IInstance.sol";
 import {StateId} from "../../../types/StateId.sol";
 import {NftId} from "../../../types/NftId.sol";
-import {ObjectType} from "../../../types/ObjectType.sol";
-import {RoleId} from "../../../types/RoleId.sol";
-import {Fee} from "../../../types/Fee.sol";
-import {UFixed} from "../../../types/UFixed.sol";
-
-import {IComponentOwnerService} from "../../service/IComponentOwnerService.sol";
-// import {IComponentBase} from "../../../components/IComponentBase.sol";
 
 interface IComponent {
-    // component dynamic info (static info kept in registry)
     struct ComponentInfo {
-        NftId nftId;
-        StateId state;
         IERC20Metadata token;
+        address wallet;
     }
 }
 
 interface IComponentModule is IComponent {
-    function getRegistry() external view returns (IRegistry registry);
 
-    function registerComponent(
-        NftId nftId,
-        ObjectType objectType,
-        IERC20Metadata token
-    ) external;
-
-    function setComponentInfo(
-        ComponentInfo memory info
-    ) external returns (NftId componentNftId);
-
-    function getComponentInfo(
-        NftId nftId
-    ) external view returns (ComponentInfo memory info);
+    function registerComponent(NftId nftId, IERC20Metadata token, address wallet) external;
+    function getComponentToken(NftId nftId) external view returns (IERC20Metadata token);
+    function getComponentWallet(NftId nftId) external view returns (address wallet);
 
     function getComponentCount() external view returns (uint256 numberOfCompnents);
-
     function getComponentId(uint256 idx) external view returns (NftId nftId);
 
     // repeat service linked signaturea to avoid linearization issues
     function getComponentOwnerService() external view returns(IComponentOwnerService);
-
-    function hasRole(RoleId role, address member) external view returns (bool);
 }

package/contracts/instance/module/distribution/DistributionModule.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IDistributionModule} from "./IDistribution.sol";
+import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
+import {ModuleBase} from "../../base/ModuleBase.sol";
+
+contract DistributionModule is
+    ModuleBase,
+    IDistributionModule
+{
+
+    function initializeDistributionModule(IKeyValueStore keyValueStore) internal {
+        _initialize(keyValueStore);
+    }
+
+}

package/contracts/instance/module/distribution/IDistribution.sol

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+interface IDistribution {
+
+}
+
+interface IDistributionModule is IDistribution {
+    
+}

package/contracts/instance/module/policy/IPolicy.sol

@@ -5,42 +5,45 @@ import {IRegistry} from "../../../registry/IRegistry.sol";
 import {IInstance} from "../../IInstance.sol";
 import {IProductService} from "../../service/IProductService.sol";
 import {NftId} from "../../../types/NftId.sol";
+import {ReferralId} from "../../../types/ReferralId.sol";
+import {RiskId} from "../../../types/RiskId.sol";
 import {StateId} from "../../../types/StateId.sol";
 import {Timestamp} from "../../../types/Timestamp.sol";
-import {Blocknumber} from "../../../types/Blocknumber.sol";
 
 // TODO check if there is value to introuce IContract and let IPolicy derive from IContract
 interface IPolicy {
     struct PolicyInfo {
-        NftId nftId;
         NftId productNftId;
         NftId bundleNftId;
+        ReferralId referralId;
         address beneficiary;
-        StateId state; // applied, withdrawn, rejected, active, closed
+        RiskId riskId;
         uint256 sumInsuredAmount;
         uint256 premiumAmount;
         uint256 premiumPaidAmount;
         uint256 lifetime;
-        bytes data;
-        Timestamp createdAt;
+        bytes applicationData;
+        bytes policyData;
         Timestamp activatedAt; // time of underwriting
         Timestamp expiredAt; // no new claims (activatedAt + lifetime)
         Timestamp closedAt; // no locked capital
-        Blocknumber updatedIn; // write log entries in a way to support backtracking of all state changes
     }
 }
 
 interface IPolicyModule is IPolicy {
-    function createApplication(
-        NftId productNftId,
+    function createPolicyInfo(
         NftId policyNftId,
+        NftId productNftId,
+        ReferralId referralId,
+        RiskId riskId,
         uint256 sumInsuredAmount,
         uint256 premiumAmount,
         uint256 lifetime,
         NftId bundleNftId
     ) external;
 
-    function setPolicyInfo(PolicyInfo memory policyInfo) external;
+    function setPolicyInfo(NftId policyNftId, PolicyInfo memory info) external;
+    function updatePolicyState(NftId nftId, StateId state) external;
 
     // function underwrite(NftId nftId) external;
 

package/contracts/instance/module/policy/PolicyModule.sol

@@ -3,23 +3,22 @@ pragma solidity ^0.8.19;
 
 import {IRegistry} from "../../../registry/IRegistry.sol";
 
-import {LifecycleModule} from "../../module/lifecycle/LifecycleModule.sol";
 import {IProductService} from "../../service/IProductService.sol";
 import {IPolicy, IPolicyModule} from "./IPolicy.sol";
 import {ObjectType, POLICY} from "../../../types/ObjectType.sol";
-import {APPLIED, ACTIVE, UNDERWRITTEN} from "../../../types/StateId.sol";
 import {NftId, NftIdLib} from "../../../types/NftId.sol";
+import {ReferralId} from "../../../types/ReferralId.sol";
+import {RiskId} from "../../../types/RiskId.sol";
+import {StateId} from "../../../types/StateId.sol";
 import {Timestamp, blockTimestamp, zeroTimestamp} from "../../../types/Timestamp.sol";
-import {Blocknumber, blockNumber} from "../../../types/Blocknumber.sol";
 
-import {LifecycleModule} from "../../module/lifecycle/LifecycleModule.sol";
+import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
+import {ModuleBase} from "../../base/ModuleBase.sol";
 
-abstract contract PolicyModule is IPolicyModule {
-    using NftIdLib for NftId;
-
-    mapping(NftId nftId => PolicyInfo info) private _policyInfo;
-
-    LifecycleModule private _lifecycleModule;
+abstract contract PolicyModule is
+    ModuleBase,
+    IPolicyModule
+{
 
     // TODO find a better place to avoid dupliation
     modifier onlyProductService2() {
@@ -30,13 +29,15 @@ abstract contract PolicyModule is IPolicyModule {
         _;
     }
 
-    constructor() {
-        _lifecycleModule = LifecycleModule(address(this));
+    function initializePolicyModule(IKeyValueStore keyValueStore) internal {
+        _initialize(keyValueStore);
     }
 
-    function createApplication(
-        NftId productNftId,
+    function createPolicyInfo(
         NftId policyNftId,
+        NftId productNftId,
+        ReferralId referralId,
+        RiskId riskId,
         uint256 sumInsuredAmount,
         uint256 premiumAmount,
         uint256 lifetime,
@@ -46,39 +47,45 @@ abstract contract PolicyModule is IPolicyModule {
         onlyProductService2
         override
     {
-        _policyInfo[policyNftId] = PolicyInfo(
-            policyNftId,
+        PolicyInfo memory info = PolicyInfo(
             productNftId,
             bundleNftId,
+            referralId,
             address(0), // beneficiary = policy nft holder
-            _lifecycleModule.getInitialState(POLICY()),
+            riskId,
             sumInsuredAmount,
             premiumAmount,
             0, // premium paid amount
             lifetime, 
-            "", // data
-            blockTimestamp(), // createdAt
+            "", // applicationData
+            "", // policyData
             zeroTimestamp(), // activatedAt
             zeroTimestamp(), // expiredAt
-            zeroTimestamp(), // closedAt
-            blockNumber() // updatedIn
+            zeroTimestamp() // closedAt
         );
 
-        // TODO add logging
+        _create(POLICY(), policyNftId, abi.encode(info));
     }
 
-    function setPolicyInfo(PolicyInfo memory policyInfo)
+    function setPolicyInfo(NftId policyNftId, PolicyInfo memory info)
         external
         override
         onlyProductService2
     {
-        _policyInfo[policyInfo.nftId] = policyInfo;
+        _updateData(POLICY(), policyNftId, abi.encode(info));
+    }
+
+    function updatePolicyState(NftId bundleNftId, StateId state)
+        external
+        override
+        onlyProductService2
+    {
+        _updateState(POLICY(), bundleNftId, state);
     }
 
     function getPolicyInfo(
         NftId nftId
     ) external view returns (PolicyInfo memory info) {
-        return _policyInfo[nftId];
+        return abi.decode(_getData(POLICY(), nftId), (PolicyInfo));
     }
-
 }

package/contracts/instance/module/pool/IPoolModule.sol

@@ -9,7 +9,6 @@ import {IPoolService} from "../../service/IPoolService.sol";
 
 interface IPool {
     struct PoolInfo {
-        NftId nftId;
         bool isVerifying;
         UFixed collateralizationLevel;
     }

package/contracts/instance/module/pool/PoolModule.sol

@@ -8,18 +8,22 @@ import {IPolicy, IPolicyModule} from "../../module/policy/IPolicy.sol";
 import {ITreasuryModule} from "../../module/treasury/ITreasury.sol";
 
 import {NftId} from "../../../types/NftId.sol";
+import {POOL} from "../../../types/ObjectType.sol";
 import {LibNftIdSet} from "../../../types/NftIdSet.sol";
 import {StateId, APPLIED} from "../../../types/StateId.sol";
 import {UFixed} from "../../../types/UFixed.sol";
 
+import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
 import {IPoolModule} from "./IPoolModule.sol";
+import {ModuleBase} from "../../base/ModuleBase.sol";
 
 abstract contract PoolModule is
+    ModuleBase,
     IPoolModule
 {
     using LibNftIdSet for LibNftIdSet.Set;
 
-    mapping(NftId poolNftId => PoolInfo info) private _poolInfo;
+    // mapping(NftId poolNftId => PoolInfo info) private _poolInfo;
     mapping(NftId poolNftId => LibNftIdSet.Set bundles) private _bundlesForPool;
 
     modifier poolServiceCallingPool() {
@@ -30,6 +34,10 @@ abstract contract PoolModule is
         _;
     }
 
+    function initializePoolModule(IKeyValueStore keyValueStore) internal {
+        _initialize(keyValueStore);
+    }
+
     function registerPool(
         NftId nftId, 
         bool isVerifying,
@@ -38,17 +46,12 @@ abstract contract PoolModule is
         public
         override
     {
-        require(
-            _poolInfo[nftId].nftId.eqz(), 
-            "ERROR:PL-010:ALREADY_CREATED");
-
-        _poolInfo[nftId] = PoolInfo(
-            nftId,
+        PoolInfo memory info  = PoolInfo(
             isVerifying,
             collateralizationRate
         );
 
-        // TODO add logging
+        _create(POOL(), nftId, abi.encode(info));
     }
 
     function addBundleToPool(
@@ -71,7 +74,7 @@ abstract contract PoolModule is
     function getPoolInfo(
         NftId nftId
     ) external view override returns (PoolInfo memory info) {
-        info = _poolInfo[nftId];
+        return abi.decode(_getData(POOL(), nftId), (PoolInfo));
     }
 
 

package/contracts/instance/module/risk/IRisk.sol

@@ -1,10 +1,26 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-interface IRisk {
+import {NftId} from "../../../types/NftId.sol";
+import {RiskId} from "../../../types/RiskId.sol";
+import {StateId} from "../../../types/StateId.sol";
 
+interface IRisk {
+    struct RiskInfo {
+        NftId productNftId;
+        bytes data;
+    }
 }
 
 interface IRiskModule is IRisk {
-    
+    function createRisk(
+        RiskId riskId,
+        NftId productNftId,
+        bytes memory data
+    ) external;
+
+    function setRiskInfo(RiskId riskId, RiskInfo memory info) external;
+    function updateRiskState(RiskId riskId, StateId state) external;
+
+    function getRiskInfo(RiskId riskId) external view returns (RiskInfo memory info);
 }

package/contracts/instance/module/risk/RiskModule.sol

@@ -1,8 +1,62 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {NftId} from "../../../types/NftId.sol";
+import {RISK} from "../../../types/ObjectType.sol";
+import {RiskId} from "../../../types/RiskId.sol";
+import {StateId} from "../../../types/StateId.sol";
+
+import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
 import {IRiskModule} from "./IRisk.sol";
+import {ModuleBase} from "../../base/ModuleBase.sol";
+
+contract RiskModule is
+    ModuleBase,
+    IRiskModule
+{
+    function initializeRiskModule(IKeyValueStore keyValueStore) internal {
+        _initialize(keyValueStore);
+    }
+
+    function createRisk(
+        RiskId riskId,
+        NftId productNftId,
+        bytes memory data
+    ) external override {
+        RiskInfo memory info = RiskInfo(
+            productNftId,
+            data
+        );
+
+        _create(RISK(), riskId.toKey32(), abi.encode(info));
+    }
+
+    function setRiskInfo(
+        RiskId riskId, 
+        RiskInfo memory info
+    )
+        external
+        override
+    {
+
+    }
+
+    function updateRiskState(
+        RiskId riskId, 
+        StateId state
+    )
+        external
+        override
+    {
+
+    }
+
+    function getRiskInfo(RiskId riskId)
+        external
+        view
+        override
+        returns (RiskInfo memory info)
+    {
 
-contract RiskModule is IRiskModule {
-    
+    }
 }

package/contracts/instance/module/treasury/ITreasury.sol

@@ -2,6 +2,9 @@
 pragma solidity ^0.8.19;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IDistributionComponent} from "../../../components/IDistributionComponent.sol";
+import {IPoolComponent} from "../../../components/IPoolComponent.sol";
+import {IProductComponent} from "../../../components/IProductComponent.sol";
 
 import {NftId} from "../../../types/NftId.sol";
 import {UFixed} from "../../../types/UFixed.sol";
@@ -13,73 +16,49 @@ interface ITreasury {
     // TODO add events
     // TODO add errors
 
-    struct ProductSetup {
-        NftId productNftId;
-        NftId distributorNftId;
+    // treasury info is linked to product nft id
+    struct TreasuryInfo {
         NftId poolNftId;
+        NftId distributionNftId;
         IERC20Metadata token;
-        address wallet;
-        Fee policyFee;
-        Fee processingFee;
-    }
-
-    struct DistributorSetup {
-        NftId distributorNftId;
-        address wallet;
-        Fee commissionFee;
-    }
-
-    struct PoolSetup {
-        NftId poolNftId;
-        address wallet;
-        Fee stakingFee;
-        Fee performanceFee;
+        Fee productFee; // product fee on net premium
+        Fee processingFee; // product fee on payout amounts
+        Fee poolFee; // pool fee on net premium
+        Fee stakingFee; // pool fee on staked capital from investor
+        Fee performanceFee; // pool fee on profits from capital investors
+        Fee distributionFee; // default distribution fee (no referral id)
     }
 }
 
 interface ITreasuryModule is ITreasury {
 
-    function registerProduct(
-        NftId productNftId,
-        NftId distributorNftId,
-        NftId poolNftId,
-        IERC20Metadata token,
-        address wallet,
-        Fee memory policyFee,
-        Fee memory processingFee
+    function registerProductSetup(
+        IProductComponent product,
+        IPoolComponent pool,
+        IDistributionComponent distribution
     ) external;
 
-    function setProductFees(
+    function setTreasuryInfo(
         NftId productNftId,
-        Fee memory policyFee,
-        Fee memory processingFee
+        TreasuryInfo memory info
     ) external;
 
-    function registerPool(
-        NftId poolNftId,
-        address wallet,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
+    function hasTreasuryInfo(
+        NftId productNftId
+    ) external view returns (bool hasInfo);
 
-    function setPoolFees(
-        NftId poolNftId,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
+    function getTreasuryInfo(
+        NftId productNftId
+    ) external view returns (TreasuryInfo memory info);
+
+    function getProductNftId(
+        NftId componentNftId
+    ) external view returns (NftId productNftId);
 
     function getTokenHandler(
         NftId componentNftId
     ) external view returns (TokenHandler tokenHandler);
 
-    function getProductSetup(
-        NftId productNftId
-    ) external view returns (ProductSetup memory setup);
-
-    function getPoolSetup(
-        NftId poolNftId
-    ) external view returns (PoolSetup memory setup);
-
     function calculateFeeAmount(
         uint256 amount,
         Fee memory fee
@@ -90,7 +69,7 @@ interface ITreasuryModule is ITreasury {
         uint256 fixedFee
     ) external pure returns (Fee memory fee);
 
-    function getZeroFee() external pure returns (Fee memory fee);
+    function getZeroFee() external view returns (Fee memory fee);
 
     function getUFixed(
         uint256 a