@etherisc/gif-next 0.0.2-fd4931b-974 → 0.0.2-fd9539f-062

package/contracts/instance/BundleManager.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 import {IInstance} from "./IInstance.sol";
 import {INSTANCE} from "../type/ObjectType.sol";

package/contracts/instance/IInstance.sol

@@ -1,8 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
+import {Amount} from "../type/Amount.sol";
 import {ClaimId} from "../type/ClaimId.sol";
 import {DistributorType} from "../type/DistributorType.sol";
 import {PayoutId} from "../type/PayoutId.sol";
@@ -13,12 +14,15 @@ 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 {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
 
+import {AccessManagerExtendedInitializeable} from "../shared/AccessManagerExtendedInitializeable.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
 
 import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
 
-import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {BundleManager} from "./BundleManager.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceStore} from "./InstanceStore.sol";
@@ -36,15 +40,14 @@ import {IPolicyService} from "../product/IPolicyService.sol";
 import {IBundleService} from "../pool/IBundleService.sol";
 
 
-
 interface IInstance is 
     IRegisterable, 
     ITransferInterceptor, 
     IAccessManaged
 {
-    error ErrorInstanceInstanceAccessManagerZero();
-    error ErrorInstanceInstanceAccessManagerAlreadySet(address instanceAccessManager);
-    error ErrorInstanceInstanceAccessManagerAuthorityMismatch(address instanceAuthority);
+    error ErrorInstanceInstanceAdminZero();
+    error ErrorInstanceInstanceAdminAlreadySet(address InstanceAdmin);
+    error ErrorInstanceInstanceAdminAuthorityMismatch(address instanceAuthority);
 
     error ErrorInstanceBundleManagerAlreadySet(address instanceBundleManager);
     error ErrorInstanceBundleManagerInstanceMismatch(address instance);
@@ -55,6 +58,10 @@ interface IInstance is
     error ErrorInstanceInstanceStoreAlreadySet(address instanceStore);
     error ErrorInstanceInstanceStoreAuthorityMismatch(address instanceAuthority);
 
+    struct InstanceInfo {
+        uint64 requestsCount;
+    }
+
     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;
@@ -63,15 +70,18 @@ interface IInstance is
     function setTargetFunctionRole(string memory targetName, bytes4[] calldata selectors, RoleId roleId) external;
     function setTargetLocked(address target, bool locked) external;
 
-    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 setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
+    function setStakingRewardRate(UFixed rewardRate) external;
+    function refillStakingRewardReserves(Amount dipAmount) external;
+
+    /// @dev defunds the staking reward reserves for the specified target
+    /// permissioned: only the target owner may call this function
+    function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
 
     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 getInstanceAdmin() external view returns (InstanceAdmin);
     function getInstanceStore() external view returns (InstanceStore);
+    function getInstanceAccessManager() external view returns (AccessManagerExtendedInitializeable);
 }

package/contracts/instance/IInstanceService.sol

@@ -1,25 +1,29 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
+import {Amount} from "../type/Amount.sol";
+import {BundleManager} from "./BundleManager.sol";
+import {Instance} from "./Instance.sol";
+import {IService} from "../shared/IService.sol";
 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";
+import {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {VersionPart} from "../type/Version.sol";
 
 interface IInstanceService is IService {
 
+    // onlyInstance
+    error ErrorInstanceServiceNotRegistered(address instance);
+    error ErrorInstanceServiceNotInstance(address instance, ObjectType objectType);
+    error ErrorInstanceServiceInstanceVersionMismatch(address instance, VersionPart instanceVersion);
+
     error ErrorInstanceServiceComponentNotInstanceLinked(address component);
 
     error ErrorInstanceServiceMasterInstanceAlreadySet();
-    error ErrorInstanceServiceMasterOzAccessManagerAlreadySet();
     error ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet();
+    error ErrorInstanceServiceMasterInstanceAdminAlreadySet();
     error ErrorInstanceServiceMasterBundleManagerAlreadySet();
     error ErrorInstanceServiceInstanceAddressZero();
 
@@ -28,7 +32,7 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader();
     error ErrorInstanceServiceInstanceReaderInstanceMismatch();
 
-    error ErrorInstanceServiceInstanceAccessManagerZero();
+    error ErrorInstanceServiceInstanceAdminZero();
     error ErrorInstanceServiceInstanceReaderZero();
     error ErrorInstanceServiceBundleManagerZero();
     error ErrorInstanceServiceInstanceStoreZero();
@@ -40,8 +44,7 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceInstanceStoreAuthorityMismatch();
 
     error ErrorInstanceServiceRequestUnauhorized(address caller);
-    error ErrorInstanceServiceNotInstanceOwner(address caller, NftId instanceNftId);
-    error ErrorInstanceServiceNotInstance(NftId nftId);
+    error ErrorInstanceServiceNotInstanceNftId(NftId nftId);
     error ErrorInstanceServiceComponentNotRegistered(address componentAddress);
     error ErrorInstanceServiceInstanceComponentMismatch(NftId instanceNftId, NftId componentNftId);
     error ErrorInstanceServiceInvalidComponentType(address componentAddress, ObjectType expectedType, ObjectType componentType);
@@ -59,10 +62,21 @@ interface IInstanceService is IService {
     function createInstanceClone()
         external 
         returns (
+            // TODO check if Instance can be changed to IInstance
             Instance clonedInstance,
             NftId instanceNftId
         );
 
+
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
+    function setStakingRewardRate(UFixed rewardRate) external;
+    function refillStakingRewardReserves(address rewardProvider, Amount dipAmount) external;
+
+    /// @dev defunds the staking reward reserves for the specified target
+    /// permissioned: only the target owner may call this function
+    function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
+
+
     function createComponentTarget(
         NftId instanceNftId,
         address targetAddress,

package/contracts/instance/Instance.sol

@@ -1,27 +1,32 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 
+import {Amount} from "../type/Amount.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 {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 import {Registerable} from "../shared/Registerable.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
+import {AccessManagerExtendedInitializeable} from "../shared/AccessManagerExtendedInitializeable.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 
 import {IInstance} from "./IInstance.sol";
+import {IInstanceService} from "./IInstanceService.sol";
 import {InstanceReader} from "./InstanceReader.sol";
-import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {BundleManager} from "./BundleManager.sol";
 import {InstanceStore} from "./InstanceStore.sol";
 
@@ -48,7 +53,8 @@ contract Instance is
 
     bool private _initialized;
 
-    InstanceAccessManager internal _accessManager;
+    IInstanceService internal _instanceService;
+    InstanceAdmin internal _instanceAdmin;
     InstanceReader internal _instanceReader;
     BundleManager internal _bundleManager;
     InstanceStore internal _instanceStore;
@@ -65,7 +71,7 @@ contract Instance is
         initializer()
     {
         if(authority == address(0)) {
-            revert ErrorInstanceInstanceAccessManagerZero();
+            revert ErrorInstanceInstanceAdminZero();
         }
 
         __AccessManaged_init(authority);
@@ -73,40 +79,82 @@ contract Instance is
         IRegistry registry = IRegistry(registryAddress);
         initializeRegisterable(registryAddress, registry.getNftId(), INSTANCE(), true, initialOwner, "");
 
+        _instanceService = IInstanceService(
+            getRegistry().getServiceAddress(
+                INSTANCE(), 
+                getMajorVersion()));
+
         registerInterface(type(IInstance).interfaceId);    
     }
 
+    //--- Staking ----------------------------------------------------------//
+
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod)
+        external
+        // TODO decide if onlyOwner or restricted to instance owner role is better
+        onlyOwner()
+    {
+        _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
+    }
+
+    function setStakingRewardRate(UFixed rewardRate)
+        external
+        onlyOwner()
+    {
+        _instanceService.setStakingRewardRate(rewardRate);
+    }
+
+    function refillStakingRewardReserves(Amount dipAmount)
+        external
+        onlyOwner()
+    {
+        address instanceOwner = msg.sender;
+        _instanceService.refillStakingRewardReserves(instanceOwner, dipAmount);
+    }
+
+    function withdrawStakingRewardReserves(Amount dipAmount)
+        external
+        onlyOwner()
+        returns (Amount newBalance)
+    {
+        return _instanceService.withdrawStakingRewardReserves(dipAmount);
+    }
+
     //--- Roles ------------------------------------------------------------//
 
     function createRole(string memory roleName, string memory adminName)
         external
+        // TODO decide if onlyOwner or restricted to instance owner role is better
         restricted // INSTANCE_OWNER_ROLE
         returns (RoleId roleId, RoleId admin)
     {
-        (roleId, admin) = _accessManager.createRole(roleName, adminName);
+        (roleId, admin) = _instanceAdmin.createRole(roleName, adminName);
     }
 
     function grantRole(RoleId roleId, address account) 
         external 
+        // TODO decide if onlyOwner or restricted to instance owner role is better
         restricted // INSTANCE_OWNER_ROLE
     {
-        _accessManager.grantRole(roleId, account);
+        AccessManagerExtendedInitializeable(authority()).grantRole(roleId.toInt(), account, 0);
     }
 
     function revokeRole(RoleId roleId, address account) 
         external 
+        // TODO decide if onlyOwner or restricted to instance owner role is better
         restricted // INSTANCE_OWNER_ROLE
     {
-        _accessManager.revokeRole(roleId, account);
+        AccessManagerExtendedInitializeable(authority()).revokeRole(roleId.toInt(), account);
     }
 
     //--- Targets ------------------------------------------------------------//
 
     function createTarget(address target, string memory name) 
         external 
+        // TODO decide if onlyOwner or restricted to instance owner role is better
         restricted // INSTANCE_OWNER_ROLE
     {
-        _accessManager.createTarget(target, name);
+        _instanceAdmin.createTarget(target, name);
     }
 
     function setTargetFunctionRole(
@@ -117,38 +165,41 @@ contract Instance is
         external 
         restricted // INSTANCE_OWNER_ROLE
     {
-        _accessManager.setTargetFunctionRole(targetName, selectors, roleId);
+        _instanceAdmin.setTargetFunctionRoleByInstance(targetName, selectors, roleId);
     }
 
     function setTargetLocked(address target, bool locked)
         external 
         restricted // INSTANCE_OWNER_ROLE
     {
-        _accessManager.setTargetLockedByInstance(target, locked);
+        _instanceAdmin.setTargetLockedByInstance(target, locked);
     }
 
-    //--- ITransferInterceptor ------------------------------------------------------------//
+    //--- ITransferInterceptor ----------------------------------------------//
 
+    // TODO interception of child components nfts
     function nftMint(address to, uint256 tokenId) external onlyChainNft {
-        assert(_accessManager.roleMembers(INSTANCE_OWNER_ROLE()) == 0);// temp
-        assert(_accessManager.grantRole(INSTANCE_OWNER_ROLE(), to) == true);
+        _instanceAdmin.transferInstanceOwnerRole(address(0), to);
     }
 
     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);
+        _instanceAdmin.transferInstanceOwnerRole(from, to);
     }
 
+    //function nftBurn(address from, uint256 tokenId) external onlyChainNft {
+        //_instanceAdmin.transferInstanceOwnerRole(from, address(0));
+    //}
+
     //--- initial setup functions -------------------------------------------//
 
-    function setInstanceAccessManager(InstanceAccessManager accessManager) external restricted {
-        if(address(_accessManager) != address(0)) {
-            revert ErrorInstanceInstanceAccessManagerAlreadySet(address(_accessManager));
+    function setInstanceAdmin(InstanceAdmin accessManager) external restricted {
+        if(address(_instanceAdmin) != address(0)) {
+            revert ErrorInstanceInstanceAdminAlreadySet(address(_instanceAdmin));
         }
         if(accessManager.authority() != authority()) {
-            revert ErrorInstanceInstanceAccessManagerAuthorityMismatch(authority());
+            revert ErrorInstanceInstanceAdminAuthorityMismatch(authority());
         }
-        _accessManager = accessManager;      
+        _instanceAdmin = accessManager;      
     }
     
     function setBundleManager(BundleManager bundleManager) external restricted() {
@@ -172,20 +223,6 @@ contract Instance is
         _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));
@@ -196,32 +233,30 @@ contract Instance is
         _instanceStore = instanceStore;
     }
 
-    function getInstanceStore() external view returns (InstanceStore) {
-        return _instanceStore;
-    }
+    //--- external view functions -------------------------------------------//
 
-    function getMajorVersion() external pure returns (VersionPart majorVersion) {
-        return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
+    function getInstanceReader() external view returns (InstanceReader) {
+        return _instanceReader;
     }
 
-    function getDistributionService() external view returns (IDistributionService) {
-        return IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), VersionPart.wrap(3)));
+    function getBundleManager() external view returns (BundleManager) {
+        return _bundleManager;
     }
 
-    function getProductService() external view returns (IProductService) {
-        return IProductService(getRegistry().getServiceAddress(PRODUCT(), VersionPart.wrap(3)));
+    function getInstanceAdmin() external view returns (InstanceAdmin) {
+        return _instanceAdmin;
     }
 
-    function getPoolService() external view returns (IPoolService) {
-        return IPoolService(getRegistry().getServiceAddress(POOL(), VersionPart.wrap(3)));
+    function getInstanceAccessManager() external view returns (AccessManagerExtendedInitializeable) {
+        return AccessManagerExtendedInitializeable(authority());
     }
 
-    function getPolicyService() external view returns (IPolicyService) {
-        return IPolicyService(getRegistry().getServiceAddress(POLICY(), VersionPart.wrap(3)));
+    function getInstanceStore() external view returns (InstanceStore) {
+        return _instanceStore;
     }
 
-    function getBundleService() external view returns (IBundleService) {
-        return IBundleService(getRegistry().getServiceAddress(BUNDLE(), VersionPart.wrap(3)));
+    function getMajorVersion() public pure returns (VersionPart majorVersion) {
+        return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
     }
 
     //--- internal view/pure functions --------------------------------------//