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
rewardAssets: bigint
maxMintShares: bigint
isProfitable: boolean
exitingPercent: bigint
}
NameDescription
sharesTokens count of boost
isProfitableDoes the boost APY exceed the current APY of the vault, if yes, then the method will return true
maxMintSharesMaximum possible number of osToken without deductions
exitingPercentThe percent (in wad) of user's position that is currently exiting
rewardAssetsUser boost rewards

Example:

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