@etherisc/gif-next 0.0.2-dc7e4cb-141 → 0.0.2-dd8c542-531

package/contracts/instance/module/access/Access.sol

@@ -1,149 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-// role admin handling of oz doesn't fit nft ownability
-// import {AccessControlEnumerable} from "@openzeppelin/contracts/access/AccessControlEnumerable.sol";
-import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
-
-import {RoleId, toRoleId} from "../../../types/RoleId.sol";
-import {DISTRIBUTOR_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../../../types/RoleId.sol";
-import {DISTRIBUTOR_OWNER_ROLE_NAME, ORACLE_OWNER_ROLE_NAME, POOL_OWNER_ROLE_NAME, PRODUCT_OWNER_ROLE_NAME} from "../../../types/RoleId.sol";
-import {IAccessModule} from "./IAccess.sol";
-
-abstract contract AccessModule is IAccessModule {
-
-    using EnumerableSet for EnumerableSet.AddressSet;
-
-    mapping(RoleId role => RoleInfo info) private _info;
-    RoleId[] private _roles;
-
-    mapping(RoleId role => mapping(address member => bool isMember))
-        private _isRoleMember;
-    mapping(RoleId role => EnumerableSet.AddressSet members) private _roleMembers;
-
-    modifier onlyAccessOwner() {
-        require(
-            msg.sender == this.getOwner(),
-            "ERROR:ACS-001:NOT_OWNER");
-        _;
-    }
-
-    modifier onlyExistingRole(RoleId role) {
-        require(
-            _info[role].id == role,
-            "ERROR:ACS-002:ROLE_NOT_EXISTING");
-        _;
-    }
-
-    constructor() {
-        _createRole(DISTRIBUTOR_OWNER_ROLE(), DISTRIBUTOR_OWNER_ROLE_NAME());
-        _createRole(ORACLE_OWNER_ROLE(), ORACLE_OWNER_ROLE_NAME());
-        _createRole(POOL_OWNER_ROLE(), POOL_OWNER_ROLE_NAME());
-        _createRole(PRODUCT_OWNER_ROLE(), PRODUCT_OWNER_ROLE_NAME());
-    }
-
-    function createRole(
-        string memory roleName
-    ) public override onlyAccessOwner returns (RoleId role) {
-        role = toRoleId(roleName);
-        require(
-            !roleExists(role),
-            "ERROR:ACS-010:ROLE_ALREADY_EXISTS");
-        
-        _createRole(role, roleName);
-    }
-
-    function setRoleState(RoleId role, bool active) external override onlyExistingRole(role) onlyAccessOwner {
-        RoleInfo memory info = _info[role];
-        info.isActive = active;
-        _setRoleInfo(info);
-
-        emit LogAccessRoleStateSet(role, active);
-    }
-
-    function grantRole(
-        RoleId role,
-        address member
-    ) external override onlyExistingRole(role) onlyAccessOwner {
-        require(_info[role].isActive, "ERROR:ACS-040:ROLE_NOT_ACTIVE");
-
-        _isRoleMember[role][member] = true;
-        _roleMembers[role].add(member);
-
-        emit LogAccessRoleGranted(role, member, _isRoleMember[role][member]);
-    }
-
-    function revokeRole(
-        RoleId role,
-        address member
-    ) external override onlyExistingRole(role) onlyAccessOwner {
-        delete _isRoleMember[role][member];
-        _roleMembers[role].remove(member);
-
-        emit LogAccessRoleGranted(role, member, false);
-    }
-
-    function roleExists(RoleId role) public view virtual override returns (bool) {
-        return _info[role].id == role;
-    }
-
-    function hasRole(
-        RoleId role,
-        address member
-    ) public view virtual override returns (bool) {
-        return _isRoleMember[role][member];
-    }
-
-    function getRoleId(string memory roleName) external pure override returns (RoleId role) {
-        return toRoleId(roleName);
-    }
-
-    function getRoleInfo(
-        RoleId role
-    ) external view override returns (RoleInfo memory info) {
-        return _info[role];
-    }
-
-    function getRole(
-        uint256 idx
-    ) external view override returns (RoleId role) {
-        return _roles[idx];
-    }
-
-    function getRoleCount() external view override returns (uint256 roles) {
-        return _roles.length;
-    }
-
-    function getRoleMemberCount(
-        RoleId role
-    ) public view override returns (uint256 roleMembers) {
-        return _roleMembers[role].length();
-    }
-
-    function getRoleMember(
-        RoleId role,
-        uint256 idx
-    ) public view override returns (address roleMembers) {
-        return _roleMembers[role].at(idx);
-    }
-
-    function _createRole(
-        RoleId role,
-        string memory roleName
-    ) internal {
-        RoleInfo memory info = RoleInfo(role, roleName, true);
-        _setRoleInfo(info);
-
-        emit LogAccessRoleCreated(role, roleName);
-    }
-
-    function _setRoleInfo(
-        RoleInfo memory info
-    ) internal {
-        RoleId role = info.id;
-        _info[role] = info;
-        if(!roleExists(role)) {
-            _roles.push(role);
-        }
-    }
-}

package/contracts/instance/module/access/IAccess.sol

@@ -1,53 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {RoleId} from "../../../types/RoleId.sol";
-
-interface IAccess {
-    struct RoleInfo {
-        RoleId id;
-        string name;
-        bool isActive;
-    }
-}
-
-interface IAccessModule is
-    IAccess
-{
-    event LogAccessRoleCreated(RoleId role, string roleName);
-    event LogAccessRoleStateSet(RoleId role, bool active);
-    event LogAccessRoleGranted(RoleId role, address member, bool isMember);
-
-    function createRole(string memory roleName) external returns (RoleId role);
-
-    function setRoleState(RoleId role, bool active) external;
-
-    function grantRole(RoleId role, address member) external;
-
-    function revokeRole(RoleId role, address member) external;
-
-    function roleExists(RoleId role) external view returns (bool);
-
-    function hasRole(RoleId role, address member) external view returns (bool);
-
-    function getRoleCount() external view returns (uint256 roles);
-
-    function getRole(uint256 idx) external view returns (RoleId role);
-
-    function getRoleId(string memory roleName) external pure returns (RoleId role);
-
-    function getRoleInfo(
-        RoleId role
-    ) external view returns (RoleInfo memory info);
-
-    function getRoleMemberCount(
-        RoleId role
-    ) external view returns (uint256 roleMembers);
-
-    function getRoleMember(
-        RoleId role,
-        uint256 idx
-    ) external view returns (address roleMember);
-
-    function getOwner() external view returns (address owner);
-}

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

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

@@ -1,53 +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 {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/compensation/CompensationModule.sol

@@ -1,8 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ICompensationModule} from "./ICompensation.sol";
-
-contract CompensationModule is ICompensationModule {
-    
-}

package/contracts/instance/module/compensation/ICompensation.sol

@@ -1,10 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-interface ICompensation {
-
-}
-
-interface ICompensationModule is ICompensation {
-    
-}

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

@@ -1,103 +0,0 @@
-// 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} from "../../../types/Fee.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

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