improvement: automatically fix incorrect symbols casing in mappers wh…

…en provided by user

src/handy.ts

@@ -451,4 +451,18 @@ if (httpsProxyAgent !== undefined) {
   }
 }
 
+export function upperCaseSymbols(symbols?: string[]) {
+  if (symbols !== undefined) {
+    return symbols.map((s) => s.toUpperCase())
+  }
+  return
+}
+
+export function lowerCaseSymbols(symbols?: string[]) {
+  if (symbols !== undefined) {
+    return symbols.map((s) => s.toLowerCase())
+  }
+  return
+}
+
 export const httpClient = got.extend(gotDefaultOptions)

src/mappers/ascendex.ts

@@ -1,12 +1,14 @@
+import { upperCaseSymbols } from '../handy'
+import { BookChange, BookTicker, DerivativeTicker, Trade } from '../types'
 import { Mapper, PendingTickerInfoHelper } from './mapper'
-import { Trade, BookChange, DerivativeTicker, BookTicker } from '../types'
 
 export class AscendexTradesMapper implements Mapper<'ascendex', Trade> {
   canHandle(message: AscendexTrade) {
     return message.m === 'trades'
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
     return [
       {
         channel: 'trades',
@@ -38,6 +40,7 @@ export class AscendexBookChangeMapper implements Mapper<'ascendex', BookChange>
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
     return [
       {
         channel: 'depth-realtime',
@@ -78,6 +81,7 @@ export class AscendexDerivativeTickerMapper implements Mapper<'ascendex', Deriva
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
     return [
       {
         channel: 'futures-pricing-data',
@@ -120,6 +124,7 @@ export class AscendexBookTickerMapper implements Mapper<'ascendex', BookTicker>
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
     return [
       {
         channel: 'bbo',

src/mappers/binance.ts

@@ -1,6 +1,6 @@
 import { debug } from '../debug'
-import { CircularBuffer } from '../handy'
-import { BookChange, DerivativeTicker, Exchange, FilterForExchange, Liquidation, BookTicker, Trade } from '../types'
+import { CircularBuffer, lowerCaseSymbols } from '../handy'
+import { BookChange, BookTicker, DerivativeTicker, Exchange, FilterForExchange, Liquidation, Trade } from '../types'
 import { Mapper, PendingTickerInfoHelper } from './mapper'
 
 // https://github.com/binance-exchange/binance-official-api-docs/blob/master/web-socket-streams.md
@@ -447,13 +447,6 @@ export class BinanceBookTickerMapper implements Mapper<'binance-futures' | 'bina
   }
 }
 
-function lowerCaseSymbols(symbols?: string[]) {
-  if (symbols !== undefined) {
-    return symbols.map((s) => s.toLowerCase())
-  }
-  return
-}
-
 type BinanceResponse<T> = {
   stream: string
   data: T

src/mappers/binancedex.ts

@@ -1,4 +1,5 @@
-import { BookChange, Trade, BookTicker } from '../types'
+import { upperCaseSymbols } from '../handy'
+import { BookChange, BookTicker, Trade } from '../types'
 import { Mapper } from './mapper'
 
 // https://docs.binance.org/api-reference/dex-api/ws-streams.html
@@ -9,6 +10,8 @@ export const binanceDexTradesMapper: Mapper<'binance-dex', Trade> = {
   },
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'trades',
@@ -46,6 +49,7 @@ export const binanceDexBookChangeMapper: Mapper<'binance-dex', BookChange> = {
   },
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
     return [
       {
         channel: 'depthSnapshot',
@@ -96,6 +100,7 @@ export const binanceDexBookTickerMapper: Mapper<'binance-dex', BookTicker> = {
   },
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
     return [
       {
         channel: 'ticker',

src/mappers/binanceoptions.ts

@@ -1,4 +1,4 @@
-import { asNumberIfValid } from '../handy'
+import { asNumberIfValid, upperCaseSymbols } from '../handy'
 import { BookChange, OptionSummary, Trade } from '../types'
 import { Mapper } from './mapper'
 
@@ -15,6 +15,8 @@ export class BinanceOptionsTradesMapper implements Mapper<'binance-options', Tra
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'TRADE',
@@ -68,6 +70,8 @@ export class BinanceOptionsBookChangeMapper implements Mapper<'binance-options',
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'DEPTH100',
@@ -109,6 +113,8 @@ export class BinanceOptionSummaryMapper implements Mapper<'binance-options', Opt
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     const indexes =
       symbols !== undefined
         ? symbols.map((s) => {

src/mappers/bitfinex.ts

@@ -1,4 +1,5 @@
-import { BookChange, DerivativeTicker, Exchange, FilterForExchange, Liquidation, Trade, BookTicker } from '../types'
+import { upperCaseSymbols } from '../handy'
+import { BookChange, BookTicker, DerivativeTicker, Exchange, FilterForExchange, Liquidation, Trade } from '../types'
 import { Mapper, PendingTickerInfoHelper } from './mapper'
 
 // https://docs.bitfinex.com/v2/docs/ws-general
@@ -33,6 +34,8 @@ export class BitfinexTradesMapper implements Mapper<'bitfinex' | 'bitfinex-deriv
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'trades',
@@ -107,6 +110,8 @@ export class BitfinexBookChangeMapper implements Mapper<'bitfinex' | 'bitfinex-d
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'book',
@@ -187,6 +192,8 @@ export class BitfinexDerivativeTickerMapper implements Mapper<'bitfinex-derivati
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'status',
@@ -345,6 +352,8 @@ export class BitfinexBookTickerMapper implements Mapper<'bitfinex' | 'bitfinex-d
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'ticker',

src/mappers/bitflyer.ts

@@ -1,5 +1,5 @@
-import { parseμs } from '../handy'
-import { BookChange, Trade, BookTicker } from '../types'
+import { parseμs, upperCaseSymbols } from '../handy'
+import { BookChange, BookTicker, Trade } from '../types'
 import { Mapper } from './mapper'
 
 export const bitflyerTradesMapper: Mapper<'bitflyer', Trade> = {
@@ -8,6 +8,8 @@ export const bitflyerTradesMapper: Mapper<'bitflyer', Trade> = {
   },
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'lightning_executions',
@@ -52,6 +54,8 @@ export class BitflyerBookChangeMapper implements Mapper<'bitflyer', BookChange>
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'lightning_board_snapshot',
@@ -97,6 +101,8 @@ export const bitflyerBookTickerMapper: Mapper<'bitflyer', BookTicker> = {
   },
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'lightning_ticker',

src/mappers/bitmex.ts

@@ -1,5 +1,5 @@
-import { asNumberIfValid } from '../handy'
-import { BookChange, BookPriceLevel, DerivativeTicker, FilterForExchange, Liquidation, Trade, BookTicker } from '../types'
+import { asNumberIfValid, upperCaseSymbols } from '../handy'
+import { BookChange, BookPriceLevel, BookTicker, DerivativeTicker, FilterForExchange, Liquidation, Trade } from '../types'
 import { Mapper, PendingTickerInfoHelper } from './mapper'
 
 // https://www.bitmex.com/app/wsAPI
@@ -10,6 +10,8 @@ export const bitmexTradesMapper: Mapper<'bitmex', Trade> = {
   },
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'trade',
@@ -45,6 +47,8 @@ export class BitmexBookChangeMapper implements Mapper<'bitmex', BookChange> {
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'orderBookL2',
@@ -150,6 +154,8 @@ export class BitmexDerivativeTickerMapper implements Mapper<'bitmex', Derivative
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'instrument',
@@ -198,6 +204,8 @@ export const bitmexLiquidationsMapper: Mapper<'bitmex', Liquidation> = {
   },
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'liquidation',
@@ -231,6 +239,8 @@ export const bitmexBookTickerMapper: Mapper<'bitmex', BookTicker> = {
   },
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'quote',

src/mappers/bitstamp.ts

@@ -1,3 +1,4 @@
+import { lowerCaseSymbols } from '../handy'
 import { BookChange, Trade } from '../types'
 import { Mapper } from './mapper'
 
@@ -168,13 +169,6 @@ export class BitstampBookChangeMapper implements Mapper<'bitstamp', BookChange>
   }
 }
 
-function lowerCaseSymbols(symbols?: string[]) {
-  if (symbols !== undefined) {
-    return symbols.map((s) => s.toLowerCase())
-  }
-  return
-}
-
 type BitstampTrade = {
   event: 'trade'
   channel: string

src/mappers/bybit.ts

@@ -1,3 +1,4 @@
+import { upperCaseSymbols } from '../handy'
 import { BookChange, DerivativeTicker, Exchange, Liquidation, Trade } from '../types'
 import { Mapper, PendingTickerInfoHelper } from './mapper'
 
@@ -14,6 +15,8 @@ export class BybitTradesMapper implements Mapper<'bybit', Trade> {
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'trade',
@@ -57,6 +60,8 @@ export class BybitBookChangeMapper implements Mapper<'bybit', BookChange> {
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     if (this._canUseBook200Channel) {
       return [
         {
@@ -117,6 +122,8 @@ export class BybitDerivativeTickerMapper implements Mapper<'bybit', DerivativeTi
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'instrument_info',
@@ -190,6 +197,8 @@ export class BybitLiquidationsMapper implements Mapper<'bybit', Liquidation> {
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'liquidation',

src/mappers/coinbase.ts

@@ -1,6 +1,6 @@
+import { parseμs, upperCaseSymbols } from '../handy'
 import { BookChange, BookPriceLevel, BookTicker, Trade } from '../types'
 import { Mapper } from './mapper'
-import { parseμs } from '../handy'
 
 // https://docs.pro.coinbase.com/#websocket-feed
 
@@ -10,6 +10,8 @@ export const coinbaseTradesMapper: Mapper<'coinbase', Trade> = {
   },
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'match',
@@ -69,6 +71,8 @@ export class CoinbaseBookChangMapper implements Mapper<'coinbase', BookChange> {
   }
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'snapshot',
@@ -128,6 +132,8 @@ export const coinbaseBookTickerMapper: Mapper<'coinbase', BookTicker> = {
   },
 
   getFilters(symbols?: string[]) {
+    symbols = upperCaseSymbols(symbols)
+
     return [
       {
         channel: 'ticker',