Update documentation and changelog

0xProject · Mar 28, 2019 · d8bfc92 · d8bfc92
1 parent 1f2214f
commit d8bfc92
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 8 deletions.
diff --git a/packages/contract-wrappers/CHANGELOG.json b/packages/contract-wrappers/CHANGELOG.json
@@ -3,7 +3,11 @@
         "version": "9.0.0",
         "changes": [
             {
-                "note": "Added a simulation for `exchange.validateOrderFillableOrThrowAsync` that simulates maker transfer",
+                "note": "Added a simulation to transfer from maker to taker during `exchange.validateOrderFillableOrThrowAsync`",
+                "pr": 1714
+            },
+            {
+                "note": "Added additional properties to `ValidateOrderFillableOpts`. An order can now be validated to fill a non-zero amount by specifying `validateRemainingOrderAmountIsFillable` as `false`. The default `true` will continue to validate the entire remaining balance is fillable.",
                 "pr": 1714
             }
         ]

diff --git a/packages/contract-wrappers/src/types.ts b/packages/contract-wrappers/src/types.ts
@@ -120,14 +120,17 @@ export interface ContractWrappersConfig {
 }
 
 /**
- * expectedFillTakerTokenAmount: If specified, the validation method will ensure that the supplied order maker has a sufficient
+ * `expectedFillTakerTokenAmount`: If specified, the validation method will ensure that the supplied order maker has a sufficient
  *                               allowance/balance to fill this amount of the order's takerTokenAmount.
- * validateRemainingOrderAmountIsFillable: The validation method ensures that the maker has a sufficient allowance/balance to fill
- *                                         the entire remaining order amount. This is the default. If neither options are specified,
- *                                         the balances and allowances are checked to determine the order is fillable for a
- *                                         non-zero amount. We call such orders "partially fillable orders".
- * simulationTakerAddress: During the maker transfer simulation validation, tokens are sent from the maker to the simulationTakerAddress. This defaults
- *                         to the takerAddress specified in the order. Some tokens prevent transfer to the NULL address so this address can be specified.
+ *
+ * `validateRemainingOrderAmountIsFillable`: The validation method ensures that the maker has sufficient allowance/balance to fill
+ *                                         the entire remaining order amount. If this option is set to false, the balances
+ *                                         and allowances are calculated to determine the order is fillable for a
+ *                                         non-zero amount (some value less than or equal to the order remaining amount).
+ *                                         We call such orders "partially fillable orders". Default is `true`.
+ *
+ * `simulationTakerAddress`: During the maker transfer simulation, tokens are sent from the maker to the `simulationTakerAddress`. This defaults
+ *                           to the `takerAddress` specified in the order. Some tokens prevent transfer to the NULL address so this address can be specified.
  */
 export interface ValidateOrderFillableOpts {
     expectedFillTakerTokenAmount?: BigNumber;