aboutsummaryrefslogtreecommitdiffstats
path: root/packages/pipeline/src/parsers/oasis_orders/index.ts
blob: 13997f31b9474fd08804d009349aa74be6de62a2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
import { BigNumber } from '@0x/utils';
import * as R from 'ramda';

import { aggregateOrders } from '../utils';

import { OasisMarket, OasisOrder } from '../../data_sources/oasis';
import { TokenOrderbookSnapshot as TokenOrder } from '../../entities';
import { OrderType } from '../../types';

/**
 * Marque function of this file.
 * 1) Takes in orders from an orderbook,
 * 2) Aggregates them according to price point,
 * 3) Builds TokenOrder entity with other information attached.
 * @param oasisOrderbook A raw orderbook that we pull from the Oasis API.
 * @param oasisMarket An object containing market data also directly from the API.
 * @param observedTimestamp Time at which the orders for the market were pulled.
 * @param source The exchange where these orders are placed. In this case 'oasis'.
 */
export function parseOasisOrders(
    oasisOrderbook: OasisOrder[],
    oasisMarket: OasisMarket,
    observedTimestamp: number,
    source: string,
): TokenOrder[] {
    const aggregatedBids = aggregateOrders(R.filter(R.propEq('act', 'bid'), oasisOrderbook));
    const aggregatedAsks = aggregateOrders(R.filter(R.propEq('act', 'ask'), oasisOrderbook));
    const parsedBids = aggregatedBids.map(order =>
        parseOasisOrder(oasisMarket, observedTimestamp, 'bid', source, order),
    );
    const parsedAsks = aggregatedAsks.map(order =>
        parseOasisOrder(oasisMarket, observedTimestamp, 'ask', source, order),
    );
    return parsedBids.concat(parsedAsks);
}

/**
 * Parse a single aggregated Oasis order to form a tokenOrder entity
 * which can be saved into the database.
 * @param oasisMarket An object containing information about the market where these
 * trades have been placed.
 * @param observedTimestamp The time when the API response returned back to us.
 * @param orderType 'bid' or 'ask' enum.
 * @param source Exchange where these orders were placed.
 * @param oasisOrder A <price, amount> tuple which we will convert to volume-basis.
 */
export function parseOasisOrder(
    oasisMarket: OasisMarket,
    observedTimestamp: number,
    orderType: OrderType,
    source: string,
    oasisOrder: [string, BigNumber],
): TokenOrder {
    const tokenOrder = new TokenOrder();
    const price = new BigNumber(oasisOrder[0]);
    const amount = oasisOrder[1];

    tokenOrder.source = source;
    tokenOrder.observedTimestamp = observedTimestamp;
    tokenOrder.orderType = orderType;
    tokenOrder.price = price;

    tokenOrder.baseAssetSymbol = oasisMarket.base;
    tokenOrder.baseAssetAddress = null; // Oasis doesn't provide address information
    tokenOrder.baseVolume = amount;

    tokenOrder.quoteAssetSymbol = oasisMarket.quote;
    tokenOrder.quoteAssetAddress = null; // Oasis doesn't provide address information
    tokenOrder.quoteVolume = price.times(amount);
    return tokenOrder;
}