feat: Support RFQT via Meta-txn Endpoints (#203)

* Add API Keys to meta-txn /price & /quote endpoints and pass RFQT opts into Asset-swapper * Fix prettier
0xProject · May 1, 2020 · ea9a7e0 · ea9a7e0
1 parent 5ebc34d
commit ea9a7e0
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 10 deletions.
diff --git a/src/handlers/meta_transaction_handlers.ts b/src/handlers/meta_transaction_handlers.ts
@@ -3,10 +3,13 @@ import { BigNumber } from '@0x/utils';
 import * as express from 'express';
 import * as HttpStatus from 'http-status-codes';
 import * as _ from 'lodash';
+import * as isValidUUID from 'uuid-validate';
 
 import { CHAIN_ID } from '../config';
 import { DEFAULT_QUOTE_SLIPPAGE_PERCENTAGE, META_TRANSACTION_DOCS_URL } from '../constants';
 import {
+    GeneralErrorCodes,
+    generalErrorCodeToReason,
     InternalServerError,
     RevertAPIError,
     ValidationError,
@@ -32,6 +35,14 @@ export class MetaTransactionHandlers {
         this._metaTransactionService = metaTransactionService;
     }
     public async getQuoteAsync(req: express.Request, res: express.Response): Promise<void> {
+        const apiKey = req.header('0x-api-key');
+        if (apiKey !== undefined && !isValidUUID(apiKey)) {
+            res.status(HttpStatus.BAD_REQUEST).send({
+                code: GeneralErrorCodes.InvalidAPIKey,
+                reason: generalErrorCodeToReason[GeneralErrorCodes.InvalidAPIKey],
+            });
+            return;
+        }
         // HACK typescript typing does not allow this valid json-schema
         schemaUtils.validateSchema(req.query, schemas.metaTransactionQuoteRequestSchema as any);
         // parse query params
@@ -56,6 +67,7 @@ export class MetaTransactionHandlers {
                 from: takerAddress,
                 slippagePercentage,
                 excludedSources,
+                apiKey,
             });
             res.status(HttpStatus.OK).send(metaTransactionQuote);
         } catch (e) {
@@ -95,6 +107,14 @@ export class MetaTransactionHandlers {
         }
     }
     public async getPriceAsync(req: express.Request, res: express.Response): Promise<void> {
+        const apiKey = req.header('0x-api-key');
+        if (apiKey !== undefined && !isValidUUID(apiKey)) {
+            res.status(HttpStatus.BAD_REQUEST).send({
+                code: GeneralErrorCodes.InvalidAPIKey,
+                reason: generalErrorCodeToReason[GeneralErrorCodes.InvalidAPIKey],
+            });
+            return;
+        }
         // HACK typescript typing does not allow this valid json-schema
         schemaUtils.validateSchema(req.query, schemas.metaTransactionQuoteRequestSchema as any);
         // parse query params
@@ -110,16 +130,20 @@ export class MetaTransactionHandlers {
         const sellTokenAddress = findTokenAddressOrThrowApiError(sellToken, 'sellToken', CHAIN_ID);
         const buyTokenAddress = findTokenAddressOrThrowApiError(buyToken, 'buyToken', CHAIN_ID);
         try {
-            const metaTransactionPrice = await this._metaTransactionService.calculateMetaTransactionPriceAsync({
-                takerAddress,
-                buyTokenAddress,
-                sellTokenAddress,
-                buyAmount,
-                sellAmount,
-                from: takerAddress,
-                slippagePercentage,
-                excludedSources,
-            });
+            const metaTransactionPrice = await this._metaTransactionService.calculateMetaTransactionPriceAsync(
+                {
+                    takerAddress,
+                    buyTokenAddress,
+                    sellTokenAddress,
+                    buyAmount,
+                    sellAmount,
+                    from: takerAddress,
+                    slippagePercentage,
+                    excludedSources,
+                    apiKey,
+                },
+                'price',
+            );
             const metaTransactionPriceResponse = {
                 price: metaTransactionPrice.price,
                 buyAmount: metaTransactionPrice.buyAmount,

diff --git a/src/services/meta_transaction_service.ts b/src/services/meta_transaction_service.ts
@@ -37,6 +37,7 @@ export class MetaTransactionService {
     }
     public async calculateMetaTransactionPriceAsync(
         params: CalculateMetaTransactionQuoteParams,
+        endpoint: 'price' | 'quote',
     ): Promise<CalculateMetaTransactionPriceResponse> {
         const {
             takerAddress,
@@ -46,13 +47,24 @@ export class MetaTransactionService {
             sellTokenAddress,
             slippagePercentage,
             excludedSources,
+            apiKey,
         } = params;
 
+        let _rfqt;
+        if (apiKey !== undefined) {
+            _rfqt = {
+                intentOnFilling: endpoint === 'quote',
+                isIndicative: endpoint === 'price',
+                apiKey,
+                takerAddress,
+            };
+        }
         const assetSwapperOpts = {
             ...ASSET_SWAPPER_MARKET_ORDERS_OPTS,
             slippagePercentage,
             bridgeSlippage: slippagePercentage,
             excludedSources, // TODO(dave4506): overrides the excluded sources selected by chainId
+            rfqt: _rfqt,
         };
 
         let swapQuote;
@@ -107,6 +119,7 @@ export class MetaTransactionService {
     ): Promise<GetMetaTransactionQuoteResponse> {
         const { takerAddress, sellAmount, buyAmount, swapQuote, price } = await this.calculateMetaTransactionPriceAsync(
             params,
+            'quote',
         );
 
         const floatGasPrice = swapQuote.gasPrice;

diff --git a/src/types.ts b/src/types.ts
@@ -458,4 +458,5 @@ export interface CalculateMetaTransactionQuoteParams {
     from: string | undefined;
     slippagePercentage?: number;
     excludedSources?: ERC20BridgeSource[];
+    apiKey: string | undefined;
 }