Base contract for ERC1155 staking (#283)

base contract for ERC1155 staking

Author: kumaryash90

contracts/base/Staking1155Base.sol

@@ -0,0 +1,95 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+import "../extension/ContractMetadata.sol";
+import "../extension/Multicall.sol";
+import "../extension/Ownable.sol";
+import "../extension/Staking1155.sol";
+
+import "../eip/interface/IERC20.sol";
+
+/**
+ *      note: This is a Beta release.
+ *
+ *  EXTENSION: Staking1155
+ *
+ *  The `Staking1155Base` smart contract implements NFT staking mechanism.
+ *  Allows users to stake their ERC-1155 NFTs and earn rewards in form of ERC-20 tokens.
+ *
+ *  Following features and implementation setup must be noted:
+ *
+ *      - ERC-1155 NFTs from only one collection can be staked.
+ *
+ *      - Contract admin can choose to give out rewards by either transferring or minting the rewardToken,
+ *        which is an ERC20 token. See {_mintRewards}.
+ *
+ *      - To implement custom logic for staking, reward calculation, etc. corresponding functions can be
+ *        overridden from the extension `Staking1155`.
+ *
+ *      - Ownership of the contract, with the ability to restrict certain functions to
+ *        only be called by the contract's owner.
+ *
+ *      - Multicall capability to perform multiple actions atomically.
+ *
+ */
+contract Staking1155Base is ContractMetadata, Multicall, Ownable, Staking1155 {
+    /// @dev ERC20 Reward Token address. See {_mintRewards} below.
+    address public rewardToken;
+
+    constructor(
+        uint256 _defaultTimeUnit,
+        uint256 _defaultRewardsPerUnitTime,
+        address _edition,
+        address _rewardToken
+    ) Staking1155(_edition) {
+        _setupOwner(msg.sender);
+        _setDefaultTimeUnit(_defaultTimeUnit);
+        _setDefaultRewardsPerUnitTime(_defaultRewardsPerUnitTime);
+
+        rewardToken = _rewardToken;
+    }
+
+    /*//////////////////////////////////////////////////////////////
+                        Minting logic
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @dev    Mint ERC20 rewards to the staker. Must override.
+     *
+     *  @param _staker    Address for which to calculated rewards.
+     *  @param _rewards   Amount of tokens to be given out as reward.
+     *
+     */
+    function _mintRewards(address _staker, uint256 _rewards) internal override {
+        // Mint or transfer reward-tokens here.
+        // e.g.
+        //
+        // IERC20(rewardToken).transfer(_staker, _rewards);
+        //
+        // OR
+        //
+        // Use a mintable ERC20, such as thirdweb's `TokenERC20.sol`
+        //
+        // TokenERC20(rewardToken).mintTo(_staker, _rewards);
+        // note: The staking contract should have minter role to mint tokens.
+    }
+
+    /*//////////////////////////////////////////////////////////////
+                        Other Internal functions
+    //////////////////////////////////////////////////////////////*/
+
+    /// @dev Returns whether staking restrictions can be set in given execution context.
+    function _canSetStakeConditions() internal view override returns (bool) {
+        return msg.sender == owner();
+    }
+
+    /// @dev Returns whether contract metadata can be set in the given execution context.
+    function _canSetContractURI() internal view virtual override returns (bool) {
+        return msg.sender == owner();
+    }
+
+    /// @dev Returns whether owner can be set in the given execution context.
+    function _canSetOwner() internal view virtual override returns (bool) {
+        return msg.sender == owner();
+    }
+}