@etherisc/gif-next 0.0.2-fe88ad7-208 → 0.0.2-ff282a4-523

package/contracts/instance/service/BundleService.sol

@@ -1,260 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Pool} from "../../components/Pool.sol";
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {IBundle} from "../../instance/module/IBundle.sol";
-import {TokenHandler} from "../../instance/module/ITreasury.sol";
-import {ISetup} from "../module/ISetup.sol";
-import {IPolicy} from "../module/IPolicy.sol";
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-import {INftOwnable} from "../../shared/INftOwnable.sol";
-
-import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {ObjectType, POOL, BUNDLE} from "../../types/ObjectType.sol";
-import {POOL_OWNER_ROLE, RoleId} from "../../types/RoleId.sol";
-import {Fee, FeeLib} from "../../types/Fee.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-import {KEEP_STATE, StateId} from "../../types/StateId.sol";
-import {TimestampLib, zeroTimestamp} from "../../types/Timestamp.sol";
-
-import {IService} from "../../shared/IService.sol";
-import {Service} from "../../shared/Service.sol";
-import {BundleManager} from "../BundleManager.sol";
-import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
-import {IBundleService} from "./IBundleService.sol";
-import {IRegistryService} from "../../registry/IRegistryService.sol";
-import {InstanceService} from "../InstanceService.sol";
-import {InstanceReader} from "../InstanceReader.sol";
-import {IBaseComponent} from "../../components/IBaseComponent.sol";
-
-string constant BUNDLE_SERVICE_NAME = "BundleService";
-
-contract BundleService is 
-    ComponentServiceBase, 
-    IBundleService 
-{
-    using NftIdLib for NftId;
-
-    string public constant NAME = "BundleService";
-
-    address internal _registryAddress;
-
-    function _initialize(
-        address owner, 
-        bytes memory data
-    )
-        internal
-        initializer
-        virtual override
-    {
-        address registryAddress;
-        address initialOwner;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-        // TODO while PoolService is not deployed in PoolServiceManager constructor
-        //      owner is PoolServiceManager deployer
-        _initializeService(registryAddress, owner);
-
-        _registerInterface(type(IBundleService).interfaceId);
-    }
-
-    function getDomain() public pure override(Service, IService) returns(ObjectType) {
-        return BUNDLE();
-    }
-
-    function createBundle(
-        address owner, 
-        Fee memory fee, 
-        uint256 stakingAmount, 
-        uint256 lifetime, 
-        bytes calldata filter
-    )
-        external
-        override
-        returns(NftId bundleNftId)
-    {
-        (IRegistry.ObjectInfo memory info, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        NftId poolNftId = info.nftId;
-
-        IBundle.BundleInfo  memory bundleInfo = IBundle.BundleInfo(
-            poolNftId,
-            fee,
-            filter,
-            stakingAmount,
-            0,
-            stakingAmount,
-            lifetime,
-            zeroTimestamp(),
-            zeroTimestamp()
-        );
-
-        // register bundle with registry
-        bundleNftId = getRegistryService().registerBundle(
-            IRegistry.ObjectInfo(
-                zeroNftId(), 
-                poolNftId,
-                BUNDLE(),
-                false, // intercepting property for bundles is defined on pool
-                address(0),
-                owner,
-                abi.encode(bundleInfo)
-            )
-        );
-
-        // create bundle info in instance
-        instance.createBundle(bundleNftId, bundleInfo);
-
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.add(bundleNftId);
-        
-        _processStakingByTreasury(
-            instanceReader,
-            poolNftId,
-            bundleNftId,
-            stakingAmount);
-
-        // TODO add logging
-    }
-
-    function setBundleFee(
-        NftId bundleNftId,
-        Fee memory fee
-    )
-        external
-        override
-    {
-        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        NftId poolNftId = info.nftId;
-
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-        require(bundleInfo.poolNftId.gtz(), "ERROR:PLS-010:BUNDLE_UNKNOWN");
-        require(poolNftId == bundleInfo.poolNftId, "ERROR:PLS-011:BUNDLE_POOL_MISMATCH");
-
-        bundleInfo.fee = fee;
-
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-    }
-
-    function updateBundle(NftId instanceNftId, NftId bundleNftId, IBundle.BundleInfo memory bundleInfo, StateId state) 
-        external
-        onlyService
-    {
-        IRegistry.ObjectInfo memory instanceInfo = getRegistry().getObjectInfo(instanceNftId);
-        IInstance instance = IInstance(instanceInfo.objectAddress);
-        instance.updateBundle(bundleNftId, bundleInfo, state);
-    } 
-
-    function lockBundle(NftId bundleNftId) 
-        external
-    {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.lock(bundleNftId);
-    }
-
-    function unlockBundle(NftId bundleNftId) 
-        external
-    {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.unlock(bundleNftId);
-    }
-
-    function underwritePolicy(IInstance instance,
-        NftId policyNftId, 
-        NftId bundleNftId, 
-        uint256 collateralAmount,
-        uint256 netPremiumAmount
-    ) 
-        external
-        onlyService 
-    {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-
-        // lock collateral
-        bundleInfo.lockedAmount += collateralAmount;
-        bundleInfo.balanceAmount += netPremiumAmount;
-
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-        
-        linkPolicy(instance, policyNftId);
-    }
-
-    /// @dev links policy to bundle
-    function linkPolicy(IInstance instance, NftId policyNftId) 
-        internal
-        onlyService 
-    {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
-
-        // ensure policy has not yet been activated
-        if (policyInfo.activatedAt.gtz()) {
-            revert BundleManager.ErrorBundleManagerErrorPolicyAlreadyActivated(policyNftId);
-        }
-        
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.linkPolicy(policyNftId);
-    }
-
-        /// @dev unlinks policy from bundle
-    function unlinkPolicy(IInstance instance, NftId policyNftId) 
-        internal
-        onlyService 
-    {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
-
-        // ensure policy has no open claims
-        if (policyInfo.openClaimsCount > 0) {
-            revert BundleManager.ErrorBundleManagerPolicyWithOpenClaims(
-                policyNftId, 
-                policyInfo.openClaimsCount);
-        }
-
-        // ensure policy is closeable
-        if (policyInfo.expiredAt < TimestampLib.blockTimestamp()
-            || policyInfo.payoutAmount < policyInfo.sumInsuredAmount)
-        {
-            revert BundleManager.ErrorBundleManagerPolicyNotCloseable(policyNftId);
-        }
-        
-        BundleManager bundleManager = instance.getBundleManager();
-        bundleManager.unlinkPolicy(policyNftId);
-    }
-
-    function _processStakingByTreasury(
-        InstanceReader instanceReader,
-        NftId poolNftId,
-        NftId bundleNftId,
-        uint256 stakingAmount
-    )
-        internal
-    {
-        // process token transfer(s)
-        if(stakingAmount > 0) {
-            ISetup.PoolSetupInfo memory poolInfo = instanceReader.getPoolSetupInfo(poolNftId);
-            TokenHandler tokenHandler = poolInfo.tokenHandler;
-            address bundleOwner = getRegistry().ownerOf(bundleNftId);
-            Fee memory stakingFee = poolInfo.stakingFee;
-
-            tokenHandler.transfer(
-                bundleOwner,
-                poolInfo.wallet,
-                stakingAmount
-            );
-
-
-            if (! FeeLib.feeIsZero(stakingFee)) {
-                (uint256 stakingFeeAmount, uint256 netAmount) = FeeLib.calculateFee(stakingFee, stakingAmount);
-                // TODO: track staking fees in pool's state (issue #177)
-            }
-        }
-    }
-}

package/contracts/instance/service/ComponentOwnerService.sol

@@ -1,315 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../IInstance.sol";
-
-import {ITreasury} from "../module/ITreasury.sol";
-// import {TreasuryModule} from "../module/TreasuryModule.sol";
-import {ISetup} from "../module/ISetup.sol";
-import {IBaseComponent} from "../../components/IBaseComponent.sol";
-import {IPoolComponent} from "../../components/IPoolComponent.sol";
-import {IKeyValueStore} from "../../instance/base/IKeyValueStore.sol";
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../types/RoleId.sol";
-import {ObjectType, REGISTRY, TOKEN, COMPONENT, PRODUCT, ORACLE, POOL, DISTRIBUTION} from "../../types/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED} from "../../types/StateId.sol";
-import {Key32} from "../../types/Key32.sol";
-import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {Fee} from "../../types/Fee.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-import {UFixed, UFixedLib} from "../../types/UFixed.sol";
-
-import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
-import {IPoolComponent} from "../../components/IPoolComponent.sol";
-import {IProductComponent} from "../../components/IProductComponent.sol";
-import {IService} from "../../shared/IService.sol";
-import {IComponentOwnerService} from "./IComponentOwnerService.sol";
-import {Service} from "../../shared/Service.sol";
-// import {IPool, IPoolModule} from "../module/IPoolModule.sol";
-
-import {IRegistryService} from "../../registry/IRegistryService.sol";
-
-contract ComponentOwnerService is
-    Service,
-    IComponentOwnerService
-{
-    using NftIdLib for NftId;
-
-    error MissingTypeRole();
-    error WalletIsZero();
-    error InvalidToken();
-    error InvalidPool();
-    error InvalidDistribution();
-    error InvalidPoolsInstance();
-    error InvalidDistributionsInstance();
-
-    error CollateralizationLevelIsZero();
-
-    modifier onlyRegisteredComponent(IBaseComponent component) {
-        NftId nftId = getRegistry().getNftId(address(component));
-        require(nftId.gtz(), "ERROR:COS-001:COMPONENT_UNKNOWN");
-        _;
-    }
-
-    constructor(
-        address registry,
-        NftId registryNftId,
-        address initialOwner
-    )
-    {
-        _initializeService(registry, initialOwner);
-        _registerInterface(type(IComponentOwnerService).interfaceId);
-    }
-
-    function getDomain() public pure override(Service, IService) returns(ObjectType) {
-        return COMPONENT();
-    }
-
-    function getRoleForType(
-        ObjectType cType
-    ) public pure override returns (RoleId role) {
-        if (cType == PRODUCT()) {
-            return PRODUCT_OWNER_ROLE();
-        }
-        if (cType == POOL()) {
-            return POOL_OWNER_ROLE();
-        }
-        if (cType == DISTRIBUTION()) {
-            return DISTRIBUTION_OWNER_ROLE();
-        }
-        if (cType == ORACLE()) {
-            return ORACLE_OWNER_ROLE();
-        }
-    }
-
-    function getRegistryService() public view virtual returns (IRegistryService) {
-        address service = getRegistry().getServiceAddress(REGISTRY(), getMajorVersion());
-        return IRegistryService(service);
-    }
-
-    function registerProduct(	
-        IBaseComponent product
-    ) external returns (NftId nftId) {	
-
-        // TODO some info parameters from component and from register may differ -> getObjectInfo() after registration?
-        (
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) = getRegistryService().registerProduct(
-            product,
-            msg.sender);	
-
-        NftId instanceNftId = info.parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        IInstance instance = IInstance(instanceAddress);
-
-        RoleId typeRole = getRoleForType(PRODUCT());
-        // TODO refactor to use access manager infra
-        // if(instance.hasRole(typeRole, msg.sender) == false) {
-        //     revert MissingTypeRole();
-        // }
-        
-        _registerProduct(
-                info.nftId, 
-                instanceNftId,
-                instance,
-                data
-        );
-    }
-
-    function registerPool(	
-        IBaseComponent pool
-    ) external returns (NftId nftId) {	
-
-        // TODO some info parameters from component and from register may differ -> getObjectInfo() after registration?
-        (
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) = getRegistryService().registerPool(
-            pool,
-            msg.sender);	
-
-        NftId instanceNftId = info.parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        IInstance instance = IInstance(instanceAddress);
-
-        RoleId typeRole = getRoleForType(POOL());
-        // TODO refactor to use access manager infra
-        // if(instance.hasRole(typeRole, msg.sender) == false) {
-        //     revert MissingTypeRole();
-        // } 
-
-        _registerPool(
-            info.nftId,
-            instanceNftId,
-            instance,
-            data
-        );
-    }
-
-    function registerDistribution(	
-        IBaseComponent distribution
-    ) external returns (NftId nftId) {	
-
-        // TODO some info parameters from component and from register may differ -> getObjectInfo() after registration?
-        (
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) = getRegistryService().registerDistribution(
-            distribution,
-            msg.sender);	
-
-        NftId instanceNftId = info.parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        IInstance instance = IInstance(instanceAddress);
-
-        RoleId typeRole = getRoleForType(DISTRIBUTION());
-        // TODO refactor to use access manager infra
-        // if(instance.hasRole(typeRole, msg.sender) == false) {
-        //     revert MissingTypeRole();
-        // }
-    }
-
-    function lock(
-        IBaseComponent component
-    ) external override onlyRegisteredComponent(component) {
-        // TODO use msg.sender to get component and get instance via registered parent nft id
-        IInstance instance = component.getInstance();
-        NftId nftId = component.getNftId();
-        Key32 key = nftId.toKey32(COMPONENT());
-        // instance.updateState(key, PAUSED());
-    }
-
-    function unlock(
-        IBaseComponent component
-    ) external override onlyRegisteredComponent(component) {
-        // TODO use msg.sender to get component and get instance via registered parent nft id
-        IInstance instance = component.getInstance();
-        NftId nftId = component.getNftId();
-        Key32 key = nftId.toKey32(COMPONENT());
-        // instance.updateState(key, ACTIVE());
-    }
-
-    // Internals
-
-    function _registerProduct(
-        NftId nftId, 
-        NftId instanceNftId,
-        IInstance instance,
-        bytes memory data
-    )
-        internal
-    {
-        // TODO change treasury info to product setup info
-        (ISetup.ProductSetupInfo memory info) = abi.decode(data, (ISetup.ProductSetupInfo));
-        // (
-        //     ITreasury.TreasuryInfo memory info,
-        //     address wallet
-        // )  = abi.decode(data, (ITreasury.TreasuryInfo, address));
-
-        // IRegistry _registry = getRegistry();
-
-        // if(wallet == address(0)) {
-        //     revert WalletIsZero();
-        // }
-
-        // IRegistry.ObjectInfo memory tokenInfo = _registry.getObjectInfo(address(info.token));
-
-        // if(tokenInfo.objectType != TOKEN()) {
-        //     revert InvalidToken();
-        // } 
-
-        // IRegistry.ObjectInfo memory poolInfo = _registry.getObjectInfo(info.poolNftId);
-
-        // if(poolInfo.objectType != POOL()) {
-        //     revert InvalidPool();
-        // }
-
-        // if(poolInfo.parentNftId != instanceNftId) {
-        //     revert InvalidPoolsInstance();
-        // }
-        // // TODO pool have the same token
-        // //ITreasury.PoolSetup memory poolSetup = instance.getPoolSetup(info.poolNftId);
-        // //require(tokenInfo.objectAddress == address(poolSetup.token), "ERROR:COS-018:PRODUCT_POOL_TOKEN_MISMATCH");
-        // // TODO pool is not linked
-
-        // IRegistry.ObjectInfo memory distributionInfo = _registry.getObjectInfo(info.distributionNftId);
-
-        // if(distributionInfo.objectType != DISTRIBUTION()) {
-        //     revert  InvalidDistribution();
-        // } 
-
-        // if(distributionInfo.parentNftId != instanceNftId) {
-        //     revert InvalidDistributionsInstance();
-        // }
-        // // TODO distribution have the same token
-        // // TODO distribution is not linked
-
-        // // component module
-        // instance.registerComponent(
-        //     nftId,
-        //     info.token,
-        //     wallet // TODO move wallet into TreasuryInfo?
-        // );
-
-        // treasury module
-        instance.createProductSetup(
-            nftId, 
-            info
-        );
-    }
-
-    function _registerPool(
-        NftId nftId,
-        NftId instanceNftId,
-        IInstance instance,
-        bytes memory data
-    )
-        internal
-    {
-        (
-            ISetup.PoolSetupInfo memory info,
-            address wallet,
-            IERC20Metadata token,
-            /*poolFee*/,
-            /*stakingFee*/,
-            /*performanceFee*/
-        )  = abi.decode(data, (ISetup.PoolSetupInfo, address, IERC20Metadata, Fee, Fee, Fee));
-
-        IRegistry _registry = getRegistry();
-
-        if(wallet == address(0)) {
-            revert WalletIsZero();
-        }
-
-        ObjectType tokenType = _registry.getObjectInfo(address(token)).objectType;
-
-        if(tokenType != TOKEN()) {
-            revert InvalidToken();
-        } 
-
-        if(UFixedLib.eqz(info.collateralizationLevel)) { 
-            revert CollateralizationLevelIsZero();
-        }
-
-        // TODO add more validations
-
-        // // component module
-        // instance.registerComponent(
-        //     nftId,
-        //     token,
-        //     wallet
-        // ); 
-
-        // pool module
-        instance.createPoolSetup(
-            nftId, 
-            info
-        );
-    }
-}

package/contracts/instance/service/DistributionService.sol

@@ -1,113 +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 {InstanceAccessManager} from "../InstanceAccessManager.sol";
-import {InstanceReader} from "../../instance/InstanceReader.sol";
-import {ISetup} from "../../instance/module/ISetup.sol";
-
-import {NftId, NftIdLib} from "../../types/NftId.sol";
-import {Fee} from "../../types/Fee.sol";
-import {DISTRIBUTION_OWNER_ROLE} from "../../types/RoleId.sol";
-import {KEEP_STATE} from "../../types/StateId.sol";
-import {ObjectType, DISTRIBUTION} from "../../types/ObjectType.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {IService} from "../../shared/IService.sol";
-import {Service} from "../../shared/Service.sol";
-import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
-import {InstanceService} from "../InstanceService.sol";
-import {IDistributionService} from "./IDistributionService.sol";
-import {IBaseComponent} from "../../components/IBaseComponent.sol";
-
-
-contract DistributionService is
-    ComponentServiceBase,
-    IDistributionService
-{
-    using NftIdLib for NftId;
-
-    address internal _registryAddress;
-    
-    function _initialize(
-        address owner, 
-        bytes memory data
-    )
-        internal
-        initializer
-        virtual override
-    {
-        address initialOwner;
-        address registryAddress;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-        // TODO while DistributionService is not deployed in DistributionServiceManager constructor
-        //      owner is DistributionServiceManager deployer
-        _initializeService(registryAddress, owner);
-
-        _registerInterface(type(IDistributionService).interfaceId);
-    }
-
-    function getDomain() public pure override(Service, IService) returns(ObjectType) {
-        return DISTRIBUTION();
-    }
-
-    function register(address distributionAddress) 
-        external
-        returns(NftId distributionNftId)
-    {
-        address distributionOwner = msg.sender;
-        IBaseComponent distribution = IBaseComponent(distributionAddress);
-
-        IRegistry.ObjectInfo memory info;
-        bytes memory data;
-        (info, data) = getRegistryService().registerDistribution(distribution, distributionOwner);
-
-        IInstance instance = _getInstance(info.parentNftId);
-        InstanceService instanceService = getInstanceService();
-
-        bool hasRole = instanceService.hasRole(
-            distributionOwner, 
-            DISTRIBUTION_OWNER_ROLE(), 
-            address(instance));
-
-        if(!hasRole) {
-            revert ExpectedRoleMissing(DISTRIBUTION_OWNER_ROLE(), distributionOwner);
-        }
-
-        distributionNftId = info.nftId;
-        ISetup.DistributionSetupInfo memory initialSetup = _decodeAndVerifyDistributionSetup(data);
-        instance.createDistributionSetup(distributionNftId, initialSetup);
-
-        instanceService.createTarget(_getInstanceNftId(info), distributionAddress, distribution.getName());
-    }
-
-    function _decodeAndVerifyDistributionSetup(bytes memory data) internal returns(ISetup.DistributionSetupInfo memory setup)
-    {
-        setup = abi.decode(
-            data,
-            (ISetup.DistributionSetupInfo)
-        );
-
-        // TODO add checks if applicable 
-    }
-
-    function setFees(
-        Fee memory distributionFee
-    )
-        external
-        override
-    {
-        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(DISTRIBUTION());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        NftId distributionNftId = info.nftId;
-
-        ISetup.DistributionSetupInfo memory distSetupInfo = instanceReader.getDistributionSetupInfo(distributionNftId);
-        distSetupInfo.distributionFee = distributionFee;
-        
-        instance.updateDistributionSetup(distributionNftId, distSetupInfo, KEEP_STATE());
-    }
-}