44 lines
846 B
TypeScript
44 lines
846 B
TypeScript
/**
|
|
* Pricecaster Service.
|
|
*
|
|
* Fetcher backend component.
|
|
*
|
|
* (c) 2021 Randlabs, Inc.
|
|
*/
|
|
|
|
import { PriceTicker } from '../common/priceTicker'
|
|
|
|
/**
|
|
* Implements a strategy for obtaining an asset price from
|
|
* a set of received prices in a buffer.
|
|
*/
|
|
export interface IStrategy {
|
|
/**
|
|
*
|
|
* @param size The size of the buffer
|
|
*/
|
|
createBuffer(size: number): void
|
|
|
|
/**
|
|
* Clear price buffer
|
|
*/
|
|
clearBuffer(): void
|
|
|
|
/**
|
|
* Returns the current number of items in buffer
|
|
*/
|
|
bufferCount(): number
|
|
|
|
/**
|
|
* Put a new price in buffer.
|
|
* @param priceData The price data to put
|
|
* @returns true if successful.
|
|
*/
|
|
put(ticker: PriceTicker): boolean
|
|
|
|
/**
|
|
* Get the calculated price according to selected strategy.
|
|
*/
|
|
getPrice(): PriceTicker | undefined
|
|
}
|