Skip to main content

getHealthFactor

Description:

Get the health of the position

Arguments:

NameTypeRequiredDescription
thresholdPercentbigintYessdk.vault.getVault
mintedAssetsbigintYessdk.osToken.getPosition
stakedAssetsbigintYessdk.vault.getStakeBalance

Returns:

type Output = {
value: number
health: OsTokenPositionHealth
}
NameDescription
valueNumerical value
healthPosition Health (enum)

Example:

sdk.osToken.getHealthFactor({
thresholdPercent: 0n,
mintedAssets: 0n,
stakedAssets: 0n,
})