@etherisc/gif-next 0.0.2-ce8407f-016 → 0.0.2-d243ae6-520

package/contracts/instance/IInstance.sol

@@ -1,6 +1,28 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-interface IInstance {
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
+import {InstanceReader} from "./InstanceReader.sol";
+
+import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IDistributionService} from "./service/IDistributionService.sol";
+import {IPoolService} from "./service/IPoolService.sol";
+import {IProductService} from "./service/IProductService.sol";
+import {ISetup} from "./module/ISetup.sol";
+import {NftId} from "../types/NftId.sol";
+
+interface IInstance is IERC165 {
+
+    function getComponentOwnerService() external view returns (IComponentOwnerService);
+    // TODO: renable these when we have the services
+    // function getDistributionService() external view returns (IDistributionService);
+    // function getProductService() external view returns (IProductService);
+    // function getPoolService() external view returns (IPoolService);
+
+    function createProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup) external;
+    function createDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup) external;
+    function createPoolSetup(NftId distributionNftId, ISetup.PoolSetupInfo memory setup) external;
+
+    function getInstanceReader() external view returns (InstanceReader);
 }

package/contracts/instance/IInstanceService.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {NftId} from "../types/NftId.sol";
+import {ObjectType} from "../types/ObjectType.sol";
+import {RoleId} from "../types/RoleId.sol";
+import {IService} from "../shared/IService.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IBaseComponent} from "../components/IBaseComponent.sol";
+
+import {AccessManagerSimple} from "./AccessManagerSimple.sol";
+import {Instance} from "./Instance.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+
+interface IInstanceService is IService {
+
+    event LogInstanceCloned(address clonedAccessManagerAddress, address clonedInstanceAddress, address clonedInstanceReaderAddress, NftId clonedInstanceNftId);
+
+    function createInstanceClone()
+        external 
+        returns (
+            AccessManagerSimple clonedAccessManager, 
+            Instance clonedInstance,
+            NftId instanceNftId,
+            InstanceReader clonedInstanceReader
+        );
+}
+

package/contracts/instance/Instance.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {EnumerableSet} from "@openzeppelin5/contracts/utils/structs/EnumerableSet.sol";
-import {ShortString, ShortStrings} from "@openzeppelin5/contracts/utils/ShortStrings.sol";
+import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
 
 import {AccessManagedSimple} from "./AccessManagedSimple.sol";
 import {AccessManagerSimple} from "./AccessManagerSimple.sol";
@@ -14,17 +14,25 @@ import {ISetup} from "./module/ISetup.sol";
 import {Key32, KeyId, Key32Lib} from "../types/Key32.sol";
 import {KeyValueStore} from "./base/KeyValueStore.sol";
 import {IInstance} from "./IInstance.sol";
+import {InstanceReader} from "./InstanceReader.sol";
 import {NftId} from "../types/NftId.sol";
 import {NumberId} from "../types/NumberId.sol";
-import {ObjectType, BUNDLE, DISTRIBUTION, POLICY, POOL, ROLE, PRODUCT, TARGET} from "../types/ObjectType.sol";
+import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, ROLE, PRODUCT, TARGET} from "../types/ObjectType.sol";
 import {RiskId, RiskIdLib} from "../types/RiskId.sol";
 import {RoleId, RoleIdLib} from "../types/RoleId.sol";
 import {StateId, ACTIVE} from "../types/StateId.sol";
+import {ERC165} from "../shared/ERC165.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {ComponentOwnerService} from "./service/ComponentOwnerService.sol";
+import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {VersionPart} from "../types/Version.sol";
 
 contract Instance is
     AccessManagedSimple,
     KeyValueStore,
-    IInstance
+    IInstance,
+    ERC165,
+    Registerable
 {
 
     uint64 public constant ADMIN_ROLE = type(uint64).min;
@@ -33,6 +41,8 @@ contract Instance is
 
     uint32 public constant EXECUTION_DELAY = 0;
 
+    bool private _initialized;
+
     mapping(ShortString name => RoleId roleId) internal _role;
     mapping(RoleId roleId => EnumerableSet.AddressSet roleMembers) internal _roleMembers; 
     RoleId [] internal _roles;
@@ -40,13 +50,25 @@ contract Instance is
     mapping(ShortString name => address target) internal _target;
 
     AccessManagerSimple internal _accessManager;
+    InstanceReader internal _instanceReader;
 
-    constructor(address accessManagerAddress)
+    constructor(address accessManagerAddress, address registryAddress, NftId registryNftId)
         AccessManagedSimple(accessManagerAddress)
     {
+        initialize(accessManagerAddress, registryAddress, registryNftId, msg.sender);
+    }
+
+    function initialize(address accessManagerAddress, address registryAddress, NftId registryNftId, address initialOwner) public {
+        require(!_initialized, "Contract instance has already been initialized");
+
         _accessManager = AccessManagerSimple(accessManagerAddress);
         _createRole(RoleIdLib.toRoleId(ADMIN_ROLE), "AdminRole", false, false);
         _createRole(RoleIdLib.toRoleId(PUBLIC_ROLE), "PublicRole", false, false);
+
+        _initializeRegisterable(registryAddress, registryNftId, INSTANCE(), false, initialOwner, "");
+
+        _registerInterface(type(IInstance).interfaceId);    
+        _initialized = true;
     }
 
     //--- Role ------------------------------------------------------//
@@ -183,11 +205,11 @@ contract Instance is
     }
 
     //--- DistributionSetup ------------------------------------------------------//
-    function createDistributionSetup(NftId distributionNftId, ISetup.ProductSetupInfo memory setup) external restricted() {
+    function createDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup) external restricted() {
         create(_toNftKey32(distributionNftId, DISTRIBUTION()), abi.encode(setup));
     }
 
-    function updateDistributionSetup(NftId distributionNftId, ISetup.ProductSetupInfo memory setup, StateId newState) external restricted() {
+    function updateDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup, StateId newState) external restricted() {
         update(_toNftKey32(distributionNftId, DISTRIBUTION()), abi.encode(setup), newState);
     }
 
@@ -196,11 +218,11 @@ contract Instance is
     }
 
     //--- PoolSetup ------------------------------------------------------//
-    function createPoolSetup(NftId distributionNftId, ISetup.ProductSetupInfo memory setup) external restricted() {
+    function createPoolSetup(NftId distributionNftId, ISetup.PoolSetupInfo memory setup) external restricted() {
         create(_toNftKey32(distributionNftId, POOL()), abi.encode(setup));
     }
 
-    function updatePoolSetup(NftId distributionNftId, ISetup.ProductSetupInfo memory setup, StateId newState) external restricted() {
+    function updatePoolSetup(NftId distributionNftId, ISetup.PoolSetupInfo memory setup, StateId newState) external restricted() {
         update(_toNftKey32(distributionNftId, POOL()), abi.encode(setup), newState);
     }
 
@@ -389,4 +411,32 @@ contract Instance is
     function toPolicyKey32(NftId policyNftId) public pure returns (Key32) {
         return policyNftId.toKey32(POLICY());
     }
+
+    function getComponentOwnerService() external view returns (IComponentOwnerService) {
+        return ComponentOwnerService(_registry.getServiceAddress("ComponentOwnerService", VersionPart.wrap(3)));
+    }
+
+    // TODO reactivate when services are available
+    // function getDistributionService() external view returns (IDistributionService) {
+    //     return DistributionService(_registry.getServiceAddress("DistributionService", VersionPart.wrap(3)));
+    // }
+
+    // TODO reactivate when services are available
+    // function getProductService() external view returns (IProductService) {
+    //     return ProductService(_registry.getServiceAddress("ProductService", VersionPart.wrap(3)));
+    // }
+
+    // TODO reactivate when services are available
+    // function getPoolService() external view returns (IPoolService) {
+    //     return PoolService(_registry.getServiceAddress("PoolService", VersionPart.wrap(3)));
+    // }
+
+    function setInstanceReader(InstanceReader instanceReader) external restricted() {
+        require(address(_instanceReader) == address(0), "InstanceReader is set");
+        _instanceReader = instanceReader;
+    }
+
+    function getInstanceReader() external view returns (InstanceReader) {
+        return _instanceReader;
+    }
 }

package/contracts/instance/InstanceAccessManager.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {EnumerableSet} from "@openzeppelin5/contracts/utils/structs/EnumerableSet.sol";
-import {ShortString, ShortStrings} from "@openzeppelin5/contracts/utils/ShortStrings.sol";
+import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
 
 import {AccessManagedSimple} from "./AccessManagedSimple.sol";
 import {AccessManagerSimple} from "./AccessManagerSimple.sol";

package/contracts/instance/InstanceReader.sol

@@ -1,17 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {DistributorType} from "../types/DistributorType.sol";
 import {Fee, FeeLib} from "../types/Fee.sol";
 import {Key32} from "../types/Key32.sol";
 import {NftId} from "../types/NftId.sol";
-import {ObjectType, DISTRIBUTOR, INSTANCE, PRODUCT, POLICY, TREASURY} from "../types/ObjectType.sol";
+import {ObjectType, DISTRIBUTOR, DISTRIBUTION, INSTANCE, PRODUCT, POLICY, POOL, TREASURY} from "../types/ObjectType.sol";
 import {ReferralId, ReferralStatus, ReferralLib, REFERRAL_OK, REFERRAL_ERROR_UNKNOWN, REFERRAL_ERROR_EXPIRED, REFERRAL_ERROR_EXHAUSTED} from "../types/Referral.sol";
 import {Registerable} from "../shared/Registerable.sol";
 import {RiskId} from "../types/RiskId.sol";
-import {UFixed, UFixedMathLib} from "../types/UFixed.sol";
+import {UFixed, MathLib, UFixedLib} from "../types/UFixed.sol";
 import {Version} from "../types/Version.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
@@ -20,11 +20,13 @@ import {IInstance} from "./IInstance.sol";
 import {IKeyValueStore} from "../instance/base/IKeyValueStore.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IRisk} from "../instance/module/IRisk.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
 import {ITreasury} from "../instance/module/ITreasury.sol";
 import {TimestampLib} from "../types/Timestamp.sol";
 
 
 contract InstanceReader {
+    bool private _initialized;
 
     IRegistry internal _registry;
     NftId internal _instanceNftId;
@@ -36,6 +38,12 @@ contract InstanceReader {
         NftId instanceNftId
     )
     {
+        initialize(registry, instanceNftId);
+    }
+
+    function initialize(address registry, NftId instanceNftId) public {
+        require(!_initialized, "ERROR:CRD-000:ALREADY_INITIALIZED");
+
         require(
             address(registry) != address(0),
             "ERROR:CRD-001:REGISTRY_ZERO");
@@ -54,8 +62,11 @@ contract InstanceReader {
 
         _instance = IInstance(instanceInfo.objectAddress);
         _store = IKeyValueStore(instanceInfo.objectAddress);
+
+        _initialized = true;
     }
 
+
     // module specific functions
 
     function getPolicyInfo(NftId policyNftId)
@@ -126,6 +137,38 @@ contract InstanceReader {
         }
     }
 
+    function getDistributionSetupInfo(NftId distributionNftId)
+        public
+        view
+        returns (ISetup.DistributionSetupInfo memory info)
+    {
+        bytes memory data = _store.getData(toDistributionKey(distributionNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (ISetup.DistributionSetupInfo));
+        }
+    }
+
+    function getPoolSetupInfo(NftId poolNftId)
+        public
+        view
+        returns (ISetup.PoolSetupInfo memory info)
+    {
+        bytes memory data = _store.getData(toPoolKey(poolNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (ISetup.PoolSetupInfo));
+        }
+    }
+
+    function getProductSetupInfo(NftId productNftId)
+        public
+        view
+        returns (ISetup.ProductSetupInfo memory info)
+    {
+        bytes memory data = _store.getData(toProductKey(productNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (ISetup.ProductSetupInfo));
+        }
+    }
 
     function getReferralInfo(ReferralId referralId)
         public 
@@ -175,19 +218,19 @@ contract InstanceReader {
 
         if (info.expiryAt.eqz()) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_UNKNOWN());
         }
 
         if (info.expiryAt < TimestampLib.blockTimestamp()) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_EXPIRED());
         }
 
         if (info.usedReferrals >= info.maxReferrals) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_EXHAUSTED());
         }
 
@@ -212,6 +255,18 @@ contract InstanceReader {
         return distributorNftId.toKey32(DISTRIBUTOR());
     }
 
+    function toDistributionKey(NftId distributionNftId) public pure returns (Key32) { 
+        return distributionNftId.toKey32(DISTRIBUTION());
+    }
+
+    function toPoolKey(NftId poolNftId) public pure returns (Key32) { 
+        return poolNftId.toKey32(POOL());
+    }
+
+    function toProductKey(NftId productNftId) public pure returns (Key32) { 
+        return productNftId.toKey32(PRODUCT());
+    }
+
     // low level function
     function getInstance() external view returns (IInstance instance) {
         return _instance;
@@ -226,10 +281,10 @@ contract InstanceReader {
     }
 
     function toUFixed(uint256 value, int8 exp) public pure returns (UFixed) {
-        return UFixedMathLib.toUFixed(value, exp);
+        return UFixedLib.toUFixed(value, exp);
     }
 
     function toInt(UFixed value) public pure returns (uint256) {
-        return UFixedMathLib.toInt(value);
+        return UFixedLib.toInt(value);
     }
 }

package/contracts/instance/InstanceService.sol

@@ -1,45 +1,138 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Clones} from "@openzeppelin5/contracts/proxy/Clones.sol";
+import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
 
 import {AccessManagerSimple} from "./AccessManagerSimple.sol";
 import {InstanceAccessManager} from "./InstanceAccessManager.sol";
 import {Instance} from "./Instance.sol";
+import {IInstanceService} from "./IInstanceService.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {Registry} from "../registry/Registry.sol";
+import {RegistryService} from "../registry/RegistryService.sol";
+import {Service} from "../../contracts/shared/Service.sol";
+import {IService} from "../shared/IService.sol";
+import {ContractDeployerLib} from "../shared/ContractDeployerLib.sol";
+import {NftId, NftIdLib, zeroNftId} from "../../contracts/types/NftId.sol";
+import {VersionLib} from "../types/Version.sol";
 
-contract InstanceService {
+contract InstanceService is Service, IInstanceService {
 
+    address internal _registryAddress;
     address internal _accessManagerMaster;
-    address internal _instanceAccessManagerMaster;
     address internal _instanceMaster;
+    address internal _instanceReaderMaster;
+
+    // TODO update to real hash when instance is stable
+    bytes32 public constant INSTANCE_CREATION_CODE_HASH = bytes32(0);
+    string public constant NAME = "InstanceService";
 
     function createInstanceClone()
         external 
         returns (
-            AccessManagerSimple am, 
-            InstanceAccessManager im, 
-            Instance i
+            AccessManagerSimple clonedAccessManager, 
+            Instance clonedInstance,
+            NftId instanceNftId,
+            InstanceReader clonedInstanceReader
         )
     {
-        am = AccessManagerSimple(Clones.clone(_accessManagerMaster));
-        im = InstanceAccessManager(Clones.clone(_instanceAccessManagerMaster));
-        i = Instance(Clones.clone(_instanceMaster));
+        Registry registry = Registry(_registryAddress);
+        NftId registryNftId = registry.getNftId(_registryAddress);
+        address registryServiceAddress = registry.getServiceAddress("RegistryService", VersionLib.toVersion(3, 0, 0).toMajorPart());
+        RegistryService registryService = RegistryService(registryServiceAddress);
+
+        clonedAccessManager = AccessManagerSimple(Clones.clone(_accessManagerMaster));
+        clonedAccessManager.initialize(msg.sender);
+
+        clonedInstance = Instance(Clones.clone(_instanceMaster));
+        clonedInstance.initialize(address(clonedAccessManager), _registryAddress, registryNftId, msg.sender);
+        ( IRegistry.ObjectInfo memory info, ) = registryService.registerInstance(clonedInstance);
+        instanceNftId = info.nftId;
+        
+        clonedInstanceReader = InstanceReader(Clones.clone(address(_instanceReaderMaster)));
+        clonedInstanceReader.initialize(_registryAddress, instanceNftId);
+
+        emit LogInstanceCloned(address(clonedAccessManager), address(clonedInstance), address(clonedInstanceReader), instanceNftId);
+    }
+
+    function setAccessManagerMaster(address accessManagerMaster) external {
+        require(
+            _accessManagerMaster == address(0),
+            "ERROR:CRD-001:ACCESS_MANAGER_MASTER_ALREADY_SET");
+        _accessManagerMaster = accessManagerMaster;
+    }
+
+    function setInstanceMaster(address instanceMaster) external {
+        require(
+            _instanceMaster == address(0),
+            "ERROR:CRD-002:INSTANCE_MASTER_ALREADY_SET");
+        _instanceMaster = instanceMaster;
+    }
+
+    function setInstanceReaderMaster(address instanceReaderMaster) external {
+        require(
+            _instanceReaderMaster == address(0),
+            "ERROR:CRD-003:INSTANCE_READER_MASTER_ALREADY_SET");
+        _instanceReaderMaster = instanceReaderMaster;
     }
 
-    function setAccessManagerMaster(address accessManager) external {
-        _accessManagerMaster = accessManager;
+    function getInstanceReaderMaster() external view returns (address) {
+        return _instanceReaderMaster;
     }
 
-    function setInstanceAccessManagerMaster(address instanceAccessManager) external {
-        _instanceAccessManagerMaster = instanceAccessManager;
+    function getInstanceMaster() external view returns (address) {
+        return _instanceMaster;
     }
 
-    function setInstanceMaster(address instance) external {
-        _instanceMaster = instance;
+    function getAccessManagerMaster() external view returns (address) {
+        return _accessManagerMaster;
     }
 
-    function getAccessManagerMaster() external view returns (address) { return address(_accessManagerMaster); }
-    function getInstanceAccessManagerMaster() external view returns (address) { return address(_instanceAccessManagerMaster); }
-    function getInstanceMaster() external view returns (address) { return address(_instanceMaster); }
+    // From IService
+    function getName() public pure override(IService, Service) returns(string memory) {
+        return NAME;
+    }
+    
+    /// @dev top level initializer
+    // 1) registry is non upgradeable -> don't need a proxy and uses constructor !
+    // 2) deploy registry service first -> from its initialization func it is easier to deploy registry then vice versa
+    // 3) deploy registry -> pass registry service address as constructor argument
+    // registry is getting instantiated and locked to registry service address forever
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        initializer
+        virtual override
+    {
+        // bytes memory encodedConstructorArguments = abi.encode(
+        //     _registryAddress);
+
+        // bytes memory instanceCreationCode = ContractDeployerLib.getCreationCode(
+        //     instanceByteCodeWithInitCode,
+        //     encodedConstructorArguments);
+
+        // address instanceAddress = ContractDeployerLib.deploy(
+        //     instanceCreationCode,
+        //     INSTANCE_CREATION_CODE_HASH);
+
+        address initialOwner = address(0);
+        (_registryAddress, initialOwner) = abi.decode(data, (address, address));
+
+        // // TODO register instance in registry  
+        IRegistry registry = IRegistry(_registryAddress);
+        NftId registryNftId = registry.getNftId(_registryAddress);
+
+        _initializeService(_registryAddress, initialOwner);
+        
+        _registerInterface(type(IService).interfaceId);
+        _registerInterface(type(IInstanceService).interfaceId);
+    }
+
+    function getInstance() external view returns (Instance) {
+        return Instance(address(this));
+    }
 }
 

package/contracts/instance/InstanceServiceManager.sol

@@ -0,0 +1,56 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Instance} from "./Instance.sol";
+import {IVersionable} from "../shared/IVersionable.sol";
+import {ProxyManager} from "../shared/ProxyManager.sol";
+import {InstanceService} from "./InstanceService.sol";
+import {Registry} from "../registry/Registry.sol";
+import {RegistryService} from "../registry/RegistryService.sol";
+import {VersionLib} from "../types/Version.sol";
+
+contract InstanceServiceManager is ProxyManager {
+
+    InstanceService private _instanceService;
+
+    /// @dev initializes proxy manager with instance service implementation and deploys instance
+    constructor(
+        address registryAddress
+    )
+        ProxyManager()
+    {
+        InstanceService instSrv = new InstanceService();
+        // bytes memory initCode = type(InstanceService).creationCode;
+        bytes memory data = abi.encode(registryAddress, address(this));
+        IVersionable versionable = deploy(
+            address(instSrv), 
+            data);
+
+        _instanceService = InstanceService(address(versionable));
+
+        Registry registry = Registry(registryAddress);
+        address registryServiceAddress = registry.getServiceAddress("RegistryService", VersionLib.toVersion(3, 0, 0).toMajorPart());
+        RegistryService registryService = RegistryService(registryServiceAddress);
+
+        registryService.registerService(_instanceService);
+        // RegistryService registryService = _instanceService.getRegistryService();
+
+        // link ownership of instance service manager ot nft owner of instance service
+        _linkToNftOwnable(
+            address(registryAddress),
+            address(_instanceService));
+
+        // implies that after this constructor call only upgrade functionality is available
+        _isDeployed = true;
+    }
+
+    //--- view functions ----------------------------------------------------//
+    function getInstanceService()
+        external
+        view
+        returns (InstanceService instanceService)
+    {
+        return _instanceService;
+    }
+
+}

package/contracts/instance/base/ComponentServiceBase.sol

@@ -0,0 +1,49 @@
+// 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 {ObjectType, INSTANCE, PRODUCT, POOL} from "../../types/ObjectType.sol";
+import {NftId, NftIdLib} from "../../types/NftId.sol";
+
+import {Service} from "../../shared/Service.sol";
+import {Version, VersionPart, VersionLib} from "../../types/Version.sol";
+
+abstract contract ComponentServiceBase is Service {
+
+    constructor(
+        address registry,
+        NftId registryNftId,
+        address initialOwner
+    )
+    {
+        _initializeService(registry, initialOwner);
+    }
+
+
+    function _getAndVerifyComponentInfoAndInstance(
+        ObjectType objectType
+    )
+        internal
+        view
+        returns(
+            IRegistry.ObjectInfo memory info, 
+            IInstance instance
+        )
+    {
+        NftId componentNftId = getRegistry().getNftId(msg.sender);
+        require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
+
+        info = getRegistry().getObjectInfo(componentNftId);
+        require(info.objectType == objectType, "OBJECT_TYPE_INVALID");
+
+        address instanceAddress = getRegistry().getObjectInfo(info.parentNftId).objectAddress;
+        instance = IInstance(instanceAddress);
+    }
+
+    function getRegistryService() public view virtual returns (IRegistryService) {
+        address service = getRegistry().getServiceAddress("RegistryService", getMajorVersion());
+        return IRegistryService(service);
+    }
+}

package/contracts/instance/base/IInstanceBase.sol

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Key32} from "../../types/Key32.sol";
+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";
+
+interface IInstanceBase {
+    function getKeyValueStore() external view returns (IKeyValueStore keyValueStore);
+    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/base/IKeyValueStore.sol

@@ -9,6 +9,7 @@ import {StateId} from "../../types/StateId.sol";
 
 import {ILifecycle} from "./ILifecycle.sol";
 
+// TODO remove - internal only?
 interface IKeyValueStore is ILifecycle {
 
     struct Value {
@@ -33,10 +34,10 @@ interface IKeyValueStore is ILifecycle {
     event LogStateUpdated(ObjectType objectType, KeyId keyId, StateId stateOld, StateId stateNew, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
 
     // generic state changing functions
-    function create(Key32 key, bytes memory data) external;
-    function update(Key32 key, bytes memory data, StateId state) external;
-    function updateData(Key32 key, bytes memory data) external;
-    function updateState(Key32 key, StateId state) external;
+    // function create(Key32 key, bytes memory data) external;
+    // function update(Key32 key, bytes memory data, StateId state) external;
+    // function updateData(Key32 key, bytes memory data) external;
+    // function updateState(Key32 key, StateId state) external;
 
     function exists(Key32 key) external view returns (bool);
     function get(Key32 key) external view returns (Value memory value);