@etherisc/gif-next 0.0.2-d3543ee-217 → 0.0.2-da77c50-824

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

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../../registry/IRegistry.sol";
+import {IInstance} from "../../IInstance.sol";
+import {IProductService} from "../../service/IProductService.sol";
+import {NftId} from "../../../types/NftId.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;
+        address beneficiary;
+        StateId state; // applied, withdrawn, rejected, active, closed
+        uint256 sumInsuredAmount;
+        uint256 premiumAmount;
+        uint256 premiumPaidAmount;
+        uint256 lifetime;
+        bytes data;
+        Timestamp createdAt;
+        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,
+        NftId policyNftId,
+        uint256 sumInsuredAmount,
+        uint256 premiumAmount,
+        uint256 lifetime,
+        NftId bundleNftId
+    ) external;
+
+    function setPolicyInfo(PolicyInfo memory policyInfo) external;
+
+    // function underwrite(NftId nftId) external;
+
+    // function processPremium(NftId nftId, uint256 amount) external;
+
+    // function activate(NftId nftId, Timestamp activateAt) external;
+
+    function getPolicyInfo(
+        NftId nftId
+    ) external view returns (PolicyInfo memory info);
+
+    // repeat registry linked signature
+    function getRegistry() external view returns (IRegistry registry);
+
+    // repeat service linked signature to avoid linearization issues
+    function getProductService() external  returns(IProductService);
+}

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

@@ -0,0 +1,84 @@
+// SPDX-License-Identifier: Apache-2.0
+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 {Timestamp, blockTimestamp, zeroTimestamp} from "../../../types/Timestamp.sol";
+import {Blocknumber, blockNumber} from "../../../types/Blocknumber.sol";
+
+import {LifecycleModule} from "../../module/lifecycle/LifecycleModule.sol";
+
+abstract contract PolicyModule is IPolicyModule {
+    using NftIdLib for NftId;
+
+    mapping(NftId nftId => PolicyInfo info) private _policyInfo;
+
+    LifecycleModule private _lifecycleModule;
+
+    // TODO find a better place to avoid dupliation
+    modifier onlyProductService2() {
+        require(
+            msg.sender == address(this.getProductService()),
+            "ERROR:POL-001:NOT_PRODUCT_SERVICE"
+        );
+        _;
+    }
+
+    constructor() {
+        _lifecycleModule = LifecycleModule(address(this));
+    }
+
+    function createApplication(
+        NftId productNftId,
+        NftId policyNftId,
+        uint256 sumInsuredAmount,
+        uint256 premiumAmount,
+        uint256 lifetime,
+        NftId bundleNftId
+    )
+        external
+        onlyProductService2
+        override
+    {
+        _policyInfo[policyNftId] = PolicyInfo(
+            policyNftId,
+            productNftId,
+            bundleNftId,
+            address(0), // beneficiary = policy nft holder
+            _lifecycleModule.getInitialState(POLICY()),
+            sumInsuredAmount,
+            premiumAmount,
+            0, // premium paid amount
+            lifetime, 
+            "", // data
+            blockTimestamp(), // createdAt
+            zeroTimestamp(), // activatedAt
+            zeroTimestamp(), // expiredAt
+            zeroTimestamp(), // closedAt
+            blockNumber() // updatedIn
+        );
+
+        // TODO add logging
+    }
+
+    function setPolicyInfo(PolicyInfo memory policyInfo)
+        external
+        override
+        onlyProductService2
+    {
+        _policyInfo[policyInfo.nftId] = policyInfo;
+    }
+
+    function getPolicyInfo(
+        NftId nftId
+    ) external view returns (PolicyInfo memory info) {
+        return _policyInfo[nftId];
+    }
+
+}

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

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../../registry/IRegistry.sol";
+import {NftId} from "../../../types/NftId.sol";
+import {UFixed} from "../../../types/UFixed.sol";
+import {IProductService} from "../../service/IProductService.sol";
+import {IPoolService} from "../../service/IPoolService.sol";
+
+interface IPool {
+    struct PoolInfo {
+        NftId nftId;
+        bool isVerifying;
+        UFixed collateralizationLevel;
+    }
+}
+
+interface IPoolModule is IPool {
+
+    function registerPool(
+        NftId poolNftId, 
+        bool isVerifying, 
+        UFixed collateralizationLevel
+    ) external;
+
+    function addBundleToPool(
+        NftId bundleNftId,
+        NftId poolNftId,
+        uint256 amount
+    ) external;
+
+    function getPoolInfo(
+        NftId nftId
+    ) external view returns (PoolInfo memory info);
+
+    function getBundleCount(NftId poolNftId) external view returns (uint256 bundleCount);
+    function getBundleNftId(NftId poolNftId, uint256 index) external view returns (NftId bundleNftId);
+
+    // repeat service linked signatures to avoid linearization issues
+    function getPoolService() external returns(IPoolService);
+}

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

@@ -0,0 +1,87 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../../registry/IRegistry.sol";
+import {IProductService} from "../../service/IProductService.sol";
+import {IPoolService} from "../../service/IPoolService.sol";
+import {IPolicy, IPolicyModule} from "../../module/policy/IPolicy.sol";
+import {ITreasuryModule} from "../../module/treasury/ITreasury.sol";
+
+import {NftId} from "../../../types/NftId.sol";
+import {LibNftIdSet} from "../../../types/NftIdSet.sol";
+import {StateId, APPLIED} from "../../../types/StateId.sol";
+import {UFixed} from "../../../types/UFixed.sol";
+
+import {IPoolModule} from "./IPoolModule.sol";
+
+abstract contract PoolModule is
+    IPoolModule
+{
+    using LibNftIdSet for LibNftIdSet.Set;
+
+    mapping(NftId poolNftId => PoolInfo info) private _poolInfo;
+    mapping(NftId poolNftId => LibNftIdSet.Set bundles) private _bundlesForPool;
+
+    modifier poolServiceCallingPool() {
+        require(
+            msg.sender == address(this.getPoolService()),
+            "ERROR:PL-001:NOT_POOL_SERVICE"
+        );
+        _;
+    }
+
+    function registerPool(
+        NftId nftId, 
+        bool isVerifying,
+        UFixed collateralizationRate
+    )
+        public
+        override
+    {
+        require(
+            _poolInfo[nftId].nftId.eqz(), 
+            "ERROR:PL-010:ALREADY_CREATED");
+
+        _poolInfo[nftId] = PoolInfo(
+            nftId,
+            isVerifying,
+            collateralizationRate
+        );
+
+        // TODO add logging
+    }
+
+    function addBundleToPool(
+        NftId bundleNftId,
+        NftId poolNftId,
+        uint256 // amount
+    )
+        external
+        override
+    {
+        LibNftIdSet.Set storage bundleSet = _bundlesForPool[poolNftId];
+        require(
+            !bundleSet.contains(bundleNftId),
+            "ERROR:PL-020:BUNDLE_ALREADY_ADDED");
+
+        bundleSet.add(bundleNftId);
+    }
+
+
+    function getPoolInfo(
+        NftId nftId
+    ) external view override returns (PoolInfo memory info) {
+        info = _poolInfo[nftId];
+    }
+
+
+    function getBundleCount(NftId poolNftId) external view override returns (uint256 bundleCount) {
+        return _bundlesForPool[poolNftId].getLength();
+    }
+
+
+    function getBundleNftId(NftId poolNftId, uint256 index) external view override returns (NftId bundleNftId) {
+        return _bundlesForPool[poolNftId].getElementAt(index);
+    }
+
+}

package/contracts/instance/module/product/IProductModule.sol

@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+interface IProductModule
+{
+}

package/contracts/instance/module/product/ProductModule.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IProductService} from "../../service/IProductService.sol";
+import {IProductModule} from "./IProductModule.sol";
+
+abstract contract ProductModule is IProductModule {
+}

package/contracts/instance/{treasury → module/treasury}/ITreasury.sol

@@ -1,27 +1,23 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.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 {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;
+        IERC20Metadata token;
         TokenHandler tokenHandler;
         address wallet;
         Fee policyFee;
@@ -40,12 +36,15 @@ interface ITreasuryModule is IRegistryLinked, ITreasury {
         Fee stakingFee;
         Fee performanceFee;
     }
+}
+
+interface ITreasuryModule is ITreasury {
 
     function registerProduct(
         NftId productNftId,
         NftId distributorNftId,
         NftId poolNftId,
-        IERC20 token,
+        IERC20Metadata token,
         address wallet,
         Fee memory policyFee,
         Fee memory processingFee
@@ -70,8 +69,6 @@ interface ITreasuryModule is IRegistryLinked, ITreasury {
         Fee memory performanceFee
     ) external;
 
-    function processPremium(NftId policyNftId, NftId productNftId) external;
-
     function getTokenHandler(
         NftId productNftId
     ) external view returns (TokenHandler tokenHandler);
@@ -88,4 +85,20 @@ interface ITreasuryModule is IRegistryLinked, ITreasury {
         uint256 amount,
         Fee memory fee
     ) external pure returns (uint256 feeAmount, uint256 netAmount);
+
+    function getFee(
+        UFixed fractionalFee, 
+        uint256 fixedFee
+    ) external pure returns (Fee memory fee);
+
+    function getZeroFee() external pure returns (Fee memory fee);
+
+    function getUFixed(
+        uint256 a
+    ) external pure returns (UFixed);
+
+    function getUFixed(
+        uint256 a, 
+        int8 exp
+    ) external pure returns (UFixed);
 }

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

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {NftId} from "../../../types/NftId.sol";
+
+contract TokenHandler {
+    NftId private _productNftId;
+    IERC20Metadata private _token;
+
+    constructor(
+        NftId productNftId,
+        address token
+    )
+    {
+        _productNftId = productNftId;
+        _token = IERC20Metadata(token);
+    }
+
+    // TODO add logging
+    function transfer(
+        address from,
+        address to,
+        uint256 amount
+    )
+        external // TODO add authz (only treasury/instance/product/pool/ service)
+    {
+        // TODO switch to oz safeTransferFrom
+        _token.transferFrom(from, to, amount);
+    }
+
+    function getProductNftId()
+        external
+        view
+        returns(NftId)
+    {
+        return _productNftId;
+    }
+
+    function getToken()
+        external
+        view
+        returns(IERC20Metadata)
+    {
+        return _token;
+    }
+}

package/contracts/instance/{treasury → module/treasury}/TreasuryModule.sol

@@ -1,16 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
-import {NftId} from "../../types/NftId.sol";
-import {Fee, feeIsZero} from "../../types/Fee.sol";
-import {UFixed, UFixedMathLib} from "../../types/UFixed.sol";
-import {IProductComponent} from "../../components/IProduct.sol";
-import {IPolicy, IPolicyModule} from "../policy/IPolicy.sol";
+import {NftId} from "../../../types/NftId.sol";
+import {Fee, feeIsZero, toFee, zeroFee} from "../../../types/Fee.sol";
+import {UFixed, UFixedMathLib} from "../../../types/UFixed.sol";
 import {TokenHandler} from "./TokenHandler.sol";
 import {ITreasuryModule} from "./ITreasury.sol";
-import {TokenHandler} from "./TokenHandler.sol";
 
 abstract contract TreasuryModule is ITreasuryModule {
     mapping(NftId productNftId => ProductSetup setup) private _productSetup;
@@ -18,17 +15,11 @@ abstract contract TreasuryModule is ITreasuryModule {
         private _distributorSetup;
     mapping(NftId poolNftId => PoolSetup setup) private _poolSetup;
 
-    IPolicyModule private _policyModule;
-
-    constructor() {
-        _policyModule = IPolicyModule(address(this));
-    }
-
     function registerProduct(
         NftId productNftId,
         NftId distributorNftId,
         NftId poolNftId,
-        IERC20 token,
+        IERC20Metadata token,
         address wallet,
         Fee memory policyFee,
         Fee memory processingFee
@@ -37,7 +28,7 @@ abstract contract TreasuryModule is ITreasuryModule {
         // TODO add validation
 
         // deploy product specific handler contract
-        TokenHandler tokenHandler = new TokenHandler(address(token));
+        TokenHandler tokenHandler = new TokenHandler(productNftId, address(token));
 
         _productSetup[productNftId] = ProductSetup(
             productNftId,
@@ -120,49 +111,38 @@ abstract contract TreasuryModule is ITreasuryModule {
         return _poolSetup[poolNftId];
     }
 
-    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"
-        );
-
-        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
-            );
-        } else {
-            (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) *
+        UFixed fractionalAmount = UFixedMathLib.toUFixed(amount) *
             fee.fractionalFee;
-        feeAmount = UFixedMathLib.ftoi(fractionalAmount) + fee.fixedFee;
+        feeAmount = fractionalAmount.toInt() + fee.fixedFee;
         netAmount = amount - feeAmount;
     }
+
+    function getFee(
+        UFixed fractionalFee, 
+        uint256 fixedFee
+    ) external pure override returns (Fee memory fee) {
+        return toFee(fractionalFee, fixedFee);
+    }
+
+    function getZeroFee() external pure override returns (Fee memory fee) {
+        return zeroFee();
+    }
+
+    function getUFixed(
+        uint256 a
+    ) external pure override returns (UFixed) {
+        return UFixedMathLib.toUFixed(a);
+    }
+
+    function getUFixed(
+        uint256 a, 
+        int8 exp
+    ) external pure returns (UFixed)
+    {
+        return UFixedMathLib.toUFixed(a, exp);
+    }
 }