LST Rewards Splitter
The LSTRewardsSplitter
enables an account to deposit LSTs and split any earned rewards between itself and other addresses.
View Functions
controller
Returns the address of the controller contract
Return Values
Name | Type | Description |
---|---|---|
controller | address | address of LSTRewardsSplitterController |
lst
Returns the address of the liquid staking token handled by this contract
Return Values
Name | Type | Description |
---|---|---|
lst | address | address of LST |
principalDeposits
Returns the total number of tokens deposited without rewards
Return Values
Name | Type | Description |
---|---|---|
principalDeposits | uint256 | total principal deposits |
checkUpkeep
Returns whether a call should be made to performUpkeep to split new rewards
Return Values
Name | Type | Description |
---|---|---|
upkeepNeeded | bool | true if performUpkeep should be called, false otherwise |
bytes |
getFees
Returns a list of all fees
Return Values
Name | Type | Description |
---|---|---|
fees | struct LSTRewardsSplitter.Fee[] | list of fees |
Write Functions
deposit
Deposits tokens
Parameters
Name | Type | Description |
---|---|---|
_amount | uint256 | amount to deposit |
withdraw
Withdraws tokens
Parameters
Name | Type | Description |
---|---|---|
_amount | uint256 | amount to withdraw |
_receiver | address | address to receive tokens |
performUpkeep
Splits new rewards between fee receivers
splitRewards
Splits new rewards between fee receivers
Bypasses rewardThreshold
addFee
Adds a new fee
Parameters
Name | Type | Description |
---|---|---|
_receiver | address | receiver of fee |
_feeBasisPoints | uint256 | fee in basis points |
updateFee
Updates an existing fee
Parameters
Name | Type | Description |
---|---|---|
_index | uint256 | index of fee |
_receiver | address | receiver of fee |
_feeBasisPoints | uint256 | fee in basis points |
Last updated