@etherisc/gif-next 0.0.2-da77c50-824 → 0.0.2-dd8c542-531

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

@@ -1,60 +0,0 @@
-// 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

@@ -1,84 +0,0 @@
-// 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

@@ -1,41 +0,0 @@
-// 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

@@ -1,87 +0,0 @@
-// 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

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

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

@@ -1,8 +0,0 @@
-// 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

@@ -1,104 +0,0 @@
-// 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

@@ -1,48 +0,0 @@
-// 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

@@ -1,148 +0,0 @@
-// 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);
-    }
-}

package/contracts/instance/service/ComponentServiceBase.sol

@@ -1,41 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {ObjectType, INSTANCE, PRODUCT, POOL} from "../../types/ObjectType.sol";
-import {NftId, NftIdLib} from "../../types/NftId.sol";
-
-import {ServiceBase} from "./ServiceBase.sol";
-
-abstract contract ComponentServiceBase is ServiceBase {
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        ServiceBase(registry, registryNftId)
-    {
-    }
-
-
-    function _getAndVerifyComponentInfoAndInstance(
-        ObjectType objectType
-    )
-        internal
-        view
-        returns(
-            IRegistry.ObjectInfo memory info, 
-            IInstance instance
-        )
-    {
-        NftId componentNftId = _registry.getNftId(msg.sender);
-        require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-
-        info = _registry.getObjectInfo(componentNftId);
-        require(info.objectType == objectType, "OBJECT_TYPE_INVALID");
-
-        address instanceAddress = _registry.getObjectInfo(info.parentNftId).objectAddress;
-        instance = IInstance(instanceAddress);
-    }
-}

package/contracts/instance/service/IService.sol

@@ -1,15 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {VersionPart} from "../../types/Version.sol";
-
-import {IRegisterable} from "../../shared/IRegisterable.sol";
-import {IVersionable} from "../../shared/IVersionable.sol";
-
-interface IService is 
-    IRegisterable,
-    IVersionable
-{
-    function getName() external pure returns(string memory name);
-    function getMajorVersion() external view returns(VersionPart majorVersion);
-}

package/contracts/instance/service/ServiceBase.sol

@@ -1,39 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-// import {IRegistry} from "../../registry/IRegistry.sol";
-// import {ITreasury, ITreasuryModule, TokenHandler} from "../../instance/module/treasury/ITreasury.sol";
-import {NftId, zeroNftId} from "../../types/NftId.sol";
-import {ObjectType, SERVICE} from "../../types/ObjectType.sol";
-import {Version, VersionPart, toVersion, toVersionPart} from "../../types/Version.sol";
-
-import {Registerable} from "../../shared/Registerable.sol";
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {IService} from "./IService.sol";
-
-abstract contract ServiceBase is 
-    Registerable,
-    Versionable,
-    IService
-{
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        Registerable(registry, registryNftId)
-        Versionable()
-    {
-        _registerInterface(type(IService).interfaceId);
-    }
-
-    function getMajorVersion() external view override returns(VersionPart majorVersion) {
-        return this.getVersion().toMajorPart();
-    }
-
-    function getType() external pure override returns (ObjectType) {
-        return SERVICE();
-    }
-}