aboutsummaryrefslogtreecommitdiffstats
path: root/packages/connect/src/ws_orderbook_channel.ts
blob: 01aaf4fd28ef4303020d4bff3034c6e9f1d0a968 (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
import * as _ from 'lodash';
import * as WebSocket from 'websocket';

import {
    OrderbookChannel,
    OrderbookChannelHandler,
    OrderbookChannelMessageTypes,
    OrderbookChannelSubscriptionOpts,
    WebsocketClientEventType,
    WebsocketConnectionEventType,
} from './types';
import { assert } from './utils/assert';
import { orderbookChannelMessageParser } from './utils/orderbook_channel_message_parser';

/**
 * This class includes all the functionality related to interacting with a websocket endpoint
 * that implements the standard relayer API v0
 */
export class WebSocketOrderbookChannel implements OrderbookChannel {
    private _client: WebSocket.w3cwebsocket;
    private _handler: OrderbookChannelHandler;
    private _subscriptionOptsList: OrderbookChannelSubscriptionOpts[] = [];
    /**
     * Instantiates a new WebSocketOrderbookChannel instance
     * @param   client               A WebSocket client
     * @param   handler              An OrderbookChannelHandler instance that responds to various
     *                               channel updates
     * @return  An instance of WebSocketOrderbookChannel
     */
    constructor(client: WebSocket.w3cwebsocket, handler: OrderbookChannelHandler) {
        assert.isOrderbookChannelHandler('handler', handler);
        // set private members
        this._client = client;
        this._handler = handler;
        // attach client callbacks
        this._client.onerror = err => {
            this._handler.onError(this, err);
        };
        this._client.onclose = () => {
            this._handler.onClose(this);
        };
        this._client.onmessage = message => {
            this._handleWebSocketMessage(message);
        };
    }
    /**
     * Subscribe to orderbook snapshots and updates from the websocket
     * @param   subscriptionOpts     An OrderbookChannelSubscriptionOpts instance describing which
     *                               token pair to subscribe to
     */
    public subscribe(subscriptionOpts: OrderbookChannelSubscriptionOpts): void {
        assert.isOrderbookChannelSubscriptionOpts('subscriptionOpts', subscriptionOpts);
        assert.assert(this._client.readyState === WebSocket.w3cwebsocket.OPEN, 'WebSocket connection is closed');
        this._subscriptionOptsList.push(subscriptionOpts);
        // TODO: update requestId management to use UUIDs for v2
        const subscribeMessage = {
            type: 'subscribe',
            channel: 'orderbook',
            requestId: this._subscriptionOptsList.length - 1,
            payload: subscriptionOpts,
        };
        this._client.send(JSON.stringify(subscribeMessage));
    }
    /**
     * Close the websocket and stop receiving updates
     */
    public close(): void {
        this._client.close();
    }
    private _handleWebSocketMessage(message: any): void {
        // if we get a message with no data, alert all handlers and return
        if (_.isUndefined(message.data)) {
            this._handler.onError(this, new Error(`Message does not contain utf8Data`));
            return;
        }
        // try to parse the message data and route it to the correct handler
        try {
            const utf8Data = message.data;
            const parserResult = orderbookChannelMessageParser.parse(utf8Data);
            const subscriptionOpts = this._subscriptionOptsList[parserResult.requestId];
            if (_.isUndefined(subscriptionOpts)) {
                this._handler.onError(this, new Error(`Message has unknown requestId: ${utf8Data}`));
                return;
            }
            switch (parserResult.type) {
                case OrderbookChannelMessageTypes.Snapshot: {
                    this._handler.onSnapshot(this, subscriptionOpts, parserResult.payload);
                    break;
                }
                case OrderbookChannelMessageTypes.Update: {
                    this._handler.onUpdate(this, subscriptionOpts, parserResult.payload);
                    break;
                }
                default: {
                    this._handler.onError(this, new Error(`Message has unknown type parameter: ${utf8Data}`));
                }
            }
        } catch (error) {
            this._handler.onError(this, error);
        }
    }
}