Class CdpViewService

Hierarchy

Service
- CdpViewService

Constructors

constructor

new CdpViewService(eBTC, cdpService, sharedServices): CdpViewService
Parameters
- eBTC: eBTC
- cdpService: CdpService
- sharedServices: {
      borrowerOperations: BorrowerOperations;
      cdpManager: CdpManager;
      hintHelper: HintHelper;
      sortedCdps: SortedCdps;
  }
  - borrowerOperations: BorrowerOperations
  - cdpManager: CdpManager
  - hintHelper: HintHelper
  - sortedCdps: SortedCdps
Returns CdpViewService
Overrides Service.constructor
- Defined in cdp/cdp.view.service.ts:20

Properties

`Private` borrowerOperations

borrowerOperations: BorrowerOperations

`Private` cdp

cdp: CdpService

`Private` cdpManager

cdpManager: CdpManager

`Private` hintHelper

hintHelper: HintHelper

level

level: LogLevel

`Protected` sdk

sdk: eBTC

`Private` sortedCdps

sortedCdps: SortedCdps

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

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

getApproxHint

getApproxHint(options): Promise<HintApproximation>
Obtain approximate hints for a proposed amount of collateral and borrow

Implementation inspired by the following from liquity: https://github.com/liquity/dev/blob/main/packages/contracts/utils/hintExamples.js#L25-L58
Parameters
- options: GetHintOptions
  Get hint transaction paramters. collateralAmount and borrowAmount in Ether unit
Returns Promise<HintApproximation>
Upper and lower hints to use against cdp manager operations
- Defined in cdp/cdp.view.service.ts:180

getBaseRate

getBaseRate(overrides?): Promise<BigNumber>
Read system base rate
Parameters
- Optional overrides: Overrides
  Get system base rate overrides
Returns Promise<BigNumber>
System current base rate
- Defined in cdp/cdp.view.service.ts:147

getCdp

getCdp(cdpId, overrides?): Promise<CdpBase>
Retrieve information for a single cdp. This includes unrealized collateral and debt changes to the cdp.
Parameters
- cdpId: BytesLike
  id of the cdp to get data for
- Optional overrides: Overrides
  Get cdp paramter overrides
Returns Promise<CdpBase>
Cdp info related to the requested id
- Defined in cdp/cdp.view.service.ts:301

getCdpsCount

getCdpsCount(overrides?): Promise<BigNumber>
Read system cdps opened
Parameters
- Optional overrides: Overrides
  Get system cdps count overrides
Returns Promise<BigNumber>
System current cdps opened
- Defined in cdp/cdp.view.service.ts:234

getCollateral

getCollateral(cdpId, overrides?): Promise<BigNumber>
Read specific cdp outstanding collateral
Parameters
- cdpId: BytesLike
  The id of the requested trove
- Optional overrides: Overrides
  Get debt collateral overrides
Returns Promise<BigNumber>
Collateral for requested trove in an 18 decimal BigNumber
- Defined in cdp/cdp.view.service.ts:54

getCollateralRatio

getCollateralRatio(cdpId, overrides?): Promise<BigNumber>
Read specific trove outstanding collateral ratio
Parameters
- cdpId: BytesLike
  The id of the requested trove
- Optional overrides: Overrides
  Get collateral ratio read overrides
Returns Promise<BigNumber>
Collateral ratio for requested trove
- Defined in cdp/cdp.view.service.ts:64

getDebt

getDebt(cdpId, overrides?): Promise<BigNumber>
Read specific trove outstanding debt
Parameters
- cdpId: BytesLike
  The id of the requested trove
- Optional overrides: Overrides
  Get debt read overrides
Returns Promise<BigNumber>
Debt for requested trove in an 18 decimal BigNumber
- Defined in cdp/cdp.view.service.ts:44

getEntireDebtAndColl

getEntireDebtAndColl(cdpId, overrides?): Promise<EntireCdpDebtAndColl>
Read entire debt and coll for a given CDP
Parameters
- cdpId: BytesLike
  id of the cdp to get data for
- Optional overrides: Overrides
  Get total collateral read overrides
Returns Promise<EntireCdpDebtAndColl>
Total system collateral
- Defined in cdp/cdp.view.service.ts:96

getMinimumCollateralRatio

getMinimumCollateralRatio(overrides?): Promise<BigNumber>
Returns the current minumum collateral ratio to open a CDP in the current system's state
Parameters
- Optional overrides: Overrides
  Get minimum collateral ratio read overrides
Returns Promise<BigNumber>
Minimum collateral ratio required for a cdp to be opened in Ether unit
- Defined in cdp/cdp.view.service.ts:114

getMinimumStethBalance

getMinimumStethBalance(overrides?): Promise<BigNumber>
Returns the current minumum collateral amount in stEth balance (not shares) as 18 decimal BigNumber to open a CDP in the current system's state
Parameters
- Optional overrides: Overrides
  Get minimum collateral amount read overrides
Returns Promise<BigNumber>
Minimum collateral amount in stEth balance (not shares) as 18 decimal BigNumber required for a cdp to be opened
- Defined in cdp/cdp.view.service.ts:129

getOwnedCdps

getOwnedCdps(address, overrides?): Promise<string[]>
Returns array of cdpIds that belong to the requested address
Parameters
- address: string
  Request address to get cdps for
- Optional overrides: Overrides
  Get owned cdps override parameters
Returns Promise<string[]>
List of cdpIds for the cdp that are owned by the requested address
- Defined in cdp/cdp.view.service.ts:291

getRedemptionHints

getRedemptionHints(options): Promise<RedemptionHint>
Obtain redemption hints for amount of eBTC redeemed
Parameters
- options: GetRedemptionHintOptions
  Redemption hint read paramters
Returns Promise<RedemptionHint>
Select parameters required for submitting redemptions
- Defined in cdp/cdp.view.service.ts:243

getRedemptionRate

getRedemptionRate(overrides?): Promise<BigNumber>
Read system redemption fees
Parameters
- Optional overrides: Overrides
  Get system redemption fee overrides
Returns Promise<BigNumber>
System current redemption fees
- Defined in cdp/cdp.view.service.ts:156

getStakingRewardSplit

getStakingRewardSplit(overrides?): Promise<BigNumber>
Returns the Staking reward split of the stEth currently in a CDP. This value is how much % in basis points the protocol takes (Example: 6000 = 60% of staking rewards taken by the protocol)
Parameters
- Optional overrides: Overrides
  Get staking reward split read overrides
Returns Promise<BigNumber>
Staking reward split of the stEth in a CDP. This value is how much % in basis points the protocol takes (Example: 6000 = 60% of staking rewards taken by the protocol)
- Defined in cdp/cdp.view.service.ts:138

getSystemCollateral

getSystemCollateral(overrides?): Promise<BigNumber>
Read system outstanding collateral
Parameters
- Optional overrides: Overrides
  Get total collateral read overrides
Returns Promise<BigNumber>
Total system collateral
- Defined in cdp/cdp.view.service.ts:82

getSystemCollateralRatio

getSystemCollateralRatio(overrides?): Promise<BigNumber>
Get the latest synced Total Collateral Ratio (TCR) of the system.
Parameters
- Optional overrides: Overrides
  getSyncedTCR overrides
Returns Promise<BigNumber>
The Total System's Collateral Ratio in the Ether unit
- Defined in cdp/cdp.view.service.ts:165

getSystemDebt

getSystemDebt(overrides?): Promise<BigNumber>
Read system outstanding debt
Parameters
- Optional overrides: Overrides
  Get total debt read overrides
Returns Promise<BigNumber>
Total system debt
- Defined in cdp/cdp.view.service.ts:73

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 CdpViewService

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

eBTC: eBTC

cdpService: CdpService

sharedServices: { borrowerOperations: BorrowerOperations; cdpManager: CdpManager; hintHelper: HintHelper; sortedCdps: SortedCdps; }

borrowerOperations: BorrowerOperations

cdpManager: CdpManager

hintHelper: HintHelper

sortedCdps: SortedCdps

Returns CdpViewService

Properties

Private borrowerOperations

Private cdp

Private cdpManager

Private hintHelper

level

Protected sdk

Private sortedCdps

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

debug

Parameters

Optional message: any

Rest ...optionalParams: any[]

Returns void

error

Parameters

Optional message: any

Rest ...optionalParams: any[]

Returns void

getApproxHint

Parameters

options: GetHintOptions

Returns Promise<HintApproximation>

getBaseRate

Parameters

Optional overrides: Overrides

Returns Promise<BigNumber>

getCdp

Parameters

cdpId: BytesLike

Optional overrides: Overrides

Returns Promise<CdpBase>

getCdpsCount

Parameters

Optional overrides: Overrides

Returns Promise<BigNumber>

getCollateral

Parameters

cdpId: BytesLike

Optional overrides: Overrides

Returns Promise<BigNumber>

getCollateralRatio

Parameters

cdpId: BytesLike

Optional overrides: Overrides

Returns Promise<BigNumber>

getDebt

sharedServices: {
borrowerOperations: BorrowerOperations;
cdpManager: CdpManager;
hintHelper: HintHelper;
sortedCdps: SortedCdps;
}

`Private` borrowerOperations

`Private` cdp

`Private` cdpManager

`Private` hintHelper

`Protected` sdk

`Private` sortedCdps

`Private` #_log

`Optional` message: any

`Rest` ...optionalParams: any[]

`Optional` message: any

`Rest` ...optionalParams: any[]

`Optional` message: any

`Rest` ...optionalParams: any[]

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` overrides: Overrides

`Optional` message: any

`Rest` ...optionalParams: any[]

`Optional` message: any

`Rest` ...optionalParams: any[]

`Optional` message: any

`Rest` ...optionalParams: any[]