@etherisc/gif-next 0.0.2-a307d03-692 → 0.0.2-a33f6f4-689

package/contracts/instance/InstanceAdmin.sol

@@ -10,7 +10,7 @@ import {IInstance} from "./IInstance.sol";
 import {AccessAdmin} from "../authorization/AccessAdmin.sol";
 import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
+import {ObjectType, INSTANCE, ORACLE} from "../type/ObjectType.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
 import {Str, StrLib} from "../type/String.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
@@ -21,19 +21,19 @@ contract InstanceAdmin is
     AccessAdmin
 {
     string public constant INSTANCE_TARGET_NAME = "Instance";
-    string public constant INSTANCE_STORE_TARGET_NAME = "InstanceStore";
     string public constant INSTANCE_ADMIN_TARGET_NAME = "InstanceAdmin";
+    string public constant INSTANCE_STORE_TARGET_NAME = "InstanceStore";
     string public constant BUNDLE_SET_TARGET_NAME = "BundleSet";
-    string public constant RISK_SET_TAGET_NAME = "RiskSet";
+    string public constant RISK_SET_TARGET_NAME = "RiskSet";
 
     uint64 public constant CUSTOM_ROLE_ID_MIN = 10000; // MUST be even
 
-    error ErrorInstanceAdminCallerNotInstanceOwner(address caller);
-    error ErrorInstanceAdminCallerNotInstance(address caller);
-    error ErrorInstanceAdminInstanceAlreadyLocked();
-    error ErrorInstanceAdminNotRegistered(address target);
+    error ErrorInstanceAdminNotInstanceService(address caller);
+
+    error ErrorInstanceAdminNotRegistered(address instance);
+    error ErrorInstanceAdminNotInstance(address instance);
+    error ErrorInstanceAdminAlreadyAuthorized(address instance);
 
-    error ErrorInstanceAdminAlreadyAuthorized(address target);
     error ErrorInstanceAdminNotComponentRole(RoleId roleId);
     error ErrorInstanceAdminRoleAlreadyExists(RoleId roleId);
     error ErrorInstanceAdminRoleTypeNotContract(RoleId roleId, IAccess.RoleType roleType);
@@ -43,130 +43,134 @@ contract InstanceAdmin is
 
     IInstance internal _instance;
     IRegistry internal _registry;
+    VersionPart internal _release;
     uint64 internal _customIdNext;
 
     mapping(address target => RoleId roleId) internal _targetRoleId;
     uint64 internal _components;
 
-    IAuthorization internal _instanceAuthorization;
-
-
-    modifier onlyInstanceOwner() {        
-        if(msg.sender != _registry.ownerOf(address(_instance))) {
-            revert ErrorInstanceAdminCallerNotInstanceOwner(msg.sender);
-        }
-        _;
-    }
-
-    modifier onlyInstance() {
-        if(msg.sender != address(_instance)) {
-            revert ErrorInstanceAdminCallerNotInstance(msg.sender);
+    modifier onlyInstanceService() {
+        if (msg.sender != _registry.getServiceAddress(INSTANCE(), getRelease())) {
+            revert ErrorInstanceAdminNotInstanceService(msg.sender);
         }
         _;
     }
 
     /// @dev Only used for master instance admin.
-    /// Contracts created via constructor come with disabled initializers.
-    constructor(
-        address instanceAuthorization
-    ) {
-        initialize(new AccessManagerCloneable());
-
-        _instanceAuthorization = IAuthorization(instanceAuthorization);
-
-        _disableInitializers();
+    constructor(address accessManager) {
+        initialize(
+            accessManager,
+            "MasterInstanceAdmin");
     }
 
 
-    function initialize(
-        AccessManagerCloneable clonedAccessManager,
-        IRegistry registry,
-        VersionPart release
-    )
-        external
-        initializer()
-    {
-        __AccessAdmin_init(clonedAccessManager);
-
-        clonedAccessManager.completeSetup(
-            address(registry), 
-            release); 
-
-        _registry = registry;
-    }
-
     /// @dev Completes the initialization of this instance admin using the provided instance, registry and version.
     /// Important: Initialization of instance admin is only complete after calling this function. 
     /// Important: The instance MUST be registered and all instance supporting contracts must be wired to this instance.
     function completeSetup(
+        address registry,
         address instance,
-        address authorization
+        address authorization,
+        VersionPart release
     )
         external
-        reinitializer(uint64(getRelease().toInt()))
+        reinitializer(uint64(release.toInt()))
         onlyDeployer()
     {
+        // checks
+        _checkRegistry(registry);
+        _checkIsRegistered(registry, instance, INSTANCE());
+
+        AccessManagerCloneable(
+            authority()).completeSetup(
+                registry, 
+                release); 
+
+        _checkAuthorization(authorization, INSTANCE(), release, true);
+
+        // effects
+        _registry = IRegistry(registry);
+        _release = release;
+
+        _instance = IInstance(instance);
+        _authorization = IAuthorization(authorization);
         _components = 0;
         _customIdNext = CUSTOM_ROLE_ID_MIN;
-        _instance = IInstance(instance);
-        _instanceAuthorization = IAuthorization(authorization);
-
-        _checkTargetIsReadyForAuthorization(instance);
 
-        // check matching releases
-        if (_instanceAuthorization.getRelease() != getRelease()) {
-            revert ErrorInstanceAdminReleaseMismatch();
-        }
+        // link nft ownability to instance
+        _linkToNftOwnable(instance);
 
         // create instance role and target
         _setupInstance(instance);
 
         // add instance authorization
-        _createRoles(_instanceAuthorization);
-
+        _createRoles(_authorization);
+        // _createTargets(_authorization);
         _setupInstanceHelperTargetsWithRoles();
-        _createTargetAuthorizations(_instanceAuthorization);
+        _createTargetAuthorizations(_authorization);
+    }
+
+
+    function _createTargets(IAuthorization authorization)
+        internal
+    {
+        _createTargetWithRole(address(this), INSTANCE_ADMIN_TARGET_NAME, authorization.getTargetRole(StrLib.toStr(INSTANCE_ADMIN_TARGET_NAME)));
+        _createTargetWithRole(address(_instance.getInstanceStore()), INSTANCE_STORE_TARGET_NAME, authorization.getTargetRole(StrLib.toStr(INSTANCE_STORE_TARGET_NAME)));
+        _createTargetWithRole(address(_instance.getBundleSet()), BUNDLE_SET_TARGET_NAME, authorization.getTargetRole(StrLib.toStr(BUNDLE_SET_TARGET_NAME)));
+        _createTargetWithRole(address(_instance.getRiskSet()), RISK_SET_TARGET_NAME, authorization.getTargetRole(StrLib.toStr(RISK_SET_TARGET_NAME)));
     }
 
 
     /// @dev Initializes the authorization for the specified component.
     /// Important: The component MUST be registered.
     function initializeComponentAuthorization(
-        IInstanceLinkedComponent component
+        address componentAddress,
+        ObjectType expectedType
     )
         external
         restricted()
     {
-        // TODO check componentInfo exists
-        // TODO deploy token handler here
         // checks
-        _checkTargetIsReadyForAuthorization(address(component));
-
-        // setup target and role for component (including token handler)
-        _setupComponentAndTokenHandler(component);
+        _checkIsRegistered(address(getRegistry()), componentAddress, expectedType);
 
-        // create other roles
+        IInstanceLinkedComponent component = IInstanceLinkedComponent(componentAddress);
         IAuthorization authorization = component.getAuthorization();
+        _checkAuthorization(address(authorization), expectedType, getRelease(), false);
 
-        _createRoles(authorization);        
+        // effects
+        // setup target and role for component (including token handler if applicable)
+        _setupComponentAndTokenHandler(component, expectedType);
 
+        // create other roles and function authorizations
+        _createRoles(authorization);
         _createTargetAuthorizations(authorization);
     }
 
+    function getRelease()
+        public
+        view
+        override
+        returns (VersionPart release)
+    {
+        return _release;
+    }
+
+
     // create instance role and target
     function _setupInstance(address instance) internal {
+
         // create instance role
-        RoleId instanceRoleId = _instanceAuthorization.getTargetRole(
-            _instanceAuthorization.getMainTarget());
+        RoleId instanceRoleId = _authorization.getTargetRole(
+            _authorization.getMainTarget());
 
         _createRole(
             instanceRoleId,
-            _instanceAuthorization.getRoleInfo(instanceRoleId));
+            _authorization.getRoleInfo(instanceRoleId));
 
         // create instance target
         _createTarget(
             instance, 
-            _instanceAuthorization.getMainTargetName(), 
+            _authorization.getMainTargetName(), 
             true, // checkAuthority
             false); // custom
 
@@ -198,21 +202,28 @@ contract InstanceAdmin is
 
     function setInstanceLocked(bool locked)
         external
-        onlyInstanceOwner()
+        // not restricted(): need to operate on locked instances to unlock instance
+        onlyInstanceService()
     {
         AccessManagerCloneable accessManager = AccessManagerCloneable(authority());
-
-        if(accessManager.isLocked() == locked) {
-            revert ErrorInstanceAdminInstanceAlreadyLocked();
-        }
         accessManager.setLocked(locked);
     }
 
+
     function setTargetLocked(address target, bool locked) 
         external 
-        onlyInstance()
+        // not restricted(): might need to operate on targets while instance is locked
+        onlyInstanceService()
+    {
+        _setTargetLocked(target, locked);
+    }
+
+
+    function setComponentLocked(address target, bool locked) 
+        external 
+        restricted()
     {
-        _setTargetClosed(target, locked);
+        _setTargetLocked(target, locked);
     }
 
     /// @dev Returns the number of components that have been registered with this instance.   
@@ -230,12 +241,15 @@ contract InstanceAdmin is
         view
         returns (IAuthorization instanceAuthorizaion)
     {
-        return _instanceAuthorization;
+        return _authorization;
     }
 
     // ------------------- Internal functions ------------------- //
 
-    function _setupComponentAndTokenHandler(IInstanceLinkedComponent component)
+    function _setupComponentAndTokenHandler(
+        IInstanceLinkedComponent component,
+        ObjectType componentType
+    )
         internal
     {
 
@@ -252,25 +266,27 @@ contract InstanceAdmin is
             true, // checkAuthority
             false); // custom
 
-        // create component's token handler target
-        NftId componentNftId = _registry.getNftIdForAddress(address(component));
-        address tokenHandler = address(
-            _instance.getInstanceReader().getComponentInfo(
-                componentNftId).tokenHandler);
-
-        _createTarget(
-            tokenHandler, 
-            authorization.getTokenHandlerName(), 
-            true, 
-            false);
+        // create component's token handler target if app
+        if (componentType != ORACLE()) {
+            NftId componentNftId = _registry.getNftIdForAddress(address(component));
+            address tokenHandler = address(
+                _instance.getInstanceReader().getComponentInfo(
+                    componentNftId).tokenHandler);
+
+            _createTarget(
+                tokenHandler, 
+                authorization.getTokenHandlerName(), 
+                true, 
+                false);
+
+            // token handler does not require its own role
+            // token handler is not calling other components
+        }
 
         // assign component role to component
         _grantRoleToAccount(
             componentRoleId, 
             address(component));
-
-        // token handler does not require its own role
-        // token handler is not calling other components
     }
 
 
@@ -324,20 +340,6 @@ contract InstanceAdmin is
     }
 
 
-    function _checkTargetIsReadyForAuthorization(address target)
-        internal
-        view
-    {
-        if (!_registry.isRegistered(target)) {
-            revert ErrorInstanceAdminNotRegistered(target);
-        }
-
-        if (targetExists(target)) {
-            revert ErrorInstanceAdminAlreadyAuthorized(target);
-        }
-    }
-
-
     function _createRoles(IAuthorization authorization)
         internal
     {
@@ -404,7 +406,7 @@ contract InstanceAdmin is
     {
         // check that target name is defined in authorization specification
         Str name = StrLib.toStr(targetName);
-        if (!_instanceAuthorization.targetExists(name)) {
+        if (!_authorization.targetExists(name)) {
             revert ErrorInstanceAdminExpectedTargetMissing(targetName);
         }
 
@@ -416,7 +418,7 @@ contract InstanceAdmin is
             false);
 
         // assign target role if defined
-        RoleId targetRoleId = _instanceAuthorization.getTargetRole(name);
+        RoleId targetRoleId = _authorization.getTargetRole(name);
         if (targetRoleId != RoleIdLib.zero()) {
             _grantRoleToAccount(targetRoleId, target);
         }
@@ -425,17 +427,16 @@ contract InstanceAdmin is
     function _setupInstanceHelperTargetsWithRoles()
         internal
     {
-        // _checkAndCreateTargetWithRole(address(_instance), INSTANCE_TARGET_NAME);
 
         // create module targets
         _checkAndCreateTargetWithRole(address(_instance.getInstanceStore()), INSTANCE_STORE_TARGET_NAME);
         _checkAndCreateTargetWithRole(address(_instance.getInstanceAdmin()), INSTANCE_ADMIN_TARGET_NAME);
         _checkAndCreateTargetWithRole(address(_instance.getBundleSet()), BUNDLE_SET_TARGET_NAME);
-        _checkAndCreateTargetWithRole(address(_instance.getRiskSet()), RISK_SET_TAGET_NAME);
+        _checkAndCreateTargetWithRole(address(_instance.getRiskSet()), RISK_SET_TARGET_NAME);
 
-        // create targets for services that need to access the module targets
-        ObjectType[] memory serviceDomains = _instanceAuthorization.getServiceDomains();
-        VersionPart release = _instanceAuthorization.getRelease();
+        // create targets for services that need to access the instance targets
+        ObjectType[] memory serviceDomains = _authorization.getServiceDomains();
+        VersionPart release = _authorization.getRelease();
         ObjectType serviceDomain;
 
         for (uint256 i = 0; i < serviceDomains.length; i++) {
@@ -443,7 +444,7 @@ contract InstanceAdmin is
 
             _checkAndCreateTargetWithRole(
                 _registry.getServiceAddress(serviceDomain, release),
-                _instanceAuthorization.getServiceTarget(serviceDomain).toString());
+                _authorization.getServiceTarget(serviceDomain).toString());
         }
     }
 }

package/contracts/instance/InstanceAuthorizationV3.sol

@@ -1,17 +1,16 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {
-     ACCOUNTING, ORACLE, POOL, INSTANCE, COMPONENT, DISTRIBUTION, APPLICATION, POLICY, CLAIM, BUNDLE, RISK
-} from "../../contracts/type/ObjectType.sol";
+import {IAccess} from "../authorization/IAccess.sol";
 
+import {Authorization} from "../authorization/Authorization.sol";
+import {ACCOUNTING, ORACLE, POOL, INSTANCE, COMPONENT, DISTRIBUTION, APPLICATION, POLICY, CLAIM, BUNDLE, RISK} from "../../contracts/type/ObjectType.sol";
 import {BundleSet} from "../instance/BundleSet.sol";
-import {RiskSet} from "../instance/RiskSet.sol"; 
-import {IAccess} from "../authorization/IAccess.sol";
 import {Instance} from "../instance/Instance.sol";
 import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
-import {Authorization} from "../authorization/Authorization.sol";
+import {PUBLIC_ROLE} from "../type/RoleId.sol";
+import {RiskSet} from "../instance/RiskSet.sol"; 
 
 
 contract InstanceAuthorizationV3
@@ -27,19 +26,10 @@ contract InstanceAuthorizationV3
      string public constant RISK_SET_TARGET_NAME = "RiskSet";
 
      constructor()
-          Authorization(INSTANCE_TARGET_NAME, INSTANCE())
+          Authorization(INSTANCE_TARGET_NAME, INSTANCE(), false, false)
      { }
 
-     function _setupTargets()
-          internal
-          override
-     {
-          // instance supporting targets
-          _addTarget(INSTANCE_STORE_TARGET_NAME);
-          _addTarget(INSTANCE_ADMIN_TARGET_NAME);
-          _addTarget(BUNDLE_SET_TARGET_NAME);
-          _addTarget(RISK_SET_TARGET_NAME);
-
+     function _setupServiceTargets() internal virtual override {
           // service targets relevant to instance
           _addServiceTargetWithRole(INSTANCE());
           _addServiceTargetWithRole(ACCOUNTING());
@@ -54,6 +44,19 @@ contract InstanceAuthorizationV3
           _addServiceTargetWithRole(CLAIM());
      }
 
+     function _setupTargets()
+          internal
+          override
+     {
+          // instance supporting targets
+          // _addGifContractTarget(INSTANCE_ADMIN_TARGET_NAME);
+          _addTarget(INSTANCE_ADMIN_TARGET_NAME);
+          _addTarget(INSTANCE_STORE_TARGET_NAME);
+          _addTarget(BUNDLE_SET_TARGET_NAME);
+          _addTarget(RISK_SET_TARGET_NAME);
+
+     }
+
 
      function _setupTargetAuthorizations()
           internal
@@ -107,13 +110,27 @@ contract InstanceAuthorizationV3
      {
           IAccess.FunctionInfo[] storage functions;
 
+          // authorize instance service role
+          functions = _authorizeForTarget(INSTANCE_TARGET_NAME, PUBLIC_ROLE());
+          _authorize(functions, Instance.registerProduct.selector, "registerProduct");
+          _authorize(functions, Instance.upgradeInstanceReader.selector, "upgradeInstanceReader");
+
+          // staking
+          _authorize(functions, Instance.setStakingLockingPeriod.selector, "setStakingLockingPeriod");
+          _authorize(functions, Instance.setStakingRewardRate.selector, "setStakingRewardRate");
+          _authorize(functions, Instance.refillStakingRewardReserves.selector, "refillStakingRewardReserves");
+          _authorize(functions, Instance.withdrawStakingRewardReserves.selector, "withdrawStakingRewardReserves");
+
+          // custom authz
+          _authorize(functions, Instance.createRole.selector, "createRole");
+          _authorize(functions, Instance.grantRole.selector, "grantRole");
+          _authorize(functions, Instance.revokeRole.selector, "revokeRole");
+          _authorize(functions, Instance.createTarget.selector, "createTarget");
+          _authorize(functions, Instance.setTargetFunctionRole.selector, "setTargetFunctionRole");
+
           // authorize instance service role
           functions = _authorizeForTarget(INSTANCE_TARGET_NAME, getServiceRole(INSTANCE()));
           _authorize(functions, Instance.setInstanceReader.selector, "setInstanceReader");
-
-          // authorize component service role
-          functions = _authorizeForTarget(INSTANCE_TARGET_NAME, getServiceRole(COMPONENT()));
-          _authorize(functions, Instance.setLockedFromService.selector, "setLockedFromService");
      }
 
 
@@ -122,13 +139,15 @@ contract InstanceAuthorizationV3
      {
           IAccess.FunctionInfo[] storage functions;
 
-          // authorize instance role
-          functions = _authorizeForTarget(INSTANCE_ADMIN_TARGET_NAME, getComponentRole(INSTANCE()));
-          _authorize(functions, InstanceAdmin.grantRole.selector, "grantRole");
+          // authorize component service role
+          functions = _authorizeForTarget(INSTANCE_ADMIN_TARGET_NAME, getServiceRole(INSTANCE()));
+          _authorize(functions, InstanceAdmin.setInstanceLocked.selector, "setInstanceLocked");
+          _authorize(functions, InstanceAdmin.setTargetLocked.selector, "setTargetLocked");
 
           // authorize component service role
           functions = _authorizeForTarget(INSTANCE_ADMIN_TARGET_NAME, getServiceRole(COMPONENT()));
           _authorize(functions, InstanceAdmin.initializeComponentAuthorization.selector, "initializeComponentAuthoriz");
+          _authorize(functions, InstanceAdmin.setComponentLocked.selector, "setComponentLocked");
      }
 
 

package/contracts/instance/InstanceReader.sol

@@ -6,6 +6,7 @@ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IER
 import {IBundle} from "../instance/module/IBundle.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IDistribution} from "../instance/module/IDistribution.sol";
+import {IDistributionService} from "../distribution/IDistributionService.sol";
 import {IInstance} from "./IInstance.sol";
 import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
 import {IOracle} from "../oracle/IOracle.sol";
@@ -47,6 +48,7 @@ contract InstanceReader {
     InstanceStore internal _store;
     BundleSet internal _bundleSet;
     RiskSet internal _riskSet;
+    IDistributionService internal _distributionService;
 
     /// @dev This initializer needs to be called from the instance itself.
     function initialize() public {
@@ -71,6 +73,7 @@ contract InstanceReader {
         _store = _instance.getInstanceStore();
         _bundleSet = _instance.getBundleSet();
         _riskSet = _instance.getRiskSet();
+        _distributionService = IDistributionService(_registry.getServiceAddress(DISTRIBUTION(), _instance.getRelease()));
     }
 
 
@@ -485,6 +488,16 @@ contract InstanceReader {
         }
     }
 
+    function isReferralValid(NftId distributionNftId, ReferralId referralId)
+        external
+        view
+        returns (bool isValid)
+    {
+        return _distributionService.referralIsValid(
+            distributionNftId,
+            referralId);
+    }
+
     function getRequestInfo(RequestId requestId)
         public
         view