docs

Author: kumaryash90

docs/EditionStake.md

@@ -766,6 +766,22 @@ Withdraw staked tokens.
 | _tokenId | uint256 | ERC1155 token-id to withdraw. |
 | _amount | uint256 | Amount to withdraw. |
 
+### withdrawRewardTokens
+
+```solidity
+function withdrawRewardTokens(uint256 _amount) external nonpayable
+```
+
+
+
+*Admin can withdraw excess reward tokens.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _amount | uint256 | undefined |
+
 
 
 ## Events

docs/IStaking20.md

@@ -0,0 +1,188 @@
+# IStaking20
+
+
+
+
+
+
+
+
+
+## Methods
+
+### claimRewards
+
+```solidity
+function claimRewards() external nonpayable
+```
+
+Claim accumulated rewards.
+
+
+
+
+### getStakeInfo
+
+```solidity
+function getStakeInfo(address staker) external view returns (uint256 _tokensStaked, uint256 _rewards)
+```
+
+View amount staked and total rewards for a user.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| staker | address | Address for which to calculated rewards. |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _tokensStaked | uint256 | undefined |
+| _rewards | uint256 | undefined |
+
+### stake
+
+```solidity
+function stake(uint256 amount) external nonpayable
+```
+
+Stake ERC721 Tokens.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| amount | uint256 | Amount to stake. |
+
+### withdraw
+
+```solidity
+function withdraw(uint256 amount) external nonpayable
+```
+
+Withdraw staked tokens.
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| amount | uint256 | Amount to withdraw. |
+
+
+
+## Events
+
+### RewardsClaimed
+
+```solidity
+event RewardsClaimed(address indexed staker, uint256 rewardAmount)
+```
+
+
+
+*Emitted when a staker claims staking rewards.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| staker `indexed` | address | undefined |
+| rewardAmount  | uint256 | undefined |
+
+### TokensStaked
+
+```solidity
+event TokensStaked(address indexed staker, uint256 amount)
+```
+
+
+
+*Emitted when tokens are staked.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| staker `indexed` | address | undefined |
+| amount  | uint256 | undefined |
+
+### TokensWithdrawn
+
+```solidity
+event TokensWithdrawn(address indexed staker, uint256 amount)
+```
+
+
+
+*Emitted when a tokens are withdrawn.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| staker `indexed` | address | undefined |
+| amount  | uint256 | undefined |
+
+### UpdatedMinStakeAmount
+
+```solidity
+event UpdatedMinStakeAmount(uint256 oldAmount, uint256 newAmount)
+```
+
+
+
+*Emitted when contract admin updates minimum staking amount.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| oldAmount  | uint256 | undefined |
+| newAmount  | uint256 | undefined |
+
+### UpdatedRewardRatio
+
+```solidity
+event UpdatedRewardRatio(uint256 oldNumerator, uint256 newNumerator, uint256 oldDenominator, uint256 newDenominator)
+```
+
+
+
+*Emitted when contract admin updates rewardsPerUnitTime.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| oldNumerator  | uint256 | undefined |
+| newNumerator  | uint256 | undefined |
+| oldDenominator  | uint256 | undefined |
+| newDenominator  | uint256 | undefined |
+
+### UpdatedTimeUnit
+
+```solidity
+event UpdatedTimeUnit(uint256 oldTimeUnit, uint256 newTimeUnit)
+```
+
+
+
+*Emitted when contract admin updates timeUnit.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| oldTimeUnit  | uint256 | undefined |
+| newTimeUnit  | uint256 | undefined |
+
+
+

docs/IStaking.md docs/IStaking721.md

@@ -1,4 +1,4 @@
-# IStaking
+# IStaking721
 
 
 

docs/NFTStake.md

@@ -649,6 +649,22 @@ Withdraw staked tokens.
 |---|---|---|
 | _tokenIds | uint256[] | List of tokens to withdraw. |
 
+### withdrawRewardTokens
+
+```solidity
+function withdrawRewardTokens(uint256 _amount) external nonpayable
+```
+
+
+
+*Admin can withdraw excess reward tokens.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _amount | uint256 | undefined |
+
 
 
 ## Events