@etherisc/gif-next 0.0.2-b9e43cf-870 → 0.0.2-bb1081a-994

package/contracts/instance/InstanceService.sol

@@ -10,7 +10,7 @@ import {IInstanceService} from "./IInstanceService.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {BundleManager} from "./BundleManager.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
 import {ChainNft} from "../registry/ChainNft.sol";
 import {Service} from "../../contracts/shared/Service.sol";
 import {IService} from "../shared/IService.sol";
@@ -28,7 +28,6 @@ contract InstanceService is Service, IInstanceService {
 
     // TODO update to real hash when instance is stable
     bytes32 public constant INSTANCE_CREATION_CODE_HASH = bytes32(0);
-    string public constant NAME = "InstanceService";
 
     modifier onlyInstanceOwner(NftId instanceNftId) {
         IRegistry registry = getRegistry();
@@ -63,25 +62,23 @@ contract InstanceService is Service, IInstanceService {
         address registryAddress = address(registry);
         NftId registryNftId = registry.getNftId(registryAddress);
         address registryServiceAddress = registry.getServiceAddress(REGISTRY(), getMajorVersion());
-        RegistryService registryService = RegistryService(registryServiceAddress);
+        IRegistryService registryService = IRegistryService(registryServiceAddress);
 
         // initially set the authority of the access managar to this (being the instance service). 
         // This will allow the instance service to bootstrap the authorizations of the instance
         // and then transfer the ownership of the access manager to the instance owner once everything is setup
         clonedAccessManager = InstanceAccessManager(Clones.clone(_masterInstanceAccessManager));
-        clonedAccessManager.__InstanceAccessManager_initialize(address(this));
+        clonedAccessManager.initialize(address(this));
 
         clonedInstance = Instance(Clones.clone(_masterInstance));
         clonedInstance.initialize(address(clonedAccessManager), registryAddress, registryNftId, msg.sender);
-        ( IRegistry.ObjectInfo memory info, ) = registryService.registerInstance(clonedInstance);
-        clonedInstanceNftId = info.nftId;
         
         clonedInstanceReader = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-        clonedInstanceReader.initialize(registryAddress, clonedInstanceNftId);
+        clonedInstanceReader.initialize(registryAddress, address(clonedInstance));
         clonedInstance.setInstanceReader(clonedInstanceReader);
 
         clonedBundleManager = BundleManager(Clones.clone(_masterInstanceBundleManager));
-        clonedBundleManager.initialize(address(clonedAccessManager), registryAddress, clonedInstanceNftId);
+        clonedBundleManager.initialize(address(clonedAccessManager), registryAddress, address(clonedInstance));
         clonedInstance.setBundleManager(clonedBundleManager);
 
         // TODO amend setters with instance specific , policy manager ...
@@ -93,6 +90,10 @@ contract InstanceService is Service, IInstanceService {
         clonedAccessManager.grantRole(ADMIN_ROLE(), instanceOwner);
         clonedAccessManager.revokeRole(ADMIN_ROLE(), address(this));
 
+        IRegistry.ObjectInfo memory info = registryService.registerInstance(clonedInstance, instanceOwner);
+        clonedInstanceNftId = info.nftId;
+        // clonedInstance.linkToRegisteredNftId();
+
         emit LogInstanceCloned(address(clonedAccessManager), address(clonedInstance), address(clonedInstanceReader), clonedInstanceNftId);
     }
 
@@ -219,7 +220,15 @@ contract InstanceService is Service, IInstanceService {
             INSTANCE_SERVICE_ROLE());
     }
 
-    function setMasterInstance(address accessManagerAddress, address instanceAddress, address instanceReaderAddress, address bundleManagerAddress) external onlyOwner {
+    function setAndRegisterMasterInstance(
+        address accessManagerAddress, 
+        address instanceAddress, 
+        address instanceReaderAddress, 
+        address bundleManagerAddress) 
+            external 
+            onlyOwner 
+            returns(NftId masterInstanceNftId)
+    {
         require(_masterInstanceAccessManager == address(0), "ERROR:CRD-001:ACCESS_MANAGER_MASTER_ALREADY_SET");
         require(_masterInstance == address(0), "ERROR:CRD-002:INSTANCE_MASTER_ALREADY_SET");
         require(_masterInstanceBundleManager == address(0), "ERROR:CRD-004:BUNDLE_MANAGER_MASTER_ALREADY_SET");
@@ -229,18 +238,25 @@ contract InstanceService is Service, IInstanceService {
         require (instanceReaderAddress != address(0), "ERROR:CRD-007:INSTANCE_READER_ZERO");
         require (bundleManagerAddress != address(0), "ERROR:CRD-008:BUNDLE_MANAGER_ZERO");
 
-        Instance instance = Instance(instanceAddress);
+        IInstance instance = IInstance(instanceAddress);
         InstanceReader instanceReader = InstanceReader(instanceReaderAddress);
         BundleManager bundleManager = BundleManager(bundleManagerAddress);
 
         require(instance.authority() == accessManagerAddress, "ERROR:CRD-009:INSTANCE_AUTHORITY_MISMATCH");
-        require(instanceReader.getInstanceNftId() == instance.getNftId(), "ERROR:CRD-010:INSTANCE_READER_INSTANCE_MISMATCH");
-        require(bundleManager.getInstanceNftId() == instance.getNftId(), "ERROR:CRD-011:BUNDLE_MANAGER_INSTANCE_MISMATCH");
+        require(instanceReader.getInstance() == instance, "ERROR:CRD-010:INSTANCE_READER_INSTANCE_MISMATCH");
+        require(bundleManager.getInstance() == instance, "ERROR:CRD-011:BUNDLE_MANAGER_INSTANCE_MISMATCH");
 
         _masterInstanceAccessManager = accessManagerAddress;
         _masterInstance = instanceAddress;
         _masterInstanceReader = instanceReaderAddress;
         _masterInstanceBundleManager = bundleManagerAddress;
+        
+        IRegistryService registryService = IRegistryService(getRegistry().getServiceAddress(REGISTRY(), getMajorVersion()));
+        IInstance masterInstance = IInstance(_masterInstance);
+        IRegistry.ObjectInfo memory info = registryService.registerInstance(masterInstance, getOwner());
+        masterInstanceNftId = info.nftId;
+
+        // masterInstance.linkToRegisteredNftId();
     }
 
     function setMasterInstanceReader(address instanceReaderAddress) external onlyOwner {
@@ -249,11 +265,12 @@ contract InstanceService is Service, IInstanceService {
         require(instanceReaderAddress != _masterInstanceReader, "ERROR:CRD-014:INSTANCE_READER_MASTER_SAME_AS_NEW");
 
         InstanceReader instanceReader = InstanceReader(instanceReaderAddress);
-        require(instanceReader.getInstanceNftId() == Instance(_masterInstance).getNftId(), "ERROR:CRD-015:INSTANCE_READER_INSTANCE_MISMATCH");
+        require(instanceReader.getInstance() == IInstance(_masterInstance), "ERROR:CRD-015:INSTANCE_READER_INSTANCE_MISMATCH");
 
         _masterInstanceReader = instanceReaderAddress;
     }
 
+    // TODO access restriction
     function upgradeInstanceReader(NftId instanceNftId) external {
         IRegistry registry = getRegistry();
         IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
@@ -265,7 +282,7 @@ contract InstanceService is Service, IInstanceService {
         }
         
         InstanceReader upgradedInstanceReaderClone = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-        upgradedInstanceReaderClone.initialize(address(registry), instanceNftId);
+        upgradedInstanceReaderClone.initialize(address(registry), address(instance));
         instance.setInstanceReader(upgradedInstanceReaderClone);
     }
 

package/contracts/instance/ObjectManager.sol

@@ -14,49 +14,32 @@ contract ObjectManager is
     Cloneable
 {
 
-    event LogObjectManagerInitialized(NftId instanceNftId, address instanceReader);
+    event LogObjectManagerInitialized(address instance);
 
     error ErrorObjectManagerNftIdInvalid(NftId instanceNftId);
     error ErrorObjectManagerAlreadyAdded(NftId componentNftId, NftId objectNftId);
 
     mapping(NftId compnentNftId => LibNftIdSet.Set objects) internal _activeObjects;
     mapping(NftId compnentNftId => LibNftIdSet.Set objects) internal _allObjects;
-    NftId internal _instanceNftId;
-    InstanceReader internal _instanceReader;
-
-    constructor() Cloneable() {
-        _instanceReader = InstanceReader(address(0));
-    }
+    IInstance internal _instance; // store instance address -> more flexible, instance may not be registered during ObjectManager initialization
 
     /// @dev call to initialize MUST be made in the same transaction as cloning of the contract
     function initialize(
         address authority,
         address registry,
-        NftId instanceNftId
+        address instance
     )
         external 
     {
         initialize(authority, registry);
 
-        // check/handle instance nft id/instance reader
-        IRegistry.ObjectInfo memory instanceInfo = _registry.getObjectInfo(instanceNftId);
-        if (instanceInfo.objectType != INSTANCE()) {
-            revert ErrorObjectManagerNftIdInvalid(instanceNftId);
-        }
-
-        IInstance instance = IInstance(instanceInfo.objectAddress);
-        _instanceReader = instance.getInstanceReader();
-        _instanceNftId = instanceNftId;
+        _instance = IInstance(instance);
         
-        emit LogObjectManagerInitialized(instanceNftId, address(_instanceReader));
-    }
-
-    function getInstanceReader() external view returns (InstanceReader) {
-        return _instanceReader;
+        emit LogObjectManagerInitialized(instance);
     }
 
-    function getInstanceNftId() external view returns (NftId) {
-        return _instanceNftId;
+    function getInstance() external view returns (IInstance) {
+        return _instance;
     }
 
     function _add(NftId componentNftId, NftId objectNftId) internal {

package/contracts/instance/base/ComponentService.sol

@@ -0,0 +1,134 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IComponent} from "../../components/IComponent.sol";
+import {IRegistry} from "../../registry/IRegistry.sol";
+import {IRegistryService} from "../../registry/IRegistryService.sol";
+import {IInstance} from "../../instance/IInstance.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 {Service} from "../../shared/Service.sol";
+import {InstanceService} from "../InstanceService.sol";
+import {InstanceAccessManager} from "../InstanceAccessManager.sol";
+
+abstract contract ComponentService is Service {
+
+    error ErrorComponentServiceAlreadyRegistered(address component, NftId nftId);
+    error ErrorComponentServiceNotComponent(address component);
+    error ErrorComponentServiceInvalidType(address component, ObjectType requiredType, ObjectType componentType);
+    error ErrorComponentServiceSenderNotOwner(address component, address initialOwner, address sender);
+    error ErrorComponentServiceExpectedRoleMissing(NftId instanceNftId, RoleId requiredRole, address sender);
+    error ErrorComponentServiceComponentLocked(address component);
+
+    /// @dev modifier to check if caller is a registered service
+    modifier onlyService() {
+        address caller = msg.sender;
+        require(getRegistry().isRegisteredService(caller), "ERROR_NOT_SERVICE");
+        _;
+    }
+
+    // view functions
+
+    function getRegistryService() public view virtual returns (IRegistryService) {
+        address service = getRegistry().getServiceAddress(REGISTRY(), getMajorVersion());
+        return IRegistryService(service);
+    }
+
+    function getInstanceService() public view returns (InstanceService) {
+        address service = getRegistry().getServiceAddress(INSTANCE(), getMajorVersion());
+        return InstanceService(service);
+    }
+
+    // internal functions
+    function _checkComponentForRegistration(
+        address componentAddress,
+        ObjectType requiredType,
+        RoleId requiredRole
+    )
+        internal
+        view
+        returns (
+            IComponent component,
+            address owner,
+            IInstance instance,
+            NftId instanceNftId
+        )
+    {
+        // component may only be registerd by initial owner of component
+        owner = msg.sender;
+
+        // check component has not already been registerd
+        NftId compoentNftId = _registry.getNftId(componentAddress);
+        if(compoentNftId.gtz()) {
+            revert ErrorComponentServiceAlreadyRegistered(componentAddress, compoentNftId);
+        }
+
+        // check this is a component
+        component = IComponent(componentAddress);
+        if(!component.supportsInterface(type(IComponent).interfaceId)) {
+            revert ErrorComponentServiceNotComponent(componentAddress);
+        }
+
+        // check component is of required type
+        IRegistry.ObjectInfo memory componentInfo = component.getInitialInfo();
+        if(componentInfo.objectType != requiredType) {
+            revert ErrorComponentServiceInvalidType(componentAddress, requiredType, componentInfo.objectType);
+        }
+
+        // check msg.sender is component owner
+        address initialOwner = componentInfo.initialOwner;
+        if(owner != initialOwner) {
+            revert ErrorComponentServiceSenderNotOwner(componentAddress, componentInfo.initialOwner, owner);
+        }
+
+        // check instance has assigned required role to owner
+        instanceNftId = componentInfo.parentNftId;
+        instance = _getInstance(instanceNftId);
+        bool hasRole = getInstanceService().hasRole(
+            owner, 
+            requiredRole, 
+            address(instance));
+
+        if(!hasRole) {
+            revert ErrorComponentServiceExpectedRoleMissing(instanceNftId, requiredRole, owner);
+        }
+    }
+
+    // internal view functions
+
+    function _getInstance(NftId instanceNftId) internal view returns (IInstance) {
+        IRegistry.ObjectInfo memory instanceInfo = getRegistry().getObjectInfo(instanceNftId);
+        return IInstance(instanceInfo.objectAddress);
+    }
+
+    function _getAndVerifyComponentInfoAndInstance(
+        //address component,
+        ObjectType expectedType
+    )
+        internal
+        view
+        returns(
+            IRegistry.ObjectInfo memory info, 
+            IInstance instance
+        )
+    {
+        IRegistry registry = getRegistry();
+        //TODO redundant check -> just check type
+        //NftId componentNftId = registry.getNftId(component); 
+        //require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
+
+        info = registry.getObjectInfo(msg.sender);
+        require(info.objectType == expectedType, "OBJECT_TYPE_INVALID");
+
+        address instanceAddress = registry.getObjectInfo(info.parentNftId).objectAddress;
+        instance = IInstance(instanceAddress);
+
+        InstanceAccessManager accessManager = InstanceAccessManager(instance.authority());
+        if (accessManager.isTargetLocked(info.objectAddress)) {
+            revert IAccess.ErrorIAccessTargetLocked(info.objectAddress);
+        }
+    }
+}

package/contracts/instance/module/ISetup.sol

@@ -39,8 +39,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 bundles)
-        bool isConfirmingApplication; // confirms applications before they are underwritten
+        bool isIntercepting; // intercepts nft transfers for bundles
+        bool isVerifyingApplications; // confirms applications before they are underwritten
         address wallet;
     }
 }

package/contracts/instance/service/BundleService.sol

@@ -24,17 +24,16 @@ 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 {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";
-import {IBaseComponent} from "../../components/IBaseComponent.sol";
 
 string constant BUNDLE_SERVICE_NAME = "BundleService";
 
 contract BundleService is 
-    ComponentServiceBase, 
+    ComponentService, 
     IBundleService 
 {
     using NftIdLib for NftId;
@@ -165,17 +164,23 @@ contract BundleService is
         bundleManager.unlock(bundleNftId);
     }
 
-    function underwritePolicy(IInstance instance,
+    function lockCollateral(
+        IInstance instance,
         NftId policyNftId, 
         NftId bundleNftId, 
         uint256 collateralAmount,
         uint256 netPremiumAmount
     ) 
         external
-        onlyService 
+        onlyService
+        returns (
+            IBundle.BundleInfo memory bundleInfo
+        )
     {
         InstanceReader instanceReader = instance.getInstanceReader();
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+        bundleInfo = instanceReader.getBundleInfo(bundleNftId);
+
+        // TODO add validation
 
         // lock collateral
         bundleInfo.lockedAmount += collateralAmount;

package/contracts/instance/service/DistributionService.sol

@@ -19,14 +19,15 @@ 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 {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 {IBaseComponent} from "../../components/IBaseComponent.sol";
 
 
 contract DistributionService is
-    ComponentServiceBase,
+    ComponentService,
     IDistributionService
 {
     using NftIdLib for NftId;
@@ -59,45 +60,30 @@ contract DistributionService is
         external
         returns(NftId distributionNftId)
     {
-        address distributionOwner = msg.sender;
-        IBaseComponent distribution = IBaseComponent(distributionAddress);
-
-        IRegistry.ObjectInfo memory info;
-        bytes memory data;
-        (info, data) = getRegistryService().registerDistribution(distribution, distributionOwner);
-
-        NftId instanceNftId = info.parentNftId;
-        IInstance instance = _getInstance(instanceNftId);
-        InstanceService instanceService = getInstanceService();
-
-        bool hasRole = instanceService.hasRole(
-            distributionOwner, 
-            DISTRIBUTION_OWNER_ROLE(), 
-            address(instance));
-
-        if(!hasRole) {
-            revert ExpectedRoleMissing(DISTRIBUTION_OWNER_ROLE(), distributionOwner);
-        }
-
-        distributionNftId = info.nftId;
-        string memory distributionName;
-        ISetup.DistributionSetupInfo memory initialSetup;
-        (distributionName, initialSetup) = _decodeAndVerifyDistributionData(data);
-        instance.createDistributionSetup(distributionNftId, initialSetup);
-
-        instanceService.createTarget(instanceNftId, distributionAddress, distributionName);
-
+        (
+            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().createTarget(instanceNftId, distributionAddress, distribution.getName());
     }
 
     function _decodeAndVerifyDistributionData(bytes memory data)
         internal 
-        returns(string memory name, ISetup.DistributionSetupInfo memory setup)
+        returns(string memory name)
     {
-        (name, setup) = abi.decode(
-            data,
-            (string, ISetup.DistributionSetupInfo)
-        );
+        (name) = abi.decode(data, (string));
 
         // TODO add checks if applicable 
     }

package/contracts/instance/service/IBundleService.sol

@@ -26,7 +26,17 @@ interface IBundleService is IService {
 
     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 lockCollateral(
+        IInstance instanceNftId, 
+        NftId policyNftId, 
+        NftId bundleNftId, 
+        uint256 collateralAmount, 
+        uint256 netPremium
+    )
+        external
+        returns (
+            IBundle.BundleInfo memory bundleInfo
+        );
 
     function increaseBalance(IInstance instance, NftId bundleNftId,  uint256 amount) external;