aboutsummaryrefslogtreecommitdiffstats
path: root/packages/order-utils/src/types.ts
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2018-08-10 09:14:46 +0800
committerBrandon Millman <brandon.millman@gmail.com>2018-08-14 12:31:22 +0800
commitc10c4cec1db2c5bc0b71177aea7590ee6fda8735 (patch)
tree0a07328c486757443b28994fdc5954ff6723fd64 /packages/order-utils/src/types.ts
parentfadd292ecf367e42154856509d0ea0c20b23f2f1 (diff)
downloaddexon-sol-tools-c10c4cec1db2c5bc0b71177aea7590ee6fda8735.tar
dexon-sol-tools-c10c4cec1db2c5bc0b71177aea7590ee6fda8735.tar.gz
dexon-sol-tools-c10c4cec1db2c5bc0b71177aea7590ee6fda8735.tar.bz2
dexon-sol-tools-c10c4cec1db2c5bc0b71177aea7590ee6fda8735.tar.lz
dexon-sol-tools-c10c4cec1db2c5bc0b71177aea7590ee6fda8735.tar.xz
dexon-sol-tools-c10c4cec1db2c5bc0b71177aea7590ee6fda8735.tar.zst
dexon-sol-tools-c10c4cec1db2c5bc0b71177aea7590ee6fda8735.zip
Update marketUtils api
Diffstat (limited to 'packages/order-utils/src/types.ts')
-rw-r--r--packages/order-utils/src/types.ts28
1 files changed, 28 insertions, 0 deletions
diff --git a/packages/order-utils/src/types.ts b/packages/order-utils/src/types.ts
index 1fbd8cf7b..8a9a4cafe 100644
--- a/packages/order-utils/src/types.ts
+++ b/packages/order-utils/src/types.ts
@@ -41,3 +41,31 @@ export interface CreateOrderOpts {
salt?: BigNumber;
expirationTimeSeconds?: BigNumber;
}
+
+/**
+ * remainingFillableMakerAssetAmount: An array of BigNumbers corresponding to the `signedOrders` parameter.
+ * You can use `OrderStateUtils` `@0xproject/order-utils` to perform blockchain lookups for these values.
+ * Defaults to `makerAssetAmount` values from the signedOrders param.
+ * slippageBufferAmount: An additional amount of makerAsset to be covered by the result in case of trade collisions or partial fills.
+ * Defaults to 0
+ */
+export interface FindOrdersThatCoverMakerAssetFillAmountOpts {
+ remainingFillableMakerAssetAmounts?: BigNumber[];
+ slippageBufferAmount?: BigNumber;
+}
+
+/**
+ * remainingFillableMakerAssetAmount: An array of BigNumbers corresponding to the `signedOrders` parameter.
+ * You can use `OrderStateUtils` `@0xproject/order-utils` to perform blockchain lookups for these values.
+ * Defaults to `makerAssetAmount` values from the signedOrders param.
+ * remainingFillableFeeAmounts: An array of BigNumbers corresponding to the signedFeeOrders parameter.
+ * You can use OrderStateUtils @0xproject/order-utils to perform blockchain lookups for these values.
+ * Defaults to `makerAssetAmount` values from the signedFeeOrders param.
+ * slippageBufferAmount: An additional amount of fee to be covered by the result in case of trade collisions or partial fills.
+ * Defaults to 0
+ */
+export interface FindFeeOrdersThatCoverFeesForTargetOrdersOpts {
+ remainingFillableMakerAssetAmounts?: BigNumber[];
+ remainingFillableFeeAmounts?: BigNumber[];
+ slippageBufferAmount?: BigNumber;
+}