Gate JavaScript SDK

1/* eslint-disable @typescript-eslint/no-unused-vars */2import { LogParams, WebsocketClient, WsTopicRequest } from 'gateio-api';3 4// eslint-disable-next-line @typescript-eslint/no-unused-vars5const account = {6  key: process.env.API_KEY || 'apiKeyHere',7  secret: process.env.API_SECRET || 'apiSecretHere',8};9 10// Define a custom logger object to handle logging at different levels11const customLogger = {12  // Trace level logging: used for detailed debugging information13  trace: (...params: LogParams): void => {14    // Uncomment the line below to enable trace logging15    // console.log(new Date(), 'trace', ...params);16  },17  // Info level logging: used for general informational messages18  info: (...params: LogParams): void => {19    console.log(new Date(), 'info', ...params);20  },21  // Error level logging: used for error messages22  error: (...params: LogParams): void => {23    console.error(new Date(), 'error', ...params);24  },25};26 27async function start() {28  const client = new WebsocketClient(29    {30      apiKey: account.key,31      apiSecret: account.secret,32    },33    customLogger,34  );35 36  // console.log('auth with: ', account);37  client.on('open', (data) => {38    console.log('connected ', data?.wsKey);39  });40 41  // Data received42  client.on('update', (data) => {43    console.info('data received: ', JSON.stringify(data));44  });45 46  // Something happened, attempting to reconnect47  client.on('reconnect', (data) => {48    console.log('reconnect: ', data);49  });50 51  // Reconnect successful52  client.on('reconnected', (data) => {53    console.log('reconnected: ', data);54  });55 56  // Connection closed. If unexpected, expect reconnect -> reconnected.57  client.on('close', (data) => {58    console.error('close: ', data);59  });60 61  // Reply to a request, e.g. "subscribe"/"unsubscribe"/"authenticate"62  client.on('response', (data) => {63    console.info('server reply: ', JSON.stringify(data), '\n');64  });65 66  client.on('exception', (data) => {67    console.error('exception: ', data);68  });69 70  client.on('authenticated', (data) => {71    console.error('authenticated: ', data);72  });73 74  try {75    // client.subscribe(topics, 'spotV4');76 77    const topicWithoutParamsAsString = 'spot.balances';78 79    // This has the same effect as above, it's just a different way of messaging which topic this is for80    // const topicWithoutParamsAsObject: WsTopicRequest = {81    //   topic: 'spot.balances',82    // };83 84    const userOrders: WsTopicRequest = {85      topic: 'spot.orders',86      payload: ['BTC_USDT', 'ETH_USDT', 'MATIC_USDT'],87    };88 89    const userTrades: WsTopicRequest = {90      topic: 'spot.usertrades',91      payload: ['BTC_USDT', 'ETH_USDT', 'MATIC_USDT'],92    };93 94    const userPriceOrders: WsTopicRequest = {95      topic: 'spot.priceorders',96      payload: ['!all'],97    };98 99    /**100     * Either send one topic (with optional params) at a time101     */102    // client.subscribe(topicWithoutParamsAsObject, 'spotV4');103 104    /**105     * Or send multiple topics in a batch (grouped by ws connection (WsKey))106     * You can also use strings for topics that don't have any parameters, even if you mix multiple requests into one function call:107     */108    client.subscribe(109      [topicWithoutParamsAsString, userOrders, userTrades, userPriceOrders],110      'spotV4',111    );112 113    /**114     * You can also subscribe in separate function calls as you wish.115     *116     * Any duplicate requests should get filtered out (e.g. here we subscribed to "spot.balances" twice, but the WS client will filter this out)117     */118    client.subscribe(119      [120        'spot.balances',121        'spot.margin_balances',122        'spot.funding_balances',123        'spot.cross_balances',124      ],125      'spotV4',126    );127  } catch (e) {128    console.error('Req error: ', e);129  }130}131 132start();