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

package/contracts/staking/StakingStore.sol

@@ -85,19 +85,34 @@ contract StakingStore is
     constructor(IRegistry registry, StakingReader reader)
         AccessManaged(msg.sender)
     {
+        // set final authority
+        setAuthority(registry.getAuthority());
+
+        // set internal variables
         _registry = registry; //TODO if keeps registry -> RegistryLinked and checks registry address
-        address authority = _registry.getAuthority();
-        setAuthority(authority);
-        
         _reader = reader;
         _targetManager = new NftIdSetManager();
+
+        // register protocol target
+        _createTarget(
+            NftIdLib.toNftId(1101), 
+            IStaking.TargetInfo({
+                objectType: PROTOCOL(),
+                chainId: 1,
+                lockingPeriod: TargetManagerLib.getDefaultLockingPeriod(),
+                rewardRate: TargetManagerLib.getDefaultRewardRate()}));
     }
 
 
     //--- staking rate specific functions -----------------------------------//
 
-    function setStakingRate(uint256 chainId, address token, UFixed stakingRate)
+    function setStakingRate(
+        uint256 chainId, 
+        address token, 
+        UFixed stakingRate
+    )
         external
+        restricted()
     {
         _stakingRate[chainId][token] = stakingRate;
     }
@@ -109,16 +124,9 @@ contract StakingStore is
         IStaking.TargetInfo memory targetInfo
     )
         external
+        restricted()
     {
-        _create(
-            targetNftId.toKey32(TARGET()),
-            abi.encode(targetInfo));
-
-        // initialize tvl and stake balance
-        _tvlLastUpdatedIn[targetNftId]= BlocknumberLib.currentBlocknumber();
-        _createTargetBalance(targetNftId);
-
-        _targetManager.add(targetNftId);
+        _createTarget(targetNftId, targetInfo);
     }
 
 
@@ -127,6 +135,7 @@ contract StakingStore is
         IStaking.TargetInfo memory targetInfo
     )
         external
+        restricted()
     {
         _update(
             targetNftId.toKey32(TARGET()), 
@@ -139,6 +148,7 @@ contract StakingStore is
         Amount dipAmount
     )
         external
+        restricted()
         returns (Amount newReserveBalance)
     {
         newReserveBalance = _reserveBalance[targetNftId] + dipAmount;
@@ -153,6 +163,7 @@ contract StakingStore is
         Amount dipAmount
     )
         external
+        restricted()
         returns (Amount newReserveBalance)
     {
         Amount reserveAmount = _reserveBalance[targetNftId];
@@ -170,24 +181,6 @@ contract StakingStore is
     }
 
 
-    function _updateReserves(
-        NftId targetNftId, 
-        Amount newRewardBalance
-    )
-        internal
-        returns (Blocknumber lastUpdatedIn)
-    {
-        if (_lastUpdatedIn[targetNftId].eqz()) {
-            revert ErrorStakingStoreNotTarget(targetNftId);
-        }
-
-        lastUpdatedIn = _lastUpdatedIn[targetNftId];
-
-        _reserveBalance[targetNftId] = newRewardBalance;
-        _lastUpdatedIn[targetNftId] = BlocknumberLib.currentBlocknumber();
-    }
-
-
     //--- tvl specific functions -------------------------------------//
 
     function increaseTotalValueLocked(
@@ -197,6 +190,7 @@ contract StakingStore is
         Amount amount
     )
         external
+        restricted()
         returns (Amount newBalance)
     {
         (
@@ -229,6 +223,7 @@ contract StakingStore is
         Amount amount
     )
         external
+        restricted()
         returns (Amount newBalance)
     {
         (
@@ -261,6 +256,7 @@ contract StakingStore is
         IStaking.StakeInfo memory stakeInfo
     )
         external
+        restricted()
     {
         _create(
             stakeNftId.toKey32(STAKE()),
@@ -274,6 +270,7 @@ contract StakingStore is
         IStaking.StakeInfo memory stakeInfo
     )
         external
+        restricted()
     {
         _update(
             stakeNftId.toKey32(STAKE()),
@@ -289,7 +286,8 @@ contract StakingStore is
         NftId targetNftId,
         Amount amount
     )
-        public
+        external
+        restricted()
     {
         Blocknumber lastUpdatedIn = _checkBalanceExists(nftId);
 
@@ -313,6 +311,7 @@ contract StakingStore is
         Amount rewardIncrementAmount
     )
         external
+        restricted()
     {
         Blocknumber lastUpdatedIn = _checkBalanceExists(nftId);
         Amount stakeAmount = _stakeBalance[nftId];
@@ -339,6 +338,7 @@ contract StakingStore is
         Amount rewardIncrementAmount
     )
         external
+        restricted()
     {
         Blocknumber lastUpdatedIn = _checkBalanceExists(nftId);
 
@@ -363,6 +363,7 @@ contract StakingStore is
         Amount maxClaimAmount
     )
         external
+        restricted()
         returns (Amount claimedAmount)
     {
         Blocknumber lastUpdatedIn = _checkBalanceExists(nftId);
@@ -392,6 +393,7 @@ contract StakingStore is
         Amount maxClaimAmount
     )
         external
+        restricted()
         returns (
             Amount unstakedAmount,
             Amount claimedAmount
@@ -475,8 +477,44 @@ contract StakingStore is
 
     //--- private functions -------------------------------------------//
 
+    function _createTarget(
+        NftId targetNftId,
+        IStaking.TargetInfo memory targetInfo
+    )
+        private
+    {
+        _create(
+            targetNftId.toKey32(TARGET()),
+            abi.encode(targetInfo));
+
+        // initialize tvl and stake balance
+        _tvlLastUpdatedIn[targetNftId]= BlocknumberLib.currentBlocknumber();
+        _createTargetBalance(targetNftId);
+
+        _targetManager.add(targetNftId);
+    }
+
+    function _updateReserves(
+        NftId targetNftId, 
+        Amount newRewardBalance
+    )
+        private
+        returns (Blocknumber lastUpdatedIn)
+    {
+        if (_lastUpdatedIn[targetNftId].eqz()) {
+            revert ErrorStakingStoreNotTarget(targetNftId);
+        }
+
+        lastUpdatedIn = _lastUpdatedIn[targetNftId];
+
+        _reserveBalance[targetNftId] = newRewardBalance;
+        _lastUpdatedIn[targetNftId] = BlocknumberLib.currentBlocknumber();
+    }
+
 
-    function _createTargetBalance(NftId nftId) private {
+    function _createTargetBalance(NftId nftId)
+        private
+    {
         if (_lastUpdatedIn[nftId].gtz()) {
             revert ErrorStakingStoreBalanceAlreadyInitialized(nftId);
         }
@@ -492,7 +530,9 @@ contract StakingStore is
     }
 
 
-    function _createStakeBalance(NftId nftId) private {
+    function _createStakeBalance(NftId nftId)
+        private
+    {
         if (_lastUpdatedIn[nftId].gtz()) {
             revert ErrorStakingStoreBalanceAlreadyInitialized(nftId);
         }
@@ -512,7 +552,7 @@ contract StakingStore is
         Amount newStakeAmount,
         Amount newRewardAmount
     )
-        internal
+        private
     {
         _stakeBalance[stakeNftId] = newStakeAmount;
         _rewardBalance[stakeNftId] = newRewardAmount;
@@ -527,7 +567,7 @@ contract StakingStore is
         Amount newStakeAmount,
         Amount newRewardAmount
     )
-        internal
+        private
     {
         _stakeBalance[targetNftId] = newStakeAmount;
         _rewardBalance[targetNftId] = newRewardAmount;
@@ -537,7 +577,8 @@ contract StakingStore is
     }
 
     function _checkBalanceExists(NftId nftId)
-        internal
+        private
+        view
         returns (Blocknumber lastUpdatedIn)
     {
         lastUpdatedIn = _lastUpdatedIn[nftId];
@@ -552,7 +593,7 @@ contract StakingStore is
         NftId targetNftId,
         address token
     )
-        internal
+        private
         view
         returns (
             Blocknumber tvlLastUpdatedIn,

package/contracts/type/ObjectType.sol

@@ -12,130 +12,125 @@ using {
     ObjectTypeLib.gtz
 } for ObjectType global;
 
-// general pure free functions
 
-function RELEASE() pure returns (ObjectType) {
-    return toObjectType(1);
-}
+//--- GIF object types/domains (rage: 1 - 99) -------------------------------//
 
 function PROTOCOL() pure returns (ObjectType) {
-    return toObjectType(10);
+    return ObjectType.wrap(1);
 }
 
-function ROLE() pure returns (ObjectType) {
-    return toObjectType(20);
+function REGISTRY() pure returns (ObjectType) {
+    return ObjectType.wrap(2);
 }
 
-function TARGET() pure returns (ObjectType) {
-    return toObjectType(30);
+function STAKING() pure returns (ObjectType) {
+    return ObjectType.wrap(3);
 }
 
-function REGISTRY() pure returns (ObjectType) {
-    return toObjectType(40);
+function TOKEN() pure returns (ObjectType) {
+    return ObjectType.wrap(6);
 }
 
-function STAKING() pure returns (ObjectType) {
-    return toObjectType(45);
+function RELEASE() pure returns (ObjectType) {
+    return ObjectType.wrap(7);
 }
 
-function TOKEN() pure returns (ObjectType) {
-    return toObjectType(50);
+function ROLE() pure returns (ObjectType) {
+    return ObjectType.wrap(8);
 }
 
 function SERVICE() pure returns (ObjectType) {
-    return toObjectType(60);
+    return ObjectType.wrap(9);
 }
 
 function INSTANCE() pure returns (ObjectType) {
-    return toObjectType(70);
+    return ObjectType.wrap(10);
 }
 
-function STAKE() pure returns (ObjectType) {
-    return toObjectType(80);
+function COMPONENT() pure returns (ObjectType) {
+    return ObjectType.wrap(11);
 }
 
-function COMPONENT() pure returns (ObjectType) {
-    return toObjectType(100);
+function PRODUCT() pure returns (ObjectType) {
+    return ObjectType.wrap(12);
 }
 
-function PRODUCT_SETUP() pure returns (ObjectType) {
-    return toObjectType(101);
+function ORACLE() pure returns (ObjectType) {
+    return ObjectType.wrap(13);
 }
 
-function REQUEST() pure returns (ObjectType) {
-    return toObjectType(105);
+function DISTRIBUTION() pure returns (ObjectType) {
+    return ObjectType.wrap(14);
 }
 
-function PRODUCT() pure returns (ObjectType) {
-    return toObjectType(110);
+function POOL() pure returns (ObjectType) {
+    return ObjectType.wrap(15);
 }
 
-function DISTRIBUTION() pure returns (ObjectType) {
-    return toObjectType(120);
+function APPLICATION() pure returns (ObjectType) {
+    return ObjectType.wrap(20);
 }
 
-function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
-    return toObjectType(121);
+function POLICY() pure returns (ObjectType) {
+    return ObjectType.wrap(21);
 }
 
-function DISTRIBUTOR() pure returns (ObjectType) {
-    return toObjectType(122);
+function CLAIM() pure returns (ObjectType) {
+    return ObjectType.wrap(22);
 }
 
-function REFERRAL() pure returns (ObjectType) {
-    return toObjectType(123);
+function PAYOUT() pure returns (ObjectType) {
+    return ObjectType.wrap(23); 
 }
 
-function ORACLE() pure returns (ObjectType) {
-    return toObjectType(130);
+function RISK() pure returns (ObjectType) {
+    return ObjectType.wrap(24);
 }
 
-function POOL() pure returns (ObjectType) {
-    return toObjectType(140);
+function PRICE() pure returns (ObjectType) {
+    return ObjectType.wrap(25);
 }
 
-function BUNDLE() pure returns (ObjectType) {
-    return toObjectType(220);
+function REQUEST() pure returns (ObjectType) {
+    return ObjectType.wrap(26);
 }
 
-function RISK() pure returns (ObjectType) {
-    return toObjectType(200);
+function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
+    return ObjectType.wrap(27);
 }
 
-function APPLICATION() pure returns (ObjectType) {
-    return toObjectType(210);
+function DISTRIBUTOR() pure returns (ObjectType) {
+    return ObjectType.wrap(28);
 }
 
-function POLICY() pure returns (ObjectType) {
-    return toObjectType(211);
+function REFERRAL() pure returns (ObjectType) {
+    return ObjectType.wrap(29);
 }
 
-function CLAIM() pure returns (ObjectType) {
-    return toObjectType(212);
+function BUNDLE() pure returns (ObjectType) {
+    return ObjectType.wrap(30);
 }
 
-function PAYOUT() pure returns (ObjectType) {
-    return toObjectType(213); 
+function TARGET() pure returns (ObjectType) {
+    return ObjectType.wrap(31);
 }
 
-function PRICE() pure returns (ObjectType) {
-    return toObjectType(230);
+function STAKE() pure returns (ObjectType) {
+    return ObjectType.wrap(32);
 }
 
-/// @dev Converts the uint8 to a ObjectType.
-function toObjectType(uint256 objectType) pure returns (ObjectType) {
-    return ObjectType.wrap(uint8(objectType));
+/// @dev Object type that includes any other object type.
+/// Note that eq()/'==' does not take this property into account.
+function ALL() pure returns (ObjectType) {
+    return ObjectType.wrap(99);
 }
 
-// pure free functions for operators
+// other pure free functions for operators
 function eqObjectType(ObjectType a, ObjectType b) pure returns (bool isSame) {
     return ObjectType.unwrap(a) == ObjectType.unwrap(b);
 }
 
-function neObjectType(
-    ObjectType a,
-    ObjectType b
-) pure returns (bool isDifferent) {
+function neObjectType(ObjectType a, ObjectType b) pure returns (bool isSame) {
     return ObjectType.unwrap(a) != ObjectType.unwrap(b);
 }
 
@@ -146,6 +141,11 @@ library ObjectTypeLib {
         return ObjectType.wrap(0);
     }
 
+    /// @dev Converts the uint256 into ObjectType.
+    function toObjectType(uint256 objectType) public pure returns (ObjectType) {
+        return ObjectType.wrap(uint8(objectType));
+    }
+
     /// @dev Converts the NftId to a uint256.
     function toInt(ObjectType objectType) public pure returns (uint96) {
         return uint96(ObjectType.unwrap(objectType));
@@ -163,6 +163,79 @@ library ObjectTypeLib {
 
     /// @dev Returns true if the values are equal (==).
     function eq(ObjectType a, ObjectType b) public pure returns (bool isSame) {
-        return eqObjectType(a, b);
+        return ObjectType.unwrap(a) == ObjectType.unwrap(b);
+    }
+
+    /// @dev Returns true if the values are not equal (!=).
+    function ne(ObjectType a, ObjectType b) public pure returns (bool isSame) {
+        return ObjectType.unwrap(a) != ObjectType.unwrap(b);
+    }
+
+    /// @dev Returns the type/domain name for the provided object type
+    function toName(ObjectType objectType) public pure returns (string memory name) {
+        if (objectType == REGISTRY()) {
+            return "Registry";
+        } else if (objectType == STAKING()) {
+            return "Staking";
+        } else if (objectType == INSTANCE()) {
+            return "Instance";
+        } else if (objectType == COMPONENT()) {
+            return "Component";
+        } else if (objectType == PRODUCT()) {
+            return "Product";
+        } else if (objectType == ORACLE()) {
+            return "Oracle";
+        } else if (objectType == DISTRIBUTION()) {
+            return "Distribution";
+        } else if (objectType == POOL()) {
+            return "Pool";
+        } else if (objectType == APPLICATION()) {
+            return "Application";
+        } else if (objectType == POLICY()) {
+            return "Policy";
+        } else if (objectType == CLAIM()) {
+            return "Claim";
+        } else if (objectType == PRICE()) {
+            return "Price";
+        } else if (objectType == BUNDLE()) {
+            return "Bundle";
+        }
+
+        // fallback: ObjectType<obect-type-int>
+        return string(
+            abi.encodePacked(
+                "ObjectType",
+                toString(
+                    toInt(objectType))));
+    }
+
+    /// @dev returns the provied int as a string
+    function toString(uint256 value) public pure returns (string memory name) {
+
+        if (value == 0) {
+            return "0";
+        }
+
+        uint256 temp = value;
+        uint256 digits = 0;
+        while (temp != 0) {
+            digits++;
+            temp /= 10;
+        }
+
+        bytes memory buffer = new bytes(digits);
+        uint index = digits - 1;
+
+        temp = value;
+        while (temp != 0) {
+            buffer[index] = bytes1(uint8(48 + temp % 10));
+            temp /= 10;
+
+            if (index > 0) {
+                index--;
+            }
+        }
+
+        return string(buffer);
     }
 }

package/contracts/type/RoleId.sol

@@ -2,7 +2,8 @@
 pragma solidity ^0.8.20;
 
 import {Key32, KeyId, Key32Lib} from "./Key32.sol";
-import {ROLE} from "./ObjectType.sol";
+import {ObjectType, ROLE} from "./ObjectType.sol";
+import {VersionPart} from "./Version.sol";
 
 type RoleId is uint64;
 
@@ -12,51 +13,85 @@ using {
     neRoleId as !=,
     RoleIdLib.eqz,
     RoleIdLib.gtz,
-    RoleIdLib.toInt,
-    RoleIdLib.toKey32
+    RoleIdLib.toInt
+    // RoleIdLib.toKey32
 } for RoleId global;
 
+// general pure free functions
+
+//--- OpenZeppelin provided roles -------------------------------------------//
 
-/// @dev role id needs to match with oz AccessManager.ADMIN_ROLE
+/// @dev Role ID needs to match with oz AccessManager.ADMIN_ROLE
 function ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(type(uint64).min); }
 
-/// @dev role id needs to match with oz AccessManager.PUBLIC_ROLE
+/// @dev Role ID needs to match with oz AccessManager.PUBLIC_ROLE
 function PUBLIC_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(type(uint64).max); }
 
-// general pure free functions
+/// @dev Default access admin (registry admin, instance admin) role with rights to manage roles
+function MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1); } 
+
+//--- Core GIF roles (range: 1-99) ------------------------------------------//
 
 /// @dev cental role for gif release management.
 /// this role is necessary to call ReleaseManager.createNextRelease/activateNextRelease
 /// the actual deployment of a release requires the GIF_MANAGER_ROLE.
 /// GIF_ADMIN_ROLE is the admin of the GIF_MANAGER_ROLE.
 /// only a single holder may hold this role at any time
-function GIF_ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1500); } 
+function GIF_ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2); } 
 
 /// @dev role for token whith/blacklisting, deploying and registering the services for a new major release
 /// registering services for a new major release is only possible after a new initial release has been created by the GIF_ADMIN_ROLE
 /// token white/blacklisting is possible for any active release
-function GIF_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1600); } 
+function GIF_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(3); } 
 
-/// @dev instance specific role to register/own a distribution component
-function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2); }
+/// @dev role for registering remote staking targets and reporting remote total value locked amounts.
+function GIF_REMOTE_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(4); } 
+
+/// @dev required role to own an instance.
+/// Role is granted by instance service when cloning a new instance.
+/// allows instance specific target, role and access management 
+function INSTANCE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10); }
+
+/// @dev instance specific  role to register/own a product component
+function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(11); }
 
 /// @dev instance specific  role to register/own an oracle component
-function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(3); }
+function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(12); }
 
-/// @dev instance specific  role to register/own a pool component
-function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(4); }
+/// @dev instance specific role to register/own a distribution component
+function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(13); }
 
-/// @dev instance specific  role to register/own a product component
-function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(5); }
+/// @dev instance specific  role to register/own a pool component
+function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(14); }
+
+//--- GIF contract roles (range: 200 - 9900) --------------------------------//
+// created and assigned during initial deployment for registry and staking
+// granting for instances and components in instance service
+// object type * 100 + 0, examples:
+// - registry contract role: 200 
+// - staking contract role: 300 
+// - instance contract role: 1000
+// - product contract role: 1200
+
+//--- GIF service roles (range 201 - 99xx) ----------------------------------//
+// created and assigned by release manager contract
+// object type * 100 + 1/major version, examples:
+// - registry service role (any version): 201
+// - registry service role (version 3): 203
+// - registry service role (any version): 301
+// - staking service role: (version 3): 303
+// - application service role (version 3): 2003
+
+//--- Custom roles (range > 10000) ------------------------------------------//
+
+/// @dev role associated with the staking contract
+/// this role is the admin role for the INSTANCE_OWNER_ROLE
+function STAKING_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1313); }
 
 /// @dev role associated with an instance contract
 /// this role is the admin role for the INSTANCE_OWNER_ROLE
 function INSTANCE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2600); }
 
-/// @dev required role to register/own an instance
-/// allows instance specific target, role and access management 
-function INSTANCE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1900); }
-
 function REGISTRY_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1800); }
 
 /// @dev instance specific role for instance service
@@ -124,6 +159,26 @@ library RoleIdLib {
         return uint64(RoleId.unwrap(a));
     }
 
+    /// @dev Converts an uint into a RoleId.
+    /// Used for GIF core contracts.
+    function roleForType(ObjectType objectType) public pure returns (RoleId) {
+        return RoleId.wrap(100 * uint64(objectType.toInt()));
+    }
+
+    /// @dev Converts an uint into a RoleId.
+    /// Used for GIF core contracts.
+    function roleForTypeAndVersion(ObjectType objectType, VersionPart majorVersion) public pure returns (RoleId) {
+        return RoleId.wrap(
+            uint64(100 * objectType.toInt() + majorVersion.toInt()));
+    }
+
+    /// @dev Converts an uint into a RoleId.
+    /// Used for GIF core contracts.
+    function roleForTypeAndAllVersions(ObjectType objectType) public pure returns (RoleId) {
+        return RoleId.wrap(
+            uint64(100 * objectType.toInt() + 99));
+    }
+
     /// @dev Returns true if the value is non-zero (> 0).
     function gtz(RoleId a) public pure returns (bool) {
         return RoleId.unwrap(a) > 0;