@etherisc/gif-next 0.0.2-ed4dd55 → 0.0.2-efdb520-159

package/contracts/instance/module/lifecycle/LifecycleModule.sol

@@ -0,0 +1,89 @@
+// 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, UNDERWRITTEN, 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()][UNDERWRITTEN()] = true;
+        _isValidTransition[POLICY()][UNDERWRITTEN()][ACTIVE()] = true;
+        _isValidTransition[POLICY()][ACTIVE()][CLOSED()] = true;
+    }
+}

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/module/treasury/ITreasury.sol

@@ -0,0 +1,104 @@
+// 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";
+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
+
+    struct ProductSetup {
+        NftId productNftId;
+        NftId distributorNftId;
+        NftId poolNftId;
+        IERC20Metadata 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;
+    }
+}
+
+interface ITreasuryModule is ITreasury {
+
+    function registerProduct(
+        NftId productNftId,
+        NftId distributorNftId,
+        NftId poolNftId,
+        IERC20Metadata 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 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);
+
+    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/module/treasury/TreasuryModule.sol

@@ -0,0 +1,148 @@
+// 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";
+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";
+
+abstract contract TreasuryModule is ITreasuryModule {
+    mapping(NftId productNftId => ProductSetup setup) private _productSetup;
+    mapping(NftId distributorNftId => DistributorSetup setup)
+        private _distributorSetup;
+    mapping(NftId poolNftId => PoolSetup setup) private _poolSetup;
+
+    function registerProduct(
+        NftId productNftId,
+        NftId distributorNftId,
+        NftId poolNftId,
+        IERC20Metadata token,
+        address wallet,
+        Fee memory policyFee,
+        Fee memory processingFee
+    ) external override // TODO add authz (only component module)
+    {
+        // TODO add validation
+
+        // deploy product specific handler contract
+        TokenHandler tokenHandler = new TokenHandler(productNftId, address(token));
+
+        _productSetup[productNftId] = ProductSetup(
+            productNftId,
+            distributorNftId,
+            poolNftId,
+            token,
+            tokenHandler,
+            wallet,
+            policyFee,
+            processingFee
+        );
+
+        // 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)
+    {
+        // TODO add validation
+
+        _poolSetup[poolNftId] = PoolSetup(
+            poolNftId,
+            wallet,
+            stakingFee,
+            performanceFee
+        );
+
+        // TODO add logging
+    }
+
+    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) {
+        return _productSetup[productNftId];
+    }
+
+    function getPoolSetup(
+        NftId poolNftId
+    ) external view override returns (PoolSetup memory setup) {
+        return _poolSetup[poolNftId];
+    }
+
+    function calculateFeeAmount(
+        uint256 amount,
+        Fee memory fee
+    ) public pure override returns (uint256 feeAmount, uint256 netAmount) {
+        UFixed fractionalAmount = UFixedMathLib.toUFixed(amount) *
+            fee.fractionalFee;
+        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);
+    }
+}