@etherisc/gif-next 0.0.2-de9ede4-391 → 0.0.2-df69269-973

package/contracts/instance/InstanceAdmin.sol

@@ -1,19 +1,19 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.20;
 
-
-import {AccessAdmin} from "../authorization/AccessAdmin.sol";
-import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+import {IAccess} from "../authorization/IAccess.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
-import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IInstance} from "./IInstance.sol";
+
+import {AccessAdmin} from "../authorization/AccessAdmin.sol";
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
 import {Str, StrLib} from "../type/String.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
-import {VersionPart} from "../type/Version.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 
 contract InstanceAdmin is
@@ -27,68 +27,103 @@ contract InstanceAdmin is
 
     uint64 public constant CUSTOM_ROLE_ID_MIN = 10000; // MUST be even
 
+    error ErrorInstanceAdminCallerNotInstanceOwner(address caller);
+    error ErrorInstanceAdminInstanceAlreadyLocked();
     error ErrorInstanceAdminNotRegistered(address target);
+
     error ErrorInstanceAdminAlreadyAuthorized(address target);
+    error ErrorInstanceAdminNotComponentRole(RoleId roleId);
+    error ErrorInstanceAdminRoleAlreadyExists(RoleId roleId);
+    error ErrorInstanceAdminRoleTypeNotContract(RoleId roleId, IAccess.RoleType roleType);
+
     error ErrorInstanceAdminReleaseMismatch();
     error ErrorInstanceAdminExpectedTargetMissing(string targetName);
 
     IInstance internal _instance;
     IRegistry internal _registry;
-    uint64 internal _idNext;
+    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);
+        }
+        _;
+    }
+
     /// @dev Only used for master instance admin.
     /// Contracts created via constructor come with disabled initializers.
     constructor(
         address instanceAuthorization
-    )
-        AccessAdmin()
-    {
+    ) {
+        initialize(new AccessManagerCloneable());
+
         _instanceAuthorization = IAuthorization(instanceAuthorization);
+
+        _disableInitializers();
     }
 
-    /// @dev Initializes this instance admin with the provided instances authorization specification.
-    /// Internally the function creates an instance specific OpenZeppelin AccessManager that is used as the authority
-    /// for the inststance authorizatios.
-    /// Important: Initialization of this instance admin is only complete after calling function initializeInstance. 
+
     function initialize(
-        AccessManagerCloneable accessManager,
-        address instanceAuthorization
+        AccessManagerCloneable clonedAccessManager,
+        IRegistry registry,
+        VersionPart release
     )
         external
         initializer()
     {
-        // create new access manager for this instance admin
-        _initializeAuthority(address(accessManager));
+        __AccessAdmin_init(clonedAccessManager);
 
-        // create basic instance independent setup
-        _createAdminAndPublicRoles();
+        clonedAccessManager.completeSetup(
+            address(registry), 
+            release); 
 
-        // store instance authorization specification
-        _instanceAuthorization = IAuthorization(instanceAuthorization);
+        _registry = registry;
     }
 
-    /// @dev Completes the initialization of this instance admin using the provided instance.
+    event LogDebug(string message, uint256 value);
+    /// @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 initializeInstanceAuthorization(address instanceAddress)
+    function completeSetup(
+        address instance,
+        address authorization
+    )
         external
+        reinitializer(uint64(getRelease().toInt()))
+        onlyDeployer()
     {
-        _checkTargetIsReadyForAuthorization(instanceAddress);
+        _components = 0;
+        _customIdNext = CUSTOM_ROLE_ID_MIN;
+        _instance = IInstance(instance);
+        _instanceAuthorization = IAuthorization(authorization);
 
-        _idNext = CUSTOM_ROLE_ID_MIN;
-        _instance = IInstance(instanceAddress);
-        _registry = _instance.getRegistry();
+        _checkTargetIsReadyForAuthorization(instance);
 
         // check matching releases
-        if (_instanceAuthorization.getRelease() != _instance.getRelease()) {
+        if (_instanceAuthorization.getRelease() != getRelease()) {
             revert ErrorInstanceAdminReleaseMismatch();
         }
 
+        // TODO cleanup
+        emit LogDebug("a", 0);
+        // create instance role and target
+        _setupInstance(instance);
+        emit LogDebug("b", 0);
+
         // add instance authorization
         _createRoles(_instanceAuthorization);
-        _createModuleTargetsWithRoles();
+        emit LogDebug("c", 0);
+
+        _setupInstanceHelperTargetsWithRoles();
+        emit LogDebug("d", 0);
         _createTargetAuthorizations(_instanceAuthorization);
+        emit LogDebug("e", 0);
     }
 
 
@@ -98,47 +133,71 @@ contract InstanceAdmin is
         IInstanceLinkedComponent component
     )
         external
+        restricted()
     {
         // checks
-        // get authorization specification
-        IAuthorization authorization = component.getAuthorization();
-        string memory targetName = authorization.getTargetName();
         _checkTargetIsReadyForAuthorization(address(component));
 
+        emit LogDebug("f", 0);
 
-        // create roles
-        _createRoles(authorization);
+        // setup target and role for component (including token handler)
+        _setupComponentAndTokenHandler(component);
 
-        // create component target
-        _createTarget(
-            address(component), 
-            targetName, 
-            true, // checkAuthority
-            false); // custom
+        emit LogDebug("g", 0);
 
-        _createTarget(
-            address(component.getTokenHandler()), 
-            string(abi.encodePacked(targetName, "TH")), 
-            true, 
-            false);
+        // create other roles
+        IAuthorization authorization = component.getAuthorization();
+        _createRoles(authorization);
+
+        emit LogDebug("h", 0);
         
         FunctionInfo[] memory functions = new FunctionInfo[](3);
         functions[0] = toFunction(TokenHandler.collectTokens.selector, "collectTokens");
         functions[1] = toFunction(TokenHandler.collectTokensToThreeRecipients.selector, "collectTokensToThreeRecipients");
         functions[2] = toFunction(TokenHandler.distributeTokens.selector, "distributeTokens");
 
+        emit LogDebug("i", 0);
+
         // FIXME: make this a bit nicer and work with IAuthorization. Use a specific role, not public - access to TokenHandler must be restricted
         _authorizeTargetFunctions(
             address(component.getTokenHandler()),
             getPublicRole(),
             functions);
 
-        _grantRoleToAccount(
-            authorization.getTargetRole(
-                authorization.getMainTarget()), 
-            address(component));
+        emit LogDebug("j", 0);
+
+        // TODO cleanup
+        // _grantRoleToAccount(
+        //     authorization.getTargetRole(
+        //         authorization.getMainTarget()), 
+        //     address(component));
         
         _createTargetAuthorizations(authorization);
+
+        emit LogDebug("k", 0);
+    }
+
+    // create instance role and target
+    function _setupInstance(address instance) internal {
+        // create instance role
+        RoleId instanceRoleId = _instanceAuthorization.getTargetRole(
+            _instanceAuthorization.getMainTarget());
+
+        _createRole(
+            instanceRoleId,
+            _instanceAuthorization.getRoleInfo(instanceRoleId));
+
+        // create instance target
+        _createTarget(
+            instance, 
+            _instanceAuthorization.getMainTargetName(), 
+            true, // checkAuthority
+            false); // custom
+
+        // assign instance role to instance
+        _grantRoleToAccount(
+            instanceRoleId, 
+            instance);
     }
 
     /// @dev Creates a custom role
@@ -160,6 +219,19 @@ contract InstanceAdmin is
         _grantRoleToAccount(roleId, account);
     }
 
+
+    function setInstanceLocked(bool locked)
+        external
+        onlyInstanceOwner()
+    {
+        AccessManagerCloneable accessManager = AccessManagerCloneable(authority());
+
+        if(accessManager.isLocked() == locked) {
+            revert ErrorInstanceAdminInstanceAlreadyLocked();
+        }
+        accessManager.setLocked(locked);
+    }
+
     function setTargetLocked(address target, bool locked) 
         external 
         restricted()
@@ -178,12 +250,98 @@ contract InstanceAdmin is
         return _instanceAuthorization;
     }
 
+    // ------------------- Internal functions ------------------- //
+
+    function _setupComponentAndTokenHandler(IInstanceLinkedComponent component)
+        internal
+    {
+
+        IAuthorization authorization = component.getAuthorization();
+        string memory targetName = authorization.getMainTargetName();
+
+        // create component role and target
+        RoleId componentRoleId = _createComponentRoleId(component, authorization);
+
+        // create component's target
+        _createTarget(
+            address(component), 
+            targetName, 
+            true, // checkAuthority
+            false); // custom
+
+        // create component's token handler target
+        _createTarget(
+            // TODO fetch token handler from instance
+            address(component.getTokenHandler()), 
+            string(abi.encodePacked(targetName, "TH")), 
+            true, 
+            false);
+
+        // assign component role to component
+        _grantRoleToAccount(
+            componentRoleId, 
+            address(component));
+
+        // token handler does not require its own role
+        // token handler is not calling other components
+    }
+
+
+    function _createComponentRoleId(
+        IInstanceLinkedComponent component,
+        IAuthorization authorization
+    )
+        internal 
+        returns (RoleId componentRoleId)
+    {
+        // checks
+        // check component is not yet authorized
+        if (_targetRoleId[address(component)].gtz()) {
+            revert ErrorInstanceAdminAlreadyAuthorized(address(component));
+        }
+
+        // check generic component role
+        RoleId genericComponentRoleId = authorization.getTargetRole(
+            authorization.getMainTarget());
+
+        if (!genericComponentRoleId.isComponentRole()) {
+            revert ErrorInstanceAdminNotComponentRole(genericComponentRoleId);
+        }
+
+        // check component role does not exist
+        componentRoleId = toComponentRole(
+            genericComponentRoleId, 
+            _components);
+
+        if (roleExists(componentRoleId)) {
+            revert ErrorInstanceAdminRoleAlreadyExists(componentRoleId);
+        }
+
+        // check role info
+        IAccess.RoleInfo memory roleInfo = authorization.getRoleInfo(
+            genericComponentRoleId);
+
+        if (roleInfo.roleType != IAccess.RoleType.Contract) {
+            revert ErrorInstanceAdminRoleTypeNotContract(
+                componentRoleId,
+                roleInfo.roleType);
+        }
+
+        // effects
+        _targetRoleId[address(component)] = componentRoleId;
+        _components++;
+
+        _createRole(
+            componentRoleId,
+            roleInfo);
+    }
+
 
     function _checkTargetIsReadyForAuthorization(address target)
         internal
         view
     {
-        if (address(_registry) != address(0) && !_registry.isRegistered(target)) {
+        if (!_registry.isRegistered(target)) {
             revert ErrorInstanceAdminNotRegistered(target);
         }
 
@@ -197,13 +355,18 @@ contract InstanceAdmin is
         internal
     {
         RoleId[] memory roles = authorization.getRoles();
+        RoleId mainTargetRoleId = authorization.getTargetRole(
+            authorization.getMainTarget());
+
         RoleId roleId;
         RoleInfo memory roleInfo;
 
         for(uint256 i = 0; i < roles.length; i++) {
+
             roleId = roles[i];
 
-            if (!roleExists(roleId)) {
+            // skip main target role, create role if not exists
+            if (roleId != mainTargetRoleId && !roleExists(roleId)) {
                 _createRole(
                     roleId,
                     authorization.getRoleInfo(roleId));
@@ -212,6 +375,16 @@ contract InstanceAdmin is
     }
 
 
+    function toComponentRole(RoleId roleId, uint64 componentIdx)
+        internal
+        pure
+        returns (RoleId)
+    {
+        return RoleIdLib.toRoleId(
+            RoleIdLib.toInt(roleId) + componentIdx);
+    }
+
+
     function _createTargetAuthorizations(IAuthorization authorization)
         internal
     {
@@ -262,11 +435,12 @@ contract InstanceAdmin is
         }
     }
 
-    function _createModuleTargetsWithRoles()
+    function _setupInstanceHelperTargetsWithRoles()
         internal
     {
+        // _checkAndCreateTargetWithRole(address(_instance), INSTANCE_TARGET_NAME);
+
         // create module targets
-        _checkAndCreateTargetWithRole(address(_instance), INSTANCE_TARGET_NAME);
         _checkAndCreateTargetWithRole(address(_instance.getInstanceStore()), INSTANCE_STORE_TARGET_NAME);
         _checkAndCreateTargetWithRole(address(_instance.getInstanceAdmin()), INSTANCE_ADMIN_TARGET_NAME);
         _checkAndCreateTargetWithRole(address(_instance.getBundleSet()), BUNDLE_SET_TARGET_NAME);

package/contracts/instance/InstanceAuthorizationV3.sol

@@ -26,7 +26,9 @@ contract InstanceAuthorizationV3
      string public constant BUNDLE_SET_TARGET_NAME = "BundleSet";
      string public constant RISK_SET_TARGET_NAME = "RiskSet";
 
-     constructor() Authorization(INSTANCE_TARGET_NAME) {}
+     constructor()
+          Authorization(INSTANCE_TARGET_NAME, INSTANCE())
+     { }
 
 
      function _setupRoles()
@@ -36,16 +38,16 @@ contract InstanceAuthorizationV3
           // empty implementation
      }
 
-
      function _setupTargets()
           internal
           override
      {
-          // instance target
-          _addTargetWithRole(
-               INSTANCE_TARGET_NAME, 
-               _toTargetRoleId(INSTANCE()),
-               INSTANCE_ROLE_NAME);
+          // TODO cleanup
+          // // instance target
+          // _addTargetWithRole(
+          //      INSTANCE_TARGET_NAME, 
+          //      _toTargetRoleId(INSTANCE()),
+          //      INSTANCE_ROLE_NAME);
 
           // instance supporting targets
           _addTarget(INSTANCE_STORE_TARGET_NAME);
@@ -132,11 +134,12 @@ contract InstanceAuthorizationV3
           IAccess.FunctionInfo[] storage functions;
 
           // authorize instance role
-          functions = _authorizeForTarget(INSTANCE_ADMIN_TARGET_NAME, _toTargetRoleId(INSTANCE()));
+          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(COMPONENT()));
+          _authorize(functions, InstanceAdmin.initializeComponentAuthorization.selector, "initializeComponentAuthoriz");
           _authorize(functions, InstanceAdmin.setTargetLocked.selector, "setTargetLocked");
      }
 
@@ -160,6 +163,8 @@ contract InstanceAuthorizationV3
           _authorize(functions, InstanceStore.createPool.selector, "createPool");
           _authorize(functions, InstanceStore.createProduct.selector, "createProduct");
           _authorize(functions, InstanceStore.updateProduct.selector, "updateProduct");
+          _authorize(functions, InstanceStore.createFee.selector, "createFee");
+          _authorize(functions, InstanceStore.updateFee.selector, "updateFee");
           
           // authorize distribution service role
           functions = _authorizeForTarget(INSTANCE_STORE_TARGET_NAME, getServiceRole(DISTRIBUTION()));
@@ -217,6 +222,7 @@ contract InstanceAuthorizationV3
           _authorize(functions, InstanceStore.updateClaim.selector, "updateClaim");
           _authorize(functions, InstanceStore.createPayout.selector, "createPayout");
           _authorize(functions, InstanceStore.updatePayout.selector, "updatePayout");
+          _authorize(functions, InstanceStore.updatePayoutState.selector, "updatePayoutState");
      }
 }
 

package/contracts/instance/InstanceReader.sol

@@ -110,7 +110,7 @@ contract InstanceReader {
     function bundles(NftId poolNftId)
         public
         view
-        returns (uint256 bundles)
+        returns (uint256 bundleCount)
     {
         return _bundleSet.bundles(poolNftId);
     }
@@ -118,7 +118,7 @@ contract InstanceReader {
     function activeBundles(NftId poolNftId)
         public
         view
-        returns (uint256 bundles)
+        returns (uint256 bundleCount)
     {
         return _bundleSet.activeBundles(poolNftId);
     }
@@ -166,7 +166,7 @@ contract InstanceReader {
     function claims(NftId policyNftId)
         public
         view
-        returns (uint16 claims)
+        returns (uint16 claimCount)
     {
         return getPolicyInfo(policyNftId).claimsCount;
     }
@@ -204,7 +204,7 @@ contract InstanceReader {
     function payouts(NftId policyNftId, ClaimId claimId)
         public
         view
-        returns (uint24 payouts)
+        returns (uint24 payoutCount)
     {
         return getClaimInfo(policyNftId, claimId).payoutsCount;
     }
@@ -250,7 +250,7 @@ contract InstanceReader {
     function risks(NftId productNftId)
         public
         view
-        returns (uint256 activeRisks)
+        returns (uint256 riskCount)
     {
         return _riskSet.risks(productNftId);
     }
@@ -266,7 +266,7 @@ contract InstanceReader {
     function activeRisks(NftId productNftId)
         public
         view
-        returns (uint256 activeRisks)
+        returns (uint256 activeRiskCount)
     {
         return _riskSet.activeRisks(productNftId);
     }