@etherisc/gif-next 0.0.2-299fe4a-464 → 0.0.2-2a0a7d0-893

package/contracts/experiment/statemachine/README.md

@@ -1,112 +0,0 @@
-# State Machines
-
-Most GIF objects have a life cycle defined by a state machine.
-
-For each object type the set of possible states is defined together with its initial state and the set of valid state transitions.
-
-## Object Types without States
-
-* Protocol
-* Chains
-* Registries (both chain and main registry)
-
-## Object Types with States
-
-* Tokens
-* Instances
-* Products
-* Oracles
-* Pools
-* Bundles
-* Policies
-* Claim (non-NFT)
-* Payout (non-NFT)
-
-### Simple State Machine
-
-Valid states
-
-* Active (initial state)
-* Paused
-* Archived (final state)
-
-Valid state transitions:
-
-* Active -> Paused
-* Paused -> Active
-* Paused -> Archived
-
-
-Candidate object types for simple state machine
-
-* Token
-* Instance
-* Product
-* Oracle
-* Pool
-
-To discuss: 
-
-* Archived is final state
-* What mechanism should exist to revert an unintended transition to 'Archived' state. Should there be such a mechanism?
-* What mechanism should exist when the NFT of such an object is burned prematurely. Should there be such a mechanism
-
-### Bundle State Machine
-
-Valid states
-
-* Active (initial state)
-* Paused
-* Expired (implicit state)
-* Closed (final state)
-
-Expired is not an explicit state. 
-A bundle is expired for block.timestamp >= expiredAt
-
-### Policy State Machine
-
-Valid states
-
-* Applied (initial state)
-* Revoked (final state)
-* Declined (final state)
-* Active
-* Expired (implicit state)
-* Closed (final state)
-
-Expired is not an explicit state. 
-A policy is expired for block.timestamp >= expiredAt
-
-To discuss: 
-
-* Should 'Closed' be less explicit using a closedAt state variable? 
-* Or even more lighweight? ie. block.timestamp >= expiredAt and no open claims
-
-Valid state transitions:
-
-* Applied -> Revoked
-* Applied -> Declined
-* Applied -> Active
-* Active -> Closed (needs to be expired)
-
-### Claim State Machine
-
-Valid states
-* Applied (initial state)
-* Confirmed
-* Declined (final state)
-* Closed (final state)
-
-Valid state transitions:
-* Applied -> Confirmed
-* Applied -> Declined
-* Confirmed -> Closed
-
-### Payout State Machine
-
-Valid states
-* Expected
-* PaidOut
-
-Valid state transitions:
-* Expected -> PaidOut

package/contracts/instance/IInstanceLinked.sol

@@ -1,8 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IInstance} from "./IInstance.sol";
-
-interface IInstanceLinked {
-    function getInstance() external view returns (IInstance instance);
-}

package/contracts/instance/IServiceLinked.sol

@@ -1,12 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
-import {IProductService} from "./service/IProductService.sol";
-import {IPoolService} from "./service/IPoolService.sol";
-
-interface IServiceLinked {
-    function getComponentOwnerService() external view returns(IComponentOwnerService service);
-    function getProductService() external view returns(IProductService service);
-    function getPoolService() external view returns(IPoolService service);
-}

package/contracts/instance/InstanceBase.sol

@@ -1,74 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Versionable} from "../shared/Versionable.sol";
-import {Registerable} from "../shared/Registerable.sol";
-// import {IRegistry} from "../registry/IRegistry.sol";
-
-// import {IInstance} from "./IInstance.sol";
-import {ObjectType, INSTANCE} from "../types/ObjectType.sol";
-import {NftId} from "../types/NftId.sol";
-import {Version, VersionPart, toVersion, toVersionPart} from "../types/Version.sol";
-
-import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
-import {IProductService} from "./service/IProductService.sol";
-import {IPoolService} from "./service/IPoolService.sol";
-
-import {IServiceLinked} from "./IServiceLinked.sol";
-import {IInstance} from "./IInstance.sol";
-
-abstract contract InstanceBase is
-    Versionable,
-    Registerable,
-    IServiceLinked
-{
-    IComponentOwnerService internal _componentOwnerService;
-    IProductService internal _productService;
-    IPoolService internal _poolService;
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        Registerable(registry, registryNftId)
-        Versionable()
-    {
-        _registerInterface(type(IInstance).interfaceId);
-        _linkToServicesInRegistry();
-    }
-
-    // from versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override
-        returns(Version)
-    {
-        return toVersion(
-            toVersionPart(3),
-            toVersionPart(0),
-            toVersionPart(0));
-    }
-
-    // from registerable
-    function getType() external pure override returns (ObjectType objectType) {
-        return INSTANCE();
-    }
-
-
-    // internal / private functions
-    function _linkToServicesInRegistry() internal {
-        VersionPart majorVersion = getVersion().toMajorPart();
-        _componentOwnerService = IComponentOwnerService(_getAndCheck("ComponentOwnerService", majorVersion));
-        _productService = IProductService(_getAndCheck("ProductService", majorVersion));
-        _poolService = IPoolService(_getAndCheck("PoolService", majorVersion));
-    }
-
-    function _getAndCheck(string memory serviceName, VersionPart majorVersion) internal view returns (address serviceAddress) {
-        serviceAddress = _registry.getServiceAddress(serviceName, majorVersion);
-        require(
-            serviceAddress != address(0),
-            "ERROR:INS-001:NOT_REGISTERED"
-        );
-    }
-}

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