@etherisc/gif-next 0.0.2-34d25ca → 0.0.2-35bac6a

package/contracts/instance/component/ComponentModule.sol

@@ -11,7 +11,7 @@ import {IProductComponent} from "../../components/IProduct.sol";
 import {IPoolModule} from "../pool/IPoolModule.sol";
 import {NftId, NftIdLib} from "../../types/NftId.sol";
 
-abstract contract ComponentModule is
+abstract contract ComponentModule is 
     IRegistryLinked,
     IAccessComponentTypeRoles,
     IAccessCheckRole,
@@ -29,10 +29,7 @@ abstract contract ComponentModule is
     IComponentOwnerService private _componentOwnerService;
 
     modifier onlyComponentOwnerService() {
-        require(
-            address(_componentOwnerService) == msg.sender,
-            "ERROR:CMP-001:NOT_OWNER_SERVICE"
-        );
+        require(address(_componentOwnerService) == msg.sender, "ERROR:CMP-001:NOT_OWNER_SERVICE");
         _;
     }
 
@@ -40,21 +37,25 @@ abstract contract ComponentModule is
         _componentOwnerService = ComponentOwnerService(componentOwnerService);
     }
 
-    function registerComponent(
-        IComponentContract component
-    ) external override onlyComponentOwnerService returns (NftId nftId) {
+    function registerComponent(IComponentContract component)
+        external
+        override
+        onlyComponentOwnerService
+        returns(NftId nftId)
+    {
         bytes32 typeRole = getRoleForType(component.getType());
         require(
             this.hasRole(typeRole, component.getInitialOwner()),
-            "ERROR:CMP-004:TYPE_ROLE_MISSING"
-        );
-
+            "ERROR:CMP-004:TYPE_ROLE_MISSING");
+        
         nftId = this.getRegistry().register(address(component));
 
-        _componentInfo[nftId] = ComponentInfo(nftId, CState.Active);
+        _componentInfo[nftId] = ComponentInfo(
+            nftId,
+            CState.Active);
 
         // special case product -> persist product - pool assignment
-        if (component.getType() == this.getRegistry().PRODUCT()) {
+        if(component.getType() == this.getRegistry().PRODUCT()) {
             IProductComponent product = IProductComponent(address(component));
             NftId poolNftId = product.getPoolNftId();
             require(poolNftId.gtz(), "ERROR:CMP-005:POOL_UNKNOWN");
@@ -63,7 +64,8 @@ abstract contract ComponentModule is
             _poolNftIdForProduct[nftId] = poolNftId;
 
             // add creation of productInfo
-        } else if (component.getType() == this.getRegistry().POOL()) {
+        }
+        else if(component.getType() == this.getRegistry().POOL()) {
             IPoolModule poolModule = IPoolModule(address(this));
             poolModule.createPoolInfo(
                 nftId,
@@ -78,79 +80,104 @@ abstract contract ComponentModule is
         // add logging
     }
 
-    function getPoolNftId(
-        NftId productNftId
-    ) external view override returns (NftId poolNftId) {
+    function getPoolNftId(NftId productNftId)
+        external
+        view
+        override
+        returns(NftId poolNftId)
+    {
         poolNftId = _poolNftIdForProduct[productNftId];
     }
 
+
     function getComponentOwnerService()
         external
-        view
         override
-        returns (IComponentOwnerService)
+        view
+        returns(IComponentOwnerService)
     {
         return _componentOwnerService;
     }
 
-    function setComponentInfo(
-        ComponentInfo memory info
-    ) external onlyComponentOwnerService returns (NftId nftId) {
+    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"
-        );
+            "ERROR:CMP-006:COMPONENT_UNKNOWN");
 
         _componentInfo[nftId] = info;
 
         // add logging
     }
 
-    function getComponentInfo(
-        NftId nftId
-    ) external view override returns (ComponentInfo memory) {
+    function getComponentInfo(NftId nftId)
+        external
+        override
+        view
+        returns(ComponentInfo memory)
+    {
         return _componentInfo[nftId];
     }
 
-    function getComponentOwner(
-        NftId nftId
-    ) external view returns (address owner) {}
+    function getComponentOwner(NftId nftId)
+        external
+        view
+        returns(address owner)
+    {
+
+    }
 
-    function getComponentId(
-        address componentAddress
-    ) external view returns (NftId componentNftId) {
+    function getComponentId(address componentAddress)
+        external
+        view
+        returns(NftId componentNftId)
+    {
         return _nftIdByAddress[componentAddress];
     }
 
-    function getComponentId(
-        uint256 idx
-    ) external view override returns (NftId componentNftId) {
+
+    function getComponentId(uint256 idx)
+        external
+        override
+        view
+        returns(NftId componentNftId)
+    {
         return _nftIds[idx];
     }
 
+
     function components()
         external
-        view
         override
-        returns (uint256 numberOfCompnents)
+        view
+        returns(uint256 numberOfCompnents)
     {
         return _nftIds.length;
     }
 
-    function getRoleForType(uint256 cType) public view returns (bytes32 role) {
-        if (cType == this.getRegistry().PRODUCT()) {
+    function getRoleForType(uint256 cType)
+        public
+        view
+        returns(bytes32 role)
+    {
+        if(cType == this.getRegistry().PRODUCT()) {
             return this.PRODUCT_OWNER_ROLE();
         }
-        if (cType == this.getRegistry().POOL()) {
+        if(cType == this.getRegistry().POOL()) {
             return this.POOL_OWNER_ROLE();
         }
-        if (cType == this.getRegistry().ORACLE()) {
+        if(cType == this.getRegistry().ORACLE()) {
             return this.ORACLE_OWNER_ROLE();
         }
+
     }
 }
 
+
 // this is actually the component owner service
 contract ComponentOwnerService is
     RegistryLinked,
@@ -161,7 +188,9 @@ contract ComponentOwnerService is
 
     modifier onlyComponentOwner(IComponentContract component) {
         NftId nftId = _registry.getNftId(address(component));
-        require(nftId.gtz(), "ERROR:COS-001:COMPONENT_UNKNOWN");
+        require(
+            nftId.gtz(), 
+            "ERROR:COS-001:COMPONENT_UNKNOWN");
         require(
             msg.sender == _registry.getOwner(nftId),
             "ERROR:COS-002:NOT_OWNER"
@@ -169,27 +198,31 @@ contract ComponentOwnerService is
         _;
     }
 
-    constructor(address registry) RegistryLinked(registry) {}
+    constructor(address registry)
+        RegistryLinked(registry)
+    { }
 
-    function register(
-        IComponentContract component
-    ) external override returns (NftId nftId) {
+    function register(IComponentContract component)
+        external
+        override
+        returns(NftId nftId)
+    {
         require(
-            msg.sender == component.getInitialOwner(),
-            "ERROR:COS-003:NOT_OWNER"
-        );
+            msg.sender == component.getInitialOwner(), 
+            "ERROR:COS-003:NOT_OWNER");
 
         IInstance instance = component.getInstance();
         nftId = instance.registerComponent(component);
     }
 
-    function lock(
-        IComponentContract component
-    ) external override onlyComponentOwner(component) {
+
+    function lock(IComponentContract component)
+        external
+        override
+        onlyComponentOwner(component)
+    {
         IInstance instance = component.getInstance();
-        ComponentInfo memory info = instance.getComponentInfo(
-            component.getNftId()
-        );
+        ComponentInfo memory info = instance.getComponentInfo(component.getNftId());
         require(info.nftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
         // TODO add state change validation
 
@@ -197,17 +230,19 @@ contract ComponentOwnerService is
         instance.setComponentInfo(info);
     }
 
-    function unlock(
-        IComponentContract component
-    ) external override onlyComponentOwner(component) {
+
+    function unlock(IComponentContract component)
+        external
+        override
+        onlyComponentOwner(component)
+    {
         IInstance instance = component.getInstance();
-        ComponentInfo memory info = instance.getComponentInfo(
-            component.getNftId()
-        );
+        ComponentInfo memory info = instance.getComponentInfo(component.getNftId());
         require(info.nftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
         // TODO state change validation
 
         info.state = CState.Active;
         instance.setComponentInfo(info);
     }
-}
+
+}

package/contracts/instance/component/IComponent.sol

@@ -1,11 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+
 import {IOwnable, IRegistryLinked, IRegisterable} from "../../registry/IRegistry.sol";
 import {IInstance} from "../IInstance.sol";
 import {NftId} from "../../types/NftId.sol";
 
 interface IComponent {
+
     // TODO decide if enum or uints with constants (as in IRegistry.PRODUCT())
     enum CState {
         Undefined,
@@ -20,54 +22,74 @@ interface IComponent {
     }
 }
 
+
 interface IInstanceLinked {
     // function setInstance(address instance) external;
-    function getInstance() external view returns (IInstance instance);
+    function getInstance() external view returns(IInstance instance);
 }
 
-interface IComponentContract is IRegisterable, IInstanceLinked, IComponent {}
 
-interface IComponentOwnerService is IRegistryLinked {
-    function register(
-        IComponentContract component
-    ) external returns (NftId nftId);
+interface IComponentContract is
+    IRegisterable,
+    IInstanceLinked,
+    IComponent
+{ }
 
-    function lock(IComponentContract component) external;
 
+interface IComponentOwnerService is IRegistryLinked{
+
+    function register(IComponentContract component) external returns(NftId nftId);
+    function lock(IComponentContract component) external;
     function unlock(IComponentContract component) external;
 }
 
-interface IComponentModule is IOwnable, IRegistryLinked, IComponent {
-    function registerComponent(
-        IComponentContract component
-    ) external returns (NftId nftId);
 
-    function setComponentInfo(
-        ComponentInfo memory info
-    ) external returns (NftId componentNftId);
+interface IComponentModule is
+    IOwnable,
+    IRegistryLinked,
+    IComponent
+{
 
-    function getComponentInfo(
-        NftId nftId
-    ) external view returns (ComponentInfo memory info);
+    function registerComponent(IComponentContract component)
+        external
+        returns(NftId nftId);
 
-    function getComponentOwner(
-        NftId nftId
-    ) external view returns (address owner);
+    function setComponentInfo(ComponentInfo memory info)
+        external
+        returns(NftId componentNftId);
 
-    function getComponentId(
-        address componentAddress
-    ) external view returns (NftId nftId);
+    function getComponentInfo(NftId nftId)
+        external
+        view
+        returns(ComponentInfo memory info);
 
-    function getComponentId(uint256 idx) external view returns (NftId nftId);
+    function getComponentOwner(NftId nftId)
+        external
+        view
+        returns(address owner);
 
-    function getPoolNftId(
-        NftId productNftId
-    ) external view returns (NftId poolNftId);
+    function getComponentId(address componentAddress)
+        external
+        view
+        returns(NftId nftId);
 
-    function components() external view returns (uint256 numberOfCompnents);
+    function getComponentId(uint256 idx)
+        external
+        view
+        returns(NftId nftId);
+
+    function getPoolNftId(NftId productNftId)
+        external
+        view
+        returns(NftId poolNftId);
+
+    function components()
+        external
+        view
+        returns(uint256 numberOfCompnents);
 
     function getComponentOwnerService()
         external
         view
-        returns (IComponentOwnerService);
-}
+        returns(IComponentOwnerService);
+}

package/contracts/instance/policy/IPolicy.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+
 import {IOwnable, IRegistryLinked, IRegisterable, IRegistry} from "../../registry/IRegistry.sol";
 import {IInstance} from "../IInstance.sol";
 import {IProductService} from "../product/IProductService.sol";
@@ -8,6 +9,7 @@ import {NftId} from "../../types/NftId.sol";
 
 // TODO check if there is value to introuce IContract and let IPolicy derive from IContract
 interface IPolicy {
+
     enum PolicyState {
         Undefined,
         Applied,
@@ -19,9 +21,11 @@ interface IPolicy {
     struct PolicyInfo {
         NftId nftId;
         PolicyState state; // applied, withdrawn, rejected, active, closed
+
         uint256 sumInsuredAmount;
         uint256 premiumAmount;
         uint256 lifetime; // activatedAt + lifetime >= expiredAt
+
         uint256 createdAt;
         uint256 activatedAt; // time of underwriting
         uint256 expiredAt; // no new claims
@@ -29,7 +33,12 @@ interface IPolicy {
     }
 }
 
-interface IPolicyModule is IOwnable, IRegistryLinked, IPolicy {
+interface IPolicyModule is
+    IOwnable,
+    IRegistryLinked,
+    IPolicy
+{
+
     function createApplication(
         IRegistry.RegistryInfo memory productInfo,
         address applicationOwner,
@@ -37,15 +46,21 @@ interface IPolicyModule is IOwnable, IRegistryLinked, IPolicy {
         uint256 premiumAmount,
         uint256 lifetime,
         NftId bundleNftId
-    ) external returns (NftId nftId);
+    )
+        external
+        returns(NftId nftId);
+
+    function activate(NftId nftId)
+        external;
 
-    function activate(NftId nftId) external;
+    function getBundleNftForPolicy(NftId nftId)
+        external
+        view
+        returns(NftId bundleNft);
 
-    function getBundleNftForPolicy(
-        NftId nftId
-    ) external view returns (NftId bundleNft);
+    function getPolicyInfo(NftId nftId)
+        external
+        view
+        returns(PolicyInfo memory info);
 
-    function getPolicyInfo(
-        NftId nftId
-    ) external view returns (PolicyInfo memory info);
 }

package/contracts/instance/policy/PolicyModule.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+
 // import {IOwnable, IRegistryLinked, IRegisterable} from "../../registry/IRegistry.sol";
 import {IRegistry, IRegistryLinked} from "../../registry/IRegistry.sol";
 
@@ -8,7 +9,10 @@ import {IProductService} from "../product/IProductService.sol";
 import {IPolicy, IPolicyModule} from "./IPolicy.sol";
 import {NftId, NftIdLib} from "../../types/NftId.sol";
 
-abstract contract PolicyModule is IRegistryLinked, IPolicyModule {
+abstract contract PolicyModule is
+    IRegistryLinked,
+    IPolicyModule
+{
     using NftIdLib for NftId;
 
     mapping(NftId nftId => PolicyInfo info) private _policyInfo;
@@ -18,10 +22,7 @@ abstract contract PolicyModule is IRegistryLinked, IPolicyModule {
 
     // TODO find a better place to avoid dupliation
     modifier onlyProductService2() {
-        require(
-            address(_productService) == msg.sender,
-            "ERROR:POL-001:NOT_PRODUCT_SERVICE"
-        );
+        require(address(_productService) == msg.sender, "ERROR:POL-001:NOT_PRODUCT_SERVICE");
         _;
     }
 
@@ -29,6 +30,7 @@ abstract contract PolicyModule is IRegistryLinked, IPolicyModule {
         _productService = IProductService(productService);
     }
 
+
     function createApplication(
         IRegistry.RegistryInfo memory productInfo,
         address applicationOwner,
@@ -36,20 +38,22 @@ abstract contract PolicyModule is IRegistryLinked, IPolicyModule {
         uint256 premiumAmount,
         uint256 lifetime,
         NftId bundleNftId
-    ) external override onlyProductService2 returns (NftId nftId) {
+    )
+        external
+        override
+        onlyProductService2
+        returns(NftId nftId)
+    {
         // TODO add parameter validation
-        if (bundleNftId.gtz()) {
-            IRegistry.RegistryInfo memory bundleInfo = this
-                .getRegistry()
-                .getInfo(bundleNftId);
+        if(bundleNftId.gtz()) {
+            IRegistry.RegistryInfo memory bundleInfo = this.getRegistry().getInfo(bundleNftId);
             // IRegistry.RegistryInfo memory poolInfo = this.getRegistry().getInfo(bundleInfo.parentNftId);
         }
 
         nftId = this.getRegistry().registerObjectForInstance(
             productInfo.nftId,
             this.getRegistry().POLICY(),
-            applicationOwner
-        );
+            applicationOwner);
 
         _policyInfo[nftId] = PolicyInfo(
             nftId,
@@ -68,7 +72,12 @@ abstract contract PolicyModule is IRegistryLinked, IPolicyModule {
         // add logging
     }
 
-    function activate(NftId nftId) external override onlyProductService2 {
+
+    function activate(NftId nftId)
+        external
+        override
+        onlyProductService2
+    {
         PolicyInfo storage info = _policyInfo[nftId];
         info.activatedAt = block.timestamp;
         info.expiredAt = block.timestamp + info.lifetime;
@@ -77,15 +86,22 @@ abstract contract PolicyModule is IRegistryLinked, IPolicyModule {
         // add logging
     }
 
-    function getBundleNftForPolicy(
-        NftId nftId
-    ) external view returns (NftId bundleNft) {
+
+
+    function getBundleNftForPolicy(NftId nftId)
+        external
+        view
+        returns(NftId bundleNft)
+    {
         return _bundleForPolicy[nftId];
     }
 
-    function getPolicyInfo(
-        NftId nftId
-    ) external view returns (PolicyInfo memory info) {
+
+    function getPolicyInfo(NftId nftId)
+        external
+        view
+        returns(PolicyInfo memory info)
+    {
         return _policyInfo[nftId];
     }
 }

package/contracts/instance/pool/IPoolModule.sol

@@ -5,6 +5,7 @@ import {IOwnable, IRegistry, IRegistryLinked} from "../../registry/IRegistry.sol
 import {NftId} from "../../types/NftId.sol";
 
 interface IPool {
+
     struct PoolInfo {
         NftId nftId;
         address wallet;
@@ -14,16 +15,27 @@ interface IPool {
     }
 }
 
-interface IPoolModule is IOwnable, IRegistryLinked, IPool {
-    function underwrite(NftId poolNftId, NftId policyNftId) external;
+interface IPoolModule is
+    IOwnable,
+    IRegistryLinked,
+    IPool
+{
+    
+    function underwrite(
+        NftId poolNftId,
+        NftId policyNftId
+    )
+        external;
 
     function createPoolInfo(
         NftId nftId,
         address wallet,
         address token
-    ) external;
+    )
+        external;
 
-    function getPoolInfo(
-        NftId nftId
-    ) external view returns (PoolInfo memory info);
-}
+    function getPoolInfo(NftId nftId)
+        external
+        view
+        returns(PoolInfo memory info);
+}