Class eBTC

constructor

• new eBTC(__namedParameters): eBTC

• Parameters

  • __namedParameters: SDKOptions

  Returns eBTC

Optional address

Optional addresses

Readonly calculations

Readonly cdp

chainId

Readonly graph

logLevel

Readonly price

provider

Readonly rewards

Optional signer

Readonly token

Optional zeroXApiKey

batchLiquidateCdps

• batchLiquidateCdps(options): Promise<TransactionStatus>

• Batch liquidate troves in the system

  Parameters

  • options: BatchLiquidateOptions

    Batch liquidate override options

  Returns Promise<TransactionStatus>

  Transaction status of the batch liquidate transaction

claimSurplusCollateral

• claimSurplusCollateral(options): Promise<TransactionStatus>

• Claim collateral from the surplus pool through Borrower Operations

  Parameters

  • options: PayableOptions

    Claim Surplus parameters

  Returns Promise<TransactionStatus>

  Transaction status of the claim transaction

claimTestnetCollateral

• claimTestnetCollateral(options): Promise<TransactionStatus>

• Claims testnet collateral to open positions on the testnet. This is for the tesnet only and will revert if called on mainnet.

  Parameters

  • options: ClaimTestCollateralOptions

    ClaimTestCollateralOptions options

  Returns Promise<TransactionStatus>

  Transaction status of the liquidate transaction

fetchPrice

• fetchPrice(overrides?): Promise<BigNumber>

• Parameters

  • Optional overrides: Overrides

    Current price read overrides

  Returns Promise<BigNumber>

  Current price registered with system oracle in Ether units

  Deprecated

  Use PriceService instead. Retrieve current price from oracle

getClaimableSurplusCollateral

• getClaimableSurplusCollateral(account, overrides?): Promise<BigNumber>

• Check how much collateral can be claimed from the surplus pool for a given account

  Parameters

  • account: string

    Address of the account to check

  • Optional overrides: Overrides

    Claim overrides

  Returns Promise<BigNumber>

  Amount of collateral that can be claimed in Ether units

getContractAddresses

• getContractAddresses(chainId): undefined | NetworkContracts

• Gives the address of the eBTC contract for the given chainId

  Parameters

  • chainId: number

    Chain ID of the network

  Returns undefined | NetworkContracts

  Addresses for the eBTC contracts

getGasCompensation

• getGasCompensation(overrides?): Promise<BigNumber>

• Retrieve the eBTC gas compensation

  Parameters

  • Optional overrides: Overrides

    eBTC gas compensation overrides

  Returns Promise<BigNumber>

  Amount required for deposit for gas compensation

getLatestStETHPrice

• getLatestStETHPrice(overrides?): Promise<BigNumber>

• Parameters

  • Optional overrides: Overrides

    Chainlink oracle overrides

  Returns Promise<BigNumber>

  Latest stETH/USD price in an 8 decimal BigNumber

  Deprecated

  Use PriceService instead. Get the latest stETH/USD price from the Chainlink oracle

getMulticallProvider

• getMulticallProvider(provider): MulticallProvider

• Parameters

  • provider: SDKProvider

  Returns MulticallProvider

getStETHSharePrice

• getStETHSharePrice(): Promise<BigNumber>

• Returns Promise<BigNumber>

  Current share price of stEth in Ether units

  Deprecated

  Use PriceService instead. Returns the current share price of stEth

getTotalClaimableSurplusCollateral

• getTotalClaimableSurplusCollateral(overrides?): Promise<BigNumber>

• Check how much collateral can be claimed in the system as a whole

  Parameters

  • Optional overrides: Overrides

    Claim overrides

  Returns Promise<BigNumber>

  Amount of collateral that can be claimed in the system as a 18 decimal BigNumber

isInRecoveryMode

• isInRecoveryMode(overrides?): Promise<boolean>

• Returns true if the system is currently in recovery mode for the current price

  Parameters

  • Optional overrides: Overrides

    overrides

  Returns Promise<boolean>

  True if the system is in recovery mode

liquidate

• liquidate(options): Promise<TransactionStatus>

• Liquidate specific CDP id

  Parameters

  • options: LiquidateOptions

    Liquidate override options

  Returns Promise<TransactionStatus>

  Transaction status of the liquidate transaction

ready

• ready(): Promise<void>

• Prepare the SDK services for use.

  Returns Promise<void>

redeemCollateral

• redeemCollateral(options): Promise<TransactionStatus>

• Redeem outstanding eBTC for deposited Ethereum

  Parameters

  • options: RedeemCollateralOptions

    Redeem collateral override options

  Returns Promise<TransactionStatus>

  Transaction status of the redemption transaction

redeemCollateralWithHelper

• redeemCollateralWithHelper(options): Promise<TransactionStatus>

• Redeem outstanding eBTC for deposited Ethereum https://github.com/liquity/dev/blob/main/packages/contracts/utils/hintExamples.js#L88-L116

  Parameters

  • options: RedeemCollateralHelperOptions

    Redeem collateral override options

  Returns Promise<TransactionStatus>

  Transaction status of the redemption transaction