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

package/contracts/instance/module/bundle/BundleModule.sol

@@ -0,0 +1,228 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../../registry/IRegistry.sol";
+
+import {LifecycleModule} from "../lifecycle/LifecycleModule.sol";
+import {IProductService} from "../../service/IProductService.sol";
+import {IPoolService} from "../../service/IPoolService.sol";
+
+import {NftId} from "../../../types/NftId.sol";
+import {LibNftIdSet} from "../../../types/NftIdSet.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 {Timestamp, blockTimestamp, zeroTimestamp} from "../../../types/Timestamp.sol";
+import {Blocknumber, blockNumber} from "../../../types/Blocknumber.sol";
+
+import {ILifecycleModule} from "../lifecycle/ILifecycle.sol";
+import {IBundleModule} from "./IBundle.sol";
+
+abstract contract BundleModule is
+    IBundleModule
+{
+
+    using LibNftIdSet for LibNftIdSet.Set;
+
+    mapping(NftId bundleNftId => BundleInfo info) private _bundleInfo;
+    mapping(NftId bundleNftId => LibNftIdSet.Set policies) private _collateralizedPolicies;
+    mapping(NftId bundleNftId => mapping(NftId policyNftId => uint256 amount)) private _collateralizationAmount;
+
+    LifecycleModule private _lifecycleModule;
+
+    modifier onlyBundlePoolService() {
+        require(
+            msg.sender == address(this.getPoolService()),
+            "ERROR:BDL-001:NOT_POOL_SERVICE"
+        );
+        _;
+    }
+
+    modifier onlyBundleProductService() {
+        require(
+            msg.sender == address(this.getProductService()),
+            "ERROR:BDL-002:NOT_PRODUCT_SERVICE"
+        );
+        _;
+    }
+
+    modifier onlyPoolOrProductService() {
+        require(
+            msg.sender == address(this.getPoolService())
+                || msg.sender == address(this.getProductService()),
+            "ERROR:BDL-003:NOT_POOL_OR_PRODUCT_SERVICE"
+        );
+        _;
+    }
+
+    constructor() {
+        _lifecycleModule = LifecycleModule(address(this));
+    }
+
+    function createBundleInfo(
+        NftId bundleNftId,
+        NftId poolNftId,
+        uint256 amount, 
+        uint256 lifetime, 
+        bytes calldata filter
+    )
+        external
+        onlyBundlePoolService
+        override
+    {
+
+        _bundleInfo[bundleNftId] = BundleInfo(
+            bundleNftId,
+            poolNftId,
+            _lifecycleModule.getInitialState(BUNDLE()),
+            filter,
+            amount, // capital
+            0, // locked capital
+            amount, // balance
+            blockTimestamp(), // createdAt
+            blockTimestamp().addSeconds(lifetime), // expiredAt
+            zeroTimestamp(), // closedAt
+            blockNumber() // updatedIn
+        );
+
+        // TODO add logging
+    }
+
+    function setBundleInfo(BundleInfo memory bundleInfo)
+        external
+        override
+        onlyPoolOrProductService
+    {
+        _bundleInfo[bundleInfo.nftId] = bundleInfo;
+    }
+
+    // function updateBundleState(
+    //     NftId bundleNftId,
+    //     StateId newState
+    // )
+    //     external    
+    //     // add authz (both product and pool service)
+    //     override
+    // {
+    //     BundleInfo storage info = _bundleInfo[bundleNftId];
+    //     info.state = newState;
+    //     info.updatedIn = blockNumber();
+    // }
+
+    // function extendBundle(
+    //     NftId bundleNftId,
+    //     uint256 lifetimeExtension
+    // )
+    //     external
+    //     onlyBundlePoolService
+    //     override
+    // {
+    //     BundleInfo storage info = _bundleInfo[bundleNftId];
+    //     info.expiredAt = info.expiredAt.addSeconds(lifetimeExtension);
+    //     info.updatedIn = blockNumber();
+    // }
+
+    // function closeBundle(
+    //     NftId bundleNftId
+    // )
+    //     external
+    //     onlyBundlePoolService
+    //     override
+    // {
+    //     BundleInfo storage info = _bundleInfo[bundleNftId];
+    //     info.state = CLOSED();
+    //     info.closedAt = blockTimestamp();
+    //     info.updatedIn = blockNumber();
+    // }
+
+    // function processStake(
+    //     NftId nftId,
+    //     uint256 amount
+    // )
+    //     external
+    //     onlyBundlePoolService
+    //     override
+    // {
+    //     BundleInfo storage info = _bundleInfo[nftId];
+    //     info.capitalAmount += amount;
+    //     info.balanceAmount += amount;
+    //     info.updatedIn = blockNumber();
+    // }
+
+    // function processUnstake(
+    //     NftId nftId,
+    //     uint256 amount
+    // )
+    //     external
+    //     onlyBundlePoolService
+    //     override
+    // {
+    //     BundleInfo storage info = _bundleInfo[nftId];
+    //     // TODO fix book keeping in a way that provides
+    //     // continuous infor regarding profitability
+    //     // this is needed to properly apply performance fees
+    //     info.capitalAmount -= amount;
+    //     info.balanceAmount -= amount;
+    //     info.updatedIn = blockNumber();
+    // }
+
+    function collateralizePolicy(
+        NftId bundleNftId, 
+        NftId policyNftId, 
+        uint256 collateralAmount
+    )
+        external
+        onlyBundleProductService
+        override
+    {
+        _collateralizationAmount[bundleNftId][policyNftId] = collateralAmount;
+        _collateralizedPolicies[bundleNftId].add(policyNftId);
+    }
+
+    function releasePolicy(
+        NftId bundleNftId,
+        NftId policyNftId
+    )
+        external
+        onlyBundleProductService
+        override 
+        returns(uint256 collateralAmount)
+    {
+    //     BundleInfo storage info = _bundleInfo[bundleNftId];
+    //     info.lockedAmount -= collateralAmount;
+    //     info.updatedIn = blockNumber();
+
+        collateralAmount = _collateralizationAmount[bundleNftId][policyNftId];
+        delete _collateralizationAmount[bundleNftId][policyNftId];
+        _collateralizedPolicies[bundleNftId].remove(policyNftId);
+    }
+
+    // function addPremium(NftId bundleNftId, uint256 amount)
+    //     external
+    //     onlyBundleProductService
+    //     override
+    // {
+    //     BundleInfo storage info = _bundleInfo[bundleNftId];
+    //     info.capitalAmount += amount;
+    //     info.balanceAmount += amount;
+    //     info.updatedIn = blockNumber();
+    // }
+
+    // function subtractPayout(NftId bundleNftId, NftId policyNftId, uint256 amount)
+    //     external
+    //     onlyBundleProductService
+    //     override
+    // {
+    //     BundleInfo storage info = _bundleInfo[bundleNftId];
+    //     info.capitalAmount -= amount;
+    //     info.lockedAmount -= amount;
+    //     info.balanceAmount -= amount;
+    //     info.updatedIn = blockNumber();
+
+    //     // deduct amount from sum insured for this policy
+    //     _collateralizationAmount[bundleNftId][policyNftId] -= amount;
+    // }
+
+    function getBundleInfo(NftId bundleNftId) external view override returns(BundleInfo memory bundleInfo) {
+        return _bundleInfo[bundleNftId];
+    }
+}

package/contracts/instance/module/bundle/IBundle.sol

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../../registry/IRegistry.sol";
+import {IInstance} from "../../IInstance.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";
+
+import {IProductService} from "../../service/IProductService.sol";
+import {IPoolService} from "../../service/IPoolService.sol";
+
+interface IBundle {
+
+    struct BundleInfo {
+        NftId nftId;
+        NftId poolNftId;
+        StateId state; // active, paused, closed (expriy only implicit)
+        bytes filter; // required conditions for applications to be considered for collateralization by this bundle
+        uint256 capitalAmount; // net investment capital amount (<= balance)
+        uint256 lockedAmount; // capital amount linked to collateralizaion of non-closed policies (<= balance)
+        uint256 balanceAmount; // total amount of funds: net investment capital + net premiums - payouts
+        Timestamp createdAt;
+        Timestamp expiredAt; // no new policies
+        Timestamp closedAt;
+        Blocknumber updatedIn;
+    }
+}
+
+interface IBundleModule is IBundle {
+
+    function createBundleInfo(
+        NftId bundleNftId,
+        NftId poolNftId,
+        uint256 amount, 
+        uint256 lifetime, 
+        bytes calldata filter
+    ) external;
+
+    function setBundleInfo(BundleInfo memory bundleInfo) external;
+    function collateralizePolicy(NftId bundleNftId, NftId policyNftId, uint256 amount) external;
+    function releasePolicy(NftId bundleNftId, NftId policyNftId) external returns(uint256 collateralAmount);
+
+    function getBundleInfo(NftId bundleNftId) external view returns(BundleInfo memory bundleInfo);
+
+    // repeat registry linked signature
+    function getRegistry() external view returns (IRegistry registry);
+
+    // repeat service linked signatures to avoid linearization issues
+    function getProductService() external returns(IProductService);
+    function getPoolService() external returns(IPoolService);
+}

package/contracts/instance/module/component/ComponentModule.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 {IRegistry} from "../../../registry/IRegistry.sol";
+import {IInstance} from "../../IInstance.sol";
+
+import {LifecycleModule} from "../lifecycle/LifecycleModule.sol";
+import {IComponent, IComponentModule} from "./IComponent.sol";
+import {IComponentOwnerService} from "../../service/IComponentOwnerService.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";
+// import {IBaseComponent} from "../../../components/IBaseComponent.sol";
+
+abstract contract ComponentModule is
+    IComponentModule
+{
+    using NftIdLib for NftId;
+
+    mapping(NftId nftId => ComponentInfo info) private _componentInfo;
+    NftId[] private _nftIds;
+
+    mapping(ObjectType cType => bytes32 role) private _componentOwnerRole;
+
+    // TODO maybe move this to Instance contract as internal variable?
+    LifecycleModule private _lifecycleModule;
+
+    modifier onlyComponentOwnerService() {
+        require(
+            msg.sender == address(this.getComponentOwnerService()),
+            "ERROR:CMP-001:NOT_OWNER_SERVICE"
+        );
+        _;
+    }
+
+    constructor() {
+        address componentAddress = address(this);
+        _lifecycleModule = LifecycleModule(componentAddress);
+    }
+
+    function registerComponent(
+        NftId nftId,
+        ObjectType objectType,
+        IERC20Metadata token
+    ) external override onlyComponentOwnerService {
+
+        // create component info
+        _componentInfo[nftId] = ComponentInfo(
+            nftId,
+            _lifecycleModule.getInitialState(objectType),
+            token
+        );
+
+        _nftIds.push(nftId);
+
+        // TODO add logging
+    }
+
+    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().getObjectInfo(nftId).objectType;
+        _lifecycleModule.checkAndLogTransition(
+            nftId,
+            objectType,
+            _componentInfo[nftId].state,
+            info.state
+        );
+        _componentInfo[nftId] = info;
+    }
+
+    function getComponentCount()
+        external
+        view
+        override
+        returns (uint256 numberOfCompnents)
+    {
+        return _nftIds.length;
+    }
+
+    function getComponentId(
+        uint256 idx
+    ) external view override returns (NftId componentNftId) {
+        return _nftIds[idx];
+    }
+
+    function getComponentInfo(
+        NftId nftId
+    ) external view override returns (ComponentInfo memory) {
+        return _componentInfo[nftId];
+    }
+}

package/contracts/instance/module/component/IComponent.sol

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+
+import {IRegistry} from "../../../registry/IRegistry.sol";
+import {IInstance} from "../../IInstance.sol";
+import {StateId} from "../../../types/StateId.sol";
+import {NftId} from "../../../types/NftId.sol";
+import {ObjectType} from "../../../types/ObjectType.sol";
+import {RoleId} from "../../../types/RoleId.sol";
+import {Fee} from "../../../types/Fee.sol";
+import {UFixed} from "../../../types/UFixed.sol";
+
+import {IComponentOwnerService} from "../../service/IComponentOwnerService.sol";
+// import {IComponentBase} from "../../../components/IComponentBase.sol";
+
+interface IComponent {
+    // component dynamic info (static info kept in registry)
+    struct ComponentInfo {
+        NftId nftId;
+        StateId state;
+        IERC20Metadata token;
+    }
+}
+
+interface IComponentModule is IComponent {
+    function getRegistry() external view returns (IRegistry registry);
+
+    function registerComponent(
+        NftId nftId,
+        ObjectType objectType,
+        IERC20Metadata token
+    ) external;
+
+    function setComponentInfo(
+        ComponentInfo memory info
+    ) external returns (NftId componentNftId);
+
+    function getComponentInfo(
+        NftId nftId
+    ) external view returns (ComponentInfo memory info);
+
+    function getComponentCount() external view returns (uint256 numberOfCompnents);
+
+    function getComponentId(uint256 idx) external view returns (NftId nftId);
+
+    // repeat service linked signaturea to avoid linearization issues
+    function getComponentOwnerService() external view returns(IComponentOwnerService);
+
+    function hasRole(RoleId role, address member) external view returns (bool);
+}

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

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ObjectType} from "../../../types/ObjectType.sol";
+import {StateId, toStateId, zeroStateId} from "../../../types/StateId.sol";
+import {NftId} from "../../../types/NftId.sol";
+
+interface ILifecycle {
+    event LogComponentStateChanged(
+        NftId nftId,
+        ObjectType objectType,
+        StateId fromStateId,
+        StateId toStateId
+    );
+    event LogBundleStateChanged(
+        NftId nftId,
+        StateId fromStateId,
+        StateId toStateId
+    );
+    event LogPolicyStateChanged(
+        NftId nftId,
+        StateId fromStateId,
+        StateId toStateId
+    );
+    // event LogClaimStateChanged(NftId nftId, ClaimId claimId, StateId fromStateId, StateId toStateId);
+    // event LogPayoutStateChanged(NftId nftId, ClaimId claimId, PayoutId payoutId, StateId fromStateId, StateId toStateId);
+
+    error ErrorNoLifecycle(NftId nftId, ObjectType objectType);
+    error ErrorInvalidStateTransition(
+        NftId nftId,
+        ObjectType objectType,
+        StateId fromStateId,
+        StateId toStateId
+    );
+}
+
+interface ILifecycleModule is ILifecycle {
+    function getInitialState(
+        ObjectType objectType
+    ) external view returns (StateId);
+
+    function isValidTransition(
+        ObjectType objectType,
+        StateId fromId,
+        StateId toId
+    ) external view returns (bool);
+}

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);
+}