Class CalculationService

Service exposing functions to do basic math calculations that a frontend would require

Hierarchy

Service
- CalculationService

Constructors

constructor

new CalculationService(eBTC): CalculationService
Parameters
- eBTC: eBTC
Returns CalculationService
Overrides Service.constructor
- Defined in calculations/calculations.service.ts:12

Properties

level

level: LogLevel

`Protected` sdk

sdk: eBTC

Accessors

address

get address(): undefined | string
Returns undefined | string
Inherited from Service.address
- Defined in service.ts:25

connector

get connector(): Signer | MulticallProvider
Returns Signer | MulticallProvider
Inherited from Service.connector
- Defined in service.ts:21

provider

get provider(): MulticallProvider
Returns MulticallProvider
Inherited from Service.provider
- Defined in service.ts:13

signer

get signer(): undefined | Signer
Returns undefined | Signer
Inherited from Service.signer
- Defined in service.ts:17

Methods

`Private` #_log

#_log(level, message?, ...optionalParams): void
Parameters
- level: LogLevel
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.#_log
- Defined in logger.ts:28

`Private` _calculateInitialMaxLeverage

_calculateInitialMaxLeverage(__namedParameters): number
Parameters
- __namedParameters: {
      borrowAmount: number;
      collWithoutGasStipend: number;
      collateralRatio: number;
      stEthBtcRatio: number;
  }
  - borrowAmount: number
  - collWithoutGasStipend: number
  - collateralRatio: number
  - stEthBtcRatio: number
Returns number
- Defined in calculations/calculations.service.ts:177

calcDebtWithLeverage

calcDebtWithLeverage(__namedParameters): BigNumber
Parameters
- __namedParameters: {
      collateral: BigNumber;
      leverageRatio: BigNumber;
      ratio: BigNumber;
      stEthBtcRatio: BigNumber;
  }
  - collateral: BigNumber
  - leverageRatio: BigNumber
  - ratio: BigNumber
  - stEthBtcRatio: BigNumber
Returns BigNumber
- Defined in calculations/calculations.service.ts:105

calculateCollateral

calculateCollateral(debt, stEthBtcRatio, collateralRatio): BigNumber
Calculate the amount of stEth (collateral) as a balance (not shares) as an 18 decimal BigNumber
Parameters
- debt: BigNumber
  Amount of ebtc debt as an 18 decimal BigNumber
- stEthBtcRatio: BigNumber
  Ratio between the stEth balance (collateral NOT in shares) and eBTC from the pricefeed as an 18 decimal BigNumber
- collateralRatio: BigNumber
  The Collateral (stEth Balance) to Debt Ratio (ICR)
Returns BigNumber
Amount of ebtc debt as an 18 decimal BigNumber
- Defined in calculations/calculations.service.ts:82

calculateCollateralRatio

calculateCollateralRatio(collateral, debt, stEthBtcRatio): BigNumber
Calculate the Collateral (stEth Balance) to Debt Ratio (ICR)
Parameters
- collateral: BigNumber
  Amount of stEth (balance not shares) as a balance (not shares) in Ether unit
- debt: BigNumber
  Amount of ebtc debt in Ether unit
- stEthBtcRatio: BigNumber
  Ratio between stEth balance (collateral NOT in shares) and eBTC from the pricefeed in Ether unit
Returns BigNumber
stEth balance in Ether unit
- Defined in calculations/calculations.service.ts:23

calculateDebt

calculateDebt(collateral, stEthBtcRatio, collateralRatio): BigNumber
Calculate the amount of debt that can be generated for a given stEth balance and the desired collateral ratio
Parameters
- collateral: BigNumber
  Amount of stEth (balance not shares) as a balance (not shares) as an 18 decimal BigNumber
- stEthBtcRatio: BigNumber
  Ratio between the stEth balance (collateral NOT in shares) and eBTC from the pricefeed as an 18 decimal BigNumber
- collateralRatio: BigNumber
  The Collateral (stEth Balance) to Debt Ratio (ICR)
Returns BigNumber
Amount of ebtc debt as an 18 decimal BigNumber
- Defined in calculations/calculations.service.ts:71

calculateLiquidationPrice

calculateLiquidationPrice(collateral, debt, liquidationRatio?): BigNumber
Calculate at what stEth-Ebtc ratio the cdp will be liquidated (note: this does not account for fluctions in the stEth share price)
Parameters
- collateral: BigNumber
  Amount of stEth (balance not shares) as a balance (not shares) as an 18 decimal BigNumber
- debt: BigNumber
  Amount of ebtc debt as an 18 decimal BigNumber
- liquidationRatio: BigNumber = ...
  The ratio at which the cdp will be liquidated as an 18 decimal BigNumber (default: 110% = 1_100_000_000_000_000_000, if recovery mode is on use 125%)
Returns BigNumber
The stEthBtcRatio at which the cdp will be liquidated as an 18 decimal BigNumber
- Defined in calculations/calculations.service.ts:57

calculateMargin

calculateMargin(debt, stEthBtcRatio, collateralRatio): BigNumber
Parameters
- debt: BigNumber
- stEthBtcRatio: BigNumber
- collateralRatio: BigNumber
Returns BigNumber
- Defined in calculations/calculations.service.ts:86

calculateMaxLeverage

calculateMaxLeverage(__namedParameters): number
Parameters
- __namedParameters: {
      borrowAmount: number;
      collWithoutGasStipend: number;
      collateralRatio: number;
      stEthBtcRatio: number;
  }
  - borrowAmount: number
  - collWithoutGasStipend: number
  - collateralRatio: number
  - stEthBtcRatio: number
Returns number
- Defined in calculations/calculations.service.ts:120

calculateStethBalance

calculateStethBalance(collateralInShares, stEthShareRatio): BigNumber
Calculate the stethBalance from the share amount and the stEth share ratio
Parameters
- collateralInShares: BigNumber
  Amount of stEth in shares (not the stEth balance) in Ether unit
- stEthShareRatio: BigNumber
  stEth share ratio in Ether unit
Returns BigNumber
stEth balance in smallest
- Defined in calculations/calculations.service.ts:36

calculateStethShares

calculateStethShares(collateral, stEthShareRatio): BigNumber
Calculate the steth shares from the steth balance amount and the stEth share ratio
Parameters
- collateral: BigNumber
  Amount of stEth balance (not the stEth shares) in Ether unit
- stEthShareRatio: BigNumber
  stEth share ratio in Ether unit
Returns BigNumber
stEth balance in smallest
- Defined in calculations/calculations.service.ts:46

convertWsEthToStEth

convertWsEthToStEth(wstEth): Promise<BigNumber>
Parameters
- wstEth: BigNumber
Returns Promise<BigNumber>
- Defined in calculations/calculations.service.ts:97

debtToCollateral

debtToCollateral(debt): Promise<BigNumber>
Parameters
- debt: BigNumber
Returns Promise<BigNumber>
- Defined in calculations/calculations.service.ts:92

debug

debug(message?, ...optionalParams): void
Parameters
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.debug
- Defined in logger.ts:12

error

error(message?, ...optionalParams): void
Parameters
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.error
- Defined in logger.ts:24

info

info(message?, ...optionalParams): void
Parameters
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.info
- Defined in logger.ts:16

log

log(message?, ...optionalParams): void
Parameters
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.log
- Defined in logger.ts:8

submitAction

submitAction<T>(__namedParameters): Promise<TransactionStatus>
Type Parameters
- T extends SubmitOptions
Parameters
- __namedParameters: T
Returns Promise<TransactionStatus>
Inherited from Service.submitAction
- Defined in service.ts:29

warn

warn(message?, ...optionalParams): void
Parameters
- Optional message: any
- Rest ...optionalParams: any[]
Returns void
Inherited from Service.warn
- Defined in logger.ts:20

Class CalculationService

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

eBTC: eBTC

Returns CalculationService

Properties

level

Protected sdk

Accessors

address

Returns undefined | string

connector

Returns Signer | MulticallProvider

provider

Returns MulticallProvider

signer

Returns undefined | Signer

Methods

Private #_log

Parameters

level: LogLevel

Optional message: any

Rest ...optionalParams: any[]

Returns void

Private _calculateInitialMaxLeverage

Parameters

__namedParameters: { borrowAmount: number; collWithoutGasStipend: number; collateralRatio: number; stEthBtcRatio: number; }

borrowAmount: number

collWithoutGasStipend: number

collateralRatio: number

stEthBtcRatio: number

Returns number

calcDebtWithLeverage

Parameters

__namedParameters: { collateral: BigNumber; leverageRatio: BigNumber; ratio: BigNumber; stEthBtcRatio: BigNumber; }

collateral: BigNumber

leverageRatio: BigNumber

ratio: BigNumber

stEthBtcRatio: BigNumber

Returns BigNumber

calculateCollateral

Parameters

debt: BigNumber

stEthBtcRatio: BigNumber

collateralRatio: BigNumber

Returns BigNumber

calculateCollateralRatio

Parameters

collateral: BigNumber

debt: BigNumber

stEthBtcRatio: BigNumber

Returns BigNumber

calculateDebt

Parameters

collateral: BigNumber

stEthBtcRatio: BigNumber

collateralRatio: BigNumber

Returns BigNumber

calculateLiquidationPrice

Parameters

collateral: BigNumber

debt: BigNumber

liquidationRatio: BigNumber = ...

Returns BigNumber

calculateMargin

Parameters

debt: BigNumber

stEthBtcRatio: BigNumber

collateralRatio: BigNumber

Returns BigNumber

calculateMaxLeverage

Parameters

__namedParameters: { borrowAmount: number; collWithoutGasStipend: number; collateralRatio: number; stEthBtcRatio: number; }

`Protected` sdk

`Private` #_log

`Optional` message: any

`Rest` ...optionalParams: any[]

`Private` _calculateInitialMaxLeverage

__namedParameters: {
borrowAmount: number;
collWithoutGasStipend: number;
collateralRatio: number;
stEthBtcRatio: number;
}

__namedParameters: {
collateral: BigNumber;
leverageRatio: BigNumber;
ratio: BigNumber;
stEthBtcRatio: BigNumber;
}

__namedParameters: {
borrowAmount: number;
collWithoutGasStipend: number;
collateralRatio: number;
stEthBtcRatio: number;
}

`Optional` message: any

`Rest` ...optionalParams: any[]

`Optional` message: any

`Rest` ...optionalParams: any[]

`Optional` message: any

`Rest` ...optionalParams: any[]

`Optional` message: any

`Rest` ...optionalParams: any[]

`Optional` message: any

`Rest` ...optionalParams: any[]