@etherisc/gif-next 0.0.2-94be5d8-181 → 0.0.2-94dc606-665

package/contracts/instance/InstanceService.sol

@@ -7,18 +7,24 @@ 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 {RoleId} from "../types/RoleId.sol";
+import {VersionLib} from "../types/Version.sol";
+import {ADMIN_ROLE, INSTANCE_SERVICE_ROLE, DISTRIBUTION_SERVICE_ROLE} from "../types/RoleId.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 +33,92 @@ 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));
+        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);
+
+        // 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 = AccessManagerSimple(Clones.clone(_accessManagerMaster));
+        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);
+        
+        // to complete setup switch instance ownership to the instance owner
+        // TODO: use a role less powerful than admin, maybe INSTANCE_ADMIN (does not exist yet)
+        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 setAccessManagerMaster(address accessManager) external {
-        _accessManagerMaster = accessManager;
+    function setInstanceReaderMaster(address instanceReaderMaster) external {
+        require(
+            _instanceReaderMaster == address(0),
+            "ERROR:CRD-003:INSTANCE_READER_MASTER_ALREADY_SET");
+        _instanceReaderMaster = instanceReaderMaster;
     }
 
-    function setInstanceAccessManagerMaster(address instanceAccessManager) external {
-        _instanceAccessManagerMaster = instanceAccessManager;
+    function getInstanceReaderMaster() external view returns (address) {
+        return _instanceReaderMaster;
     }
 
-    function setInstanceMaster(address instance) external {
-        _instanceMaster = instance;
+    function getInstanceMaster() external view returns (address) {
+        return _instanceMaster;
     }
 
-    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 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;
     }
     
@@ -85,18 +149,22 @@ contract InstanceService is ServiceBase, IInstanceService {
         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);
-
-        _initializeServiceBase(_registryAddress, registryNftId, initialOwner);
+        _initializeService(_registryAddress, initialOwner);
         
         _registerInterface(type(IService).interfaceId);
         _registerInterface(type(IInstanceService).interfaceId);
     }
 
-    function getInstance() external view returns (Instance) {
-        return Instance(address(this));
+    function hasRole(address account, RoleId role, NftId instanceNftId) external view returns (bool) {
+        IRegistry.ObjectInfo memory instanceObjectInfo = getRegistry().getObjectInfo(instanceNftId);
+        address instanceAddress = instanceObjectInfo.objectAddress;
+        Instance instance = Instance(instanceAddress);
+        AccessManagerSimple accessManager = AccessManagerSimple(instance.authority());
+        (bool isMember, uint32 executionDelay) = accessManager.hasRole(role.toInt(), account);
+        if (executionDelay > 0) {
+            return false;
+        } 
+        return isMember;
     }
 }
 

package/contracts/instance/base/ComponentServiceBase.sol

@@ -7,20 +7,12 @@ 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 {
-
-    constructor(
-        address registry,
-        NftId registryNftId,
-        address initialOwner
-    )
-    {
-        _initializeServiceBase(registry, registryNftId, initialOwner);
-    }
+abstract contract ComponentServiceBase is Service {
 
+    error CallerIsNotComponentOwner();
 
     function _getAndVerifyComponentInfoAndInstance(
         ObjectType objectType
@@ -32,7 +24,7 @@ abstract contract ComponentServiceBase is ServiceBase {
             IInstance instance
         )
     {
-        NftId componentNftId = getRegistry().getNftId(msg.sender);
+        NftId componentNftId = _registry.getNftId(msg.sender);
         require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
 
         info = getRegistry().getObjectInfo(componentNftId);

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/DistributionService.sol

@@ -0,0 +1,105 @@
+// 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 {InstanceReader} from "../../instance/InstanceReader.sol";
+import {ISetup} from "../../instance/module/ISetup.sol";
+import {ITreasury} from "../../instance/module/ITreasury.sol";
+
+import {NftId, NftIdLib} from "../../types/NftId.sol";
+import {Fee} from "../../types/Fee.sol";
+import {DISTRIBUTION_OWNER_ROLE} from "../../types/RoleId.sol";
+import {KEEP_STATE} from "../../types/StateId.sol";
+import {DISTRIBUTION} from "../../types/ObjectType.sol";
+import {Version, VersionLib} from "../../types/Version.sol";
+
+import {IVersionable} from "../../shared/IVersionable.sol";
+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 {IDistributionService} from "./IDistributionService.sol";
+import {Distribution} from "../../components/Distribution.sol";
+import {InstanceService} from "../InstanceService.sol";
+import {Instance} from "../Instance.sol";
+import {INftOwnable} from "../../shared/INftOwnable.sol";
+
+string constant DISTRIBUTION_SERVICE_NAME = "DistributionService";
+
+contract DistributionService is
+    ComponentServiceBase,
+    IDistributionService
+{
+    using NftIdLib for NftId;
+
+    string public constant NAME = "DistributionService";
+
+    address internal _registryAddress;
+    InstanceService internal _instanceService;
+    
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        initializer
+        virtual override
+    {
+        address initialOwner = address(0);
+        (_registryAddress, initialOwner) = abi.decode(data, (address, address));
+
+        IRegistry registry = IRegistry(_registryAddress);
+        _instanceService = InstanceService(registry.getServiceAddress("InstanceService", getMajorVersion()));
+
+        _initializeService(_registryAddress, initialOwner);
+
+        _registerInterface(type(IService).interfaceId);
+        _registerInterface(type(IDistributionService).interfaceId);
+    }
+
+
+    function getName() public pure override(IService, Service) returns(string memory name) {
+        return NAME;
+    }
+
+    function register(address distributionComponentAddress) 
+        external 
+        returns (NftId distributionNftId)
+    {
+        address componentOwner = msg.sender;
+        Distribution distribution = Distribution(distributionComponentAddress);
+        IInstance instance = distribution.getInstance();
+        INftOwnable nftOwnable = INftOwnable(address(instance));
+        
+        require(_instanceService.hasRole(componentOwner, DISTRIBUTION_OWNER_ROLE(), nftOwnable.getNftId()), "ERROR:DIS-001:NOT_DISTRIBUTION_OWNER");
+        
+        IRegistryService registryService = getRegistryService();
+        (IRegistry.ObjectInfo memory distributionObjInfo, ) = registryService.registerDistribution(
+            distribution,
+            componentOwner
+        );
+        distributionNftId = distributionObjInfo.nftId;
+
+        ISetup.DistributionSetupInfo memory initialSetup = distribution.getInitialSetupInfo();
+        instance.createDistributionSetup(distributionNftId, initialSetup);
+    }
+
+    function setFees(
+        Fee memory distributionFee
+    )
+        external
+        override
+    {
+        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(DISTRIBUTION());
+        InstanceReader instanceReader = instance.getInstanceReader();
+        NftId distributionNftId = info.nftId;
+
+        ISetup.DistributionSetupInfo memory distSetupInfo = instanceReader.getDistributionSetupInfo(distributionNftId);
+        distSetupInfo.distributionFee = distributionFee;
+        
+        instance.updateDistributionSetup(distributionNftId, distSetupInfo, KEEP_STATE());
+    }
+}

package/contracts/instance/service/DistributionServiceManager.sol

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

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

@@ -10,10 +10,33 @@ import {VersionPart} from "../types/Version.sol";
 
 interface IRegistry is IERC165 {
 
+    event LogInitialMajorVersionSet(VersionPart majorVersion);
+    event LogMajorVersionSet(VersionPart majorVersionMax);
     event LogRegistration(ObjectInfo info);
-
+    event LogTokenStateSet(address token, VersionPart majorVersion, bool active);
     event LogServiceNameRegistration(string serviceName, VersionPart majorVersion); 
 
+    // supported versions
+    error MajorVersionMaxIncreaseInvalid(VersionPart newMajorVersionMax, VersionPart existingMaxMajorVersion);
+
+    // token whitelisting
+    error TokenNotRegistered(address token);
+    error NotToken(address token);
+    error TokenMajorVersionInvalid(VersionPart majorVersion);
+
+    // register
+    error NotRegistryService();
+    error ZeroParentAddress();
+    error ContractAlreadyRegistered(address objectAddress);
+    error InvalidServiceVersion(VersionPart majorVersion);
+    error ServiceNameAlreadyRegistered(string name, VersionPart majorVersion);
+            
+    // approve
+    error NotOwner(address account);
+    error NotRegisteredContract(NftId registrarNftId);
+    error NotService(NftId registrarNftId);
+    error InvalidTypesCombination(ObjectType objectType, ObjectType parentType);
+
 
     struct ObjectInfo {
         NftId nftId;
@@ -24,12 +47,24 @@ 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 setMajorVersion(VersionPart newMajorVersionMax) external;
 
     function register(ObjectInfo memory info) external returns (NftId nftId);
-    
+
+    function setTokenActive(address token, VersionPart majorVersion, bool active) external;
+
+    function getMajorVersionMin() external view returns (VersionPart);
+
+    function getMajorVersionMax() external view returns (VersionPart);
+
+    function getMajorVersion() external view returns (VersionPart);
 
     function getObjectCount() external view returns (uint256);
 
+    function getNftId() external view returns (NftId nftId);
+
     function getNftId(address objectAddress) external view returns (NftId nftId);
 
     function ownerOf(NftId nftId) external view returns (address);
@@ -44,6 +79,8 @@ interface IRegistry is IERC165 {
 
     function isRegistered(address contractAddress) external view returns (bool);
 
+    function isTokenActive(address token, VersionPart majorVersion) external view returns (bool);
+
     function getServiceName(NftId nftId) external view returns (string memory name);
 
     function getServiceAddress(

package/contracts/registry/IRegistryService.sol

@@ -1,19 +1,17 @@
 // 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 {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 "../../contracts/shared/IRegisterable.sol";
-import {IBaseComponent} from "../../contracts/components/IBaseComponent.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IBaseComponent} from "../components/IBaseComponent.sol";
 
 interface IRegistryService is IService {
 
-    function registerToken(address tokenAddress) external returns(NftId nftId);
-
     function registerService(IService service)  external returns(IRegistry.ObjectInfo memory info, bytes memory data);
 
     function registerInstance(IRegisterable instance)