Add apps to fill endpoints (#433)

* Add apps to fills endpoint

* Add apps to fill endpoint

Author: cbovis

src/app/routes/v1/fills.js

@@ -151,12 +151,12 @@ const createRouter = () => {
     const fill = mongoose.Types.ObjectId.isValid(fillId)
       ? await Fill.findById(fillId, undefined, {
           populate: [
-            { path: 'relayer', select: 'imageUrl name slug' },
             { path: 'assets.token', select: 'decimals name symbol type' },
             { path: 'fees.token', select: 'decimals name symbol type' },
             { path: 'affiliate', select: 'name imageUrl' },
             { path: 'takerMetadata', select: 'isContract' },
             { path: 'transaction', select: 'from' },
+            { path: 'attributions.entity', select: 'id logoUrl name urlSlug' },
           ],
         })
       : null;

src/app/routes/v1/util/transform-fill.js

@@ -1,13 +1,30 @@
 const _ = require('lodash');
 
-const { ETH_TOKEN_DECIMALS } = require('../../../../constants');
+const {
+  ETH_TOKEN_DECIMALS,
+  FILL_ATTRIBUTION_TYPE,
+} = require('../../../../constants');
+const formatFillAttributionType = require('../../../../fills/format-fill-attribution-type');
 const formatFillStatus = require('../../../../fills/format-fill-status');
 const formatTokenAmount = require('../../../../tokens/format-token-amount');
 const getAssetsForFill = require('../../../../fills/get-assets-for-fill');
 const getFeesForFill = require('../../../../fills/get-fees-for-fill');
 
-const formatRelayer = relayer =>
-  relayer === null ? null : _.pick(relayer, 'slug', 'name', 'imageUrl');
+const getRelayer = fill => {
+  const relayerAttribution = fill.attributions.find(
+    a => a.type === FILL_ATTRIBUTION_TYPE.RELAYER,
+  );
+
+  if (relayerAttribution === undefined) {
+    return null;
+  }
+
+  return {
+    imageUrl: relayerAttribution.entity.logoUrl,
+    name: relayerAttribution.entity.name,
+    slug: relayerAttribution.entity.urlSlug,
+  };
+};
 
 const transformFill = fill => {
   const assets = getAssetsForFill(fill);
@@ -33,6 +50,20 @@ const transformFill = fill => {
           imageUrl: _.get(fill, 'affiliate.imageUrl', null),
           name: _.get(fill, 'affiliate.name', null),
         },
+    apps: fill.attributions
+      .filter(a =>
+        [
+          FILL_ATTRIBUTION_TYPE.CONSUMER,
+          FILL_ATTRIBUTION_TYPE.RELAYER,
+        ].includes(a.type),
+      )
+      .map(attribution => ({
+        id: attribution.entityId,
+        logoUrl: attribution.entity.logoUrl,
+        name: attribution.entity.name,
+        type: formatFillAttributionType(attribution.type),
+        urlSlug: attribution.entity.urlSlug,
+      })),
     assets,
     date: fill.date,
     fees,
@@ -42,7 +73,7 @@ const transformFill = fill => {
     orderHash: fill.orderHash,
     protocolFee,
     protocolVersion: fill.protocolVersion,
-    relayer: formatRelayer(fill.relayer),
+    relayer: getRelayer(fill),
     senderAddress: fill.senderAddress,
     status: formatFillStatus(fill.status),
     takerAddress: taker,

src/app/routes/v1/util/transform-fills.js

@@ -1,12 +1,29 @@
 const _ = require('lodash');
 
-const { ETH_TOKEN_DECIMALS } = require('../../../../constants');
+const {
+  ETH_TOKEN_DECIMALS,
+  FILL_ATTRIBUTION_TYPE,
+} = require('../../../../constants');
+const formatFillAttributionType = require('../../../../fills/format-fill-attribution-type');
 const formatFillStatus = require('../../../../fills/format-fill-status');
 const formatTokenAmount = require('../../../../tokens/format-token-amount');
 const getAssetsForFill = require('../../../../fills/get-assets-for-fill');
 
-const transformRelayer = relayer =>
-  relayer === null ? null : _.pick(relayer, 'slug', 'name', 'imageUrl');
+const getRelayer = fill => {
+  const relayerAttribution = fill.attributions.find(
+    a => a.type === FILL_ATTRIBUTION_TYPE.RELAYER,
+  );
+
+  if (relayerAttribution === undefined) {
+    return null;
+  }
+
+  return {
+    imageUrl: relayerAttribution.entity.logoUrl,
+    name: relayerAttribution.entity.name,
+    slug: relayerAttribution.entity.urlSlug,
+  };
+};
 
 const transformFill = fill => {
   const assets = getAssetsForFill(fill);
@@ -24,14 +41,28 @@ const transformFill = fill => {
       : undefined;
 
   return {
+    apps: fill.attributions
+      .filter(a =>
+        [
+          FILL_ATTRIBUTION_TYPE.CONSUMER,
+          FILL_ATTRIBUTION_TYPE.RELAYER,
+        ].includes(a.type),
+      )
+      .map(a => ({
+        id: a.entity.id,
+        logoUrl: a.entity.logoUrl,
+        name: a.entity.name,
+        type: formatFillAttributionType(a.type),
+        urlSlug: a.entity.urlSlug,
+      })),
     assets,
     date: fill.date,
     feeRecipient: fill.feeRecipient,
     id: fill.id,
     makerAddress: fill.maker,
     protocolFee,
     protocolVersion: fill.protocolVersion,
-    relayer: transformRelayer(fill.relayer),
+    relayer: getRelayer(fill),
     status: formatFillStatus(fill.status),
     takerAddress: taker,
     value: _.has(conversions, 'amount')

src/fills/format-fill-attribution-type.js

@@ -0,0 +1,19 @@
+const _ = require('lodash');
+
+const { FILL_ATTRIBUTION_TYPE } = require('../constants');
+
+const formatFillAttributionType = type => {
+  if (type === undefined) {
+    return undefined;
+  }
+
+  const matchingKey = _.findKey(FILL_ATTRIBUTION_TYPE, value => type === value);
+
+  if (matchingKey === undefined) {
+    throw new Error(`Unrecognised fill attribution type: ${type}`);
+  }
+
+  return matchingKey.toLowerCase();
+};
+
+module.exports = formatFillAttributionType;

src/fills/search-fills.js

@@ -19,10 +19,10 @@ const searchFills = async (params, options) => {
   const fillIds = results.body.hits.hits.map(hit => hit._id);
   const fills = await Fill.find({ _id: { $in: fillIds } })
     .populate([
-      { path: 'relayer', select: 'imageUrl name slug' },
       { path: 'assets.token', select: 'decimals name symbol type imageUrl' },
       { path: 'transaction', select: 'from' },
       { path: 'takerMetadata', select: 'isContract' },
+      { path: 'attributions.entity', select: 'logoUrl name urlSlug' },
     ])
     .sort({ date: -1 });
 

src/model/fill.js

@@ -4,6 +4,7 @@ const { FILL_STATUS } = require('../constants');
 
 const { Schema } = mongoose;
 
+require('./attribution-entity');
 require('./transaction');
 
 const schema = Schema({
@@ -20,6 +21,14 @@ const schema = Schema({
       tokenId: Number,
     },
   ],
+  attributions: [
+    {
+      entityId: String,
+      type: {
+        type: Number,
+      },
+    },
+  ],
   conversions: {
     USD: {
       amount: Number,
@@ -93,6 +102,13 @@ schema.virtual('transaction', {
   justOne: true,
 });
 
+schema.virtual('attributions.entity', {
+  ref: 'AttributionEntity',
+  localField: 'attributions.entityId',
+  foreignField: '_id',
+  justOne: true,
+});
+
 const Model = mongoose.model('Fill', schema);
 
 module.exports = Model;