@etherisc/gif-next 0.0.2-b9e9dc3-713 → 0.0.2-bca36d7-613

package/contracts/instance/InstanceService.sol

@@ -7,18 +7,22 @@ import {AccessManagerSimple} from "./AccessManagerSimple.sol";
 import {InstanceAccessManager} from "./InstanceAccessManager.sol";
 import {Instance} from "./Instance.sol";
 import {IInstanceService} from "./IInstanceService.sol";
-import {ServiceBase} from "../../contracts/instance/base/ServiceBase.sol";
+import {InstanceReader} from "./InstanceReader.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
-import {IService} from "../../contracts/instance/base/IService.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 is ServiceBase, IInstanceService {
+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);
@@ -27,34 +31,66 @@ contract InstanceService is ServiceBase, IInstanceService {
     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 accessManager) external {
-        _accessManagerMaster = accessManager;
+    function setAccessManagerMaster(address accessManagerMaster) external {
+        require(
+            _accessManagerMaster == address(0),
+            "ERROR:CRD-001:ACCESS_MANAGER_MASTER_ALREADY_SET");
+        _accessManagerMaster = accessManagerMaster;
     }
 
-    function setInstanceAccessManagerMaster(address instanceAccessManager) external {
-        _instanceAccessManagerMaster = instanceAccessManager;
+    function setInstanceMaster(address instanceMaster) external {
+        require(
+            _instanceMaster == address(0),
+            "ERROR:CRD-002:INSTANCE_MASTER_ALREADY_SET");
+        _instanceMaster = instanceMaster;
     }
 
-    function setInstanceMaster(address instance) external {
-        _instanceMaster = instance;
+    function setInstanceReaderMaster(address instanceReaderMaster) external {
+        require(
+            _instanceReaderMaster == address(0),
+            "ERROR:CRD-003:INSTANCE_READER_MASTER_ALREADY_SET");
+        _instanceReaderMaster = instanceReaderMaster;
     }
 
-    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); }
+    function getInstanceReaderMaster() external view returns (address) {
+        return _instanceReaderMaster;
+    }
+
+    function getInstanceMaster() external view returns (address) {
+        return _instanceMaster;
+    }
+
+    function getAccessManagerMaster() external view returns (address) {
+        return _accessManagerMaster;
+    }
 
     // From IService
-    function getName() public pure override(IService, ServiceBase) returns(string memory) {
+    function getName() public pure override(IService, Service) returns(string memory) {
         return NAME;
     }
     
@@ -89,7 +125,7 @@ contract InstanceService is ServiceBase, IInstanceService {
         IRegistry registry = IRegistry(_registryAddress);
         NftId registryNftId = registry.getNftId(_registryAddress);
 
-        _initializeServiceBase(_registryAddress, registryNftId, initialOwner);
+        _initializeService(_registryAddress, initialOwner);
         
         _registerInterface(type(IService).interfaceId);
         _registerInterface(type(IInstanceService).interfaceId);

package/contracts/instance/base/ComponentServiceBase.sol

@@ -7,10 +7,10 @@ import {IInstance} from "../../instance/IInstance.sol";
 import {ObjectType, INSTANCE, PRODUCT, POOL} from "../../types/ObjectType.sol";
 import {NftId, NftIdLib} from "../../types/NftId.sol";
 
-import {ServiceBase} from "./ServiceBase.sol";
+import {Service} from "../../shared/Service.sol";
 import {Version, VersionPart, VersionLib} from "../../types/Version.sol";
 
-abstract contract ComponentServiceBase is ServiceBase {
+abstract contract ComponentServiceBase is Service {
 
     constructor(
         address registry,
@@ -18,7 +18,7 @@ abstract contract ComponentServiceBase is ServiceBase {
         address initialOwner
     )
     {
-        _initializeServiceBase(registry, registryNftId, initialOwner);
+        _initializeService(registry, initialOwner);
     }
 
 

package/contracts/instance/service/ComponentOwnerService.sol

@@ -27,15 +27,15 @@ import {UFixed, UFixedLib} from "../../types/UFixed.sol";
 import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
 import {IPoolComponent} from "../../components/IPoolComponent.sol";
 import {IProductComponent} from "../../components/IProductComponent.sol";
-import {IService} from "../base/IService.sol";
+import {IService} from "../../shared/IService.sol";
 import {IComponentOwnerService} from "./IComponentOwnerService.sol";
-import {ServiceBase} from "../base/ServiceBase.sol";
+import {Service} from "../../shared/Service.sol";
 // import {IPool, IPoolModule} from "../module/IPoolModule.sol";
 
 import {IRegistryService} from "../../registry/IRegistryService.sol";
 
 contract ComponentOwnerService is
-    ServiceBase,
+    Service,
     IComponentOwnerService
 {
     using NftIdLib for NftId;
@@ -64,11 +64,11 @@ contract ComponentOwnerService is
         address initialOwner
     )
     {
-        _initializeServiceBase(registry, registryNftId, initialOwner);
+        _initializeService(registry, initialOwner);
         _registerInterface(type(IComponentOwnerService).interfaceId);
     }
 
-    function getName() public pure override(IService, ServiceBase) returns(string memory name) {
+    function getName() public pure override(IService, Service) returns(string memory name) {
         return NAME;
     }
 

package/contracts/instance/service/IComponentOwnerService.sol

@@ -5,7 +5,7 @@ import {NftId} from "../../types/NftId.sol";
 import {ObjectType} from "../../types/ObjectType.sol";
 import {RoleId} from "../../types/RoleId.sol";
 import {IBaseComponent} from "../../components/IBaseComponent.sol";
-import {IService} from "../base/IService.sol";
+import {IService} from "../../shared/IService.sol";
 
 // TODO rename to registry service
 interface IComponentOwnerService is IService {

package/contracts/instance/service/IDistributionService.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.19;
 
 import {NftId} from "../../types/NftId.sol";
 import {Fee} from "../../types/Fee.sol";
-import {IService} from "../base/IService.sol";
+import {IService} from "../../shared/IService.sol";
 
 interface IDistributionService is IService {
     function setFees(

package/contracts/instance/service/IPoolService.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.19;
 
 import {NftId} from "../../types/NftId.sol";
 import {Fee} from "../../types/Fee.sol";
-import {IService} from "../base/IService.sol";
+import {IService} from "../../shared/IService.sol";
 
 interface IPoolService is IService {
     function setFees(

package/contracts/instance/service/IProductService.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.19;
 
 import {IRisk} from "../module/IRisk.sol";
-import {IService} from "../base/IService.sol";
+import {IService} from "../../shared/IService.sol";
 
 import {NftId} from "../../types/NftId.sol";
 import {ReferralId} from "../../types/Referral.sol";

package/contracts/registry/IRegistry.sol

@@ -24,6 +24,7 @@ interface IRegistry is IERC165 {
         address initialOwner;
         bytes data;
     }// TODO delete nftId and initialOwner(if not used) from struct
+    // TODO strong disagree, keep nftId there (lets keep get object info return object consistent)
 
     function register(ObjectInfo memory info) external returns (NftId nftId);
     

package/contracts/registry/IRegistryService.sol

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {NftId} from "../../contracts/types/NftId.sol";
-import {ObjectType} from "../../contracts/types/ObjectType.sol";
-import {RoleId} from "../../contracts/types/RoleId.sol";
-import {IService} from "../../contracts/instance/base/IService.sol";
-import {IRegistry} from "../../contracts/registry/IRegistry.sol";
-
-import {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
-import {IBaseComponent} from "../../contracts/components/IBaseComponent.sol";
+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 "./IRegistry.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IBaseComponent} from "../components/IBaseComponent.sol";
 
 interface IRegistryService is IService {
 

package/contracts/registry/Registry.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IService} from "../instance/base/IService.sol";
+import {IService} from "../shared/IService.sol";
 
 import {ChainNft} from "./ChainNft.sol";
 import {IRegistry} from "./IRegistry.sol";

package/contracts/registry/RegistryService.sol

@@ -28,15 +28,15 @@ import {NftId, NftIdLib, zeroNftId} from "../../contracts/types/NftId.sol";
 import {Fee, FeeLib} from "../../contracts/types/Fee.sol";
 import {Version, VersionPart, VersionLib} from "../../contracts/types/Version.sol";
 
-import {ServiceBase} from "../../contracts/instance/base/ServiceBase.sol";
-import {IService} from "../../contracts/instance/base/IService.sol";
+import {Service} from "../shared/Service.sol";
+import {IService} from "../shared/IService.sol";
 import {IRegistryService} from "./IRegistryService.sol";
 import {Registry} from "./Registry.sol";
 import {ChainNft} from "./ChainNft.sol";
 
 contract RegistryService is
     AccessManagedUpgradeable,
-    ServiceBase,
+    Service,
     IRegistryService
 {
     using NftIdLib for NftId;
@@ -158,7 +158,6 @@ contract RegistryService is
             bytes memory data
         ) 
     {
-
         if(!instance.supportsInterface(type(IInstance).interfaceId)) {
             revert NotInstance();
         }
@@ -290,7 +289,7 @@ contract RegistryService is
 
 
     // From IService
-    function getName() public pure override(IService, ServiceBase) returns(string memory) {
+    function getName() public pure override(IService, Service) returns(string memory) {
         return NAME;
     }
     //function getType() public pure override(IService, ServiceBase) returns(ObjectType serviceType) {
@@ -334,7 +333,7 @@ contract RegistryService is
 
         NftId registryNftId = registry.getNftId(address(registry));
 
-        _initializeServiceBase(address(registry), registryNftId, owner);
+        _initializeService(address(registry), owner);
 
         // TODO why do registry service proxy need to keep its nftId??? -> no registryServiceNftId checks in implementation
         // if they are -> use registry address to obtain owner of registry service nft (works the same with any registerable and(or) implementation)
@@ -367,8 +366,13 @@ contract RegistryService is
 
         address owner = info.initialOwner;
 
-        if(owner != expectedOwner) { // registerable owner protection
-            revert NotRegisterableOwner(expectedOwner);
+        // solhint-disable-next-line 
+        if(expectedType == INSTANCE()) { 
+            // any address may create a new instance via instance service
+        } else {
+            if(owner != expectedOwner) { // registerable owner protection
+                revert NotRegisterableOwner(expectedOwner);
+            }
         }
 
         if(owner == address(registerable)) {

package/contracts/{instance/base → shared}/IService.sol

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {VersionPart} from "../../types/Version.sol";
+import {VersionPart} from "../types/Version.sol";
 
-import {IRegisterable} from "../../shared/IRegisterable.sol";
-import {IVersionable} from "../../shared/IVersionable.sol";
+import {IRegisterable} from "./IRegisterable.sol";
+import {IVersionable} from "./IVersionable.sol";
 
 interface IService is 
     IRegisterable,

package/contracts/shared/RegisterableUpgradable.sol

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Registerable} from "./Registerable.sol";
+import {Versionable} from "./Versionable.sol";
+
+/// @dev base contract for upgradable objects like services and upgradable components
+/// deriving contracs need to call _initializeRegisterable
+/// TODO internalizes versionable here, a non-registerable versionalbe might itself have some value but is outside the scope of the gif
+/// after this merge versionable will no longer exist on its own in gif
+/// only registerable and upgradable (which is a registerable too) will remain
+abstract contract RegisterableUpgradable is 
+    Registerable,
+    Versionable
+{
+}

package/contracts/shared/Service.sol

@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IService} from "./IService.sol";
+import {IVersionable} from "./IVersionable.sol";
+import {NftId, zeroNftId} from "../types/NftId.sol";
+import {RegisterableUpgradable} from "./RegisterableUpgradable.sol";
+import {SERVICE} from "../types/ObjectType.sol";
+import {Version, VersionPart, VersionLib} from "../types/Version.sol";
+import {Versionable} from "./Versionable.sol";
+
+/// @dev service base contract
+abstract contract Service is 
+    RegisterableUpgradable,
+    IService
+{
+    function getName() public pure virtual override returns(string memory name);
+
+    function getMajorVersion() public view virtual override returns(VersionPart majorVersion) {
+        return getVersion().toMajorPart(); 
+    }
+
+    // from Versionable
+    function getVersion()
+        public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(3,0,0);
+    }
+
+    function _initializeService(
+        address registry, 
+        address initialOwner
+    )
+        internal
+        //onlyInitializing //TODO uncomment when "fully" upgradeable
+    {
+        // service must provide its name and version upon registration
+        bytes memory data = abi.encode(getName(), getMajorVersion());
+        NftId registryNftId = _getRegistryNftId(registry); 
+        bool isInterceptor = false;
+
+        _initializeRegisterable(registry, registryNftId, SERVICE(), isInterceptor, initialOwner, data);
+        _registerInterface(type(IService).interfaceId);
+    }
+
+    // this is just a conveniene function, actual validation will be done upon registration
+    function _getRegistryNftId(address registryAddress) internal view returns (NftId) {
+        return IRegistry(registryAddress).getNftId(registryAddress);
+    }
+}

package/contracts/test/TestService.sol

@@ -3,21 +3,19 @@ pragma solidity ^0.8.19;
 
 import {NftId} from "../../contracts/types/NftId.sol";
 import {Version, VersionLib} from "../../contracts/types/Version.sol";
-import {ServiceBase} from "../../contracts/instance/base/ServiceBase.sol";
+import {Service} from "../../contracts/shared/Service.sol";
 
 import {IVersionable} from "../../contracts/shared/IVersionable.sol";
 import {Versionable} from "../../contracts/shared/Versionable.sol";
 
-//import {IService} from "../../contracts/instance/base/IService.sol";
-
-contract TestService is ServiceBase {
+contract TestService is Service {
 
     string public constant NAME = "TestService";
 
     constructor(address registry, NftId registryNftId, address initialOwner)
     // solhint-disable-next-line no-empty-blocks
     {
-        _initializeServiceBase(registry, registryNftId, initialOwner);
+        _initializeService(registry, initialOwner);
     }
 
     function getName() public pure override returns(string memory name) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-b9e9dc3-713",
+  "version": "0.0.2-bca36d7-613",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {

package/artifacts/contracts/instance/base/IService.sol/IService.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/a8e0e3f537ba4656e5a360abc248c3a6.json"
-}

package/artifacts/contracts/instance/base/ServiceBase.sol/ServiceBase.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/a8e0e3f537ba4656e5a360abc248c3a6.json"
-}

package/contracts/instance/base/ServiceBase.sol

@@ -1,44 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId, zeroNftId} from "../../types/NftId.sol";
-import {ObjectType, SERVICE} from "../../types/ObjectType.sol";
-import {Version, VersionPart, VersionLib} from "../../types/Version.sol";
-
-import {Registerable} from "../../shared/Registerable.sol";
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {IService} from "./IService.sol";
-
-abstract contract ServiceBase is 
-    Registerable,
-    Versionable,
-    IService
-{
-    function getName() public pure virtual override returns(string memory name);
-
-    function getMajorVersion() public view virtual override returns(VersionPart majorVersion) {
-        return getVersion().toMajorPart(); 
-    }
-
-    // from Versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(3,0,0);
-    }
-
-    function _initializeServiceBase(address registry, NftId registryNftId, address initialOwner)
-        internal 
-        //onlyInitializing //TODO uncomment when "fully" upgradeable
-    {// service must provide its name and version upon registration
-        bytes memory data = abi.encode(getName(), getMajorVersion());
-        _initializeRegisterable(registry, registryNftId, SERVICE(), false, initialOwner, data);
-        _registerInterface(type(IService).interfaceId);
-    }
-}