Merge pull request #2583 from 0xProject/feat/estimated-gas-token-refund

Expose fills object in asset-swapper quote orders
0xProject · May 20, 2020 · b23f1eb · b23f1eb
2 parents d9e13d6 + f694072
commit b23f1eb
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 8 deletions.
diff --git a/packages/abi-gen/test-cli/output/python/lib_dummy/__init__.py b/packages/abi-gen/test-cli/output/python/lib_dummy/__init__.py
@@ -90,7 +90,7 @@ def __init__(
             try:
                 for middleware in MIDDLEWARE:
                     web3.middleware_onion.inject(
-                        middleware["function"], layer=middleware["layer"],
+                        middleware["function"], layer=middleware["layer"]
                     )
             except ValueError as value_error:
                 if value_error.args == (

diff --git a/packages/asset-swapper/CHANGELOG.json b/packages/asset-swapper/CHANGELOG.json
@@ -69,6 +69,10 @@
             {
                 "note": "Remove Kyber exclusion when Uniswap/Eth2Dai is present",
                 "pr": 2575
+            },
+            {
+                "note": "Expose fills object in asset-swapper quote orders",
+                "pr": 2583
             }
         ]
     },

diff --git a/packages/asset-swapper/src/types.ts b/packages/asset-swapper/src/types.ts
@@ -2,7 +2,7 @@ import { ContractAddresses } from '@0x/contract-wrappers';
 import { SignedOrder } from '@0x/types';
 import { BigNumber } from '@0x/utils';
 
-import { GetMarketOrdersOpts } from './utils/market_operation_utils/types';
+import { GetMarketOrdersOpts, OptimizedMarketOrder } from './utils/market_operation_utils/types';
 import { LogFunction } from './utils/quote_requestor';
 
 /**
@@ -132,15 +132,15 @@ export interface GetExtensionContractTypeOpts {
  * takerAssetData: String that represents a specific taker asset (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md).
  * makerAssetData: String that represents a specific maker asset (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md).
  * gasPrice: gas price used to determine protocolFee amount, default to ethGasStation fast amount.
- * orders: An array of objects conforming to SignedOrder. These orders can be used to cover the requested assetBuyAmount plus slippage.
+ * orders: An array of objects conforming to OptimizedMarketOrder. These orders can be used to cover the requested assetBuyAmount plus slippage.
  * bestCaseQuoteInfo: Info about the best case price for the asset.
  * worstCaseQuoteInfo: Info about the worst case price for the asset.
  */
 export interface SwapQuoteBase {
     takerAssetData: string;
     makerAssetData: string;
     gasPrice: BigNumber;
-    orders: SignedOrder[];
+    orders: OptimizedMarketOrder[];
     bestCaseQuoteInfo: SwapQuoteInfo;
     worstCaseQuoteInfo: SwapQuoteInfo;
     sourceBreakdown: SwapQuoteOrdersBreakdown;

diff --git a/packages/asset-swapper/src/utils/swap_quote_calculator.ts b/packages/asset-swapper/src/utils/swap_quote_calculator.ts
@@ -8,7 +8,6 @@ import {
     MarketBuySwapQuote,
     MarketOperation,
     MarketSellSwapQuote,
-    SignedOrderWithFillableAmounts,
     SwapQuote,
     SwapQuoteBase,
     SwapQuoteInfo,
@@ -200,8 +199,7 @@ function createSwapQuote(
         bestCaseQuoteInfo: fillResultsToQuoteInfo(bestCaseFillResult),
         worstCaseQuoteInfo: fillResultsToQuoteInfo(worstCaseFillResult),
         sourceBreakdown: getSwapQuoteOrdersBreakdown(bestCaseFillResult.fillAmountBySource),
-        // Remove fill metadata.
-        orders: resultOrders.map(o => _.omit(o, 'fills')) as SignedOrderWithFillableAmounts[],
+        orders: resultOrders,
     };
 
     if (operation === MarketOperation.Buy) {

diff --git a/packages/asset-swapper/test/utils/swap_quote.ts b/packages/asset-swapper/test/utils/swap_quote.ts
@@ -34,7 +34,7 @@ export async function getFullyFillableSwapQuoteWithNoFeesAsync(
     const quoteBase = {
         makerAssetData,
         takerAssetData,
-        orders,
+        orders: orders.map(order => ({ ...order, fills: [] })),
         gasPrice,
         bestCaseQuoteInfo: quoteInfo,
         worstCaseQuoteInfo: quoteInfo,