aboutsummaryrefslogtreecommitdiffstats
path: root/packages/order-utils/src/types.ts
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-17 06:10:12 +0800
committerFabio Berger <me@fabioberger.com>2018-08-17 06:10:12 +0800
commit0337b5a40104ef83ebd527184785def7f399d573 (patch)
tree1fcbd0effd3ad4a88e99a41082825818e3f02302 /packages/order-utils/src/types.ts
parente47e9c5b34a2c189b6913c4c7082cb7ec256617f (diff)
parent72752bcb68bac29ff5897ed57de357ad7af09abe (diff)
downloaddexon-sol-tools-0337b5a40104ef83ebd527184785def7f399d573.tar
dexon-sol-tools-0337b5a40104ef83ebd527184785def7f399d573.tar.gz
dexon-sol-tools-0337b5a40104ef83ebd527184785def7f399d573.tar.bz2
dexon-sol-tools-0337b5a40104ef83ebd527184785def7f399d573.tar.lz
dexon-sol-tools-0337b5a40104ef83ebd527184785def7f399d573.tar.xz
dexon-sol-tools-0337b5a40104ef83ebd527184785def7f399d573.tar.zst
dexon-sol-tools-0337b5a40104ef83ebd527184785def7f399d573.zip
Merge development
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..2e9c79d80 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 `orders` parameter.
+ * You can use `OrderStateUtils` `@0xproject/order-utils` to perform blockchain lookups for these values.
+ * Defaults to `makerAssetAmount` values from the orders 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 `orders` parameter.
+ * You can use `OrderStateUtils` `@0xproject/order-utils` to perform blockchain lookups for these values.
+ * Defaults to `makerAssetAmount` values from the orders param.
+ * remainingFillableFeeAmounts: An array of BigNumbers corresponding to the feeOrders parameter.
+ * You can use OrderStateUtils @0xproject/order-utils to perform blockchain lookups for these values.
+ * Defaults to `makerAssetAmount` values from the feeOrders 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;
+}