Staking updates (#298)

* more efficient way of storing state for Staking contracts

* [M-1] Block gas limit can be exceeded during setTimeUnit() and setRewardsPerUnit() when staker count grows

* [C-1] Contract admins can lock staked tokens in the contract

* [M-1] revised fix for Staking1155

* [H-1] TokenStake.sol rewards can be over- or under-awarded when the staking and reward tokens have different decimals

* [M-2] ERC721 and ERC1155 tokens safe-transferred directly to contract will be locked and unrecoverable

* [C-1] revised fix for large rewardsPerUnitTime

* [L-1] Incorrect ERC165 implementation for NFTStake and EditionStake

* [Q-2] Normalize support for ERC2771 trusted forwarder

* [Q-3] Reentrancy init called twice

* [Q-5] unitTime and rewardsPerUnitTime setter functions don’t check for new input data

* [Q-6] getStakeInfo should be marked as external

* [G-1] Halt array iteration after staker removed during withdraw()

* [G-2] Loop reading from storage array length

* [Q-7] Missing reward balance information

* [M-3] TokenStake.sol: Double entry-point ERC20 tokens could be drained from the staking contract

* [H-2] TokenStake.sol: Tokens with a tax on transfer will account for inaccurate amounts

* virtual functions for bases

* docs

* v3.2.9

* handle native token

* rename to stakingToken

* remove beta tag

* interfaces

Co-authored-by: Krishang <[email protected]>

Author: kumaryash90

contracts/base/Staking1155Base.sol

@@ -9,7 +9,6 @@ import "../extension/Staking1155.sol";
 import "../eip/interface/IERC20.sol";
 
 /**
- *      note: This is a Beta release.
  *
  *  EXTENSION: Staking1155
  *
@@ -39,9 +38,9 @@ contract Staking1155Base is ContractMetadata, Multicall, Ownable, Staking1155 {
     constructor(
         uint256 _defaultTimeUnit,
         uint256 _defaultRewardsPerUnitTime,
-        address _edition,
+        address _stakingToken,
         address _rewardToken
-    ) Staking1155(_edition) {
+    ) Staking1155(_stakingToken) {
         _setupOwner(msg.sender);
         _setDefaultStakingCondition(_defaultTimeUnit, _defaultRewardsPerUnitTime);
 

contracts/base/Staking20Base.sol

@@ -10,7 +10,6 @@ import "../eip/interface/IERC20.sol";
 import "../eip/interface/IERC20Metadata.sol";
 
 /**
- *      note: This is a Beta release.
  *
  *  EXTENSION: Staking20
  *
@@ -42,8 +41,16 @@ contract Staking20Base is ContractMetadata, Multicall, Ownable, Staking20 {
         uint256 _rewardRatioNumerator,
         uint256 _rewardRatioDenominator,
         address _stakingToken,
-        address _rewardToken
-    ) Staking20(_stakingToken, IERC20Metadata(_stakingToken).decimals(), IERC20Metadata(_rewardToken).decimals()) {
+        address _rewardToken,
+        address _nativeTokenWrapper
+    )
+        Staking20(
+            _nativeTokenWrapper,
+            _stakingToken,
+            IERC20Metadata(_stakingToken).decimals(),
+            IERC20Metadata(_rewardToken).decimals()
+        )
+    {
         _setupOwner(msg.sender);
         _setStakingCondition(_timeUnit, _rewardRatioNumerator, _rewardRatioDenominator);
 

contracts/base/Staking721Base.sol

@@ -9,7 +9,6 @@ import "../extension/Staking721.sol";
 import "../eip/interface/IERC20.sol";
 
 /**
- *      note: This is a Beta release.
  *
  *  EXTENSION: Staking721
  *
@@ -39,9 +38,9 @@ contract Staking721Base is ContractMetadata, Multicall, Ownable, Staking721 {
     constructor(
         uint128 _timeUnit,
         uint128 _rewardsPerUnitTime,
-        address _nftCollection,
+        address _stakingToken,
         address _rewardToken
-    ) Staking721(_nftCollection) {
+    ) Staking721(_stakingToken) {
         _setupOwner(msg.sender);
         _setStakingCondition(_timeUnit, _rewardsPerUnitTime);
 

contracts/extension/Staking1155.sol

@@ -7,17 +7,13 @@ import "../eip/interface/IERC1155.sol";
 
 import "./interface/IStaking1155.sol";
 
-/**
- *      note: This is a Beta release.
- */
-
 abstract contract Staking1155 is ReentrancyGuard, IStaking1155 {
     /*///////////////////////////////////////////////////////////////
                             State variables / Mappings
     //////////////////////////////////////////////////////////////*/
 
     ///@dev Address of ERC1155 contract -- staked tokens belong to this contract.
-    address public edition;
+    address public stakingToken;
 
     /// @dev Flag to check direct transfers of staking tokens.
     uint8 internal isStaking = 1;
@@ -46,9 +42,9 @@ abstract contract Staking1155 is ReentrancyGuard, IStaking1155 {
     /// @dev Mapping from token-id to list of accounts that have staked that token-id.
     mapping(uint256 => address[]) public stakersArray;
 
-    constructor(address _edition) ReentrancyGuard() {
-        require(address(_edition) != address(0), "address 0");
-        edition = _edition;
+    constructor(address _stakingToken) ReentrancyGuard() {
+        require(address(_stakingToken) != address(0), "address 0");
+        stakingToken = _stakingToken;
     }
 
     /*///////////////////////////////////////////////////////////////
@@ -270,7 +266,7 @@ abstract contract Staking1155 is ReentrancyGuard, IStaking1155 {
     /// @dev Staking logic. Override to add custom logic.
     function _stake(uint256 _tokenId, uint256 _amount) internal virtual {
         require(_amount != 0, "Staking 0 tokens");
-        address _edition = edition;
+        address _stakingToken = stakingToken;
 
         if (stakers[_tokenId][_stakeMsgSender()].amountStaked > 0) {
             _updateUnclaimedRewardsForStaker(_tokenId, _stakeMsgSender());
@@ -285,12 +281,12 @@ abstract contract Staking1155 is ReentrancyGuard, IStaking1155 {
         }
 
         require(
-            IERC1155(_edition).balanceOf(_stakeMsgSender(), _tokenId) >= _amount &&
-                IERC1155(_edition).isApprovedForAll(_stakeMsgSender(), address(this)),
+            IERC1155(_stakingToken).balanceOf(_stakeMsgSender(), _tokenId) >= _amount &&
+                IERC1155(_stakingToken).isApprovedForAll(_stakeMsgSender(), address(this)),
             "Not balance or approved"
         );
         isStaking = 2;
-        IERC1155(_edition).safeTransferFrom(_stakeMsgSender(), address(this), _tokenId, _amount, "");
+        IERC1155(_stakingToken).safeTransferFrom(_stakeMsgSender(), address(this), _tokenId, _amount, "");
         isStaking = 1;
         // stakerAddress[_tokenIds[i]] = _stakeMsgSender();
         stakers[_tokenId][_stakeMsgSender()].amountStaked += _amount;
@@ -323,7 +319,7 @@ abstract contract Staking1155 is ReentrancyGuard, IStaking1155 {
         }
         stakers[_tokenId][_stakeMsgSender()].amountStaked -= _amount;
 
-        IERC1155(edition).safeTransferFrom(address(this), _stakeMsgSender(), _tokenId, _amount, "");
+        IERC1155(stakingToken).safeTransferFrom(address(this), _stakeMsgSender(), _tokenId, _amount, "");
 
         emit TokensWithdrawn(_stakeMsgSender(), _tokenId, _amount);
     }

contracts/extension/Staking1155Upgradeable.sol

@@ -7,17 +7,13 @@ import "../eip/interface/IERC1155.sol";
 
 import "./interface/IStaking1155.sol";
 
-/**
- *      note: This is a Beta release.
- */
-
 abstract contract Staking1155Upgradeable is ReentrancyGuardUpgradeable, IStaking1155 {
     /*///////////////////////////////////////////////////////////////
                             State variables / Mappings
     //////////////////////////////////////////////////////////////*/
 
     ///@dev Address of ERC1155 contract -- staked tokens belong to this contract.
-    address public edition;
+    address public stakingToken;
 
     /// @dev Flag to check direct transfers of staking tokens.
     uint8 internal isStaking = 1;
@@ -46,11 +42,11 @@ abstract contract Staking1155Upgradeable is ReentrancyGuardUpgradeable, IStaking
     /// @dev Mapping from token-id to list of accounts that have staked that token-id.
     mapping(uint256 => address[]) public stakersArray;
 
-    function __Staking1155_init(address _edition) internal onlyInitializing {
+    function __Staking1155_init(address _stakingToken) internal onlyInitializing {
         __ReentrancyGuard_init();
 
-        require(address(_edition) != address(0), "address 0");
-        edition = _edition;
+        require(address(_stakingToken) != address(0), "address 0");
+        stakingToken = _stakingToken;
     }
 
     /*///////////////////////////////////////////////////////////////
@@ -272,7 +268,7 @@ abstract contract Staking1155Upgradeable is ReentrancyGuardUpgradeable, IStaking
     /// @dev Staking logic. Override to add custom logic.
     function _stake(uint256 _tokenId, uint256 _amount) internal virtual {
         require(_amount != 0, "Staking 0 tokens");
-        address _edition = edition;
+        address _stakingToken = stakingToken;
 
         if (stakers[_tokenId][_stakeMsgSender()].amountStaked > 0) {
             _updateUnclaimedRewardsForStaker(_tokenId, _stakeMsgSender());
@@ -287,12 +283,12 @@ abstract contract Staking1155Upgradeable is ReentrancyGuardUpgradeable, IStaking
         }
 
         require(
-            IERC1155(_edition).balanceOf(_stakeMsgSender(), _tokenId) >= _amount &&
-                IERC1155(_edition).isApprovedForAll(_stakeMsgSender(), address(this)),
+            IERC1155(_stakingToken).balanceOf(_stakeMsgSender(), _tokenId) >= _amount &&
+                IERC1155(_stakingToken).isApprovedForAll(_stakeMsgSender(), address(this)),
             "Not balance or approved"
         );
         isStaking = 2;
-        IERC1155(_edition).safeTransferFrom(_stakeMsgSender(), address(this), _tokenId, _amount, "");
+        IERC1155(_stakingToken).safeTransferFrom(_stakeMsgSender(), address(this), _tokenId, _amount, "");
         isStaking = 1;
         // stakerAddress[_tokenIds[i]] = _stakeMsgSender();
         stakers[_tokenId][_stakeMsgSender()].amountStaked += _amount;
@@ -325,7 +321,7 @@ abstract contract Staking1155Upgradeable is ReentrancyGuardUpgradeable, IStaking
         }
         stakers[_tokenId][_stakeMsgSender()].amountStaked -= _amount;
 
-        IERC1155(edition).safeTransferFrom(address(this), _stakeMsgSender(), _tokenId, _amount, "");
+        IERC1155(stakingToken).safeTransferFrom(address(this), _stakeMsgSender(), _tokenId, _amount, "");
 
         emit TokensWithdrawn(_stakeMsgSender(), _tokenId, _amount);
     }

contracts/extension/Staking20.sol

@@ -8,17 +8,16 @@ import "../lib/CurrencyTransferLib.sol";
 
 import "./interface/IStaking20.sol";
 
-/**
- *      note: This is a Beta release.
- */
-
 abstract contract Staking20 is ReentrancyGuard, IStaking20 {
     /*///////////////////////////////////////////////////////////////
                             State variables / Mappings
     //////////////////////////////////////////////////////////////*/
 
+    /// @dev The address of the native token wrapper contract.
+    address internal immutable nativeTokenWrapper;
+
     ///@dev Address of ERC20 contract -- staked tokens belong to this contract.
-    address public token;
+    address public stakingToken;
 
     /// @dev Decimals of staking token.
     uint256 public stakingTokenDecimals;
@@ -42,14 +41,16 @@ abstract contract Staking20 is ReentrancyGuard, IStaking20 {
     mapping(uint256 => StakingCondition) private stakingConditions;
 
     constructor(
-        address _token,
+        address _nativeTokenWrapper,
+        address _stakingToken,
         uint256 _stakingTokenDecimals,
         uint256 _rewardTokenDecimals
     ) ReentrancyGuard() {
-        require(address(_token) != address(0), "address 0");
+        require(_stakingToken != address(0) && _nativeTokenWrapper != address(0), "address 0");
         require(_stakingTokenDecimals != 0 && _rewardTokenDecimals != 0, "decimals 0");
 
-        token = _token;
+        nativeTokenWrapper = _nativeTokenWrapper;
+        stakingToken = _stakingToken;
         stakingTokenDecimals = _stakingTokenDecimals;
         rewardTokenDecimals = _rewardTokenDecimals;
     }
@@ -65,7 +66,7 @@ abstract contract Staking20 is ReentrancyGuard, IStaking20 {
      *
      *  @param _amount    Amount to stake.
      */
-    function stake(uint256 _amount) external nonReentrant {
+    function stake(uint256 _amount) external payable nonReentrant {
         _stake(_amount);
     }
 
@@ -170,7 +171,14 @@ abstract contract Staking20 is ReentrancyGuard, IStaking20 {
     /// @dev Staking logic. Override to add custom logic.
     function _stake(uint256 _amount) internal virtual {
         require(_amount != 0, "Staking 0 tokens");
-        address _token = token;
+
+        address _stakingToken;
+        if (stakingToken == CurrencyTransferLib.NATIVE_TOKEN) {
+            _stakingToken = nativeTokenWrapper;
+        } else {
+            require(msg.value == 0, "Value not 0");
+            _stakingToken = stakingToken;
+        }
 
         if (stakers[_stakeMsgSender()].amountStaked > 0) {
             _updateUnclaimedRewardsForStaker(_stakeMsgSender());
@@ -180,9 +188,15 @@ abstract contract Staking20 is ReentrancyGuard, IStaking20 {
             stakers[_stakeMsgSender()].conditionIdOflastUpdate = nextConditionId - 1;
         }
 
-        uint256 balanceBefore = IERC20(_token).balanceOf(address(this));
-        CurrencyTransferLib.transferCurrency(_token, _stakeMsgSender(), address(this), _amount);
-        uint256 actualAmount = IERC20(_token).balanceOf(address(this)) - balanceBefore;
+        uint256 balanceBefore = IERC20(_stakingToken).balanceOf(address(this));
+        CurrencyTransferLib.transferCurrencyWithWrapper(
+            stakingToken,
+            _stakeMsgSender(),
+            address(this),
+            _amount,
+            nativeTokenWrapper
+        );
+        uint256 actualAmount = IERC20(_stakingToken).balanceOf(address(this)) - balanceBefore;
 
         stakers[_stakeMsgSender()].amountStaked += actualAmount;
         stakingTokenBalance += actualAmount;
@@ -211,7 +225,13 @@ abstract contract Staking20 is ReentrancyGuard, IStaking20 {
         stakers[_stakeMsgSender()].amountStaked -= _amount;
         stakingTokenBalance -= _amount;
 
-        CurrencyTransferLib.transferCurrency(token, address(this), _stakeMsgSender(), _amount);
+        CurrencyTransferLib.transferCurrencyWithWrapper(
+            stakingToken,
+            address(this),
+            _stakeMsgSender(),
+            _amount,
+            nativeTokenWrapper
+        );
 
         emit TokensWithdrawn(_stakeMsgSender(), _amount);
     }