@etherisc/gif-next 0.0.2-cddad6b-504 → 0.0.2-ce3fd5e-324

package/contracts/instance/IInstance.sol

@@ -1,53 +1,77 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+
+import {ClaimId} from "../type/ClaimId.sol";
+import {DistributorType} from "../type/DistributorType.sol";
+import {PayoutId} from "../type/PayoutId.sol";
+import {NftId} from "../type/NftId.sol";
+import {StateId} from "../type/StateId.sol";
+import {ReferralId} from "../type/Referral.sol";
+import {RiskId} from "../type/RiskId.sol";
+import {VersionPart} from "../type/Version.sol";
+import {Key32} from "../type/Key32.sol";
+import {RoleId} from "../type/RoleId.sol";
 
-import {IVersionable} from "../shared/IVersionable.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IOwnable} from "../shared/IOwnable.sol";
-import {RoleId} from "../types/RoleId.sol";
-
-import {IAccessModule} from "./module/access/IAccess.sol";
-import {IBundleModule} from "./module/bundle/IBundle.sol";
-import {IDistributionModule} from "./module/distribution/IDistribution.sol";
-import {IComponentModule} from "./module/component/IComponent.sol";
-import {IPolicyModule} from "./module/policy/IPolicy.sol";
-import {IPoolModule} from "./module/pool/IPoolModule.sol";
-import {IRiskModule} from "./module/risk/IRisk.sol";
-import {ITreasuryModule} from "./module/treasury/ITreasury.sol";
+
+import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
+
+import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {BundleManager} from "./BundleManager.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {InstanceStore} from "./InstanceStore.sol";
 
 import {IKeyValueStore} from "./base/IKeyValueStore.sol";
-import {IRegistry, IRegistryLinked} from "../registry/IRegistryLinked.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";
-import {IInstanceBase} from "./base/IInstanceBase.sol";
-
-// solhint-disable-next-line no-empty-blocks
-interface IInstance is
-    IERC165,
-    IVersionable,
-    IRegisterable,
-    IAccessModule,
-    IPolicyModule,
-    IPoolModule,
-    IRiskModule,
-    IBundleModule,
-    IComponentModule,
-    ITreasuryModule,
-    IDistributionModule,
-    IInstanceBase
+
+import {IAccess} from "./module/IAccess.sol";
+
+import {IBundleService} from "../pool/IBundleService.sol";
+import {IDistributionService} from "../distribution/IDistributionService.sol";
+import {IPolicyService} from "../product/IPolicyService.sol";
+import {IPoolService} from "../pool/IPoolService.sol";
+import {IProductService} from "../product/IProductService.sol";
+import {IPolicyService} from "../product/IPolicyService.sol";
+import {IBundleService} from "../pool/IBundleService.sol";
+
+
+
+interface IInstance is 
+    IRegisterable, 
+    ITransferInterceptor, 
+    IAccessManaged
 {
-    function getRegistry() external view override (IPolicyModule, IRegisterable) returns (IRegistry registry);
-    function getOwner() external view override (IOwnable, IAccessModule) returns(address owner);
+    error ErrorInstanceInstanceAccessManagerZero();
+    error ErrorInstanceInstanceAccessManagerAlreadySet(address instanceAccessManager);
+    error ErrorInstanceInstanceAccessManagerAuthorityMismatch(address instanceAuthority);
+
+    error ErrorInstanceBundleManagerAlreadySet(address instanceBundleManager);
+    error ErrorInstanceBundleManagerInstanceMismatch(address instance);
+    error ErrorInstanceBundleManagerAuthorityMismatch(address instanceAuthority);
+
+    error ErrorInstanceInstanceReaderInstanceMismatch(address instanceAuthority);
+
+    error ErrorInstanceInstanceStoreAlreadySet(address instanceStore);
+    error ErrorInstanceInstanceStoreAuthorityMismatch(address instanceAuthority);
+
+    function createRole(string memory roleName, string memory adminName) external returns (RoleId roleId, RoleId admin);
+    function grantRole(RoleId roleId, address account) external;
+    function revokeRole(RoleId roleId, address account) external;
+
+    function createTarget(address target, string memory name) external;
+    function setTargetFunctionRole(string memory targetName, bytes4[] calldata selectors, RoleId roleId) external;
+    function setTargetLocked(address target, bool locked) external;
 
-    function getKeyValueStore() external view override (IInstanceBase) returns (IKeyValueStore keyValueStore);
-    function getComponentOwnerService() external view override (IInstanceBase, IComponentModule) returns(IComponentOwnerService);
-    function getDistributionService() external view override returns(IDistributionService);
-    function getProductService() external view override (IInstanceBase, IBundleModule, IPolicyModule) returns(IProductService);
-    function getPoolService() external view override (IInstanceBase, IBundleModule, IPoolModule) returns(IPoolService);
+    function getDistributionService() external view returns (IDistributionService);
+    function getProductService() external view returns (IProductService);
+    function getPoolService() external view returns (IPoolService);
+    function getPolicyService() external view returns (IPolicyService);
+    function getBundleService() external view returns (IBundleService);
 
-}
+    function getMajorVersion() external pure returns (VersionPart majorVersion);
+    function getInstanceReader() external view returns (InstanceReader);
+    function getBundleManager() external view returns (BundleManager);
+    function getInstanceAccessManager() external view returns (InstanceAccessManager);
+    function getInstanceStore() external view returns (InstanceStore);
+}

package/contracts/instance/IInstanceService.sol

@@ -0,0 +1,73 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {IService} from "../shared/IService.sol";
+
+import {AccessManagerUpgradeableInitializeable} from "../shared/AccessManagerUpgradeableInitializeable.sol";
+import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {Instance} from "./Instance.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {BundleManager} from "./BundleManager.sol";
+import {InstanceStore} from "./InstanceStore.sol";
+
+interface IInstanceService is IService {
+
+    error ErrorInstanceServiceMasterInstanceAlreadySet();
+    error ErrorInstanceServiceMasterOzAccessManagerAlreadySet();
+    error ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet();
+    error ErrorInstanceServiceMasterBundleManagerAlreadySet();
+    error ErrorInstanceServiceInstanceAddressZero();
+
+    error ErrorInstanceServiceMasterInstanceReaderNotSet();
+    error ErrorInstanceServiceInstanceReaderAddressZero();
+    error ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch();
+
+    error ErrorInstanceServiceInstanceAccessManagerZero();
+    error ErrorInstanceServiceInstanceReaderZero();
+    error ErrorInstanceServiceBundleManagerZero();
+    error ErrorInstanceServiceInstanceStoreZero();
+
+    error ErrorInstanceServiceInstanceAuthorityMismatch();
+    error ErrorInstanceServiceBundleManagerAuthorityMismatch();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch2();
+    error ErrorInstanceServiceBundleMangerInstanceMismatch();
+    error ErrorInstanceServiceInstanceStoreAuthorityMismatch();
+
+    error ErrorInstanceServiceRequestUnauhorized(address caller);
+    error ErrorInstanceServiceNotInstanceOwner(address caller, NftId instanceNftId);
+    error ErrorInstanceServiceNotInstance(NftId nftId);
+    error ErrorInstanceServiceComponentNotRegistered(address componentAddress);
+    error ErrorInstanceServiceInstanceComponentMismatch(NftId instanceNftId, NftId componentNftId);
+    error ErrorInstanceServiceInvalidComponentType(address componentAddress, ObjectType expectedType, ObjectType componentType);
+    
+    event LogInstanceCloned(
+        address clonedOzAccessManager,
+        address clonedInstanceAccessManager,
+        address clonedInstance,
+        address clonedInstanceStore,
+        address clonedBundleManager, 
+        address clonedInstanceReader, 
+        NftId clonedInstanceNftId
+    );
+
+    function createInstanceClone()
+        external 
+        returns (
+            Instance clonedInstance,
+            NftId instanceNftId
+        );
+
+    function createGifTarget(
+        NftId instanceNftId,
+        address targetAddress,
+        string memory targetName,
+        bytes4[][] memory selectors,
+        RoleId[] memory roles
+    ) external;
+
+    function setComponentLocked(bool locked) external;
+}

package/contracts/instance/Instance.sol

@@ -1,74 +1,229 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {NftId} from "../types/NftId.sol";
-import {RoleId} from "../types/RoleId.sol";
+import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 
-import {InstanceBase} from "./base/InstanceBase.sol";
-import {AccessModule} from "./module/access/Access.sol";
-import {ComponentModule} from "./module/component/ComponentModule.sol";
-import {DistributionModule} from "./module/distribution/DistributionModule.sol";
-import {PolicyModule} from "./module/policy/PolicyModule.sol";
-import {PoolModule} from "./module/pool/PoolModule.sol";
-import {RiskModule} from "./module/risk/RiskModule.sol";
-import {BundleModule} from "./module/bundle/BundleModule.sol";
-import {TreasuryModule} from "./module/treasury/TreasuryModule.sol";
+import {Key32} from "../type/Key32.sol";
+import {NftId} from "../type/NftId.sol";
+import {RiskId} from "../type/RiskId.sol";
+import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, ROLE, PRODUCT, TARGET, COMPONENT, DISTRIBUTOR, DISTRIBUTOR_TYPE} from "../type/ObjectType.sol";
+import {RoleId, RoleIdLib, eqRoleId, ADMIN_ROLE, INSTANCE_ROLE, INSTANCE_OWNER_ROLE} from "../type/RoleId.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
+import {ClaimId} from "../type/ClaimId.sol";
+import {ReferralId} from "../type/Referral.sol";
+import {PayoutId} from "../type/PayoutId.sol";
+import {DistributorType} from "../type/DistributorType.sol";
 
-import {IRegistry} from "../registry/IRegistry.sol";
 import {Registerable} from "../shared/Registerable.sol";
-import {IAccessModule} from "./module/access/IAccess.sol";
-import {IBundleModule} from "./module/bundle/IBundle.sol";
-import {IComponentModule} from "./module/component/IComponent.sol";
-import {IPoolModule} from "./module/pool/IPoolModule.sol";
-import {IPolicyModule} from "./module/policy/IPolicy.sol";
-import {IInstanceBase} from "./base/IInstanceBase.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+
+import {IInstance} from "./IInstance.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {BundleManager} from "./BundleManager.sol";
+import {InstanceStore} from "./InstanceStore.sol";
+
+import {KeyValueStore} from "./base/KeyValueStore.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";
+import {IBundle} from "./module/IBundle.sol";
+import {IComponents} from "./module/IComponents.sol";
+import {IDistribution} from "./module/IDistribution.sol";
+import {IPolicy} from "./module/IPolicy.sol";
+import {IRisk} from "./module/IRisk.sol";
+import {ISetup} from "./module/ISetup.sol";
 
-import {IKeyValueStore} from "./base/IKeyValueStore.sol";
+import {IDistributionService} from "../distribution/IDistributionService.sol";
+import {IPoolService} from "../pool/IPoolService.sol";
+import {IProductService} from "../product/IProductService.sol";
+import {IPolicyService} from "../product/IPolicyService.sol";
+import {IBundleService} from "../pool/IBundleService.sol";
 
 contract Instance is
-    InstanceBase,
-    AccessModule,
-    BundleModule,
-    ComponentModule,
-    DistributionModule,
-    PolicyModule,
-    PoolModule,
-    RiskModule,
-    TreasuryModule
+    IInstance,
+    AccessManagedUpgradeable,
+    Registerable
 {
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        InstanceBase(registry, registryNftId)
-        AccessModule()
-        BundleModule()
-        DistributionModule()
-        ComponentModule()
-        PolicyModule()
-        PoolModule()
-        TreasuryModule()
+    uint256 public constant GIF_MAJOR_VERSION = 3;
+
+    bool private _initialized;
+
+    InstanceAccessManager internal _accessManager;
+    InstanceReader internal _instanceReader;
+    BundleManager internal _bundleManager;
+    InstanceStore internal _instanceStore;
+
+    modifier onlyChainNft() {
+        if(msg.sender != getRegistry().getChainNftAddress()) {
+            revert();
+        }
+        _;
+    }
+
+    function initialize(address authority, address registryAddress, address initialOwner) 
+        external 
+        initializer()
     {
-        initializeBundleModule(_keyValueStore);
-        initializeComponentModule(_keyValueStore);
-        initializeDistributionModule(_keyValueStore);
-        initializePolicyModule(_keyValueStore);
-        initializePoolModule(_keyValueStore);
-        initializeRiskModule(_keyValueStore);
+        if(authority == address(0)) {
+            revert ErrorInstanceInstanceAccessManagerZero();
+        }
+
+        __AccessManaged_init(authority);
+        
+        IRegistry registry = IRegistry(registryAddress);
+        initializeRegisterable(registryAddress, registry.getNftId(), INSTANCE(), true, initialOwner, "");
+
+        registerInterface(type(IInstance).interfaceId);    
     }
 
-    function getRegistry() public view override (Registerable, IPolicyModule) returns (IRegistry registry) { return super.getRegistry(); }
-    function getKeyValueStore() public view override (InstanceBase) returns (IKeyValueStore keyValueStore) { return super.getKeyValueStore(); }
+    //--- Roles ------------------------------------------------------------//
+
+    function createRole(string memory roleName, string memory adminName)
+        external
+        restricted // INSTANCE_OWNER_ROLE
+        returns (RoleId roleId, RoleId admin)
+    {
+        (roleId, admin) = _accessManager.createRole(roleName, adminName);
+    }
 
-    function getComponentOwnerService() external view override (IComponentModule, IInstanceBase) returns(IComponentOwnerService service) { return _componentOwnerService; }
-    function getDistributionService() external view override (IInstanceBase) returns(IDistributionService service) { return _distributionService; }
-    function getProductService() external view override (IBundleModule, IPolicyModule, IInstanceBase) returns(IProductService service) { return _productService; }
-    function getPoolService() external view override (IBundleModule, IPoolModule, IInstanceBase) returns(IPoolService service) { return _poolService; }
+    function grantRole(RoleId roleId, address account) 
+        external 
+        restricted // INSTANCE_OWNER_ROLE
+    {
+        _accessManager.grantRole(roleId, account);
+    }
+
+    function revokeRole(RoleId roleId, address account) 
+        external 
+        restricted // INSTANCE_OWNER_ROLE
+    {
+        _accessManager.revokeRole(roleId, account);
+    }
+
+    //--- Targets ------------------------------------------------------------//
+
+    function createTarget(address target, string memory name) 
+        external 
+        restricted // INSTANCE_OWNER_ROLE
+    {
+        _accessManager.createTarget(target, name);
+    }
+
+    function setTargetFunctionRole(
+        string memory targetName,
+        bytes4[] calldata selectors,
+        RoleId roleId
+    ) 
+        external 
+        restricted // INSTANCE_OWNER_ROLE
+    {
+        _accessManager.setTargetFunctionRole(targetName, selectors, roleId);
+    }
+
+    function setTargetLocked(address target, bool locked)
+        external 
+        restricted // INSTANCE_OWNER_ROLE
+    {
+        _accessManager.setTargetLockedByInstance(target, locked);
+    }
+
+    //--- ITransferInterceptor ------------------------------------------------------------//
+
+    function nftMint(address to, uint256 tokenId) external onlyChainNft {
+        assert(_accessManager.roleMembers(INSTANCE_OWNER_ROLE()) == 0);// temp
+        assert(_accessManager.grantRole(INSTANCE_OWNER_ROLE(), to) == true);
+    }
+
+    function nftTransferFrom(address from, address to, uint256 tokenId) external onlyChainNft {
+        assert(_accessManager.revokeRole(INSTANCE_OWNER_ROLE(), from) == true);
+        assert(_accessManager.grantRole(INSTANCE_OWNER_ROLE(), to) == true);
+    }
+
+    //--- initial setup functions -------------------------------------------//
+
+    function setInstanceAccessManager(InstanceAccessManager accessManager) external restricted {
+        if(address(_accessManager) != address(0)) {
+            revert ErrorInstanceInstanceAccessManagerAlreadySet(address(_accessManager));
+        }
+        if(accessManager.authority() != authority()) {
+            revert ErrorInstanceInstanceAccessManagerAuthorityMismatch(authority());
+        }
+        _accessManager = accessManager;      
+    }
+    
+    function setBundleManager(BundleManager bundleManager) external restricted() {
+        if(address(_bundleManager) != address(0)) {
+            revert ErrorInstanceBundleManagerAlreadySet(address(_bundleManager));
+        }
+        if(bundleManager.getInstance() != Instance(this)) {
+            revert ErrorInstanceBundleManagerInstanceMismatch(address(this));
+        }
+        if(bundleManager.authority() != authority()) {
+            revert ErrorInstanceBundleManagerAuthorityMismatch(authority());
+        }
+        _bundleManager = bundleManager;
+    }
+
+    function setInstanceReader(InstanceReader instanceReader) external restricted() {
+        if(instanceReader.getInstance() != Instance(this)) {
+            revert ErrorInstanceInstanceReaderInstanceMismatch(address(this));
+        }
+
+        _instanceReader = instanceReader;
+    }
+
+    //--- external view functions -------------------------------------------//
+
+    function getInstanceReader() external view returns (InstanceReader) {
+        return _instanceReader;
+    }
+
+    function getBundleManager() external view returns (BundleManager) {
+        return _bundleManager;
+    }
+
+    function getInstanceAccessManager() external view returns (InstanceAccessManager) {
+        return _accessManager;
+    }
+
+    function setInstanceStore(InstanceStore instanceStore) external restricted {
+        if(address(_instanceStore) != address(0)) {
+            revert ErrorInstanceInstanceStoreAlreadySet(address(_instanceStore));
+        }
+        if(instanceStore.authority() != authority()) {
+            revert ErrorInstanceInstanceStoreAuthorityMismatch(authority());
+        }
+        _instanceStore = instanceStore;
+    }
+
+    function getInstanceStore() external view returns (InstanceStore) {
+        return _instanceStore;
+    }
+
+    function getMajorVersion() external pure returns (VersionPart majorVersion) {
+        return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
+    }
+
+    function getDistributionService() external view returns (IDistributionService) {
+        return IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), VersionPart.wrap(3)));
+    }
+
+    function getProductService() external view returns (IProductService) {
+        return IProductService(getRegistry().getServiceAddress(PRODUCT(), VersionPart.wrap(3)));
+    }
+
+    function getPoolService() external view returns (IPoolService) {
+        return IPoolService(getRegistry().getServiceAddress(POOL(), VersionPart.wrap(3)));
+    }
+
+    function getPolicyService() external view returns (IPolicyService) {
+        return IPolicyService(getRegistry().getServiceAddress(POLICY(), VersionPart.wrap(3)));
+    }
+
+    function getBundleService() external view returns (IBundleService) {
+        return IBundleService(getRegistry().getServiceAddress(BUNDLE(), VersionPart.wrap(3)));
+    }
 
-    function getOwner() public view override (IAccessModule, Registerable) returns(address owner) { return super.getOwner(); }
-}
+    //--- internal view/pure functions --------------------------------------//
+}