@etherisc/gif-next 0.0.2-7ca6cd9-950 → 0.0.2-7d65090-351

package/contracts/shared/AccessManagerCustom.sol

@@ -17,7 +17,12 @@ import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Ini
     2. _getAdminRestrictions() private view -> internal virtual view
     3. _checkSelector() private pure -> internal pure
 */
-abstract contract AccessManagerCustom is Initializable, ContextUpgradeable, MulticallUpgradeable, IAccessManager {
+abstract contract AccessManagerCustom is
+    Initializable, 
+    ContextUpgradeable, 
+    MulticallUpgradeable, 
+    IAccessManager
+{
     using Time for *;
 
     // Structure that stores the details for a target contract.

package/contracts/shared/AccessManagerExtended.sol

@@ -13,7 +13,10 @@ import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 
 
 // IMPORTANT: check role/target for existance before using return value of getter
-contract AccessManagerExtended is AccessManagerCustom, IAccessManagerExtended {
+contract AccessManagerExtended is
+    AccessManagerCustom, 
+    IAccessManagerExtended
+{
     using EnumerableSet for EnumerableSet.AddressSet;
 
     string constant private ADMIN_ROLE_NAME = "Admin";
@@ -76,6 +79,14 @@ contract AccessManagerExtended is AccessManagerCustom, IAccessManagerExtended {
         return $._targetAddressForName[name] != address(0);
     }
 
+    function getTargets() public view returns (uint256 numberOfTargets) {
+        return _getAccessManagerExtendedStorage()._targetAddresses.length;
+    }
+
+    function getTarget(uint256 idx) public view returns (address target) {
+        return _getAccessManagerExtendedStorage()._targetAddresses[idx];
+    }
+
     function getTargetAddress(string memory name) public view returns(address targetAddress) {
         AccessManagerExtendedStorage storage $ = _getAccessManagerExtendedStorage();
         return $._targetAddressForName[name];

package/contracts/shared/ComponentService.sol

@@ -64,11 +64,6 @@ contract ComponentService is
         registerInterface(type(IComponentService).interfaceId);
     }
 
-
-    function getDomain() public pure virtual override returns(ObjectType) {
-        return COMPONENT();
-    }
-
     //-------- component ----------------------------------------------------//
 
     function setWallet(address newWallet) external virtual {
@@ -615,4 +610,8 @@ contract ComponentService is
             revert ErrorComponentServiceExpectedRoleMissing(info.parentNftId, requiredRole, owner);
         }
     }
+
+    function _getDomain() internal pure virtual override returns(ObjectType) {
+        return COMPONENT();
+    }
 }

package/contracts/shared/IAccessAdmin.sol

@@ -0,0 +1,168 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+
+import {RoleId} from "../type/RoleId.sol";
+import {Selector} from "../type/Selector.sol";
+import {Str} from "../type/String.sol";
+import {Timestamp} from "../type/Timestamp.sol";
+
+interface IAccessAdmin is 
+    IAccessManaged
+{
+
+    // roles
+    event LogRoleCreated(RoleId roleId, RoleId roleAdminId, string name);
+    event LogRoleDisabled(RoleId roleId, bool disabled, Timestamp disabledAtOld);
+    event LogTargetCreated(address target, string name);
+    event LogFunctionCreated(address target, Selector selector, string name);
+
+    // only deployer modifier
+    error ErrorNotDeployer();
+
+    // only role admin modifier
+    error ErrorNotAdminOfRole(RoleId adminRoleId);
+
+    // only role owner modifier
+    error ErrorNotRoleOwner(RoleId roleId);
+
+    // initialize authority
+    error ErrorAuthorityAlreadySet();
+    error ErrorAdminRoleMissing();
+
+    // create role
+    error ErrorRoleAlreadyCreated(RoleId roleId, string name);
+    error ErrorRoleAdminNotExisting(RoleId adminRoleId);
+    error ErrorRoleNameEmpty(RoleId roleId);
+    error ErrorRoleNameAlreadyExists(RoleId roleId, string name, RoleId existingRoleId);
+
+    // grant/revoke/renounce role
+    error ErrorRoleUnknown(RoleId roleId);
+    error ErrorRoleIsLocked(RoleId roleId);
+    error ErrorRoleIsDisabled(RoleId roleId);
+    error ErrorRoleMembersLimitReached(RoleId roleId, uint256 memberCountLimit);
+    error ErrorRoleRemovalDisabled(RoleId roleId);
+
+    // create target
+    error ErrorTargetAlreadyCreated(address target, string name);
+    error ErrorTargetNameEmpty(address target);
+    error ErrorTargetNameAlreadyExists(address target, string name, address existingTarget);
+    error ErrorTargetNotAccessManaged(address target);
+    error ErrorTargetAuthorityMismatch(address expectedAuthority, address actualAuthority);
+
+    // lock target
+    error ErrorTagetNotLockable();
+
+    // authorize target functions
+    error ErrorAuthorizeForAdminRoleInvalid(address target);
+
+    // check target
+    error ErrorTargetUnknown(address target);
+
+    struct RoleInfo {
+        RoleId adminRoleId;
+        Str name;
+        uint256 maxMemberCount;
+        bool memberRemovalDisabled;
+        Timestamp disabledAt;
+        bool exists;
+    }
+
+    struct RoleNameInfo {
+        RoleId roleId;
+        bool exists;
+    }
+
+    struct TargetInfo {
+        Str name;
+        Timestamp createdAt;
+    }
+
+    struct Function {
+        Selector selector; // function selector
+        Str name; // function name
+    }
+
+    /// @dev Create a new named role using the specified parameters.
+    /// The adminRoleId refers to the required role to grant/revoke the newly created role.
+    /// permissioned: the caller must have the manager role (getManagerRole).
+    function createRole(
+        RoleId roleId, 
+        RoleId adminRoleId, 
+        string memory name,
+        uint256 maxMemberCount,
+        bool memberRemovalDisabled
+    )
+        external;
+
+    /// @dev Set the disabled status of the speicified role.
+    /// Role disabling only prevents the role from being granted to new accounts.
+    /// Existing role members may still execute functions that are authorized for that role.
+    /// Permissioned: the caller must have the manager role (getManagerRole).
+    function setRoleDisabled(RoleId roleId, bool disabled) external;
+
+    /// @dev Grant the specified account the provided role.
+    /// Permissioned: the caller must have the roles admin role.
+    function grantRole(address account, RoleId roleId) external;
+
+    /// @dev Revoke the provided role from the specified account.
+    /// Permissioned: the caller must have the roles admin role.
+    function revokeRole(address account, RoleId roleId) external;
+
+    /// @dev Removes the provided role from the caller
+    function renounceRole(RoleId roleId) external;
+
+    /// @dev Create a new named target.
+    /// Permissioned: the caller must have the manager role (getManagerRole).
+    function createTarget(address target, string memory name) external;
+
+    /// @dev Set the locked status of the speicified contract.
+    /// IMPORTANT: using this function the AccessManager might itself be put into locked state from which it cannot be unlocked again.
+    /// Overwrite this function if a different use case specific behaviour is required.
+    /// Alternatively, add specific function to just unlock this contract without a restricted() modifier.
+    /// Permissioned: the caller must have the manager role (getManagerRole).
+    function setTargetLocked(address target, bool locked) external;
+
+    /// @dev Specifies which functions of the target can be accessed by the provided role.
+    /// Previously existing authorizations will be overwritten.
+    /// Authorizing the admin role is not allowed, use function unauthorizedFunctions for this.
+    /// Permissioned: the caller must have the manager role (getManagerRole).
+    function authorizeFunctions(address target, RoleId roleId, Function[] memory functions) external;
+
+    /// @dev Specifies for which functionss to remove any previous authorization
+    /// Permissioned: the caller must have the manager role (getManagerRole).
+    function unauthorizeFunctions(address target, Function[] memory functions) external;
+
+    //--- view functions ----------------------------------------------------//
+
+    function roles() external view returns (uint256 numberOfRoles);
+    function getRoleId(uint256 idx) external view returns (RoleId roleId);
+    function getAdminRole() external view returns (RoleId roleId);
+    function getManagerRole() external view returns (RoleId roleId);
+    function getPublicRole() external view returns (RoleId roleId);
+
+    function roleExists(RoleId roleId) external view returns (bool exists); 
+    function isRoleDisabled(RoleId roleId) external view returns (bool roleIsActive);
+    function getRoleInfo(RoleId roleId) external view returns (RoleInfo memory roleInfo);
+    function getRoleForName(Str name) external view returns (RoleNameInfo memory);
+
+    function hasRole(address account, RoleId roleId) external view returns (bool);
+    function roleMembers(RoleId roleId) external view returns (uint256 numberOfMembers);
+    function getRoleMember(RoleId roleId, uint256 idx) external view returns (address account);
+
+    function targetExists(address target) external view returns (bool exists);
+    function isTargetLocked(address target) external view returns (bool locked);
+    function targets() external view returns (uint256 numberOfTargets);
+    function getTargetAddress(uint256 idx) external view returns (address target);
+    function getTargetInfo(address target) external view returns (TargetInfo memory targetInfo);
+    function getTargetForName(Str name) external view returns (address target);
+
+    function authorizedFunctions(address target) external view returns (uint256 numberOfFunctions);
+    function getAuthorizedFunction(address target, uint256 idx) external view returns (Function memory func, RoleId roleId);
+    function canCall(address caller, address target, Selector selector) external view returns (bool can);
+
+    function toFunction(bytes4 selector, string memory name) external pure returns (Function memory);
+    function isAccessManaged(address target) external view returns (bool);
+    function deployer() external view returns (address);
+}

package/contracts/shared/IService.sol

@@ -6,6 +6,7 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {IRegisterable} from "./IRegisterable.sol";
 import {IVersionable} from "./IVersionable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
+import {RoleId} from "../type/RoleId.sol";
 
 interface IService is 
     IRegisterable,
@@ -14,5 +15,11 @@ interface IService is
 {
     error ErrorServiceNotImplemented();
 
+    /// @dev returns the domain for this service.
+    /// In any GIF release only one service for any given domain may be deployed.
     function getDomain() external pure returns(ObjectType serviceDomain);
+
+    /// @dev returns the GIF release specific role id.
+    /// These role ids are used to authorize service to service communication.
+    function getRoleId() external pure returns(RoleId serviceRoleId);
 }

package/contracts/shared/Service.sol

@@ -4,17 +4,15 @@ pragma solidity ^0.8.20;
 import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
-import {ObjectType, REGISTRY, SERVICE} from "../type/ObjectType.sol";
-import {NftId} from "../type/NftId.sol";
-import {Version, VersionPart, VersionLib, VersionPartLib} from "../type/Version.sol";
-
-import {Versionable} from "./Versionable.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "./IService.sol";
 import {IVersionable} from "./IVersionable.sol";
-import {Versionable} from "./Versionable.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, REGISTRY, SERVICE} from "../type/ObjectType.sol";
 import {Registerable} from "./Registerable.sol";
-
-import {IRegistry} from "../registry/IRegistry.sol";
+import {RoleId, RoleIdLib} from "../type/RoleId.sol";
+import {Version, VersionPart, VersionLib, VersionPartLib} from "../type/Version.sol";
+import {Versionable} from "./Versionable.sol";
 
 
 /// @dev service base contract
@@ -27,15 +25,6 @@ abstract contract Service is
 
     uint8 private constant GIF_MAJOR_VERSION = 3;
 
-    // from Versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
-    }
 
     function initializeService(
         address registry, 
@@ -58,9 +47,7 @@ abstract contract Service is
         if(authority != address(0)) {
             __AccessManaged_init(authority);
         } else {
-            address registryServiceAddress = getRegistry().getServiceAddress(
-                REGISTRY(), 
-                VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
+            address registryServiceAddress = _getServiceAddress(REGISTRY());
 
             // copy authority from already registered registry services
             __AccessManaged_init(IAccessManaged(registryServiceAddress).authority());
@@ -70,8 +57,27 @@ abstract contract Service is
         registerInterface(type(IService).interfaceId);
     }
 
+    function getDomain() external virtual pure returns(ObjectType serviceDomain) {
+        return _getDomain();
+    }
+
+    function getRoleId() external virtual pure returns(RoleId serviceRoleId) {
+        return RoleIdLib.roleForTypeAndVersion(_getDomain(), VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
+    }
+
+    // from Versionable
+    function getVersion()
+        public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
+    }
+
+    function _getDomain() internal virtual pure returns (ObjectType);
 
     function _getServiceAddress(ObjectType domain) internal view returns (address) {
-        return getRegistry().getServiceAddress(domain, getVersion().toMajorPart());
+        return getRegistry().getServiceAddress(domain, VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
     }
 }

package/contracts/staking/IStakingService.sol

@@ -52,21 +52,25 @@ interface IStakingService is IService
         UFixed initialRewardRate
     ) external;
 
-    /// @dev set the stake locking period to the specified duration.
+    /// @dev Set the instance stake locking period to the specified duration.
     /// permissioned: only the owner of the specified target may set the locking period
-    function setLockingPeriod(NftId targetNftId, Seconds lockingPeriod) external;
+    function setInstanceLockingPeriod(NftId instanceNftId, Seconds lockingPeriod) external;
 
-    /// @dev set the reward rate to the specified value
+    /// @dev Set the instance reward rate to the specified value
     /// permissioned: only the owner of the specified target may set the locking period
-    function setRewardRate(NftId targetNftId, UFixed rewardRate) external;
+    function setInstanceRewardRate(NftId instanceNftId, UFixed rewardRate) external;
 
-    /// @dev (re)fills the staking reward reserves for the specified target
+    /// @dev (Re)fills the staking reward reserves for the specified target using the dips provided by the reward provider.
     /// unpermissioned: anybody may fill up staking reward reserves
-    function refillRewardReserves(NftId targetNftId, Amount dipAmount) external returns (Amount newBalance);
+    function refillInstanceRewardReserves(NftId instanceNftId, address rewardProvider, Amount dipAmount) external returns (Amount newBalance);
+
+    /// @dev (Re)fills the staking reward reserves for the specified target using the dips provided by the sender
+    /// unpermissioned: anybody may fill up staking reward reserves
+    function refillRewardReservesBySender(NftId targetNftId, Amount dipAmount) external returns (Amount newBalance);
 
     /// @dev defunds the staking reward reserves for the specified target
     /// permissioned: only the target owner may call this function
-    function withdrawRewardReserves(NftId targetNftId, Amount dipAmount) external returns (Amount newBalance);
+    function withdrawInstanceRewardReserves(NftId instanceNftId, Amount dipAmount) external returns (Amount newBalance);
 
     /// @dev create a new stake with amount DIP to the specified target
     /// returns the id of the newly minted stake nft

package/contracts/staking/StakeManagerLib.sol

@@ -13,12 +13,64 @@ import {NftId} from "../type/NftId.sol";
 import {ObjectType, INSTANCE, PROTOCOL, TARGET} from "../type/ObjectType.sol";
 import {Seconds, SecondsLib} from "../type/Seconds.sol";
 import {StakingReader} from "./StakingReader.sol";
+import {StakingStore} from "./StakingStore.sol";
 import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 
 library StakeManagerLib {
 
+    function stake(
+        IRegistry registry,
+        StakingReader stakingReader,
+        StakingStore stakingStore,
+        NftId stakeNftId,
+        Amount stakeAmount
+    )
+        external
+        returns (Amount stakeBalance)
+    {
+        // check that target is active for staking
+        (
+            UFixed rewardRate,
+            Seconds lockingPeriod
+        ) = checkStakeParameters(
+            stakingReader, 
+            stakeNftId);        
+
+        // calculate new rewards (if any)
+        (
+            Amount rewardIncrementAmount, 
+            Amount currentTotalDipAmount
+        ) = calculateRewardIncrease(
+            stakingReader, 
+            stakeNftId,
+            rewardRate);
+
+        stakeBalance = currentTotalDipAmount + stakeAmount;
+
+        // TODO check that additional dip, rewards and rewards increment 
+        // are still ok with max target staking amount
+        NftId targetNftId = registry.getObjectInfo(stakeNftId).parentNftId;
+
+        stakingStore.restakeRewards(
+            stakeNftId, 
+            targetNftId, 
+            rewardIncrementAmount);
+
+        stakingStore.increaseStake(
+            stakeNftId, 
+            targetNftId, 
+            stakeAmount);
+
+        // update locked until with target locking period
+        stakingStore.update(
+            stakeNftId, 
+            IStaking.StakeInfo({
+                lockedUntil: TimestampLib.blockTimestamp().addSeconds(
+                    lockingPeriod)}));
+
+    }
 
     function checkCreateParameters(
         StakingReader stakingReader,