EcdPtpRewardPool

Functions

totalSupply

  function totalSupply(
  ) public returns (uint256)

The sum of all the staked tokens

Return Values:

Name	Type	Description
_totalSupply		The total supply

balanceOf

  function balanceOf(
  ) public returns (uint256)

Balance of staked tokens for a user

Return Values:

Name	Type	Description
Balance	address	of the user

extraRewardsLength

  function extraRewardsLength(
  ) external returns (uint256)

Get the number of extraRewards

Return Values:

Name	Type	Description
the		extraRewards length

setEmissionRate

  function setEmissionRate(
    uint256 _emissionRate
  ) external

Queue a new emission rate

Parameters:

Name	Type	Description
_emissionRate	uint256	new emission rate

commitEmissionRate

  function commitEmissionRate(
  ) external

Commit emission rate.

addExtraReward

  function addExtraReward(
  ) external returns (bool)

Add an extraReward to the extraRewards list @param _reward The address of the reward pool.

clearExtraRewards

  function clearExtraRewards(
  ) external

Remove the list of extraRewards.

lastTimeRewardApplicable

  function lastTimeRewardApplicable(
  ) public returns (uint256)

Returns the timestamp to conside for reward distribution.

Return Values:

Name	Type	Description
a		timestamp

rewardPerToken

  function rewardPerToken(
  ) public returns (uint256)

Returns the amount of rewards per staked token.

Return Values:

Name	Type	Description
amount		of rewards

earned

  function earned(
    address account
  ) public returns (uint256)

Get the aount of tokens earned by an account

Parameters:

Name	Type	Description
account	address	that staked tokens

Return Values:

Name	Type	Description
amount	address	of rewards

stake

  function stake(
  ) public returns (bool)

Stake tokens into the reward pool @param _amount amount of tokens to stake

stakeAll

  function stakeAll(
  ) external returns (bool)

Stake all tokens into the reward pool.

stake the total balance up to the allowance.

stakeFor

  function stakeFor(
    address _for,
    uint256 _amount
  ) external returns (bool)

Stake for for a user that's not the sender.

tokens are transfered from msg.sender but balance is increased for _for.

Parameters:

Name	Type	Description
_for	address	token will be staked for this account
_amount	uint256	the amount of token to stake

withdraw

  function withdraw(
    uint256 amount,
    bool claim
  ) external returns (bool)

Unstake tokens from the pool

Before unstaking the rewards for the account are updated

Parameters:

Name	Type	Description
amount	uint256	amount of tokens to withdraw
claim	bool	claim the rewards

getReward

  function getReward(
    address _account,
    bool _claimExtras
  ) public returns (bool)

Get rewards

Parameters:

Name	Type	Description
_account	address	account to get rewards for
_claimExtras	bool	claim extra rewards

getReward

  function getReward(
  ) external returns (bool)

Get rewards for msg.sender and claim extra rewards

donate

  function donate(
  ) external returns (bool)

Donate rewardToken to the pool @dev they will added to the queuedRewards and distribution will start once queueNewRewards is called. @param _amount amount of tokens to donate

queueNewRewards

  function queueNewRewards(
  ) external returns (bool)

Add some more rewards in to the pool @dev funds should be transfered before queueNewRewards is called @param _rewards amount of tokens to add to rewards

Events