@etherisc/gif-next 0.0.2-836a512-798 → 0.0.2-839b2a2-792

package/contracts/instance/lifecycle/LifecycleModule.sol

@@ -7,13 +7,11 @@ import {StateId, ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, REVOKED, DECLINED} f
 import {ILifecycleModule} from "./ILifecycle.sol";
 
 contract LifecycleModule is ILifecycleModule {
+    mapping(ObjectType objectType => StateId initialState)
+        private _initialState;
 
-    mapping(ObjectType objectType => StateId initialState) private _initialState;
-
-    mapping(ObjectType objectType => 
-        mapping(StateId stateFrom => 
-            mapping(StateId stateTo => bool isValid))) private _isValidTransition;
-
+    mapping(ObjectType objectType => mapping(StateId stateFrom => mapping(StateId stateTo => bool isValid)))
+        private _isValidTransition;
 
     constructor() {
         _setupComponentLifecycle(PRODUCT());
@@ -24,22 +22,27 @@ contract LifecycleModule is ILifecycleModule {
         _setupPolicyLifecycle();
     }
 
-
-    function checkAndLogTransition(NftId nftId, ObjectType objectType, StateId fromId, StateId toId)
-        public
-        returns(StateId)
-        // add only currentcontract? would that work?
+    function checkAndLogTransition(
+        NftId nftId,
+        ObjectType objectType,
+        StateId fromId,
+        StateId toId
+    ) public returns (StateId) // add only currentcontract? would that work?
     {
-        if(!_isValidTransition[objectType][fromId][toId]) {
+        if (!_isValidTransition[objectType][fromId][toId]) {
             revert ErrorInvalidStateTransition(nftId, objectType, fromId, toId);
         }
 
-        if(objectType == POLICY()) {
+        if (objectType == POLICY()) {
             emit LogPolicyStateChanged(nftId, fromId, toId);
-        } else if(objectType == BUNDLE()) {
+        } else if (objectType == BUNDLE()) {
             emit LogBundleStateChanged(nftId, fromId, toId);
-        } else if(objectType == PRODUCT() || objectType == ORACLE() || objectType == POOL()) {
-            emit LogComponentStateChanged(nftId, objectType, fromId, toId);            
+        } else if (
+            objectType == PRODUCT() ||
+            objectType == ORACLE() ||
+            objectType == POOL()
+        ) {
+            emit LogComponentStateChanged(nftId, objectType, fromId, toId);
         } else {
             revert ErrorNoLifecycle(nftId, objectType);
         }
@@ -47,24 +50,20 @@ contract LifecycleModule is ILifecycleModule {
         return toId;
     }
 
-    function getInitialState(ObjectType objectType)
-        public
-        view
-        returns(StateId)
-    {
+    function getInitialState(
+        ObjectType objectType
+    ) public view returns (StateId) {
         return _initialState[objectType];
     }
 
-
-    function isValidTransition(ObjectType objectType, StateId fromId, StateId toId)
-        public
-        view
-        returns(bool)
-    {
+    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;
@@ -72,7 +71,6 @@ contract LifecycleModule is ILifecycleModule {
         _isValidTransition[objectType][PAUSED()][ARCHIVED()] = true;
     }
 
-
     function _setupBundleLifecycle() internal {
         _initialState[BUNDLE()] = ACTIVE();
         _isValidTransition[BUNDLE()][ACTIVE()][PAUSED()] = true;
@@ -80,7 +78,6 @@ contract LifecycleModule is ILifecycleModule {
         _isValidTransition[BUNDLE()][PAUSED()][CLOSED()] = true;
     }
 
-
     function _setupPolicyLifecycle() internal {
         _initialState[POLICY()] = APPLIED();
         _isValidTransition[POLICY()][APPLIED()][REVOKED()] = true;
@@ -88,4 +85,4 @@ contract LifecycleModule is ILifecycleModule {
         _isValidTransition[POLICY()][APPLIED()][ACTIVE()] = true;
         _isValidTransition[POLICY()][ACTIVE()][CLOSED()] = true;
     }
-}
+}

package/contracts/instance/policy/IPolicy.sol

@@ -9,7 +9,6 @@ import {StateId} from "../../types/StateId.sol";
 
 // TODO check if there is value to introuce IContract and let IPolicy derive from IContract
 interface IPolicy {
-
     struct PolicyInfo {
         NftId nftId;
         StateId state; // applied, withdrawn, rejected, active, closed
@@ -27,7 +26,6 @@ interface IPolicy {
 }
 
 interface IPolicyModule is IOwnable, IRegistryLinked, IPolicy {
-
     function createApplication(
         IRegistry.RegistryInfo memory productInfo,
         address applicationOwner,

package/contracts/instance/policy/PolicyModule.sol

@@ -13,10 +13,7 @@ import {NftId, NftIdLib} from "../../types/NftId.sol";
 
 import {LifecycleModule} from "../lifecycle/LifecycleModule.sol";
 
-abstract contract PolicyModule is
-    IRegistryLinked,
-    IPolicyModule
-{
+abstract contract PolicyModule is IRegistryLinked, IPolicyModule {
     using NftIdLib for NftId;
 
     mapping(NftId nftId => PolicyInfo info) private _policyInfo;
@@ -58,7 +55,8 @@ abstract contract PolicyModule is
         nftId = this.getRegistry().registerObjectForInstance(
             productInfo.nftId,
             POLICY(),
-            applicationOwner);
+            applicationOwner
+        );
 
         _policyInfo[nftId] = PolicyInfo(
             nftId,
@@ -67,7 +65,9 @@ abstract contract PolicyModule is
             premiumAmount,
             0, // premium paid amount
             lifetime,
+            // 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
@@ -82,15 +82,22 @@ abstract contract PolicyModule is
     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 = _lifecycleModule.checkAndLogTransition(nftId, POLICY(), info.state, ACTIVE());
+        info.state = _lifecycleModule.checkAndLogTransition(
+            nftId,
+            POLICY(),
+            info.state,
+            ACTIVE()
+        );
     }
 
     function getBundleNftForPolicy(

package/contracts/instance/pool/IPoolModule.sol

@@ -13,10 +13,11 @@ interface IPool {
 }
 
 interface IPoolModule is IOwnable, IRegistryLinked, IPool {
-
     function underwrite(NftId policyNftId, NftId productNftId) external;
 
     function registerPool(NftId nftId) external;
 
-    function getPoolInfo(NftId nftId) external view returns (PoolInfo memory info);
+    function getPoolInfo(
+        NftId nftId
+    ) external view returns (PoolInfo memory info);
 }

package/contracts/instance/pool/PoolModule.sol

@@ -34,10 +34,7 @@ abstract contract PoolModule is IPoolModule {
         _productService = IProductService(productService);
     }
 
-    function registerPool(NftId nftId)
-        public
-        override
-    {
+    function registerPool(NftId nftId) public override {
         require(_poolInfo[nftId].nftId.eqz(), "ERROR:PL-001:ALREADY_CREATED");
 
         _poolInfo[nftId] = PoolInfo(
@@ -50,16 +47,18 @@ abstract contract PoolModule is IPoolModule {
     function underwrite(
         NftId policyNftId,
         NftId productNftId
-    )
-        external
-        override
-        onlyProductService
-    {
-        IPolicy.PolicyInfo memory policyInfo = _policyModule.getPolicyInfo(policyNftId);
+    ) external override onlyProductService {
+        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");
+        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];

package/contracts/instance/product/ProductService.sol

@@ -17,7 +17,12 @@ import {NftId, NftIdLib} from "../../types/NftId.sol";
 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,
@@ -29,10 +34,14 @@ contract ProductService is RegistryLinked, IProductService {
         // same as only registered product
         NftId productNftId = _registry.getNftId(msg.sender);
         require(productNftId.gtz(), "ERROR_PRODUCT_UNKNOWN");
-        IRegistry.RegistryInfo memory productInfo = _registry.getInfo(productNftId);
+        IRegistry.RegistryInfo memory productInfo = _registry.getInfo(
+            productNftId
+        );
         require(productInfo.objectType == PRODUCT(), "ERROR_NOT_PRODUCT");
 
-        IRegistry.RegistryInfo memory instanceInfo = _registry.getInfo(productInfo.parentNftId);
+        IRegistry.RegistryInfo memory instanceInfo = _registry.getInfo(
+            productInfo.parentNftId
+        );
         require(instanceInfo.nftId.gtz(), "ERROR_INSTANCE_UNKNOWN");
         require(instanceInfo.objectType == INSTANCE(), "ERROR_NOT_INSTANCE");
 
@@ -54,10 +63,14 @@ contract ProductService is RegistryLinked, IProductService {
         // same as only registered product
         NftId productNftId = _registry.getNftId(msg.sender);
         require(productNftId.gtz(), "ERROR_PRODUCT_UNKNOWN");
-        IRegistry.RegistryInfo memory productInfo = _registry.getInfo(productNftId);
+        IRegistry.RegistryInfo memory productInfo = _registry.getInfo(
+            productNftId
+        );
         require(productInfo.objectType == PRODUCT(), "ERROR_NOT_PRODUCT");
 
-        IRegistry.RegistryInfo memory instanceInfo = _registry.getInfo(productInfo.parentNftId);
+        IRegistry.RegistryInfo memory instanceInfo = _registry.getInfo(
+            productInfo.parentNftId
+        );
         require(instanceInfo.nftId.gtz(), "ERROR_INSTANCE_UNKNOWN");
         require(instanceInfo.objectType == INSTANCE(), "ERROR_NOT_INSTANCE");
 
@@ -73,19 +86,20 @@ contract ProductService is RegistryLinked, IProductService {
         // add logging
     }
 
-    function collectPremium(NftId policyNftId)
-        external
-        override
-    {
+    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);
+        IRegistry.RegistryInfo memory productInfo = _registry.getInfo(
+            productNftId
+        );
         require(productInfo.objectType == PRODUCT(), "ERROR_NOT_PRODUCT");
 
-        IRegistry.RegistryInfo memory instanceInfo = _registry.getInfo(productInfo.parentNftId);
+        IRegistry.RegistryInfo memory instanceInfo = _registry.getInfo(
+            productInfo.parentNftId
+        );
         require(instanceInfo.nftId.gtz(), "ERROR_INSTANCE_UNKNOWN");
         require(instanceInfo.objectType == INSTANCE(), "ERROR_NOT_INSTANCE");
 
@@ -101,8 +115,12 @@ contract ProductService is RegistryLinked, IProductService {
         // TODO add logging
     }
 
-    function close(NftId policyNftId) 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

@@ -12,16 +12,11 @@ import {Fee} from "../../types/Fee.sol";
 import {TokenHandler} from "./TokenHandler.sol";
 
 interface ITreasury {
-
     // TODO add events
     // TODO add errors
 }
 
-interface ITreasuryModule is
-    IRegistryLinked,
-    ITreasury
-{
-
+interface ITreasuryModule is IRegistryLinked, ITreasury {
     struct ProductSetup {
         NftId productNftId;
         NftId distributorNftId;
@@ -47,27 +42,50 @@ interface ITreasuryModule is
     }
 
     function registerProduct(
-            NftId productNftId,
-            NftId distributorNftId,
-            NftId poolNftId,
-            IERC20 token,
-            address wallet,
-            Fee memory policyFee,
-            Fee memory processingFee
-        )
-            external;
+        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;
+        NftId poolNftId,
+        address wallet,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    ) 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 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

@@ -4,7 +4,6 @@ pragma solidity ^0.8.19;
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
 contract TokenHandler {
-
     // TODO use oz safeTransferFrom
 
     IERC20 _token;
@@ -18,9 +17,7 @@ contract TokenHandler {
         address from,
         address to,
         uint256 amount
-    )
-        external
-        // TODO add authz (only treasury)
+    ) external // TODO add authz (only treasury)
     {
         _token.transferFrom(from, to, amount);
     }

package/contracts/instance/treasury/TreasuryModule.sol

@@ -5,7 +5,7 @@ import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
 import {NftId} from "../../types/NftId.sol";
 import {Fee, feeIsZero} from "../../types/Fee.sol";
-import {UFixed} from "../../types/UFixed.sol";
+import {UFixed, UFixedMathLib} from "../../types/UFixed.sol";
 import {IProductComponent} from "../../components/IProduct.sol";
 import {IPolicy, IPolicyModule} from "../policy/IPolicy.sol";
 import {TokenHandler} from "./TokenHandler.sol";
@@ -13,9 +13,9 @@ import {ITreasuryModule} from "./ITreasury.sol";
 import {TokenHandler} from "./TokenHandler.sol";
 
 abstract contract TreasuryModule is ITreasuryModule {
-
     mapping(NftId productNftId => ProductSetup setup) private _productSetup;
-    mapping(NftId distributorNftId => DistributorSetup setup) private _distributorSetup;
+    mapping(NftId distributorNftId => DistributorSetup setup)
+        private _distributorSetup;
     mapping(NftId poolNftId => PoolSetup setup) private _poolSetup;
 
     IPolicyModule private _policyModule;
@@ -32,10 +32,7 @@ abstract contract TreasuryModule is ITreasuryModule {
         address wallet,
         Fee memory policyFee,
         Fee memory processingFee
-    )
-        external
-        override
-        // TODO add authz (only component module)
+    ) external override // TODO add authz (only component module)
     {
         // TODO add validation
 
@@ -56,15 +53,27 @@ abstract contract TreasuryModule is ITreasuryModule {
         // TODO add logging
     }
 
+    function setProductFees(
+        NftId productNftId,
+        Fee memory policyFee,
+        Fee memory processingFee
+    ) external override // TODO add authz (only component owner service)
+    {
+        // TODO add validation
+
+        ProductSetup storage setup = _productSetup[productNftId];
+        setup.policyFee = policyFee;
+        setup.processingFee = processingFee;
+
+        // TODO add logging
+    }
+
     function registerPool(
-            NftId poolNftId,
-            address wallet,
-            Fee memory stakingFee,
-            Fee memory performanceFee
-    )
-        external
-        override
-        // TODO add authz (only component module)
+        NftId poolNftId,
+        address wallet,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    ) external override // TODO add authz (only component module)
     {
         // TODO add validation
 
@@ -78,54 +87,82 @@ abstract contract TreasuryModule is ITreasuryModule {
         // TODO add logging
     }
 
-    function getTokenHandler(NftId productNftId)
-        external
-        view
-        override
-        returns(TokenHandler tokenHandler)
+    function setPoolFees(
+        NftId poolNftId,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    ) external override // TODO add authz (only component owner service)
     {
+        // TODO add validation
+
+        PoolSetup storage setup = _poolSetup[poolNftId];
+        setup.stakingFee = stakingFee;
+        setup.performanceFee = performanceFee;
+
+        // TODO add logging
+    }
+
+    function getTokenHandler(
+        NftId productNftId
+    ) external view override returns (TokenHandler tokenHandler) {
         return _productSetup[productNftId].tokenHandler;
     }
 
-    function getProductSetup(NftId productNftId)
-        external
-        view
-        override
-        returns(ProductSetup memory setup)
-    {
+    function getProductSetup(
+        NftId productNftId
+    ) external view override returns (ProductSetup memory setup) {
         return _productSetup[productNftId];
     }
 
-    function getPoolSetup(NftId poolNftId) 
-        external
-        view
-        override
-        returns(PoolSetup memory setup)
-    {
+    function getPoolSetup(
+        NftId poolNftId
+    ) external view override returns (PoolSetup memory setup) {
         return _poolSetup[poolNftId];
     }
 
-
-    function processPremium(NftId policyNftId, NftId productNftId)
-        external
-        override
-        // TODO add authz (only product service)
+    function processPremium(
+        NftId policyNftId,
+        NftId productNftId
+    ) external override // TODO add authz (only product service)
     {
-        IPolicy.PolicyInfo memory policyInfo = _policyModule.getPolicyInfo(policyNftId);
-        require(policyInfo.nftId == policyNftId, "ERROR:TRS-020:POLICY_UNKNOWN");
+        IPolicy.PolicyInfo memory policyInfo = _policyModule.getPolicyInfo(
+            policyNftId
+        );
+        require(
+            policyInfo.nftId == policyNftId,
+            "ERROR:TRS-020:POLICY_UNKNOWN"
+        );
 
         ProductSetup memory product = _productSetup[productNftId];
-
         TokenHandler tokenHandler = product.tokenHandler;
         address policyOwner = this.getRegistry().getOwner(policyNftId);
         address poolWallet = _poolSetup[product.poolNftId].wallet;
         // TODO add validation
 
-        if(feeIsZero(product.policyFee)) {
-            tokenHandler.transfer(policyOwner, poolWallet, policyInfo.premiumAmount);
+        if (feeIsZero(product.policyFee)) {
+            tokenHandler.transfer(
+                policyOwner,
+                poolWallet,
+                policyInfo.premiumAmount
+            );
         } else {
-            // TODO add fee handling
-            tokenHandler.transfer(policyOwner, poolWallet, policyInfo.premiumAmount);
+            (uint256 feeAmount, uint256 netAmount) = calculateFeeAmount(
+                policyInfo.premiumAmount,
+                product.policyFee
+            );
+
+            tokenHandler.transfer(policyOwner, product.wallet, feeAmount);
+            tokenHandler.transfer(policyOwner, poolWallet, netAmount);
         }
     }
-}
+
+    function calculateFeeAmount(
+        uint256 amount,
+        Fee memory fee
+    ) public pure override returns (uint256 feeAmount, uint256 netAmount) {
+        UFixed fractionalAmount = UFixedMathLib.itof(amount) *
+            fee.fractionalFee;
+        feeAmount = UFixedMathLib.ftoi(fractionalAmount) + fee.fixedFee;
+        netAmount = amount - feeAmount;
+    }
+}

package/contracts/mock/Dip.sol

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+
+contract DIP is ERC20 {
+
+    // https://etherscan.io/token/0xc719d010b63e5bbf2c0551872cd5316ed26acd83#readContract
+    string public constant NAME = "Decentralized Insurance Protocol - DUMMY";
+    string public constant SYMBOL = "DIP";
+    uint8 public constant DECIMALS = 18;
+    uint256 public constant INITIAL_SUPPLY = 10**9 * 10**DECIMALS; // 1 Billion 1'000'000'000
+    // decimals == 18 (openzeppelin erc20 default)
+    constructor()
+        ERC20(NAME, SYMBOL)
+    {
+        _mint(
+            _msgSender(),
+            INITIAL_SUPPLY
+        );   
+    }
+
+    function decimals() public pure override returns(uint8) {
+        return DECIMALS;
+    }
+}

package/contracts/mock/TestPool.sol

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Fee, zeroFee} from "../../contracts/types/Fee.sol";
+import {Pool} from "../../contracts/components/Pool.sol";
+
+
+contract TestPool is Pool {
+
+    constructor(address registry, address instance, address token)
+        // feeless pool (no staking fee, no performance fee)
+        Pool(registry, instance, token, zeroFee(), zeroFee())
+    // solhint-disable-next-line no-empty-blocks
+    {}
+
+}