crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
protocol/packages/asset-swapper/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

3387 lines
88 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: SwapQuoteConsumer
## Implements
* [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)‹*[SmartContractParams](#smartcontractparams)*›
## Constructors
\+ **new SwapQuoteConsumer**(`supportedProvider`: [SupportedProvider](#supportedprovider), `options`: `Partial<SwapQuoteConsumerOpts>`): *[SwapQuoteConsumer](#class-swapquoteconsumer)*
*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L30)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`options` | `Partial<SwapQuoteConsumerOpts>` | {} |
**Returns:** *[SwapQuoteConsumer](#class-swapquoteconsumer)*
## Properties
### networkId
• **networkId**: *number*
*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L26)*
___
### provider
• **provider**: *`ZeroExProvider`*
*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:25](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L25)*
## Methods
### executeSwapQuoteOrThrowAsync
▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial<SwapQuoteExecutionOpts>`): *`Promise<string>`*
*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)*
*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:80](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L80)*
Given a SwapQuote and desired rate (in takerAsset), attempt to execute the swap.
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`quote` | [SwapQuote](#swapquote) | - | An object that conforms to SwapQuote. See type definition for more information. |
`opts` | `Partial<SwapQuoteExecutionOpts>` | {} | Options for getting CalldataInfo. See type definition for more information. |
**Returns:** *`Promise<string>`*
___
### getCalldataOrThrowAsync
▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial<SwapQuoteGetOutputOpts>`): *`Promise<CalldataInfo>`*
*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)*
*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L52)*
Given a SwapQuote, returns 'CalldataInfo' for a 0x exchange call. See type definition of CalldataInfo for more information.
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`quote` | [SwapQuote](#swapquote) | - | An object that conforms to SwapQuote. See type definition for more information. |
`opts` | `Partial<SwapQuoteGetOutputOpts>` | {} | Options for getting SmartContractParams. See type definition for more information. |
**Returns:** *`Promise<CalldataInfo>`*
___
### getSmartContractParamsOrThrowAsync
▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial<SwapQuoteGetOutputOpts>`): *`Promise<SmartContractParamsInfo<SmartContractParams>>`*
*Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)*
*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:66](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L66)*
Given a SwapQuote, returns 'SmartContractParamsInfo' for a 0x exchange call. See type definition of SmartContractParamsInfo for more information.
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`quote` | [SwapQuote](#swapquote) | - | An object that conforms to SwapQuote. See type definition for more information. |
`opts` | `Partial<SwapQuoteGetOutputOpts>` | {} | Options for getting SmartContractParams. See type definition for more information. |
**Returns:** *`Promise<SmartContractParamsInfo<SmartContractParams>>`*
<hr />
# Class: SwapQuoter
## Constructors
\+ **new SwapQuoter**(`supportedProvider`: [SupportedProvider](#supportedprovider), `orderbook`: `Orderbook`, `options`: `Partial<SwapQuoterOpts>`): *[SwapQuoter](#class-swapquoter)*
*Defined in [asset-swapper/src/swap_quoter.ts:125](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L125)*
Instantiates a new SwapQuoter instance
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. |
`orderbook` | `Orderbook` | - | An object that conforms to Orderbook, see type for definition. |
`options` | `Partial<SwapQuoterOpts>` | {} | Initialization options for the SwapQuoter. See type definition for details. |
**Returns:** *[SwapQuoter](#class-swapquoter)*
An instance of SwapQuoter
## Properties
### expiryBufferMs
• **expiryBufferMs**: *number*
*Defined in [asset-swapper/src/swap_quoter.ts:29](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L29)*
___
### orderbook
• **orderbook**: *`Orderbook`*
*Defined in [asset-swapper/src/swap_quoter.ts:28](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L28)*
___
### provider
• **provider**: *`ZeroExProvider`*
*Defined in [asset-swapper/src/swap_quoter.ts:27](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L27)*
## Methods
### destroyAsync
▸ **destroyAsync**(): *`Promise<void>`*
*Defined in [asset-swapper/src/swap_quoter.ts:390](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L390)*
Destroys any subscriptions or connections.
**Returns:** *`Promise<void>`*
___
### getAvailableMakerAssetDatasAsync
▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise<string[]>`*
*Defined in [asset-swapper/src/swap_quoter.ts:308](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L308)*
Get the asset data of all assets that are purchaseable with takerAssetData in the order provider passed in at init.
**Parameters:**
Name | Type |
------ | ------ |
`takerAssetData` | string |
**Returns:** *`Promise<string[]>`*
An array of asset data strings that are purchaseable with takerAssetData.
___
### getAvailableTakerAssetDatasAsync
▸ **getAvailableTakerAssetDatasAsync**(`makerAssetData`: string): *`Promise<string[]>`*
*Defined in [asset-swapper/src/swap_quoter.ts:293](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L293)*
Get the asset data of all assets that can be used to purchase makerAssetData in the order provider passed in at init.
**Parameters:**
Name | Type |
------ | ------ |
`makerAssetData` | string |
**Returns:** *`Promise<string[]>`*
An array of asset data strings that can purchase makerAssetData.
___
### getLiquidityForMakerTakerAssetDataPairAsync
▸ **getLiquidityForMakerTakerAssetDataPairAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise<LiquidityForAssetData>`*
*Defined in [asset-swapper/src/swap_quoter.ts:267](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L267)*
Returns information about available liquidity for an asset
Does not factor in slippage or fees
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`makerAssetData` | string | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). |
`takerAssetData` | string | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). |
**Returns:** *`Promise<LiquidityForAssetData>`*
An object that conforms to LiquidityForAssetData that satisfies the request. See type definition for more information.
___
### getMarketBuySwapQuoteAsync
▸ **getMarketBuySwapQuoteAsync**(`makerTokenAddress`: string, `takerTokenAddress`: string, `makerAssetBuyAmount`: `BigNumber`, `options`: `Partial<SwapQuoteRequestOpts>`): *`Promise<SwapQuote>`*
*Defined in [asset-swapper/src/swap_quoter.ts:209](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L209)*
Get a `SwapQuote` containing all information relevant to fulfilling a swap between a desired ERC20 token address and ERC20 owned by a provided address.
You can then pass the `SwapQuote` to a `SwapQuoteConsumer` to execute a buy, or process SwapQuote for on-chain consumption.
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`makerTokenAddress` | string | - | The address of the maker asset |
`takerTokenAddress` | string | - | The address of the taker asset |
`makerAssetBuyAmount` | `BigNumber` | - | The amount of maker asset to swap for. |
`options` | `Partial<SwapQuoteRequestOpts>` | {} | Options for the request. See type definition for more information. |
**Returns:** *`Promise<SwapQuote>`*
An object that conforms to SwapQuote that satisfies the request. See type definition for more information.
___
### getMarketBuySwapQuoteForAssetDataAsync
▸ **getMarketBuySwapQuoteForAssetDataAsync**(`makerAssetData`: string, `takerAssetData`: string, `makerAssetBuyAmount`: `BigNumber`, `options`: `Partial<SwapQuoteRequestOpts>`): *`Promise<MarketBuySwapQuote>`*
*Defined in [asset-swapper/src/swap_quoter.ts:184](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L184)*
Get a `SwapQuote` containing all information relevant to fulfilling a swap between a desired ERC20 token address and ERC20 owned by a provided address.
You can then pass the `SwapQuote` to a `SwapQuoteConsumer` to execute a buy, or process SwapQuote for on-chain consumption.
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`makerAssetData` | string | - | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). |
`takerAssetData` | string | - | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). |
`makerAssetBuyAmount` | `BigNumber` | - | The amount of maker asset to swap for. |
`options` | `Partial<SwapQuoteRequestOpts>` | {} | Options for the request. See type definition for more information. |
**Returns:** *`Promise<MarketBuySwapQuote>`*
An object that conforms to SwapQuote that satisfies the request. See type definition for more information.
___
### getMarketSellSwapQuoteAsync
▸ **getMarketSellSwapQuoteAsync**(`makerTokenAddress`: string, `takerTokenAddress`: string, `takerAssetSellAmount`: `BigNumber`, `options`: `Partial<SwapQuoteRequestOpts>`): *`Promise<SwapQuote>`*
*Defined in [asset-swapper/src/swap_quoter.ts:239](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L239)*
Get a `SwapQuote` containing all information relevant to fulfilling a swap between a desired ERC20 token address and ERC20 owned by a provided address.
You can then pass the `SwapQuote` to a `SwapQuoteConsumer` to execute a buy, or process SwapQuote for on-chain consumption.
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`makerTokenAddress` | string | - | The address of the maker asset |
`takerTokenAddress` | string | - | The address of the taker asset |
`takerAssetSellAmount` | `BigNumber` | - | The amount of taker asset to sell. |
`options` | `Partial<SwapQuoteRequestOpts>` | {} | Options for the request. See type definition for more information. |
**Returns:** *`Promise<SwapQuote>`*
An object that conforms to SwapQuote that satisfies the request. See type definition for more information.
___
### getMarketSellSwapQuoteForAssetDataAsync
▸ **getMarketSellSwapQuoteForAssetDataAsync**(`makerAssetData`: string, `takerAssetData`: string, `takerAssetSellAmount`: `BigNumber`, `options`: `Partial<SwapQuoteRequestOpts>`): *`Promise<MarketSellSwapQuote>`*
*Defined in [asset-swapper/src/swap_quoter.ts:158](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L158)*
Get a `SwapQuote` containing all information relevant to fulfilling a swap between a desired ERC20 token address and ERC20 owned by a provided address.
You can then pass the `SwapQuote` to a `SwapQuoteConsumer` to execute a buy, or process SwapQuote for on-chain consumption.
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`makerAssetData` | string | - | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). |
`takerAssetData` | string | - | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). |
`takerAssetSellAmount` | `BigNumber` | - | The amount of taker asset to swap for. |
`options` | `Partial<SwapQuoteRequestOpts>` | {} | Options for the request. See type definition for more information. |
**Returns:** *`Promise<MarketSellSwapQuote>`*
An object that conforms to SwapQuote that satisfies the request. See type definition for more information.
___
### getOrdersAndFillableAmountsAsync
▸ **getOrdersAndFillableAmountsAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise<OrdersAndFillableAmounts>`*
*Defined in [asset-swapper/src/swap_quoter.ts:340](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L340)*
Grab orders from the map, if there is a miss or it is time to refresh, fetch and process the orders
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`makerAssetData` | string | The makerAssetData of the desired asset to swap for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). |
`takerAssetData` | string | The takerAssetData of the asset to swap makerAssetData for (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). |
**Returns:** *`Promise<OrdersAndFillableAmounts>`*
___
### isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync
▸ **isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync**(`swapQuote`: [SwapQuote](#swapquote), `takerAddress`: string): *`Promise<[boolean, boolean]>`*
*Defined in [asset-swapper/src/swap_quoter.ts:371](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L371)*
Util function to check if takerAddress's allowance is enough for 0x exchange contracts to conduct the swap specified by the swapQuote.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`swapQuote` | [SwapQuote](#swapquote) | The swapQuote in question to check enough allowance enabled for 0x exchange contracts to conduct the swap. |
`takerAddress` | string | The address of the taker of the provided swapQuote |
**Returns:** *`Promise<[boolean, boolean]>`*
___
### isTakerMakerAssetDataPairAvailableAsync
▸ **isTakerMakerAssetDataPairAvailableAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise<boolean>`*
*Defined in [asset-swapper/src/swap_quoter.ts:323](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L323)*
Validates the taker + maker asset pair is available from the order provider provided to `SwapQuote`.
**Parameters:**
Name | Type |
------ | ------ |
`makerAssetData` | string |
`takerAssetData` | string |
**Returns:** *`Promise<boolean>`*
A boolean on if the taker, maker pair exists
___
### `Static` getSwapQuoterForMeshEndpoint
▸ **getSwapQuoterForMeshEndpoint**(`supportedProvider`: [SupportedProvider](#supportedprovider), `meshEndpoint`: string, `options`: `Partial<SwapQuoterOpts & MeshOrderProviderOpts>`): *[SwapQuoter](#class-swapquoter)*
*Defined in [asset-swapper/src/swap_quoter.ts:112](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L112)*
Instantiates a new SwapQuoter instance given a 0x Mesh endpoint. This pulls all available liquidity stored in Mesh
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. |
`meshEndpoint` | string | - | The standard relayer API base HTTP url you would like to source orders from. |
`options` | `Partial<SwapQuoterOpts & MeshOrderProviderOpts>` | {} | Initialization options for the SwapQuoter. See type definition for details. |
**Returns:** *[SwapQuoter](#class-swapquoter)*
An instance of SwapQuoter
___
### `Static` getSwapQuoterForProvidedOrders
▸ **getSwapQuoterForProvidedOrders**(`supportedProvider`: [SupportedProvider](#supportedprovider), `orders`: `SignedOrder`[], `options`: `Partial<SwapQuoterOpts>`): *[SwapQuoter](#class-swapquoter)*
*Defined in [asset-swapper/src/swap_quoter.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L40)*
Instantiates a new SwapQuoter instance given existing liquidity in the form of orders and feeOrders.
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. |
`orders` | `SignedOrder`[] | - | A non-empty array of objects that conform to SignedOrder. All orders must have the same makerAssetData and takerAssetData. |
`options` | `Partial<SwapQuoterOpts>` | {} | Initialization options for the SwapQuoter. See type definition for details. |
**Returns:** *[SwapQuoter](#class-swapquoter)*
An instance of SwapQuoter
___
### `Static` getSwapQuoterForStandardRelayerAPIUrl
▸ **getSwapQuoterForStandardRelayerAPIUrl**(`supportedProvider`: [SupportedProvider](#supportedprovider), `sraApiUrl`: string, `options`: `Partial<SwapQuoterOpts & SRAPollingOrderProviderOpts>`): *[SwapQuoter](#class-swapquoter)*
*Defined in [asset-swapper/src/swap_quoter.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L60)*
Instantiates a new SwapQuoter instance given a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. |
`sraApiUrl` | string | - | The standard relayer API base HTTP url you would like to source orders from. |
`options` | `Partial<SwapQuoterOpts & SRAPollingOrderProviderOpts>` | {} | Initialization options for the SwapQuoter. See type definition for details. |
**Returns:** *[SwapQuoter](#class-swapquoter)*
An instance of SwapQuoter
___
### `Static` getSwapQuoterForStandardRelayerAPIWebsocket
▸ **getSwapQuoterForStandardRelayerAPIWebsocket**(`supportedProvider`: [SupportedProvider](#supportedprovider), `sraApiUrl`: string, `sraWebsocketAPIUrl`: string, `options`: `Partial<SwapQuoterOpts>`): *[SwapQuoter](#class-swapquoter)*
*Defined in [asset-swapper/src/swap_quoter.ts:87](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/swap_quoter.ts#L87)*
Instantiates a new SwapQuoter instance given a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint
and a websocket endpoint. This is more effecient than `getSwapQuoterForStandardRelayerAPIUrl` when requesting multiple quotes.
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - | The Provider instance you would like to use for interacting with the Ethereum network. |
`sraApiUrl` | string | - | The standard relayer API base HTTP url you would like to source orders from. |
`sraWebsocketAPIUrl` | string | - | - |
`options` | `Partial<SwapQuoterOpts>` | {} | Initialization options for the SwapQuoter. See type definition for details. |
**Returns:** *[SwapQuoter](#class-swapquoter)*
An instance of SwapQuoter
<hr />
# Class: BaseOrderProvider
## Constructors
\+ **new BaseOrderProvider**(`orderStore`: [OrderStore](_orderbook_src_order_store_.orderstore.md)): *[BaseOrderProvider](#class-baseorderprovider)*
*Defined in [orderbook/src/order_provider/base_order_provider.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_provider/base_order_provider.ts#L12)*
**Parameters:**
Name | Type |
------ | ------ |
`orderStore` | [OrderStore](#class-orderstore) |
**Returns:** *[BaseOrderProvider](#class-baseorderprovider)*
## Properties
### _orderStore
• **_orderStore**: *[OrderStore](#class-orderstore)*
*Defined in [orderbook/src/order_provider/base_order_provider.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_provider/base_order_provider.ts#L12)*
## Methods
### `Abstract` addOrdersAsync
▸ **addOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise<AcceptedRejectedOrders>`*
*Defined in [orderbook/src/order_provider/base_order_provider.ts:27](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_provider/base_order_provider.ts#L27)*
**Parameters:**
Name | Type |
------ | ------ |
`orders` | `SignedOrder`[] |
**Returns:** *`Promise<AcceptedRejectedOrders>`*
___
### `Abstract` createSubscriptionForAssetPairAsync
▸ **createSubscriptionForAssetPairAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise<void>`*
*Defined in [orderbook/src/order_provider/base_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_provider/base_order_provider.ts#L18)*
**Parameters:**
Name | Type |
------ | ------ |
`makerAssetData` | string |
`takerAssetData` | string |
**Returns:** *`Promise<void>`*
___
### `Abstract` destroyAsync
▸ **destroyAsync**(): *`Promise<void>`*
*Defined in [orderbook/src/order_provider/base_order_provider.ts:25](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_provider/base_order_provider.ts#L25)*
**Returns:** *`Promise<void>`*
___
### `Abstract` getAvailableAssetDatasAsync
▸ **getAvailableAssetDatasAsync**(): *`Promise<AssetPairsItem[]>`*
*Defined in [orderbook/src/order_provider/base_order_provider.ts:23](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_provider/base_order_provider.ts#L23)*
**Returns:** *`Promise<AssetPairsItem[]>`*
<hr />
# Class: OrderSet
## Constructors
\+ **new OrderSet**(`orders`: `APIOrder`[]): *[OrderSet](#class-orderset)*
*Defined in [orderbook/src/order_set.ts:6](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_set.ts#L6)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`orders` | `APIOrder`[] | [] |
**Returns:** *[OrderSet](#class-orderset)*
## Methods
### add
▸ **add**(`item`: `APIOrder`): *void*
*Defined in [orderbook/src/order_set.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_set.ts#L19)*
**Parameters:**
Name | Type |
------ | ------ |
`item` | `APIOrder` |
**Returns:** *void*
___
### addMany
▸ **addMany**(`items`: `APIOrder`[]): *void*
*Defined in [orderbook/src/order_set.ts:25](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_set.ts#L25)*
**Parameters:**
Name | Type |
------ | ------ |
`items` | `APIOrder`[] |
**Returns:** *void*
___
### delete
▸ **delete**(`item`: `APIOrder`): *boolean*
*Defined in [orderbook/src/order_set.ts:57](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_set.ts#L57)*
**Parameters:**
Name | Type |
------ | ------ |
`item` | `APIOrder` |
**Returns:** *boolean*
___
### deleteMany
▸ **deleteMany**(`items`: `APIOrder`[]): *void*
*Defined in [orderbook/src/order_set.ts:61](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_set.ts#L61)*
**Parameters:**
Name | Type |
------ | ------ |
`items` | `APIOrder`[] |
**Returns:** *void*
___
### diff
▸ **diff**(`other`: [OrderSet](#class-orderset)): *object*
*Defined in [orderbook/src/order_set.ts:35](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_set.ts#L35)*
**Parameters:**
Name | Type |
------ | ------ |
`other` | [OrderSet](#class-orderset) |
**Returns:** *object*
___
### has
▸ **has**(`order`: `APIOrder`): *boolean*
*Defined in [orderbook/src/order_set.ts:31](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_set.ts#L31)*
**Parameters:**
Name | Type |
------ | ------ |
`order` | `APIOrder` |
**Returns:** *boolean*
___
### size
▸ **size**(): *number*
*Defined in [orderbook/src/order_set.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_set.ts#L15)*
**Returns:** *number*
___
### values
▸ **values**(): *`IterableIterator<APIOrder>`*
*Defined in [orderbook/src/order_set.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_set.ts#L53)*
**Returns:** *`IterableIterator<APIOrder>`*
<hr />
# Class: OrderStore
## Methods
### getOrderSetForAssetPair
▸ **getOrderSetForAssetPair**(`assetPairKey`: string): *[OrderSet](#class-orderset)*
*Defined in [orderbook/src/order_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_store.ts#L19)*
**Parameters:**
Name | Type |
------ | ------ |
`assetPairKey` | string |
**Returns:** *[OrderSet](#class-orderset)*
___
### getOrderSetForAssets
▸ **getOrderSetForAssets**(`makerAssetData`: string, `takerAssetData`: string): *[OrderSet](#class-orderset)*
*Defined in [orderbook/src/order_store.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_store.ts#L15)*
**Parameters:**
Name | Type |
------ | ------ |
`makerAssetData` | string |
`takerAssetData` | string |
**Returns:** *[OrderSet](#class-orderset)*
___
### has
▸ **has**(`assetPairKey`: string): *boolean*
*Defined in [orderbook/src/order_store.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_store.ts#L34)*
**Parameters:**
Name | Type |
------ | ------ |
`assetPairKey` | string |
**Returns:** *boolean*
___
### keys
▸ **keys**(): *`IterableIterator<string>`*
*Defined in [orderbook/src/order_store.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_store.ts#L40)*
**Returns:** *`IterableIterator<string>`*
___
### update
▸ **update**(`addedRemoved`: [AddedRemovedOrders](#interface-addedremovedorders)): *void*
*Defined in [orderbook/src/order_store.ts:28](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_store.ts#L28)*
**Parameters:**
Name | Type |
------ | ------ |
`addedRemoved` | [AddedRemovedOrders](#interface-addedremovedorders) |
**Returns:** *void*
___
### values
▸ **values**(`assetPairKey`: string): *`APIOrder`[]*
*Defined in [orderbook/src/order_store.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_store.ts#L37)*
**Parameters:**
Name | Type |
------ | ------ |
`assetPairKey` | string |
**Returns:** *`APIOrder`[]*
___
### `Static` assetPairKeyToAssets
▸ **assetPairKeyToAssets**(`assetPairKey`: string): *string[]*
*Defined in [orderbook/src/order_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_store.ts#L12)*
**Parameters:**
Name | Type |
------ | ------ |
`assetPairKey` | string |
**Returns:** *string[]*
___
### `Static` getKeyForAssetPair
▸ **getKeyForAssetPair**(`makerAssetData`: string, `takerAssetData`: string): *string*
*Defined in [orderbook/src/order_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_store.ts#L9)*
**Parameters:**
Name | Type |
------ | ------ |
`makerAssetData` | string |
`takerAssetData` | string |
**Returns:** *string*
<hr />
# Class: Orderbook
## Constructors
\+ **new Orderbook**(`orderProvider`: [BaseOrderProvider](_orderbook_src_order_provider_base_order_provider_.baseorderprovider.md), `orderStore`: [OrderStore](_orderbook_src_order_store_.orderstore.md)): *[Orderbook](#class-orderbook)*
*Defined in [orderbook/src/orderbook.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L55)*
Creates an Orderbook with the order provider. All order updates are stored
in the `OrderStore`.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orderProvider` | [BaseOrderProvider](#class-baseorderprovider) | the order provider, e.g SRAWebbsocketOrderProvider |
`orderStore` | [OrderStore](#class-orderstore) | the order store where orders are added and deleted |
**Returns:** *[Orderbook](#class-orderbook)*
## Methods
### addOrdersAsync
▸ **addOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise<AcceptedRejectedOrders>`*
*Defined in [orderbook/src/orderbook.ts:98](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L98)*
Adds the orders to the Order Provider. All accepted orders will be returned
and rejected orders will be returned with an message indicating a reason for its rejection
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `SignedOrder`[] | The set of Orders to add to the Order Provider |
**Returns:** *`Promise<AcceptedRejectedOrders>`*
___
### destroyAsync
▸ **destroyAsync**(): *`Promise<void>`*
*Defined in [orderbook/src/orderbook.ts:104](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L104)*
Destroys any subscriptions or connections.
**Returns:** *`Promise<void>`*
___
### getAvailableAssetDatasAsync
▸ **getAvailableAssetDatasAsync**(): *`Promise<AssetPairsItem[]>`*
*Defined in [orderbook/src/orderbook.ts:90](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L90)*
Returns all of the Available Asset Pairs for the provided Order Provider.
**Returns:** *`Promise<AssetPairsItem[]>`*
___
### getOrdersAsync
▸ **getOrdersAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise<APIOrder[]>`*
*Defined in [orderbook/src/orderbook.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L75)*
Returns all orders where the order.makerAssetData == makerAssetData and
order.takerAssetData == takerAssetData. This pair is then subscribed to
and all future updates will be stored. The first request
to `getOrdersAsync` might fetch the orders from the Order Provider and create a subscription.
Subsequent requests will be quick and up to date and synced with the Order Provider state.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`makerAssetData` | string | the maker asset data |
`takerAssetData` | string | the taker asset data |
**Returns:** *`Promise<APIOrder[]>`*
___
### `Static` getOrderbookForMeshProvider
▸ **getOrderbookForMeshProvider**(`opts`: [MeshOrderProviderOpts](#interface-meshorderprovideropts)): *[Orderbook](#class-orderbook)*
*Defined in [orderbook/src/orderbook.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L52)*
Creates an Orderbook with a Mesh Order Provider. This Provider fetches ALL orders
and subscribes to updates on ALL orders.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`opts` | [MeshOrderProviderOpts](#interface-meshorderprovideropts) | the `MeshOrderProviderOpts` |
**Returns:** *[Orderbook](#class-orderbook)*
___
### `Static` getOrderbookForPollingProvider
▸ **getOrderbookForPollingProvider**(`opts`: [SRAPollingOrderProviderOpts](#interface-srapollingorderprovideropts)): *[Orderbook](#class-orderbook)*
*Defined in [orderbook/src/orderbook.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L43)*
Creates an Orderbook with SRA Polling Provider. This Provider simply polls every interval.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`opts` | [SRAPollingOrderProviderOpts](#interface-srapollingorderprovideropts) | the `SRAPollingOrderProviderOpts` |
**Returns:** *[Orderbook](#class-orderbook)*
___
### `Static` getOrderbookForProvidedOrders
▸ **getOrderbookForProvidedOrders**(`orders`: `SignedOrder`[]): *[Orderbook](#class-orderbook)*
*Defined in [orderbook/src/orderbook.ts:26](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L26)*
Creates an Orderbook with the provided orders. This provider simply stores the
orders and allows querying. No validation or subscriptions occur.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `SignedOrder`[] | the set of SignedOrders |
**Returns:** *[Orderbook](#class-orderbook)*
___
### `Static` getOrderbookForWebsocketProvider
▸ **getOrderbookForWebsocketProvider**(`opts`: [SRAWebsocketOrderProviderOpts](#interface-srawebsocketorderprovideropts)): *[Orderbook](#class-orderbook)*
*Defined in [orderbook/src/orderbook.ts:35](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L35)*
Creates an Orderbook with the SRA Websocket Provider. This Provider fetches orders via
the SRA http endpoint and then subscribes to the asset pair for future updates.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`opts` | [SRAWebsocketOrderProviderOpts](#interface-srawebsocketorderprovideropts) | the `SRAWebsocketOrderProviderOpts` |
**Returns:** *[Orderbook](#class-orderbook)*
<hr />
# Enumeration: ConsumerType
Represents the varying smart contracts that can consume a valid swap quote
## Enumeration members
### Exchange
• **Exchange**: = "EXCHANGE"
*Defined in [asset-swapper/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L91)*
___
### Forwarder
• **Forwarder**: = "FORWARDER"
*Defined in [asset-swapper/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L90)*
<hr />
# Enumeration: SwapQuoterError
Possible error messages thrown by an SwapQuoter instance or associated static methods.
## Enumeration members
### AssetUnavailable
• **AssetUnavailable**: = "ASSET_UNAVAILABLE"
*Defined in [asset-swapper/src/types.ts:301](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L301)*
___
### InsufficientAssetLiquidity
• **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY"
*Defined in [asset-swapper/src/types.ts:298](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L298)*
___
### InsufficientZrxLiquidity
• **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY"
*Defined in [asset-swapper/src/types.ts:299](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L299)*
___
### InvalidOrderProviderResponse
• **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE"
*Defined in [asset-swapper/src/types.ts:300](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L300)*
___
### NoEtherTokenContractFound
• **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND"
*Defined in [asset-swapper/src/types.ts:295](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L295)*
___
### NoZrxTokenContractFound
• **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND"
*Defined in [asset-swapper/src/types.ts:296](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L296)*
___
### StandardRelayerApiError
• **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR"
*Defined in [asset-swapper/src/types.ts:297](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L297)*
<hr />
<hr />
# Interface: CalldataInfo
Represents the metadata to call a smart contract with calldata.
calldataHexString: The hexstring of the calldata.
methodAbi: The ABI of the smart contract method to call.
toAddress: The contract address to call.
ethAmount: If provided, the eth amount in wei to send with the smart contract call.
## Properties
### calldataHexString
• **calldataHexString**: *string*
*Defined in [asset-swapper/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L39)*
___
### `Optional` ethAmount
• **ethAmount**? : *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L42)*
___
### methodAbi
• **methodAbi**: *`MethodAbi`*
*Defined in [asset-swapper/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L40)*
___
### toAddress
• **toAddress**: *string*
*Defined in [asset-swapper/src/types.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L41)*
<hr />
# Interface: ForwarderSwapQuoteExecutionOpts
## Properties
### `Optional` ethAmount
• **ethAmount**? : *`BigNumber`*
*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[ethAmount](#optional-ethamount)*
*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L181)*
___
### feePercentage
• **feePercentage**: *number*
*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feePercentage](#feepercentage)*
*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L179)*
___
### feeRecipient
• **feeRecipient**: *string*
*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feeRecipient](#feerecipient)*
*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L180)*
___
### `Optional` gasLimit
• **gasLimit**? : *undefined | number*
*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasLimit](#optional-gaslimit)*
*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L169)*
___
### `Optional` gasPrice
• **gasPrice**? : *`BigNumber`*
*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasPrice](#optional-gasprice)*
*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L170)*
___
### `Optional` takerAddress
• **takerAddress**? : *undefined | string*
*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[takerAddress](#optional-takeraddress)*
*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L168)*
<hr />
# Interface: ForwarderSwapQuoteGetOutputOpts
feePercentage: percentage (up to 5%) of the taker asset paid to feeRecipient
feeRecipient: address of the receiver of the feePercentage of taker asset
ethAmount: The amount of eth (in Wei) sent to the forwarder contract.
## Properties
### `Optional` ethAmount
• **ethAmount**? : *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L181)*
___
### feePercentage
• **feePercentage**: *number*
*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L179)*
___
### feeRecipient
• **feeRecipient**: *string*
*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L180)*
<hr />
# Interface: LiquidityForAssetData
Represents available liquidity for a given assetData
## Properties
### makerTokensAvailableInBaseUnits
• **makerTokensAvailableInBaseUnits**: *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:317](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L317)*
___
### takerTokensAvailableInBaseUnits
• **takerTokensAvailableInBaseUnits**: *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:318](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L318)*
<hr />
# Interface: MarketBuySwapQuote
makerAssetFillAmount: The amount of makerAsset bought with takerAsset.
type: Specified MarketOperation the SwapQuote is provided for
## Properties
### bestCaseQuoteInfo
• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)*
*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L215)*
___
### feeOrders
• **feeOrders**: *`SignedOrder`[]*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)*
*Defined in [asset-swapper/src/types.ts:214](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L214)*
___
### makerAssetData
• **makerAssetData**: *string*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)*
*Defined in [asset-swapper/src/types.ts:212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L212)*
___
### makerAssetFillAmount
• **makerAssetFillAmount**: *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:233](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L233)*
___
### orders
• **orders**: *`SignedOrder`[]*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)*
*Defined in [asset-swapper/src/types.ts:213](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L213)*
___
### takerAssetData
• **takerAssetData**: *string*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)*
*Defined in [asset-swapper/src/types.ts:211](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L211)*
___
### type
• **type**: *`Buy`*
*Defined in [asset-swapper/src/types.ts:234](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L234)*
___
### worstCaseQuoteInfo
• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)*
*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L216)*
<hr />
# Interface: MarketBuySwapQuoteWithAffiliateFee
## Properties
### bestCaseQuoteInfo
• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)*
*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L215)*
___
### feeOrders
• **feeOrders**: *`SignedOrder`[]*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)*
*Defined in [asset-swapper/src/types.ts:214](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L214)*
___
### feePercentage
• **feePercentage**: *number*
*Inherited from [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase).[feePercentage](#feepercentage)*
*Defined in [asset-swapper/src/types.ts:238](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L238)*
___
### makerAssetData
• **makerAssetData**: *string*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)*
*Defined in [asset-swapper/src/types.ts:212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L212)*
___
### makerAssetFillAmount
• **makerAssetFillAmount**: *`BigNumber`*
*Inherited from [MarketBuySwapQuote](#interface-marketbuyswapquote).[makerAssetFillAmount](#makerassetfillamount)*
*Defined in [asset-swapper/src/types.ts:233](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L233)*
___
### orders
• **orders**: *`SignedOrder`[]*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)*
*Defined in [asset-swapper/src/types.ts:213](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L213)*
___
### takerAssetData
• **takerAssetData**: *string*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)*
*Defined in [asset-swapper/src/types.ts:211](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L211)*
___
### type
• **type**: *`Buy`*
*Inherited from [MarketBuySwapQuote](#interface-marketbuyswapquote).[type](#type)*
*Defined in [asset-swapper/src/types.ts:234](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L234)*
___
### worstCaseQuoteInfo
• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)*
*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L216)*
<hr />
# Interface: MarketSellSwapQuote
takerAssetFillAmount: The amount of takerAsset sold for makerAsset.
type: Specified MarketOperation the SwapQuote is provided for
## Properties
### bestCaseQuoteInfo
• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)*
*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L215)*
___
### feeOrders
• **feeOrders**: *`SignedOrder`[]*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)*
*Defined in [asset-swapper/src/types.ts:214](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L214)*
___
### makerAssetData
• **makerAssetData**: *string*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)*
*Defined in [asset-swapper/src/types.ts:212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L212)*
___
### orders
• **orders**: *`SignedOrder`[]*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)*
*Defined in [asset-swapper/src/types.ts:213](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L213)*
___
### takerAssetData
• **takerAssetData**: *string*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)*
*Defined in [asset-swapper/src/types.ts:211](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L211)*
___
### takerAssetFillAmount
• **takerAssetFillAmount**: *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:224](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L224)*
___
### type
• **type**: *`Sell`*
*Defined in [asset-swapper/src/types.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L225)*
___
### worstCaseQuoteInfo
• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)*
*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L216)*
<hr />
# Interface: MarketSellSwapQuoteWithAffiliateFee
## Properties
### bestCaseQuoteInfo
• **bestCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)*
*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L215)*
___
### feeOrders
• **feeOrders**: *`SignedOrder`[]*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)*
*Defined in [asset-swapper/src/types.ts:214](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L214)*
___
### feePercentage
• **feePercentage**: *number*
*Inherited from [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase).[feePercentage](#feepercentage)*
*Defined in [asset-swapper/src/types.ts:238](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L238)*
___
### makerAssetData
• **makerAssetData**: *string*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)*
*Defined in [asset-swapper/src/types.ts:212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L212)*
___
### orders
• **orders**: *`SignedOrder`[]*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)*
*Defined in [asset-swapper/src/types.ts:213](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L213)*
___
### takerAssetData
• **takerAssetData**: *string*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)*
*Defined in [asset-swapper/src/types.ts:211](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L211)*
___
### takerAssetFillAmount
• **takerAssetFillAmount**: *`BigNumber`*
*Inherited from [MarketSellSwapQuote](#interface-marketsellswapquote).[takerAssetFillAmount](#takerassetfillamount)*
*Defined in [asset-swapper/src/types.ts:224](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L224)*
___
### type
• **type**: *`Sell`*
*Inherited from [MarketSellSwapQuote](#interface-marketsellswapquote).[type](#type)*
*Defined in [asset-swapper/src/types.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L225)*
___
### worstCaseQuoteInfo
• **worstCaseQuoteInfo**: *[SwapQuoteInfo](#class-swapquoteinfo)*
*Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)*
*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L216)*
<hr />
# Interface: SmartContractParamsInfo <**T**>
Represents the metadata to call a smart contract with parameters.
params: The metadata object containing all the input parameters of a smart contract call.
toAddress: The contract address to call.
ethAmount: If provided, the eth amount in wei to send with the smart contract call.
methodAbi: The ABI of the smart contract method to call with params.
## Type parameters
▪ **T**
## Properties
### `Optional` ethAmount
• **ethAmount**? : *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L55)*
___
### methodAbi
• **methodAbi**: *`MethodAbi`*
*Defined in [asset-swapper/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L56)*
___
### params
• **params**: *`T`*
*Defined in [asset-swapper/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L53)*
___
### toAddress
• **toAddress**: *string*
*Defined in [asset-swapper/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L54)*
<hr />
# Interface: SwapQuoteConsumerBase <**T**>
Interface that varying SwapQuoteConsumers adhere to (exchange consumer, router consumer, forwarder consumer, coordinator consumer)
getCalldataOrThrow: Get CalldataInfo to swap for tokens with provided SwapQuote. Throws if invalid SwapQuote is provided.
getSmartContractParamsOrThrow: Get SmartContractParamsInfo to swap for tokens with provided SwapQuote. Throws if invalid SwapQuote is provided.
executeSwapQuoteOrThrowAsync: Executes a web3 transaction to swap for tokens with provided SwapQuote. Throws if invalid SwapQuote is provided.
## Type parameters
▪ **T**
## Implemented by
* [SwapQuoteConsumer](#class-swapquoteconsumer)
## Methods
### executeSwapQuoteOrThrowAsync
▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial<SwapQuoteExecutionOptsBase>`): *`Promise<string>`*
*Defined in [asset-swapper/src/types.ts:147](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L147)*
**Parameters:**
Name | Type |
------ | ------ |
`quote` | [SwapQuote](#swapquote) |
`opts` | `Partial<SwapQuoteExecutionOptsBase>` |
**Returns:** *`Promise<string>`*
___
### getCalldataOrThrowAsync
▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial<SwapQuoteGetOutputOptsBase>`): *`Promise<CalldataInfo>`*
*Defined in [asset-swapper/src/types.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L142)*
**Parameters:**
Name | Type |
------ | ------ |
`quote` | [SwapQuote](#swapquote) |
`opts` | `Partial<SwapQuoteGetOutputOptsBase>` |
**Returns:** *`Promise<CalldataInfo>`*
___
### getSmartContractParamsOrThrowAsync
▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial<SwapQuoteGetOutputOptsBase>`): *`Promise<SmartContractParamsInfo<T>>`*
*Defined in [asset-swapper/src/types.ts:143](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L143)*
**Parameters:**
Name | Type |
------ | ------ |
`quote` | [SwapQuote](#swapquote) |
`opts` | `Partial<SwapQuoteGetOutputOptsBase>` |
**Returns:** *`Promise<SmartContractParamsInfo<T>>`*
<hr />
# Interface: SwapQuoteConsumerOpts
networkId: The networkId that the desired orders should be for.
## Properties
### networkId
• **networkId**: *number*
*Defined in [asset-swapper/src/types.ts:154](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L154)*
<hr />
# Interface: SwapQuoteExecutionOpts
Represents the options for executing a swap quote with SwapQuoteConsumer
## Properties
### `Optional` ethAmount
• **ethAmount**? : *`BigNumber`*
*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[ethAmount](#optional-ethamount)*
*Overrides [ForwarderSwapQuoteGetOutputOpts](_asset_swapper_src_types_.forwarderswapquotegetoutputopts.md).[ethAmount](#optional-ethamount)*
*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L181)*
___
### feePercentage
• **feePercentage**: *number*
*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feePercentage](#feepercentage)*
*Overrides [ForwarderSwapQuoteGetOutputOpts](_asset_swapper_src_types_.forwarderswapquotegetoutputopts.md).[feePercentage](#feepercentage)*
*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L179)*
___
### feeRecipient
• **feeRecipient**: *string*
*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feeRecipient](#feerecipient)*
*Overrides [ForwarderSwapQuoteGetOutputOpts](_asset_swapper_src_types_.forwarderswapquotegetoutputopts.md).[feeRecipient](#feerecipient)*
*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L180)*
___
### `Optional` gasLimit
• **gasLimit**? : *undefined | number*
*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasLimit](#optional-gaslimit)*
*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L169)*
___
### `Optional` gasPrice
• **gasPrice**? : *`BigNumber`*
*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasPrice](#optional-gasprice)*
*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L170)*
___
### `Optional` takerAddress
• **takerAddress**? : *undefined | string*
*Inherited from [SwapQuoteGetOutputOpts](#interface-swapquotegetoutputopts).[takerAddress](#optional-takeraddress)*
*Overrides [SwapQuoteExecutionOptsBase](_asset_swapper_src_types_.swapquoteexecutionoptsbase.md).[takerAddress](#optional-takeraddress)*
*Defined in [asset-swapper/src/types.ts:191](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L191)*
___
### `Optional` useConsumerType
• **useConsumerType**? : *[ConsumerType](#enumeration-consumertype)*
*Inherited from [SwapQuoteGetOutputOpts](#interface-swapquotegetoutputopts).[useConsumerType](#optional-useconsumertype)*
*Defined in [asset-swapper/src/types.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L192)*
<hr />
# Interface: SwapQuoteExecutionOptsBase
takerAddress: The address to perform the buy. Defaults to the first available address from the provider.
gasLimit: The amount of gas to send with a transaction (in Gwei). Defaults to an eth_estimateGas rpc call.
gasPrice: Gas price in Wei to use for a transaction
## Properties
### `Optional` gasLimit
• **gasLimit**? : *undefined | number*
*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L169)*
___
### `Optional` gasPrice
• **gasPrice**? : *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L170)*
___
### `Optional` takerAddress
• **takerAddress**? : *undefined | string*
*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L168)*
<hr />
# Interface: SwapQuoteGetOutputOpts
takerAddress: The address to perform the buy. Defaults to the first available address from the provider.
useConsumerType: If provided, defaults the SwapQuoteConsumer to create output consumed by ConsumerType.
## Properties
### `Optional` ethAmount
• **ethAmount**? : *`BigNumber`*
*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[ethAmount](#optional-ethamount)*
*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L181)*
___
### feePercentage
• **feePercentage**: *number*
*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feePercentage](#feepercentage)*
*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L179)*
___
### feeRecipient
• **feeRecipient**: *string*
*Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feeRecipient](#feerecipient)*
*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L180)*
___
### `Optional` takerAddress
• **takerAddress**? : *undefined | string*
*Defined in [asset-swapper/src/types.ts:191](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L191)*
___
### `Optional` useConsumerType
• **useConsumerType**? : *[ConsumerType](#enumeration-consumertype)*
*Defined in [asset-swapper/src/types.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L192)*
<hr />
# Interface: SwapQuoteGetOutputOptsBase
Represents the options provided to a generic SwapQuoteConsumer
## Hierarchy
* **SwapQuoteInfo**
## Properties
### feeTakerTokenAmount
• **feeTakerTokenAmount**: *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:254](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L254)*
___
### makerTokenAmount
• **makerTokenAmount**: *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:257](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L257)*
___
### takerTokenAmount
• **takerTokenAmount**: *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:256](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L256)*
___
### totalTakerTokenAmount
• **totalTakerTokenAmount**: *`BigNumber`*
*Defined in [asset-swapper/src/types.ts:255](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L255)*
<hr />
# Interface: SwapQuoteRequestOpts
shouldDisableRequestingFeeOrders: If set to true, requesting a swapQuote will not perform any computation or requests for fees.
slippagePercentage: The percentage buffer to add to account for slippage. Affects max ETH price estimates. Defaults to 0.2 (20%).
## Properties
### shouldDisableRequestingFeeOrders
• **shouldDisableRequestingFeeOrders**: *boolean*
*Defined in [asset-swapper/src/types.ts:265](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L265)*
___
### slippagePercentage
• **slippagePercentage**: *number*
*Defined in [asset-swapper/src/types.ts:266](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L266)*
<hr />
# Interface: SwapQuoterOpts
networkId: The ethereum network id. Defaults to 1 (mainnet).
orderRefreshIntervalMs: The interval in ms that getBuyQuoteAsync should trigger an refresh of orders and order states. Defaults to 10000ms (10s).
expiryBufferMs: The number of seconds to add when calculating whether an order is expired or not. Defaults to 300s (5m).
## Properties
### expiryBufferMs
• **expiryBufferMs**: *number*
*Defined in [asset-swapper/src/types.ts:277](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L277)*
___
### networkId
• **networkId**: *number*
*Defined in [asset-swapper/src/types.ts:275](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L275)*
___
### orderRefreshIntervalMs
• **orderRefreshIntervalMs**: *number*
*Defined in [asset-swapper/src/types.ts:276](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L276)*
<hr />
# Interface: DataItem
## Properties
### `Optional` components
• **components**? : *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L131)*
___
### name
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L129)*
___
### type
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L130)*
<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: MethodAbi
## Properties
### constant
• **constant**: *boolean*
*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L94)*
___
### inputs
• **inputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L92)*
___
### name
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L91)*
___
### outputs
• **outputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L93)*
___
### payable
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L96)*
___
### stateMutability
• **stateMutability**: *[StateMutability](#statemutability)*
*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L95)*
___
### type
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L90)*
<hr />
# Class: InsufficientAssetLiquidityError
Error class representing insufficient asset liquidity
## Constructors
\+ **new InsufficientAssetLiquidityError**(`amountAvailableToFill`: `BigNumber`): *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)*
*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/errors.ts#L12)*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`amountAvailableToFill` | `BigNumber` | The amount availabe to fill (in base units) factoring in slippage |
**Returns:** *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)*
## Properties
### amountAvailableToFill
• **amountAvailableToFill**: *`BigNumber`*
*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/errors.ts#L12)*
The amount availabe to fill (in base units) factoring in slippage.
___
### message
• **message**: *string*
___
### name
• **name**: *string*
___
### `Optional` stack
• **stack**? : *undefined | string*
*Overrides void*
___
### `Static` Error
▪ **Error**: *`ErrorConstructor`*
<hr />
# Interface: TupleDataItem
## Properties
### components
• **components**: *[DataItem](#class-dataitem)[]*
*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L135)*
___
### name
• **name**: *string*
*Inherited from [DataItem](#interface-dataitem).[name](#name)*
*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L129)*
___
### type
• **type**: *string*
*Inherited from [DataItem](#interface-dataitem).[type](#type)*
*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L130)*
<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: AcceptedRejectedOrders
## Properties
### accepted
• **accepted**: *`SignedOrder`[]*
*Defined in [orderbook/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L15)*
___
### rejected
• **rejected**: *[RejectedOrder](#class-rejectedorder)[]*
*Defined in [orderbook/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L16)*
<hr />
# Interface: AddedRemovedOrders
## Properties
### added
• **added**: *`APIOrder`[]*
*Defined in [orderbook/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L6)*
___
### assetPairKey
• **assetPairKey**: *string*
*Defined in [orderbook/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L5)*
___
### removed
• **removed**: *`APIOrder`[]*
*Defined in [orderbook/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L7)*
<hr />
# Interface: MeshOrderProviderOpts
Constructor options for a Mesh Order Provider
## Properties
### websocketEndpoint
• **websocketEndpoint**: *string*
*Defined in [orderbook/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L52)*
___
### `Optional` wsOpts
• **wsOpts**? : *`WSOpts`*
*Defined in [orderbook/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L54)*
<hr />
# Interface: RejectedOrder
## Properties
### message
• **message**: *string*
*Defined in [orderbook/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L11)*
___
### order
• **order**: *`SignedOrder`*
*Defined in [orderbook/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L12)*
<hr />
# Interface: SRAPollingOrderProviderOpts
Constructor options for a SRA Polling Order Provider
## Properties
### httpEndpoint
• **httpEndpoint**: *string*
*Defined in [orderbook/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L38)*
___
### `Optional` networkId
• **networkId**? : *undefined | number*
*Defined in [orderbook/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L44)*
___
### `Optional` perPage
• **perPage**? : *undefined | number*
*Defined in [orderbook/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L42)*
___
### pollingIntervalMs
• **pollingIntervalMs**: *number*
*Defined in [orderbook/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L40)*
<hr />
# Interface: SRAWebsocketOrderProviderOpts
Constructor options for a SRA Websocket Order Provider
## Properties
### httpEndpoint
• **httpEndpoint**: *string*
*Defined in [orderbook/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L26)*
___
### `Optional` networkId
• **networkId**? : *undefined | number*
*Defined in [orderbook/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L30)*
___
### websocketEndpoint
• **websocketEndpoint**: *string*
*Defined in [orderbook/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L28)*
<hr />
# Interface: APIOrder
## Properties
### metaData
• **metaData**: *object*
*Defined in [types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L403)*
___
### order
• **order**: *[SignedOrder](#class-signedorder)*
*Defined in [types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L402)*
<hr />
# Interface: Asset
## Properties
### assetData
• **assetData**: *string*
*Defined in [types/src/index.ts:419](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L419)*
___
### maxAmount
• **maxAmount**: *`BigNumber`*
*Defined in [types/src/index.ts:421](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L421)*
___
### minAmount
• **minAmount**: *`BigNumber`*
*Defined in [types/src/index.ts:420](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L420)*
___
### precision
• **precision**: *number*
*Defined in [types/src/index.ts:422](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L422)*
<hr />
# Interface: AssetPairsItem
## Properties
### assetDataA
• **assetDataA**: *[Asset](#class-asset)*
*Defined in [types/src/index.ts:414](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L414)*
___
### assetDataB
• **assetDataB**: *[Asset](#class-asset)*
*Defined in [types/src/index.ts:415](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L415)*
<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 />
## Type aliases
<hr />
<hr />
<hr />
## Type aliases
### SwapQuote
Ƭ **SwapQuote**: *[MarketBuySwapQuote](#interface-marketbuyswapquote) | [MarketSellSwapQuote](#interface-marketsellswapquote)*
*Defined in [asset-swapper/src/types.ts:184](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L184)*
___
## Type aliases
### ConstructorStateMutability
Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"*
*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L84)*
___
### 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) |
___
### StateMutability
Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)*
*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L85)*
___
### 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 />
## Variables
### `Const` DEFAULT_TOKEN_PRECISION
• **DEFAULT_TOKEN_PRECISION**: *`18`* = 18
*Defined in [orderbook/src/order_provider/base_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_provider/base_order_provider.ts#L9)*
<hr />
<hr />
<hr />
<hr />
## Type aliases
Reference in New Issue View Git Blame Copy Permalink