Class CdpOpenService

Hierarchy

Service
- CdpOpenService

Constructors

constructor

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

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

_zapLeverageOpenCdpCommonLogic(options, openCdpMethod, isWithEth?): Promise<ContractTransaction>
Executes the common logic for opening a leveraged CDP with the Zap protocol.
Parameters
- options: ZapLeverageOpenCdpWithHelperOptions
  The options for opening the CDP.
- openCdpMethod: ((debt, upperHint, lowerHint, stEthLoanAmount, erc20MarginAmount, stEthDepositAmount, positionManagerPermit, tradeData, overrides?) => Promise<ContractTransaction>)
  The method for opening the CDP.
  - - (debt, upperHint, lowerHint, stEthLoanAmount, erc20MarginAmount, stEthDepositAmount, positionManagerPermit, tradeData, overrides?): Promise<ContractTransaction>
    - Parameters
      debt: BigNumberish
      upperHint: BytesLike
      lowerHint: BytesLike
      stEthLoanAmount: BigNumberish
      erc20MarginAmount: BigNumberish
      stEthDepositAmount: BigNumberish
      positionManagerPermit: BytesLike
      tradeData: TradeDataStruct
      Optional overrides: Overrides & {
      from?: string;
      }
      Returns Promise<ContractTransaction>
- isWithEth: boolean = false
  Indicates whether the transaction is with ETH.
Returns Promise<ContractTransaction>
A promise that resolves to a ContractTransaction object.

Throws
Error if unable to generate permit.
- Defined in cdp/cdp.open.service.ts:146

`Private` _zapOpenCdpCommonLogic

_zapOpenCdpCommonLogic(options, openCdpMethod, isWithEth?): Promise<ContractTransaction>
Executes the common logic for opening a CDP.
Parameters
- options: ZapOpenCdpWithHelperOptions
  The options for opening the CDP.
- openCdpMethod: ((debt, upperHint, lowerHint, stEthBalance, positionManagerPermit, overrides?) => Promise<ContractTransaction>)
  The helper function for opening the CDP.
  - - (debt, upperHint, lowerHint, stEthBalance, positionManagerPermit, overrides?): Promise<ContractTransaction>
    - Parameters
      debt: BigNumberish
      upperHint: BytesLike
      lowerHint: BytesLike
      stEthBalance: BigNumberish
      positionManagerPermit: PositionManagerPermitStruct
      Optional overrides: Overrides & {
      from?: string;
      }
      Returns Promise<ContractTransaction>
- isWithEth: boolean = false
  Flag to indicate if the transaction includes ETH. Defaults to false.
Returns Promise<ContractTransaction>
A promise that resolves to a ContractTransaction.
- Defined in cdp/cdp.open.service.ts:93

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

open

open(options): Promise<TransactionStatus>
Open a CDP for eBTC
Parameters
- options: OpenCdpOptions
  Open transaction parameters Note: value override must be provided to supply collateral for initial open
Returns Promise<TransactionStatus>
Transaction status of submitted open operation
- Defined in cdp/cdp.open.service.ts:48

openWithHelper

openWithHelper(options): Promise<TransactionStatus>
Open a CDP for eBTC with Hint Helper
Parameters
- options: OpenCdpWithHelperOptions
  Open transaction parameters Note: value override must be provided to supply collateral for initial open
Returns Promise<TransactionStatus>
Transaction status of submitted open operation
- Defined in cdp/cdp.open.service.ts:69

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

zapLeverageOpenCdp

zapLeverageOpenCdp(options): Promise<TransactionStatus>
Zaps leverage to open a CDP (Collateralized Debt Position).
Parameters
- options: ZapLeverageOpenCdpWithHelperOptions
  The options for zapping leverage to open a CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.open.service.ts:230

zapLeverageOpenCdpWithETH

zapLeverageOpenCdpWithETH(options): Promise<TransactionStatus>
Zaps leverage to open a CDP with ETH.
Parameters
- options: ZapLeverageOpenCdpWithHelperOptions
  The options for opening a CDP with ETH.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.open.service.ts:255

zapLeverageOpenCdpWithWETH

zapLeverageOpenCdpWithWETH(options): Promise<TransactionStatus>
Zaps leverage to open a CDP with Wrapped Ether (WETH).
Parameters
- options: ZapLeverageOpenCdpWithHelperOptions
  The options for zapping leverage to open a CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.open.service.ts:280

zapLeverageOpenCdpWithWstETH

zapLeverageOpenCdpWithWstETH(options): Promise<TransactionStatus>
Zaps leverage and opens a CDP with Wrapped stETH (wstETH).
Parameters
- options: ZapLeverageOpenCdpWithHelperOptions
  The options for zapping leverage and opening the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.open.service.ts:305

zapOpenCdp

zapOpenCdp(options): Promise<TransactionStatus>
Open CDP with stETH collateral Note: To use this method, you must first call approve on the zapRouter to authorize it to spend StETH
Parameters
- options: ZapOpenCdpWithHelperOptions
  The options for opening the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.open.service.ts:218

zapOpenCdpWithETH

zapOpenCdpWithETH(options): Promise<TransactionStatus>
Opens a CDP (Collateralized Debt Position) with ETH.
Parameters
- options: ZapOpenCdpWithHelperOptions
  The options for opening the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.open.service.ts:242

zapOpenCdpWithWETH

zapOpenCdpWithWETH(options): Promise<TransactionStatus>
Opens a CDP (Collateralized Debt Position) with wrapped Ether. Note: To use this method, you must first call approve on the zapRouter to authorize it to spend wETH
Parameters
- options: ZapOpenCdpWithHelperOptions
  The options for opening the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.open.service.ts:268

zapOpenCdpWithWstETH

zapOpenCdpWithWstETH(options): Promise<TransactionStatus>
Opens a CDP (Collateralized Debt Position) with wrapped stETH. Note: To use this method, you must first call approve on the zapRouter to authorize it to spend wstETH
Parameters
- options: ZapOpenCdpWithHelperOptions
  The options for opening the CDP.
Returns Promise<TransactionStatus>
A promise that resolves to a TransactionStatus object.
- Defined in cdp/cdp.open.service.ts:293

Class CdpOpenService

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 CdpOpenService

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 _zapLeverageOpenCdpCommonLogic

Parameters

options: ZapLeverageOpenCdpWithHelperOptions

openCdpMethod: ((debt, upperHint, lowerHint, stEthLoanAmount, erc20MarginAmount, stEthDepositAmount, positionManagerPermit, tradeData, overrides?) => Promise<ContractTransaction>)

Parameters

debt: BigNumberish

upperHint: BytesLike

lowerHint: BytesLike

stEthLoanAmount: BigNumberish

erc20MarginAmount: BigNumberish

stEthDepositAmount: BigNumberish

positionManagerPermit: BytesLike

tradeData: TradeDataStruct

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

Returns Promise<ContractTransaction>

isWithEth: boolean = false

Returns Promise<ContractTransaction>

Throws

Private _zapOpenCdpCommonLogic

Parameters

options: ZapOpenCdpWithHelperOptions

openCdpMethod: ((debt, upperHint, lowerHint, stEthBalance, positionManagerPermit, overrides?) => Promise<ContractTransaction>)

Parameters

debt: BigNumberish

upperHint: BytesLike

lowerHint: BytesLike

stEthBalance: BigNumberish

positionManagerPermit: PositionManagerPermitStruct

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

Returns Promise<ContractTransaction>

isWithEth: boolean = false

Returns Promise<ContractTransaction>

debug

Parameters

Optional message: any

Rest ...optionalParams: any[]

Returns void

error

Parameters

Optional message: any

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

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

`Private` _zapOpenCdpCommonLogic

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