Yield tracking and claiming
In Yelay V3, all earned yield is collected in the YieldExtractor contract. The yield is then becoming available to be claimed for clients and end users on a daily basis.
Fetch aggregated yield accrual info
Use this method to retrieve aggregated yield data for specified vaults, pools, and users within a given timeframe:
Where:
vaults
– Array of vault addresses to filter results.poolIds
– Array of pool IDs to filter results.users
– Array of user addresses to filter results.timeframe
– Timeframe to limit results within a specific period.
Fetch yield and APY per vault
Fetch yield info and APY per specific vault per given timeframe:
The method returns a response of the following structure:
Get claimable yield
Retrieve the amount of claimable yield for the user, optionally filtering by specific pool IDs and vault addresses:
Claim yield
Once you have retrieved claimable yield using getClaimableYield
, you can claim it using the claimYield
method:
The claimYield
method sends a transaction to the blockchain to claim yield based on the provided claim requests. It requires a valid signer with sufficient gas to execute the transaction. You can optionally provide gas overrides to customize the transaction parameters.
Last updated