Class CdpAdjustService

Hierarchy

Service
- CdpAdjustService

Constructors

constructor

new CdpAdjustService(eBTC, cdpService, sharedServices): CdpAdjustService
Parameters
- eBTC: eBTC
- cdpService: CdpService
- sharedServices: {
      borrowerOperations: BorrowerOperations;
      zapLeverageRouter: ZapLeverageRouter;
      zapRouter: ZapRouter;
  }
  - borrowerOperations: BorrowerOperations
  - zapLeverageRouter: ZapLeverageRouter
  - zapRouter: ZapRouter
Returns CdpAdjustService
Overrides Service.constructor
- Defined in cdp/cdp.adjust.service.ts:32

Properties

`Private` borrowerOperations

borrowerOperations: BorrowerOperations

`Private` cdp

cdp: CdpService

level

level: LogLevel

`Protected` sdk

sdk: eBTC

`Private` zapLeverageRouter

zapLeverageRouter: ZapLeverageRouter

`Private` zapRouter

zapRouter: ZapRouter

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` _getAdjustCdpParams

_getAdjustCdpParams(__namedParameters): AdjustCdpParamsStruct
Parameters
- __namedParameters: {
      collValue: BigNumber;
      debtChange: BigNumber;
      flashLoanAmount: BigNumber;
      lowerHint: BytesLike;
      marginBalance: BigNumber;
      upperHint: BytesLike;
      useWstETHForDecrease: boolean;
  }
  - collValue: BigNumber
  - debtChange: BigNumber
  - flashLoanAmount: BigNumber
  - lowerHint: BytesLike
  - marginBalance: BigNumber
  - upperHint: BytesLike
  - useWstETHForDecrease: boolean
Returns AdjustCdpParamsStruct
- Defined in cdp/cdp.adjust.service.ts:314

`Private` _zapAdjustCdpCommonLogic

_zapAdjustCdpCommonLogic(options, adjustCdpMethod, isWithEth?): Promise<ContractTransaction>
Performs the common logic for adjusting a CDP using the specified adjustCdpMethod.
Parameters
- options: ZapAdjustCdpOptions
  The options for adjusting the CDP.
- adjustCdpMethod: ((cdpId, stEthBalanceDecrease, debtChange, isDebtIncrease, upperHint, lowerHint, stEthBalanceIncrease, useWstETHForDecrease, positionManagerPermit, overrides?) => Promise<ContractTransaction>)
  The method for adjusting the CDP.
  - - (cdpId, stEthBalanceDecrease, debtChange, isDebtIncrease, upperHint, lowerHint, stEthBalanceIncrease, useWstETHForDecrease, positionManagerPermit, overrides?): Promise<ContractTransaction>
    - Parameters
      cdpId: BytesLike
      stEthBalanceDecrease: BigNumberish
      debtChange: BigNumberish
      isDebtIncrease: boolean
      upperHint: BytesLike
      lowerHint: BytesLike
      stEthBalanceIncrease: BigNumberish
      useWstETHForDecrease: boolean
      positionManagerPermit: PositionManagerPermitStruct
      Optional overrides: Overrides & {
      from?: string;
      }
      Returns Promise<ContractTransaction>
- isWithEth: boolean = false
Returns Promise<ContractTransaction>
A promise that resolves to the transaction object.
- Defined in cdp/cdp.adjust.service.ts:166

`Private` _zapLeverageAdjustCdpCommonLogic

_zapLeverageAdjustCdpCommonLogic(options, adjustCdpMethod): Promise<ContractTransaction>
Parameters
- options: ZapLeverageAdjustCdpOptions
- adjustCdpMethod: ((cdpId, params, positionManagerPermit, tradeData, overrides?) => Promise<ContractTransaction>)
  - - (cdpId, params, positionManagerPermit, tradeData, overrides?): Promise<ContractTransaction>
    - Parameters
      cdpId: BytesLike
      params: AdjustCdpParamsStruct
      positionManagerPermit: BytesLike
      tradeData: TradeDataStruct
      Optional overrides: Overrides & {
      from?: string;
      }
      Returns Promise<ContractTransaction>
Returns Promise<ContractTransaction>
- Defined in cdp/cdp.adjust.service.ts:228

addCollateral

addCollateral(options): Promise<TransactionStatus>
Add collateral to an existing eBTC CDP
Parameters
- options: AddCollateralOptions
  Add collateral transaction parameters
Returns Promise<TransactionStatus>
Transaction status of submitted add collateral operation
- Defined in cdp/cdp.adjust.service.ts:109

adjustCdp

adjustCdp(options): Promise<TransactionStatus>
Adjust an existing eBTC CDP by adding collateral and/or withdrawing debt
Parameters
- options: AdjustCdpOptions
  Adjust position transaction parameters
Returns Promise<TransactionStatus>
Transaction status of submitted adjust position operation
- Defined in cdp/cdp.adjust.service.ts:52

adjustCdpWithHelper

adjustCdpWithHelper(options): Promise<TransactionStatus>
Adjust an existing eBTC CDP by adding collateral and/or withdrawing debt
Parameters
- options: AdjustCdpWithHelperOptions
  Adjust position transaction parameters
Returns Promise<TransactionStatus>
Transaction status of submitted adjust position operation
- Defined in cdp/cdp.adjust.service.ts:82

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

repay

repay(options): Promise<TransactionStatus>
Repay an open eBTC CDP
Parameters
- options: RepayOptions
  Repay transaction parameters
Returns Promise<TransactionStatus>
Transaction status of the submitted repay operation
- Defined in cdp/cdp.adjust.service.ts:137

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>
Withdraw debt from an existing eBTC CDP
Parameters
- options: WithdrawOptions
  Withdraw debt parameters
Returns Promise<TransactionStatus>
Transaction status for submitted withdraw operation
- Defined in cdp/cdp.adjust.service.ts:151

withdrawCollateral

withdrawCollateral(options): Promise<TransactionStatus>
Withdraw collateral from an existing eBTC CDP
Parameters
- options: WithdrawCollateralOptions
  Withdraw collateral transaction parameters
Returns Promise<TransactionStatus>
Transaction status of submitted withdraw collateral operation
- Defined in cdp/cdp.adjust.service.ts:123

zapAddCollateralWithETH

zapAddCollateralWithETH(options): Promise<TransactionStatus>
Add collateral to an existing eBTC CDP with ETH
Parameters
- options: ZapAddCollateralOptions
  Add collateral transaction parameters
Returns Promise<TransactionStatus>
Transaction status of submitted add collateral operation
- Defined in cdp/cdp.adjust.service.ts:446

zapAdjustCdp

zapAdjustCdp(options): Promise<TransactionStatus>
Adjust an existing eBTC CDP by adding collateral and/or withdrawing debt with stETH
Parameters
- options: ZapAdjustCdpOptions
  Adjust position transaction parameters
Returns Promise<TransactionStatus>
Transaction status of submitted adjust position operation
- Defined in cdp/cdp.adjust.service.ts:351

zapAdjustCdpWithETH

zapAdjustCdpWithETH(options): Promise<TransactionStatus>
Adjust an existing eBTC CDP by adding collateral and/or withdrawing debt with ETH
Parameters
- options: ZapAdjustCdpOptions
  Adjust position transaction parameters
Returns Promise<TransactionStatus>
Transaction status of submitted adjust position operation
- Defined in cdp/cdp.adjust.service.ts:373

zapAdjustCdpWithWETH

zapAdjustCdpWithWETH(options): Promise<TransactionStatus>
Adjust an existing eBTC CDP by adding collateral and/or withdrawing debt with Wrapped ETH
Parameters
- options: ZapAdjustCdpOptions
  Adjust position transaction parameters
Returns Promise<TransactionStatus>
Transaction status of submitted adjust position operation
- Defined in cdp/cdp.adjust.service.ts:397

zapAdjustCdpWithWstETH

zapAdjustCdpWithWstETH(options): Promise<TransactionStatus>
Adjust an existing eBTC CDP by adding collateral and/or withdrawing debt with Wrapped stETH
Parameters
- options: ZapAdjustCdpOptions
  Adjust position transaction parameters
Returns Promise<TransactionStatus>
Transaction status of submitted adjust position operation
- Defined in cdp/cdp.adjust.service.ts:420

zapDepositETH

zapDepositETH(options): Promise<TransactionStatus>
Deposits ETH into a CDP using the Zap protocol.
Parameters
- options: ZapDepositOptions
  The options for the Zap adjustment.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.adjust.service.ts:595

zapDepositStETH

zapDepositStETH(options): Promise<TransactionStatus>
Deposits stETH into a CDP using the Zap protocol.
Parameters
- options: ZapDepositOptions
  The options for adjusting the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to the transaction status.
- Defined in cdp/cdp.adjust.service.ts:471

zapDepositWETH

zapDepositWETH(options): Promise<TransactionStatus>
Deposits WETH into the CDP and adjusts the collateral.
Parameters
- options: ZapDepositOptions
  The options for the zap adjustment.
Returns Promise<TransactionStatus>
A promise that resolves to the transaction status.
- Defined in cdp/cdp.adjust.service.ts:554

zapDepositWstETH

zapDepositWstETH(options): Promise<TransactionStatus>
Deposits WST-ETH into a CDP using the Zap protocol.
Parameters
- options: ZapDepositOptions
  The options for adjusting the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.adjust.service.ts:513

zapLeverageAdjustCdp

zapLeverageAdjustCdp(options): Promise<TransactionStatus>
Adjusts the leverage of a CDP using the Zap Leverage Router.
Parameters
- options: ZapLeverageAdjustCdpOptions
  The options for adjusting the leverage of the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.adjust.service.ts:362

zapLeverageAdjustCdpWithETH

zapLeverageAdjustCdpWithETH(options): Promise<TransactionStatus>
Adjusts the leverage of a CDP (Collateralized Debt Position) using ETH (Ethereum).
Parameters
- options: ZapLeverageAdjustCdpOptions
  The options for adjusting the leverage of the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object representing the status of the transaction.
- Defined in cdp/cdp.adjust.service.ts:385

zapLeverageAdjustCdpWithWETH

zapLeverageAdjustCdpWithWETH(options): Promise<TransactionStatus>
Adjusts the leverage of a CDP (Collateralized Debt Position) by zapping with Wrapped Ether (WETH).
Parameters
- options: ZapLeverageAdjustCdpOptions
  The options for adjusting the CDP leverage.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.adjust.service.ts:408

zapLeverageAdjustCdpWithWstETH

zapLeverageAdjustCdpWithWstETH(options): Promise<TransactionStatus>
Adjusts the leverage of a CDP (Collateralized Debt Position) using WstETH.
Parameters
- options: ZapLeverageAdjustCdpOptions
  The options for adjusting the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.adjust.service.ts:431

zapLeverageDepositETH

zapLeverageDepositETH(options): Promise<TransactionStatus>
Adjusts the leverage of a CDP by depositing ETH.
Parameters
- options: ZapLeverageAdjustCdpOptions
  The options for adjusting the CDP leverage.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.adjust.service.ts:617

zapLeverageDepositStETH

zapLeverageDepositStETH(options): Promise<TransactionStatus>
Adjusts the leverage and deposits collateral for a specific CDP using the zapLeverageRouter.
Parameters
- options: ZapLeverageAdjustCdpOptions
  The options for adjusting the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.adjust.service.ts:492

zapLeverageDepositWETH

zapLeverageDepositWETH(options): Promise<TransactionStatus>
Adjusts the leverage of a CDP by depositing Wrapped Ether (WETH).
Parameters
- options: ZapLeverageAdjustCdpOptions
  The options for adjusting the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.adjust.service.ts:574

zapLeverageDepositWstETH

zapLeverageDepositWstETH(options): Promise<TransactionStatus>
Adjusts a CDP by depositing collateral using WstETH.
Parameters
- options: ZapLeverageAdjustCdpOptions
  The options for adjusting the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.adjust.service.ts:533

zapLeverageWithdrawStETH

zapLeverageWithdrawStETH(options): Promise<TransactionStatus>
Withdraws leverage from a CDP by adjusting the stETH position.
Parameters
- options: ZapLeverageAdjustCdpOptions
  The options for adjusting the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.adjust.service.ts:659

zapLeverageWithdrawWstETH

zapLeverageWithdrawWstETH(options): Promise<TransactionStatus>
Withdraws collateral from a leverage CDP using wstETH.
Parameters
- options: ZapLeverageAdjustCdpOptions
  The options for adjusting the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.adjust.service.ts:701

zapWithdrawStETH

zapWithdrawStETH(options): Promise<TransactionStatus>
Withdraws stETH from a CDP using the Zap protocol.
Parameters
- options: ZapWithdrawOptions
  The options for withdrawing stETH.
Returns Promise<TransactionStatus>
A promise that resolves to the transaction status.
- Defined in cdp/cdp.adjust.service.ts:639

zapWithdrawWstETH

zapWithdrawWstETH(options): Promise<TransactionStatus>
Withdraws WstETH from a CDP using the Zap protocol.
Parameters
- options: ZapWithdrawOptions
  The options for the Zap adjustment.
Returns Promise<TransactionStatus>
A promise that resolves to the transaction status.
- Defined in cdp/cdp.adjust.service.ts:681

Class CdpAdjustService

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

eBTC: eBTC

cdpService: CdpService

sharedServices: { borrowerOperations: BorrowerOperations; zapLeverageRouter: ZapLeverageRouter; zapRouter: ZapRouter; }

borrowerOperations: BorrowerOperations

zapLeverageRouter: ZapLeverageRouter

zapRouter: ZapRouter

Returns CdpAdjustService

Properties

Private borrowerOperations

Private cdp

level

Protected sdk

Private zapLeverageRouter

Private zapRouter

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 _getAdjustCdpParams

Parameters

__namedParameters: { collValue: BigNumber; debtChange: BigNumber; flashLoanAmount: BigNumber; lowerHint: BytesLike; marginBalance: BigNumber; upperHint: BytesLike; useWstETHForDecrease: boolean; }

collValue: BigNumber

debtChange: BigNumber

flashLoanAmount: BigNumber

lowerHint: BytesLike

marginBalance: BigNumber

upperHint: BytesLike

useWstETHForDecrease: boolean

Returns AdjustCdpParamsStruct

Private _zapAdjustCdpCommonLogic

Parameters

options: ZapAdjustCdpOptions

adjustCdpMethod: ((cdpId, stEthBalanceDecrease, debtChange, isDebtIncrease, upperHint, lowerHint, stEthBalanceIncrease, useWstETHForDecrease, positionManagerPermit, overrides?) => Promise<ContractTransaction>)

Parameters

cdpId: BytesLike

stEthBalanceDecrease: BigNumberish

debtChange: BigNumberish

isDebtIncrease: boolean

upperHint: BytesLike

lowerHint: BytesLike

stEthBalanceIncrease: BigNumberish

useWstETHForDecrease: boolean

positionManagerPermit: PositionManagerPermitStruct

Optional overrides: Overrides & { from?: string; }

Returns Promise<ContractTransaction>

isWithEth: boolean = false

Returns Promise<ContractTransaction>

Private _zapLeverageAdjustCdpCommonLogic

Parameters

options: ZapLeverageAdjustCdpOptions

adjustCdpMethod: ((cdpId, params, positionManagerPermit, tradeData, overrides?) => Promise<ContractTransaction>)

Parameters

cdpId: BytesLike

params: AdjustCdpParamsStruct

positionManagerPermit: BytesLike

tradeData: TradeDataStruct

Optional overrides: Overrides & { from?: string; }

Returns Promise<ContractTransaction>

sharedServices: {
borrowerOperations: BorrowerOperations;
zapLeverageRouter: ZapLeverageRouter;
zapRouter: ZapRouter;
}

`Private` borrowerOperations

`Private` cdp

`Protected` sdk

`Private` zapLeverageRouter

`Private` zapRouter

`Private` #_log

`Optional` message: any

`Rest` ...optionalParams: any[]

`Private` _getAdjustCdpParams

__namedParameters: {
collValue: BigNumber;
debtChange: BigNumber;
flashLoanAmount: BigNumber;
lowerHint: BytesLike;
marginBalance: BigNumber;
upperHint: BytesLike;
useWstETHForDecrease: boolean;
}

`Private` _zapAdjustCdpCommonLogic

`Optional` overrides: Overrides & {
from?: string;
}

`Private` _zapLeverageAdjustCdpCommonLogic

`Optional` overrides: Overrides & {
from?: string;
}

`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[]