Introduce support for bridged assets (#323)

* Add asset bridging support to fills endpoints

* Add bridge name to fill endpoint

* Add bridge data to fills endpoint

Author: cbovis

src/app/routes/v1/fills.js

@@ -30,14 +30,22 @@ const parseNumber = numberString => {
   return _.toNumber(numberString);
 };
 
+const parseBoolean = booleanString => {
+  if (booleanString === undefined) {
+    return undefined;
+  }
+
+  return booleanString === 'true';
+};
+
 const createRouter = () => {
   const router = new Router({ prefix: '/fills' });
 
   router.get(
     '/',
     pagination({ defaultLimit: 20, maxLimit: 50, maxPage: Infinity }),
     async ({ pagination: { limit, page }, request, response }, next) => {
-      const { address, status, token } = request.query;
+      const { address, bridgeAddress, status, token } = request.query;
       const relayerId = request.query.relayer;
       const query = request.query.q;
       const relayerLookupId = await getRelayerLookupId(relayerId);
@@ -49,6 +57,7 @@ const createRouter = () => {
         request.query.protocolVersion !== undefined
           ? _.toNumber(request.query.protocolVersion)
           : undefined;
+      const bridged = parseBoolean(request.query.bridged);
 
       const minDate = moment().subtract(6, 'months');
 
@@ -142,6 +151,8 @@ const createRouter = () => {
       const { docs, pages, total } = await searchFills(
         {
           address,
+          bridgeAddress,
+          bridged,
           dateFrom: dateFrom !== undefined ? dateFrom : minDate,
           dateTo,
           protocolVersion,

src/app/routes/v1/util/__snapshots__/transform-fill.test.js.snap

@@ -3,6 +3,8 @@
 exports[`transformFill should transform ERC20 asset 1`] = `
 Object {
   "amount": "0.275",
+  "bridgeAddress": undefined,
+  "bridgeName": undefined,
   "price": Object {
     "USD": 137.36999999999998,
   },
@@ -18,6 +20,8 @@ Object {
 exports[`transformFill should transform ERC721 asset 1`] = `
 Object {
   "amount": "1",
+  "bridgeAddress": undefined,
+  "bridgeName": undefined,
   "price": Object {
     "USD": 37.77675,
   },
@@ -35,6 +39,8 @@ Object {
   "assets": Array [
     Object {
       "amount": "7.1373405",
+      "bridgeAddress": undefined,
+      "bridgeName": undefined,
       "price": Object {
         "USD": 224.42000000000002,
       },
@@ -47,6 +53,8 @@ Object {
     },
     Object {
       "amount": "300000",
+      "bridgeAddress": undefined,
+      "bridgeName": undefined,
       "price": Object {
         "USD": 0.0053392065167000005,
       },
@@ -96,6 +104,8 @@ Object {
 exports[`transformFill should transform V1 fill with unrecognised maker asset 1`] = `
 Object {
   "amount": undefined,
+  "bridgeAddress": undefined,
+  "bridgeName": undefined,
   "price": Object {
     "USD": 224.42000000000002,
   },
@@ -111,6 +121,8 @@ Object {
 exports[`transformFill should transform V1 fill with unrecognised taker asset 1`] = `
 Object {
   "amount": undefined,
+  "bridgeAddress": undefined,
+  "bridgeName": undefined,
   "price": Object {
     "USD": 0.0053392065167000005,
   },
@@ -128,6 +140,8 @@ Object {
   "assets": Array [
     Object {
       "amount": "1",
+      "bridgeAddress": undefined,
+      "bridgeName": undefined,
       "price": Object {
         "USD": 37.77675,
       },
@@ -140,6 +154,8 @@ Object {
     },
     Object {
       "amount": "0.275",
+      "bridgeAddress": undefined,
+      "bridgeName": undefined,
       "price": Object {
         "USD": 137.36999999999998,
       },

src/constants.js

@@ -103,4 +103,44 @@ module.exports = {
       slug: 'veil',
     },
   },
+  KNOWN_ASSET_BRIDGES: [
+    {
+      addresses: [
+        '0x6a3b7c553d47c08651641ef00cb3befae97bf415', // V1
+        '0x77c31eba23043b9a72d13470f3a3a311344d7438', // V2
+      ],
+      name: 'Chai',
+    },
+    {
+      addresses: [
+        '0x96ddba19b69d6ea2549f6a12d005595167414744', // V1
+        '0x55dc8f21d20d4c6ed3c82916a438a413ca68e335', // V2
+      ],
+      name: 'dYdX',
+    },
+    {
+      addresses: [
+        '0x0ac2d6f5f5afc669d3ca38f830dad2b4f238ad3f', // V1
+        '0x1c36b06fc0d9354a96cf155b861b141ed10c3312', // V2
+        '0xe97ea901d034ba2e018155264f77c417ce7717f9', // V3
+      ],
+      name: 'Eth2Dai',
+    },
+    {
+      addresses: [
+        '0xe64660275c40c16c491c2dabf50afaded20f858f', // V1
+        '0x7253a80c1d3a3175283bad9ed04b2cecad0fe0d3', // V2
+        '0xf342f3a80fdc9b48713d58fe97e17f5cc764ee62', // V3
+      ],
+      name: 'Kyber',
+    },
+    {
+      addresses: [
+        '0xa6baaed2053058a3c8f11e0c7a9716304454b09e', // V1
+        '0xb0dc61047847732a013ce27341228228a38655a0', // V2
+        '0x533344cfdf2a3e911e2cf4c6f5ed08e791f5355f', // V3
+      ],
+      name: 'Uniswap',
+    },
+  ],
 };

src/constants.test.js

@@ -0,0 +1,9 @@
+const _ = require('lodash');
+const { KNOWN_ASSET_BRIDGES } = require('./constants');
+
+it('KNOWN_ASSET_BRIDGES should not contain any duplicate addresses', () => {
+  const addresses = _.flatMap(KNOWN_ASSET_BRIDGES, 'addresses');
+  const uniqueAddresses = _.uniq(addresses);
+
+  expect(addresses).toEqual(uniqueAddresses);
+});

src/fills/get-asset-bridge-name.js

@@ -0,0 +1,15 @@
+const { KNOWN_ASSET_BRIDGES } = require('../constants');
+
+const getAssetBridgeName = address => {
+  if (address === undefined) {
+    return undefined;
+  }
+
+  const matchingBridge = KNOWN_ASSET_BRIDGES.find(bridge =>
+    bridge.addresses.includes(address),
+  );
+
+  return matchingBridge === undefined ? undefined : matchingBridge.name;
+};
+
+module.exports = getAssetBridgeName;

src/fills/get-asset-bridge-name.test.js

@@ -0,0 +1,25 @@
+const getAssetBridgeName = require('./get-asset-bridge-name');
+
+it('should return undefined when address is undefined', () => {
+  const name = getAssetBridgeName();
+
+  expect(name).toBeUndefined();
+});
+
+it('should return Eth2Dai when address is 0xe97ea901d034ba2e018155264f77c417ce7717f9', () => {
+  const name = getAssetBridgeName('0xe97ea901d034ba2e018155264f77c417ce7717f9');
+
+  expect(name).toBe('Eth2Dai');
+});
+
+it('should return Kyber when address is 0xf342f3a80fdc9b48713d58fe97e17f5cc764ee62', () => {
+  const name = getAssetBridgeName('0xf342f3a80fdc9b48713d58fe97e17f5cc764ee62');
+
+  expect(name).toBe('Kyber');
+});
+
+it('should return Kyber when address is 0x7253a80c1d3a3175283bad9ed04b2cecad0fe0d3', () => {
+  const name = getAssetBridgeName('0x7253a80c1d3a3175283bad9ed04b2cecad0fe0d3');
+
+  expect(name).toBe('Kyber');
+});

src/fills/get-assets-for-fill.js

@@ -3,13 +3,16 @@ const _ = require('lodash');
 const formatTokenAmount = require('../tokens/format-token-amount');
 const formatTokenType = require('../tokens/format-token-type');
 const formatTraderType = require('../traders/format-trader-type');
+const getAssetBridgeName = require('./get-asset-bridge-name');
 
 const transformAsset = (tokens, asset) => {
   const token = tokens[asset.tokenAddress];
   const price = _.get(asset.price, 'USD');
 
   return {
     amount: formatTokenAmount(asset.amount, token),
+    bridgeAddress: asset.bridgeAddress,
+    bridgeName: getAssetBridgeName(asset.bridgeAddress),
     price: _.isNumber(price) ? { USD: price } : undefined,
     tokenAddress: asset.tokenAddress,
     tokenId: asset.tokenId,

src/fills/search-fills.js

@@ -5,6 +5,8 @@ const Fill = require('../model/fill');
 
 const buildQuery = ({
   address,
+  bridgeAddress,
+  bridged,
   dateFrom,
   dateTo,
   protocolVersion,
@@ -16,6 +18,7 @@ const buildQuery = ({
   valueTo,
 }) => {
   const filters = [];
+  const exclusions = [];
 
   if (dateFrom !== undefined || dateTo !== undefined) {
     filters.push({
@@ -82,10 +85,30 @@ const buildQuery = ({
     filters.push({ term: { status } });
   }
 
+  if (_.isString(bridgeAddress)) {
+    filters.push({ match_phrase: { 'assets.bridgeAddress': bridgeAddress } });
+  }
+
+  if (_.isBoolean(bridged)) {
+    if (bridged) {
+      filters.push({
+        exists: {
+          field: 'assets.bridgeAddress',
+        },
+      });
+    } else {
+      exclusions.push({
+        exists: {
+          field: 'assets.bridgeAddress',
+        },
+      });
+    }
+  }
+
   return filters.length === 0
     ? undefined
     : {
-        bool: { filter: filters },
+        bool: { filter: filters, must_not: exclusions },
       };
 };
 

src/model/fill.js

@@ -9,6 +9,7 @@ const schema = Schema({
     {
       actor: Number,
       amount: Number,
+      bridgeAddress: String,
       price: {
         USD: Number,
       },