diff options
author | F. Eugene Aumson <feuGeneA@users.noreply.github.com> | 2018-08-17 06:32:09 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-08-17 06:32:09 +0800 |
commit | c1ec849554a1e55cd3e8d5bbee206f4bf1d67a5b (patch) | |
tree | 919eca787e6da6b6e1b28073d7a9e876f9497616 /packages/order-utils/src/sorting_utils.ts | |
parent | 445177bf420049041ade4d7526a5f4a8194bd216 (diff) | |
parent | 72752bcb68bac29ff5897ed57de357ad7af09abe (diff) | |
download | dexon-sol-tools-c1ec849554a1e55cd3e8d5bbee206f4bf1d67a5b.tar dexon-sol-tools-c1ec849554a1e55cd3e8d5bbee206f4bf1d67a5b.tar.gz dexon-sol-tools-c1ec849554a1e55cd3e8d5bbee206f4bf1d67a5b.tar.bz2 dexon-sol-tools-c1ec849554a1e55cd3e8d5bbee206f4bf1d67a5b.tar.lz dexon-sol-tools-c1ec849554a1e55cd3e8d5bbee206f4bf1d67a5b.tar.xz dexon-sol-tools-c1ec849554a1e55cd3e8d5bbee206f4bf1d67a5b.tar.zst dexon-sol-tools-c1ec849554a1e55cd3e8d5bbee206f4bf1d67a5b.zip |
Merge branch 'development' into sol-compile-lot
Diffstat (limited to 'packages/order-utils/src/sorting_utils.ts')
-rw-r--r-- | packages/order-utils/src/sorting_utils.ts | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/packages/order-utils/src/sorting_utils.ts b/packages/order-utils/src/sorting_utils.ts new file mode 100644 index 000000000..8811bcaf8 --- /dev/null +++ b/packages/order-utils/src/sorting_utils.ts @@ -0,0 +1,54 @@ +import { schemas } from '@0xproject/json-schemas'; +import { Order } from '@0xproject/types'; +import { BigNumber } from '@0xproject/utils'; +import * as _ from 'lodash'; + +import { assert } from './assert'; +import { constants } from './constants'; +import { rateUtils } from './rate_utils'; + +export const sortingUtils = { + /** + * Takes an array of orders and sorts them by takerAsset/makerAsset rate in ascending order (best rate first). + * Adjusts the rate of each order according to the feeRate and takerFee for that order. + * @param orders An array of objects that extend the Order interface. All orders should specify ZRX as + * the makerAsset and WETH as the takerAsset. + * @param feeRate The market rate of ZRX denominated in takerAssetAmount + * (ex. feeRate is 0.1 takerAsset/ZRX if it takes 1 unit of takerAsset to buy 10 ZRX) + * Defaults to 0 + * @return The input orders sorted by rate in ascending order + */ + sortOrdersByFeeAdjustedRate<T extends Order>(orders: T[], feeRate: BigNumber = constants.ZERO_AMOUNT): T[] { + assert.doesConformToSchema('orders', orders, schemas.ordersSchema); + assert.isBigNumber('feeRate', feeRate); + const rateCalculator = (order: Order) => rateUtils.getFeeAdjustedRateOfOrder(order, feeRate); + const sortedOrders = sortOrders(orders, rateCalculator); + return sortedOrders; + }, + /** + * Takes an array of fee orders (makerAssetData corresponds to ZRX and takerAssetData corresponds to WETH) + * and sorts them by rate in ascending order (best rate first). Adjusts the rate according to the takerFee. + * @param feeOrders An array of objects that extend the Order interface. All orders should specify ZRX as + * the makerAsset and WETH as the takerAsset. + * @return The input orders sorted by rate in ascending order + */ + sortFeeOrdersByFeeAdjustedRate(feeOrders: Order[]): Order[] { + assert.doesConformToSchema('feeOrders', feeOrders, schemas.ordersSchema); + const rateCalculator = rateUtils.getFeeAdjustedRateOfFeeOrder.bind(rateUtils); + const sortedOrders = sortOrders(feeOrders, rateCalculator); + return sortedOrders; + }, +}; + +type RateCalculator = (order: Order) => BigNumber; + +// takes an array of orders, copies them, and sorts the copy based on the rate definition provided by rateCalculator +function sortOrders<T extends Order>(orders: T[], rateCalculator: RateCalculator): T[] { + const copiedOrders = _.cloneDeep(orders); + copiedOrders.sort((firstOrder, secondOrder) => { + const firstOrderRate = rateCalculator(firstOrder); + const secondOrderRate = rateCalculator(secondOrder); + return firstOrderRate.comparedTo(secondOrderRate); + }); + return copiedOrders; +} |