Skip to main content

BinancePriceProvider<T>

Defined in: atomiq-sdk/src/prices/providers/BinancePriceProvider.ts:16

Price provider using Binance exchange API

Extends

  • ExchangePriceProvider<T>

Type Parameters

Type Parameter
T extends MultiChain

Constructors

Constructor

new BinancePriceProvider<T>(
coinsMap,
url,
httpRequestTimeout?): BinancePriceProvider<T>;

Defined in: atomiq-sdk/src/prices/providers/BinancePriceProvider.ts:18

Parameters

ParameterTypeDefault value
coinsMapCtorCoinTypes<T>undefined
urlstring"https://api.binance.com/api/v3"
httpRequestTimeout?numberundefined

Returns

BinancePriceProvider<T>

Overrides

ExchangePriceProvider<T>.constructor

Properties

coinsMap

coinsMap: CoinTypes<T> = {};

Defined in: atomiq-sdk/src/prices/abstract/IPriceProvider.ts:42

Inherited from

ExchangePriceProvider.coinsMap

httpRequestTimeout?

optional httpRequestTimeout: number;

Defined in: atomiq-sdk/src/prices/providers/abstract/HttpPriceProvider.ts:7

Inherited from

CoinGeckoPriceProvider.httpRequestTimeout


url

url: string;

Defined in: atomiq-sdk/src/prices/providers/abstract/HttpPriceProvider.ts:6

Inherited from

CoinGeckoPriceProvider.url

Methods

getPrice()

getPrice<C>(
chainIdentifier,
token,
abortSignal?): Promise<bigint>;

Defined in: atomiq-sdk/src/prices/abstract/IPriceProvider.ts:84

Returns coin price in uSat (microSat)

Type Parameters

Type Parameter
C extends string

Parameters

ParameterTypeDescription
chainIdentifierC
tokenstring
abortSignal?AbortSignal

Returns

Promise<bigint>

Throws

if token is not found

Inherited from

ExchangePriceProvider.getPrice

getUsdPrice()

getUsdPrice(abortSignal?): Promise<number>;

Defined in: atomiq-sdk/src/prices/abstract/IPriceProvider.ts:106

Returns coin price in uSat (microSat)

Parameters

ParameterTypeDescription
abortSignal?AbortSignal

Returns

Promise<number>

Throws

if token is not found

Inherited from

ExchangePriceProvider.getUsdPrice

fetchPair()

protected fetchPair(pair, abortSignal?): Promise<number>;

Defined in: atomiq-sdk/src/prices/providers/BinancePriceProvider.ts:25

Parameters

ParameterType
pairstring
abortSignal?AbortSignal

Returns

Promise<number>

Inherit Doc

Overrides

ExchangePriceProvider.fetchPair

fetchPrice()

protected fetchPrice(token, abortSignal?): Promise<bigint>;

Defined in: atomiq-sdk/src/prices/providers/abstract/ExchangePriceProvider.ts:19

Parameters

ParameterType
tokenCoinType
abortSignal?AbortSignal

Returns

Promise<bigint>

Inherit Doc

Inherited from

ExchangePriceProvider.fetchPrice

fetchUsdPrice()

protected fetchUsdPrice(abortSignal?): Promise<number>;

Defined in: atomiq-sdk/src/prices/providers/BinancePriceProvider.ts:38

Parameters

ParameterType
abortSignal?AbortSignal

Returns

Promise<number>

Inherit Doc

Overrides

ExchangePriceProvider.fetchUsdPrice

getDecimals()

protected getDecimals<C>(chainIdentifier, token): number;

Defined in: atomiq-sdk/src/prices/abstract/IPriceProvider.ts:119

Returns the decimal places of the specified token, or -1 if token should be ignored, returns null if token is not found

Type Parameters

Type Parameter
C extends string

Parameters

ParameterTypeDescription
chainIdentifierC
tokenstring

Returns

number

Throws

If token is not found

Inherited from

ExchangePriceProvider.getDecimals