Class PriceFeed

Watches for price updates on the h2so server at oracle.handle.fi, allowing a client to subscribe to price updates.

Hierarchy

PriceFeed

Constructors

constructor

new PriceFeed(options): PriceFeed
Parameters
- options: Options
Returns PriceFeed
- Defined in src/components/h2so/feed.ts:62

Properties

`Private` `Optional` client

client?: w3cwebsocket

`Private` `Optional` clientOpenPromise

clientOpenPromise?: Promise<void>

`Private` connectionId

connectionId: number = 0

`Private` feed

feed: PairMap<TimestampedPrice> = {}

`Private` `Optional` internalErrorCallback

internalErrorCallback?: ErrorCallback

`Private` internalPriceCallbacks

internalPriceCallbacks: PriceCallback[] = []

`Private` isConnecting

isConnecting: boolean = false

`Private` localSubscriptions

localSubscriptions: (null | LocalSubscription)[] = []

Subscriptions from local users.

`Private` options

options: Options

`Private` remoteSubscriptions

remoteSubscriptions: SubscriptionPair[] = []

Subscriptions to the remote server.

`Private` `Optional` userErrorCallback

userErrorCallback?: ErrorCallback

Accessors

isConnected

get isConnected(): undefined | boolean
Returns undefined | boolean
- Defined in src/components/h2so/feed.ts:308

`Private` websocketUrl

get websocketUrl(): string
Returns string
- Defined in src/components/h2so/feed.ts:72

Methods

close

close(): void
Returns void
- Defined in src/components/h2so/feed.ts:173

connect

connect(reconnectDelayMillis?): Promise<void>
Parameters
- reconnectDelayMillis: number = RECONNECT_DELAY
Returns Promise<void>
- Defined in src/components/h2so/feed.ts:80

connectPersisting

connectPersisting(maxAttempts?, reconnectDelayMillis?): Promise<void>
Parameters
- maxAttempts: number = MAX_RECONNECT_ATTEMPTS
- reconnectDelayMillis: number = RECONNECT_DELAY
Returns Promise<void>
- Defined in src/components/h2so/feed.ts:148

fetchPrice

fetchPrice(pair): Promise<BigNumber>
Parameters
- pair: Pair
Returns Promise<BigNumber>
- Defined in src/components/h2so/feed.ts:367

fetchPrices

fetchPrices(pairs): Promise<Record<string, undefined | BigNumber>>
Parameters
- pairs: Pair[]
Returns Promise<Record<string, undefined | BigNumber>>
- Defined in src/components/h2so/feed.ts:345

getLatestPrice

getLatestPrice(pair): BigNumber
Parameters
- pair: Pair
Returns BigNumber
- Defined in src/components/h2so/feed.ts:441

getPrice

getPrice(pair): Promise<BigNumber>
Parameters
- pair: Pair
Returns Promise<BigNumber>
- Defined in src/components/h2so/feed.ts:314

getPriceSync

getPriceSync(pair): undefined | BigNumber
Gets a (nullable) price from the feed, and does not subscribe to the pair if missing.
Parameters
- pair: Pair
Returns undefined | BigNumber
- Defined in src/components/h2so/feed.ts:328

`Private` handleMessage

handleMessage(message): void
Parameters
- message: IMessageEvent
Returns void
- Defined in src/components/h2so/feed.ts:186

`Private` handlePrice

handlePrice(pair, price, timestamp): void
Parameters
- pair: Pair
- price: BigNumber
- timestamp: number
Returns void
- Defined in src/components/h2so/feed.ts:195

`Private` isNewSubscription

isNewSubscription(subscription): boolean
Parameters
- subscription: SubscriptionPair
Returns boolean
- Defined in src/components/h2so/feed.ts:267

`Private` isSubscribedToPairLocal

isSubscribedToPairLocal(pair): boolean
Parameters
- pair: Pair
Returns boolean
- Defined in src/components/h2so/feed.ts:430

onError

onError(callback): void
Parameters
- callback: ((error) => void)
  - - (error): void
    - Parameters
      
      error: Error
      
      Returns void
Returns void
- Defined in src/components/h2so/feed.ts:181

`Private` publishPriceUpdate

publishPriceUpdate(data): void
Parameters
- data: WebsocketPrice
Returns void
- Defined in src/components/h2so/feed.ts:449

`Private` removeOldSubscriptions

removeOldSubscriptions(): void
Returns void
- Defined in src/components/h2so/feed.ts:332

setOptions

setOptions(options): void
Parameters
- options: Options
Returns void
- Defined in src/components/h2so/feed.ts:76

`Private` setupConnection

setupConnection(reconnectDelayMillis?): Promise<void>
Parameters
- reconnectDelayMillis: number = RECONNECT_DELAY
Returns Promise<void>
- Defined in src/components/h2so/feed.ts:98

subscribe(pairs, callback, shouldSendExistingPrice?): number
Subscribes to the H2SO feed.
Parameters
- pairs: Pair[]
  
  Pairs to subscribe to.
- callback: SubscriptionCallback
  
  Callback for receiving updates.
- shouldSendExistingPrice: boolean = true
  
  Whether to immediately call the callback with an exiting price, if available. If this is set to false, the callback will only be called when a remote price update is received.
Returns number
- Defined in src/components/h2so/feed.ts:385

`Private` subscribeRemote

subscribeRemote(pairs): Promise<void>
Subscribes to price updates from the remote server. Only returns when the prices have been received.
Parameters
- pairs: Pair[]
Returns Promise<void>
- Defined in src/components/h2so/feed.ts:215

unsubscribe

unsubscribe(id): void
Parameters
- id: number
Returns void
- Defined in src/components/h2so/feed.ts:411

`Private` unsubscribeRemote

unsubscribeRemote(pairs): void
Unsubscribes from price updates from the remote server.
Parameters
- pairs: Pair[]
Returns void
- Defined in src/components/h2so/feed.ts:278

waitForConnection

waitForConnection(): Promise<void>
Returns Promise<void>
- Defined in src/components/h2so/feed.ts:304

waitForPrice

waitForPrice(pair, shouldReturnExisting?, timeoutMillis?): Promise<TimestampedPrice>
Parameters
- pair: Pair
- shouldReturnExisting: boolean = false
- timeoutMillis: number = 15_000
Returns Promise<TimestampedPrice>
- Defined in src/components/h2so/feed.ts:460

Class PriceFeed

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: Options

Returns PriceFeed

Properties

Private Optional client

Private Optional clientOpenPromise

Private connectionId

Private feed

Private Optional internalErrorCallback

Private internalPriceCallbacks

Private isConnecting

Private localSubscriptions

Private options

Private remoteSubscriptions

Private Optional userErrorCallback

Accessors

isConnected

Returns undefined | boolean

Private websocketUrl

Returns string

Methods

close

Returns void

connect

Parameters

reconnectDelayMillis: number = RECONNECT_DELAY

Returns Promise<void>

connectPersisting

Parameters

maxAttempts: number = MAX_RECONNECT_ATTEMPTS

reconnectDelayMillis: number = RECONNECT_DELAY

Returns Promise<void>

fetchPrice

Parameters

pair: Pair

Returns Promise<BigNumber>

fetchPrices

Parameters

pairs: Pair[]

Returns Promise<Record<string, undefined | BigNumber>>

getLatestPrice

Parameters

pair: Pair

Returns BigNumber

getPrice

Parameters

pair: Pair

Returns Promise<BigNumber>

getPriceSync

Parameters

pair: Pair

Returns undefined | BigNumber

Private handleMessage

Parameters

message: IMessageEvent

Returns void

Private handlePrice

Parameters

pair: Pair

price: BigNumber

timestamp: number

Returns void

Private isNewSubscription

Parameters

subscription: SubscriptionPair

Returns boolean

Private isSubscribedToPairLocal

Parameters

pair: Pair

Returns boolean

onError

`Private` `Optional` client

`Private` `Optional` clientOpenPromise

`Private` connectionId

`Private` feed

`Private` `Optional` internalErrorCallback

`Private` internalPriceCallbacks

`Private` isConnecting

`Private` localSubscriptions

`Private` options

`Private` remoteSubscriptions

`Private` `Optional` userErrorCallback

`Private` websocketUrl

`Private` handleMessage

`Private` handlePrice

`Private` isNewSubscription

`Private` isSubscribedToPairLocal

`Private` publishPriceUpdate

`Private` removeOldSubscriptions

`Private` setupConnection

`Private` subscribeRemote

`Private` unsubscribeRemote