@paraswap/dex-lib 3.10.3 → 3.11.0-bebop

package/src/dex/bebop/bebop.ts

@@ -120,7 +120,7 @@ export class Bebop extends SimpleExchange implements IDex<BebopData> {
           pricesReqParams: {
             url:
               BEBOP_WS_API_URL +
-              `/pmm/${BebopConfig['Bebop'][network].chainName}/v3/pricing`,
+              `/pmm/${BebopConfig['Bebop'][network].chainName}/v3/pricing?format=protobuf`,
             headers: {
               name: BEBOP_AUTH_NAME,
               authorization: this.bebopAuthToken,

package/src/dex/bebop/config.ts

@@ -33,5 +33,10 @@ export const BebopConfig: DexConfigMap<DexParams> = {
       chainName: 'optimism',
       middleTokens: ['0x7F5c764cBc14f9669B88837ca1490cCa17c31607'],
     },
+    [Network.BSC]: {
+      settlementAddress: '0xbbbbbBB520d69a9775E85b458C58c648259FAD5F',
+      chainName: 'bsc',
+      middleTokens: ['0x55d398326f99059fF775485246999027B3197955'],
+    },
   },
 };

package/src/dex/bebop/rate-fetcher.ts

@@ -1,15 +1,30 @@
 import { ETHER_ADDRESS, Network } from '../../constants';
 import { IDexHelper } from '../../dex-helper';
 import { Fetcher } from '../../lib/fetcher/fetcher';
-import { validateAndCast } from '../../lib/validators';
+import { validateAndCast, ValidationError } from '../../lib/validators';
 import { Logger, Token } from '../../types';
 import {
+  BebopLevel,
+  BebopPair,
   BebopPricingResponse,
   BebopRateFetcherConfig,
   BebopTokensResponse,
 } from './types';
-import { pricesResponseValidator, tokensResponseValidator } from './validators';
+import {
+  BebopPricingUpdate,
+  pricesResponseValidator,
+  tokensResponseValidator,
+} from './validators';
 import { WebSocketFetcher } from '../../lib/fetcher/wsFetcher';
+import { utils } from 'ethers';
+
+export function levels_from_flat_array(values: number[]): BebopLevel[] {
+  const levels: BebopLevel[] = [];
+  for (let i = 0; i < values.length; i += 2) {
+    levels.push([values[i], values[i + 1]]);
+  }
+  return levels;
+}
 
 export class RateFetcher {
   private pricesFetcher: WebSocketFetcher<BebopPricingResponse>;
@@ -35,10 +50,16 @@ export class RateFetcher {
         info: {
           requestOptions: config.rateConfig.pricesReqParams,
           caster: (data: unknown) => {
-            return validateAndCast<BebopPricingResponse>(
-              data,
-              pricesResponseValidator,
-            );
+            const dataBuffer = data as any;
+            const invalid = BebopPricingUpdate.verify(dataBuffer);
+            if (invalid) {
+              throw new ValidationError(invalid);
+            }
+            const update = BebopPricingUpdate.decode(dataBuffer);
+            const updateObject = BebopPricingUpdate.toObject(update, {
+              longs: Number,
+            });
+            return this.parsePricingUpdate(updateObject);
           },
         },
         handler: this.handlePricesResponse.bind(this),
@@ -68,6 +89,30 @@ export class RateFetcher {
     );
   }
 
+  parsePricingUpdate(updateObject: any): BebopPricingResponse {
+    const pricingResponse: BebopPricingResponse = {};
+    if (!updateObject.pairs || !updateObject.pairs.length) {
+      this.logger.warn('Update message did not include pairs', updateObject);
+      return pricingResponse;
+    }
+    for (const pairBook of updateObject.pairs) {
+      const pair =
+        utils.getAddress('0x' + pairBook.base.toString('hex')) +
+        '/' +
+        utils.getAddress('0x' + pairBook.quote.toString('hex'));
+      const lastUpdateTs = pairBook.lastUpdateTs;
+      const bids = pairBook.bids ? levels_from_flat_array(pairBook.bids) : [];
+      const asks = pairBook.asks ? levels_from_flat_array(pairBook.asks) : [];
+      const bebopPair: BebopPair = {
+        bids,
+        asks,
+        last_update_ts: lastUpdateTs,
+      };
+      pricingResponse[pair] = bebopPair;
+    }
+    return pricingResponse;
+  }
+
   start() {
     this.pricesFetcher.startPolling();
     this.tokensFetcher.startPolling();

package/src/dex/bebop/validators.ts

@@ -1,4 +1,5 @@
 import joi from 'joi';
+import protobuf from 'protobufjs';
 
 const levelValidator = joi.array().items(joi.number()).length(2);
 
@@ -27,3 +28,6 @@ export const tokensResponseValidator = joi.object({
 export const blacklistResponseValidator = joi.object({
   blacklist: joi.array().items(joi.string().min(1)).required(),
 });
+
+const root = protobuf.loadSync('src/dex/bebop/bebop.proto');
+export const BebopPricingUpdate = root.lookupType('bebop.BebopPricingUpdate');

package/src/lib/fetcher/wsFetcher.ts

@@ -1,10 +1,6 @@
 import { Logger } from 'log4js';
 import { RequestConfig, Response } from '../../dex-helper/irequest-wrapper';
-import {
-  connection as WebSocketConnection,
-  client as WebSocketClient,
-} from 'websocket';
-
+import WebSocket from 'ws';
 export class SkippingRequest {
   constructor(public message = '') {}
 }
@@ -26,74 +22,77 @@ export type RequestInfoWithHandler<T> = {
 
 export class WebSocketFetcher<T> {
   private requests: RequestInfoWithHandler<T>;
+  // Time to wait before declaring connection as broken and restarting it
+  private timeoutInterval: number;
+  // Time to wait after disconnection before reconnecting
+  private reconnectDelay: number;
+  private pingTimeout: NodeJS.Timeout | undefined = undefined;
   public lastFetchSucceeded: boolean = false;
   private stop: boolean = true;
-  private ws: WebSocketClient = new WebSocketClient();
-  private connection: WebSocketConnection | null = null;
-
-  constructor(requestsInfo: RequestInfoWithHandler<T>, private logger: Logger) {
+  private connection: WebSocket | null = null;
+
+  constructor(
+    requestsInfo: RequestInfoWithHandler<T>,
+    private logger: Logger,
+    timeoutInterval: number = 10000,
+    reconnectDelay: number = 5000,
+  ) {
     this.requests = requestsInfo;
-    this.ws.on('connect', this.connected.bind(this));
-    this.ws.on('connectFailed', this.connectFailed.bind(this));
+    this.timeoutInterval = timeoutInterval;
+    this.reconnectDelay = reconnectDelay;
   }
 
-  private connected(connection: WebSocketConnection) {
-    this.connection = connection;
+  private connected() {
     this.logger.info(`Connected to ${this.requests.info.requestOptions.url}`);
-    this.connection.on('error', this.onError.bind(this));
-    this.connection.on('close', this.onClose.bind(this));
-    this.connection.on('message', this.onMessage.bind(this));
+    this.heartbeat();
   }
 
-  private connectFailed(error: any) {
-    this.logger.error(`Connect Error: ${error.toString()}. Reconnecting...`);
-    // reconnect on errors / failures
-    setTimeout(() => {
-      this.startPolling();
-    }, 3000);
+  private heartbeat() {
+    clearTimeout(this.pingTimeout);
+    this.pingTimeout = setTimeout(() => {
+      this.logger.warn('No heartbeat. Terminating Connection...');
+      this?.connection?.terminate();
+    }, this.timeoutInterval);
   }
 
   private onClose() {
-    this.logger.info(`Connection closed. Reconnecting...`);
-    // reconnect on errors / failures
-    setTimeout(() => {
-      this.startPolling();
-    }, 3000);
+    this.logger.info(`Connection closed.`);
+    // Do not reconnect if polling is stopped
+    if (this.stop) {
+      clearTimeout(this.pingTimeout);
+      return;
+    }
+
+    this.logger.info(`Unexpected closure, Reconnecting...`);
+    this.reconnectWithDelay();
   }
 
   private onError(error: any) {
     this.logger.error(
-      `Connection Error: ${error.toString()}. Stopping & Reconnecting...`,
+      `Websocket Error: ${error.toString()}. Stopping & Reconnecting...`,
     );
-    this.stopPolling();
-
-    // reconnect on errors / failures
-    setTimeout(() => {
-      this.startPolling();
-    }, 3000);
+    this?.connection?.terminate();
   }
 
-  private onMessage(message: any) {
-    if (message.type === 'utf8') {
-      const response = JSON.parse(message.utf8Data) as Response<T>;
-      const reqInfo = this.requests;
-      const info = reqInfo.info;
-      const options = reqInfo.info.requestOptions;
-      this.logger.debug(`(${options.url}) received new data`);
-
-      try {
-        const parsedData = info.caster(response);
-        reqInfo.handler(parsedData);
-      } catch (e) {
-        this.logger.info(e);
-        this.logger.info(
-          `(${options.url}) received incorrect data ${JSON.stringify(
-            response,
-          ).replace(/(?:\r\n|\r|\n)/g, ' ')}`,
-          e,
-        );
-        return;
-      }
+  private onMessage(data: WebSocket.RawData) {
+    this.heartbeat();
+    const reqInfo = this.requests;
+    const info = reqInfo.info;
+    const options = reqInfo.info.requestOptions;
+    this.logger.debug(`(${options.url}) received new data`);
+
+    try {
+      const parsedData = info.caster(data);
+      reqInfo.handler(parsedData);
+    } catch (e) {
+      this.logger.info(e);
+      this.logger.info(
+        `(${options.url}) received incorrect data ${JSON.stringify(
+          data,
+        ).replace(/(?:\r\n|\r|\n)/g, ' ')}`,
+        e,
+      );
+      return;
     }
   }
 
@@ -110,30 +109,44 @@ export class WebSocketFetcher<T> {
     this.logger.info(
       `Connecting to ${this.requests.info.requestOptions.url}...`,
     );
-    this.ws.connect(
-      this.requests.info.requestOptions.url!,
-      undefined,
-      undefined,
-      {
+    const ws = new WebSocket(this.requests.info.requestOptions.url!, {
+      headers: {
         Authorization: authorization,
         name: name,
       },
-    );
+    });
+
+    ws.on('open', this.connected.bind(this));
+    ws.on('message', this.onMessage.bind(this));
+    ws.on('error', this.onError.bind(this));
+    ws.on('close', this.onClose.bind(this));
+    this.connection = ws;
   }
 
-  startPolling(): void {
-    this.stop = false;
+  reconnectWithDelay() {
+    this.logger.info(`Waiting ${this.reconnectDelay}ms before reconnecting...`);
+    clearTimeout(this.pingTimeout);
+    setTimeout(() => {
+      this.reconnect();
+    }, this.reconnectDelay);
+  }
+
+  reconnect() {
+    clearTimeout(this.pingTimeout);
     this.connect();
     this.logger.info(
       `Connection started for ${this.requests.info.requestOptions.url}`,
     );
   }
 
+  startPolling(): void {
+    this.stop = false;
+    this.reconnect();
+  }
+
   stopPolling() {
-    if (this.connection) {
-      this.connection.close();
-    }
     this.stop = true;
+    this.connection?.terminate();
     this.logger.info(
       `Connection stopped for ${this.requests.info.requestOptions.url}`,
     );

package/.idea/aws.xml

@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="accountSettings">
-    <option name="activeProfile" value="profile:default" />
-    <option name="activeRegion" value="us-east-1" />
-    <option name="recentlyUsedProfiles">
-      <list>
-        <option value="profile:default" />
-      </list>
-    </option>
-    <option name="recentlyUsedRegions">
-      <list>
-        <option value="us-east-1" />
-      </list>
-    </option>
-  </component>
-</project>

package/.idea/codeStyles/Project.xml

@@ -1,19 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <ScalaCodeStyleSettings>
-      <option name="MULTILINE_STRING_CLOSING_QUOTES_ON_NEW_LINE" value="true" />
-    </ScalaCodeStyleSettings>
-    <TypeScriptCodeStyleSettings version="0">
-      <option name="SPACE_WITHIN_ARRAY_INITIALIZER_BRACKETS" value="true" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </TypeScriptCodeStyleSettings>
-    <codeStyleSettings language="TypeScript">
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-  </code_scheme>
-</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
-  </state>
-</component>

package/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/paraswap-dex-lib.iml" filepath="$PROJECT_DIR$/.idea/paraswap-dex-lib.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/paraswap-dex-lib.iml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="JAVA_MODULE" version="4">
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/prettier.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="PrettierConfiguration">
-    <option name="myRunOnSave" value="true" />
-    <option name="myRunOnReformat" value="true" />
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
-</project>