@etherisc/gif-next 0.0.2-b81ff84-640 → 0.0.2-b97394c-442

package/contracts/instance/base/ComponentServiceBase.sol

@@ -4,23 +4,108 @@ pragma solidity ^0.8.19;
 import {IRegistry} from "../../registry/IRegistry.sol";
 import {IRegistryService} from "../../registry/IRegistryService.sol";
 import {IInstance} from "../../instance/IInstance.sol";
-import {ObjectType, INSTANCE, PRODUCT, POOL} from "../../types/ObjectType.sol";
+import {ObjectType, INSTANCE, PRODUCT, POOL, DISTRIBUTION, ORACLE} from "../../types/ObjectType.sol";
 import {NftId, NftIdLib} from "../../types/NftId.sol";
+import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../types/RoleId.sol";
 
+import {BaseComponent} from "../../components/BaseComponent.sol";
+import {Product} from "../../components/Product.sol";
+import {INftOwnable} from "../../shared/INftOwnable.sol";
 import {Service} from "../../shared/Service.sol";
+import {InstanceService} from "../InstanceService.sol";
 import {Version, VersionPart, VersionLib} from "../../types/Version.sol";
 
 abstract contract ComponentServiceBase is Service {
 
-    constructor(
-        address registry,
-        NftId registryNftId,
+    error ExpectedRoleMissing(RoleId expected, address caller);
+    error ComponentTypeInvalid(ObjectType componentType);
+
+    mapping (ObjectType => RoleId) internal _objectTypeToExpectedRole;
+
+    /// @dev modifier to check if caller has a role on the instance the component is registered in
+    modifier onlyComponentOwnerRole(address componentAddress) {
+        BaseComponent component = BaseComponent(componentAddress);
+        ObjectType objectType = _getObjectType(component);
+        RoleId expectedRole = _objectTypeToExpectedRole[objectType];
+
+        address componentOwner = msg.sender;
+        INftOwnable nftOwnable = INftOwnable(address(component.getInstance()));
+        if(! getInstanceService().hasRole(componentOwner, expectedRole, nftOwnable.getNftId())) {
+            revert ExpectedRoleMissing(expectedRole, componentOwner);
+        }
+        _;
+    }
+
+    /// @dev modifier to check if caller is a registered service
+    modifier onlyService() {
+        address caller = msg.sender;
+        require(getRegistry().isRegisteredService(caller), "ERROR_NOT_SERVICE");
+        _;
+    }
+
+    function _initializeService(
+        address registry, 
         address initialOwner
     )
+        internal
+        override
     {
-        _initializeService(registry, initialOwner);
+        super._initializeService(registry, initialOwner);
+        _objectTypeToExpectedRole[PRODUCT()] = PRODUCT_OWNER_ROLE();
+        _objectTypeToExpectedRole[POOL()] = POOL_OWNER_ROLE();
+        _objectTypeToExpectedRole[DISTRIBUTION()] = DISTRIBUTION_OWNER_ROLE();
+        _objectTypeToExpectedRole[ORACLE()] = ORACLE_OWNER_ROLE();
+    }
+
+    function getInstanceService() public view returns (InstanceService) {
+        return InstanceService(getRegistry().getServiceAddress("InstanceService", getMajorVersion()));
     }
 
+    function register(address componentAddress) 
+        external 
+        onlyComponentOwnerRole(componentAddress)
+        returns (NftId componentNftId)
+    {
+        address componentOwner = msg.sender;
+        BaseComponent component = BaseComponent(componentAddress);
+        ObjectType objectType = _getObjectType(component);
+        IRegistryService registryService = getRegistryService();
+
+        IRegistry.ObjectInfo memory objInfo;
+        bytes memory initialObjData;
+
+        if (objectType == DISTRIBUTION()) {
+            (objInfo, initialObjData) = registryService.registerDistribution(component, componentOwner);
+        } else if (objectType == PRODUCT()) {
+            (objInfo, initialObjData) = registryService.registerProduct(component, componentOwner);
+        } else if (objectType == POOL()) {
+            (objInfo, initialObjData) = registryService.registerPool(component, componentOwner);
+        // TODO: implement this for oracle - currently missing in registry
+        // } else if (objectType == ORACLE()) {
+        //     (objInfo, initialObjData) = registryService.registerOracle(component, componentOwner);
+        } else {
+            revert ComponentTypeInvalid(objectType);
+        }
+
+        componentNftId = objInfo.nftId;
+        {
+            IInstance instance = _getInstance(objInfo);
+            _finalizeComponentRegistration(componentNftId, initialObjData, instance);
+        }
+    }
+
+    function _finalizeComponentRegistration(NftId componentNftId, bytes memory initialObjData, IInstance instance) internal virtual;
+
+    function _getObjectType(BaseComponent component) internal view returns (ObjectType) {
+        (IRegistry.ObjectInfo memory compInitialInfo, )  = component.getInitialInfo();
+        return compInitialInfo.objectType;
+    }
+    
+    function _getInstance(IRegistry.ObjectInfo memory compObjInfo) internal view returns (IInstance) {
+        IRegistry registry = getRegistry();
+        IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(compObjInfo.parentNftId);
+        return IInstance(instanceInfo.objectAddress);
+    }
 
     function _getAndVerifyComponentInfoAndInstance(
         ObjectType objectType
@@ -32,7 +117,7 @@ abstract contract ComponentServiceBase is Service {
             IInstance instance
         )
     {
-        NftId componentNftId = getRegistry().getNftId(msg.sender);
+        NftId componentNftId = _registry.getNftId(msg.sender);
         require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
 
         info = getRegistry().getObjectInfo(componentNftId);

package/contracts/instance/module/IBundle.sol

@@ -13,6 +13,7 @@ interface IBundle {
         uint256 capitalAmount; // net investment capital + net premiums - payouts
         uint256 lockedAmount; // capital amount linked to collateralizaion of non-closed policies (<= balance)
         uint256 balanceAmount; // total amount of funds: capitalAmount + fees (balance >= captial)
+        uint256 lifetime;
         Timestamp expiredAt; // no new policies
         Timestamp closedAt; // no open policies, locked amount = 0
     }

package/contracts/instance/module/ISetup.sol

@@ -5,6 +5,7 @@ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IER
 
 import {Fee} from "../../types/Fee.sol";
 import {NftId} from "../../types/NftId.sol";
+import {LibNftIdSet} from "../../types/NftIdSet.sol";
 import {UFixed} from "../../types/UFixed.sol";
 import {TokenHandler} from "../../shared/TokenHandler.sol";
 
@@ -20,6 +21,8 @@ interface ISetup {
         Fee poolFee; // pool fee on net premium
         Fee stakingFee; // pool fee on staked capital from investor
         Fee performanceFee; // pool fee on profits from capital investors
+        bool isIntercepting; // intercepts nft transfers (for products)
+        address wallet;
     }
 
     struct DistributionSetupInfo {
@@ -38,6 +41,7 @@ interface ISetup {
         Fee stakingFee; // pool fee on staked capital from investor
         Fee performanceFee; // pool fee on profits from capital investors
         bool isIntercepting; // intercepts nft transfers (for bundles)
+        bool isConfirmingApplication; // confirms applications before they are underwritten
         address wallet;
     }
 }

package/contracts/instance/service/DistributionService.sol

@@ -0,0 +1,88 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../registry/IRegistry.sol";
+import {IRegistryService} from "../../registry/IRegistryService.sol";
+import {IInstance} from "../../instance/IInstance.sol";
+import {InstanceReader} from "../../instance/InstanceReader.sol";
+import {ISetup} from "../../instance/module/ISetup.sol";
+import {ITreasury} from "../../instance/module/ITreasury.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 {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 {IDistributionService} from "./IDistributionService.sol";
+import {Distribution} from "../../components/Distribution.sol";
+import {InstanceService} from "../InstanceService.sol";
+import {Instance} from "../Instance.sol";
+import {INftOwnable} from "../../shared/INftOwnable.sol";
+
+string constant DISTRIBUTION_SERVICE_NAME = "DistributionService";
+
+contract DistributionService is
+    ComponentServiceBase,
+    IDistributionService
+{
+    using NftIdLib for NftId;
+
+    string public constant NAME = "DistributionService";
+
+    address internal _registryAddress;
+    
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        initializer
+        virtual override
+    {
+        address initialOwner = address(0);
+        (_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(IService).interfaceId);
+        _registerInterface(type(IDistributionService).interfaceId);
+    }
+
+
+    function getName() public pure override(IService, Service) returns(string memory name) {
+        return NAME;
+    }
+
+    function _finalizeComponentRegistration(NftId componentNftId, bytes memory initialObjData, IInstance instance) internal override {
+        ISetup.DistributionSetupInfo memory initialSetup = abi.decode(
+            initialObjData,
+            (ISetup.DistributionSetupInfo)
+        );
+        instance.createDistributionSetup(componentNftId, initialSetup);
+    }
+
+    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());
+    }
+}

package/contracts/instance/service/DistributionServiceManager.sol

@@ -0,0 +1,54 @@
+// 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 {VersionLib} from "../../types/Version.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));
+
+        Registry registry = Registry(registryAddress);
+        address registryServiceAddress = registry.getServiceAddress("RegistryService", VersionLib.toVersion(3, 0, 0).toMajorPart());
+        RegistryService registryService = RegistryService(registryServiceAddress);
+        // TODO this must have a role or own nft to register service
+        //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));
+
+        // implies that after this constructor call only upgrade functionality is available
+        _isDeployed = true;
+    }
+
+    //--- view functions ----------------------------------------------------//
+    function getDistributionService()
+        external
+        view
+        returns (DistributionService distributionService)
+    {
+        return _distributionService;
+    }
+
+}

package/contracts/instance/service/IPoolService.sol

@@ -3,9 +3,13 @@ pragma solidity ^0.8.19;
 
 import {NftId} from "../../types/NftId.sol";
 import {Fee} from "../../types/Fee.sol";
+import {StateId} from "../../types/StateId.sol";
 import {IService} from "../../shared/IService.sol";
+import {IBundle} from "../module/IBundle.sol";
 
 interface IPoolService is IService {
+    error ErrorIPoolServiceInsufficientAllowance(address bundleOwner, address tokenHandlerAddress, uint256 amount);
+
     function setFees(
         Fee memory poolFee,
         Fee memory stakingFee,
@@ -25,6 +29,8 @@ interface IPoolService is IService {
         Fee memory fee
     ) external;
 
+    function updateBundle(NftId instanceNftId, NftId bundleNftId, IBundle.BundleInfo memory bundleInfo, StateId state) external;
+
     // function fundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
 
     // function defundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);

package/contracts/instance/service/IProductService.sol

@@ -13,6 +13,9 @@ import {UFixed} from "../../types/UFixed.sol";
 import {Fee} from "../../types/Fee.sol";
 
 interface IProductService is IService {
+
+    error ErrorIProductServiceInsufficientAllowance(address customer, address tokenHandlerAddress, uint256 amount);
+    
     function setFees(
         Fee memory productFee,
         Fee memory processingFee
@@ -24,15 +27,15 @@ interface IProductService is IService {
     ) external;
 
 
-    function setRiskInfo(
+    function updateRisk(
         RiskId riskId,
-        IRisk.RiskInfo memory data
+        bytes memory data
     ) external;
 
 
     function updateRiskState(
         RiskId riskId,
-        StateId state
+        StateId newState
     ) external;
 
 

package/contracts/instance/service/PoolService.sol

@@ -0,0 +1,204 @@
+// 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 {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 {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 {zeroTimestamp} from "../../types/Timestamp.sol";
+
+import {IService} from "../../shared/IService.sol";
+import {Service} from "../../shared/Service.sol";
+import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
+import {IPoolService} from "./IPoolService.sol";
+import {IRegistryService} from "../../registry/IRegistryService.sol";
+import {InstanceService} from "../InstanceService.sol";
+import {InstanceReader} from "../InstanceReader.sol";
+
+string constant POOL_SERVICE_NAME = "PoolService";
+
+contract PoolService is 
+    ComponentServiceBase, 
+    IPoolService 
+{
+    using NftIdLib for NftId;
+
+    string public constant NAME = "PoolService";
+
+    address internal _registryAddress;
+
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        initializer
+        virtual override
+    {
+        address initialOwner = address(0);
+        (_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(IService).interfaceId);
+        _registerInterface(type(IPoolService).interfaceId);
+    }
+
+    function getName() public pure override(Service, IService) returns(string memory name) {
+        return NAME;
+    }
+
+    function _finalizeComponentRegistration(NftId componentNftId, bytes memory initialObjData, IInstance instance) internal override {
+        ISetup.PoolSetupInfo memory initialSetup = abi.decode(
+            initialObjData,
+            (ISetup.PoolSetupInfo)
+        );
+        instance.createPoolSetup(componentNftId, initialSetup);
+    }
+
+    function setFees(
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    )
+        external
+        override
+    {
+        (IRegistry.ObjectInfo memory poolInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        InstanceReader instanceReader = instance.getInstanceReader();
+        NftId poolNftId = poolInfo.nftId;
+
+        ISetup.PoolSetupInfo memory poolSetupInfo = instanceReader.getPoolSetupInfo(poolNftId);
+        poolSetupInfo.poolFee = poolFee;
+        poolSetupInfo.stakingFee = stakingFee;
+        poolSetupInfo.performanceFee = performanceFee;
+        
+        instance.updatePoolSetup(poolNftId, poolSetupInfo, KEEP_STATE());
+    }
+
+    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);
+
+        // TODO add bundle to pool in instance
+        
+        _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 _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/PoolServiceManager.sol

@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IVersionable} from "../../shared/IVersionable.sol";
+import {ProxyManager} from "../../shared/ProxyManager.sol";
+import {PoolService} from "./PoolService.sol";
+import {Registry} from "../../registry/Registry.sol";
+import {RegistryService} from "../../registry/RegistryService.sol";
+import {VersionLib} from "../../types/Version.sol";
+
+contract PoolServiceManager is ProxyManager {
+
+    PoolService private _poolService;
+
+    /// @dev initializes proxy manager with pool service implementation 
+    constructor(
+        address registryAddress
+    )
+        ProxyManager()
+    {
+        PoolService poolSrv = new PoolService();
+        bytes memory data = abi.encode(registryAddress, address(this));
+        IVersionable versionable = deploy(
+            address(poolSrv), 
+            data);
+
+        _poolService = PoolService(address(versionable));
+
+        Registry registry = Registry(registryAddress);
+        address registryServiceAddress = registry.getServiceAddress("RegistryService", VersionLib.toVersion(3, 0, 0).toMajorPart());
+        RegistryService registryService = RegistryService(registryServiceAddress);
+        // TODO this must have a role or own nft to register service
+        //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));
+
+        // implies that after this constructor call only upgrade functionality is available
+        _isDeployed = true;
+    }
+
+    //--- view functions ----------------------------------------------------//
+    function getPoolService()
+        external
+        view
+        returns (PoolService poolService)
+    {
+        return _poolService;
+    }
+
+}