Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Borrow Variables

debtEstimateø: Observable<W3bNumber> = ...

Calculate the expected NEW debt @ maturity ( any exisiting debt + new debt ) previously 'borrowEstimate'

isBorrowLimitedø: Observable<boolean> = ...

TODO: Check if the particular borrow amount is limited by the liquidity in the protocol

isBorrowPossibleø: Observable<boolean> = ...

Check if the user can borrow the specified amount based on current protocol sharesReserves

maxDebtLimitø: Observable<W3bNumber> = ...

Maximum amount of debt allowed by the protocol for a particular Asset Pair

minDebtLimitø: Observable<W3bNumber> = ...

Minimum amount of debt allowed by the protocol ( Dust level ) for a particular Asset Pair

Borrow | Collateral Variables

collateralizationPercentø: Observable<number> = ...

The PREDICTED collateralization based on the current INPUT parameters expressed as a PERCENTAGE ( for display )

collateralizationRatioø: Observable<number | undefined> = ...

The PREDICTED collateralization ratio based on the current INPUT expressed as a ratio

estimatedLiquidatePriceø: Observable<String | undefined> = ...

Pre Transaction estimated Price at which a vault / pair will get liquidated based on collateral and debt INPUT ( and existing colalteral and debt)

isUndercollateralizedø: Observable<boolean> = ...

Check if the debt amount is undercollaterallized

isUnhealthyCollateralizationø: Observable<boolean> = ...

Check if the collateraillization level of a vault is consdired 'unhealthy'

maxCollateralø: Observable<W3bNumber> = ...

Maximum collateral based selected Ilk and users balance

maxRemovableCollateralø: Observable<W3bNumber> = ...

Calculate the maximum amount of collateral that can be removed without leaving the vault undercollateralised

minCollateralRequiredø: Observable<W3bNumber> = ...

The minimum collateral required to meet the minimum protocol-allowed levels

minCollateralizationPercentø: Observable<number> = ...

The minimum protocol-allowed collaterallisation level expressed as a percentage ( for display )

minCollateralizationRatioø: Observable<number> = ...

The minimum protocol allowed collaterallisation level expressed as a ratio

minimumSafePercentø: Observable<number> = ...

Minimum Safe collatearalization level expressed as a percentage

minimumSafeRatioø: Observable<number> = ...

Minimum Safe collatearalization level expressed asa ratio TODO: would this be better specified with the assetPair data? - possibly

vaultLiquidatePriceø: Observable<String | undefined> = ...

Price at which the vault will get liquidated

Borrow | Repay Variables

debtAfterRepayø: Observable<W3bNumber> = ...

Calculate how much debt will be remaining after successful repayment of [input]

isRepayLimitedø: Observable<boolean> = ...

TODO:

Check if the particular repay [input] is limited by the liquidity in the protocol

maximumRepayø: Observable<W3bNumber> = ...

Maximum amount that can be repayed (limited by: either the max tokens owned OR max debt available )

maximumRollø: Observable<W3bNumber> = ...

TODO: Maximum amount that can be rolled ( NOTE : Not NB for now because we are only rolling entire [vaults] )

minimumRepayø: Observable<W3bNumber> = ...

Min amount that can be repayed (limited by assetPair dustlevels/minDebt )

Borrow | Roll Variables

isRollVaultPossibleø: Observable<boolean> = ...

Check if the user can roll the selected vault to a new [future] series

Input Variables

addLiquidityInputø: Observable<W3bNumber> = ...

Add liquidity input

borrowInputø: Observable<W3bNumber> = ...

Borrow input

closeInputø: Observable<W3bNumber> = ...

Close Position input

collateralInputø: Observable<W3bNumber> = ...

Collateral input

lendInputø: Observable<W3bNumber> = ...

Lending input

removeLiquidityInputø: Observable<W3bNumber> = ...

Remove liquidity input

repayInputø: Observable<W3bNumber> = ...

Repayment input

Lend Variables

isLendingLimitedø: Observable<boolean> = ...

Flag indicating if lending is limited by the protocol based on both account blaance ( and possibly input? )

lendPostionValueø: Observable<W3bNumber> = ...

Get the base value of the existing lending position. i.e. the CURRENT base value of the fyTokens held by the user

lendValueAtMaturityø: Observable<W3bNumber> = ...

Predicted Base Value at maturity based on the [[input]] provided.

maximumLendø: Observable<W3bNumber> = ...

Get the maximum lendable to the protocol based on selected series

Lend | Close Variables

maximumCloseø: Observable<W3bNumber> = ...

Maximum allowable when closing a lending posiiton

Lend | Roll Variables

maximumLendRollø: Observable<W3bNumber> = ...

Maximum rollable base

Pool | Add Liquidity Variables

isBuyAndPoolPossibleø: Observable<boolean> = ...

Check if it is possible to use BUY and POOL strategy is available for a particular INPUT and selected strategy.

maximumAddLiquidityø: Observable<W3bNumber> = ...

Pool | Remove Liquidity Variables

borrowAndPoolVaultø: Observable<IVault | undefined> = ...

Get the vault ( if adding liquidity was done using the 'Borrow and Pool' method. )

isPartialRemoveRequiredø: Observable<boolean> = ...

Check if not all liquidity can be removed, and a partial removal is required.

maximumRemoveLiquidityø: Observable<W3bNumber> = ...

Maximum removalable liquidity

  • currently liquidity is always removable, so the balance is the strategy token balance
removeLiquidityReturnø: Observable<W3bNumber[]> = ...

Indicates the amount of [0] Base and [1] fyTokens that will be returned when partially removing liquidity tokens based on the input

returns

Functions

  • updateAddLiqInput(input: string): void
  • updateBorrowInput(input: string): void
  • updateCloseInput(input: string): void
  • updateCollateralInput(input: string): void
  • updateLendInput(input: string): void
  • updateRemoveLiqInput(input: string): void
  • updateRepayInput(input: string): void

Generated using TypeDoc