crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation and changelog

Browse Source
This commit is contained in:
Jacob Evans 2019-03-28 14:49:22 +01:00
parent 1f2214f891
commit d8bfc92cc5
No known key found for this signature in database
GPG Key ID: 2036DA2ADDFB0842
2 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
packages/contract-wrappers/CHANGELOG.json
View File

@ -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
}
]

17
packages/contract-wrappers/src/types.ts
View File

@ -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;