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

function controller() external view returns (address)

Return Values

Name	Type	Description
controller	address	address of LSTRewardsSplitterController

lst

Returns the address of the liquid staking token handled by this contract

function lst() external view returns (address)

Return Values

Name	Type	Description
lst	address	address of LST

principalDeposits

Returns the total number of tokens deposited without rewards

function stakingPool() external view returns (uint256)

Return Values

Name	Type	Description
principalDeposits	uint256	total principal deposits

checkUpkeep

Returns whether a call should be made to performUpkeep to split new rewards

function checkUpkeep(bytes) external view returns (bool, bytes)

Return Values

Name	Type	Description
upkeepNeeded	bool	true if performUpkeep should be called, false otherwise
	bytes

getFees

Returns a list of all fees

function getFees() external view returns (struct LSTRewardsSplitter.Fee[])

Return Values

Name	Type	Description
fees	struct LSTRewardsSplitter.Fee[]	list of fees

Write Functions

deposit

Deposits tokens

function deposit(uint256 _amount) external

Parameters

Name	Type	Description
_amount	uint256	amount to deposit

withdraw

Withdraws tokens

function withdraw(uint256 _amount, address _receiver) external

Parameters

Name	Type	Description
_amount	uint256	amount to withdraw
_receiver	address	address to receive tokens

performUpkeep

Splits new rewards between fee receivers

function performUpkeep(bytes) external

splitRewards

Splits new rewards between fee receivers

Bypasses rewardThreshold

function splitRewards() external

addFee

Adds a new fee

function addFee(address _receiver, uint256 _feeBasisPoints) external

Parameters

Name	Type	Description
_receiver	address	receiver of fee
_feeBasisPoints	uint256	fee in basis points

updateFee

Updates an existing fee

function updateFee(uint256 _index, address _receiver, uint256 _feeBasisPoints) external

Parameters

Name	Type	Description
_index	uint256	index of fee
_receiver	address	receiver of fee
_feeBasisPoints	uint256	fee in basis points