Add support for bridged ERC20 assets (#374)

* Add support for bridged ERC20 assets

* Tweak bridged asset shape

* Index asset bridge address

* Store asset bridge address and data

* Store bridge data for fee assets

* Improve tests

* Tweak test name

Author: cbovis

package-lock.json

@@ -36,7 +36,7 @@
     "prettier": "1.19.1"
   },
   "dependencies": {
-    "@0x/order-utils": "8.1.1",
+    "@0x/order-utils": "10.0.1",
     "@0x/subproviders": "4.1.0",
     "@0x/utils": "4.3.3",
     "@0x/web3-wrapper": "6.0.7",

package.json

@@ -1,12 +1,27 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`assets should include bridgeAddress property when asset is bridged 1`] = `
+Array [
+  Object {
+    "bridgeAddress": "0x58b7b96e170e46c07d02fac903cd1b3356b7549f",
+    "tokenAddress": "0x6b175474e89094c44da98b954eedeac495271d0f",
+  },
+  Object {
+    "bridgeAddress": "0x58b7b96e170e46c07d02fac903cd1b3356b7549f",
+    "tokenAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
+  },
+]
+`;
+
 exports[`should create Elasticsearch document for fill 1`] = `
 Object {
   "assets": Array [
     Object {
+      "bridgeAddress": undefined,
       "tokenAddress": "0x6b175474e89094c44da98b954eedeac495271d0f",
     },
     Object {
+      "bridgeAddress": undefined,
       "tokenAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
     },
   ],

src/index/fills/__snapshots__/create-document.test.js.snap

@@ -4,7 +4,10 @@ const createDocument = fill => {
   const value = _.get(fill, 'conversions.USD.amount');
 
   return {
-    assets: fill.assets.map(asset => ({ tokenAddress: asset.tokenAddress })),
+    assets: fill.assets.map(asset => ({
+      bridgeAddress: asset.bridgeAddress,
+      tokenAddress: asset.tokenAddress,
+    })),
     date: fill.date,
     fees: fill.fees.map(fee => ({ tokenAddress: fee.tokenAddress })),
     feeRecipient: fill.feeRecipient,

src/index/fills/create-document.js

@@ -18,3 +18,16 @@ it('should exclude value property when fill is unmeasured', () => {
 
   expect(doc.value).toBeUndefined();
 });
+
+it('assets should include bridgeAddress property when asset is bridged', () => {
+  const fill = {
+    ...V2_FILL,
+    assets: V2_FILL.assets.map(asset => ({
+      ...asset,
+      bridgeAddress: '0x58b7b96e170e46c07d02fac903cd1b3356b7549f',
+    })),
+  };
+  const doc = createDocument(fill);
+
+  expect(doc.assets).toMatchSnapshot();
+});

src/index/fills/create-document.test.js

@@ -42,6 +42,36 @@ describe('extractFeesFromEventArgs', () => {
     ]);
   });
 
+  it('should extract bridged fees for v3.0 fill event', () => {
+    const args = {
+      ...V3_EVENT.data.args,
+      makerFeeAssetData:
+        '0xdc1600f3000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc200000000000000000000000058b7b96e170e46c07d02fac903cd1b3356b7549f000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000400000000000000000000000006b175474e89094c44da98b954eedeac495271d0f00000000000000000000000000000000000000000000000000000000000a5a2f',
+    };
+    const protocolVersion = 3;
+    const fees = extractFeesFromEventArgs(args, protocolVersion);
+
+    expect(fees).toEqual([
+      {
+        amount: { token: 500000000000 },
+        bridgeAddress: '0x58b7b96e170e46c07d02fac903cd1b3356b7549f',
+        bridgeData:
+          '0x0000000000000000000000006b175474e89094c44da98b954eedeac495271d0f00000000000000000000000000000000000000000000000000000000000a5a2f',
+        tokenAddress: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+        tokenType: 0,
+        traderType: 0,
+      },
+      {
+        amount: {
+          token: 300000000,
+        },
+        tokenAddress: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+        tokenType: 0,
+        traderType: 1,
+      },
+    ]);
+  });
+
   it('should return undefined for v3 fill event when makerFeeAssetData is corrupt', () => {
     const protocolVersion = 3;
     const eventArgs = { ...V3_EVENT.data.args, makerFeeAssetData: 'fubar' };

src/jobs/create-fills/extract-fees-from-event-args.test.js

@@ -161,6 +161,46 @@ it('should get assets for V2 event with multi-asset data', () => {
   ]);
 });
 
+it('should get assets for V2 event with bridged ERC20 asset data', () => {
+  const eventArgs = {
+    makerAddress: '0x9193ed9cbf94d109667c3d5659caffe21b4197bc',
+    feeRecipientAddress: '0x0000000000000000000000000000000000000000',
+    takerAddress: '0xdf1bc6498338135de5ffdbcb98817d81e2665912',
+    senderAddress: '0xdf1bc6498338135de5ffdbcb98817d81e2665912',
+    makerAssetFilledAmount: 7597171425070027,
+    takerAssetFilledAmount: 46810278916603824.0,
+    makerFeePaid: 0,
+    takerFeePaid: 0,
+    orderHash:
+      '0xc9a69b17a479155016a724a250a6093903bcaafa318e757eab2c7fc6d5ca3edd',
+    makerAssetData:
+      '0xdc1600f3000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc200000000000000000000000058b7b96e170e46c07d02fac903cd1b3356b7549f000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000400000000000000000000000006b175474e89094c44da98b954eedeac495271d0f00000000000000000000000000000000000000000000000000000000000a5a2f',
+    takerAssetData:
+      '0xf47261b000000000000000000000000053b04999c1ff2d77fcdde98935bb936a67209e4c',
+  };
+  const assets = getAssets(eventArgs, 2);
+
+  expect(assets).toEqual([
+    {
+      actor: 0,
+      amount: 7597171425070027,
+      bridgeAddress: '0x58b7b96e170e46c07d02fac903cd1b3356b7549f',
+      bridgeData:
+        '0x0000000000000000000000006b175474e89094c44da98b954eedeac495271d0f00000000000000000000000000000000000000000000000000000000000a5a2f',
+      tokenAddress: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+      tokenResolved: false,
+      tokenType: 0,
+    },
+    {
+      actor: 1,
+      amount: 46810278916603820,
+      tokenAddress: '0x53b04999c1ff2d77fcdde98935bb936a67209e4c',
+      tokenResolved: false,
+      tokenType: 0,
+    },
+  ]);
+});
+
 it('should return undefined when one of the assets data is corrupt', () => {
   const eventArgs = {
     makerAddress: '0x9193ed9cbf94d109667c3d5659caffe21b4197bc',

src/jobs/create-fills/get-assets.test.js

@@ -1,12 +1,13 @@
 const { assetDataUtils } = require('@0x/order-utils');
 const { TOKEN_TYPE } = require('../../constants');
 
-const {
-  decodeAssetDataOrThrow,
-  isERC20AssetData,
-  isERC721AssetData,
-  isMultiAssetData,
-} = assetDataUtils;
+const { decodeAssetDataOrThrow } = assetDataUtils;
+
+const isERC20AssetData = assetData => assetData.assetProxyId === '0xf47261b0';
+const isERC721AssetData = assetData => assetData.assetProxyId === '0x02571792';
+const isMultiAssetData = assetData => assetData.assetProxyId === '0x94cfcdd7';
+const isERC20BridgeAssetData = assetData =>
+  assetData.assetProxyId === '0xdc1600f3';
 
 const decodeAssetData = assetData => {
   try {
@@ -16,27 +17,37 @@ const decodeAssetData = assetData => {
   }
 };
 
-const createAsset = (singleAssetData, amount) => {
-  const simpleAsset = {
+const createAsset = (assetData, amount) => {
+  const baseAsset = {
     amount,
-    tokenAddress: singleAssetData.tokenAddress,
+    tokenAddress: assetData.tokenAddress,
   };
 
-  if (isERC20AssetData(singleAssetData)) {
+  if (isERC20AssetData(assetData)) {
     return {
-      ...simpleAsset,
+      ...baseAsset,
       tokenType: TOKEN_TYPE.ERC20,
     };
   }
 
-  if (isERC721AssetData(singleAssetData)) {
+  if (isERC721AssetData(assetData)) {
     return {
-      ...simpleAsset,
-      tokenId: singleAssetData.tokenId.toNumber(),
+      ...baseAsset,
+      tokenId: assetData.tokenId.toNumber(),
       tokenType: TOKEN_TYPE.ERC721,
     };
   }
 
+  if (isERC20BridgeAssetData(assetData)) {
+    return {
+      ...baseAsset,
+      bridgeAddress: assetData.bridgeAddress,
+      bridgeData: assetData.bridgeData,
+      tokenAddress: assetData.tokenAddress,
+      tokenType: TOKEN_TYPE.ERC20,
+    };
+  }
+
   return undefined; // Unrecognised asset
 };
 
@@ -68,7 +79,11 @@ const parseAssetData = (encodedData, amount) => {
   }
 
   // When the asset data represents a single asset we can just return a single item array.
-  if (isERC20AssetData(assetData) || isERC721AssetData(assetData)) {
+  if (
+    isERC20AssetData(assetData) ||
+    isERC721AssetData(assetData) ||
+    isERC20BridgeAssetData(assetData)
+  ) {
     return [createAsset(assetData, amount)];
   }
 

src/jobs/create-fills/parse-asset-data.js

@@ -10,6 +10,8 @@ const createModel = () => {
       {
         actor: Number,
         amount: Number,
+        bridgeAddress: String,
+        bridgeData: String,
         price: {
           USD: Number,
         },
@@ -36,6 +38,8 @@ const createModel = () => {
     fees: [
       {
         amount: { token: Number, USD: Number },
+        bridgeAddress: String,
+        bridgeData: String,
         tokenAddress: String,
         tokenId: Number,
         traderType: Number,