@etherisc/gif-next 0.0.2-a6faeb6-912 → 0.0.2-a7954cc-097

package/contracts/instance/base/ComponentServiceBase.sol

@@ -4,37 +4,21 @@ 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, 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 {IAccess} from "../module/IAccess.sol";
+import {ObjectType, INSTANCE, REGISTRY} from "../../types/ObjectType.sol";
+import {NftId} from "../../types/NftId.sol";
+import {RoleId} 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";
+import {InstanceAccessManager} from "../InstanceAccessManager.sol";
 
 abstract contract ComponentServiceBase is Service {
 
+    error ErrorComponentServiceBaseComponentLocked(address componentAddress);
     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() {
@@ -43,72 +27,34 @@ abstract contract ComponentServiceBase is Service {
         _;
     }
 
-    function _initializeService(
-        address registry, 
-        address initialOwner
-    )
-        internal
-        override
-    {
-        super._initializeService(registry, initialOwner);
-        _objectTypeToExpectedRole[PRODUCT()] = PRODUCT_OWNER_ROLE();
-        _objectTypeToExpectedRole[POOL()] = POOL_OWNER_ROLE();
-        _objectTypeToExpectedRole[DISTRIBUTION()] = DISTRIBUTION_OWNER_ROLE();
-        _objectTypeToExpectedRole[ORACLE()] = ORACLE_OWNER_ROLE();
+    // view functions
+
+    function getRegistryService() public view virtual returns (IRegistryService) {
+        address service = getRegistry().getServiceAddress(REGISTRY(), getMajorVersion());
+        return IRegistryService(service);
     }
 
     function getInstanceService() public view returns (InstanceService) {
-        return InstanceService(getRegistry().getServiceAddress("InstanceService", getMajorVersion()));
+        address service = getRegistry().getServiceAddress(INSTANCE(), getMajorVersion());
+        return InstanceService(service);
     }
 
-    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);
-        }
+    // internal view functions
 
-        componentNftId = objInfo.nftId;
-        {
-            IInstance instance = _getInstance(objInfo);
-            _finalizeComponentRegistration(componentNftId, initialObjData, instance);
-        }
+    function _getInstance(NftId instanceNftId) internal view returns (IInstance) {
+        IRegistry.ObjectInfo memory instanceInfo = getRegistry().getObjectInfo(instanceNftId);
+        return IInstance(instanceInfo.objectAddress);
     }
 
-    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) {
+    function _getInstanceNftId(IRegistry.ObjectInfo memory compObjInfo) internal view returns (NftId) {
         IRegistry registry = getRegistry();
         IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(compObjInfo.parentNftId);
-        return IInstance(instanceInfo.objectAddress);
+        return instanceInfo.nftId;
     }
 
     function _getAndVerifyComponentInfoAndInstance(
-        ObjectType objectType
+        //address component,
+        ObjectType expectedType
     )
         internal
         view
@@ -117,18 +63,20 @@ abstract contract ComponentServiceBase is Service {
             IInstance instance
         )
     {
-        NftId componentNftId = _registry.getNftId(msg.sender);
-        require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
+        IRegistry registry = getRegistry();
+        //TODO redundant check -> just check type
+        //NftId componentNftId = registry.getNftId(component); 
+        //require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
 
-        info = getRegistry().getObjectInfo(componentNftId);
-        require(info.objectType == objectType, "OBJECT_TYPE_INVALID");
+        info = registry.getObjectInfo(msg.sender);
+        require(info.objectType == expectedType, "OBJECT_TYPE_INVALID");
 
-        address instanceAddress = getRegistry().getObjectInfo(info.parentNftId).objectAddress;
+        address instanceAddress = registry.getObjectInfo(info.parentNftId).objectAddress;
         instance = IInstance(instanceAddress);
-    }
 
-    function getRegistryService() public view virtual returns (IRegistryService) {
-        address service = getRegistry().getServiceAddress("RegistryService", getMajorVersion());
-        return IRegistryService(service);
+        InstanceAccessManager accessManager = instance.getInstanceAccessManager();
+        if (accessManager.isTargetLocked(info.objectAddress)) {
+            revert IAccess.ErrorIAccessTargetLocked(info.objectAddress);
+        }
     }
 }

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,260 @@
+// 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/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/ComponentOwnerService.sol

@@ -16,7 +16,7 @@ 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, TOKEN, COMPONENT, PRODUCT, ORACLE, POOL, DISTRIBUTION} from "../../types/ObjectType.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";
@@ -50,8 +50,6 @@ contract ComponentOwnerService is
 
     error CollateralizationLevelIsZero();
 
-    string public constant NAME = "ComponentOwnerService";
-
     modifier onlyRegisteredComponent(IBaseComponent component) {
         NftId nftId = getRegistry().getNftId(address(component));
         require(nftId.gtz(), "ERROR:COS-001:COMPONENT_UNKNOWN");
@@ -68,8 +66,8 @@ contract ComponentOwnerService is
         _registerInterface(type(IComponentOwnerService).interfaceId);
     }
 
-    function getName() public pure override(IService, Service) returns(string memory name) {
-        return NAME;
+    function getDomain() public pure override(Service, IService) returns(ObjectType) {
+        return COMPONENT();
     }
 
     function getRoleForType(
@@ -90,7 +88,7 @@ contract ComponentOwnerService is
     }
 
     function getRegistryService() public view virtual returns (IRegistryService) {
-        address service = getRegistry().getServiceAddress("RegistryService", getMajorVersion());
+        address service = getRegistry().getServiceAddress(REGISTRY(), getMajorVersion());
         return IRegistryService(service);
     }