@etherisc/gif-next 0.0.2-750c7cb-311 → 0.0.2-754ba48-078

package/contracts/instance/IInstance.sol

@@ -1,57 +1,34 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-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";
+import {BundleSet} from "./BundleSet.sol";
+import {RiskSet} from "./RiskSet.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {InstanceStore} from "./InstanceStore.sol";
+import {IRegisterable} from "../shared/IRegisterable.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 {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
 
-import {IRegisterable} from "../shared/IRegisterable.sol";
-
-import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
-
-import {InstanceAdmin} from "./InstanceAdmin.sol";
-import {BundleSet} from "./BundleSet.sol";
-import {InstanceReader} from "./InstanceReader.sol";
-import {InstanceStore} from "./InstanceStore.sol";
-
-import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
-
-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
+    IRegisterable
 {
     error ErrorInstanceInstanceAdminZero();
-    error ErrorInstanceInstanceAdminAlreadySet(address InstanceAdmin);
+    error ErrorInstanceInstanceAdminAlreadySet(address instanceAdmin);
     error ErrorInstanceInstanceAdminAuthorityMismatch(address instanceAuthority);
 
     error ErrorInstanceBundleSetAlreadySet(address instanceBundleSet);
     error ErrorInstanceBundleSetInstanceMismatch(address instance);
     error ErrorInstanceBundleSetAuthorityMismatch(address instanceAuthority);
 
+    error ErrorInstanceRiskSetAlreadySet(address instanceRiskSet);
+    error ErrorInstanceRiskSetInstanceMismatch(address instance);
+    error ErrorInstanceRiskSetAuthorityMismatch(address instanceAuthority);
+
     error ErrorInstanceInstanceReaderInstanceMismatch(address instanceAuthority);
 
     error ErrorInstanceInstanceStoreAlreadySet(address instanceStore);
@@ -61,26 +38,68 @@ interface IInstance is
         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;
+    ///--- instance ---------------------------------------------------------//
 
-    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;
+    /// @dev Locks/unlocks the complete instance, including all its components.
+    function setInstanceLocked(bool locked) external;
+
+    /// @dev Upgrades the instance reader to the specified target.
+    function upgradeInstanceReader() external;
+
+    /// @dev Sets the instance reader for the instance.
+    /// Permissioned: only the instance service may call this function.
+    function setInstanceReader(InstanceReader instanceReader) external;
 
+    ///--- staking ----------------------------------------------------------//
+
+    /// @dev Sets the duration for locking new stakes on this instance..
     function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
+
+    /// @dev Sets the staking reward rate [apr] for this instance.
     function setStakingRewardRate(UFixed rewardRate) external;
+
+    /// @dev Sets the maximum staked amount for this instance.
+    function setStakingMaxAmount(Amount maxStakedAmount) external;
+
+    /// @dev Refills the staking reward reserves for the specified target.
     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);
 
-    // get instance release and supporting contracts
-    function getMajorVersion() external pure returns (VersionPart majorVersion);
+    ///--- product/component ------------------------------------------------//
+
+    /// @dev Locks/unlocks the specified target.
+    function setTargetLocked(address target, bool locked) external;
+
+    /// @dev Register a product with the instance.
+    function registerProduct(address product) external returns (NftId productNftId);
+
+    ///--- authz ------------------------------------------------------------//
+
+    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;
+
+    //--- getters -----------------------------------------------------------//
+
+    /// @dev returns the overall locking state of the instance (including all components)
+    function isInstanceLocked() external view returns (bool isLocked);
+
+    /// @dev returns the locking state of the specified target
+    function isTargetLocked(address target) external view returns (bool isLocked);
+
+    // get products
+    function products() external view returns (uint256 productCount);
+    function getProductNftId(uint256 idx) external view returns (NftId productNftId);
+
+    // get supporting contracts
     function getInstanceReader() external view returns (InstanceReader);
     function getBundleSet() external view returns (BundleSet);
+    function getRiskSet() external view returns (RiskSet);
     function getInstanceAdmin() external view returns (InstanceAdmin);
     function getInstanceStore() external view returns (InstanceStore);
 }

package/contracts/instance/IInstanceService.sol

@@ -2,13 +2,10 @@
 pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
-import {BundleSet} from "./BundleSet.sol";
-import {Instance} from "./Instance.sol";
-import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+import {IInstance} from "./IInstance.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 {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
 import {VersionPart} from "../type/Version.sol";
@@ -18,13 +15,14 @@ interface IInstanceService is IService {
     // onlyInstance
     error ErrorInstanceServiceNotRegistered(address instance);
     error ErrorInstanceServiceNotInstance(address instance, ObjectType objectType);
-    error ErrorInstanceServiceInstanceVersionMismatch(address instance, VersionPart instanceVersion);
+    error ErrorInstanceServiceInstanceVersionMismatch(NftId instanceNftId, VersionPart expectedRelease, VersionPart instanceRelease);
 
     error ErrorInstanceServiceComponentNotInstanceLinked(address component);
 
     error ErrorInstanceServiceMasterInstanceAlreadySet();
     error ErrorInstanceServiceMasterInstanceAdminAlreadySet();
     error ErrorInstanceServiceMasterBundleSetAlreadySet();
+    error ErrorInstanceServiceMasterRiskSetAlreadySet();
     error ErrorInstanceServiceInstanceAddressZero();
 
     error ErrorInstanceServiceMasterInstanceReaderNotSet();
@@ -36,12 +34,15 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceInstanceAdminZero();
     error ErrorInstanceServiceInstanceReaderZero();
     error ErrorInstanceServiceBundleSetZero();
+    error ErrorInstanceServiceRiskSetZero();
     error ErrorInstanceServiceInstanceStoreZero();
 
     error ErrorInstanceServiceInstanceAuthorityMismatch();
     error ErrorInstanceServiceBundleSetAuthorityMismatch();
+    error ErrorInstanceServiceRiskSetAuthorityMismatch();
     error ErrorInstanceServiceInstanceReaderInstanceMismatch2();
-    error ErrorInstanceServiceBundleMangerInstanceMismatch();
+    error ErrorInstanceServiceBundleSetInstanceMismatch();
+    error ErrorInstanceServiceRiskSetInstanceMismatch();
     error ErrorInstanceServiceInstanceStoreAuthorityMismatch();
 
     error ErrorInstanceServiceRequestUnauhorized(address caller);
@@ -52,41 +53,32 @@ interface IInstanceService is IService {
     
     event LogInstanceCloned(NftId instanceNftId, address instance);
 
+    /// @dev Locks the complete instance, including all its components.
+    function setInstanceLocked(bool locked) external;
+
+    /// @dev Locks/unlocks the specified target constrolled by the corresponding instance admin.
+    function setTargetLocked(address target, bool locked) external;
+
+    /// @dev Creates a new instance.
+    /// The caller becomes the owner of the new instance.
+    /// Creation of a new instance is achieved by this service through the creation and registration 
+    /// of a new clone of the master instance and then setting up the initial wiring and authorization 
+    /// of the necessary components.
     function createInstance()
         external 
         returns (
-            // TODO check if Instance can be changed to IInstance
-            Instance clonedInstance,
+            IInstance instance,
             NftId instanceNftId
         );
 
+    function upgradeInstanceReader() external;
+    function upgradeMasterInstanceReader(address instanceReaderAddress) external;
 
     function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
     function setStakingRewardRate(UFixed rewardRate) external;
+    function setStakingMaxAmount(Amount maxStakedAmount) external;
     function refillStakingRewardReserves(address rewardProvider, Amount dipAmount) external;
 
     /// @dev Defunds the staking reward reserves for the specified target.
     function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
-
-    /// @dev Sets up the component authorization for the specified instance.
-    /// The authorization is based on the authz specification provided by the component via getAuthorization.
-    function initializeAuthorization(NftId instanceNftId, IInstanceLinkedComponent component) external;
-
-    function createComponentTarget(
-        NftId instanceNftId,
-        address targetAddress,
-        string memory targetName,
-        bytes4[][] memory selectors,
-        RoleId[] memory roles
-    ) external;
-
-    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,62 +1,40 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
+import {IInstance} from "./IInstance.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {IInstanceService} from "./IInstanceService.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
 
 import {Amount} from "../type/Amount.sol";
-import {Key32} from "../type/Key32.sol";
+import {BundleSet} from "./BundleSet.sol";
+import {RiskSet} from "./RiskSet.sol";
+import {COMPONENT, INSTANCE} from "../type/ObjectType.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
+import {InstanceStore} from "./InstanceStore.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 {Registerable} from "../shared/Registerable.sol";
 import {RoleId} from "../type/RoleId.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 {IRegistry} from "../registry/IRegistry.sol";
-
-import {IInstance} from "./IInstance.sol";
-import {IInstanceService} from "./IInstanceService.sol";
-import {InstanceReader} from "./InstanceReader.sol";
-import {InstanceAdmin} from "./InstanceAdmin.sol";
-import {BundleSet} from "./BundleSet.sol";
-import {InstanceStore} from "./InstanceStore.sol";
-
-import {KeyValueStore} from "../shared/KeyValueStore.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 {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";
+import {VersionPart} from "../type/Version.sol";
 
 contract Instance is
     IInstance,
-    AccessManagedUpgradeable,
     Registerable
 {
-    uint256 public constant GIF_MAJOR_VERSION = 3;
-
     bool private _initialized;
 
+    IComponentService internal _componentService;
     IInstanceService internal _instanceService;
+
     InstanceAdmin internal _instanceAdmin;
     InstanceReader internal _instanceReader;
-    BundleSet internal _bundleManager;
+    BundleSet internal _bundleSet;
+    RiskSet internal _riskSet;
     InstanceStore internal _instanceStore;
+    NftId [] internal _products;
 
     modifier onlyChainNft() {
         if(msg.sender != getRegistry().getChainNftAddress()) {
@@ -68,25 +46,25 @@ contract Instance is
     function initialize(
         InstanceAdmin instanceAdmin, 
         InstanceStore instanceStore,
-        BundleSet bundleManager,
+        BundleSet bundleSet,
+        RiskSet riskSet,
         InstanceReader instanceReader,
         IRegistry registry, 
+        VersionPart release,
         address initialOwner
     ) 
         external 
         initializer()
     {
-        _instanceAdmin = instanceAdmin;
-        if(_instanceAdmin.authority() == address(0)) {
-            // TODO rename error
+        if(address(instanceAdmin) == address(0)) {
             revert ErrorInstanceInstanceAdminZero();
         }
 
-        // set authority to instance admin authority
-        __AccessManaged_init(_instanceAdmin.authority());
+        _instanceAdmin = instanceAdmin;
 
         // setup instance object info
-        initializeRegisterable(
+        __Registerable_init(
+            instanceAdmin.authority(),
             address(registry), 
             registry.getNftId(), 
             INSTANCE(), 
@@ -96,27 +74,65 @@ contract Instance is
 
         // store instance supporting contracts
         _instanceStore = instanceStore;
-        _bundleManager = bundleManager;
+        _bundleSet = bundleSet;
+        _riskSet = riskSet;
         _instanceReader = instanceReader;
 
         // initialize instance supporting contracts
         _instanceStore.initialize();
-        _bundleManager.initialize();
+        _bundleSet.initialize(instanceAdmin.authority(), address(registry));
+        _riskSet.initialize(instanceAdmin.authority(), address(registry));
         _instanceReader.initialize();
 
+        _componentService = IComponentService(
+            getRegistry().getServiceAddress(
+                COMPONENT(), 
+                release));
+
         _instanceService = IInstanceService(
             getRegistry().getServiceAddress(
                 INSTANCE(), 
-                getMajorVersion()));
+                release));
+
+        _registerInterface(type(IInstance).interfaceId);    
+    }
+
 
-        registerInterface(type(IInstance).interfaceId);    
+    function setInstanceLocked(bool locked)
+        external 
+        // not restricted(): need to be able to unlock a locked instance
+        onlyOwner()
+    {
+        _instanceService.setInstanceLocked(locked);
+    }
+
+
+    function upgradeInstanceReader()
+        external
+        restricted()
+        onlyOwner()
+    {
+        _instanceService.upgradeInstanceReader();
+    }
+
+
+    //--- ProductRegistration ----------------------------------------------//
+
+    function registerProduct(address product)
+        external
+        restricted()
+        onlyOwner()
+        returns (NftId productNftId)
+    {
+        productNftId = _componentService.registerProduct(product);
+        _products.push(productNftId);
     }
 
     //--- Staking ----------------------------------------------------------//
 
     function setStakingLockingPeriod(Seconds stakeLockingPeriod)
         external
-        // TODO decide if onlyOwner or restricted to instance owner role is better
+        restricted()
         onlyOwner()
     {
         _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
@@ -124,13 +140,22 @@ contract Instance is
 
     function setStakingRewardRate(UFixed rewardRate)
         external
+        restricted()
         onlyOwner()
     {
         _instanceService.setStakingRewardRate(rewardRate);
     }
 
+    function setStakingMaxAmount(Amount maxStakedAmount)
+        external
+        onlyOwner()
+    {
+        _instanceService.setStakingMaxAmount(maxStakedAmount);
+    }
+
     function refillStakingRewardReserves(Amount dipAmount)
         external
+        restricted()
         onlyOwner()
     {
         address instanceOwner = msg.sender;
@@ -139,6 +164,7 @@ contract Instance is
 
     function withdrawStakingRewardReserves(Amount dipAmount)
         external
+        restricted()
         onlyOwner()
         returns (Amount newBalance)
     {
@@ -149,6 +175,7 @@ contract Instance is
 
     function createRole(string memory roleName, string memory adminName)
         external
+        restricted()
         onlyOwner()
         returns (RoleId roleId, RoleId admin)
     {
@@ -158,6 +185,7 @@ contract Instance is
 
     function grantRole(RoleId roleId, address account) 
         external 
+        restricted()
         onlyOwner()
     {
         _instanceAdmin.grantRole(roleId, account);
@@ -165,6 +193,7 @@ contract Instance is
 
     function revokeRole(RoleId roleId, address account) 
         external 
+        restricted()
         onlyOwner()
     {
         // TODO refactor
@@ -173,8 +202,18 @@ contract Instance is
 
     //--- Targets ------------------------------------------------------------//
 
+
+    function setTargetLocked(address target, bool locked)
+        external 
+        // not restricted(): instance owner may need to be able to unlock targets on an locked instance
+        onlyOwner()
+    {
+        _instanceService.setTargetLocked(target, locked);
+    }
+
     function createTarget(address target, string memory name) 
         external 
+        restricted()
         onlyOwner()
     {
         // TODO refactor
@@ -187,29 +226,16 @@ contract Instance is
         RoleId roleId
     ) 
         external 
+        restricted()
         onlyOwner()
     {
         // TODO refactor
         // _instanceAdmin.setTargetFunctionRoleByInstance(targetName, selectors, roleId);
     }
 
-    function setTargetLocked(address target, bool locked)
-        external 
-        onlyOwner()
-    {
-        // TODO refactor
-        // _instanceAdmin.setTargetLockedByInstance(target, locked);
-    }
-
     //--- ITransferInterceptor ----------------------------------------------//
 
-    // TODO interception of child components nfts
-    function nftMint(address to, uint256 tokenId) external onlyChainNft {
-        // TODO refactor
-        // _instanceAdmin.transferInstanceOwnerRole(address(0), to);
-    }
-
-    function nftTransferFrom(address from, address to, uint256 tokenId) external onlyChainNft {
+    function nftTransferFrom(address from, address to, uint256 tokenId, address operator) external onlyChainNft {
         // TODO refactor
         // _instanceAdmin.transferInstanceOwnerRole(from, to);
     }
@@ -230,12 +256,32 @@ contract Instance is
 
     //--- external view functions -------------------------------------------//
 
+    function isInstanceLocked() external view returns (bool) {
+        return _instanceAdmin.isLocked();
+    }
+
+    function isTargetLocked(address target) external view returns (bool) {
+        return _instanceAdmin.isTargetLocked(target);
+    }
+
+    function products() external view returns (uint256 productCount) {
+        return _products.length;
+    }
+
+    function getProductNftId(uint256 idx) external view returns (NftId productNftId) {
+        return _products[idx];
+    }
+
     function getInstanceReader() external view returns (InstanceReader) {
         return _instanceReader;
     }
 
     function getBundleSet() external view returns (BundleSet) {
-        return _bundleManager;
+        return _bundleSet;
+    }
+
+    function getRiskSet() external view returns (RiskSet) {
+        return _riskSet;
     }
 
     function getInstanceAdmin() external view returns (InstanceAdmin) {
@@ -246,9 +292,5 @@ contract Instance is
         return _instanceStore;
     }
 
-    function getMajorVersion() public pure returns (VersionPart majorVersion) {
-        return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
-    }
-
     //--- internal view/pure functions --------------------------------------//
 }