@etherisc/gif-next 0.0.2-b643f7e-850 → 0.0.2-b7cfc95-746

package/contracts/instance/base/IInstanceBase.sol

@@ -6,7 +6,6 @@ import {StateId} from "../../types/StateId.sol";
 
 import {IKeyValueStore} from "./IKeyValueStore.sol";
 
-import {IComponentOwnerService} from "../service/IComponentOwnerService.sol";
 import {IDistributionService} from "../service/IDistributionService.sol";
 import {IProductService} from "../service/IProductService.sol";
 import {IPoolService} from "../service/IPoolService.sol";
@@ -16,7 +15,6 @@ interface IInstanceBase {
     function updateState(Key32 key, StateId state) external;
     function getState(Key32 key) external view returns (StateId state);
 
-    function getComponentOwnerService() external view returns(IComponentOwnerService);
     function getDistributionService() external view returns(IDistributionService);
     function getProductService() external view returns(IProductService service);
     function getPoolService() external view returns(IPoolService service);

package/contracts/instance/module/IAccess.sol

@@ -5,34 +5,44 @@ import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet
 import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
 
 import {RoleId} from "../../types/RoleId.sol";
+import {Timestamp} from "../../types/Timestamp.sol";
 
 interface IAccess {
+
     struct RoleInfo {
         ShortString name;
         bool isCustom;
+        bool isLocked;
+        Timestamp createdAt;
+        Timestamp updatedAt;
     }
 
     struct TargetInfo {
         ShortString name;
         bool isCustom;
+        bool isLocked;
+        Timestamp createdAt;
+        Timestamp updatedAt;
     }
 
-    error ErrorTargetAddressZero();
-    error ErrorTargetAlreadyExists(address target, ShortString name);
-    error ErrorTargetDoesNotExist(address target);
-    error ErrorTargetNameEmpty(address target);
-    error ErrorTargetNameExists(address target, address existingTarget, ShortString name);
-
-    error ErrorRoleIdInvalid(RoleId roleId);
-    error ErrorRoleIdTooBig(RoleId roleId);
-    error ErrorRoleIdTooSmall(RoleId roleId);
-    error ErrorRoleIdAlreadyExists(RoleId roleId, ShortString name);
-    error ErrorRoleIdNotActive(RoleId roleId);
-    error ErrorRoleNameEmpty(RoleId roleId);
-    error ErrorRoleNameNotUnique(RoleId roleId, ShortString name);
-    error ErrorRoleInvalidUpdate(RoleId roleId, bool isCustom);
-    error ErrorGrantNonexstentRole(RoleId roleId);
-    error ErrorRevokeNonexstentRole(RoleId roleId);
-    error ErrorRenounceNonexstentRole(RoleId roleId);
+    error ErrorIAccessRoleIdInvalid(RoleId roleId);
+    error ErrorIAccessRoleIdTooBig(RoleId roleId);
+    error ErrorIAccessRoleIdTooSmall(RoleId roleId);
+    error ErrorIAccessRoleIdAlreadyExists(RoleId roleId, ShortString name);
+    error ErrorIAccessRoleIdNotActive(RoleId roleId);
+    error ErrorIAccessRoleNameEmpty(RoleId roleId);
+    error ErrorIAccessRoleNameNotUnique(RoleId roleId, ShortString name);
+    error ErrorIAccessRoleInvalidUpdate(RoleId roleId, bool isCustom);
+    error ErrorIAccessRoleIsCustomIsImmutable(RoleId roleId, bool isCustom, bool isCustomExisting);
+    error ErrorIAccessSetLockedForNonexstentRole(RoleId roleId);
+    error ErrorIAccessGrantNonexstentRole(RoleId roleId);
+    error ErrorIAccessRevokeNonexstentRole(RoleId roleId); 
+    error ErrorIAccessRenounceNonexstentRole(RoleId roleId);
 
+    error ErrorIAccessTargetAddressZero();
+    error ErrorIAccessTargetAlreadyExists(address target, ShortString name);
+    error ErrorIAccessTargetNameEmpty(address target);
+    error ErrorIAccessTargetNameExists(address target, address existingTarget, ShortString name);
+    error ErrorIAccessSetLockedForNonexstentTarget(address target);
+    error ErrorIAccessTargetLocked(address target);
 }

package/contracts/instance/service/BundleService.sol

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

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

@@ -2,17 +2,16 @@
 pragma solidity ^0.8.19;
 
 import {IRegistry} from "../../registry/IRegistry.sol";
-import {IRegistryService} from "../../registry/IRegistryService.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 {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 {ObjectType, DISTRIBUTION} from "../../types/ObjectType.sol";
 import {Version, VersionLib} from "../../types/Version.sol";
 
 import {IVersionable} from "../../shared/IVersionable.sol";
@@ -20,23 +19,18 @@ 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 {ComponentService} from "../base/ComponentService.sol";
 import {InstanceService} from "../InstanceService.sol";
-import {Instance} from "../Instance.sol";
-import {INftOwnable} from "../../shared/INftOwnable.sol";
+import {IDistributionService} from "./IDistributionService.sol";
+import {IComponent} from "../../components/IComponent.sol";
 
-string constant DISTRIBUTION_SERVICE_NAME = "DistributionService";
 
 contract DistributionService is
-    ComponentServiceBase,
+    ComponentService,
     IDistributionService
 {
     using NftIdLib for NftId;
 
-    string public constant NAME = "DistributionService";
-
     address internal _registryAddress;
     
     function _initialize(
@@ -47,27 +41,60 @@ contract DistributionService is
         initializer
         virtual override
     {
-        address initialOwner = address(0);
-        (_registryAddress, initialOwner) = abi.decode(data, (address, address));
+        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);
+        _initializeService(registryAddress, owner);
 
-        _registerInterface(type(IService).interfaceId);
         _registerInterface(type(IDistributionService).interfaceId);
     }
 
+    function getDomain() public pure override(Service, IService) returns(ObjectType) {
+        return DISTRIBUTION();
+    }
 
-    function getName() public pure override(IService, Service) returns(string memory name) {
-        return NAME;
+    function register(address distributionAddress) 
+        external
+        returns(NftId distributionNftId)
+    {
+        (
+            IComponent distribution,
+            address owner,
+            IInstance instance,
+            NftId instanceNftId
+        ) = _checkComponentForRegistration(
+            distributionAddress,
+            DISTRIBUTION(),
+            DISTRIBUTION_OWNER_ROLE());
+
+        (
+            IRegistry.ObjectInfo memory distributionInfo,
+            bytes memory data
+        ) = getRegistryService().registerDistribution(distribution, owner);
+        distribution.linkToRegisteredNftId();
+        distributionNftId = distributionInfo.nftId;
+
+        (
+            string memory name, 
+            ISetup.DistributionSetupInfo memory initialSetup
+        ) = _decodeAndVerifyDistributionData(data);
+        instance.createDistributionSetup(distributionNftId, initialSetup);
+
+        getInstanceService().createTarget(instanceNftId, distributionAddress, name);
     }
 
-    function _finalizeComponentRegistration(NftId componentNftId, bytes memory initialObjData, IInstance instance) internal override {
-        ISetup.DistributionSetupInfo memory initialSetup = abi.decode(
-            initialObjData,
-            (ISetup.DistributionSetupInfo)
+    function _decodeAndVerifyDistributionData(bytes memory data)
+        internal 
+        returns(string memory name, ISetup.DistributionSetupInfo memory setup)
+    {
+        (name, setup) = abi.decode(
+            data,
+            (string, ISetup.DistributionSetupInfo)
         );
-        instance.createDistributionSetup(componentNftId, initialSetup);
+
+        // TODO add checks if applicable 
     }
 
     function setFees(

package/contracts/instance/service/DistributionServiceManager.sol

@@ -6,7 +6,7 @@ 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";
+import {REGISTRY} from "../../types/ObjectType.sol";
 
 contract DistributionServiceManager is ProxyManager {
 
@@ -25,11 +25,11 @@ contract DistributionServiceManager is ProxyManager {
             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
+        
+        // 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
@@ -37,9 +37,6 @@ contract DistributionServiceManager is ProxyManager {
         //_linkToNftOwnable(
         //    address(registryAddress),
         //    address(_distributionService));
-
-        // implies that after this constructor call only upgrade functionality is available
-        _isDeployed = true;
     }
 
     //--- view functions ----------------------------------------------------//

package/contracts/instance/service/IBundleService.sol

@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: Apache-2.0
+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";
+import {IInstance} from "../../instance/IInstance.sol";
+
+interface IBundleService is IService {
+    error ErrorIBundleServiceInsufficientAllowance(address bundleOwner, address tokenHandlerAddress, uint256 amount);
+
+    function createBundle(
+        address owner,
+        Fee memory fee, 
+        uint256 amount,
+        uint256 lifetime, 
+        bytes calldata filter
+    ) external returns(NftId bundleNftId);
+
+    function setBundleFee(
+        NftId bundleNftId,
+        Fee memory fee
+    ) external;
+
+    function updateBundle(NftId instanceNftId, NftId bundleNftId, IBundle.BundleInfo memory bundleInfo, StateId state) external;
+
+    function underwritePolicy(IInstance instanceNftId, NftId policyNftId, NftId bundleNftId, uint256 collateralAmount, uint256 netPremium) external;
+
+    function increaseBalance(IInstance instance, NftId bundleNftId,  uint256 amount) external;
+
+    function closePolicy(IInstance instance, NftId policyNftId, NftId bundleNftId, uint256 collateralAmount) external;
+
+    // function fundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
+
+    // function defundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
+
+    function lockBundle(NftId bundleNftId) external;
+
+    function unlockBundle(NftId bundleNftId) external;
+
+    // function closeBundle(NftId bundleNftId) external;
+}