@etherisc/gif-next 0.0.2-c4efd5e → 0.0.2-c630f3f-038

package/contracts/instance/lifecycle/LifecycleModule.sol

@@ -0,0 +1,88 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../../types/NftId.sol";
+import {ObjectType, PRODUCT, ORACLE, POOL, BUNDLE, POLICY} from "../../types/ObjectType.sol";
+import {StateId, ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, REVOKED, DECLINED} from "../../types/StateId.sol";
+import {ILifecycleModule} from "./ILifecycle.sol";
+
+contract LifecycleModule is ILifecycleModule {
+    mapping(ObjectType objectType => StateId initialState)
+        private _initialState;
+
+    mapping(ObjectType objectType => mapping(StateId stateFrom => mapping(StateId stateTo => bool isValid)))
+        private _isValidTransition;
+
+    constructor() {
+        _setupComponentLifecycle(PRODUCT());
+        _setupComponentLifecycle(ORACLE());
+        _setupComponentLifecycle(POOL());
+
+        _setupBundleLifecycle();
+        _setupPolicyLifecycle();
+    }
+
+    function checkAndLogTransition(
+        NftId nftId,
+        ObjectType objectType,
+        StateId fromId,
+        StateId toId
+    ) public returns (StateId) // add only currentcontract? would that work?
+    {
+        if (!_isValidTransition[objectType][fromId][toId]) {
+            revert ErrorInvalidStateTransition(nftId, objectType, fromId, toId);
+        }
+
+        if (objectType == POLICY()) {
+            emit LogPolicyStateChanged(nftId, fromId, toId);
+        } else if (objectType == BUNDLE()) {
+            emit LogBundleStateChanged(nftId, fromId, toId);
+        } else if (
+            objectType == PRODUCT() ||
+            objectType == ORACLE() ||
+            objectType == POOL()
+        ) {
+            emit LogComponentStateChanged(nftId, objectType, fromId, toId);
+        } else {
+            revert ErrorNoLifecycle(nftId, objectType);
+        }
+
+        return toId;
+    }
+
+    function getInitialState(
+        ObjectType objectType
+    ) public view returns (StateId) {
+        return _initialState[objectType];
+    }
+
+    function isValidTransition(
+        ObjectType objectType,
+        StateId fromId,
+        StateId toId
+    ) public view returns (bool) {
+        return _isValidTransition[objectType][fromId][toId];
+    }
+
+    function _setupComponentLifecycle(ObjectType objectType) internal {
+        _initialState[objectType] = ACTIVE();
+        _isValidTransition[objectType][ACTIVE()][PAUSED()] = true;
+        _isValidTransition[objectType][PAUSED()][ACTIVE()] = true;
+        _isValidTransition[objectType][PAUSED()][ARCHIVED()] = true;
+    }
+
+    function _setupBundleLifecycle() internal {
+        _initialState[BUNDLE()] = ACTIVE();
+        _isValidTransition[BUNDLE()][ACTIVE()][PAUSED()] = true;
+        _isValidTransition[BUNDLE()][PAUSED()][ACTIVE()] = true;
+        _isValidTransition[BUNDLE()][PAUSED()][CLOSED()] = true;
+    }
+
+    function _setupPolicyLifecycle() internal {
+        _initialState[POLICY()] = APPLIED();
+        _isValidTransition[POLICY()][APPLIED()][REVOKED()] = true;
+        _isValidTransition[POLICY()][APPLIED()][DECLINED()] = true;
+        _isValidTransition[POLICY()][APPLIED()][ACTIVE()] = true;
+        _isValidTransition[POLICY()][ACTIVE()][CLOSED()] = true;
+    }
+}

package/contracts/instance/policy/IPolicy.sol

@@ -5,24 +5,20 @@ import {IOwnable, IRegistryLinked, IRegisterable, IRegistry} from "../../registr
 import {IInstance} from "../IInstance.sol";
 import {IProductService} from "../product/IProductService.sol";
 import {NftId} from "../../types/NftId.sol";
+import {StateId} from "../../types/StateId.sol";
 
 // TODO check if there is value to introuce IContract and let IPolicy derive from IContract
 interface IPolicy {
-    enum PolicyState {
-        Undefined,
-        Applied,
-        Rejected,
-        Active,
-        Closed
-    }
-
     struct PolicyInfo {
         NftId nftId;
-        PolicyState state; // applied, withdrawn, rejected, active, closed
+        StateId state; // applied, withdrawn, rejected, active, closed
+        // TODO add beneficiary address
         uint256 sumInsuredAmount;
         uint256 premiumAmount;
+        uint256 premiumPaidAmount;
         uint256 lifetime; // activatedAt + lifetime >= expiredAt
         uint256 createdAt;
+        uint256 updatedAt;
         uint256 activatedAt; // time of underwriting
         uint256 expiredAt; // no new claims
         uint256 closedAt; // no locked capital
@@ -39,6 +35,9 @@ interface IPolicyModule is IOwnable, IRegistryLinked, IPolicy {
         NftId bundleNftId
     ) external returns (NftId nftId);
 
+    // process full premium
+    function processPremium(NftId nftId) external;
+
     function activate(NftId nftId) external;
 
     function getBundleNftForPolicy(

package/contracts/instance/policy/PolicyModule.sol

@@ -4,16 +4,22 @@ pragma solidity ^0.8.19;
 // import {IOwnable, IRegistryLinked, IRegisterable} from "../../registry/IRegistry.sol";
 import {IRegistry, IRegistryLinked} from "../../registry/IRegistry.sol";
 
+import {LifecycleModule} from "../lifecycle/LifecycleModule.sol";
 import {IProductService} from "../product/IProductService.sol";
 import {IPolicy, IPolicyModule} from "./IPolicy.sol";
+import {ObjectType, POLICY} from "../../types/ObjectType.sol";
+import {ACTIVE} from "../../types/StateId.sol";
 import {NftId, NftIdLib} from "../../types/NftId.sol";
 
+import {LifecycleModule} from "../lifecycle/LifecycleModule.sol";
+
 abstract contract PolicyModule is IRegistryLinked, IPolicyModule {
     using NftIdLib for NftId;
 
     mapping(NftId nftId => PolicyInfo info) private _policyInfo;
     mapping(NftId nftId => NftId bundleNftId) private _bundleForPolicy;
 
+    LifecycleModule private _lifecycleModule;
     IProductService private _productService;
 
     // TODO find a better place to avoid dupliation
@@ -26,6 +32,7 @@ abstract contract PolicyModule is IRegistryLinked, IPolicyModule {
     }
 
     constructor(address productService) {
+        _lifecycleModule = LifecycleModule(address(this));
         _productService = IProductService(productService);
     }
 
@@ -39,25 +46,29 @@ abstract contract PolicyModule is IRegistryLinked, IPolicyModule {
     ) external override onlyProductService2 returns (NftId nftId) {
         // TODO add parameter validation
         if (bundleNftId.gtz()) {
-            IRegistry.RegistryInfo memory bundleInfo = this
-                .getRegistry()
-                .getInfo(bundleNftId);
+            // 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(),
+            POLICY(),
             applicationOwner
         );
 
         _policyInfo[nftId] = PolicyInfo(
             nftId,
-            PolicyState.Applied,
+            _lifecycleModule.getInitialState(POLICY()),
             sumInsuredAmount,
             premiumAmount,
+            0, // premium paid amount
             lifetime,
-            block.timestamp,
+            // solhint-disable-next-line not-rely-on-time
+            block.timestamp, // createdAt
+            // solhint-disable-next-line not-rely-on-time
+            block.timestamp, // updatedAt
             0, // activatedAt
             0, // expiredAt
             0 // closedAt
@@ -68,13 +79,25 @@ abstract contract PolicyModule is IRegistryLinked, IPolicyModule {
         // add logging
     }
 
+    function processPremium(NftId nftId) external override onlyProductService2 {
+        PolicyInfo storage info = _policyInfo[nftId];
+        info.premiumPaidAmount = info.premiumAmount;
+        // solhint-disable-next-line not-rely-on-time
+        info.updatedAt = block.timestamp;
+    }
+
     function activate(NftId nftId) external override onlyProductService2 {
         PolicyInfo storage info = _policyInfo[nftId];
+        // solhint-disable-next-line not-rely-on-time
         info.activatedAt = block.timestamp;
+        // solhint-disable-next-line not-rely-on-time
         info.expiredAt = block.timestamp + info.lifetime;
-        info.state = PolicyState.Active;
-
-        // add logging
+        info.state = _lifecycleModule.checkAndLogTransition(
+            nftId,
+            POLICY(),
+            info.state,
+            ACTIVE()
+        );
     }
 
     function getBundleNftForPolicy(

package/contracts/instance/pool/IPoolModule.sol

@@ -7,21 +7,15 @@ import {NftId} from "../../types/NftId.sol";
 interface IPool {
     struct PoolInfo {
         NftId nftId;
-        address wallet;
-        address token;
         uint256 capital;
         uint256 lockedCapital;
     }
 }
 
 interface IPoolModule is IOwnable, IRegistryLinked, IPool {
-    function underwrite(NftId poolNftId, NftId policyNftId) external;
+    function underwrite(NftId policyNftId, NftId productNftId) external;
 
-    function createPoolInfo(
-        NftId nftId,
-        address wallet,
-        address token
-    ) external;
+    function registerPool(NftId nftId) external;
 
     function getPoolInfo(
         NftId nftId

package/contracts/instance/pool/PoolModule.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.19;
 import {IOwnable, IRegistry, IRegistryLinked} from "../../registry/IRegistry.sol";
 import {IProductService} from "../product/IProductService.sol";
 import {IPolicy, IPolicyModule} from "../policy/IPolicy.sol";
+import {ITreasuryModule} from "../treasury/ITreasury.sol";
 import {IPoolModule} from "./IPoolModule.sol";
 import {NftId, NftIdLib} from "../../types/NftId.sol";
 
@@ -11,9 +12,12 @@ abstract contract PoolModule is IPoolModule {
     using NftIdLib for NftId;
 
     uint256 public constant INITIAL_CAPITAL = 10000 * 10 ** 6;
+    uint256 public constant INITIAL_LOCKED_CAPITAL = 0;
 
     mapping(NftId nftId => PoolInfo info) private _poolInfo;
 
+    IPolicyModule private _policyModule;
+    ITreasuryModule private _treasuryModule;
     IProductService private _productService;
 
     modifier onlyProductService() {
@@ -25,41 +29,45 @@ abstract contract PoolModule is IPoolModule {
     }
 
     constructor(address productService) {
+        _policyModule = IPolicyModule(address(this));
+        _treasuryModule = ITreasuryModule(address(this));
         _productService = IProductService(productService);
     }
 
-    function createPoolInfo(
-        NftId nftId,
-        address wallet,
-        address token
-    ) public override {
+    function registerPool(NftId nftId) public override {
         require(_poolInfo[nftId].nftId.eqz(), "ERROR:PL-001:ALREADY_CREATED");
 
         _poolInfo[nftId] = PoolInfo(
             nftId,
-            wallet,
-            token,
             INITIAL_CAPITAL,
-            0 // locked capital
+            INITIAL_LOCKED_CAPITAL
         );
     }
 
     function underwrite(
-        NftId poolNftId,
-        NftId policyNftId
+        NftId policyNftId,
+        NftId productNftId
     ) external override onlyProductService {
-        PoolInfo storage poolInfo = _poolInfo[poolNftId];
-        require(poolInfo.nftId == poolNftId, "ERROR:PL-002:POOL_UNKNOWN");
-
-        IPolicyModule policyModule = IPolicyModule(address(this));
-        IPolicy.PolicyInfo memory policyInfo = policyModule.getPolicyInfo(
+        IPolicy.PolicyInfo memory policyInfo = _policyModule.getPolicyInfo(
             policyNftId
         );
+        require(policyInfo.nftId == policyNftId, "ERROR:PL-002:POLICY_UNKNOWN");
+
+        ITreasuryModule.ProductSetup memory product = _treasuryModule
+            .getProductSetup(productNftId);
+        require(
+            product.productNftId == productNftId,
+            "ERROR:PL-003:PRODUCT_SETUP_MISSING"
+        );
+
+        NftId poolNftId = product.poolNftId;
+        PoolInfo storage poolInfo = _poolInfo[poolNftId];
+        require(poolInfo.nftId == poolNftId, "ERROR:PL-004:POOL_UNKNOWN");
 
         require(
             poolInfo.capital - poolInfo.lockedCapital >=
                 policyInfo.sumInsuredAmount,
-            "ERROR:PL-003:CAPACITY_TOO_LOW"
+            "ERROR:PL-005:CAPACITY_TOO_LOW"
         );
 
         poolInfo.lockedCapital += policyInfo.sumInsuredAmount;

package/contracts/instance/product/IProductService.sol

@@ -23,7 +23,7 @@ interface IProductService is IRegistryLinked {
     // function expire(uint256 nftId) external;
     function close(NftId nftId) external;
 
-    // function collectPremium(uint256 nftId, uint256 premiumAmount) external;
+    function collectPremium(NftId nftId) external;
 
     // function createClaim(uint256 nftId, uint256 claimAmount) external;
     // function confirmClaim(uint256 nftId, uint256 claimId, uint256 claimAmount) external;

package/contracts/instance/product/ProductService.sol

@@ -8,15 +8,21 @@ import {IRegistry} from "../../registry/IRegistry.sol";
 import {IPolicyModule} from "../policy/IPolicy.sol";
 import {RegistryLinked} from "../../registry/Registry.sol";
 import {IProductService, IProductModule} from "./IProductService.sol";
-import {IComponentModule} from "../../instance/component/IComponent.sol";
+import {ITreasuryModule} from "../../instance/treasury/ITreasury.sol";
 import {IPoolModule} from "../../instance/pool/IPoolModule.sol";
+import {ObjectType, INSTANCE, PRODUCT} from "../../types/ObjectType.sol";
 import {NftId, NftIdLib} from "../../types/NftId.sol";
 
 // TODO or name this ProtectionService to have Product be something more generic (loan, savings account, ...)
 contract ProductService is RegistryLinked, IProductService {
     using NftIdLib for NftId;
 
-    constructor(address registry) RegistryLinked(registry) {}
+    constructor(
+        address registry
+    ) RegistryLinked(registry) // solhint-disable-next-line no-empty-blocks
+    {
+
+    }
 
     function createApplication(
         address applicationOwner,
@@ -31,19 +37,13 @@ contract ProductService is RegistryLinked, IProductService {
         IRegistry.RegistryInfo memory productInfo = _registry.getInfo(
             productNftId
         );
-        require(
-            productInfo.objectType == _registry.PRODUCT(),
-            "ERROR_NOT_PRODUCT"
-        );
+        require(productInfo.objectType == PRODUCT(), "ERROR_NOT_PRODUCT");
 
         IRegistry.RegistryInfo memory instanceInfo = _registry.getInfo(
             productInfo.parentNftId
         );
         require(instanceInfo.nftId.gtz(), "ERROR_INSTANCE_UNKNOWN");
-        require(
-            instanceInfo.objectType == _registry.INSTANCE(),
-            "ERROR_NOT_INSTANCE"
-        );
+        require(instanceInfo.objectType == INSTANCE(), "ERROR_NOT_INSTANCE");
 
         IPolicyModule policyModule = IPolicyModule(instanceInfo.objectAddress);
         nftId = policyModule.createApplication(
@@ -58,45 +58,69 @@ contract ProductService is RegistryLinked, IProductService {
         // add logging
     }
 
-    function underwrite(NftId nftId) external override {
+    function underwrite(NftId policyNftId) external override {
+        // validation
         // same as only registered product
         NftId productNftId = _registry.getNftId(msg.sender);
         require(productNftId.gtz(), "ERROR_PRODUCT_UNKNOWN");
         IRegistry.RegistryInfo memory productInfo = _registry.getInfo(
             productNftId
         );
-        require(
-            productInfo.objectType == _registry.PRODUCT(),
-            "ERROR_NOT_PRODUCT"
-        );
+        require(productInfo.objectType == PRODUCT(), "ERROR_NOT_PRODUCT");
 
         IRegistry.RegistryInfo memory instanceInfo = _registry.getInfo(
             productInfo.parentNftId
         );
         require(instanceInfo.nftId.gtz(), "ERROR_INSTANCE_UNKNOWN");
-        require(
-            instanceInfo.objectType == _registry.INSTANCE(),
-            "ERROR_NOT_INSTANCE"
+        require(instanceInfo.objectType == INSTANCE(), "ERROR_NOT_INSTANCE");
+
+        // underwrite policy
+        address instanceAddress = instanceInfo.objectAddress;
+        IPoolModule poolModule = IPoolModule(instanceAddress);
+        poolModule.underwrite(policyNftId, productNftId);
+
+        // activate policy
+        IPolicyModule policyModule = IPolicyModule(instanceAddress);
+        policyModule.activate(policyNftId);
+
+        // add logging
+    }
+
+    function collectPremium(NftId policyNftId) external override {
+        // validation same as other functions, eg underwrite
+        // TODO unify validation into modifier and/or other suitable approaches
+        // same as only registered product
+        NftId productNftId = _registry.getNftId(msg.sender);
+        require(productNftId.gtz(), "ERROR_PRODUCT_UNKNOWN");
+        IRegistry.RegistryInfo memory productInfo = _registry.getInfo(
+            productNftId
         );
+        require(productInfo.objectType == PRODUCT(), "ERROR_NOT_PRODUCT");
 
-        // get responsible pool
-        IComponentModule componentModule = IComponentModule(
-            instanceInfo.objectAddress
+        IRegistry.RegistryInfo memory instanceInfo = _registry.getInfo(
+            productInfo.parentNftId
         );
-        NftId poolNftId = componentModule.getPoolNftId(productNftId);
+        require(instanceInfo.nftId.gtz(), "ERROR_INSTANCE_UNKNOWN");
+        require(instanceInfo.objectType == INSTANCE(), "ERROR_NOT_INSTANCE");
 
-        // lock capital (and update pool accounting)
-        IPoolModule poolModule = IPoolModule(instanceInfo.objectAddress);
-        poolModule.underwrite(poolNftId, nftId);
+        // process/collect premium: book keeping for policy
+        address instanceAddress = instanceInfo.objectAddress;
+        IPolicyModule policyModule = IPolicyModule(instanceAddress);
+        policyModule.processPremium(policyNftId);
 
-        // activate policy
-        IPolicyModule policyModule = IPolicyModule(instanceInfo.objectAddress);
-        policyModule.activate(nftId);
+        // process/collect premium: actual token transfer
+        ITreasuryModule treasuryModule = ITreasuryModule(instanceAddress);
+        treasuryModule.processPremium(policyNftId, productNftId);
 
-        // add logging
+        // TODO add logging
     }
 
-    function close(NftId nftId) external override {}
+    function close(
+        NftId policyNftId
+    ) external override // solhint-disable-next-line no-empty-blocks
+    {
+
+    }
 }
 
 abstract contract ProductModule is IProductModule {

package/contracts/instance/treasury/ITreasury.sol

@@ -0,0 +1,91 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+import {IRegistryLinked} from "../../registry/IRegistry.sol";
+
+import {NftId} from "../../types/NftId.sol";
+import {UFixed} from "../../types/UFixed.sol";
+import {Fee} from "../../types/Fee.sol";
+
+import {TokenHandler} from "./TokenHandler.sol";
+
+interface ITreasury {
+    // TODO add events
+    // TODO add errors
+}
+
+interface ITreasuryModule is IRegistryLinked, ITreasury {
+    struct ProductSetup {
+        NftId productNftId;
+        NftId distributorNftId;
+        NftId poolNftId;
+        IERC20 token;
+        TokenHandler tokenHandler;
+        address wallet;
+        Fee policyFee;
+        Fee processingFee;
+    }
+
+    struct DistributorSetup {
+        NftId distributorNftId;
+        address wallet;
+        Fee commissionFees;
+    }
+
+    struct PoolSetup {
+        NftId poolNftId;
+        address wallet;
+        Fee stakingFee;
+        Fee performanceFee;
+    }
+
+    function registerProduct(
+        NftId productNftId,
+        NftId distributorNftId,
+        NftId poolNftId,
+        IERC20 token,
+        address wallet,
+        Fee memory policyFee,
+        Fee memory processingFee
+    ) external;
+
+    function setProductFees(
+        NftId productNftId,
+        Fee memory policyFee,
+        Fee memory processingFee
+    ) external;
+
+    function registerPool(
+        NftId poolNftId,
+        address wallet,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    ) external;
+
+    function setPoolFees(
+        NftId poolNftId,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    ) external;
+
+    function processPremium(NftId policyNftId, NftId productNftId) external;
+
+    function getTokenHandler(
+        NftId productNftId
+    ) 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
+    ) external pure returns (uint256 feeAmount, uint256 netAmount);
+}

package/contracts/instance/treasury/TokenHandler.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+contract TokenHandler {
+    // TODO use oz safeTransferFrom
+
+    IERC20 _token;
+
+    constructor(address token) {
+        _token = IERC20(token);
+    }
+
+    // TODO add logging
+    function transfer(
+        address from,
+        address to,
+        uint256 amount
+    ) external // TODO add authz (only treasury)
+    {
+        _token.transferFrom(from, to, amount);
+    }
+}