Rewards Pool WSD
RewardsPoolWSD
RewardsPoolWSD
is similar to RewardsPool
but it handles a single rebasing token minted by a StakingPool
by wrapping the tokens when theyβre received for distribution and unwrapping them when a user claims their rewards.
View Functions
token
Returns the address of the rewards token this pool distributes
Return Values
Name | Type | Description |
---|---|---|
token | address | Address of rewards token |
wsdToken
Returns the address of the wrapped version of the token this pool distributes
Return Values
Name | Type | Description |
---|---|---|
wrappedToken | address | Address of wrapped rewards token |
withdrawableRewards
Returns an account's total unwrapped unclaimed rewards
Parameters
Name | Type | Description |
---|---|---|
_account | address | Address of account |
Return Values
Name | Type | Description |
---|---|---|
rewards | uint256 | Total unclaimed rewards (unwrapped) |
withdrawableRewardsWrapped
Returns an account's total wrapped unclaimed rewards
Parameters
Name | Type | Description |
---|---|---|
_account | address | Address of account |
Return Values
Name | Type | Description |
---|---|---|
rewards | uint256 | Total unclaimed rewards (wrapped) |
Write Functions
withdraw
Withdraws the sender's unclaimed rewards
withdraw
Withdraws an account's unclaimed rewards
Parameters
Name | Type | Description |
---|---|---|
_account | address | Account to withdraw for |
onTokenTransfer
ERC677 implementation that receives rewards and distributes them
distributeRewards
Distributes new rewards that have been deposited
updateReward
Updates an account's principal reward balance
Parameters
Name | Type | Description |
---|---|---|
_account | address | Address of account |
Last updated