crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
protocol/packages/order-utils/docs/reference.mdx
Xianny a57dd427ca
Merge development into 3.0 (#2170) 
* Added longer timeout for algolia admin operations. Added an option to apply hidden and custom labels to filters from algolia. Added sorting guides (alphabetically) and tools (by community maintenance and alphabetically).

* Fixed some types in guides

* Updated webpack, webpack-dev-server, webpack-bundle-analyzer, webpack-cli versions

* Updated / cleaned up babel and mdx packages

* Updated terser webpack plugin; Removed uglify plugin (unused). Added parallel option for terser. Added target browsers and cache directory option for babel-loader

* Webpack changes: using eval-source-map for development, added parallel option to Terser plugin, added cache loader and caching directory to mdx / babel loaders.

* Removed unusued pkg: body-scroll-lock

* Removed unused jsonschema / @types/jsonschema packages

* Removed unused less node package, adjusted less loader rules to match other loaders in webpack config

* Removed unusued node-sass package. Left sass-loader for webpack intact.

* Removed unused package react-lazyload

* Removed unused package react-typist

* Removed react-tap-event types as it's not used anymore. Reinstalled node-sass as a dev dependency as it's needed by sass-loader

* Moves @0x/types and @0x/typescript-typings to devDependencies

* Replaced react loadable (only used in Icon) with the native react lazy / suspense. Removed loadable nad its types from package.json

* Removed unused make-promises-safe package

* Moved animations to public and compressed files

* Added opening step links in new tab if the url is valid

* Moved @0x/types back to dependencies.

* Added animation wrapper with positioning props. Updated animations for core concepts.

* Replaced images for core concepts. Fixed a bug causing duplicate props on image and its container in mdx

* Remove legacy FAQ

* Update yarn.lock

* Add MD docs diff test to CI

* Remove unused dep

* Update docs to latest format

* Update yarn.lock

* Update ts-doc-gen with fix for multi-link lines

* Final docs gen

* Fix home route

* Update yarn.lock

* Add Golang Mesh RPC package and update versions

* Update the tools MDX files from authoritative S3 before build and dev server start

* Gitignore the tool MDX files in website repo

* Redirect old docs pages and wiki to new doc pages

* Move out Algolia indexing command-line tool out of website and remove need to expose admin key

* Add updating tools from S3 and indexing content on Algolia to deployment commands

* Add note about admin API env var needed for indexing docs

* Remove scripts gitignore since we don't have monorepo scripts in each package anymore

* Segregate indexes by environment

* Fixed 404 display for docs pages

* Removed webpack bundle analyzer

* Fix search and indexing

* Use `yarn` because otherwise the flags don't get passed down properly

* Improve indexing comment

* Remove legacy doc pages

* Fix linter errors

* Fix clean command to remove bundles recursively

* Revert react and react-dom versions in Instant

* Remove old doc md files

* Fix links

* Fix prettier

* Combine @0x/utils exports

* Update doc links

* Remove unused components

* Fix TS error

* Add missing new line

* Update Guides

* Ignore auto-generated MDX in website repo

* Prettier fix

* Add all guides to the sitemap.txt

* Add MMing guide

* Fix Get Started links

* Add 0x Extensions guide

* Replace all links to wiki with links to guides section

* Fix all /docs/{pkg} links to /docs/tools/{pkg}

* Remove deployer endpoint that is no longer used

* Fix links in Core Concepts

* Fixed regex to not remove hashes on links beyond the initial one

* Fixed huge width on instant screenshot

* Cleaned up core concept illustrations

* Started updating tool titles

* Fixed sectionizing headings in docs: Nested sections do not get wrapped in parent sections anymore; only sectionizing headings that need to be sectionized (i.e. that appear in the table of contents)

* Stylstic fix for the new way we sectionize headings / table of contents

* Change CoordinatorWrapper constructor to take a provider

* Added autolinking headings in mdx docs

* Refactor doc generation script to only generate MD docs and to have them reflect what is exported in their respective index.ts files

* Update ts-doc-gen

* Pass in provider, not Web3Wrapper

* Add back logic to prune out private methods

* Write algolia_metadata to utils dir

* Remove duplicate algolia_meta

* Add more packages to those we generate docs for and remove unused flags

* Update reference.mdx files

* Hide tools from homepage that have isHidden flag

* Link 0x.js to it's reference page

* Update tool naming to be more human readable

* Remove order-watcher reference doc

* Add blurb about on-chain API Explorer

* Add "On-chain" prefix to section name

* Remove committed reference file

* Sorting guides by difficulty and alphabetically

* Pushed sorting guides titles case-insensitive

* Sorting tools by difficulty and alphabetically. Removed icons from featured tools. Extracted common difficultyOrder constant

* Update ts-doc-gen so that it properly converts module relative links to anchor links

* Update doc references

* Remove "Relayers" topic/tag

* Prettier fix

* Remove hr so we don't have a bunch in a row

* Cleaned up CLI tag and added link to tools on API page

* Cleaned up some Guide titles

* Added bug bounty program guide

* Fixed a bug in algolia_meta

* Thrid level of nesting / temporary webpack config

* Open help link in new tab

* Link Python tools to doc pages not PyPi

* Fix links in guides

* Remove unused variables

* Revert webpack config

* Extracted common styles for levels of nesting deeper than 1 in the mdx table of contents

* Smoother animation on active table of contents state change

* Autolink headings in mdx only up to h3. Added heading sizes (in px) for h4,h5,h6 in mdx headings

* Fix prettier

* Adjusted font-size for paragraph, ordered and unordered lists. Fixed line-heights and colors too.

* Update ts-doc-gen and the reference docs

* Replace 0xproject.com urls with 0x.org

* Update README links

* Fix header sizes to display optimally in sidebar

* Fixed an issue with other nodes than text being parsed incorrectly in the table of contents

* Fixed styles for table of contents

* Use a different babel plugin that works in a production webpack build

* Unbroke build process / generating toc

* Changed line-height to 1.6 for paragraph

* Adjust scrollbar / toc height to available space

* Fixed some types

* Remove unnecessary link

* Fix casing on TypeScript

* Fix casing of PyPI

* Remove doc gen from abi-gen-wrappers since it'll be tested via contract-wrappers

* Fix MD docs and make sure generated contract wrappers are being rendered

* Remove generated docs in clean

* Correctly copying code samples

* Several additional fixes to the reference MDX docs

* Changed tools to Tools & Libraries - top nav left as just tools

* Changed references from Asset Buyer to Asset Swapper

* Changed trader keyword to trading

* Nevermind, changed back to Trader

* Sneaking in updated product dropdown menu titles based on Will's feedback

* Removed the word wiki from resources dropdown

* Open legal guide in same window

* Removed the isCommunity filter / custom filter labels functionality (only used for that before)

* Update ts-doc-gen version to one that fixes issues with Object Literals and removes Hierarchy sections and Module headers

* update yarn.lock

* Remove unused code

* Remove unused import

* Remove unused imports

* Remove unused import

* Fix prettier

* Update outdating dep version

* Created a color scheme for code snippets. Fixed language not being passed to some code blocks in two guides.

* Update abi-gen-wrappers dep version

* Update Algolia to production account

* Fix prettier

* Fix prettier in algolia_meta

* Remove packages/dev-tools-pages folder and update yarn.lock

* Remove other random references to dev-tools-pages

* Fix website

* Changed the order of indices in search suggestions

* Removed a comment

* Added scrollbar size adjustment on resize / scroll

* Rendering sidebar on mobile without any event listeners / taxing calculations / changes in height

* Added a performance comment

* Simplified table of contents

* Update ganache-cli to later version

* Remove bundle dirs too

* Added keeping active link in view when scrolling content in the docs

* Increase available memory for webpack

* Update contract addresses

* Update market-making guide to mention Mesh as an alternative to SRA

* Update Web3 Provider Explained guide

* Re-wrote Ganache Setup guide into a Setting up a local 0x testnet guide

* Export more of abi-gen-wrappers from contract-wrappers

* Final update of reference docs

* Add contract-wrappers MD docs and update it's index.ts so that no types are missing

* Fix prettier

* Increase the memory allocation for building the website

* Remove use of remove type

* Check if link is a valid url in mdx inline link: if so, open in a new tab, if not, same tab.

* Print out which snapshot version is being downloaded

* Updated CHANGELOGS & MD docs

* Publish

 - @0x/contracts-asset-proxy@2.2.7
 - @0x/contracts-coordinator@2.0.12
 - @0x/contracts-dev-utils@0.0.9
 - @0x/contracts-erc1155@1.1.14
 - @0x/contracts-erc20@2.2.13
 - @0x/contracts-erc721@2.1.14
 - @0x/contracts-exchange-forwarder@3.0.11
 - @0x/contracts-exchange-libs@3.0.7
 - @0x/contracts-exchange@2.1.13
 - @0x/contracts-extensions@4.0.7
 - @0x/contracts-multisig@3.1.13
 - @0x/contracts-test-utils@3.1.15
 - @0x/contracts-utils@3.2.3
 - 0x.js@7.0.1
 - @0x/abi-gen-wrappers@5.3.1
 - @0x/abi-gen@4.2.0
 - @0x/assert@2.1.5
 - @0x/asset-buyer@6.1.13
 - @0x/asset-swapper@1.0.3
 - @0x/base-contract@5.3.3
 - @0x/connect@5.0.18
 - @0x/contract-artifacts@2.2.1
 - @0x/contract-wrappers@12.0.0
 - @0x/contracts-gen@1.0.14
 - @0x/dev-tools-pages@0.0.30
 - @0x/dev-utils@2.3.2
 - ethereum-types@2.1.5
 - @0x/fill-scenarios@3.0.18
 - @0x/instant@1.0.30
 - @0x/json-schemas@4.0.1
 - @0x/migrations@4.3.1
 - @0x/monorepo-scripts@1.0.36
 - @0x/order-utils@8.3.1
 - @0x/sol-compiler@3.1.14
 - @0x/sol-coverage@3.0.11
 - @0x/sol-doc@2.0.18
 - @0x/sol-profiler@3.1.13
 - @0x/sol-resolver@2.0.10
 - @0x/sol-trace@2.0.19
 - @0x/sol-tracing-utils@6.0.18
 - @0x/sra-spec@2.0.16
 - @0x/subproviders@5.0.3
 - @0x/testnet-faucets@1.0.86
 - @0x/types@2.4.2
 - @0x/typescript-typings@4.2.5
 - @0x/utils@4.5.1
 - @0x/web3-wrapper@6.0.12
 - @0x/website@0.0.89

* Remove the website from the monorepo

* Update yarn.lock

* Remove website files that were accidentally merged back in

* Use local EVM for pure functions (#2108)

* add local evm for pure functions

* increase container size to >=8gb for static-tests

* increase max bundle size because of ethereumjs-vm dependency

* add declarations for ethereumjs-vm in @0x/typescript-typings

* Make `OrdersChannelSubscriptionOpts` conform to SRAv2

* Make it easier to use validateOrderFillableOrThrowAsync (#2096)

* make it easier to use validateOrderFillableOrThrowAsync

* add unit tests, use DevUtils

* remove dependency on @0x/order-utils from @0x/migrations

* add devUtils to contract-wrappers (#2146)

* Delete docs in S3 bucket before uploading latest version so we only ever have one version uploaded at a time

* Update to new ts-doc-gen version that fixes links in "Inherited from" lines

* try to fix instant build

* Remove redoc-cli as a dep from sra-spec

* Smooth out some last incompatible types

* Fix prettier

* Add terser-webpack-plugin to 0x.js deps

* @0x/orderbook

* AssetSwapper to use @0x/orderbook

* Remove unused imported type

* Prevent double websocket connections

* Fix build error

* fixed consumer inconsistency bug

* linted + added convenience functionality

* minor changes/typo fixes

* updated websocket

* updated for prettier

* Fix versions and exported types

* move log tests to @0x/abi-gen; delete exchange_wrapper_test (#2160)

* Remove unused exported types

* Fix exports from asset-swapper

* Update exported types for docs

* Update mesh client dep

* Move perPage and 18 precision lower to re-use

* fix ABI encoding/decoding functions (#2165)

* Fix typo at contract import (#2102)

* Updated CHANGELOGS & MD docs

* Publish

 - @0x/contracts-asset-proxy@2.2.8
 - @0x/contracts-coordinator@2.0.13
 - @0x/contracts-dev-utils@0.0.10
 - @0x/contracts-erc1155@1.1.15
 - @0x/contracts-erc20@2.2.14
 - @0x/contracts-erc721@2.1.15
 - @0x/contracts-exchange-forwarder@3.0.12
 - @0x/contracts-exchange-libs@3.0.8
 - @0x/contracts-exchange@2.1.14
 - @0x/contracts-extensions@4.0.8
 - @0x/contracts-multisig@3.1.14
 - @0x/contracts-test-utils@3.1.16
 - @0x/contracts-utils@3.2.4
 - 0x.js@7.0.2
 - @0x/abi-gen-wrappers@5.3.2
 - @0x/abi-gen@4.2.1
 - @0x/assert@2.1.6
 - @0x/asset-buyer@6.1.14
 - @0x/asset-swapper@2.0.0
 - @0x/base-contract@5.4.0
 - @0x/connect@5.0.19
 - @0x/contract-addresses@3.2.0
 - @0x/contract-artifacts@2.2.2
 - @0x/contract-wrappers@12.1.0
 - @0x/contracts-gen@1.0.15
 - @0x/dev-utils@2.3.3
 - ethereum-types@2.1.6
 - @0x/fill-scenarios@3.0.19
 - @0x/instant@1.0.31
 - @0x/json-schemas@4.0.2
 - @0x/migrations@4.3.2
 - @0x/monorepo-scripts@1.0.37
 - @0x/order-utils@8.4.0
 - @0x/orderbook@0.0.2
 - @0x/sol-compiler@3.1.15
 - @0x/sol-coverage@3.0.12
 - @0x/sol-doc@2.0.19
 - @0x/sol-profiler@3.1.14
 - @0x/sol-resolver@2.0.11
 - @0x/sol-trace@2.0.20
 - @0x/sol-tracing-utils@6.0.19
 - @0x/sra-spec@2.0.17
 - @0x/subproviders@5.0.4
 - @0x/testnet-faucets@1.0.87
 - @0x/types@2.4.3
 - @0x/typescript-typings@4.3.0
 - @0x/utils@4.5.2
 - @0x/web3-wrapper@6.0.13

* fix circleci diff

* update changelog
2019-09-19 19:43:08 -07:00

4773 lines
135 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Class: AbstractBalanceAndProxyAllowanceLazyStore
## Implemented by
* [BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore)
## Methods
### `Abstract` deleteAll
▸ **deleteAll**(): *void*
*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)*
**Returns:** *void*
___
### `Abstract` deleteBalance
▸ **deleteBalance**(`assetData`: string, `userAddress`: string): *void*
*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)*
**Parameters:**
Name | Type |
------ | ------ |
`assetData` | string |
`userAddress` | string |
**Returns:** *void*
___
### `Abstract` deleteProxyAllowance
▸ **deleteProxyAllowance**(`assetData`: string, `userAddress`: string): *void*
*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)*
**Parameters:**
Name | Type |
------ | ------ |
`assetData` | string |
`userAddress` | string |
**Returns:** *void*
___
### `Abstract` getBalanceAsync
▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:4](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)*
**Parameters:**
Name | Type |
------ | ------ |
`assetData` | string |
`userAddress` | string |
**Returns:** *`Promise<BigNumber>`*
___
### `Abstract` getProxyAllowanceAsync
▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)*
**Parameters:**
Name | Type |
------ | ------ |
`assetData` | string |
`userAddress` | string |
**Returns:** *`Promise<BigNumber>`*
___
### `Abstract` setBalance
▸ **setBalance**(`assetData`: string, `userAddress`: string, `balance`: `BigNumber`): *void*
*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)*
**Parameters:**
Name | Type |
------ | ------ |
`assetData` | string |
`userAddress` | string |
`balance` | `BigNumber` |
**Returns:** *void*
___
### `Abstract` setProxyAllowance
▸ **setProxyAllowance**(`assetData`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void*
*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)*
**Parameters:**
Name | Type |
------ | ------ |
`assetData` | string |
`userAddress` | string |
`proxyAllowance` | `BigNumber` |
**Returns:** *void*
<hr />
# Class: AbstractOrderFilledCancelledFetcher
An abstract class to be implemented in order to use OrderStateUtils. The class that
implements this interface must be capable of fetching the amount filled of an order
and whether it's been cancelled.
## Methods
### `Abstract` getFilledTakerAmountAsync
▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise<BigNumber>`*
*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L15)*
Get the amount of the order's takerToken amount already filled
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | OrderHash of order we are interested in |
**Returns:** *`Promise<BigNumber>`*
FilledTakerAmount
___
### `Abstract` getZRXAssetData
▸ **getZRXAssetData**(): *string*
*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L22)*
**Returns:** *string*
___
### `Abstract` isOrderCancelledAsync
▸ **isOrderCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise<boolean>`*
*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts:21](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L21)*
Whether an order is cancelled
**Parameters:**
Name | Type |
------ | ------ |
`signedOrder` | `SignedOrder` |
**Returns:** *`Promise<boolean>`*
Whether or not the order is cancelled
<hr />
# Class: AbstractOrderFilledCancelledLazyStore
## Implemented by
* [OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore)
## Methods
### `Abstract` deleteAll
▸ **deleteAll**(): *void*
*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L11)*
**Returns:** *void*
___
### `Abstract` deleteFilledTakerAmount
▸ **deleteFilledTakerAmount**(`orderHash`: string): *void*
*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L8)*
**Parameters:**
Name | Type |
------ | ------ |
`orderHash` | string |
**Returns:** *void*
___
### `Abstract` deleteIsCancelled
▸ **deleteIsCancelled**(`orderHash`: string): *void*
*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L10)*
**Parameters:**
Name | Type |
------ | ------ |
`orderHash` | string |
**Returns:** *void*
___
### `Abstract` getFilledTakerAmountAsync
▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise<BigNumber>`*
*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L5)*
**Parameters:**
Name | Type |
------ | ------ |
`orderHash` | string |
**Returns:** *`Promise<BigNumber>`*
___
### `Abstract` getIsCancelledAsync
▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise<boolean>`*
*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L6)*
**Parameters:**
Name | Type |
------ | ------ |
`signedOrder` | `SignedOrder` |
**Returns:** *`Promise<boolean>`*
___
### `Abstract` getZRXAssetData
▸ **getZRXAssetData**(): *string*
*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L12)*
**Returns:** *string*
___
### `Abstract` setFilledTakerAmount
▸ **setFilledTakerAmount**(`orderHash`: string, `balance`: `BigNumber`): *void*
*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L7)*
**Parameters:**
Name | Type |
------ | ------ |
`orderHash` | string |
`balance` | `BigNumber` |
**Returns:** *void*
___
### `Abstract` setIsCancelled
▸ **setIsCancelled**(`orderHash`: string, `isCancelled`: boolean): *void*
*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L9)*
**Parameters:**
Name | Type |
------ | ------ |
`orderHash` | string |
`isCancelled` | boolean |
**Returns:** *void*
<hr />
# Class: ExchangeTransferSimulator
An exchange transfer simulator which simulates asset transfers exactly how the
0x exchange contract would do them.
## Constructors
\+ **new ExchangeTransferSimulator**(`store`: [AbstractBalanceAndProxyAllowanceLazyStore](_order_utils_src_abstract_abstract_balance_and_proxy_allowance_lazy_store_.abstractbalanceandproxyallowancelazystore.md)): *[ExchangeTransferSimulator](#class-exchangetransfersimulator)*
*Defined in [order-utils/src/exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/exchange_transfer_simulator.ts#L50)*
Instantiate a ExchangeTransferSimulator
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`store` | [AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) | A class that implements AbstractBalanceAndProxyAllowanceLazyStore |
**Returns:** *[ExchangeTransferSimulator](#class-exchangetransfersimulator)*
an instance of ExchangeTransferSimulator
## Methods
### transferFromAsync
▸ **transferFromAsync**(`assetData`: string, `from`: string, `to`: string, `amountInBaseUnits`: `BigNumber`, `tradeSide`: [TradeSide](#enumeration-tradeside), `transferType`: [TransferType](#enumeration-transfertype)): *`Promise<void>`*
*Defined in [order-utils/src/exchange_transfer_simulator.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/exchange_transfer_simulator.ts#L70)*
Simulates transferFrom call performed by a proxy
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Data of the asset being transferred. Includes it's identifying information and assetType, e.g address for ERC20, address & tokenId for ERC721 |
`from` | string | Owner of the transferred tokens |
`to` | string | Recipient of the transferred tokens |
`amountInBaseUnits` | `BigNumber` | The amount of tokens being transferred |
`tradeSide` | [TradeSide](#enumeration-tradeside) | Is Maker/Taker transferring |
`transferType` | [TransferType](#enumeration-transfertype) | Is it a fee payment or a value transfer |
**Returns:** *`Promise<void>`*
<hr />
# Class: OrderStateUtils
## Constructors
\+ **new OrderStateUtils**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](_order_utils_src_abstract_abstract_balance_and_proxy_allowance_fetcher_.abstractbalanceandproxyallowancefetcher.md), `orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_order_utils_src_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md)): *[OrderStateUtils](#class-orderstateutils)*
*Defined in [order-utils/src/order_state_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_state_utils.ts#L98)*
Instantiate OrderStateUtils
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`balanceAndProxyAllowanceFetcher` | [AbstractBalanceAndProxyAllowanceFetcher](#class-abstractbalanceandproxyallowancefetcher) | A class that is capable of fetching balances and proxyAllowances for Ethereum addresses. It must implement AbstractBalanceAndProxyAllowanceFetcher |
`orderFilledCancelledFetcher` | [AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) | A class that is capable of fetching whether an order is cancelled and how much of it has been filled. It must implement AbstractOrderFilledCancelledFetcher |
**Returns:** *[OrderStateUtils](#class-orderstateutils)*
Instance of OrderStateUtils
## Methods
### getMaxFillableTakerAssetAmountAsync
▸ **getMaxFillableTakerAssetAmountAsync**(`signedOrder`: `SignedOrder`, `takerAddress`: string): *`Promise<BigNumber>`*
*Defined in [order-utils/src/order_state_utils.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_state_utils.ts#L192)*
Get the max amount of the supplied order's takerAmount that could still be filled
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signedOrder` | `SignedOrder` | Order of interest |
`takerAddress` | string | Hypothetical taker of the order |
**Returns:** *`Promise<BigNumber>`*
fillableTakerAssetAmount
___
### getOpenOrderRelevantStateAsync
▸ **getOpenOrderRelevantStateAsync**(`signedOrder`: `SignedOrder`): *`Promise<OrderRelevantState>`*
*Defined in [order-utils/src/order_state_utils.ts:162](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_state_utils.ts#L162)*
Get state relevant to an order (i.e makerBalance, makerAllowance, filledTakerAssetAmount, etc...
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signedOrder` | `SignedOrder` | Order of interest |
**Returns:** *`Promise<OrderRelevantState>`*
An instance of OrderRelevantState
___
### getOpenOrderStateAsync
▸ **getOpenOrderStateAsync**(`signedOrder`: `SignedOrder`, `transactionHash?`: undefined | string): *`Promise<OrderState>`*
*Defined in [order-utils/src/order_state_utils.ts:122](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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
OrderState.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signedOrder` | `SignedOrder` | The order of interest |
`transactionHash?` | undefined \| string | - |
**Returns:** *`Promise<OrderState>`*
State relevant to the signedOrder, as well as whether the signedOrder is "valid".
Validity is defined as a non-zero amount of the order can still be filled.
<hr />
# Class: OrderValidationUtils
A utility class for validating orders
## Constructors
\+ **new OrderValidationUtils**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_order_utils_src_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md), `supportedProvider`: [SupportedProvider](#supportedprovider)): *[OrderValidationUtils](#class-ordervalidationutils)*
*Defined in [order-utils/src/order_validation_utils.ts:167](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_validation_utils.ts#L167)*
Instantiate OrderValidationUtils
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderFilledCancelledFetcher` | [AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) | A module that implements the AbstractOrderFilledCancelledFetcher |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for JSON RPC calls |
**Returns:** *[OrderValidationUtils](#class-ordervalidationutils)*
An instance of OrderValidationUtils
## Methods
### simpleValidateOrderFillableOrThrowAsync
▸ **simpleValidateOrderFillableOrThrowAsync**(`provider`: [SupportedProvider](#supportedprovider), `signedOrder`: `SignedOrder`, `opts`: [ValidateOrderFillableOpts](#interface-validateorderfillableopts)): *`Promise<void>`*
*Defined in [order-utils/src/order_validation_utils.ts:196](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_validation_utils.ts#L196)*
Validate if the supplied order is fillable, and throw if it isn't
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`provider` | [SupportedProvider](#supportedprovider) | - | The same provider used to interact with contracts |
`signedOrder` | `SignedOrder` | - | SignedOrder of interest |
`opts` | [ValidateOrderFillableOpts](#interface-validateorderfillableopts) | {} | ValidateOrderFillableOpts options (e.g expectedFillTakerTokenAmount. If it isn't supplied, we check if the order is fillable for the remaining amount. To check if the order is fillable for a non-zero amount, set `validateRemainingOrderAmountIsFillable` to false.) |
**Returns:** *`Promise<void>`*
___
### validateFillOrderThrowIfInvalidAsync
▸ **validateFillOrderThrowIfInvalidAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](_order_utils_src_exchange_transfer_simulator_.exchangetransfersimulator.md), `supportedProvider`: [SupportedProvider](#supportedprovider), `signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `takerAddress`: string, `zrxAssetData`: string): *`Promise<BigNumber>`*
*Defined in [order-utils/src/order_validation_utils.ts:313](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_validation_utils.ts#L313)*
Validate a call to FillOrder and throw if it wouldn't succeed
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`exchangeTradeEmulator` | [ExchangeTransferSimulator](#class-exchangetransfersimulator) | ExchangeTradeEmulator to use |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for JSON RPC requests |
`signedOrder` | `SignedOrder` | SignedOrder of interest |
`fillTakerAssetAmount` | `BigNumber` | Amount we'd like to fill the order for |
`takerAddress` | string | The taker of the order |
`zrxAssetData` | string | ZRX asset data |
**Returns:** *`Promise<BigNumber>`*
___
### validateOrderFillableOrThrowAsync
▸ **validateOrderFillableOrThrowAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `signedOrder`: `SignedOrder`, `zrxAssetData`: string, `expectedFillTakerTokenAmount?`: `BigNumber`): *`Promise<void>`*
*Defined in [order-utils/src/order_validation_utils.ts:261](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_validation_utils.ts#L261)*
Validate if the supplied order is fillable, and throw if it isn't
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`exchangeTradeEmulator` | [ExchangeTransferSimulator](#class-exchangetransfersimulator) | ExchangeTradeEmulator instance |
`signedOrder` | `SignedOrder` | SignedOrder of interest |
`zrxAssetData` | string | ZRX assetData |
`expectedFillTakerTokenAmount?` | `BigNumber` | If supplied, this call will make sure this amount is fillable. If it isn't supplied, we check if the order is fillable for a non-zero amount |
**Returns:** *`Promise<void>`*
___
### `Static` isRoundingErrorFloor
▸ **isRoundingErrorFloor**(`numerator`: `BigNumber`, `denominator`: `BigNumber`, `target`: `BigNumber`): *boolean*
*Defined in [order-utils/src/order_validation_utils.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_validation_utils.ts#L42)*
A TypeScript implementation mirroring the implementation of isRoundingError in the
Exchange smart contract
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`numerator` | `BigNumber` | Numerator value. When used to check an order, pass in `takerAssetFilledAmount` |
`denominator` | `BigNumber` | Denominator value. When used to check an order, pass in `order.takerAssetAmount` |
`target` | `BigNumber` | Target value. When used to check an order, pass in `order.makerAssetAmount` |
**Returns:** *boolean*
___
### `Static` validateFillOrderBalancesAllowancesThrowIfInvalidAsync
▸ **validateFillOrderBalancesAllowancesThrowIfInvalidAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `senderAddress`: string, `zrxAssetData`: string): *`Promise<void>`*
*Defined in [order-utils/src/order_validation_utils.ts:69](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_validation_utils.ts#L69)*
Validate that the maker & taker have sufficient balances/allowances
to fill the supplied order to the fillTakerAssetAmount amount
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`exchangeTradeEmulator` | [ExchangeTransferSimulator](#class-exchangetransfersimulator) | ExchangeTradeEmulator to use |
`signedOrder` | `SignedOrder` | SignedOrder to test |
`fillTakerAssetAmount` | `BigNumber` | Amount of takerAsset to fill the signedOrder |
`senderAddress` | string | Sender of the fillOrder tx |
`zrxAssetData` | string | AssetData for the ZRX token |
**Returns:** *`Promise<void>`*
___
### `Static` validateMakerTransferThrowIfInvalidAsync
▸ **validateMakerTransferThrowIfInvalidAsync**(`networkId`: `NetworkId`, `supportedProvider`: [SupportedProvider](#supportedprovider), `signedOrder`: `SignedOrder`, `makerAssetAmount`: `BigNumber`, `takerAddress?`: undefined | string): *`Promise<void>`*
*Defined in [order-utils/src/order_validation_utils.ts:135](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_validation_utils.ts#L135)*
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.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`networkId` | `NetworkId` | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`signedOrder` | `SignedOrder` | SignedOrder of interest |
`makerAssetAmount` | `BigNumber` | Amount to transfer from the maker |
`takerAddress?` | undefined \| string | The address to transfer to, defaults to signedOrder.takerAddress |
**Returns:** *`Promise<void>`*
<hr />
# Class: BalanceAndProxyAllowanceLazyStore
Copy on read store for balances/proxyAllowances of tokens/accounts
## Implements
* [AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore)
## Constructors
\+ **new BalanceAndProxyAllowanceLazyStore**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](_order_utils_src_abstract_abstract_balance_and_proxy_allowance_fetcher_.abstractbalanceandproxyallowancefetcher.md)): *[BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore)*
*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:23](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L23)*
Instantiates a BalanceAndProxyAllowanceLazyStore
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`balanceAndProxyAllowanceFetcher` | [AbstractBalanceAndProxyAllowanceFetcher](#class-abstractbalanceandproxyallowancefetcher) | Class the implements the AbstractBalanceAndProxyAllowanceFetcher |
**Returns:** *[BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore)*
Instance of BalanceAndProxyAllowanceLazyStore
## Methods
### deleteAll
▸ **deleteAll**(): *void*
*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L136)*
Delete all balances & allowances
**Returns:** *void*
___
### deleteAllERC721ProxyAllowance
▸ **deleteAllERC721ProxyAllowance**(`tokenAddress`: string, `userAddress`: string): *void*
*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:119](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`tokenAddress` | string | ERc721 token address |
`userAddress` | string | Owner Ethereum address |
**Returns:** *void*
___
### deleteBalance
▸ **deleteBalance**(`assetData`: string, `userAddress`: string): *void*
*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L63)*
Clear the balance of an asset for a user
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetData of interest |
`userAddress` | string | Ethereum address of interest |
**Returns:** *void*
___
### deleteProxyAllowance
▸ **deleteProxyAllowance**(`assetData`: string, `userAddress`: string): *void*
*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:106](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L106)*
Clear the 0x asset proxy allowance
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetData of interest |
`userAddress` | string | Ethereum address of interest |
**Returns:** *void*
___
### getBalanceAsync
▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:39](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L39)*
Get a users balance of an asset
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetData of interest |
`userAddress` | string | Ethereum address of interest |
**Returns:** *`Promise<BigNumber>`*
___
### getProxyAllowanceAsync
▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:76](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L76)*
Get the 0x asset proxy allowance
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetData of interest |
`userAddress` | string | Ethereum address of interest |
**Returns:** *`Promise<BigNumber>`*
___
### setBalance
▸ **setBalance**(`assetData`: string, `userAddress`: string, `balance`: `BigNumber`): *void*
*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L52)*
Set the balance of an asset for a user
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetData of interest |
`userAddress` | string | Ethereum address of interest |
`balance` | `BigNumber` | - |
**Returns:** *void*
___
### setProxyAllowance
▸ **setProxyAllowance**(`assetData`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void*
*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:95](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L95)*
Set the 0x asset proxy allowance
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetData of interest |
`userAddress` | string | Ethereum address of interest |
`proxyAllowance` | `BigNumber` | - |
**Returns:** *void*
<hr />
# Class: OrderFilledCancelledLazyStore
Copy on read store for balances/proxyAllowances of tokens/accounts
## Implements
* [AbstractOrderFilledCancelledLazyStore](#class-abstractorderfilledcancelledlazystore)
## Constructors
\+ **new OrderFilledCancelledLazyStore**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_order_utils_src_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md)): *[OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore)*
*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L19)*
Instantiate a OrderFilledCancelledLazyStore
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderFilledCancelledFetcher` | [AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) | Class instance that implements the AbstractOrderFilledCancelledFetcher |
**Returns:** *[OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore)*
An instance of OrderFilledCancelledLazyStore
## Methods
### deleteAll
▸ **deleteAll**(): *void*
*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:90](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L90)*
Clear all filled/cancelled state
**Returns:** *void*
___
### deleteAllFilled
▸ **deleteAllFilled**(): *void*
*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:103](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L103)*
Clear all filled state
**Returns:** *void*
___
### deleteAllIsCancelled
▸ **deleteAllIsCancelled**(): *void*
*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:97](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L97)*
Clear all cancelled state
**Returns:** *void*
___
### deleteFilledTakerAmount
▸ **deleteFilledTakerAmount**(`orderHash`: string): *void*
*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L55)*
Clear the filledTakerAssetAmount of an order
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | OrderHash from order of interest |
**Returns:** *void*
___
### deleteIsCancelled
▸ **deleteIsCancelled**(`orderHash`: string): *void*
*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:84](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L84)*
Clear whether the order has been cancelled if already set
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | OrderHash from order of interest |
**Returns:** *void*
___
### getFilledTakerAmountAsync
▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise<BigNumber>`*
*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:35](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L35)*
Get the filledTakerAssetAmount of an order
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | OrderHash from order of interest |
**Returns:** *`Promise<BigNumber>`*
filledTakerAssetAmount
___
### getIsCancelledAsync
▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise<boolean>`*
*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L63)*
Check if an order has been cancelled
**Parameters:**
Name | Type |
------ | ------ |
`signedOrder` | `SignedOrder` |
**Returns:** *`Promise<boolean>`*
Whether the order has been cancelled
___
### getZRXAssetData
▸ **getZRXAssetData**(): *string*
*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:109](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L109)*
Get the ZRX assetData
**Returns:** *string*
___
### setFilledTakerAmount
▸ **setFilledTakerAmount**(`orderHash`: string, `filledTakerAmount`: `BigNumber`): *void*
*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L48)*
Set the filledTakerAssetAmount of an order
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | OrderHash from order of interest |
`filledTakerAmount` | `BigNumber` | Desired filledTakerAssetAmount |
**Returns:** *void*
___
### setIsCancelled
▸ **setIsCancelled**(`orderHash`: string, `isCancelled`: boolean): *void*
*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:77](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L77)*
Set whether an order has been cancelled or not
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | OrderHash from order of interest |
`isCancelled` | boolean | Whether this order should be cancelled or not |
**Returns:** *void*
<hr />
# Enumeration: NetworkId
## Enumeration members
### Ganache
• **Ganache**: = 50
*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L26)*
___
### Kovan
• **Kovan**: = 42
*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L25)*
___
### Mainnet
• **Mainnet**: = 1
*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L22)*
___
### Rinkeby
• **Rinkeby**: = 4
*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L24)*
___
### Ropsten
• **Ropsten**: = 3
*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L23)*
<hr />
# Enumeration: TradeSide
## Enumeration members
### Maker
• **Maker**: = "maker"
*Defined in [order-utils/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L9)*
___
### Taker
• **Taker**: = "taker"
*Defined in [order-utils/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L10)*
<hr />
# Enumeration: TransferType
## Enumeration members
### Fee
• **Fee**: = "fee"
*Defined in [order-utils/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L15)*
___
### Trade
• **Trade**: = "trade"
*Defined in [order-utils/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L14)*
<hr />
# Enumeration: TypedDataError
## Enumeration members
### InvalidMetamaskSigner
• **InvalidMetamaskSigner**: = "MetaMask provider must be wrapped in a MetamaskSubprovider (from the '@0x/subproviders' package) in order to work with this method."
*Defined in [order-utils/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L5)*
___
### InvalidSignature
• **InvalidSignature**: = "INVALID_SIGNATURE"
*Defined in [order-utils/src/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L4)*
<hr />
# Enumeration: AssetProxyId
## Enumeration members
### ERC1155
• **ERC1155**: = "0xa7cb5fb7"
*Defined in [types/src/index.ts:171](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L171)*
___
### ERC20
• **ERC20**: = "0xf47261b0"
*Defined in [types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L168)*
___
### ERC721
• **ERC721**: = "0x02571792"
*Defined in [types/src/index.ts:169](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L169)*
___
### MultiAsset
• **MultiAsset**: = "0x94cfcdd7"
*Defined in [types/src/index.ts:170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L170)*
___
### StaticCall
• **StaticCall**: = "0xc339d10a"
*Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L172)*
<hr />
# Enumeration: ExchangeContractErrs
Errors originating from the 0x exchange contract
## Enumeration members
### BatchOrdersMustHaveAtLeastOneItem
• **BatchOrdersMustHaveAtLeastOneItem**: = "BATCH_ORDERS_MUST_HAVE_AT_LEAST_ONE_ITEM"
*Defined in [types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L104)*
___
### BatchOrdersMustHaveSameExchangeAddress
• **BatchOrdersMustHaveSameExchangeAddress**: = "BATCH_ORDERS_MUST_HAVE_SAME_EXCHANGE_ADDRESS"
*Defined in [types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L103)*
___
### FillBalanceAllowanceError
• **FillBalanceAllowanceError**: = "FILL_BALANCE_ALLOWANCE_ERROR"
*Defined in [types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L90)*
___
### InsufficientMakerAllowance
• **InsufficientMakerAllowance**: = "INSUFFICIENT_MAKER_ALLOWANCE"
*Defined in [types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L94)*
___
### InsufficientMakerBalance
• **InsufficientMakerBalance**: = "INSUFFICIENT_MAKER_BALANCE"
*Defined in [types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L93)*
___
### InsufficientMakerFeeAllowance
• **InsufficientMakerFeeAllowance**: = "INSUFFICIENT_MAKER_FEE_ALLOWANCE"
*Defined in [types/src/index.ts:98](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L98)*
___
### InsufficientMakerFeeBalance
• **InsufficientMakerFeeBalance**: = "INSUFFICIENT_MAKER_FEE_BALANCE"
*Defined in [types/src/index.ts:97](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L97)*
___
### InsufficientRemainingFillAmount
• **InsufficientRemainingFillAmount**: = "INSUFFICIENT_REMAINING_FILL_AMOUNT"
*Defined in [types/src/index.ts:101](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L101)*
___
### InsufficientTakerAllowance
• **InsufficientTakerAllowance**: = "INSUFFICIENT_TAKER_ALLOWANCE"
*Defined in [types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L92)*
___
### InsufficientTakerBalance
• **InsufficientTakerBalance**: = "INSUFFICIENT_TAKER_BALANCE"
*Defined in [types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L91)*
___
### InsufficientTakerFeeAllowance
• **InsufficientTakerFeeAllowance**: = "INSUFFICIENT_TAKER_FEE_ALLOWANCE"
*Defined in [types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L96)*
___
### InsufficientTakerFeeBalance
• **InsufficientTakerFeeBalance**: = "INSUFFICIENT_TAKER_FEE_BALANCE"
*Defined in [types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L95)*
___
### MultipleMakersInSingleCancelBatchDisallowed
• **MultipleMakersInSingleCancelBatchDisallowed**: = "MULTIPLE_MAKERS_IN_SINGLE_CANCEL_BATCH_DISALLOWED"
*Defined in [types/src/index.ts:100](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L100)*
___
### MultipleTakerTokensInFillUpToDisallowed
• **MultipleTakerTokensInFillUpToDisallowed**: = "MULTIPLE_TAKER_TOKENS_IN_FILL_UP_TO_DISALLOWED"
*Defined in [types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L102)*
___
### OrderCancelExpired
• **OrderCancelExpired**: = "ORDER_CANCEL_EXPIRED"
*Defined in [types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L85)*
___
### OrderCancelled
• **OrderCancelled**: = "ORDER_CANCELLED"
*Defined in [types/src/index.ts:86](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L86)*
___
### OrderFillAmountZero
• **OrderFillAmountZero**: = "ORDER_FILL_AMOUNT_ZERO"
*Defined in [types/src/index.ts:87](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L87)*
___
### OrderFillExpired
• **OrderFillExpired**: = "ORDER_FILL_EXPIRED"
*Defined in [types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L84)*
___
### OrderFillRoundingError
• **OrderFillRoundingError**: = "ORDER_FILL_ROUNDING_ERROR"
*Defined in [types/src/index.ts:89](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L89)*
___
### OrderRemainingFillAmountZero
• **OrderRemainingFillAmountZero**: = "ORDER_REMAINING_FILL_AMOUNT_ZERO"
*Defined in [types/src/index.ts:88](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L88)*
___
### TransactionSenderIsNotFillOrderTaker
• **TransactionSenderIsNotFillOrderTaker**: = "TRANSACTION_SENDER_IS_NOT_FILL_ORDER_TAKER"
*Defined in [types/src/index.ts:99](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L99)*
<hr />
# Enumeration: SignatureType
## Enumeration members
### EIP712
• **EIP712**:
*Defined in [types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L159)*
___
### EthSign
• **EthSign**:
*Defined in [types/src/index.ts:160](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L160)*
___
### Illegal
• **Illegal**:
*Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L157)*
___
### Invalid
• **Invalid**:
*Defined in [types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L158)*
___
### NSignatureTypes
• **NSignatureTypes**:
*Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L164)*
___
### PreSigned
• **PreSigned**:
*Defined in [types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L163)*
___
### Validator
• **Validator**:
*Defined in [types/src/index.ts:162](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L162)*
___
### Wallet
• **Wallet**:
*Defined in [types/src/index.ts:161](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L161)*
<hr />
## Type aliases
### AssetData
Ƭ **AssetData**: *[SingleAssetData](_types_src_index_.md#singleassetdata) | [MultiAssetData](#interface-multiassetdata) | [MultiAssetDataWithRecursiveDecoding](#interface-multiassetdatawithrecursivedecoding)*
*Defined in [types/src/index.ts:228](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L228)*
___
### EIP712ObjectValue
Ƭ **EIP712ObjectValue**: *string | number | [EIP712Object](#interface-eip712object)*
*Defined in [types/src/index.ts:719](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L719)*
___
### OrderState
Ƭ **OrderState**: *[OrderStateValid](#interface-orderstatevalid) | [OrderStateInvalid](#interface-orderstateinvalid)*
*Defined in [types/src/index.ts:147](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L147)*
___
### SingleAssetData
Ƭ **SingleAssetData**: *[ERC20AssetData](#interface-erc20assetdata) | [ERC721AssetData](#interface-erc721assetdata) | [ERC1155AssetData](#interface-erc1155assetdata) | [StaticCallAssetData](#interface-staticcallassetdata)*
*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L208)*
<hr />
# Interface: EIP1193Provider
## Properties
### isEIP1193
• **isEIP1193**: *boolean*
*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L73)*
## Methods
### on
▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this*
*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L75)*
**Parameters:**
▪ **event**: *[EIP1193Event](#eip1193event)*
▪ **listener**: *function*
▸ (`result`: any): *void*
**Parameters:**
Name | Type |
------ | ------ |
`result` | any |
**Returns:** *this*
___
### send
▸ **send**(`method`: string, `params?`: any[]): *`Promise<any>`*
*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L74)*
**Parameters:**
Name | Type |
------ | ------ |
`method` | string |
`params?` | any[] |
**Returns:** *`Promise<any>`*
<hr />
# Interface: GanacheProvider
## Methods
### sendAsync
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L14)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
<hr />
# Interface: JSONRPCRequestPayload
## Properties
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L324)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L325)*
___
### method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L323)*
___
### params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L322)*
<hr />
# Interface: JSONRPCResponseError
## Properties
### code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L330)*
___
### message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L329)*
<hr />
# Interface: JSONRPCResponsePayload
## Properties
### `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L337)*
___
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L335)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L336)*
___
### result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L334)*
<hr />
# Interface: Web3JsV1Provider
Web3.js version 1 provider interface
This provider interface was implemented in the pre-1.0Beta releases for Web3.js.
This interface allowed sending synchonous requests, support for which was later dropped.
## Methods
### send
▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)*
*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L45)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
**Returns:** *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)*
___
### sendAsync
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L44)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
<hr />
# Interface: Web3JsV2Provider
Web3.js version 2 provider interface
This provider interface was used in a couple of Web3.js 1.0 beta releases
before the first attempts to conform to EIP1193
## Methods
### send
▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L54)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
<hr />
# Interface: Web3JsV3Provider
Web3.js version 3 provider interface
This provider interface was implemented with the hopes for conforming to the EIP1193 spec,
however it does not conform entirely.
## Methods
### send
▸ **send**(`method`: string, `params?`: any[]): *`Promise<any>`*
*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L63)*
**Parameters:**
Name | Type |
------ | ------ |
`method` | string |
`params?` | any[] |
**Returns:** *`Promise<any>`*
<hr />
# Interface: ZeroExProvider
The interface for the provider used internally by 0x libraries
Any property we use from any SupportedProvider should we explicitly
add here
## Properties
### `Optional` isMetaMask
• **isMetaMask**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L31)*
___
### `Optional` isParity
• **isParity**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L32)*
___
### `Optional` isZeroExProvider
• **isZeroExProvider**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L30)*
## Methods
### `Optional` enable
▸ **enable**(): *`Promise<void>`*
*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L34)*
**Returns:** *`Promise<void>`*
___
### sendAsync
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L35)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
___
### `Optional` stop
▸ **stop**(): *void*
*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L33)*
**Returns:** *void*
<hr />
# Interface: FeeOrdersAndRemainingFeeAmount <**T**>
## Type parameters
▪ **T**
## Properties
### feeOrdersRemainingFillableMakerAssetAmounts
• **feeOrdersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]*
*Defined in [order-utils/src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L76)*
___
### remainingFeeAmount
• **remainingFeeAmount**: *`BigNumber`*
*Defined in [order-utils/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L77)*
___
### resultFeeOrders
• **resultFeeOrders**: *`T`[]*
*Defined in [order-utils/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L75)*
<hr />
# Interface: FindFeeOrdersThatCoverFeesForTargetOrdersOpts
remainingFillableMakerAssetAmount: An array of BigNumbers corresponding to the `orders` parameter.
You can use `OrderStateUtils` `@0x/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 @0x/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
## Properties
### `Optional` remainingFillableFeeAmounts
• **remainingFillableFeeAmounts**? : *`BigNumber`[]*
*Defined in [order-utils/src/types.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L70)*
___
### `Optional` remainingFillableMakerAssetAmounts
• **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]*
*Defined in [order-utils/src/types.ts:69](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L69)*
___
### `Optional` slippageBufferAmount
• **slippageBufferAmount**? : *`BigNumber`*
*Defined in [order-utils/src/types.ts:71](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L71)*
<hr />
# Interface: FindOrdersThatCoverMakerAssetFillAmountOpts
remainingFillableMakerAssetAmount: An array of BigNumbers corresponding to the `orders` parameter.
You can use `OrderStateUtils` `@0x/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
## Properties
### `Optional` remainingFillableMakerAssetAmounts
• **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]*
*Defined in [order-utils/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L42)*
___
### `Optional` slippageBufferAmount
• **slippageBufferAmount**? : *`BigNumber`*
*Defined in [order-utils/src/types.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L43)*
<hr />
# Interface: FindOrdersThatCoverTakerAssetFillAmountOpts
remainingFillableMakerAssetAmount: An array of BigNumbers corresponding to the `orders` parameter.
You can use `OrderStateUtils` `@0x/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
## Properties
### `Optional` remainingFillableTakerAssetAmounts
• **remainingFillableTakerAssetAmounts**? : *`BigNumber`[]*
*Defined in [order-utils/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L54)*
___
### `Optional` slippageBufferAmount
• **slippageBufferAmount**? : *`BigNumber`*
*Defined in [order-utils/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L55)*
<hr />
# Interface: OrdersAndRemainingMakerFillAmount <**T**>
## Type parameters
▪ **T**
## Properties
### ordersRemainingFillableMakerAssetAmounts
• **ordersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]*
*Defined in [order-utils/src/types.ts:82](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L82)*
___
### remainingFillAmount
• **remainingFillAmount**: *`BigNumber`*
*Defined in [order-utils/src/types.ts:83](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L83)*
___
### resultOrders
• **resultOrders**: *`T`[]*
*Defined in [order-utils/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L81)*
<hr />
# Interface: OrdersAndRemainingTakerFillAmount <**T**>
## Type parameters
▪ **T**
## Properties
### ordersRemainingFillableTakerAssetAmounts
• **ordersRemainingFillableTakerAssetAmounts**: *`BigNumber`[]*
*Defined in [order-utils/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L88)*
___
### remainingFillAmount
• **remainingFillAmount**: *`BigNumber`*
*Defined in [order-utils/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L89)*
___
### resultOrders
• **resultOrders**: *`T`[]*
*Defined in [order-utils/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L87)*
<hr />
# Interface: ValidateOrderFillableOpts
## Properties
### `Optional` expectedFillTakerTokenAmount
• **expectedFillTakerTokenAmount**? : *`BigNumber`*
*Defined in [order-utils/src/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L29)*
___
### `Optional` simulationTakerAddress
• **simulationTakerAddress**? : *undefined | string*
*Defined in [order-utils/src/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L31)*
___
### `Optional` validateRemainingOrderAmountIsFillable
• **validateRemainingOrderAmountIsFillable**? : *undefined | false | true*
*Defined in [order-utils/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/types.ts#L30)*
<hr />
# Class: AbstractBalanceAndProxyAllowanceFetcher
An abstract class to be implemented in order to use OrderStateUtils. The class that
implements this interface must be capable of fetching the balance and proxyAllowance
for an Ethereum address and assetData
## Methods
### `Abstract` getBalanceAsync
▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L15)*
Get balance of assetData for userAddress
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetData for which to fetch the balance |
`userAddress` | string | Ethereum address for which to fetch the balance |
**Returns:** *`Promise<BigNumber>`*
Balance amount in base units
___
### `Abstract` getProxyAllowanceAsync
▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise<BigNumber>`*
*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L22)*
Get the 0x asset proxy allowance of assetData for userAddress
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetData for which to fetch the allowance |
`userAddress` | string | Ethereum address for which to fetch the allowance |
**Returns:** *`Promise<BigNumber>`*
Allowance amount in base units
<hr />
# Interface: DutchAuctionData
## Properties
### assetData
• **assetData**: *[AssetData](#assetdata)*
*Defined in [types/src/index.ts:223](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L223)*
___
### beginAmount
• **beginAmount**: *`BigNumber`*
*Defined in [types/src/index.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L225)*
___
### beginTimeSeconds
• **beginTimeSeconds**: *`BigNumber`*
*Defined in [types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L224)*
<hr />
# Interface: ECSignature
Elliptic Curve signature
## Properties
### r
• **r**: *string*
*Defined in [types/src/index.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L68)*
___
### s
• **s**: *string*
*Defined in [types/src/index.ts:69](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L69)*
___
### v
• **v**: *number*
*Defined in [types/src/index.ts:67](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L67)*
<hr />
# Interface: EIP712DomainWithDefaultSchema
## Properties
### `Optional` name
• **name**? : *undefined | string*
*Defined in [types/src/index.ts:791](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L791)*
___
### verifyingContractAddress
• **verifyingContractAddress**: *string*
*Defined in [types/src/index.ts:793](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L793)*
___
### `Optional` version
• **version**? : *undefined | string*
*Defined in [types/src/index.ts:792](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L792)*
<hr />
# Interface: EIP712Object
## Hierarchy
* **EIP712Parameter**
## Properties
### name
• **name**: *string*
*Defined in [types/src/index.ts:711](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L711)*
___
### type
• **type**: *string*
*Defined in [types/src/index.ts:712](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L712)*
<hr />
# Interface: EIP712TypedData
## Properties
### domain
• **domain**: *[EIP712Object](#class-eip712object)*
*Defined in [types/src/index.ts:727](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L727)*
___
### message
• **message**: *[EIP712Object](#class-eip712object)*
*Defined in [types/src/index.ts:728](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L728)*
___
### primaryType
• **primaryType**: *string*
*Defined in [types/src/index.ts:729](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L729)*
___
### types
• **types**: *[EIP712Types](#class-eip712types)*
*Defined in [types/src/index.ts:726](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L726)*
<hr />
# Interface: EIP712Types
## Hierarchy
* **ElementType**
## Properties
### name
• **name**: *string*
*Defined in [types/src/index.ts:665](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L665)*
___
### typeDocType
• **typeDocType**: *[TypeDocTypes](#enumeration-typedoctypes)*
*Defined in [types/src/index.ts:666](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L666)*
<hr />
# Interface: ERC1155AssetData
## Properties
### assetProxyId
• **assetProxyId**: *string*
*Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L187)*
___
### callbackData
• **callbackData**: *string*
*Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L191)*
___
### tokenAddress
• **tokenAddress**: *string*
*Defined in [types/src/index.ts:188](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L188)*
___
### tokenIds
• **tokenIds**: *`BigNumber`[]*
*Defined in [types/src/index.ts:189](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L189)*
___
### tokenValues
• **tokenValues**: *`BigNumber`[]*
*Defined in [types/src/index.ts:190](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L190)*
<hr />
# Interface: ERC20AssetData
## Properties
### assetProxyId
• **assetProxyId**: *string*
*Defined in [types/src/index.ts:176](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L176)*
___
### tokenAddress
• **tokenAddress**: *string*
*Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L177)*
<hr />
# Interface: ERC721AssetData
## Properties
### assetProxyId
• **assetProxyId**: *string*
*Defined in [types/src/index.ts:181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L181)*
___
### tokenAddress
• **tokenAddress**: *string*
*Defined in [types/src/index.ts:182](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L182)*
___
### tokenId
• **tokenId**: *`BigNumber`*
*Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L183)*
<hr />
# Interface: MultiAssetData
## Properties
### amounts
• **amounts**: *`BigNumber`[]*
*Defined in [types/src/index.ts:212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L212)*
___
### assetProxyId
• **assetProxyId**: *string*
*Defined in [types/src/index.ts:211](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L211)*
___
### nestedAssetData
• **nestedAssetData**: *string[]*
*Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L213)*
<hr />
# Interface: MultiAssetDataWithRecursiveDecoding
## Properties
### amounts
• **amounts**: *`BigNumber`[]*
*Defined in [types/src/index.ts:218](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L218)*
___
### assetProxyId
• **assetProxyId**: *string*
*Defined in [types/src/index.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L217)*
___
### nestedAssetData
• **nestedAssetData**: *[SingleAssetData](#singleassetdata)[]*
*Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L219)*
<hr />
# Interface: ObjectMap <**T**>
## Type parameters
▪ **T**
## Hierarchy
* **Order**
* [SignedOrder](#class-signedorder)
## Properties
### exchangeAddress
• **exchangeAddress**: *string*
*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L20)*
___
### expirationTimeSeconds
• **expirationTimeSeconds**: *`BigNumber`*
*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L22)*
___
### feeRecipientAddress
• **feeRecipientAddress**: *string*
*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L21)*
___
### makerAddress
• **makerAddress**: *string*
*Defined in [types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L11)*
___
### makerAssetAmount
• **makerAssetAmount**: *`BigNumber`*
*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L15)*
___
### makerAssetData
• **makerAssetData**: *string*
*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L17)*
___
### makerFee
• **makerFee**: *`BigNumber`*
*Defined in [types/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L13)*
___
### salt
• **salt**: *`BigNumber`*
*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L19)*
___
### senderAddress
• **senderAddress**: *string*
*Defined in [types/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L10)*
___
### takerAddress
• **takerAddress**: *string*
*Defined in [types/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L12)*
___
### takerAssetAmount
• **takerAssetAmount**: *`BigNumber`*
*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L16)*
___
### takerAssetData
• **takerAssetData**: *string*
*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L18)*
___
### takerFee
• **takerFee**: *`BigNumber`*
*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L14)*
<hr />
# Interface: OrderRelevantState
## Properties
### filledTakerAssetAmount
• **filledTakerAssetAmount**: *`BigNumber`*
*Defined in [types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L128)*
___
### makerBalance
• **makerBalance**: *`BigNumber`*
*Defined in [types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L122)*
___
### makerFeeBalance
• **makerFeeBalance**: *`BigNumber`*
*Defined in [types/src/index.ts:126](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L126)*
___
### makerFeeProxyAllowance
• **makerFeeProxyAllowance**: *`BigNumber`*
*Defined in [types/src/index.ts:127](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L127)*
___
### makerIndividualBalances
• **makerIndividualBalances**: *[ObjectMap](#class-objectmap)‹*`BigNumber`*›*
*Defined in [types/src/index.ts:123](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L123)*
___
### makerIndividualProxyAllowances
• **makerIndividualProxyAllowances**: *[ObjectMap](#class-objectmap)‹*`BigNumber`*›*
*Defined in [types/src/index.ts:125](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L125)*
___
### makerProxyAllowance
• **makerProxyAllowance**: *`BigNumber`*
*Defined in [types/src/index.ts:124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L124)*
___
### remainingFillableMakerAssetAmount
• **remainingFillableMakerAssetAmount**: *`BigNumber`*
*Defined in [types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L129)*
___
### remainingFillableTakerAssetAmount
• **remainingFillableTakerAssetAmount**: *`BigNumber`*
*Defined in [types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L130)*
<hr />
# Interface: OrderStateInvalid
## Properties
### error
• **error**: *[ExchangeContractErrs](#enumeration-exchangecontracterrs)*
*Defined in [types/src/index.ts:143](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L143)*
___
### isValid
• **isValid**: *false*
*Defined in [types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L141)*
___
### orderHash
• **orderHash**: *string*
*Defined in [types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L142)*
___
### `Optional` transactionHash
• **transactionHash**? : *undefined | string*
*Defined in [types/src/index.ts:144](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L144)*
<hr />
# Interface: OrderStateValid
## Properties
### isValid
• **isValid**: *true*
*Defined in [types/src/index.ts:134](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L134)*
___
### orderHash
• **orderHash**: *string*
*Defined in [types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L135)*
___
### orderRelevantState
• **orderRelevantState**: *[OrderRelevantState](#class-orderrelevantstate)*
*Defined in [types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L136)*
___
### `Optional` transactionHash
• **transactionHash**? : *undefined | string*
*Defined in [types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L137)*
<hr />
# Interface: SignedOrder
## Properties
### exchangeAddress
• **exchangeAddress**: *string*
*Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)*
*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L20)*
___
### expirationTimeSeconds
• **expirationTimeSeconds**: *`BigNumber`*
*Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)*
*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L22)*
___
### feeRecipientAddress
• **feeRecipientAddress**: *string*
*Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)*
*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L21)*
___
### makerAddress
• **makerAddress**: *string*
*Inherited from [Order](#interface-order).[makerAddress](#makeraddress)*
*Defined in [types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L11)*
___
### makerAssetAmount
• **makerAssetAmount**: *`BigNumber`*
*Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)*
*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L15)*
___
### makerAssetData
• **makerAssetData**: *string*
*Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)*
*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L17)*
___
### makerFee
• **makerFee**: *`BigNumber`*
*Inherited from [Order](#interface-order).[makerFee](#makerfee)*
*Defined in [types/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L13)*
___
### salt
• **salt**: *`BigNumber`*
*Inherited from [Order](#interface-order).[salt](#salt)*
*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L19)*
___
### senderAddress
• **senderAddress**: *string*
*Inherited from [Order](#interface-order).[senderAddress](#senderaddress)*
*Defined in [types/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L10)*
___
### signature
• **signature**: *string*
*Defined in [types/src/index.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L41)*
___
### takerAddress
• **takerAddress**: *string*
*Inherited from [Order](#interface-order).[takerAddress](#takeraddress)*
*Defined in [types/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L12)*
___
### takerAssetAmount
• **takerAssetAmount**: *`BigNumber`*
*Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)*
*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L16)*
___
### takerAssetData
• **takerAssetData**: *string*
*Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)*
*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L18)*
___
### takerFee
• **takerFee**: *`BigNumber`*
*Inherited from [Order](#interface-order).[takerFee](#takerfee)*
*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L14)*
<hr />
# Interface: SignedZeroExTransaction
## Properties
### data
• **data**: *string*
*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[data](#data)*
*Defined in [types/src/index.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L56)*
___
### salt
• **salt**: *`BigNumber`*
*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[salt](#salt)*
*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L54)*
___
### signature
• **signature**: *string*
*Defined in [types/src/index.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L60)*
___
### signerAddress
• **signerAddress**: *string*
*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[signerAddress](#signeraddress)*
*Defined in [types/src/index.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L55)*
___
### verifyingContractAddress
• **verifyingContractAddress**: *string*
*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[verifyingContractAddress](#verifyingcontractaddress)*
*Defined in [types/src/index.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L53)*
<hr />
# Interface: StaticCallAssetData
## Properties
### assetProxyId
• **assetProxyId**: *string*
*Defined in [types/src/index.ts:195](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L195)*
___
### callResultHash
• **callResultHash**: *string*
*Defined in [types/src/index.ts:198](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L198)*
___
### callTarget
• **callTarget**: *string*
*Defined in [types/src/index.ts:196](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L196)*
___
### staticCallData
• **staticCallData**: *string*
*Defined in [types/src/index.ts:197](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L197)*
<hr />
# Interface: ValidatorSignature
Validator signature components
## Properties
### signature
• **signature**: *string*
*Defined in [types/src/index.ts:77](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L77)*
___
### validatorAddress
• **validatorAddress**: *string*
*Defined in [types/src/index.ts:76](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L76)*
<hr />
# Interface: ZeroExTransaction
ZeroExTransaction for use with 0x Exchange executeTransaction
## Properties
### data
• **data**: *string*
*Defined in [types/src/index.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L56)*
___
### salt
• **salt**: *`BigNumber`*
*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L54)*
___
### signerAddress
• **signerAddress**: *string*
*Defined in [types/src/index.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L55)*
___
### verifyingContractAddress
• **verifyingContractAddress**: *string*
*Defined in [types/src/index.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L53)*
<hr />
<hr />
## Functions
### getContractAddressesForNetworkOrThrow
▸ **getContractAddressesForNetworkOrThrow**(`networkId`: [NetworkId](#enumeration-networkid)): *[ContractAddresses](#interface-contractaddresses)*
*Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L128)*
Used to get addresses of contracts that have been deployed to either the
Ethereum mainnet or a supported testnet. Throws if there are no known
contracts deployed on the corresponding network.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`networkId` | [NetworkId](#enumeration-networkid) | The desired networkId. |
**Returns:** *[ContractAddresses](#interface-contractaddresses)*
The set of addresses for contracts which have been deployed on the
given networkId.
___
### getNetworkIdByExchangeAddressOrThrow
▸ **getNetworkIdByExchangeAddressOrThrow**(`exchangeAddress`: string): *[NetworkId](#enumeration-networkid)*
*Defined in [contract-addresses/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L142)*
Uses a given exchange address to look up the network id that the exchange contract is deployed
on. Only works for Ethereum mainnet or a supported testnet. Throws if the exchange address
does not correspond to a known deployed exchange contract.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`exchangeAddress` | string | The exchange address of concern |
**Returns:** *[NetworkId](#enumeration-networkid)*
The network ID on which the exchange contract is deployed
<hr />
## Type aliases
### EIP1193Event
Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"*
*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L70)*
Interface for providers that conform to EIP 1193
Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md
___
### JSONRPCErrorCallback
Ƭ **JSONRPCErrorCallback**: *function*
*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L3)*
#### Type declaration:
▸ (`err`: `Error` | null, `result?`: [JSONRPCResponsePayload](#interface-jsonrpcresponsepayload)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`result?` | [JSONRPCResponsePayload](#interface-jsonrpcresponsepayload) |
___
### SupportedProvider
Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)*
*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L9)*
Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library
Read more about Providers in the guides section of the 0x docs.
___
### Web3JsProvider
Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)*
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L11)*
<hr />
<hr />
<hr />
<hr />
<hr />
## Object literals
### `Const` assetDataUtils
#### ▪ **assetDataUtils**: *object*
*Defined in [order-utils/src/asset_data_utils.ts:23](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L23)*
#### assertIsERC1155AssetData
▸ **assertIsERC1155AssetData**(`assetData`: string): *void*
*Defined in [order-utils/src/asset_data_utils.ts:397](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L397)*
Throws if the assetData is not ERC1155.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string |
**Returns:** *void*
#### assertIsERC20AssetData
▸ **assertIsERC20AssetData**(`assetData`: string): *void*
*Defined in [order-utils/src/asset_data_utils.ts:353](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L353)*
Throws if the length or assetProxyId are invalid for the ERC20Proxy.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string |
**Returns:** *void*
#### assertIsERC721AssetData
▸ **assertIsERC721AssetData**(`assetData`: string): *void*
*Defined in [order-utils/src/asset_data_utils.ts:375](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L375)*
Throws if the length or assetProxyId are invalid for the ERC721Proxy.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string |
**Returns:** *void*
#### assertIsMultiAssetData
▸ **assertIsMultiAssetData**(`assetData`: string): *void*
*Defined in [order-utils/src/asset_data_utils.ts:419](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L419)*
Throws if the length or assetProxyId are invalid for the MultiAssetProxy.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string |
**Returns:** *void*
#### assertIsStaticCallAssetData
▸ **assertIsStaticCallAssetData**(`assetData`: string): *void*
*Defined in [order-utils/src/asset_data_utils.ts:441](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L441)*
Throws if the assetData is not StaticCallData.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string |
**Returns:** *void*
#### assertWordAlignedAssetData
▸ **assertWordAlignedAssetData**(`assetData`: string): *void*
*Defined in [order-utils/src/asset_data_utils.ts:463](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L463)*
Throws if the assetData is not padded to 32 bytes.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string |
**Returns:** *void*
#### decodeAssetDataOrThrow
▸ **decodeAssetDataOrThrow**(`assetData`: string): *[SingleAssetData](#singleassetdata) | `MultiAssetData`*
*Defined in [order-utils/src/asset_data_utils.ts:502](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L502)*
Decode any assetData into its corresponding assetData object
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string to decode |
**Returns:** *[SingleAssetData](#singleassetdata) | `MultiAssetData`*
Either a ERC20, ERC721, ERC1155, or MultiAsset assetData object
#### decodeAssetProxyId
▸ **decodeAssetProxyId**(`assetData`: string): *`AssetProxyId`*
*Defined in [order-utils/src/asset_data_utils.ts:294](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L294)*
Decode and return the assetProxyId from the assetData
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string to decode |
**Returns:** *`AssetProxyId`*
The assetProxyId
#### decodeDutchAuctionData
▸ **decodeDutchAuctionData**(`dutchAuctionData`: string): *`DutchAuctionData`*
*Defined in [order-utils/src/asset_data_utils.ts:263](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L263)*
Dutch auction details are encoded with the asset data for a 0x order. This function decodes a hex
encoded assetData string, containing information both about the asset being traded and the
dutch auction.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`dutchAuctionData` | string | Hex encoded assetData string for the asset being auctioned. |
**Returns:** *`DutchAuctionData`*
An object containing the auction asset, auction begin time and auction begin amount.
#### decodeERC1155AssetData
▸ **decodeERC1155AssetData**(`assetData`: string): *`ERC1155AssetData`*
*Defined in [order-utils/src/asset_data_utils.ts:107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L107)*
Decodes an ERC1155 assetData hex string into its corresponding ERC1155 components.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string to decode |
**Returns:** *`ERC1155AssetData`*
An object containing the decoded tokenAddress, tokenIds, tokenValues, callbackData & assetProxyId
#### decodeERC20AssetData
▸ **decodeERC20AssetData**(`assetData`: string): *`ERC20AssetData`*
*Defined in [order-utils/src/asset_data_utils.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L41)*
Decodes an ERC20 assetData hex string into its corresponding ERC20 tokenAddress & assetProxyId
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string to decode |
**Returns:** *`ERC20AssetData`*
An object containing the decoded tokenAddress & assetProxyId
#### decodeERC721AssetData
▸ **decodeERC721AssetData**(`assetData`: string): *`ERC721AssetData`*
*Defined in [order-utils/src/asset_data_utils.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L70)*
Decodes an ERC721 assetData hex string into its corresponding ERC721 tokenAddress, tokenId & assetProxyId
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string to decode |
**Returns:** *`ERC721AssetData`*
An object containing the decoded tokenAddress, tokenId & assetProxyId
#### decodeMultiAssetData
▸ **decodeMultiAssetData**(`assetData`: string): *`MultiAssetData`*
*Defined in [order-utils/src/asset_data_utils.ts:149](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L149)*
Decodes a MultiAsset assetData hex string into its corresponding amounts and nestedAssetData
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string to decode |
**Returns:** *`MultiAssetData`*
An object containing the decoded amounts and nestedAssetData
#### decodeMultiAssetDataRecursively
▸ **decodeMultiAssetDataRecursively**(`assetData`: string): *`MultiAssetDataWithRecursiveDecoding`*
*Defined in [order-utils/src/asset_data_utils.ts:175](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L175)*
Decodes a MultiAsset assetData hex string into its corresponding amounts and decoded nestedAssetData elements (all nested elements are flattened)
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string to decode |
**Returns:** *`MultiAssetDataWithRecursiveDecoding`*
An object containing the decoded amounts and nestedAssetData
#### decodeStaticCallAssetData
▸ **decodeStaticCallAssetData**(`assetData`: string): *`StaticCallAssetData`*
*Defined in [order-utils/src/asset_data_utils.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L225)*
Decoded StaticCall assetData into its corresponding callTarget, staticCallData, and expected callResultHash
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string to decode |
**Returns:** *`StaticCallAssetData`*
An object containing the decoded callTarget, staticCallData, and expected callResultHash
#### encodeDutchAuctionAssetData
▸ **encodeDutchAuctionAssetData**(`assetData`: string, `beginTimeSeconds`: `BigNumber`, `beginAmount`: `BigNumber`): *string*
*Defined in [order-utils/src/asset_data_utils.ts:245](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L245)*
Dutch auction details are encoded with the asset data for a 0x order. This function produces a hex
encoded assetData string, containing information both about the asset being traded and the
dutch auction; which is usable in the makerAssetData or takerAssetData fields in a 0x order.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string for the asset being auctioned. |
`beginTimeSeconds` | `BigNumber` | Begin time of the dutch auction. |
`beginAmount` | `BigNumber` | Starting amount being sold in the dutch auction. |
**Returns:** *string*
The hex encoded assetData string.
#### encodeERC1155AssetData
▸ **encodeERC1155AssetData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *string*
*Defined in [order-utils/src/asset_data_utils.ts:91](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L91)*
Encodes a set of ERC1155 assets into an assetData string, usable in the makerAssetData or
takerAssetData fields of a 0x order.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`tokenAddress` | string | The token address of the ERC1155 contract |
`tokenIds` | `BigNumber`[] | The Id's of the ERC1155 tokens to transfer |
`tokenValues` | `BigNumber`[] | The values of each respective token Id to transfer |
`callbackData` | string | The data forwarded to a receiver, if receiver is a contract. |
**Returns:** *string*
The hex encoded assetData string
#### encodeERC20AssetData
▸ **encodeERC20AssetData**(`tokenAddress`: string): *string*
*Defined in [order-utils/src/asset_data_utils.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L30)*
Encodes an ERC20 token address into a hex encoded assetData string, usable in the makerAssetData or
takerAssetData fields in a 0x order.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`tokenAddress` | string | The ERC20 token address to encode |
**Returns:** *string*
The hex encoded assetData string
#### encodeERC721AssetData
▸ **encodeERC721AssetData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string*
*Defined in [order-utils/src/asset_data_utils.ts:59](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L59)*
Encodes an ERC721 token address into a hex encoded assetData string, usable in the makerAssetData or
takerAssetData fields in a 0x order.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`tokenAddress` | string | The ERC721 token address to encode |
`tokenId` | `BigNumber` | The ERC721 tokenId to encode |
**Returns:** *string*
The hex encoded assetData string
#### encodeMultiAssetData
▸ **encodeMultiAssetData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *string*
*Defined in [order-utils/src/asset_data_utils.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L130)*
Encodes assetData for multiple AssetProxies into a single hex encoded assetData string, usable in the makerAssetData or
takerAssetData fields in a 0x order.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`amounts` | `BigNumber`[] | Amounts of each asset that correspond to a single unit within an order. |
`nestedAssetData` | string[] | assetData strings that correspond to a valid assetProxyId. |
**Returns:** *string*
The hex encoded assetData string
#### encodeStaticCallAssetData
▸ **encodeStaticCallAssetData**(`callTarget`: string, `staticCallData`: string, `callResultHash`: string): *string*
*Defined in [order-utils/src/asset_data_utils.ts:214](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L214)*
Encodes StaticCallProxy data into an assetData hex string
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`callTarget` | string | Address of contract to call from StaticCallProxy |
`staticCallData` | string | The function data that will be called on the callTarget contract |
`callResultHash` | string | The keccak256 hash of the ABI encoded expected output of the static call |
**Returns:** *string*
The hex encoded assetData string
#### isERC1155AssetData
▸ **isERC1155AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean*
*Defined in [order-utils/src/asset_data_utils.ts:332](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L332)*
Checks if the decoded asset data is valid ERC1155 data
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`decodedAssetData` | [SingleAssetData](#singleassetdata) \| `MultiAssetData` | The decoded asset data to check |
**Returns:** *boolean*
#### isERC20AssetData
▸ **isERC20AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean*
*Defined in [order-utils/src/asset_data_utils.ts:318](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L318)*
Checks if the decoded asset data is valid ERC20 data
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`decodedAssetData` | [SingleAssetData](#singleassetdata) \| `MultiAssetData` | The decoded asset data to check |
**Returns:** *boolean*
#### isERC721AssetData
▸ **isERC721AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean*
*Defined in [order-utils/src/asset_data_utils.ts:325](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L325)*
Checks if the decoded asset data is valid ERC721 data
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`decodedAssetData` | [SingleAssetData](#singleassetdata) \| `MultiAssetData` | The decoded asset data to check |
**Returns:** *boolean*
#### isMultiAssetData
▸ **isMultiAssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean*
*Defined in [order-utils/src/asset_data_utils.ts:339](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L339)*
Checks if the decoded asset data is valid MultiAsset data
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`decodedAssetData` | [SingleAssetData](#singleassetdata) \| `MultiAssetData` | The decoded asset data to check |
**Returns:** *boolean*
#### isStaticCallAssetData
▸ **isStaticCallAssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean*
*Defined in [order-utils/src/asset_data_utils.ts:346](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L346)*
Checks if the decoded asset data is valid StaticCall data
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`decodedAssetData` | [SingleAssetData](#singleassetdata) \| `MultiAssetData` | The decoded asset data to check |
**Returns:** *boolean*
#### validateAssetDataOrThrow
▸ **validateAssetDataOrThrow**(`assetData`: string): *void*
*Defined in [order-utils/src/asset_data_utils.ts:475](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L475)*
Throws if the length or assetProxyId are invalid for the corresponding AssetProxy.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Hex encoded assetData string |
**Returns:** *void*
<hr />
## Object literals
#### `Const` eip712Utils
#### ▪ **eip712Utils**: *object*
*Defined in [order-utils/src/eip712_utils.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/eip712_utils.ts#L18)*
#### createCoordinatorApprovalTypedData
▸ **createCoordinatorApprovalTypedData**(`transaction`: `SignedZeroExTransaction`, `verifyingContractAddress`: string, `txOrigin`: string, `approvalExpirationTimeSeconds`: `BigNumber`): *`EIP712TypedData`*
*Defined in [order-utils/src/eip712_utils.ts:103](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/eip712_utils.ts#L103)*
Creates an Coordiantor typedData EIP712TypedData object for use with the Coordinator extension contract
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`transaction` | `SignedZeroExTransaction` | A 0x transaction |
`verifyingContractAddress` | string | The coordinator extension contract address that will be verifying the typedData |
`txOrigin` | string | The desired `tx.origin` that should be able to submit an Ethereum txn involving this 0x transaction |
`approvalExpirationTimeSeconds` | `BigNumber` | The approvals expiration time |
**Returns:** *`EIP712TypedData`*
A typed data object
#### createOrderTypedData
▸ **createOrderTypedData**(`order`: `Order`): *`EIP712TypedData`*
*Defined in [order-utils/src/eip712_utils.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/eip712_utils.ts#L56)*
Creates an Order EIP712TypedData object for use with signTypedData.
**Parameters:**
Name | Type |
------ | ------ |
`order` | `Order` |
**Returns:** *`EIP712TypedData`*
A typed data object
#### createTypedData
▸ **createTypedData**(`primaryType`: string, `types`: `EIP712Types`, `message`: `EIP712Object`, `domain`: `EIP712DomainWithDefaultSchema`): *`EIP712TypedData`*
*Defined in [order-utils/src/eip712_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/eip712_utils.ts#L27)*
Creates a EIP712TypedData object specific to the 0x protocol for use with signTypedData.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`primaryType` | string | The primary type found in message |
`types` | `EIP712Types` | The additional types for the data in message |
`message` | `EIP712Object` | The contents of the message |
`domain` | `EIP712DomainWithDefaultSchema` | Domain containing a name (optional), version (optional), and verifying contract address |
**Returns:** *`EIP712TypedData`*
A typed data object
#### createZeroExTransactionTypedData
▸ **createZeroExTransactionTypedData**(`zeroExTransaction`: `ZeroExTransaction`): *`EIP712TypedData`*
*Defined in [order-utils/src/eip712_utils.ts:78](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/eip712_utils.ts#L78)*
Creates an ExecuteTransaction EIP712TypedData object for use with signTypedData and
0x Exchange executeTransaction.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`zeroExTransaction` | `ZeroExTransaction` | the 0x transaction |
**Returns:** *`EIP712TypedData`*
A typed data object
<hr />
<hr />
## Object literals
#### `Const` marketUtils
#### ▪ **marketUtils**: *object*
*Defined in [order-utils/src/market_utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/market_utils.ts#L17)*
#### findFeeOrdersThatCoverFeesForTargetOrders
▸ **findFeeOrdersThatCoverFeesForTargetOrders**<**T**>(`orders`: `T`[], `feeOrders`: `T`[], `opts?`: [FindFeeOrdersThatCoverFeesForTargetOrdersOpts](#interface-findfeeordersthatcoverfeesfortargetordersopts)): *[FeeOrdersAndRemainingFeeAmount](#interface-feeordersandremainingfeeamount)‹*`T`*›*
*Defined in [order-utils/src/market_utils.ts:64](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/market_utils.ts#L64)*
Takes an array of orders and an array of feeOrders. Returns a subset of the feeOrders that has enough ZRX
in order to fill the takerFees required by orders plus a slippageBufferAmount.
Iterates from first feeOrder to last. Sort the feeOrders by ascending rate in order to get the subset of
feeOrders that will cost the least ETH.
**Type parameters:**
▪ **T**: *`Order`*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `T`[] | An array of objects that extend the Order interface. All orders should specify ZRX as the makerAsset and WETH as the takerAsset. |
`feeOrders` | `T`[] | An array of objects that extend the Order interface. All orders should specify ZRX as the makerAsset and WETH as the takerAsset. |
`opts?` | [FindFeeOrdersThatCoverFeesForTargetOrdersOpts](#interface-findfeeordersthatcoverfeesfortargetordersopts) | Optional arguments this function accepts. |
**Returns:** *[FeeOrdersAndRemainingFeeAmount](#interface-feeordersandremainingfeeamount)‹*`T`*›*
Resulting orders and remaining fee amount that could not be covered by the input.
#### findOrdersThatCoverMakerAssetFillAmount
▸ **findOrdersThatCoverMakerAssetFillAmount**<**T**>(`orders`: `T`[], `makerAssetFillAmount`: `BigNumber`, `opts?`: [FindOrdersThatCoverMakerAssetFillAmountOpts](#interface-findordersthatcovermakerassetfillamountopts)): *[OrdersAndRemainingMakerFillAmount](#interface-ordersandremainingmakerfillamount)‹*`T`*›*
*Defined in [order-utils/src/market_utils.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/market_utils.ts#L40)*
Takes an array of orders and returns a subset of those orders that has enough makerAssetAmount
in order to fill the input makerAssetFillAmount plus slippageBufferAmount. Iterates from first order to last order.
Sort the input by ascending rate in order to get the subset of orders that will cost the least ETH.
**Type parameters:**
▪ **T**: *`Order`*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `T`[] | An array of objects that extend the Order interface. All orders should specify the same makerAsset. All orders should specify WETH as the takerAsset. |
`makerAssetFillAmount` | `BigNumber` | The amount of makerAsset desired to be filled. |
`opts?` | [FindOrdersThatCoverMakerAssetFillAmountOpts](#interface-findordersthatcovermakerassetfillamountopts) | Optional arguments this function accepts. |
**Returns:** *[OrdersAndRemainingMakerFillAmount](#interface-ordersandremainingmakerfillamount)‹*`T`*›*
Resulting orders and remaining fill amount that could not be covered by the input.
#### findOrdersThatCoverTakerAssetFillAmount
▸ **findOrdersThatCoverTakerAssetFillAmount**<**T**>(`orders`: `T`[], `takerAssetFillAmount`: `BigNumber`, `opts?`: [FindOrdersThatCoverTakerAssetFillAmountOpts](#interface-findordersthatcovertakerassetfillamountopts)): *[OrdersAndRemainingTakerFillAmount](#interface-ordersandremainingtakerfillamount)‹*`T`*›*
*Defined in [order-utils/src/market_utils.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/market_utils.ts#L18)*
**Type parameters:**
▪ **T**: *`Order`*
**Parameters:**
Name | Type |
------ | ------ |
`orders` | `T`[] |
`takerAssetFillAmount` | `BigNumber` |
`opts?` | [FindOrdersThatCoverTakerAssetFillAmountOpts](#interface-findordersthatcovertakerassetfillamountopts) |
**Returns:** *[OrdersAndRemainingTakerFillAmount](#interface-ordersandremainingtakerfillamount)‹*`T`*›*
<hr />
## Object literals
#### `Const` orderCalculationUtils
#### ▪ **orderCalculationUtils**: *object*
*Defined in [order-utils/src/order_calculation_utils.ts:6](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_calculation_utils.ts#L6)*
#### getMakerFeeAmount
▸ **getMakerFeeAmount**(`order`: `Order`, `makerFillAmount`: `BigNumber`): *`BigNumber`*
*Defined in [order-utils/src/order_calculation_utils.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_calculation_utils.ts#L75)*
Given an amount of maker asset, calculate the fee amount required for the maker
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | `Order` | The order |
`makerFillAmount` | `BigNumber` | the amount of maker asset |
**Returns:** *`BigNumber`*
#### getMakerFillAmount
▸ **getMakerFillAmount**(`order`: `Order`, `takerFillAmount`: `BigNumber`): *`BigNumber`*
*Defined in [order-utils/src/order_calculation_utils.ts:36](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_calculation_utils.ts#L36)*
Given an amount of taker asset, calculate the the amount of maker asset
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | `Order` | The order |
`takerFillAmount` | `BigNumber` | - |
**Returns:** *`BigNumber`*
#### getTakerFeeAmount
▸ **getTakerFeeAmount**(`order`: `Order`, `takerFillAmount`: `BigNumber`): *`BigNumber`*
*Defined in [order-utils/src/order_calculation_utils.ts:62](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_calculation_utils.ts#L62)*
Given an amount of taker asset, calculate the fee amount required for the taker
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | `Order` | The order |
`takerFillAmount` | `BigNumber` | the amount of taker asset |
**Returns:** *`BigNumber`*
#### getTakerFillAmount
▸ **getTakerFillAmount**(`order`: `Order`, `makerFillAmount`: `BigNumber`): *`BigNumber`*
*Defined in [order-utils/src/order_calculation_utils.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_calculation_utils.ts#L49)*
Given an amount of maker asset, calculate the equivalent amount in taker asset
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | `Order` | The order |
`makerFillAmount` | `BigNumber` | the amount of maker asset |
**Returns:** *`BigNumber`*
#### getTakerFillAmountForFeeOrder
▸ **getTakerFillAmountForFeeOrder**(`order`: `Order`, `makerFillAmount`: `BigNumber`): *[`BigNumber`, `BigNumber`]*
*Defined in [order-utils/src/order_calculation_utils.ts:89](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_calculation_utils.ts#L89)*
Given a desired amount of ZRX from a fee order, calculate the amount of taker asset required to fill.
Also calculate how much ZRX needs to be purchased in order to fill the desired amount plus the taker fee amount
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | `Order` | The order |
`makerFillAmount` | `BigNumber` | the amount of maker asset |
**Returns:** *[`BigNumber`, `BigNumber`]*
#### isOpenOrder
▸ **isOpenOrder**(`order`: `Order`): *boolean*
*Defined in [order-utils/src/order_calculation_utils.ts:28](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_calculation_utils.ts#L28)*
Determines if the order is open and fillable by any taker.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | `Order` | The order |
**Returns:** *boolean*
#### isOrderExpired
▸ **isOrderExpired**(`order`: `Order`): *boolean*
*Defined in [order-utils/src/order_calculation_utils.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_calculation_utils.ts#L11)*
Determines if the order is expired given the current time
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | `Order` | The order for expiry calculation |
**Returns:** *boolean*
#### willOrderExpire
▸ **willOrderExpire**(`order`: `Order`, `secondsFromNow`: number): *boolean*
*Defined in [order-utils/src/order_calculation_utils.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_calculation_utils.ts#L19)*
Calculates if the order will expire in the future.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | `Order` | The order for expiry calculation |
`secondsFromNow` | number | The amount of seconds from current time |
**Returns:** *boolean*
<hr />
## Object literals
#### `Const` orderHashUtils
#### ▪ **orderHashUtils**: *object*
*Defined in [order-utils/src/order_hash.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_hash.ts#L12)*
#### getOrderHashBuffer
▸ **getOrderHashBuffer**(`order`: `SignedOrder` | `Order`): *`Buffer`*
*Defined in [order-utils/src/order_hash.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_hash.ts#L55)*
Computes the orderHash for a supplied order
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | `SignedOrder` \| `Order` | An object that conforms to the Order or SignedOrder interface definitions. |
**Returns:** *`Buffer`*
A Buffer containing the resulting orderHash from hashing the supplied order
#### getOrderHashHex
▸ **getOrderHashHex**(`order`: `SignedOrder` | `Order`): *string*
*Defined in [order-utils/src/order_hash.ts:33](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_hash.ts#L33)*
Computes the orderHash for a supplied order.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | `SignedOrder` \| `Order` | An object that conforms to the Order or SignedOrder interface definitions. |
**Returns:** *string*
Hex encoded string orderHash from hashing the supplied order.
#### isValidOrderHash
▸ **isValidOrderHash**(`orderHash`: string): *boolean*
*Defined in [order-utils/src/order_hash.ts:20](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_hash.ts#L20)*
Checks if the supplied hex encoded order hash is valid.
Note: Valid means it has the expected format, not that an order with the orderHash exists.
Use this method when processing orderHashes submitted as user input.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderHash` | string | Hex encoded orderHash. |
**Returns:** *boolean*
Whether the supplied orderHash has the expected format.
<hr />
<hr />
<hr />
## Object literals
#### `Const` orderParsingUtils
#### ▪ **orderParsingUtils**: *object*
*Defined in [order-utils/src/parsing_utils.ts:4](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/parsing_utils.ts#L4)*
#### convertOrderStringFieldsToBigNumber
▸ **convertOrderStringFieldsToBigNumber**(`order`: any): *any*
*Defined in [order-utils/src/parsing_utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/parsing_utils.ts#L17)*
**Parameters:**
Name | Type |
------ | ------ |
`order` | any |
**Returns:** *any*
#### convertStringsFieldsToBigNumbers
▸ **convertStringsFieldsToBigNumbers**(`obj`: any, `fields`: string[]): *any*
*Defined in [order-utils/src/parsing_utils.ts:5](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/parsing_utils.ts#L5)*
**Parameters:**
Name | Type |
------ | ------ |
`obj` | any |
`fields` | string[] |
**Returns:** *any*
<hr />
## Object literals
#### `Const` rateUtils
#### ▪ **rateUtils**: *object*
*Defined in [order-utils/src/rate_utils.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/rate_utils.ts#L8)*
#### getFeeAdjustedRateOfFeeOrder
▸ **getFeeAdjustedRateOfFeeOrder**(`feeOrder`: `Order`): *`BigNumber`*
*Defined in [order-utils/src/rate_utils.ts:36](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/rate_utils.ts#L36)*
Takes a fee order (makerAssetData corresponds to ZRX and takerAssetData corresponds to WETH) and calculates
the fee adjusted rate (WETH/ZRX) by dividing the takerAssetAmount by the makerAmount minus the takerFee
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`feeOrder` | `Order` | An object that conforms to the order interface |
**Returns:** *`BigNumber`*
The rate (WETH/ZRX) of the fee order adjusted for fees
#### getFeeAdjustedRateOfOrder
▸ **getFeeAdjustedRateOfOrder**(`order`: `Order`, `feeRate`: `BigNumber`): *`BigNumber`*
*Defined in [order-utils/src/rate_utils.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/rate_utils.ts#L18)*
Takes an order and calculates the fee adjusted rate (takerAsset/makerAsset) by calculating how much takerAsset
is required to cover the fees (feeRate * takerFee), adding the takerAssetAmount and dividing by makerAssetAmount
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`order` | `Order` | - | An object that conforms to the order interface |
`feeRate` | `BigNumber` | constants.ZERO_AMOUNT | The market rate of ZRX denominated in takerAssetAmount (ex. feeRate is 0.1 takerAsset/ZRX if it takes 1 unit of takerAsset to buy 10 ZRX) Defaults to 0 |
**Returns:** *`BigNumber`*
The rate (takerAsset/makerAsset) of the order adjusted for fees
<hr />
## Functions
#### generatePseudoRandomSalt
▸ **generatePseudoRandomSalt**(): *`BigNumber`*
*Defined in [order-utils/src/salt.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/salt.ts#L9)*
Generates a pseudo-random 256-bit salt.
The salt can be included in a 0x order, ensuring that the order generates a unique orderHash
and will not collide with other outstanding orders that are identical in all other parameters.
**Returns:** *`BigNumber`*
A pseudo-random 256-bit number that can be used as a salt.
<hr />
## Object literals
#### `Const` signatureUtils
#### ▪ **signatureUtils**: *object*
*Defined in [order-utils/src/signature_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L27)*
#### addSignedMessagePrefix
▸ **addSignedMessagePrefix**(`message`: string): *string*
*Defined in [order-utils/src/signature_utils.ts:500](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L500)*
Adds the relevant prefix to the message being signed.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`message` | string | Message to sign |
**Returns:** *string*
Prefixed message
#### convertECSignatureToSignatureHex
▸ **convertECSignatureToSignatureHex**(`ecSignature`: `ECSignature`): *string*
*Defined in [order-utils/src/signature_utils.ts:474](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L474)*
Combines ECSignature with V,R,S and the EthSign signature type for use in 0x protocol
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`ecSignature` | `ECSignature` | The ECSignature of the signed data |
**Returns:** *string*
Hex encoded string of signature (v,r,s) with Signature Type
#### convertToSignatureWithType
▸ **convertToSignatureWithType**(`signature`: string, `signatureType`: `SignatureType`): *string*
*Defined in [order-utils/src/signature_utils.ts:490](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L490)*
Combines the signature proof and the Signature Type.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signature` | string | The hex encoded signature proof |
`signatureType` | `SignatureType` | The signature type, i.e EthSign, Wallet etc. |
**Returns:** *string*
Hex encoded string of signature proof with Signature Type
#### ecSignHashAsync
▸ **ecSignHashAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `msgHash`: string, `signerAddress`: string): *`Promise<string>`*
*Defined in [order-utils/src/signature_utils.ts:417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L417)*
Signs a hash using `eth_sign` and returns its elliptic curve signature and signature type.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests |
`msgHash` | string | Hex encoded message to sign. |
`signerAddress` | string | The hex encoded Ethereum address you wish to sign it with. This address must be available via the supplied Provider. |
**Returns:** *`Promise<string>`*
A hex encoded string containing the Elliptic curve signature generated by signing the msgHash and the Signature Type.
#### ecSignOrderAsync
▸ **ecSignOrderAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `order`: `Order`, `signerAddress`: string): *`Promise<SignedOrder>`*
*Defined in [order-utils/src/signature_utils.ts:252](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L252)*
Signs an order and returns a SignedOrder. First `eth_signTypedData` is requested
then a fallback to `eth_sign` if not available on the supplied provider.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests |
`order` | `Order` | The Order to sign. |
`signerAddress` | string | The hex encoded Ethereum address you wish to sign it with. This address must be available via the supplied Provider. |
**Returns:** *`Promise<SignedOrder>`*
A SignedOrder containing the order and Elliptic curve signature with Signature Type.
#### ecSignTransactionAsync
▸ **ecSignTransactionAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `transaction`: `ZeroExTransaction`, `signerAddress`: string): *`Promise<SignedZeroExTransaction>`*
*Defined in [order-utils/src/signature_utils.ts:331](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L331)*
Signs a transaction and returns a SignedZeroExTransaction. First `eth_signTypedData` is requested
then a fallback to `eth_sign` if not available on the supplied provider.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests |
`transaction` | `ZeroExTransaction` | The ZeroExTransaction to sign. |
`signerAddress` | string | The hex encoded Ethereum address you wish to sign it with. This address must be available via the supplied Provider. |
**Returns:** *`Promise<SignedZeroExTransaction>`*
A SignedTransaction containing the order and Elliptic curve signature with Signature Type.
#### ecSignTypedDataOrderAsync
▸ **ecSignTypedDataOrderAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `order`: `Order`, `signerAddress`: string): *`Promise<SignedOrder>`*
*Defined in [order-utils/src/signature_utils.ts:287](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L287)*
Signs an order using `eth_signTypedData` and returns a SignedOrder.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests |
`order` | `Order` | The Order to sign. |
`signerAddress` | string | The hex encoded Ethereum address you wish to sign it with. This address must be available via the supplied Provider. |
**Returns:** *`Promise<SignedOrder>`*
A SignedOrder containing the order and Elliptic curve signature with Signature Type.
#### ecSignTypedDataTransactionAsync
▸ **ecSignTypedDataTransactionAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `transaction`: `ZeroExTransaction`, `signerAddress`: string): *`Promise<SignedZeroExTransaction>`*
*Defined in [order-utils/src/signature_utils.ts:374](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L374)*
Signs a ZeroExTransaction using `eth_signTypedData` and returns a SignedZeroExTransaction.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests |
`transaction` | `ZeroExTransaction` | The ZeroEx Transaction to sign. |
`signerAddress` | string | The hex encoded Ethereum address you wish to sign it with. This address must be available via the supplied Provider. |
**Returns:** *`Promise<SignedZeroExTransaction>`*
A SignedZeroExTransaction containing the ZeroExTransaction and Elliptic curve signature with Signature Type.
#### isValidECSignature
▸ **isValidECSignature**(`data`: string, `signature`: `ECSignature`, `signerAddress`: string): *boolean*
*Defined in [order-utils/src/signature_utils.ts:222](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L222)*
Checks if the supplied elliptic curve signature corresponds to signing `data` with
the private key corresponding to `signerAddress`
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`data` | string | The hex encoded data signed by the supplied signature. |
`signature` | `ECSignature` | An object containing the elliptic curve signature parameters. |
`signerAddress` | string | The hex encoded address that signed the data, producing the supplied signature. |
**Returns:** *boolean*
Whether the ECSignature is valid.
#### isValidPresignedSignatureAsync
▸ **isValidPresignedSignatureAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `data`: string, `signerAddress`: string, `exchangeAddress?`: undefined | string): *`Promise<boolean>`*
*Defined in [order-utils/src/signature_utils.ts:107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L107)*
Verifies that the provided presigned signature is valid according to the 0x Protocol smart contracts
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests |
`data` | string | The hex encoded data signed by the supplied signature |
`signerAddress` | string | The hex encoded address that signed the data, producing the supplied signature. |
`exchangeAddress?` | undefined \| string | The address of the Exchange contract to validate the signature against. |
**Returns:** *`Promise<boolean>`*
Whether the data was preSigned by the supplied signerAddress
#### isValidSignatureAsync
▸ **isValidSignatureAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `data`: string, `signature`: string, `signerAddress`: string, `exchangeAddress?`: undefined | string): *`Promise<boolean>`*
*Defined in [order-utils/src/signature_utils.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L38)*
Verifies that the provided signature is valid according to the 0x Protocol smart contracts
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests |
`data` | string | The hex encoded data signed by the supplied signature. |
`signature` | string | A hex encoded 0x Protocol signature made up of: [TypeSpecificData][SignatureType]. E.g [vrs][SignatureType.EIP712] |
`signerAddress` | string | The hex encoded address that signed the data, producing the supplied signature. |
`exchangeAddress?` | undefined \| string | Optional address of the Exchange contract to validate the signature against. |
**Returns:** *`Promise<boolean>`*
Whether the signature is valid for the supplied signerAddress and data.
#### isValidValidatorSignatureAsync
▸ **isValidValidatorSignatureAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `data`: string, `signature`: string, `signerAddress`: string, `exchangeAddress?`: undefined | string): *`Promise<boolean>`*
*Defined in [order-utils/src/signature_utils.ts:168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L168)*
Verifies that the provided validator signature is valid according to the 0x Protocol smart contracts
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests |
`data` | string | The hex encoded data signed by the supplied signature. |
`signature` | string | A hex encoded presigned 0x Protocol signature made up of: [SignatureType.Presigned] |
`signerAddress` | string | The hex encoded address that signed the data, producing the supplied signature. |
`exchangeAddress?` | undefined \| string | The address of the Exchange contract to validate the signature against. |
**Returns:** *`Promise<boolean>`*
Whether the data was preSigned by the supplied signerAddress.
#### isValidWalletSignatureAsync
▸ **isValidWalletSignatureAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `data`: string, `signature`: string, `signerAddress`: string): *`Promise<boolean>`*
*Defined in [order-utils/src/signature_utils.ts:139](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L139)*
Verifies that the provided wallet signature is valid according to the 0x Protocol smart contracts
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests |
`data` | string | The hex encoded data signed by the supplied signature. |
`signature` | string | A hex encoded presigned 0x Protocol signature made up of: [SignatureType.Presigned] |
`signerAddress` | string | The hex encoded address that signed the data, producing the supplied signature. |
**Returns:** *`Promise<boolean>`*
Whether the data was preSigned by the supplied signerAddress.
#### parseECSignature
▸ **parseECSignature**(`signature`: string): *`ECSignature`*
*Defined in [order-utils/src/signature_utils.ts:512](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L512)*
Parse a 0x protocol hex-encoded signature string into its ECSignature components
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signature` | string | A hex encoded ecSignature 0x Protocol signature |
**Returns:** *`ECSignature`*
An ECSignature object with r,s,v parameters
#### parseValidatorSignature
▸ **parseValidatorSignature**(`signature`: string): *`ValidatorSignature`*
*Defined in [order-utils/src/signature_utils.ts:529](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L529)*
Parse a hex-encoded Validator signature into validator address and signature components
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signature` | string | A hex encoded Validator 0x Protocol signature |
**Returns:** *`ValidatorSignature`*
A ValidatorSignature with validatorAddress and signature parameters
<hr />
## Object literals
#### `Const` sortingUtils
#### ▪ **sortingUtils**: *object*
*Defined in [order-utils/src/sorting_utils.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/sorting_utils.ts#L10)*
#### sortFeeOrdersByFeeAdjustedRate
▸ **sortFeeOrdersByFeeAdjustedRate**<**T**>(`feeOrders`: `T`[]): *`T`[]*
*Defined in [order-utils/src/sorting_utils.ts:35](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/sorting_utils.ts#L35)*
Takes an array of fee orders (makerAssetData corresponds to ZRX and takerAssetData corresponds to WETH)
and sorts them by rate in ascending order (best rate first). Adjusts the rate according to the takerFee.
**Type parameters:**
▪ **T**: *`Order`*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`feeOrders` | `T`[] | An array of objects that extend the Order interface. All orders should specify ZRX as the makerAsset and WETH as the takerAsset. |
**Returns:** *`T`[]*
The input orders sorted by rate in ascending order
#### sortOrdersByFeeAdjustedRate
▸ **sortOrdersByFeeAdjustedRate**<**T**>(`orders`: `T`[], `feeRate`: `BigNumber`): *`T`[]*
*Defined in [order-utils/src/sorting_utils.ts:21](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/sorting_utils.ts#L21)*
Takes an array of orders and sorts them by takerAsset/makerAsset rate in ascending order (best rate first).
Adjusts the rate of each order according to the feeRate and takerFee for that order.
**Type parameters:**
▪ **T**: *`Order`*
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`orders` | `T`[] | - | An array of objects that extend the Order interface. All orders should specify ZRX as the makerAsset and WETH as the takerAsset. |
`feeRate` | `BigNumber` | constants.ZERO_AMOUNT | The market rate of ZRX denominated in takerAssetAmount (ex. feeRate is 0.1 takerAsset/ZRX if it takes 1 unit of takerAsset to buy 10 ZRX) Defaults to 0 |
**Returns:** *`T`[]*
The input orders sorted by rate in ascending order
<hr />
<hr />
<hr />
## Object literals
#### `Const` transactionHashUtils
#### ▪ **transactionHashUtils**: *object*
*Defined in [order-utils/src/transaction_hash.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/transaction_hash.ts#L9)*
#### getTransactionHashBuffer
▸ **getTransactionHashBuffer**(`transaction`: `ZeroExTransaction` | `SignedZeroExTransaction`): *`Buffer`*
*Defined in [order-utils/src/transaction_hash.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/transaction_hash.ts#L41)*
Computes the transactionHash for a supplied 0x transaction.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`transaction` | `ZeroExTransaction` \| `SignedZeroExTransaction` | An object that conforms to the ZeroExTransaction or SignedZeroExTransaction interface definitions. |
**Returns:** *`Buffer`*
A Buffer containing the resulting transactionHash from hashing the supplied 0x transaction.
#### getTransactionHashHex
▸ **getTransactionHashHex**(`transaction`: `ZeroExTransaction` | `SignedZeroExTransaction`): *string*
*Defined in [order-utils/src/transaction_hash.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/transaction_hash.ts#L30)*
Computes the transactionHash for a supplied 0x transaction.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`transaction` | `ZeroExTransaction` \| `SignedZeroExTransaction` | An object that conforms to the ZeroExTransaction or SignedZeroExTransaction interface definitions. |
**Returns:** *string*
Hex encoded string transactionHash from hashing the supplied order.
#### isValidTransactionHash
▸ **isValidTransactionHash**(`transactionHash`: string): *boolean*
*Defined in [order-utils/src/transaction_hash.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/transaction_hash.ts#L17)*
Checks if the supplied hex encoded 0x transaction hash is valid.
Note: Valid means it has the expected format, not that a transaction with the transactionHash exists.
Use this method when processing transactionHashes submitted as user input.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`transactionHash` | string | Hex encoded transactionHash. |
**Returns:** *boolean*
Whether the supplied transactionHash has the expected format.
<hr />
Reference in New Issue View Git Blame Copy Permalink