@etherisc/gif-next 0.0.2-7c8d286-020 → 0.0.2-7d488b3-675

package/contracts/distribution/DistributionService.sol

@@ -71,7 +71,6 @@ contract DistributionService is
         bytes memory data
     )
         external
-        restricted()
         returns (DistributorType distributorType)
     {
         (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
@@ -117,7 +116,6 @@ contract DistributionService is
     )
         external 
         virtual
-        restricted()
         returns (NftId distributorNftId)
     {
         (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
@@ -145,19 +143,18 @@ contract DistributionService is
 
     function changeDistributorType(
         NftId distributorNftId,
-        DistributorType newDistributorType,
+        DistributorType distributorType,
         bytes memory data
     )
         external
         virtual
-        restricted()
     {
         _checkNftType(distributorNftId, DISTRIBUTOR());
         (NftId distributionNftId,, IInstance instance) = _getAndVerifyActiveComponent(DISTRIBUTION());
-        _checkDistributionType(instance.getInstanceReader(), newDistributorType, distributionNftId);
+        _checkDistributionType(instance.getInstanceReader(), distributorType, distributionNftId);
         
         IDistribution.DistributorInfo memory distributorInfo = instance.getInstanceReader().getDistributorInfo(distributorNftId);
-        distributorInfo.distributorType = newDistributorType;
+        distributorInfo.distributorType = distributorType;
         distributorInfo.data = data;
         instance.getInstanceStore().updateDistributor(distributorNftId, distributorInfo, KEEP_STATE());
     }
@@ -173,7 +170,6 @@ contract DistributionService is
     )
         external
         virtual
-        restricted()
         onlyNftOfType(distributorNftId, DISTRIBUTOR())
         returns (ReferralId referralId)
     {
@@ -188,7 +184,7 @@ contract DistributionService is
 
         NftId distributorDistributionNftId = getRegistry().getParentNftId(distributorNftId);
         if (distributorDistributionNftId != distributionNftId) {
-            revert ErrorDistributionServiceDistributorDistributionMismatch(distributorNftId, distributorDistributionNftId, distributionNftId);
+            revert ErrorDistributionServiceInvalidDistributor(distributorNftId);
         }
 
         {
@@ -294,7 +290,7 @@ contract DistributionService is
     function withdrawCommission(NftId distributorNftId, Amount amount) 
         public 
         virtual
-        restricted()
+        // TODO: restricted() (once #462 is done)
         onlyNftOfType(distributorNftId, DISTRIBUTOR())
         returns (Amount withdrawnAmount) 
     {
@@ -369,7 +365,7 @@ contract DistributionService is
         NftId distributorTypeDistributionNftId = instanceReader.getDistributorTypeInfo(distributorType).distributionNftId;
 
         if (distributorTypeDistributionNftId != expectedDistributionNftId) {
-            revert ErrorDistributionServiceDistributorTypeDistributionMismatch(distributorType, distributorTypeDistributionNftId, expectedDistributionNftId);
+            revert ErrorDistributionServiceInvalidDistributorType(distributorType);
         }
     }
 

package/contracts/distribution/IDistributionComponent.sol

@@ -9,8 +9,17 @@ import {UFixed} from "../type/UFixed.sol";
 
 interface IDistributionComponent is IInstanceLinkedComponent {
 
+    error ErrorDistributionNotDistributor(address distributor);
+    error ErrorDistributionAlreadyDistributor(address distributor, NftId distributorNftId);
+
     event LogDistributorUpdated(address to, address operator);
 
+    /// @dev Returns true iff the provided address is registered as a distributor with this distribution component.
+    function isDistributor(address candidate) external view returns (bool);
+
+    /// @dev Returns the distributor Nft Id for the provided address
+    function getDistributorNftId(address distributor) external view returns (NftId distributorNftId);
+
     function getDiscountPercentage(
         string memory referralCode
     ) external view returns (UFixed discountPercentage, ReferralStatus status);

package/contracts/distribution/IDistributionService.sol

@@ -13,6 +13,10 @@ import {Timestamp} from "../type/Timestamp.sol";
 
 
 interface IDistributionService is IService {
+    // TODO: rename
+    error ErrorDistributionServiceInvalidDistributorType(DistributorType distributorType);
+    // TODO: rename
+    error ErrorDistributionServiceInvalidDistributor(NftId distributorNftId);
     error ErrorDistributionServiceCallerNotRegistered(address caller);
     error ErrorDistributionServiceParentNftIdNotInstance(NftId nftId, NftId parentNftId);
     error ErrorDistributionServiceCallerNotDistributor(address caller);
@@ -25,8 +29,6 @@ interface IDistributionService is IService {
     error ErrorDistributionServiceExpirationInvalid(Timestamp expiryAt);
     error ErrorDistributionServiceCommissionTooHigh(uint256 commissionPercentage, uint256 maxCommissionPercentage);
     error ErrorDistributionServiceMinFeeTooHigh(uint256 minFee, uint256 limit);
-    error ErrorDistributionServiceDistributorTypeDistributionMismatch(DistributorType distributorType, NftId distributorTypeDistributionNftId, NftId distributionNftId);
-    error ErrorDistributionServiceDistributorDistributionMismatch(NftId distributorNftId, NftId distributorDistributionNftId, NftId distributionNftId);
 
     error ErrorDistributionServiceCommissionWithdrawAmountExceedsLimit(Amount amount, Amount limit);
     
@@ -61,7 +63,7 @@ interface IDistributionService is IService {
 
     function changeDistributorType(
         NftId distributorNftId,
-        DistributorType newDistributorType,
+        DistributorType distributorType,
         bytes memory data
     ) external;
 

package/contracts/instance/IInstance.sol

@@ -18,7 +18,7 @@ interface IInstance is
     IRegisterable
 {
     error ErrorInstanceInstanceAdminZero();
-    error ErrorInstanceInstanceAdminAlreadySet(address instanceAdmin);
+    error ErrorInstanceInstanceAdminAlreadySet(address InstanceAdmin);
     error ErrorInstanceInstanceAdminAuthorityMismatch(address instanceAuthority);
 
     error ErrorInstanceBundleSetAlreadySet(address instanceBundleSet);
@@ -38,59 +38,24 @@ interface IInstance is
         uint64 requestsCount;
     }
 
-    ///--- instance ---------------------------------------------------------//
-
-    /// @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.
-    function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
-
-    ///--- 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;
+    function setLocked(address target, bool locked) external;
 
-    //--- getters -----------------------------------------------------------//
-
-    /// @dev returns the overall locking state of the instance (including all components)
-    function isInstanceLocked() external view returns (bool isLocked);
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
+    function setStakingRewardRate(UFixed rewardRate) external;
+    function refillStakingRewardReserves(Amount dipAmount) external;
 
-    /// @dev returns the locking state of the specified target
-    function isTargetLocked(address target) external view returns (bool isLocked);
+    /// @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 products
     function products() external view returns (uint256 productCount);

package/contracts/instance/IInstanceService.sol

@@ -15,7 +15,7 @@ interface IInstanceService is IService {
     // onlyInstance
     error ErrorInstanceServiceNotRegistered(address instance);
     error ErrorInstanceServiceNotInstance(address instance, ObjectType objectType);
-    error ErrorInstanceServiceInstanceVersionMismatch(NftId instanceNftId, VersionPart expectedRelease, VersionPart instanceRelease);
+    error ErrorInstanceServiceInstanceVersionMismatch(address instance, VersionPart instanceVersion);
 
     error ErrorInstanceServiceComponentNotInstanceLinked(address component);
 
@@ -53,17 +53,6 @@ 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 (
@@ -71,12 +60,11 @@ interface IInstanceService is IService {
             NftId instanceNftId
         );
 
-    function upgradeInstanceReader() external;
+    function upgradeInstanceReader(NftId instanceNftId) 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.

package/contracts/instance/Instance.sol

@@ -1,24 +1,22 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-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 {BundleSet} from "./BundleSet.sol";
 import {RiskSet} from "./RiskSet.sol";
 import {COMPONENT, INSTANCE} from "../type/ObjectType.sol";
+import {IInstance} from "./IInstance.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {IInstanceService} from "./IInstanceService.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {InstanceStore} from "./InstanceStore.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../type/NftId.sol";
 import {Registerable} from "../shared/Registerable.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";
 
 contract Instance is
     IInstance,
@@ -50,7 +48,6 @@ contract Instance is
         RiskSet riskSet,
         InstanceReader instanceReader,
         IRegistry registry, 
-        VersionPart release,
         address initialOwner
     ) 
         external 
@@ -87,40 +84,20 @@ contract Instance is
         _componentService = IComponentService(
             getRegistry().getServiceAddress(
                 COMPONENT(), 
-                release));
+                getRelease()));
 
         _instanceService = IInstanceService(
             getRegistry().getServiceAddress(
                 INSTANCE(), 
-                release));
+                getRelease()));
 
         _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)
     {
@@ -132,7 +109,6 @@ contract Instance is
 
     function setStakingLockingPeriod(Seconds stakeLockingPeriod)
         external
-        restricted()
         onlyOwner()
     {
         _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
@@ -140,22 +116,13 @@ 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;
@@ -164,7 +131,6 @@ contract Instance is
 
     function withdrawStakingRewardReserves(Amount dipAmount)
         external
-        restricted()
         onlyOwner()
         returns (Amount newBalance)
     {
@@ -175,7 +141,6 @@ contract Instance is
 
     function createRole(string memory roleName, string memory adminName)
         external
-        restricted()
         onlyOwner()
         returns (RoleId roleId, RoleId admin)
     {
@@ -185,7 +150,6 @@ contract Instance is
 
     function grantRole(RoleId roleId, address account) 
         external 
-        restricted()
         onlyOwner()
     {
         _instanceAdmin.grantRole(roleId, account);
@@ -193,7 +157,6 @@ contract Instance is
 
     function revokeRole(RoleId roleId, address account) 
         external 
-        restricted()
         onlyOwner()
     {
         // TODO refactor
@@ -202,18 +165,8 @@ 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
@@ -226,13 +179,19 @@ contract Instance is
         RoleId roleId
     ) 
         external 
-        restricted()
         onlyOwner()
     {
         // TODO refactor
         // _instanceAdmin.setTargetFunctionRoleByInstance(targetName, selectors, roleId);
     }
 
+    function setLocked(address target, bool locked)
+        external 
+        onlyOwner()
+    {
+        _componentService.setLockedFromInstance(target, locked);
+    }
+
     //--- ITransferInterceptor ----------------------------------------------//
 
     function nftTransferFrom(address from, address to, uint256 tokenId, address operator) external onlyChainNft {
@@ -256,14 +215,6 @@ 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;
     }