Class CdpService

Service exposing functions to interface with an eBTC collateralized debt position (CDP).

Hierarchy

Service
- CdpService

Index

Constructors

Constructors

constructor

new CdpService(eBTC): CdpService
Parameters
- eBTC: eBTC
Returns CdpService
Overrides Service.constructor
- Defined in cdp/cdp.service.ts:78

Properties

`Private` `Optional` _borrowerOperations

_borrowerOperations?: BorrowerOperations

`Private` `Optional` _cdpManager

_cdpManager?: CdpManager

`Private` `Optional` _collSurplusPool

_collSurplusPool?: CollSurplusPool

`Private` `Optional` _hintHelper

_hintHelper?: HintHelper

`Private` `Optional` _priceFeed

_priceFeed?: PriceFeed

`Private` `Optional` _sortedCdps

_sortedCdps?: SortedCdps

`Private` `Optional` _stEth

_stEth?: Steth

`Private` `Optional` _stEthUsdChainlinkOracle

_stEthUsdChainlinkOracle?: ChainlinkAggregator

`Private` `Optional` _zapLeverageRouter

_zapLeverageRouter?: ZapLeverageRouter

`Private` `Optional` _zapRouter

_zapRouter?: ZapRouter

`Private` eBTC

eBTC: eBTC

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

borrowerOperations

get borrowerOperations(): BorrowerOperations
Returns BorrowerOperations
- Defined in cdp/cdp.service.ts:159

cdpManager

get cdpManager(): CdpManager
Returns CdpManager
- Defined in cdp/cdp.service.ts:152

collSurplusPool

get collSurplusPool(): CollSurplusPool
Returns CollSurplusPool
- Defined in cdp/cdp.service.ts:173

connector

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

hintHelper

get hintHelper(): HintHelper
Returns HintHelper
- Defined in cdp/cdp.service.ts:194

priceFeed

get priceFeed(): PriceFeed
Returns PriceFeed
- Defined in cdp/cdp.service.ts:187

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

sortedCdps

get sortedCdps(): SortedCdps
Returns SortedCdps
- Defined in cdp/cdp.service.ts:166

stEth

get stEth(): Steth
Returns Steth
- Defined in cdp/cdp.service.ts:201

stEthUsdChainlinkOracle

get stEthUsdChainlinkOracle(): ChainlinkAggregator
Returns ChainlinkAggregator
- Defined in cdp/cdp.service.ts:180

zapLeverageRouter

get zapLeverageRouter(): ZapLeverageRouter
Returns ZapLeverageRouter
- Defined in cdp/cdp.service.ts:215

zapRouter

get zapRouter(): ZapRouter
Returns ZapRouter
- Defined in cdp/cdp.service.ts:208

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

_getLeverageCloseData

_getLeverageCloseData(options): Promise<ZapLeverageCloseData>
Parameters
- options: ZapLeverageCloseCdpOptions
Returns Promise<ZapLeverageCloseData>
- Defined in cdp/cdp.service.ts:261

addCollateral

addCollateral(options): Promise<TransactionStatus>
Parameters
- options: AddCollateralOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:266

adjustCdp

adjustCdp(options): Promise<TransactionStatus>
Parameters
- options: AdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:264

adjustCdpWithHelper

adjustCdpWithHelper(options): Promise<TransactionStatus>
Parameters
- options: AdjustCdpWithHelperOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:265

close

close(options): Promise<TransactionStatus>
Parameters
- options: CloseCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:256

convertPermitToBytes

convertPermitToBytes(permit): BytesLike
Parameters
- permit: GeneratePermitResponse
Returns BytesLike
- Defined in cdp/cdp.service.ts:295

createGetters

createGetters(serviceInstance): void
Parameters
- serviceInstance: any
Returns void
- Defined in cdp/cdp.service.ts:85

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>
Parameters
- options: GetHintOptions
Returns Promise<HintApproximation>
- Defined in cdp/cdp.service.ts:237

getBaseRate

getBaseRate(overrides?): Promise<BigNumber>
Parameters
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:234

getCdp

getCdp(cdpId, overrides?): Promise<CdpBase>
Parameters
- cdpId: BytesLike
- Optional overrides: Overrides
Returns Promise<CdpBase>
- Defined in cdp/cdp.service.ts:241

getCdpState

getCdpState(input): CdpStateString
Parameters
- input: CdpState
Returns CdpStateString
- Defined in cdp/cdp.service.ts:293

getCdpsCount

getCdpsCount(overrides?): Promise<BigNumber>
Parameters
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:238

getCollateral

getCollateral(cdpId, overrides?): Promise<BigNumber>
Parameters
- cdpId: BytesLike
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:226

getCollateralRatio

getCollateralRatio(cdpId, overrides?): Promise<BigNumber>
Parameters
- cdpId: BytesLike
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:227

getDebt

getDebt(cdpId, overrides?): Promise<BigNumber>
Parameters
- cdpId: BytesLike
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:225

getEntireDebtAndColl

getEntireDebtAndColl(cdpId, overrides?): Promise<EntireCdpDebtAndColl>
Parameters
- cdpId: BytesLike
- Optional overrides: Overrides
Returns Promise<EntireCdpDebtAndColl>
- Defined in cdp/cdp.service.ts:230

getExactInTradeData

getExactInTradeData(data): Promise<TradeDataStruct>
Parameters
- data: TradeDataExactInInput
Returns Promise<TradeDataStruct>
- Defined in cdp/cdp.service.ts:297

getExactOutTradeData

getExactOutTradeData(data): Promise<TradeDataStruct>
Parameters
- data: TradeDataExactOutInput
Returns Promise<TradeDataStruct>
- Defined in cdp/cdp.service.ts:298

getMinimumCollateralRatio

getMinimumCollateralRatio(overrides?): Promise<BigNumber>
Parameters
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:231

getMinimumStethBalance

getMinimumStethBalance(overrides?): Promise<BigNumber>
Parameters
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:232

getOwnedCdps

getOwnedCdps(address, overrides?): Promise<string[]>
Parameters
- address: string
- Optional overrides: Overrides
Returns Promise<string[]>
- Defined in cdp/cdp.service.ts:240

getRedemptionHints

getRedemptionHints(options): Promise<RedemptionHint>
Parameters
- options: GetRedemptionHintOptions
Returns Promise<RedemptionHint>
- Defined in cdp/cdp.service.ts:239

getRedemptionRate

getRedemptionRate(overrides?): Promise<BigNumber>
Parameters
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:235

getStakingRewardSplit

getStakingRewardSplit(overrides?): Promise<BigNumber>
Parameters
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:233

getSystemCollateral

getSystemCollateral(overrides?): Promise<BigNumber>
Parameters
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:229

getSystemCollateralRatio

getSystemCollateralRatio(overrides?): Promise<BigNumber>
Parameters
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:236

getSystemDebt

getSystemDebt(overrides?): Promise<BigNumber>
Parameters
- Optional overrides: Overrides
Returns Promise<BigNumber>
- Defined in cdp/cdp.service.ts:228

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

open

open(options): Promise<TransactionStatus>
Parameters
- options: OpenCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:244

openWithHelper

openWithHelper(options): Promise<TransactionStatus>
Parameters
- options: OpenCdpWithHelperOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:245

ready

ready(chainId): Promise<void>
Parameters
- chainId: number
Returns Promise<void>
- Defined in cdp/cdp.service.ts:96

repay

repay(options): Promise<TransactionStatus>
Parameters
- options: RepayOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:268

shouldGetHint

shouldGetHint(upperHint, lowerHint, emptyBytes32): boolean
Parameters
- upperHint: BytesLike
- lowerHint: BytesLike
- emptyBytes32: BytesLike
Returns boolean
- Defined in cdp/cdp.service.ts:296

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

withdraw

withdraw(options): Promise<TransactionStatus>
Parameters
- options: WithdrawOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:269

withdrawCollateral

withdrawCollateral(options): Promise<TransactionStatus>
Parameters
- options: WithdrawCollateralOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:267

zapAddCollateralWithETH

zapAddCollateralWithETH(options): Promise<TransactionStatus>
Parameters
- options: ZapAddCollateralOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:278

zapAdjustCdp

zapAdjustCdp(options): Promise<TransactionStatus>
Parameters
- options: ZapAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:270

zapAdjustCdpWithETH

zapAdjustCdpWithETH(options): Promise<TransactionStatus>
Parameters
- options: ZapAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:272

zapAdjustCdpWithWETH

zapAdjustCdpWithWETH(options): Promise<TransactionStatus>
Parameters
- options: ZapAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:274

zapAdjustCdpWithWstETH

zapAdjustCdpWithWstETH(options): Promise<TransactionStatus>
Parameters
- options: ZapAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:276

zapClose

zapClose(options): Promise<TransactionStatus>
Parameters
- options: CloseCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:257

zapCloseForWstETH

zapCloseForWstETH(options): Promise<TransactionStatus>
Parameters
- options: CloseCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:259

zapDepositETH

zapDepositETH(options): Promise<TransactionStatus>
Parameters
- options: ZapDepositOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:285

zapDepositStETH

zapDepositStETH(options): Promise<TransactionStatus>
Parameters
- options: ZapDepositOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:279

zapDepositWETH

zapDepositWETH(options): Promise<TransactionStatus>
Parameters
- options: ZapDepositOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:283

zapDepositWstETH

zapDepositWstETH(options): Promise<TransactionStatus>
Parameters
- options: ZapDepositOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:281

zapGeneratePermit

zapGeneratePermit(options?): Promise<GeneratePermitResponse>
Parameters
- Optional options: GeneratePermitOptions
Returns Promise<GeneratePermitResponse>
- Defined in cdp/cdp.service.ts:294

zapLeverageAdjustCdp

zapLeverageAdjustCdp(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:271

zapLeverageAdjustCdpWithETH

zapLeverageAdjustCdpWithETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:273

zapLeverageAdjustCdpWithWETH

zapLeverageAdjustCdpWithWETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:275

zapLeverageAdjustCdpWithWstETH

zapLeverageAdjustCdpWithWstETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:277

zapLeverageClose

zapLeverageClose(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageCloseCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:258

zapLeverageCloseForWstETH

zapLeverageCloseForWstETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageCloseCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:260

zapLeverageDepositETH

zapLeverageDepositETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:286

zapLeverageDepositStETH

zapLeverageDepositStETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:280

zapLeverageDepositWETH

zapLeverageDepositWETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:284

zapLeverageDepositWstETH

zapLeverageDepositWstETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:282

zapLeverageOpenCdp

zapLeverageOpenCdp(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageOpenCdpWithHelperOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:247

zapLeverageOpenCdpWithETH

zapLeverageOpenCdpWithETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageOpenCdpWithHelperOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:249

zapLeverageOpenCdpWithWETH

zapLeverageOpenCdpWithWETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageOpenCdpWithHelperOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:251

zapLeverageOpenCdpWithWstETH

zapLeverageOpenCdpWithWstETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageOpenCdpWithHelperOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:253

zapLeverageWithdrawStETH

zapLeverageWithdrawStETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:288

zapLeverageWithdrawWstETH

zapLeverageWithdrawWstETH(options): Promise<TransactionStatus>
Parameters
- options: ZapLeverageAdjustCdpOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:290

zapOpenCdp

zapOpenCdp(options): Promise<TransactionStatus>
Parameters
- options: ZapOpenCdpWithHelperOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:246

zapOpenCdpWithETH

zapOpenCdpWithETH(options): Promise<TransactionStatus>
Parameters
- options: ZapOpenCdpWithHelperOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:248

zapOpenCdpWithWETH

zapOpenCdpWithWETH(options): Promise<TransactionStatus>
Parameters
- options: ZapOpenCdpWithHelperOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:250

zapOpenCdpWithWstETH

zapOpenCdpWithWstETH(options): Promise<TransactionStatus>
Parameters
- options: ZapOpenCdpWithHelperOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:252

zapWithdrawStETH

zapWithdrawStETH(options): Promise<TransactionStatus>
Parameters
- options: ZapWithdrawOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:287

zapWithdrawWstETH

zapWithdrawWstETH(options): Promise<TransactionStatus>
Parameters
- options: ZapWithdrawOptions
Returns Promise<TransactionStatus>
- Defined in cdp/cdp.service.ts:289

Class CdpService

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

eBTC: eBTC

Returns CdpService

Properties

Private Optional _borrowerOperations

Private Optional _cdpManager

Private Optional _collSurplusPool

Private Optional _hintHelper

Private Optional _priceFeed

Private Optional _sortedCdps

Private Optional _stEth

Private Optional _stEthUsdChainlinkOracle

Private Optional _zapLeverageRouter

Private Optional _zapRouter

Private eBTC

level

Protected sdk

Accessors

address

Returns undefined | string

borrowerOperations

Returns BorrowerOperations

cdpManager

Returns CdpManager

collSurplusPool

Returns CollSurplusPool

connector

Returns Signer | MulticallProvider

hintHelper

Returns HintHelper

priceFeed

Returns PriceFeed

provider

Returns MulticallProvider

signer

Returns undefined | Signer

sortedCdps

Returns SortedCdps

stEth

Returns Steth

stEthUsdChainlinkOracle

Returns ChainlinkAggregator

zapLeverageRouter

Returns ZapLeverageRouter

zapRouter

Returns ZapRouter

Methods

Private #_log

Parameters

level: LogLevel

Optional message: any

Rest ...optionalParams: any[]

Returns void

_getLeverageCloseData

Parameters

options: ZapLeverageCloseCdpOptions

Returns Promise<ZapLeverageCloseData>

addCollateral

Parameters

options: AddCollateralOptions

Returns Promise<TransactionStatus>

adjustCdp

Parameters

options: AdjustCdpOptions

Returns Promise<TransactionStatus>

adjustCdpWithHelper

Parameters

options: AdjustCdpWithHelperOptions

Returns Promise<TransactionStatus>

close

Parameters

`Private` `Optional` _borrowerOperations

`Private` `Optional` _cdpManager

`Private` `Optional` _collSurplusPool

`Private` `Optional` _hintHelper

`Private` `Optional` _priceFeed

`Private` `Optional` _sortedCdps

`Private` `Optional` _stEth

`Private` `Optional` _stEthUsdChainlinkOracle

`Private` `Optional` _zapLeverageRouter

`Private` `Optional` _zapRouter

`Private` eBTC

`Protected` sdk

`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