@etherisc/gif-next 0.0.2-2a59cd5-352 → 0.0.2-2aebd8d-365

package/contracts/instance/service/BundleService.sol

@@ -1,298 +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 {ComponentService} from "../base/ComponentService.sol";
-import {IBundleService} from "./IBundleService.sol";
-import {IRegistryService} from "../../registry/IRegistryService.sol";
-import {InstanceService} from "../InstanceService.sol";
-import {InstanceReader} from "../InstanceReader.sol";
-
-string constant BUNDLE_SERVICE_NAME = "BundleService";
-
-contract BundleService is 
-    ComponentService, 
-    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 lockCollateral(
-        IInstance instance,
-        NftId policyNftId, 
-        NftId bundleNftId, 
-        uint256 collateralAmount,
-        uint256 netPremiumAmount
-    ) 
-        external
-        onlyService
-        returns (
-            IBundle.BundleInfo memory bundleInfo
-        )
-    {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-
-        // TODO add validation
-
-        // lock collateral
-        bundleInfo.lockedAmount += collateralAmount;
-        bundleInfo.balanceAmount += netPremiumAmount;
-
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-        
-        linkPolicy(instance, policyNftId);
-    }
-
-    function increaseBalance(IInstance instance,
-        NftId bundleNftId, 
-        uint256 amount
-    ) 
-        external
-        onlyService 
-    {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-
-        bundleInfo.balanceAmount += amount;
-
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-    }
-
-    function closePolicy(IInstance instance,
-        NftId policyNftId, 
-        NftId bundleNftId, 
-        uint256 collateralAmount
-    ) 
-        external
-        onlyService 
-    {
-        InstanceReader instanceReader = instance.getInstanceReader();
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-
-        // lock collateral
-        bundleInfo.lockedAmount -= collateralAmount;
-
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-        
-        unlinkPolicy(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 ( TimestampLib.blockTimestamp() < policyInfo.expiredAt
-            && 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/BundleServiceManager.sol

@@ -1,51 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {ProxyManager} from "../../shared/ProxyManager.sol";
-import {BundleService} from "./BundleService.sol";
-import {Registry} from "../../registry/Registry.sol";
-import {RegistryService} from "../../registry/RegistryService.sol";
-import {ObjectType, REGISTRY} from "../../types/ObjectType.sol";
-
-contract BundleServiceManager is ProxyManager {
-
-    BundleService private _bundleService;
-
-    /// @dev initializes proxy manager with pool service implementation 
-    constructor(
-        address registryAddress
-    )
-        ProxyManager()
-    {
-        BundleService bundleSrv = new BundleService();
-        bytes memory data = abi.encode(registryAddress, address(this));
-        IVersionable versionable = deploy(
-            address(bundleSrv), 
-            data);
-
-        _bundleService = BundleService(address(versionable));
-
-        // TODO `this` must have a role or own nft to register service
-        //Registry registry = Registry(registryAddress);
-        //address registryServiceAddress = registry.getServiceAddress(REGISTRY(), _bundleService.getMajorVersion());
-        //RegistryService registryService = RegistryService(registryServiceAddress); 
-        //registryService.registerService(_poolService);
-        
-        // TODO no nft to link yet
-        // link ownership of instance service manager ot nft owner of instance service
-        //_linkToNftOwnable(
-        //    address(registryAddress),
-        //    address(_poolService));
-    }
-
-    //--- view functions ----------------------------------------------------//
-    function getBundleService()
-        external
-        view
-        returns (BundleService)
-    {
-        return _bundleService;
-    }
-
-}

package/contracts/instance/service/DistributionService.sol

@@ -1,282 +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, zeroNftId} 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, INSTANCE, DISTRIBUTION, DISTRIBUTOR} 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 {ComponentService} from "../base/ComponentService.sol";
-import {InstanceService} from "../InstanceService.sol";
-import {IComponent} from "../../components/IComponent.sol";
-import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
-import {IDistributionService} from "./IDistributionService.sol";
-
-import {UFixed} from "../../types/UFixed.sol";
-import {DistributorType, DistributorTypeLib} from "../../types/DistributorType.sol";
-import {ReferralId, ReferralStatus, ReferralLib} from "../../types/Referral.sol";
-import {Timestamp, TimestampLib, zeroTimestamp} from "../../types/Timestamp.sol";
-import {Key32} from "../../types/Key32.sol";
-import {IDistribution} from "../module/IDistribution.sol";
-
-
-contract DistributionService is
-    ComponentService,
-    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)
-    {
-        (
-            IComponent component,
-            address owner,
-            IInstance instance,
-            NftId instanceNftId
-        ) = _checkComponentForRegistration(
-            distributionAddress,
-            DISTRIBUTION(),
-            DISTRIBUTION_OWNER_ROLE());
-
-        IRegistry.ObjectInfo memory distributionInfo = getRegistryService().registerDistribution(component, owner);
-        IDistributionComponent distribution = IDistributionComponent(distributionAddress);
-        distribution.linkToRegisteredNftId();
-        distributionNftId = distributionInfo.nftId;
-
-        instance.createDistributionSetup(distributionNftId, distribution.getSetupInfo());
-        getInstanceService().createGifTarget(instanceNftId, distributionAddress, distribution.getName());
-        getInstanceService().grantDistributionDefaultPermissions(instanceNftId, distributionAddress, distribution.getName());
-    }
-
-    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());
-    }
-
-    function createDistributorType(
-        string memory name,
-        UFixed minDiscountPercentage,
-        UFixed maxDiscountPercentage,
-        UFixed commissionPercentage,
-        uint32 maxReferralCount,
-        uint32 maxReferralLifetime,
-        bool allowSelfReferrals,
-        bool allowRenewals,
-        bytes memory data
-    )
-        external
-        returns (DistributorType distributorType)
-    {
-        (,NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
-        distributorType = DistributorTypeLib.toDistributorType(distributionNftId, name);
-        Key32 key32 = distributorType.toKey32();
-
-        if(!instance.exists(key32)) {
-            IDistribution.DistributorTypeInfo memory info = IDistribution.DistributorTypeInfo(
-                name,
-                minDiscountPercentage,
-                maxDiscountPercentage,
-                commissionPercentage,
-                maxReferralCount,
-                maxReferralLifetime,
-                allowSelfReferrals,
-                allowRenewals,
-                data);
-
-            instance.createDistributorType(key32, info);
-        }
-    }
-
-    function createDistributor(
-        address distributor,
-        DistributorType distributorType,
-        bytes memory data
-    ) external returns (NftId distributorNftId)
-    {
-        (, NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
-
-        distributorNftId = getRegistryService().registerDistributor(
-            IRegistry.ObjectInfo(
-                zeroNftId(), 
-                distributionNftId,
-                DISTRIBUTOR(),
-                true, // intercepting property for bundles is defined on pool
-                address(0),
-                distributor,
-                ""
-            ));
-
-        IDistribution.DistributorInfo memory info = IDistribution.DistributorInfo(
-            distributorType,
-            true, // active
-            data);
-
-        instance.createDistributor(distributorNftId, info);
-    }
-
-    function updateDistributorType(
-        NftId distributorNftId,
-        DistributorType distributorType,
-        bytes memory data
-    ) external virtual
-    {
-        (,, IInstance instance) = _getAndVerifyCallingDistribution();
-
-        IDistribution.DistributorInfo memory info = IDistribution.DistributorInfo(
-            distributorType,
-            true, // active
-            data);
-
-        instance.updateDistributor(distributorNftId, info, KEEP_STATE());
-    }
-
-
-    function createReferral(
-        NftId distributorNftId,
-        string memory code,
-        UFixed discountPercentage,
-        uint32 maxReferrals,
-        Timestamp expiryAt,
-        bytes memory data
-    )
-        external
-        virtual
-        returns (ReferralId referralId)
-    {
-        (,NftId distributionNftId, IInstance instance) = _getAndVerifyCallingDistribution();
-        require(bytes(code).length > 0, "ERROR:DSV-030:CODE_INVALID");
-        require(expiryAt > zeroTimestamp(), "ERROR:DSV-031:EXPIRY_AT_ZERO");
-
-        // FIXME: validate input against distributortype (get via nft)
-
-        referralId = ReferralLib.toReferralId(distributionNftId, code);
-        IDistribution.ReferralInfo memory info = IDistribution.ReferralInfo(
-            distributorNftId,
-            code,
-            discountPercentage,
-            maxReferrals,
-            0, // used referrals
-            expiryAt,
-            data
-        );
-
-        instance.createReferral(referralId.toKey32(), info);
-        return referralId;
-    }
-
-    function processSale(
-        ReferralId referralId,
-        uint256 premiumAmount
-    )
-        external
-        virtual
-    {
-        // TODO: fetch referral
-        // TODO: if referral is active, process sale with condiutions of this referral
-        // TODO: if referral is not active, process sale with conditions of distribution component
-        revert("NOT_IMPLEMENTED_YET");
-    }
-
-    function calculateFeeAmount(
-        ReferralId referralId,
-        uint256 premiumAmount
-    )
-        external
-        virtual
-        view 
-        returns (uint256 feeAmount)
-    {
-        revert("NOT_IMPLEMENTED_YET");
-    }
-
-    function _getAndVerifyCallingDistribution()
-        internal
-        view
-        returns(
-            address distributionAddress,
-            NftId distributionNftId,
-            IInstance instance
-        )
-    {
-        ObjectType objectType;
-        (
-            distributionAddress,
-            distributionNftId,
-            objectType,
-            instance
-        ) = _getAndVerifyCaller();
-
-        require(objectType == DISTRIBUTION(), "ERROR:PRS-031:CALLER_NOT_DISTRUBUTION");
-    }
-
-    function _getAndVerifyCaller()
-        internal
-        view
-        returns(
-            address objectAddress,
-            NftId objectNftId,
-            ObjectType objectType,
-            IInstance instance
-        )
-    {
-        objectAddress = msg.sender;
-        objectNftId = getRegistry().getNftId(objectAddress);
-        require(objectNftId.gtz(), "ERROR:SRV-030:CALLER_UNKNOWN");
-        IRegistry.ObjectInfo memory info = getRegistry().getObjectInfo(objectNftId);
-        objectType = info.objectType;
-
-        IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(info.parentNftId);
-        require(parentInfo.objectType == INSTANCE(), "ERROR:SRV-031:PARENT_NOT_INSTANCE");
-        instance = IInstance(parentInfo.objectAddress);
-    }
-
-}

package/contracts/instance/service/DistributionServiceManager.sol

@@ -1,51 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {ProxyManager} from "../../shared/ProxyManager.sol";
-import {DistributionService} from "./DistributionService.sol";
-import {Registry} from "../../registry/Registry.sol";
-import {RegistryService} from "../../registry/RegistryService.sol";
-import {REGISTRY} from "../../types/ObjectType.sol";
-
-contract DistributionServiceManager is ProxyManager {
-
-    DistributionService private _distributionService;
-
-    /// @dev initializes proxy manager with distribution service implementation and deploys instance
-    constructor(
-        address registryAddress
-    )
-        ProxyManager()
-    {
-        DistributionService distSrv = new DistributionService();
-        bytes memory data = abi.encode(registryAddress, address(this));
-        IVersionable versionable = deploy(
-            address(distSrv), 
-            data);
-
-        _distributionService = DistributionService(address(versionable));
-        
-        // TODO `thi` must have a role or own nft to register service
-        //Registry registry = Registry(registryAddress);
-        //address registryServiceAddress = registry.getServiceAddress(REGISTRY(), _distributionService.getMajorVersion());
-        //RegistryService registryService = RegistryService(registryServiceAddress);
-        //registryService.registerService(_distributionService);
-        
-        // TODO no nft to link yet
-        // link ownership of instance service manager ot nft owner of instance service
-        //_linkToNftOwnable(
-        //    address(registryAddress),
-        //    address(_distributionService));
-    }
-
-    //--- view functions ----------------------------------------------------//
-    function getDistributionService()
-        external
-        view
-        returns (DistributionService distributionService)
-    {
-        return _distributionService;
-    }
-
-}