@etherisc/gif-next 0.0.2-ce8407f-016 → 0.0.2-cf68d0c-530

package/contracts/instance/InstanceService.sol

@@ -1,45 +1,158 @@
 // 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";
+import {ADMIN_ROLE, INSTANCE_SERVICE_ROLE, DISTRIBUTION_SERVICE_ROLE} from "../types/RoleId.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));
+        address instanceOwner = msg.sender;
+        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));
+        // initial as this
+        clonedAccessManager.initialize(address(this));
+
+        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);
+
+        _grantInitialAuthorizations(clonedAccessManager, clonedInstance);
+
+        clonedInstance.setInstanceReader(clonedInstanceReader);
+
+        // switch instance ownership to instance owner
+        clonedAccessManager.grantRole(ADMIN_ROLE().toInt(), instanceOwner, 0);
+        clonedAccessManager.revokeRole(ADMIN_ROLE().toInt(), address(this));
+
+        emit LogInstanceCloned(address(clonedAccessManager), address(clonedInstance), address(clonedInstanceReader), instanceNftId);
+    }
+
+    function _grantInitialAuthorizations(AccessManagerSimple clonedAccessManager, Instance clonedInstance) internal {
+        address distributionServiceAddress = _registry.getServiceAddress("DistributionService", VersionLib.toVersion(3, 0, 0).toMajorPart());
+        
+        clonedAccessManager.grantRole(DISTRIBUTION_SERVICE_ROLE().toInt(), distributionServiceAddress, 0);
+        bytes4[] memory instanceDistributionServiceSelectors = new bytes4[](2);
+        instanceDistributionServiceSelectors[0] = clonedInstance.createDistributionSetup.selector;
+        instanceDistributionServiceSelectors[1] = clonedInstance.updateDistributionSetup.selector;
+        clonedAccessManager.setTargetFunctionRole(
+            address(clonedInstance),
+            instanceDistributionServiceSelectors, 
+            DISTRIBUTION_SERVICE_ROLE().toInt());
+    }
+
+    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 getInstanceReaderMaster() external view returns (address) {
+        return _instanceReaderMaster;
+    }
+
+    function getInstanceMaster() external view returns (address) {
+        return _instanceMaster;
     }
 
-    function setAccessManagerMaster(address accessManager) external {
-        _accessManagerMaster = accessManager;
+    function getAccessManagerMaster() external view returns (address) {
+        return _accessManagerMaster;
     }
 
-    function setInstanceAccessManagerMaster(address instanceAccessManager) external {
-        _instanceAccessManagerMaster = instanceAccessManager;
+    // 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);
 
-    function setInstanceMaster(address instance) external {
-        _instanceMaster = instance;
+        // address instanceAddress = ContractDeployerLib.deploy(
+        //     instanceCreationCode,
+        //     INSTANCE_CREATION_CODE_HASH);
+
+        address initialOwner = address(0);
+        (_registryAddress, initialOwner) = abi.decode(data, (address, address));
+
+        _initializeService(_registryAddress, initialOwner);
+        
+        _registerInterface(type(IService).interfaceId);
+        _registerInterface(type(IInstanceService).interfaceId);
     }
 
-    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 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,39 @@
+// 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 {
+
+    function _getAndVerifyComponentInfoAndInstance(
+        ObjectType objectType
+    )
+        internal
+        view
+        returns(
+            IRegistry.ObjectInfo memory info, 
+            IInstance instance
+        )
+    {
+        NftId componentNftId = _registry.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);

package/contracts/instance/base/KeyValueStore.sol

@@ -14,25 +14,12 @@ import {IKeyValueStore} from "./IKeyValueStore.sol";
 contract KeyValueStore is Lifecycle, IKeyValueStore {
 
     mapping(Key32 key32 => Value value) private _value;
-    address private _owner;
-
-    modifier onlyOwner() {
-        require(
-            msg.sender == _owner,
-            "ERROR:KVS-001:NOT_OWNER");
-        _;
-    }
-
-    constructor() {
-        _owner = msg.sender;
-    }
 
     function create(
         Key32 key32, 
         bytes memory data
     )
-        public
-        onlyOwner
+        internal
     {
         _create(key32, data);
     }
@@ -72,8 +59,7 @@ contract KeyValueStore is Lifecycle, IKeyValueStore {
         bytes memory data,
         StateId state
     ) 
-        public
-        onlyOwner
+        internal
     {
         _update(key32, data, state);
     }
@@ -108,8 +94,7 @@ contract KeyValueStore is Lifecycle, IKeyValueStore {
     }
 
     function updateData(Key32 key32, bytes memory data) 
-        public
-        onlyOwner
+        internal
     {
         _updateData(key32, data);
     }
@@ -136,8 +121,7 @@ contract KeyValueStore is Lifecycle, IKeyValueStore {
     }
 
     function updateState(Key32 key32, StateId state)
-        public
-        onlyOwner
+        internal
     {
         _updateState(key32, state);
     }

package/contracts/instance/module/IAccess.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 {RoleId} from "../../types/RoleId.sol";
 

package/contracts/instance/module/ISetup.sol

@@ -1,10 +1,11 @@
 // 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 {Fee} from "../../types/Fee.sol";
 import {NftId} from "../../types/NftId.sol";
+import {UFixed} from "../../types/UFixed.sol";
 import {TokenHandler} from "../../shared/TokenHandler.sol";
 
 interface ISetup {
@@ -32,6 +33,7 @@ interface ISetup {
     struct PoolSetupInfo {
         NftId productNftId;
         TokenHandler tokenHandler;
+        UFixed collateralizationLevel;
         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

package/contracts/instance/module/ITreasury.sol

@@ -1,7 +1,7 @@
 // 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 {Fee} from "../../types/Fee.sol";
 import {NftId} from "../../types/NftId.sol";