@etherisc/gif-next 0.0.2-da2c7dd-538 → 0.0.2-db12733-152

package/contracts/examples/unpermissioned/SimpleDistribution.sol

@@ -7,6 +7,9 @@ import {Amount} from "../../type/Amount.sol";
 import {BasicDistribution} from "../../distribution/BasicDistribution.sol";
 import {IAuthorization} from "../../authorization/IAuthorization.sol";
 import {NftId} from "../../type/NftId.sol";
+import {ReferralId} from "../../type/Referral.sol";
+import {Timestamp, TimestampLib} from "../../type/Timestamp.sol";
+import {UFixed, UFixedLib} from "../../type/UFixed.sol";
 
 
 contract SimpleDistribution is
@@ -17,8 +20,7 @@ contract SimpleDistribution is
         address registry,
         NftId productNftId,
         IAuthorization authorization,
-        address initialOwner,
-        address token
+        address initialOwner
     ) 
     {
         initialize(
@@ -26,8 +28,7 @@ contract SimpleDistribution is
             productNftId,
             authorization,
             initialOwner,
-            "SimpleDistribution",
-            token);
+            "SimpleDistribution");
     }
 
     function initialize(
@@ -35,8 +36,7 @@ contract SimpleDistribution is
         NftId productNftId,
         IAuthorization authorization,
         address initialOwner,
-        string memory name,
-        address token
+        string memory name
     )
         public
         virtual
@@ -47,11 +47,35 @@ contract SimpleDistribution is
             productNftId,
             authorization,
             initialOwner,
-            name,
-            token);
+            name);
     }
 
     function approveTokenHandler(IERC20Metadata token, Amount amount) external restricted() onlyOwner() { _approveTokenHandler(token, amount); }
     function setLocked(bool locked) external onlyOwner() { _setLocked(locked); }
     function setWallet(address newWallet) external restricted() onlyOwner() { _setWallet(newWallet); }
+
+    /**
+     * @dev create referral codes. This is required for testing only to provide a distributor that is not the message sender. 
+     */
+    function createReferral2(
+        NftId distributorNftId,
+        string memory code,
+        UFixed discountPercentage,
+        uint32 maxReferrals,
+        Timestamp expiryAt,
+        bytes memory data
+    )
+        external
+        virtual
+        returns (ReferralId referralId)
+    {
+        return _createReferral(
+            distributorNftId,
+            code,
+            discountPercentage,
+            maxReferrals,
+            expiryAt,
+            data); // data
+    }
+
 }

package/contracts/examples/unpermissioned/SimpleOracle.sol

@@ -34,8 +34,7 @@ contract SimpleOracle is
         address registry,
         NftId productNftId,
         IAuthorization authorization,
-        address initialOwner,
-        address token
+        address initialOwner
     ) 
     {
         initialize(
@@ -43,8 +42,7 @@ contract SimpleOracle is
             productNftId,
             authorization,
             initialOwner,
-            "SimpleOracle",
-            token
+            "SimpleOracle"
         );
     }
 
@@ -53,8 +51,7 @@ contract SimpleOracle is
         NftId productNftId,
         IAuthorization authorization,
         address initialOwner,
-        string memory name,
-        address token
+        string memory name
     )
         public
         virtual
@@ -65,8 +62,7 @@ contract SimpleOracle is
             productNftId,
             authorization,
             initialOwner,
-            name,
-            token);
+            name);
     }
 
     /// @dev use case specific handling of oracle requests

package/contracts/examples/unpermissioned/SimplePool.sol

@@ -19,7 +19,6 @@ contract SimplePool is
     constructor(
         address registry,
         NftId productNftId,
-        address token,
         IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
@@ -28,7 +27,6 @@ contract SimplePool is
         initialize(
             registry,
             productNftId,
-            token,
             poolInfo,
             authorization,
             initialOwner
@@ -39,7 +37,6 @@ contract SimplePool is
     function initialize(
         address registry,
         NftId productNftId,
-        address token,
         IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
@@ -52,7 +49,6 @@ contract SimplePool is
             registry,
             productNftId,
             "SimplePool",
-            token,
             poolInfo,
             authorization,
             initialOwner);

package/contracts/examples/unpermissioned/SimpleProduct.sol

@@ -37,7 +37,6 @@ contract SimpleProduct is
         address registry,
         NftId instanceNftId,
         string memory name,
-        address token,
         IComponents.ProductInfo memory productInfo,
         IComponents.FeeInfo memory feeInfo,
         IAuthorization authorization,
@@ -48,7 +47,6 @@ contract SimpleProduct is
             registry,
             instanceNftId,
             name,
-            token,
             productInfo,
             feeInfo,
             authorization,
@@ -60,7 +58,6 @@ contract SimpleProduct is
         address registry,
         NftId instanceNftid,
         string memory name,
-        address token,
         IComponents.ProductInfo memory productInfo,
         IComponents.FeeInfo memory feeInfo,
         IAuthorization authorization,
@@ -74,7 +71,6 @@ contract SimpleProduct is
             registry,
             instanceNftid,
             name,
-            token,
             productInfo,
             feeInfo,
             authorization,

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,8 +38,44 @@ 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);
+    function registerProduct(address product, address token) 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;
@@ -47,15 +83,14 @@ interface IInstance is
 
     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;
 
-    function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
-    function setStakingRewardRate(UFixed rewardRate) external;
-    function refillStakingRewardReserves(Amount dipAmount) external;
+    //--- getters -----------------------------------------------------------//
 
-    /// @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);
+    /// @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);
@@ -67,4 +102,5 @@ interface IInstance is
     function getRiskSet() external view returns (RiskSet);
     function getInstanceAdmin() external view returns (InstanceAdmin);
     function getInstanceStore() external view returns (InstanceStore);
+    function isTokenRegistryDisabled() external view returns (bool);
 }

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(address instance, VersionPart instanceVersion);
+    error ErrorInstanceServiceInstanceVersionMismatch(NftId instanceNftId, VersionPart expectedRelease, VersionPart instanceRelease);
 
     error ErrorInstanceServiceComponentNotInstanceLinked(address component);
 
@@ -53,18 +53,34 @@ interface IInstanceService is IService {
     
     event LogInstanceCloned(NftId instanceNftId, address instance);
 
-    function createInstance()
+    /// @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.
+    /// @param allowAnyToken specifies whether the new instance is allowed to use any token or 
+    /// only tokens that are registered in the `TokenRegistry`. Use of tokens **not** registered in the
+    /// `TokenRegistry` may result in problems with token handline and is therefor not recommended. The 
+    /// use of such instances **is not supported** by Etherisc. 
+    function createInstance(bool allowAnyToken)
         external 
         returns (
             IInstance instance,
             NftId instanceNftId
         );
 
-    function upgradeInstanceReader(NftId instanceNftId) external;
+    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.

package/contracts/instance/Instance.sol

@@ -1,22 +1,24 @@
 // 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,
@@ -33,6 +35,7 @@ contract Instance is
     RiskSet internal _riskSet;
     InstanceStore internal _instanceStore;
     NftId [] internal _products;
+    bool internal _tokenRegistryDisabled;
 
     modifier onlyChainNft() {
         if(msg.sender != getRegistry().getChainNftAddress()) {
@@ -48,7 +51,9 @@ contract Instance is
         RiskSet riskSet,
         InstanceReader instanceReader,
         IRegistry registry, 
-        address initialOwner
+        VersionPart release,
+        address initialOwner,
+        bool tokenRegistryDisabled
     ) 
         external 
         initializer()
@@ -84,24 +89,46 @@ contract Instance is
         _componentService = IComponentService(
             getRegistry().getServiceAddress(
                 COMPONENT(), 
-                getRelease()));
+                release));
 
         _instanceService = IInstanceService(
             getRegistry().getServiceAddress(
                 INSTANCE(), 
-                getRelease()));
+                release));
+
+        _tokenRegistryDisabled = tokenRegistryDisabled;
 
         _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)
+    function registerProduct(address product, address token)
         external
+        restricted()
         onlyOwner()
         returns (NftId productNftId)
     {
-        productNftId = _componentService.registerProduct(product);
+        productNftId = _componentService.registerProduct(product, token);
         _products.push(productNftId);
     }
 
@@ -109,6 +136,7 @@ contract Instance is
 
     function setStakingLockingPeriod(Seconds stakeLockingPeriod)
         external
+        restricted()
         onlyOwner()
     {
         _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
@@ -116,13 +144,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;
@@ -131,6 +168,7 @@ contract Instance is
 
     function withdrawStakingRewardReserves(Amount dipAmount)
         external
+        restricted()
         onlyOwner()
         returns (Amount newBalance)
     {
@@ -141,6 +179,7 @@ contract Instance is
 
     function createRole(string memory roleName, string memory adminName)
         external
+        restricted()
         onlyOwner()
         returns (RoleId roleId, RoleId admin)
     {
@@ -150,6 +189,7 @@ contract Instance is
 
     function grantRole(RoleId roleId, address account) 
         external 
+        restricted()
         onlyOwner()
     {
         _instanceAdmin.grantRole(roleId, account);
@@ -157,6 +197,7 @@ contract Instance is
 
     function revokeRole(RoleId roleId, address account) 
         external 
+        restricted()
         onlyOwner()
     {
         // TODO refactor
@@ -165,8 +206,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
@@ -179,19 +230,13 @@ 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 {
@@ -215,6 +260,14 @@ 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;
     }
@@ -243,5 +296,9 @@ contract Instance is
         return _instanceStore;
     }
 
+    function isTokenRegistryDisabled() external view returns (bool) {
+        return _tokenRegistryDisabled;
+    }
+
     //--- internal view/pure functions --------------------------------------//
 }