getHealthFactor
Description:
Get the health of the position
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| liqThresholdPercent | bigint | Yes | sdk.vault.getVault |
| mintedAssets | bigint | Yes | sdk.osToken.getPosition |
| stakedAssets | bigint | Yes | sdk.vault.getStakeBalance |
Returns:
type Output = {
value: number
health: OsTokenPositionHealth
}
| Name | Description |
|---|---|
value | Numerical value |
health | Position Health (enum) |
Example:
sdk.osToken.getHealthFactor({
liqThresholdPercent: 0n,
mintedAssets: 0n,
stakedAssets: 0n,
})