@etherisc/gif-next 0.0.2-f74fcad-685 → 0.0.2-f7b8c9f-436

package/contracts/instance/component/ComponentModule.sol

@@ -1,274 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {RegistryLinked} from "../../registry/Registry.sol";
-import {IRegistry, IRegistryLinked} from "../../registry/IRegistry.sol";
-import {IAccessComponentTypeRoles, IAccessCheckRole} from "../access/IAccess.sol";
-import {IInstance} from "../IInstance.sol";
-
-import {LifecycleModule} from "../lifecycle/LifecycleModule.sol";
-import {ITreasuryModule} from "../treasury/ITreasury.sol";
-import {TreasuryModule} from "../treasury/TreasuryModule.sol";
-import {IComponent, IComponentContract, IComponentModule, IComponentOwnerService} from "./IComponent.sol";
-import {IProductComponent} from "../../components/IProduct.sol";
-import {IPoolComponent} from "../../components/IPool.sol";
-import {IPoolModule} from "../pool/IPoolModule.sol";
-import {ObjectType, PRODUCT, ORACLE, POOL} from "../../types/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED} from "../../types/StateId.sol";
-import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {Fee, zeroFee} from "../../types/Fee.sol";
-
-abstract contract ComponentModule is
-    IRegistryLinked,
-    IAccessComponentTypeRoles,
-    IAccessCheckRole,
-    IComponentModule
-{
-    using NftIdLib for NftId;
-
-    mapping(NftId nftId => ComponentInfo info) private _componentInfo;
-    mapping(address cAddress => NftId nftId) private _nftIdByAddress;
-    NftId[] private _nftIds;
-
-    mapping(ObjectType cType => bytes32 role) private _componentOwnerRole;
-
-    // TODO maybe move this to Instance contract as internal variable?
-    LifecycleModule private _lifecycleModule;
-    TreasuryModule private _treasuryModule;
-    IPoolModule private _poolModule;
-    IComponentOwnerService private _componentOwnerService;
-
-    modifier onlyComponentOwnerService() {
-        require(
-            address(_componentOwnerService) == msg.sender,
-            "ERROR:CMP-001:NOT_OWNER_SERVICE"
-        );
-        _;
-    }
-
-    constructor(address componentOwnerService) {
-        address componentAddress = address(this);
-        _lifecycleModule = LifecycleModule(componentAddress);
-        _treasuryModule = TreasuryModule(componentAddress);
-        _poolModule = IPoolModule(componentAddress);
-        _componentOwnerService = ComponentOwnerService(componentOwnerService);
-    }
-
-    function registerComponent(
-        IComponentContract component
-    ) external override onlyComponentOwnerService returns (NftId nftId) {
-        ObjectType objectType = component.getType();
-        bytes32 typeRole = getRoleForType(objectType);
-        require(
-            this.hasRole(typeRole, component.getInitialOwner()),
-            "ERROR:CMP-004:TYPE_ROLE_MISSING"
-        );
-
-        nftId = this.getRegistry().register(address(component));
-        IERC20Metadata token = component.getToken();
-        address wallet = component.getWallet();
-
-        // create component info
-        _componentInfo[nftId] = ComponentInfo(
-            nftId,
-            _lifecycleModule.getInitialState(objectType),
-            token
-        );
-
-        // component type specific registration actions
-        if (component.getType() == PRODUCT()) {
-            IProductComponent product = IProductComponent(address(component));
-            NftId poolNftId = product.getPoolNftId();
-            require(poolNftId.gtz(), "ERROR:CMP-005:POOL_UNKNOWN");
-            // validate pool token and product token are same
-
-            // register with tresury
-            // implement and add validation
-            NftId distributorNftId = zeroNftId();
-            _treasuryModule.registerProduct(
-                nftId,
-                distributorNftId,
-                poolNftId,
-                token,
-                wallet,
-                product.getPolicyFee(),
-                product.getProcessingFee()
-            );
-        } else if (component.getType() == POOL()) {
-            IPoolComponent pool = IPoolComponent(address(component));
-
-            // register with pool
-            _poolModule.registerPool(nftId);
-
-            // register with tresury
-            _treasuryModule.registerPool(
-                nftId,
-                wallet,
-                pool.getStakingFee(),
-                pool.getPerformanceFee()
-            );
-        }
-        // TODO add distribution
-
-        _nftIdByAddress[address(component)] = nftId;
-        _nftIds.push(nftId);
-
-        // TODO add loggingx
-    }
-
-    function getComponentOwnerService()
-        external
-        view
-        override
-        returns (IComponentOwnerService)
-    {
-        return _componentOwnerService;
-    }
-
-    function setComponentInfo(
-        ComponentInfo memory info
-    ) external onlyComponentOwnerService returns (NftId nftId) {
-        nftId = info.nftId;
-        require(
-            nftId.gtz() && _componentInfo[nftId].nftId.eq(nftId),
-            "ERROR:CMP-006:COMPONENT_UNKNOWN"
-        );
-
-        // TODO decide if state changes should have explicit functions and not
-        // just a generic setXYZInfo and implicit state transitions
-        // when in doubt go for the explicit approach ...
-        ObjectType objectType = this.getRegistry().getInfo(nftId).objectType;
-        _lifecycleModule.checkAndLogTransition(
-            nftId,
-            objectType,
-            _componentInfo[nftId].state,
-            info.state
-        );
-        _componentInfo[nftId] = info;
-    }
-
-    function getComponentInfo(
-        NftId nftId
-    ) external view override returns (ComponentInfo memory) {
-        return _componentInfo[nftId];
-    }
-
-    function getComponentId(
-        address componentAddress
-    ) external view returns (NftId componentNftId) {
-        return _nftIdByAddress[componentAddress];
-    }
-
-    function getComponentId(
-        uint256 idx
-    ) external view override returns (NftId componentNftId) {
-        return _nftIds[idx];
-    }
-
-    function components()
-        external
-        view
-        override
-        returns (uint256 numberOfCompnents)
-    {
-        return _nftIds.length;
-    }
-
-    function getRoleForType(
-        ObjectType cType
-    ) public view returns (bytes32 role) {
-        if (cType == PRODUCT()) {
-            return this.PRODUCT_OWNER_ROLE();
-        }
-        if (cType == POOL()) {
-            return this.POOL_OWNER_ROLE();
-        }
-        if (cType == ORACLE()) {
-            return this.ORACLE_OWNER_ROLE();
-        }
-    }
-}
-
-// this is actually the component owner service
-contract ComponentOwnerService is
-    RegistryLinked,
-    IComponent,
-    IComponentOwnerService
-{
-    using NftIdLib for NftId;
-
-    modifier onlyComponentOwner(IComponentContract component) {
-        NftId nftId = _registry.getNftId(address(component));
-        require(nftId.gtz(), "ERROR:COS-001:COMPONENT_UNKNOWN");
-        require(
-            msg.sender == _registry.getOwner(nftId),
-            "ERROR:COS-002:NOT_OWNER"
-        );
-        _;
-    }
-
-    constructor(
-        address registry
-    ) RegistryLinked(registry) // solhint-disable-next-line no-empty-blocks
-    {
-
-    }
-
-    function register(
-        IComponentContract component
-    ) external override returns (NftId nftId) {
-        require(
-            msg.sender == component.getInitialOwner(),
-            "ERROR:COS-003:NOT_OWNER"
-        );
-
-        IInstance instance = component.getInstance();
-        nftId = instance.registerComponent(component);
-    }
-
-    function lock(
-        IComponentContract component
-    ) external override onlyComponentOwner(component) {
-        IInstance instance = component.getInstance();
-        ComponentInfo memory info = instance.getComponentInfo(
-            component.getNftId()
-        );
-        require(info.nftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-
-        info.state = PAUSED();
-        // setComponentInfo checks for valid state changes
-        instance.setComponentInfo(info);
-    }
-
-    function unlock(
-        IComponentContract component
-    ) external override onlyComponentOwner(component) {
-        IInstance instance = component.getInstance();
-        ComponentInfo memory info = instance.getComponentInfo(
-            component.getNftId()
-        );
-        require(info.nftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-
-        info.state = ACTIVE();
-        // setComponentInfo checks for valid state changes
-        instance.setComponentInfo(info);
-    }
-
-    function setProductFees(
-        IComponentContract product,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external override onlyComponentOwner(product) {
-        require(product.getType() == PRODUCT(), "ERROR_NOT_PRODUCT");
-
-        address instanceAddress = address(product.getInstance());
-        ITreasuryModule treasuryModule = ITreasuryModule(instanceAddress);
-        treasuryModule.setProductFees(
-            product.getNftId(),
-            policyFee,
-            processingFee
-        );
-    }
-}

package/contracts/instance/component/IComponent.sol

@@ -1,74 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {IOwnable, IRegistryLinked, IRegisterable} from "../../registry/IRegistry.sol";
-import {IInstance} from "../IInstance.sol";
-import {StateId} from "../../types/StateId.sol";
-import {NftId} from "../../types/NftId.sol";
-import {Fee} from "../../types/Fee.sol";
-import {UFixed} from "../../types/UFixed.sol";
-
-interface IComponent {
-    // component dynamic info (static info kept in registry)
-    struct ComponentInfo {
-        NftId nftId;
-        StateId state;
-        IERC20Metadata token;
-    }
-}
-
-interface IInstanceLinked {
-    // function setInstance(address instance) external;
-    function getInstance() external view returns (IInstance instance);
-}
-
-interface IComponentContract is IRegisterable, IInstanceLinked, IComponent {
-    function getToken() external view returns (IERC20Metadata token);
-
-    function getWallet() external view returns (address walletAddress);
-}
-
-interface IComponentOwnerService is IRegistryLinked {
-    function register(
-        IComponentContract component
-    ) external returns (NftId nftId);
-
-    function lock(IComponentContract component) external;
-
-    function unlock(IComponentContract component) external;
-
-    function setProductFees(
-        IComponentContract product,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external;
-}
-
-interface IComponentModule is IOwnable, IRegistryLinked, IComponent {
-    function registerComponent(
-        IComponentContract component
-    ) external returns (NftId nftId);
-
-    function setComponentInfo(
-        ComponentInfo memory info
-    ) external returns (NftId componentNftId);
-
-    function getComponentInfo(
-        NftId nftId
-    ) external view returns (ComponentInfo memory info);
-
-    function getComponentId(
-        address componentAddress
-    ) external view returns (NftId nftId);
-
-    function getComponentId(uint256 idx) external view returns (NftId nftId);
-
-    function components() external view returns (uint256 numberOfCompnents);
-
-    function getComponentOwnerService()
-        external
-        view
-        returns (IComponentOwnerService);
-}

package/contracts/instance/lifecycle/LifecycleModule.sol

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

@@ -1,50 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IOwnable, IRegistryLinked, IRegisterable, IRegistry} from "../../registry/IRegistry.sol";
-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 {
-    struct PolicyInfo {
-        NftId nftId;
-        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
-    }
-}
-
-interface IPolicyModule is IOwnable, IRegistryLinked, IPolicy {
-    function createApplication(
-        IRegistry.RegistryInfo memory productInfo,
-        address applicationOwner,
-        uint256 sumInsuredAmount,
-        uint256 premiumAmount,
-        uint256 lifetime,
-        NftId bundleNftId
-    ) external returns (NftId nftId);
-
-    // process full premium
-    function processPremium(NftId nftId) external;
-
-    function activate(NftId nftId) external;
-
-    function getBundleNftForPolicy(
-        NftId nftId
-    ) external view returns (NftId bundleNft);
-
-    function getPolicyInfo(
-        NftId nftId
-    ) external view returns (PolicyInfo memory info);
-}

package/contracts/instance/policy/PolicyModule.sol

@@ -1,114 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-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
-    modifier onlyProductService2() {
-        require(
-            address(_productService) == msg.sender,
-            "ERROR:POL-001:NOT_PRODUCT_SERVICE"
-        );
-        _;
-    }
-
-    constructor(address productService) {
-        _lifecycleModule = LifecycleModule(address(this));
-        _productService = IProductService(productService);
-    }
-
-    function createApplication(
-        IRegistry.RegistryInfo memory productInfo,
-        address applicationOwner,
-        uint256 sumInsuredAmount,
-        uint256 premiumAmount,
-        uint256 lifetime,
-        NftId bundleNftId
-    ) external override onlyProductService2 returns (NftId nftId) {
-        // TODO add parameter validation
-        if (bundleNftId.gtz()) {
-            // IRegistry.RegistryInfo memory bundleInfo = this
-            //     .getRegistry()
-            //     .getInfo(bundleNftId);
-            // IRegistry.RegistryInfo memory poolInfo = this.getRegistry().getInfo(bundleInfo.parentNftId);
-        }
-
-        nftId = this.getRegistry().registerObjectForInstance(
-            productInfo.nftId,
-            POLICY(),
-            applicationOwner
-        );
-
-        _policyInfo[nftId] = PolicyInfo(
-            nftId,
-            _lifecycleModule.getInitialState(POLICY()),
-            sumInsuredAmount,
-            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
-            0 // closedAt
-        );
-
-        _bundleForPolicy[nftId] = bundleNftId;
-
-        // 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 = _lifecycleModule.checkAndLogTransition(
-            nftId,
-            POLICY(),
-            info.state,
-            ACTIVE()
-        );
-    }
-
-    function getBundleNftForPolicy(
-        NftId nftId
-    ) external view returns (NftId bundleNft) {
-        return _bundleForPolicy[nftId];
-    }
-
-    function getPolicyInfo(
-        NftId nftId
-    ) external view returns (PolicyInfo memory info) {
-        return _policyInfo[nftId];
-    }
-}

package/contracts/instance/pool/IPoolModule.sol

@@ -1,23 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IOwnable, IRegistry, IRegistryLinked} from "../../registry/IRegistry.sol";
-import {NftId} from "../../types/NftId.sol";
-
-interface IPool {
-    struct PoolInfo {
-        NftId nftId;
-        uint256 capital;
-        uint256 lockedCapital;
-    }
-}
-
-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);
-}