IAutopoolMainRewarder
Interface for Tokemak's AutopoolMainRewarder contract
Used to stake autopool vault tokens and claim rewards
Functions
stake
Stakes autopool tokens for a given account
function stake(address account, uint256 amount) external;
Parameters
| Name | Type | Description |
|---|---|---|
account | address | The account to stake for |
amount | uint256 | The amount of autopool tokens to stake |
withdraw
Withdraws staked autopool tokens
function withdraw(address account, uint256 amount, bool claim) external;
Parameters
| Name | Type | Description |
|---|---|---|
account | address | The account to withdraw for |
amount | uint256 | The amount to withdraw |
claim | bool | Whether to claim rewards |
getReward
Claims rewards for an account
function getReward(address account, address recipient, bool claimExtras) external;
Parameters
| Name | Type | Description |
|---|---|---|
account | address | The account to claim for |
recipient | address | The recipient of the rewards |
claimExtras | bool | Whether to claim extra rewards |
balanceOf
Returns the balance of staked tokens for an account
function balanceOf(address account) external view returns (uint256);
Parameters
| Name | Type | Description |
|---|---|---|
account | address | The account to check |
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | The staked balance |
earned
Returns the amount of earned rewards for an account
function earned(address account) external view returns (uint256);
Parameters
| Name | Type | Description |
|---|---|---|
account | address | The account to check |
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | The earned rewards |
rewardToken
Returns the main reward token address
function rewardToken() external view returns (address);
Returns
| Name | Type | Description |
|---|---|---|
<none> | address | The reward token address |
stakingToken
Returns the staking token (autopool vault token)
function stakingToken() external view returns (address);
Returns
| Name | Type | Description |
|---|---|---|
<none> | address | The staking token address |
extraRewardsLength
Returns the number of extra reward contracts
function extraRewardsLength() external view returns (uint256);
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | The count of extra rewards |
extraRewards
Returns an extra reward contract at index
function extraRewards(uint256 index) external view returns (address);
Parameters
| Name | Type | Description |
|---|---|---|
index | uint256 | The index of the extra reward |
Returns
| Name | Type | Description |
|---|---|---|
<none> | address | The extra reward contract address |