Staking20Upgradeable
Methods
claimRewards
function claimRewards() external nonpayable
Claim accumulated rewards.
See {_claimRewards}. Override that to implement custom logic. See {_calculateRewards} for reward-calculation logic.
getRewardRatio
function getRewardRatio() external view returns (uint256 _numerator, uint256 _denominator)
Returns
| Name | Type | Description |
|---|
| _numerator | uint256 | undefined |
| _denominator | uint256 | undefined |
getRewardTokenBalance
function getRewardTokenBalance() external view returns (uint256 _rewardsAvailableInContract)
View total rewards available in the staking contract.
Returns
| Name | Type | Description |
|---|
| _rewardsAvailableInContract | uint256 | undefined |
getStakeInfo
function getStakeInfo(address _staker) external view returns (uint256 _tokensStaked, uint256 _rewards)
View amount staked and rewards for a user.
Parameters
| Name | Type | Description |
|---|
| _staker | address | Address for which to calculated rewards. |
Returns
| Name | Type | Description |
|---|
| _tokensStaked | uint256 | Amount of tokens staked. |
| _rewards | uint256 | Available reward amount. |
getTimeUnit
function getTimeUnit() external view returns (uint256 _timeUnit)
Returns
| Name | Type | Description |
|---|
| _timeUnit | uint256 | undefined |
rewardTokenDecimals
function rewardTokenDecimals() external view returns (uint256)
Decimals of reward token.
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
setRewardRatio
function setRewardRatio(uint256 _numerator, uint256 _denominator) external nonpayable
Set rewards per unit of time. Interpreted as (numerator/denominator) rewards per second/per day/etc based on time-unit. For e.g., ratio of 1/20 would mean 1 reward token for every 20 tokens staked.
Only admin/authorized-account can call it.
Parameters
| Name | Type | Description |
|---|
| _numerator | uint256 | Reward ratio numerator. |
| _denominator | uint256 | Reward ratio denominator. |
setTimeUnit
function setTimeUnit(uint256 _timeUnit) external nonpayable
Set time unit. Set as a number of seconds. Could be specified as -- x 1 hours, x 1 days, etc.
Only admin/authorized-account can call it.
Parameters
| Name | Type | Description |
|---|
| _timeUnit | uint256 | New time unit. |
stake
function stake(uint256 _amount) external payable
Stake ERC20 Tokens.
See {_stake}. Override that to implement custom logic.
Parameters
| Name | Type | Description |
|---|
| _amount | uint256 | Amount to stake. |
stakers
function stakers(address) external view returns (uint256 amountStaked, uint256 timeOfLastUpdate, uint256 unclaimedRewards, uint256 conditionIdOflastUpdate)
Mapping staker address to Staker struct. See {struct IStaking20.Staker}.
Parameters
| Name | Type | Description |
|---|
| _0 | address | undefined |
Returns
| Name | Type | Description |
|---|
| amountStaked | uint256 | undefined |
| timeOfLastUpdate | uint256 | undefined |
| unclaimedRewards | uint256 | undefined |
| conditionIdOflastUpdate | uint256 | undefined |
stakersArray
function stakersArray(uint256) external view returns (address)
List of accounts that have staked that token-id.
Parameters
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | address | undefined |
stakingToken
function stakingToken() external view returns (address)
Address of ERC20 contract -- staked tokens belong to this contract.
Returns
| Name | Type | Description |
|---|
| _0 | address | undefined |
stakingTokenBalance
function stakingTokenBalance() external view returns (uint256)
Total amount of tokens staked in the contract.
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
stakingTokenDecimals
function stakingTokenDecimals() external view returns (uint256)
Decimals of staking token.
Returns
| Name | Type | Description |
|---|
| _0 | uint256 | undefined |
withdraw
function withdraw(uint256 _amount) external nonpayable
Withdraw staked ERC20 tokens.
See {_withdraw}. Override that to implement custom logic.
Parameters
| Name | Type | Description |
|---|
| _amount | uint256 | Amount to withdraw. |
Events
Initialized
event Initialized(uint8 version)
Parameters
| Name | Type | Description |
|---|
| version | uint8 | undefined |
RewardsClaimed
event RewardsClaimed(address indexed staker, uint256 rewardAmount)
Parameters
| Name | Type | Description |
|---|
staker indexed | address | undefined |
| rewardAmount | uint256 | undefined |
TokensStaked
event TokensStaked(address indexed staker, uint256 amount)
Parameters
| Name | Type | Description |
|---|
staker indexed | address | undefined |
| amount | uint256 | undefined |
TokensWithdrawn
event TokensWithdrawn(address indexed staker, uint256 amount)
Parameters
| Name | Type | Description |
|---|
staker indexed | address | undefined |
| amount | uint256 | undefined |
UpdatedMinStakeAmount
event UpdatedMinStakeAmount(uint256 oldAmount, uint256 newAmount)
Parameters
| Name | Type | Description |
|---|
| oldAmount | uint256 | undefined |
| newAmount | uint256 | undefined |
UpdatedRewardRatio
event UpdatedRewardRatio(uint256 oldNumerator, uint256 newNumerator, uint256 oldDenominator, uint256 newDenominator)
Parameters
| Name | Type | Description |
|---|
| oldNumerator | uint256 | undefined |
| newNumerator | uint256 | undefined |
| oldDenominator | uint256 | undefined |
| newDenominator | uint256 | undefined |
UpdatedTimeUnit
event UpdatedTimeUnit(uint256 oldTimeUnit, uint256 newTimeUnit)
Parameters
| Name | Type | Description |
|---|
| oldTimeUnit | uint256 | undefined |
| newTimeUnit | uint256 | undefined |