Skip to main content

IStakingRewards.sol

Methods​

claimPendingRewards(uint256)​

Solidity

function claimPendingRewards(uint256 poolId) external nonpayable

Parameters​

NameTypeDescription
poolIduint256undefined

createPool(address,address,uint256,uint256,uint256)​

Solidity

function createPool(address stakingToken, address rewardToken, uint256 rewardRate, uint256 start, uint256 end) external nonpayable

Parameters​

NameTypeDescription
stakingTokenaddressundefined
rewardTokenaddressundefined
rewardRateuint256undefined
startuint256undefined
enduint256undefined

depositRewards(uint256,uint256)​

Solidity

function depositRewards(uint256 poolId, uint256 amount) external nonpayable

Parameters​

NameTypeDescription
poolIduint256undefined
amountuint256undefined

getPool(uint256)​

Solidity

function getPool(uint256 poolId) external view returns (struct IStakingRewards.Pool pool)

Parameters​

NameTypeDescription
poolIduint256undefined

Returns​

NameTypeDescription
poolIStakingRewards.Poolundefined

getPools()​

Solidity

function getPools() external view returns (struct IStakingRewards.Pool[] pools, string[] symbols)

Returns​

NameTypeDescription
poolsIStakingRewards.Pool[]undefined
symbolsstring[]undefined

getRewardsForAPool(address,uint256)​

Solidity

function getRewardsForAPool(address account, uint256 poolId) external view returns (uint256)

Parameters​

NameTypeDescription
accountaddressundefined
poolIduint256undefined

Returns​

NameTypeDescription
_0uint256undefined

setJobState(uint256,bool)​

Solidity

function setJobState(uint256 poolId, bool pause) external nonpayable

Parameters​

NameTypeDescription
poolIduint256undefined
pauseboolundefined

stake(uint256,uint256)​

Solidity

function stake(uint256 amount, uint256 poolId) external nonpayable

Parameters​

NameTypeDescription
amountuint256undefined
poolIduint256undefined

stakeFor(address,uint256,uint256)​

Solidity

function stakeFor(address user, uint256 amount, uint256 poolId) external nonpayable

Parameters​

NameTypeDescription
useraddressundefined
amountuint256undefined
poolIduint256undefined

unstake(uint256)​

Solidity

function unstake(uint256 poolId) external nonpayable

Parameters​

NameTypeDescription
poolIduint256undefined

withdrawRewards(uint256,uint256,address)​

Solidity

function withdrawRewards(uint256 poolId, uint256 amount, address receiver) external nonpayable

Parameters​

NameTypeDescription
poolIduint256undefined
amountuint256undefined
receiveraddressundefined

Events​

RewardPaid​

Solidity

event RewardPaid(address indexed user, uint256 poolId, uint256 reward)

Parameters​

NameTypeDescription
user indexedaddressundefined
poolIduint256undefined
rewarduint256undefined

RewardsDeposited​

Solidity

event RewardsDeposited(address depositor, uint256 poolId, uint256 amount)

Parameters​

NameTypeDescription
depositoraddressundefined
poolIduint256undefined
amountuint256undefined

RewardsWithdrawn​

Solidity

event RewardsWithdrawn(uint256 amount, uint256 poolId)

Parameters​

NameTypeDescription
amountuint256undefined
poolIduint256undefined

Staked​

Solidity

event Staked(address indexed user, uint256 amount, uint256 poolId)

Parameters​

NameTypeDescription
user indexedaddressundefined
amountuint256undefined
poolIduint256undefined

Withdrawn​

Solidity

event Withdrawn(address indexed user, uint256 amount, uint256 poolId)

Parameters​

NameTypeDescription
user indexedaddressundefined
amountuint256undefined
poolIduint256undefined