aboutsummaryrefslogtreecommitdiffstats
path: root/packages/order-utils/src/types.ts
diff options
context:
space:
mode:
authorfragosti <francesco.agosti93@gmail.com>2018-08-17 07:08:02 +0800
committerfragosti <francesco.agosti93@gmail.com>2018-08-17 07:08:02 +0800
commit89174cd63fb8c178c33d456d3b9d1d645ee07e91 (patch)
tree1d3b1932bdb4ff435d7a4d44ca443605d78b9bd0 /packages/order-utils/src/types.ts
parent8cb1d2a0af2df12e0b628a7b016a2b96a4a66860 (diff)
parentd0d6a6a500cf8bbaf5da144490056d0275675eb3 (diff)
downloaddexon-sol-tools-89174cd63fb8c178c33d456d3b9d1d645ee07e91.tar
dexon-sol-tools-89174cd63fb8c178c33d456d3b9d1d645ee07e91.tar.gz
dexon-sol-tools-89174cd63fb8c178c33d456d3b9d1d645ee07e91.tar.bz2
dexon-sol-tools-89174cd63fb8c178c33d456d3b9d1d645ee07e91.tar.lz
dexon-sol-tools-89174cd63fb8c178c33d456d3b9d1d645ee07e91.tar.xz
dexon-sol-tools-89174cd63fb8c178c33d456d3b9d1d645ee07e91.tar.zst
dexon-sol-tools-89174cd63fb8c178c33d456d3b9d1d645ee07e91.zip
Merge branch 'development' of https://github.com/0xProject/0x-monorepo into feature/connect/sra-api-v2
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;
+}