aboutsummaryrefslogtreecommitdiffstats
path: root/packages/forwarder-helper/src/types.ts
diff options
context:
space:
mode:
authorF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-09-25 01:30:37 +0800
committerF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-09-25 01:30:37 +0800
commit2116548eed666c3c61277f17e996fee720301f31 (patch)
tree6f4b601b59659ac9134ffe4efed79c8a8a2750e0 /packages/forwarder-helper/src/types.ts
parent57fca16d7b1dc61c060c90fa440b1dc947aefb93 (diff)
parentb830c28d83a33c0170d4f150ee287ea97ccf7865 (diff)
downloaddexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar.gz
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar.bz2
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar.lz
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar.xz
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar.zst
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.zip
Merge remote-tracking branch 'upstream/development' into sol-doc
Diffstat (limited to 'packages/forwarder-helper/src/types.ts')
-rw-r--r--packages/forwarder-helper/src/types.ts43
1 files changed, 0 insertions, 43 deletions
diff --git a/packages/forwarder-helper/src/types.ts b/packages/forwarder-helper/src/types.ts
deleted file mode 100644
index fb171cc90..000000000
--- a/packages/forwarder-helper/src/types.ts
+++ /dev/null
@@ -1,43 +0,0 @@
-import { SignedOrder } from '@0xproject/types';
-import { BigNumber } from '@0xproject/utils';
-
-export interface ForwarderHelper {
- /**
- * Given a MarketBuyOrdersInfoRequest, returns a MarketBuyOrdersInfo containing all information relevant to fulfilling the request
- * using the ForwarderContract marketBuyOrdersWithEth function.
- * @param request An object that conforms to MarketBuyOrdersInfoRequest. See type definition for more information.
- * @return An object that conforms to MarketBuyOrdersInfo that satisfies the request. See type definition for more information.
- */
- getMarketBuyOrdersInfo: (request: MarketBuyOrdersInfoRequest) => MarketBuyOrdersInfo;
-}
-
-export enum ForwarderHelperError {
- InsufficientMakerAssetLiquidity = 'INSUFFICIENT_MAKER_ASSET_LIQUIDITY',
- InsufficientZrxLiquidity = 'INSUFFICIENT_ZRX_LIQUIDITY',
-}
-
-/**
- * makerAssetFillAmount: The amount of makerAsset requesting to be filled
- * feePercentage: Optional affiliate percentage amount factoring into eth amount calculations
- */
-export interface MarketBuyOrdersInfoRequest {
- makerAssetFillAmount: BigNumber;
- feePercentage?: BigNumber;
-}
-
-/**
- * makerAssetFillAmount: The amount of makerAsset requesting to be filled
- * orders: An array of objects conforming to SignedOrder. These orders can be used to cover the requested makerAssetFillAmount plus slippage
- * feeOrders: An array of objects conforming to SignedOrder. These orders can be used to cover the fees for the orders param above
- * minEthAmount: Amount of eth in wei to send with the tx for the most optimistic case
- * maxEthAmount: Amount of eth in wei to send with the tx for the worst case
- * feePercentage: Affiliate fee percentage used to calculate the eth amounts above. Passed thru directly from the request
- */
-export interface MarketBuyOrdersInfo {
- makerAssetFillAmount: BigNumber;
- orders: SignedOrder[];
- feeOrders: SignedOrder[];
- minEthAmount: BigNumber;
- maxEthAmount: BigNumber;
- feePercentage?: BigNumber;
-}