initial commit, add bitget rest api and websockets connector

examples/README.md

@@ -0,0 +1,6 @@
+# Examples
+
+These samples can be executed using `ts-node`:
+```
+ts-node ./examples/rest-spot-public.ts
+```

examples/rest-spot-public.ts

@@ -0,0 +1,16 @@
+import { SpotClient } from '../src/index';
+
+// or
+// import { SpotClient } from 'bitget-api';
+
+const client = new SpotClient();
+
+const symbol = 'BTCUSDT_SPBL';
+
+(async () => {
+  try {
+    console.log('getCandles: ', await client.getCandles(symbol, '1min'));
+  } catch (e) {
+    console.error('request failed: ', e);
+  }
+})();

examples/ws-private.ts

@@ -0,0 +1,73 @@
+import { WebsocketClient, DefaultLogger } from '../src';
+
+// or
+// import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from 'bitget-api';
+
+(async () => {
+  const logger = {
+    ...DefaultLogger,
+    silly: (...params) => console.log('silly', ...params),
+  };
+
+  const API_KEY = process.env.API_KEY_COM;
+  const API_SECRET = process.env.API_SECRET_COM;
+  const API_PASS = process.env.API_PASS_COM;
+
+  const wsClient = new WebsocketClient(
+    {
+      apiKey: API_KEY,
+      apiSecret: API_SECRET,
+      apiPass: API_PASS,
+      // restOptions: {
+      // optionally provide rest options, e.g. to pass through a proxy
+      // },
+    },
+    logger
+  );
+
+  wsClient.on('update', (data) => {
+    console.log('WS raw message received ', data);
+    // console.log('WS raw message received ', JSON.stringify(data, null, 2));
+  });
+
+  wsClient.on('open', (data) => {
+    console.log('WS connection opened:', data.wsKey);
+  });
+  wsClient.on('response', (data) => {
+    console.log('WS response: ', JSON.stringify(data, null, 2));
+  });
+  wsClient.on('reconnect', ({ wsKey }) => {
+    console.log('WS automatically reconnecting.... ', wsKey);
+  });
+  wsClient.on('reconnected', (data) => {
+    console.log('WS reconnected ', data?.wsKey);
+  });
+  // auth happens async after the ws connection opens
+  wsClient.on('authenticated', (data) => {
+    console.log('WS authenticated', data);
+    // wsClient.subscribePublicSpotTickers(['BTCUSDT', 'LTCUSDT']);
+  });
+  wsClient.on('exception', (data) => {
+    console.log('WS error', data);
+  });
+
+  /**
+   * Private account updates
+   */
+
+  // spot private
+  // : account updates
+  // wsClient.subscribeTopic('SPBL', 'account');
+  // : order updates
+  // wsClient.subscribeTopic('SPBL', 'orders');
+
+  // futures private
+  // : account updates
+  // wsClient.subscribeTopic('UMCBL', 'account');
+  // // : position updates
+  // wsClient.subscribeTopic('UMCBL', 'positions');
+  // // : order updates
+  // wsClient.subscribeTopic('UMCBL', 'orders');
+  // // : plan order updates
+  // wsClient.subscribeTopic('UMCBL', 'ordersAlgo');
+})();

examples/ws-public.ts

@@ -0,0 +1,76 @@
+import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from '../src';
+
+// or
+// import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from 'bitget-api';
+
+(async () => {
+  const logger = {
+    ...DefaultLogger,
+    silly: (...params) => console.log('silly', ...params),
+  };
+
+  const wsClient = new WebsocketClient(
+    {
+      // restOptions: {
+      // optionally provide rest options, e.g. to pass through a proxy
+      // },
+    },
+    logger
+  );
+
+  wsClient.on('update', (data) => {
+    console.log('WS raw message received ', data);
+    // console.log('WS raw message received ', JSON.stringify(data, null, 2));
+  });
+
+  wsClient.on('open', (data) => {
+    console.log('WS connection opened:', data.wsKey);
+  });
+  wsClient.on('response', (data) => {
+    console.log('WS response: ', JSON.stringify(data, null, 2));
+  });
+  wsClient.on('reconnect', ({ wsKey }) => {
+    console.log('WS automatically reconnecting.... ', wsKey);
+  });
+  wsClient.on('reconnected', (data) => {
+    console.log('WS reconnected ', data?.wsKey);
+  });
+  wsClient.on('exception', (data) => {
+    console.log('WS error', data);
+  });
+
+  /**
+   * Public events
+   */
+
+  const symbol = 'BTCUSDT';
+
+  // // Spot public
+  // // tickers
+  // wsClient.subscribeTopic('SP', 'ticker', symbol);
+  // // candles
+  // wsClient.subscribeTopic('SP', 'candle1m', symbol);
+  // // orderbook updates
+  wsClient.subscribeTopic('SP', 'books', symbol);
+  // // trades
+  // wsClient.subscribeTopic('SP', 'trade', symbol);
+
+  // // Futures public
+
+  // // tickers
+  // wsClient.subscribeTopic('MC', 'ticker', symbol);
+  // // candles
+  // wsClient.subscribeTopic('MC', 'candle1m', symbol);
+  // // orderbook updates
+  // wsClient.subscribeTopic('MC', 'books', symbol);
+  // // trades
+  // wsClient.subscribeTopic('MC', 'trade', symbol);
+
+  // Topics are tracked per websocket type
+  // Get a list of subscribed topics (e.g. for spot topics) (after a 5 second delay)
+  setTimeout(() => {
+    const publicSpotTopics = wsClient.getWsStore().getTopics(WS_KEY_MAP.spotv1);
+
+    console.log('public spot topics: ', publicSpotTopics);
+  }, 5 * 1000);
+})();