Class PriceService

Service exposing functions to interface with an eBTC incentive rewards.

Hierarchy

Constructors

constructor

Properties

_btcUsdChainlinkOracle? _ebtcFeed? _stEth? _stEthUsdChainlinkOracle? level sdk

Accessors

address btcUsdChainlinkOracle connector ebtcFeed provider signer stEth stEthUsdChainlinkOracle

Methods

#_log debug error fetchStEthBtcRatio getLatestRoundBtcUsdPrice getLatestRoundStEthUsdPrice getStEthSharesToBalanceRatio info log ready submitAction warn

Constructors

constructor

Properties

Private Optional _btcUsdChainlinkOracle

_btcUsdChainlinkOracle?: ChainlinkAggregator

Private Optional _ebtcFeed

_ebtcFeed?: EbtcFeed

Private Optional _stEth

_stEth?: Steth

Private Optional _stEthUsdChainlinkOracle

_stEthUsdChainlinkOracle?: ChainlinkAggregator

level

level: LogLevel

Protected sdk

sdk: eBTC

Accessors

address

  • get address(): undefined | string

  • Returns undefined | string

btcUsdChainlinkOracle

connector

  • get connector(): Signer | MulticallProvider

  • Returns Signer | MulticallProvider

ebtcFeed

provider

  • get provider(): MulticallProvider

  • Returns MulticallProvider

signer

  • get signer(): undefined | Signer

  • Returns undefined | Signer

stEth

stEthUsdChainlinkOracle

Methods

Private #_log

  • #_log(level, message?, ...optionalParams): void

  • Parameters

    • level: LogLevel
    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

debug

  • debug(message?, ...optionalParams): void

  • Parameters

    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

error

  • error(message?, ...optionalParams): void

  • Parameters

    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

fetchStEthBtcRatio

  • fetchStEthBtcRatio(overrides?): Promise<BigNumber>

  • Retrieves the most up to date stETH/BTC ratio from the eBTC Price Feed. This is the price of 1 stETH in BTC. e.g. 1 stETH = 0.05300524643 BTC (~march 2024) will return 0.05300524643

    Parameters

    • Optional overrides: Overrides

      ethers overrides

    Returns Promise<BigNumber>

    Current stETH/BTC ratio for the eBTC system in Ether units

getLatestRoundBtcUsdPrice

  • getLatestRoundBtcUsdPrice(overrides?): Promise<BigNumber>

  • Get the latest BTC/USD price from the Chainlink oracle

    Parameters

    • Optional overrides: Overrides

      Chainlink oracle overrides

    Returns Promise<BigNumber>

    Latest BTC/USD price in Ether units

getLatestRoundStEthUsdPrice

  • getLatestRoundStEthUsdPrice(overrides?): Promise<BigNumber>

  • Get the latest stETH/USD price from the Chainlink oracle

    Parameters

    • Optional overrides: Overrides

      Chainlink oracle overrides

    Returns Promise<BigNumber>

    Latest stETH/USD price in Ether units

getStEthSharesToBalanceRatio

  • getStEthSharesToBalanceRatio(): Promise<BigNumber>

  • Returns the current share ratio of stEth. Returns the stEth balance for 1 stEth Share. e.g. 1.2 stEth balance per 1 stEth Share

    Returns Promise<BigNumber>

    Current share to balance ratio of stEth in Ether units

info

  • info(message?, ...optionalParams): void

  • Parameters

    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

log

  • log(message?, ...optionalParams): void

  • Parameters

    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

ready

submitAction

warn

  • warn(message?, ...optionalParams): void

  • Parameters

    • Optional message: any
    • Rest ...optionalParams: any[]

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc