@etherisc/gif-next 0.0.2-7d65090-351 → 0.0.2-7dc3cd3-858

package/contracts/instance/InstanceService.sol

@@ -11,13 +11,12 @@ import {NftId} from "../type/NftId.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {SecondsLib} from "../type/Seconds.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
-import {ADMIN_ROLE, INSTANCE_OWNER_ROLE, DISTRIBUTION_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE, INSTANCE_SERVICE_ROLE, DISTRIBUTION_SERVICE_ROLE, POOL_SERVICE_ROLE, PRODUCT_SERVICE_ROLE, APPLICATION_SERVICE_ROLE, POLICY_SERVICE_ROLE, CLAIM_SERVICE_ROLE, BUNDLE_SERVICE_ROLE, INSTANCE_ROLE} from "../type/RoleId.sol";
+import {ADMIN_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
 import {ObjectType, INSTANCE, BUNDLE, APPLICATION, CLAIM, DISTRIBUTION, INSTANCE, POLICY, POOL, PRODUCT, REGISTRY, STAKING} from "../type/ObjectType.sol";
 
 import {Service} from "../shared/Service.sol";
 import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IService} from "../shared/IService.sol";
-import {AccessManagerExtendedInitializeable} from "../shared/AccessManagerExtendedInitializeable.sol";
 
 import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
 import {IPoolComponent} from "../pool/IPoolComponent.sol";
@@ -29,12 +28,13 @@ import {IStakingService} from "../staking/IStakingService.sol";
 import {TargetManagerLib} from "../staking/TargetManagerLib.sol";
 
 import {Instance} from "./Instance.sol";
+import {IModuleAuthorization} from "../authorization/IModuleAuthorization.sol";
 import {IInstance} from "./IInstance.sol";
-import {InstanceAdmin} from "./InstanceAdmin.sol";
+import {InstanceAdminNew} from "./InstanceAdminNew.sol";
 import {IInstanceService} from "./IInstanceService.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceStore} from "./InstanceStore.sol";
-import {InstanceAuthorizationsLib} from "./InstanceAuthorizationsLib.sol";
+// import {InstanceAuthorizationsLib} from "./InstanceAuthorizationsLib.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
@@ -50,7 +50,6 @@ contract InstanceService is
     IRegistryService internal _registryService;
     IStakingService internal _stakingService;
 
-    address internal _masterAccessManager;
     address internal _masterInstanceAdmin;
     address internal _masterInstance;
     address internal _masterInstanceReader;
@@ -101,71 +100,43 @@ contract InstanceService is
             NftId clonedInstanceNftId
         )
     {
+        // tx sender will become instance owner
         address instanceOwner = msg.sender;
-        AccessManagerExtendedInitializeable clonedAccessManager = AccessManagerExtendedInitializeable(
-            Clones.clone(_masterAccessManager));
 
-        // initially grants ADMIN_ROLE to this (being the instance service). 
-        // This will allow the instance service to bootstrap the authorizations of the instance.
-        // Instance service will renounce ADMIN_ROLE when bootstraping is finished
-        clonedAccessManager.initialize(address(this));
+        // start with setting up the instance admin
+        InstanceAdminNew clonedInstanceAdmin = InstanceAdminNew(Clones.clone(_masterInstanceAdmin));
+        clonedInstanceAdmin.initialize(InstanceAdminNew(_masterInstanceAdmin).getInstanceAuthorization());
 
-        clonedInstance = Instance(Clones.clone(_masterInstance));
-        clonedInstance.initialize(
-            address(clonedAccessManager),
-            address(getRegistry()), 
-            instanceOwner);
-        // initialize and set before instance reader
         InstanceStore clonedInstanceStore = InstanceStore(Clones.clone(address(_masterInstanceStore)));
-        clonedInstanceStore.initialize(address(clonedInstance));
-        clonedInstance.setInstanceStore(clonedInstanceStore);
-        
+        BundleManager clonedBundleManager = BundleManager(Clones.clone(_masterInstanceBundleManager));
         InstanceReader clonedInstanceReader = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-        clonedInstanceReader.initialize(address(clonedInstance));
-        clonedInstance.setInstanceReader(clonedInstanceReader);
 
-        BundleManager clonedBundleManager = BundleManager(Clones.clone(_masterInstanceBundleManager));
-        clonedBundleManager.initialize(address(clonedInstance));
-        clonedInstance.setBundleManager(clonedBundleManager);
-
-        InstanceAdmin clonedInstanceAdmin = InstanceAdmin(Clones.clone(_masterInstanceAdmin));
-        clonedAccessManager.grantRole(ADMIN_ROLE().toInt(), address(clonedInstanceAdmin), 0);
-        clonedInstanceAdmin.initialize(address(clonedInstance));
-        clonedInstance.setInstanceAdmin(clonedInstanceAdmin);
-
-        // TODO amend setters with instance specific , policy manager ...
-
-        // TODO library does external calls -> but it is registry and access manager -> find out is it best practice
-        InstanceAuthorizationsLib.grantInitialAuthorizations(
-            clonedAccessManager, 
-            clonedInstanceAdmin, 
-            clonedInstance, 
-            clonedBundleManager, 
-            clonedInstanceStore, 
-            instanceOwner,
+        // clone instance
+        clonedInstance = Instance(Clones.clone(_masterInstance));
+        clonedInstance.initialize(
+            clonedInstanceAdmin,
+            clonedInstanceStore,
+            clonedBundleManager,
+            clonedInstanceReader,
             getRegistry(),
-            getVersion().toMajorPart());
-
-        clonedAccessManager.renounceRole(ADMIN_ROLE().toInt(), address(this));
+            instanceOwner);
 
-        // register new instance with registry
-        IRegistry.ObjectInfo memory info = _registryService.registerInstance(clonedInstance, instanceOwner);
-        clonedInstanceNftId = info.nftId;
+        // register cloned instance with registry
+        clonedInstanceNftId = _registryService.registerInstance(
+            clonedInstance, instanceOwner).nftId;
 
-        // create corresponding staking target
+        // register cloned instance as staking target
         _stakingService.createInstanceTarget(
             clonedInstanceNftId,
             TargetManagerLib.getDefaultLockingPeriod(),
             TargetManagerLib.getDefaultRewardRate());
 
+        // MUST be set after instance is set up and registered
+        clonedInstanceAdmin.initializeInstanceAuthorization(address(clonedInstance));
+
         emit LogInstanceCloned(
-            address(clonedAccessManager), 
-            address(clonedInstanceAdmin), 
-            address(clonedInstance),
-            address(clonedInstanceStore),
-            address(clonedBundleManager), 
-            address(clonedInstanceReader), 
-            clonedInstanceNftId);
+            clonedInstanceNftId,
+            address(clonedInstance));
     }
 
 
@@ -239,9 +210,10 @@ contract InstanceService is
                 instanceNftId).objectAddress);
 
         // no revert in case already locked
-        instance.getInstanceAdmin().setTargetLockedByService(
-            componentAddress, 
-            locked);
+        // TODO refactor/implement
+        // instance.getInstanceAdmin().setTargetLockedByService(
+        //     componentAddress, 
+        //     locked);
     }
 
 
@@ -255,14 +227,13 @@ contract InstanceService is
             returns(NftId masterInstanceNftId)
     {
         if(_masterInstance != address(0)) { revert ErrorInstanceServiceMasterInstanceAlreadySet(); }
-        if(_masterAccessManager != address(0)) { revert ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet(); }
         if(_masterInstanceAdmin != address(0)) { revert ErrorInstanceServiceMasterInstanceAdminAlreadySet(); }
         if(_masterInstanceBundleManager != address(0)) { revert ErrorInstanceServiceMasterBundleManagerAlreadySet(); }
 
         if(instanceAddress == address(0)) { revert ErrorInstanceServiceInstanceAddressZero(); }
 
         IInstance instance = IInstance(instanceAddress);
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
+        InstanceAdminNew instanceAdmin = instance.getInstanceAdmin();
         address instanceAdminAddress = address(instanceAdmin);
         InstanceReader instanceReader = instance.getInstanceReader();
         address instanceReaderAddress = address(instanceReader);
@@ -282,7 +253,6 @@ contract InstanceService is
         if(bundleManager.getInstance() != instance) { revert ErrorInstanceServiceBundleMangerInstanceMismatch(); }
         if(instanceReader.getInstance() != instance) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch2(); }
 
-        _masterAccessManager = instance.authority();
         _masterInstanceAdmin = instanceAdminAddress;
         _masterInstance = instanceAddress;
         _masterInstanceReader = instanceReaderAddress;
@@ -314,7 +284,7 @@ contract InstanceService is
         Instance instance = Instance(instanceInfo.objectAddress);
         
         InstanceReader upgradedInstanceReaderClone = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-        upgradedInstanceReaderClone.initialize(address(instance));
+        upgradedInstanceReaderClone.initializeWithInstance(address(instance));
         instance.setInstanceReader(upgradedInstanceReaderClone);
     }
 
@@ -340,6 +310,25 @@ contract InstanceService is
     }
 
 
+    function initializeAuthorization(
+        NftId instanceNftId, 
+        IInstanceLinkedComponent component
+    )
+        external
+        virtual
+        restricted()
+    {
+        (IInstance instance, ) = _validateInstanceAndComponent(
+            instanceNftId, 
+            address(component));
+
+        InstanceAdminNew instanceAdmin = instance.getInstanceAdmin();
+        instanceAdmin.initializeComponentAuthorization(
+            address(component),
+            component.getAuthorization());
+    }
+
+
     function createComponentTarget(
         NftId instanceNftId,
         address targetAddress,
@@ -378,13 +367,15 @@ contract InstanceService is
             // or targetInfo
         ) = _validateInstanceAndComponent(instanceNftId, targetAddress);
 
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-        instanceAdmin.createGifTarget(targetAddress, targetName);
+        InstanceAdminNew instanceAdmin = instance.getInstanceAdmin();
+
+        // TODO refactor/implement
+        // instanceAdmin.createGifTarget(targetAddress, targetName);
+
         // set proposed target config
-        // TODO restriction: gif targets are set only once and only here?
-        //      assume config is a mix of gif and custom roles and no further configuration by INSTANCE_OWNER_ROLE is ever needed?
         for(uint roleIdx = 0; roleIdx < roles.length; roleIdx++) {
-            instanceAdmin.setTargetFunctionRoleByService(targetName, selectors[roleIdx], roles[roleIdx]);
+            // TODO refactor/implement
+            // instanceAdmin.setTargetFunctionRoleByService(targetName, selectors[roleIdx], roles[roleIdx]);
         }
     }
     

package/contracts/instance/InstanceStore.sol

@@ -34,11 +34,15 @@ contract InstanceStore is
     KeyValueStore,
     ObjectCounter
 {
-    function initialize(address instance)
+
+    /// @dev This initializer needs to be called from the instance itself.
+    function initialize()
         public 
         initializer()
     {
+        address instance = msg.sender;
         address authority = IInstance(instance).authority();
+
         __AccessManaged_init(authority);
 
         initializeLifecycle();

package/contracts/instance/base/ObjectManager.sol

@@ -22,16 +22,15 @@ contract ObjectManager is
     mapping(NftId compnentNftId => LibNftIdSet.Set objects) internal _allObjects;
     IInstance internal _instance; // store instance address -> more flexible, instance may not be registered during ObjectManager initialization
 
-    /// @dev call to initialize MUST be made in the same transaction as cloning of the contract
-    function initialize(address instanceAddress) 
-        initializer
-        external 
+    /// @dev This initializer needs to be called from the instance itself.
+    function initialize() 
+        external
+        initializer()
     {
-        IInstance instance = IInstance(instanceAddress);
-        __Cloneable_init(instance.authority(), address(instance.getRegistry()));
-        _instance = instance;
+        _instance = IInstance(msg.sender);
+        __Cloneable_init(_instance.authority(), address(_instance.getRegistry()));
         
-        emit LogObjectManagerInitialized(instanceAddress);
+        emit LogObjectManagerInitialized(address(_instance));
     }
 
     function getInstance() external view returns (IInstance) {

package/contracts/oracle/BasicOracle.sol

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IAuthorization} from "../../contracts/authorization/IAuthorization.sol";
+import {NftId} from "../../contracts/type/NftId.sol";
+import {Oracle} from "../../contracts/oracle/Oracle.sol";
+import {RequestId} from "../../contracts/type/RequestId.sol";
+
+contract BasicOracle is
+    Oracle
+{
+
+    /// Function to provide reponse data releated to request id.
+    function respond(
+        RequestId requestId,
+        bytes memory responseData
+    )
+        external
+        virtual
+        restricted()
+    {
+        _respond(requestId, responseData);
+    }
+
+    function _initializeBasicOracle(
+        address registry,
+        NftId instanceNftId,
+        IAuthorization authorization,
+        address initialOwner,
+        string memory name,
+        address token
+    )
+        internal
+        virtual
+        onlyInitializing()
+    {
+
+        _initializeOracle(
+            registry,
+            instanceNftId,
+            authorization,
+            initialOwner,
+            name,
+            token,
+            "",
+            "");
+    }
+}

package/contracts/oracle/BasicOracleAuthorization.sol

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Authorization} from "../authorization/Authorization.sol";
+import {BasicOracle} from "./BasicOracle.sol"; 
+import {ORACLE} from "../type/ObjectType.sol";
+import {IAccess} from "../authorization/IAccess.sol";
+import {IOracle} from "./IOracle.sol"; 
+import {PUBLIC_ROLE} from "../../contracts/type/RoleId.sol";
+import {RoleId} from "../type/RoleId.sol";
+
+
+contract BasicOracleAuthorization
+     is Authorization
+{
+
+     constructor(string memory componentName)
+          Authorization(componentName)
+     {}
+
+     function _setupTargets()
+          internal
+          virtual override
+     {
+          // basic component target
+          _addComponentTargetWithRole(ORACLE()); 
+     }
+
+
+     function _setupTargetAuthorizations()
+          internal
+          virtual override
+     {
+          IAccess.FunctionInfo[] storage functions;
+
+          // authorize public role (open access to any account, only allows to lock target)
+          functions = _authorizeForTarget(getTargetName(), getServiceRole(ORACLE()));
+          _authorize(functions, IOracle.request.selector, "request");
+          _authorize(functions, IOracle.cancel.selector, "cancel");
+
+          // authorize public role (open access to any account, only allows to lock target)
+          functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+          _authorize(functions, BasicOracle.respond.selector, "respond");
+     }
+}
+

package/contracts/oracle/IOracle.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {NftId} from "../type/NftId.sol";
+import {RequestId} from "../type/RequestId.sol";
 import {Timestamp} from "../type/Timestamp.sol";
 
 
@@ -17,4 +18,19 @@ interface IOracle {
         Timestamp expiredAt; // expiry timestamp
         bool isCancelled;
     }
+
+
+    /// @dev Callback function for oracle service to notify this oracle component to retreive some oracle data.
+    function request(
+        RequestId requestId,
+        NftId requesterId,
+        bytes calldata requestData,
+        Timestamp expiryAt
+    ) external;
+
+
+    /// @dev Callback function for oracle service to notify this oracle component that the specified oracle request has ben cancelled by the requestor.
+    function cancel(
+        RequestId requestId
+    ) external;
 }

package/contracts/oracle/Oracle.sol

@@ -2,16 +2,17 @@
 pragma solidity ^0.8.20;
 
 import {COMPONENT, ORACLE} from "../type/ObjectType.sol";
-import {IOracleService} from "./IOracleService.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
-import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
 import {IOracleComponent} from "./IOracleComponent.sol";
+import {IOracleService} from "./IOracleService.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
+import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
 import {UFixed} from "../type/UFixed.sol";
 
 
@@ -28,29 +29,6 @@ abstract contract Oracle is
     }
 
 
-    function initializeOracle(
-        address registry,
-        NftId instanceNftId,
-        address initialOwner,
-        string memory name,
-        address token,
-        bytes memory registryData, // writeonly data that will saved in the object info record of the registry
-        bytes memory componentData // component specifidc data 
-    )
-        public
-        virtual
-        onlyInitializing()
-    {
-        initializeInstanceLinkedComponent(registry, instanceNftId, name, token, ORACLE(), true, initialOwner, registryData, componentData);
-
-        OracleStorage storage $ = _getOracleStorage();
-        $._oracleService = IOracleService(_getServiceAddress(ORACLE())); 
-        $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
-
-        registerInterface(type(IOracleComponent).interfaceId);
-    }
-
-
     function register()
         external
         virtual
@@ -60,16 +38,6 @@ abstract contract Oracle is
     }
 
 
-    function isVerifying()
-        external 
-        virtual 
-        view 
-        returns (bool verifying)
-    {
-        return false;
-    }
-
-
     function request(
         RequestId requestId,
         NftId requesterId,
@@ -78,7 +46,7 @@ abstract contract Oracle is
     )
         external
         virtual
-        // restricted() // TODO enable: only oracle service
+        restricted()
     {
         _request(requestId, requesterId, requestData, expiryAt);
     }
@@ -89,16 +57,60 @@ abstract contract Oracle is
     )
         external
         virtual
-        // restricted() // TODO enable: only oracle service
+        restricted()
     {
         _cancel(requestId);
     }
 
 
-    /// @dev internal function for handling requests.
-    /// empty implementation.
-    /// overwrite this function to implement use case specific handling
-    /// for oracle calls.
+    /// @dev Not relevant for oracle components, always returns false.
+    function isVerifying()
+        external 
+        virtual 
+        view 
+        returns (bool verifying)
+    {
+        return false;
+    }
+
+
+    function _initializeOracle(
+        address registry,
+        NftId instanceNftId,
+        IAuthorization authorization,
+        address initialOwner,
+        string memory name,
+        address token,
+        bytes memory registryData, // writeonly data that will saved in the object info record of the registry
+        bytes memory componentData // component specifidc data 
+    )
+        internal
+        virtual
+        onlyInitializing()
+    {
+        _initializeInstanceLinkedComponent(
+            registry, 
+            instanceNftId, 
+            name, 
+            token, 
+            ORACLE(), 
+            authorization,
+            true, 
+            initialOwner, 
+            registryData, 
+            componentData);
+
+        OracleStorage storage $ = _getOracleStorage();
+        $._oracleService = IOracleService(_getServiceAddress(ORACLE())); 
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
+
+        registerInterface(type(IOracleComponent).interfaceId);
+    }
+
+
+    /// @dev Internal function for handling requests.
+    /// Empty implementation.
+    /// Overwrite this function to implement use case specific handling for oracle calls.
     function _request(
         RequestId requestId,
         NftId requesterId,
@@ -111,9 +123,9 @@ abstract contract Oracle is
     }
 
 
-    /// @dev internal function for cancelling requests.
-    /// empty implementation.
-    /// overwrite this function to implement use case specific cancelling
+    /// @dev Internal function for cancelling requests.
+    /// Empty implementation.
+    /// Overwrite this function to implement use case specific cancelling.
     function _cancel(
         RequestId requestId
     )
@@ -123,9 +135,9 @@ abstract contract Oracle is
     }
 
 
-    /// @dev internal function for handling oracle responses.
-    /// use this function in use case specific external/public functions
-    /// to handle use case specific response handling.
+    /// @dev Internal function for handling oracle responses.
+    /// Default implementation sends response back to oracle service.
+    /// Use this function in use case specific external/public functions to handle use case specific response handling.
     function _respond(
         RequestId requestId,
         bytes memory responseData