Skip to main content

getData

Description:

Get boost data for vault user

Arguments:

NameTypeRequiredDescription
userAddressstringYesThe user address
vaultAddressstringYesThe address of the vault

Returns:

type Output = {
shares: bigint
vaultApy: number
rewardAssets: bigint
maxMintShares: bigint
exitingPercent: number
allocatorMaxBoostApy: number
osTokenHolderMaxBoostApy: number
}
NameDescription
sharesTokens count of boost
vaultApyBase vault apy
maxMintSharesMaximum possible number of osToken without deductions
exitingPercentThe percent (in wad) of user's position that is currently exiting
rewardAssetsUser boost rewards
allocatorMaxBoostApyThe average max boost APY earned in this vault by the allocator
osTokenHolderMaxBoostApyThe average max boost APY earned in this vault by the osToken holder

Example:

await sdk.boost.getData({
userAddress: '0x...',
vaultAddress: '0x...',
})