Final docs gen
This commit is contained in:
@@ -15,7 +15,7 @@ for an Ethereum address and assetData
|
||||
|
||||
▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
|
||||
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L15)*
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L15)*
|
||||
|
||||
Get balance of assetData for userAddress
|
||||
|
||||
@@ -36,7 +36,7 @@ ___
|
||||
|
||||
▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
|
||||
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L22)*
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L22)*
|
||||
|
||||
Get the 0x asset proxy allowance of assetData for userAddress
|
||||
|
||||
@@ -70,7 +70,7 @@ Allowance amount in base units
|
||||
|
||||
▸ **deleteAll**(): *void*
|
||||
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)*
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)*
|
||||
|
||||
**Returns:** *void*
|
||||
|
||||
@@ -80,7 +80,7 @@ ___
|
||||
|
||||
▸ **deleteBalance**(`assetData`: string, `userAddress`: string): *void*
|
||||
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)*
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -97,7 +97,7 @@ ___
|
||||
|
||||
▸ **deleteProxyAllowance**(`assetData`: string, `userAddress`: string): *void*
|
||||
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)*
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -114,7 +114,7 @@ ___
|
||||
|
||||
▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
|
||||
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:4](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)*
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:4](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -131,7 +131,7 @@ ___
|
||||
|
||||
▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
|
||||
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)*
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -148,7 +148,7 @@ ___
|
||||
|
||||
▸ **setBalance**(`assetData`: string, `userAddress`: string, `balance`: `BigNumber`): *void*
|
||||
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)*
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -166,7 +166,7 @@ ___
|
||||
|
||||
▸ **setProxyAllowance**(`assetData`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void*
|
||||
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)*
|
||||
*Defined in [abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -197,7 +197,7 @@ and whether it's been cancelled.
|
||||
|
||||
▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise<BigNumber>`*
|
||||
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L15)*
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L15)*
|
||||
|
||||
Get the amount of the order's takerToken amount already filled
|
||||
|
||||
@@ -217,7 +217,7 @@ ___
|
||||
|
||||
▸ **getZRXAssetData**(): *string*
|
||||
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L22)*
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L22)*
|
||||
|
||||
**Returns:** *string*
|
||||
|
||||
@@ -227,7 +227,7 @@ ___
|
||||
|
||||
▸ **isOrderCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise<boolean>`*
|
||||
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L21)*
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:21](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L21)*
|
||||
|
||||
Whether an order is cancelled
|
||||
|
||||
@@ -260,7 +260,7 @@ Whether or not the order is cancelled
|
||||
|
||||
▸ **deleteAll**(): *void*
|
||||
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:11](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L11)*
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:11](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L11)*
|
||||
|
||||
**Returns:** *void*
|
||||
|
||||
@@ -270,7 +270,7 @@ ___
|
||||
|
||||
▸ **deleteFilledTakerAmount**(`orderHash`: string): *void*
|
||||
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L8)*
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L8)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -286,7 +286,7 @@ ___
|
||||
|
||||
▸ **deleteIsCancelled**(`orderHash`: string): *void*
|
||||
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L10)*
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L10)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -302,7 +302,7 @@ ___
|
||||
|
||||
▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise<BigNumber>`*
|
||||
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L5)*
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L5)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -318,7 +318,7 @@ ___
|
||||
|
||||
▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise<boolean>`*
|
||||
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L6)*
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L6)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -334,7 +334,7 @@ ___
|
||||
|
||||
▸ **getZRXAssetData**(): *string*
|
||||
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L12)*
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L12)*
|
||||
|
||||
**Returns:** *string*
|
||||
|
||||
@@ -344,7 +344,7 @@ ___
|
||||
|
||||
▸ **setFilledTakerAmount**(`orderHash`: string, `balance`: `BigNumber`): *void*
|
||||
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L7)*
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L7)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -361,7 +361,7 @@ ___
|
||||
|
||||
▸ **setIsCancelled**(`orderHash`: string, `isCancelled`: boolean): *void*
|
||||
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L9)*
|
||||
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L9)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -390,7 +390,7 @@ An exchange transfer simulator which simulates asset transfers exactly how the
|
||||
|
||||
\+ **new ExchangeTransferSimulator**(`store`: [AbstractBalanceAndProxyAllowanceLazyStore](_abstract_abstract_balance_and_proxy_allowance_lazy_store_.abstractbalanceandproxyallowancelazystore.md)): *[ExchangeTransferSimulator](#class-exchangetransfersimulator)*
|
||||
|
||||
*Defined in [exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/exchange_transfer_simulator.ts#L50)*
|
||||
*Defined in [exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/exchange_transfer_simulator.ts#L50)*
|
||||
|
||||
Instantiate a ExchangeTransferSimulator
|
||||
|
||||
@@ -410,7 +410,7 @@ an instance of ExchangeTransferSimulator
|
||||
|
||||
▸ **transferFromAsync**(`assetData`: string, `from`: string, `to`: string, `amountInBaseUnits`: `BigNumber`, `tradeSide`: [TradeSide](#enumeration-tradeside), `transferType`: [TransferType](#enumeration-transfertype)): *`Promise<void>`*
|
||||
|
||||
*Defined in [exchange_transfer_simulator.ts:70](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/exchange_transfer_simulator.ts#L70)*
|
||||
*Defined in [exchange_transfer_simulator.ts:70](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/exchange_transfer_simulator.ts#L70)*
|
||||
|
||||
Simulates transferFrom call performed by a proxy
|
||||
|
||||
@@ -442,7 +442,7 @@ Name | Type | Description |
|
||||
|
||||
\+ **new OrderStateUtils**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](_abstract_abstract_balance_and_proxy_allowance_fetcher_.abstractbalanceandproxyallowancefetcher.md), `orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md)): *[OrderStateUtils](#class-orderstateutils)*
|
||||
|
||||
*Defined in [order_state_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/order_state_utils.ts#L98)*
|
||||
*Defined in [order_state_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/order_state_utils.ts#L98)*
|
||||
|
||||
Instantiate OrderStateUtils
|
||||
|
||||
@@ -463,7 +463,7 @@ Instance of OrderStateUtils
|
||||
|
||||
▸ **getMaxFillableTakerAssetAmountAsync**(`signedOrder`: `SignedOrder`, `takerAddress`: string): *`Promise<BigNumber>`*
|
||||
|
||||
*Defined in [order_state_utils.ts:192](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/order_state_utils.ts#L192)*
|
||||
*Defined in [order_state_utils.ts:192](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/order_state_utils.ts#L192)*
|
||||
|
||||
Get the max amount of the supplied order's takerAmount that could still be filled
|
||||
|
||||
@@ -484,7 +484,7 @@ ___
|
||||
|
||||
▸ **getOpenOrderRelevantStateAsync**(`signedOrder`: `SignedOrder`): *`Promise<OrderRelevantState>`*
|
||||
|
||||
*Defined in [order_state_utils.ts:162](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/order_state_utils.ts#L162)*
|
||||
*Defined in [order_state_utils.ts:162](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/order_state_utils.ts#L162)*
|
||||
|
||||
Get state relevant to an order (i.e makerBalance, makerAllowance, filledTakerAssetAmount, etc...
|
||||
|
||||
@@ -504,7 +504,7 @@ ___
|
||||
|
||||
▸ **getOpenOrderStateAsync**(`signedOrder`: `SignedOrder`, `transactionHash?`: undefined | string): *`Promise<OrderState>`*
|
||||
|
||||
*Defined in [order_state_utils.ts:122](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/order_state_utils.ts#L122)*
|
||||
*Defined in [order_state_utils.ts:122](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/order_state_utils.ts#L122)*
|
||||
|
||||
Get the orderState for an "open" order (i.e where takerAddress=NULL_ADDRESS)
|
||||
This method will only check the maker's balance/allowance to calculate the
|
||||
@@ -539,7 +539,7 @@ A utility class for validating orders
|
||||
|
||||
\+ **new OrderValidationUtils**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md), `supportedProvider`: `SupportedProvider`): *[OrderValidationUtils](#class-ordervalidationutils)*
|
||||
|
||||
*Defined in [order_validation_utils.ts:159](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/order_validation_utils.ts#L159)*
|
||||
*Defined in [order_validation_utils.ts:159](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/order_validation_utils.ts#L159)*
|
||||
|
||||
Instantiate OrderValidationUtils
|
||||
|
||||
@@ -560,7 +560,7 @@ An instance of OrderValidationUtils
|
||||
|
||||
▸ **validateFillOrderThrowIfInvalidAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `supportedProvider`: `SupportedProvider`, `signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `takerAddress`: string, `zrxAssetData`: string): *`Promise<BigNumber>`*
|
||||
|
||||
*Defined in [order_validation_utils.ts:237](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/order_validation_utils.ts#L237)*
|
||||
*Defined in [order_validation_utils.ts:237](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/order_validation_utils.ts#L237)*
|
||||
|
||||
Validate a call to FillOrder and throw if it wouldn't succeed
|
||||
|
||||
@@ -583,7 +583,7 @@ ___
|
||||
|
||||
▸ **validateOrderFillableOrThrowAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `signedOrder`: `SignedOrder`, `zrxAssetData`: string, `expectedFillTakerTokenAmount?`: `BigNumber`): *`Promise<void>`*
|
||||
|
||||
*Defined in [order_validation_utils.ts:185](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/order_validation_utils.ts#L185)*
|
||||
*Defined in [order_validation_utils.ts:185](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/order_validation_utils.ts#L185)*
|
||||
|
||||
Validate if the supplied order is fillable, and throw if it isn't
|
||||
|
||||
@@ -604,7 +604,7 @@ ___
|
||||
|
||||
▸ **isRoundingErrorFloor**(`numerator`: `BigNumber`, `denominator`: `BigNumber`, `target`: `BigNumber`): *boolean*
|
||||
|
||||
*Defined in [order_validation_utils.ts:34](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/order_validation_utils.ts#L34)*
|
||||
*Defined in [order_validation_utils.ts:34](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/order_validation_utils.ts#L34)*
|
||||
|
||||
A Typescript implementation mirroring the implementation of isRoundingError in the
|
||||
Exchange smart contract
|
||||
@@ -625,7 +625,7 @@ ___
|
||||
|
||||
▸ **validateFillOrderBalancesAllowancesThrowIfInvalidAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `senderAddress`: string, `zrxAssetData`: string): *`Promise<void>`*
|
||||
|
||||
*Defined in [order_validation_utils.ts:61](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/order_validation_utils.ts#L61)*
|
||||
*Defined in [order_validation_utils.ts:61](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/order_validation_utils.ts#L61)*
|
||||
|
||||
Validate that the maker & taker have sufficient balances/allowances
|
||||
to fill the supplied order to the fillTakerAssetAmount amount
|
||||
@@ -648,7 +648,7 @@ ___
|
||||
|
||||
▸ **validateMakerTransferThrowIfInvalidAsync**(`networkId`: `NetworkId`, `supportedProvider`: `SupportedProvider`, `signedOrder`: `SignedOrder`, `makerAssetAmount`: `BigNumber`, `takerAddress?`: undefined | string): *`Promise<void>`*
|
||||
|
||||
*Defined in [order_validation_utils.ts:127](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/order_validation_utils.ts#L127)*
|
||||
*Defined in [order_validation_utils.ts:127](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/order_validation_utils.ts#L127)*
|
||||
|
||||
Validate the transfer from the maker to the taker. This is simulated on-chain
|
||||
via an eth_call. If this call fails, the asset is currently nontransferable.
|
||||
@@ -680,7 +680,7 @@ Name | Type | Description |
|
||||
|
||||
\+ **new RemainingFillableCalculator**(`orderFee`: `BigNumber`, `orderAssetAmount`: `BigNumber`, `isTraderAssetZRX`: boolean, `transferrableAssetAmount`: `BigNumber`, `transferrableFeeAmount`: `BigNumber`, `remainingOrderAssetAmount`: `BigNumber`): *[RemainingFillableCalculator](#class-remainingfillablecalculator)*
|
||||
|
||||
*Defined in [remaining_fillable_calculator.ts:11](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/remaining_fillable_calculator.ts#L11)*
|
||||
*Defined in [remaining_fillable_calculator.ts:11](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/remaining_fillable_calculator.ts#L11)*
|
||||
|
||||
**Parameters:**
|
||||
|
||||
@@ -701,7 +701,7 @@ Name | Type |
|
||||
|
||||
▸ **computeRemainingFillable**(): *`BigNumber`*
|
||||
|
||||
*Defined in [remaining_fillable_calculator.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/remaining_fillable_calculator.ts#L30)*
|
||||
*Defined in [remaining_fillable_calculator.ts:30](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/remaining_fillable_calculator.ts#L30)*
|
||||
|
||||
**Returns:** *`BigNumber`*
|
||||
|
||||
@@ -726,7 +726,7 @@ Copy on read store for balances/proxyAllowances of tokens/accounts
|
||||
|
||||
\+ **new BalanceAndProxyAllowanceLazyStore**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](_abstract_abstract_balance_and_proxy_allowance_fetcher_.abstractbalanceandproxyallowancefetcher.md)): *[BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore)*
|
||||
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L23)*
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:23](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L23)*
|
||||
|
||||
Instantiates a BalanceAndProxyAllowanceLazyStore
|
||||
|
||||
@@ -746,7 +746,7 @@ Instance of BalanceAndProxyAllowanceLazyStore
|
||||
|
||||
▸ **deleteAll**(): *void*
|
||||
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:136](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L136)*
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:136](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L136)*
|
||||
|
||||
Delete all balances & allowances
|
||||
|
||||
@@ -758,7 +758,7 @@ ___
|
||||
|
||||
▸ **deleteAllERC721ProxyAllowance**(`tokenAddress`: string, `userAddress`: string): *void*
|
||||
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:119](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L119)*
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:119](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L119)*
|
||||
|
||||
Clear all ERC721 0x proxy allowances a user has on all items of a specific ERC721 contract
|
||||
|
||||
@@ -777,7 +777,7 @@ ___
|
||||
|
||||
▸ **deleteBalance**(`assetData`: string, `userAddress`: string): *void*
|
||||
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L63)*
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L63)*
|
||||
|
||||
Clear the balance of an asset for a user
|
||||
|
||||
@@ -796,7 +796,7 @@ ___
|
||||
|
||||
▸ **deleteProxyAllowance**(`assetData`: string, `userAddress`: string): *void*
|
||||
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:106](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L106)*
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:106](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L106)*
|
||||
|
||||
Clear the 0x asset proxy allowance
|
||||
|
||||
@@ -815,7 +815,7 @@ ___
|
||||
|
||||
▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
|
||||
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L39)*
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:39](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L39)*
|
||||
|
||||
Get a users balance of an asset
|
||||
|
||||
@@ -834,7 +834,7 @@ ___
|
||||
|
||||
▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
|
||||
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L76)*
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:76](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L76)*
|
||||
|
||||
Get the 0x asset proxy allowance
|
||||
|
||||
@@ -853,7 +853,7 @@ ___
|
||||
|
||||
▸ **setBalance**(`assetData`: string, `userAddress`: string, `balance`: `BigNumber`): *void*
|
||||
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:52](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L52)*
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:52](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L52)*
|
||||
|
||||
Set the balance of an asset for a user
|
||||
|
||||
@@ -873,7 +873,7 @@ ___
|
||||
|
||||
▸ **setProxyAllowance**(`assetData`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void*
|
||||
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:95](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L95)*
|
||||
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:95](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L95)*
|
||||
|
||||
Set the 0x asset proxy allowance
|
||||
|
||||
@@ -908,7 +908,7 @@ Copy on read store for balances/proxyAllowances of tokens/accounts
|
||||
|
||||
\+ **new OrderFilledCancelledLazyStore**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md)): *[OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore)*
|
||||
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L19)*
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L19)*
|
||||
|
||||
Instantiate a OrderFilledCancelledLazyStore
|
||||
|
||||
@@ -928,7 +928,7 @@ An instance of OrderFilledCancelledLazyStore
|
||||
|
||||
▸ **deleteAll**(): *void*
|
||||
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:90](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L90)*
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:90](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L90)*
|
||||
|
||||
Clear all filled/cancelled state
|
||||
|
||||
@@ -940,7 +940,7 @@ ___
|
||||
|
||||
▸ **deleteAllFilled**(): *void*
|
||||
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:103](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L103)*
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:103](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L103)*
|
||||
|
||||
Clear all filled state
|
||||
|
||||
@@ -952,7 +952,7 @@ ___
|
||||
|
||||
▸ **deleteAllIsCancelled**(): *void*
|
||||
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:97](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L97)*
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:97](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L97)*
|
||||
|
||||
Clear all cancelled state
|
||||
|
||||
@@ -964,7 +964,7 @@ ___
|
||||
|
||||
▸ **deleteFilledTakerAmount**(`orderHash`: string): *void*
|
||||
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:55](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L55)*
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:55](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L55)*
|
||||
|
||||
Clear the filledTakerAssetAmount of an order
|
||||
|
||||
@@ -982,7 +982,7 @@ ___
|
||||
|
||||
▸ **deleteIsCancelled**(`orderHash`: string): *void*
|
||||
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:84](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L84)*
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:84](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L84)*
|
||||
|
||||
Clear whether the order has been cancelled if already set
|
||||
|
||||
@@ -1000,7 +1000,7 @@ ___
|
||||
|
||||
▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise<BigNumber>`*
|
||||
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:35](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L35)*
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:35](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L35)*
|
||||
|
||||
Get the filledTakerAssetAmount of an order
|
||||
|
||||
@@ -1020,7 +1020,7 @@ ___
|
||||
|
||||
▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise<boolean>`*
|
||||
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L63)*
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L63)*
|
||||
|
||||
Check if an order has been cancelled
|
||||
|
||||
@@ -1040,7 +1040,7 @@ ___
|
||||
|
||||
▸ **getZRXAssetData**(): *string*
|
||||
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:109](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L109)*
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:109](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L109)*
|
||||
|
||||
Get the ZRX assetData
|
||||
|
||||
@@ -1052,7 +1052,7 @@ ___
|
||||
|
||||
▸ **setFilledTakerAmount**(`orderHash`: string, `filledTakerAmount`: `BigNumber`): *void*
|
||||
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:48](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L48)*
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:48](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L48)*
|
||||
|
||||
Set the filledTakerAssetAmount of an order
|
||||
|
||||
@@ -1071,7 +1071,7 @@ ___
|
||||
|
||||
▸ **setIsCancelled**(`orderHash`: string, `isCancelled`: boolean): *void*
|
||||
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:77](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L77)*
|
||||
*Defined in [store/order_filled_cancelled_lazy_store.ts:77](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L77)*
|
||||
|
||||
Set whether an order has been cancelled or not
|
||||
|
||||
@@ -1095,7 +1095,7 @@ Name | Type | Description |
|
||||
|
||||
• **Maker**: = "maker"
|
||||
|
||||
*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L9)*
|
||||
*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L9)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1103,7 +1103,7 @@ ___
|
||||
|
||||
• **Taker**: = "taker"
|
||||
|
||||
*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L10)*
|
||||
*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L10)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -1116,7 +1116,7 @@ ___
|
||||
|
||||
• **Fee**: = "fee"
|
||||
|
||||
*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L15)*
|
||||
*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L15)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1124,7 +1124,7 @@ ___
|
||||
|
||||
• **Trade**: = "trade"
|
||||
|
||||
*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L14)*
|
||||
*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L14)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -1137,7 +1137,7 @@ ___
|
||||
|
||||
• **InvalidMetamaskSigner**: = "MetaMask provider must be wrapped in a MetamaskSubprovider (from the '@0x/subproviders' package) in order to work with this method."
|
||||
|
||||
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L5)*
|
||||
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L5)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1145,7 +1145,7 @@ ___
|
||||
|
||||
• **InvalidSignature**: = "INVALID_SIGNATURE"
|
||||
|
||||
*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L4)*
|
||||
*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L4)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -1162,7 +1162,7 @@ ___
|
||||
|
||||
• **expirationTimeSeconds**? : *`BigNumber`*
|
||||
|
||||
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L25)*
|
||||
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L25)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1170,7 +1170,7 @@ ___
|
||||
|
||||
• **feeRecipientAddress**? : *undefined | string*
|
||||
|
||||
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L23)*
|
||||
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L23)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1178,7 +1178,7 @@ ___
|
||||
|
||||
• **makerFee**? : *`BigNumber`*
|
||||
|
||||
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L21)*
|
||||
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L21)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1186,7 +1186,7 @@ ___
|
||||
|
||||
• **salt**? : *`BigNumber`*
|
||||
|
||||
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L24)*
|
||||
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L24)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1194,7 +1194,7 @@ ___
|
||||
|
||||
• **senderAddress**? : *undefined | string*
|
||||
|
||||
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L20)*
|
||||
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L20)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1202,7 +1202,7 @@ ___
|
||||
|
||||
• **takerAddress**? : *undefined | string*
|
||||
|
||||
*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L19)*
|
||||
*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L19)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1210,7 +1210,7 @@ ___
|
||||
|
||||
• **takerFee**? : *`BigNumber`*
|
||||
|
||||
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L22)*
|
||||
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L22)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -1231,7 +1231,7 @@ ___
|
||||
|
||||
• **feeOrdersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]*
|
||||
|
||||
*Defined in [types.ts:70](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L70)*
|
||||
*Defined in [types.ts:70](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L70)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1239,7 +1239,7 @@ ___
|
||||
|
||||
• **remainingFeeAmount**: *`BigNumber`*
|
||||
|
||||
*Defined in [types.ts:71](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L71)*
|
||||
*Defined in [types.ts:71](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L71)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1247,7 +1247,7 @@ ___
|
||||
|
||||
• **resultFeeOrders**: *`T`[]*
|
||||
|
||||
*Defined in [types.ts:69](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L69)*
|
||||
*Defined in [types.ts:69](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L69)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -1273,7 +1273,7 @@ Defaults to 0
|
||||
|
||||
• **remainingFillableFeeAmounts**? : *`BigNumber`[]*
|
||||
|
||||
*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L64)*
|
||||
*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L64)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1281,7 +1281,7 @@ ___
|
||||
|
||||
• **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]*
|
||||
|
||||
*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L63)*
|
||||
*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L63)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1289,7 +1289,7 @@ ___
|
||||
|
||||
• **slippageBufferAmount**? : *`BigNumber`*
|
||||
|
||||
*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L65)*
|
||||
*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L65)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -1312,7 +1312,7 @@ Defaults to 0
|
||||
|
||||
• **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]*
|
||||
|
||||
*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L36)*
|
||||
*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L36)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1320,7 +1320,7 @@ ___
|
||||
|
||||
• **slippageBufferAmount**? : *`BigNumber`*
|
||||
|
||||
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L37)*
|
||||
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L37)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -1343,7 +1343,7 @@ Defaults to 0
|
||||
|
||||
• **remainingFillableTakerAssetAmounts**? : *`BigNumber`[]*
|
||||
|
||||
*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L48)*
|
||||
*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L48)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1351,7 +1351,7 @@ ___
|
||||
|
||||
• **slippageBufferAmount**? : *`BigNumber`*
|
||||
|
||||
*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L49)*
|
||||
*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L49)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -1372,7 +1372,7 @@ ___
|
||||
|
||||
• **ordersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]*
|
||||
|
||||
*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L76)*
|
||||
*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L76)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1380,7 +1380,7 @@ ___
|
||||
|
||||
• **remainingFillAmount**: *`BigNumber`*
|
||||
|
||||
*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L77)*
|
||||
*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L77)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1388,7 +1388,7 @@ ___
|
||||
|
||||
• **resultOrders**: *`T`[]*
|
||||
|
||||
*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L75)*
|
||||
*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L75)*
|
||||
|
||||
<hr />
|
||||
|
||||
@@ -1409,7 +1409,7 @@ ___
|
||||
|
||||
• **ordersRemainingFillableTakerAssetAmounts**: *`BigNumber`[]*
|
||||
|
||||
*Defined in [types.ts:82](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L82)*
|
||||
*Defined in [types.ts:82](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L82)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1417,7 +1417,7 @@ ___
|
||||
|
||||
• **remainingFillAmount**: *`BigNumber`*
|
||||
|
||||
*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L83)*
|
||||
*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L83)*
|
||||
|
||||
___
|
||||
|
||||
@@ -1425,7 +1425,7 @@ ___
|
||||
|
||||
• **resultOrders**: *`T`[]*
|
||||
|
||||
*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/order-utils/src/types.ts#L81)*
|
||||
*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/order-utils/src/types.ts#L81)*
|
||||
|
||||
<hr />
|
||||
|
||||
|
||||
Reference in New Issue
Block a user