diff --git a/packages/asset-swapper/docs/reference.mdx b/packages/asset-swapper/docs/reference.mdx index 7c7a4605c2..83b6566a60 100644 --- a/packages/asset-swapper/docs/reference.mdx +++ b/packages/asset-swapper/docs/reference.mdx @@ -14,7 +14,7 @@ \+ **new SwapQuoteConsumer**(`supportedProvider`: [SupportedProvider](#supportedprovider), `options`: `Partial`): *[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)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:31](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L31)* **Parameters:** @@ -31,7 +31,7 @@ Name | Type | Default | • **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)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:27](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L27)* ___ @@ -39,7 +39,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L26)* ## Methods @@ -49,7 +49,7 @@ ___ *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)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:81](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L81)* Given a SwapQuote and desired rate (in takerAsset), attempt to execute the swap. @@ -70,7 +70,7 @@ ___ *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)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:53](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L53)* Given a SwapQuote, returns 'CalldataInfo' for a 0x exchange call. See type definition of CalldataInfo for more information. @@ -85,13 +85,30 @@ Name | Type | Default | Description | ___ +### getOptimalExtensionContractTypeAsync + +▸ **getOptimalExtensionContractTypeAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* + +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:90](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L90)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`quote` | [SwapQuote](#swapquote) | - | +`opts` | `Partial` | {} | + +**Returns:** *`Promise`* + +___ + ### getSmartContractParamsOrThrowAsync ▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* *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)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:67](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L67)* Given a SwapQuote, returns 'SmartContractParamsInfo' for a 0x exchange call. See type definition of SmartContractParamsInfo for more information. @@ -115,7 +132,7 @@ Name | Type | Default | Description | \+ **new SwapQuoter**(`supportedProvider`: [SupportedProvider](#supportedprovider), `orderbook`: `Orderbook`, `options`: `Partial`): *[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)* +*Defined in [asset-swapper/src/swap_quoter.ts:125](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L125)* Instantiates a new SwapQuoter instance @@ -137,7 +154,7 @@ An instance of SwapQuoter • **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)* +*Defined in [asset-swapper/src/swap_quoter.ts:29](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L29)* ___ @@ -145,7 +162,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/swap_quoter.ts:28](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L28)* ___ @@ -153,7 +170,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/swap_quoter.ts:27](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L27)* ## Methods @@ -161,7 +178,7 @@ ___ ▸ **destroyAsync**(): *`Promise`* -*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)* +*Defined in [asset-swapper/src/swap_quoter.ts:390](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L390)* Destroys any subscriptions or connections. @@ -173,7 +190,7 @@ ___ ▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* -*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)* +*Defined in [asset-swapper/src/swap_quoter.ts:308](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -193,7 +210,7 @@ ___ ▸ **getAvailableTakerAssetDatasAsync**(`makerAssetData`: string): *`Promise`* -*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)* +*Defined in [asset-swapper/src/swap_quoter.ts:293](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -213,7 +230,7 @@ ___ ▸ **getLiquidityForMakerTakerAssetDataPairAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* -*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)* +*Defined in [asset-swapper/src/swap_quoter.ts:267](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L267)* Returns information about available liquidity for an asset Does not factor in slippage or fees @@ -235,7 +252,7 @@ ___ ▸ **getMarketBuySwapQuoteAsync**(`makerTokenAddress`: string, `takerTokenAddress`: string, `makerAssetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*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)* +*Defined in [asset-swapper/src/swap_quoter.ts:209](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -259,7 +276,7 @@ ___ ▸ **getMarketBuySwapQuoteForAssetDataAsync**(`makerAssetData`: string, `takerAssetData`: string, `makerAssetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*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)* +*Defined in [asset-swapper/src/swap_quoter.ts:184](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -283,7 +300,7 @@ ___ ▸ **getMarketSellSwapQuoteAsync**(`makerTokenAddress`: string, `takerTokenAddress`: string, `takerAssetSellAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*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)* +*Defined in [asset-swapper/src/swap_quoter.ts:239](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -307,7 +324,7 @@ ___ ▸ **getMarketSellSwapQuoteForAssetDataAsync**(`makerAssetData`: string, `takerAssetData`: string, `takerAssetSellAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*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)* +*Defined in [asset-swapper/src/swap_quoter.ts:158](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -331,7 +348,7 @@ ___ ▸ **getOrdersAndFillableAmountsAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* -*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)* +*Defined in [asset-swapper/src/swap_quoter.ts:340](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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 @@ -350,7 +367,7 @@ ___ ▸ **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)* +*Defined in [asset-swapper/src/swap_quoter.ts:371](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -369,7 +386,7 @@ ___ ▸ **isTakerMakerAssetDataPairAvailableAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* -*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)* +*Defined in [asset-swapper/src/swap_quoter.ts:323](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L323)* Validates the taker + maker asset pair is available from the order provider provided to `SwapQuote`. @@ -390,7 +407,7 @@ ___ ▸ **getSwapQuoterForMeshEndpoint**(`supportedProvider`: [SupportedProvider](#supportedprovider), `meshEndpoint`: string, `options`: `Partial`): *[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)* +*Defined in [asset-swapper/src/swap_quoter.ts:112](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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 @@ -412,7 +429,7 @@ ___ ▸ **getSwapQuoterForProvidedOrders**(`supportedProvider`: [SupportedProvider](#supportedprovider), `orders`: `SignedOrder`[], `options`: `Partial`): *[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)* +*Defined in [asset-swapper/src/swap_quoter.ts:40](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/swap_quoter.ts#L40)* Instantiates a new SwapQuoter instance given existing liquidity in the form of orders and feeOrders. @@ -434,7 +451,7 @@ ___ ▸ **getSwapQuoterForStandardRelayerAPIUrl**(`supportedProvider`: [SupportedProvider](#supportedprovider), `sraApiUrl`: string, `options`: `Partial`): *[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)* +*Defined in [asset-swapper/src/swap_quoter.ts:60](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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 @@ -456,7 +473,7 @@ ___ ▸ **getSwapQuoterForStandardRelayerAPIWebsocket**(`supportedProvider`: [SupportedProvider](#supportedprovider), `sraApiUrl`: string, `sraWebsocketAPIUrl`: string, `options`: `Partial`): *[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)* +*Defined in [asset-swapper/src/swap_quoter.ts:87](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -485,7 +502,7 @@ An instance of SwapQuoter \+ **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)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:12](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_provider/base_order_provider.ts#L12)* **Parameters:** @@ -501,7 +518,7 @@ Name | Type | • **_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)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:12](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_provider/base_order_provider.ts#L12)* ## Methods @@ -509,7 +526,7 @@ Name | Type | ▸ **addOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* -*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)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:27](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_provider/base_order_provider.ts#L27)* **Parameters:** @@ -525,7 +542,7 @@ ___ ▸ **createSubscriptionForAssetPairAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* -*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)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_provider/base_order_provider.ts#L18)* **Parameters:** @@ -542,7 +559,7 @@ ___ ▸ **destroyAsync**(): *`Promise`* -*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)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:25](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_provider/base_order_provider.ts#L25)* **Returns:** *`Promise`* @@ -552,7 +569,7 @@ ___ ▸ **getAvailableAssetDatasAsync**(): *`Promise`* -*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)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:23](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_provider/base_order_provider.ts#L23)* **Returns:** *`Promise`* @@ -567,7 +584,7 @@ ___ \+ **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)* +*Defined in [orderbook/src/order_set.ts:6](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_set.ts#L6)* **Parameters:** @@ -583,7 +600,7 @@ Name | Type | Default | ▸ **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)* +*Defined in [orderbook/src/order_set.ts:19](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_set.ts#L19)* **Parameters:** @@ -599,7 +616,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_set.ts:25](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_set.ts#L25)* **Parameters:** @@ -615,7 +632,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_set.ts:57](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_set.ts#L57)* **Parameters:** @@ -631,7 +648,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_set.ts:61](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_set.ts#L61)* **Parameters:** @@ -647,7 +664,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_set.ts:35](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_set.ts#L35)* **Parameters:** @@ -663,7 +680,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_set.ts:31](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_set.ts#L31)* **Parameters:** @@ -679,7 +696,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_set.ts:15](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_set.ts#L15)* **Returns:** *number* @@ -689,7 +706,7 @@ ___ ▸ **values**(): *`IterableIterator`* -*Defined in [orderbook/src/order_set.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_set.ts#L53)* +*Defined in [orderbook/src/order_set.ts:53](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_set.ts#L53)* **Returns:** *`IterableIterator`* @@ -704,7 +721,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_store.ts#L19)* **Parameters:** @@ -720,7 +737,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_store.ts:15](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_store.ts#L15)* **Parameters:** @@ -737,7 +754,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_store.ts:34](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_store.ts#L34)* **Parameters:** @@ -753,7 +770,7 @@ ___ ▸ **keys**(): *`IterableIterator`* -*Defined in [orderbook/src/order_store.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/order_store.ts#L40)* +*Defined in [orderbook/src/order_store.ts:40](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_store.ts#L40)* **Returns:** *`IterableIterator`* @@ -763,7 +780,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_store.ts:28](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_store.ts#L28)* **Parameters:** @@ -779,7 +796,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_store.ts:37](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_store.ts#L37)* **Parameters:** @@ -795,7 +812,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_store.ts#L12)* **Parameters:** @@ -811,7 +828,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/order_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_store.ts#L9)* **Parameters:** @@ -833,7 +850,7 @@ Name | Type | \+ **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)* +*Defined in [orderbook/src/orderbook.ts:55](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/orderbook.ts#L55)* Creates an Orderbook with the order provider. All order updates are stored in the `OrderStore`. @@ -853,7 +870,7 @@ Name | Type | Description | ▸ **addOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* -*Defined in [orderbook/src/orderbook.ts:98](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L98)* +*Defined in [orderbook/src/orderbook.ts:98](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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 @@ -872,7 +889,7 @@ ___ ▸ **destroyAsync**(): *`Promise`* -*Defined in [orderbook/src/orderbook.ts:104](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L104)* +*Defined in [orderbook/src/orderbook.ts:104](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/orderbook.ts#L104)* Destroys any subscriptions or connections. @@ -884,7 +901,7 @@ ___ ▸ **getAvailableAssetDatasAsync**(): *`Promise`* -*Defined in [orderbook/src/orderbook.ts:90](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L90)* +*Defined in [orderbook/src/orderbook.ts:90](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/orderbook.ts#L90)* Returns all of the Available Asset Pairs for the provided Order Provider. @@ -896,7 +913,7 @@ ___ ▸ **getOrdersAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* -*Defined in [orderbook/src/orderbook.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/orderbook.ts#L75)* +*Defined in [orderbook/src/orderbook.ts:75](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/orderbook.ts#L75)* Returns all orders where the order.makerAssetData == makerAssetData and order.takerAssetData == takerAssetData. This pair is then subscribed to @@ -919,7 +936,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/orderbook.ts:52](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -938,7 +955,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/orderbook.ts:43](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/orderbook.ts#L43)* Creates an Orderbook with SRA Polling Provider. This Provider simply polls every interval. @@ -956,7 +973,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/orderbook.ts:26](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -975,7 +992,7 @@ ___ ▸ **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)* +*Defined in [orderbook/src/orderbook.ts:35](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -990,26 +1007,26 @@ Name | Type | Description |
-# Enumeration: ConsumerType +# Enumeration: ExtensionContractType 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)* +*Defined in [asset-swapper/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L90)* + +___ + +### None + +• **None**: = "NONE" + +*Defined in [asset-swapper/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L91)*
@@ -1026,7 +1043,7 @@ Possible error messages thrown by an SwapQuoter instance or associated static me • **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)* +*Defined in [asset-swapper/src/types.ts:305](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L305)* ___ @@ -1034,7 +1051,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:302](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L302)* ___ @@ -1042,7 +1059,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:303](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L303)* ___ @@ -1050,7 +1067,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:304](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L304)* ___ @@ -1058,7 +1075,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:299](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L299)* ___ @@ -1066,7 +1083,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:300](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L300)* ___ @@ -1074,7 +1091,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:301](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L301)*
@@ -1125,7 +1142,7 @@ ethAmount: If provided, the eth amount in wei to send with the smart contract ca • **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)* +*Defined in [asset-swapper/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L39)* ___ @@ -1133,7 +1150,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L42)* ___ @@ -1141,7 +1158,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L40)* ___ @@ -1149,7 +1166,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:41](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L41)*
@@ -1174,7 +1191,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L181)* ___ @@ -1184,7 +1201,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L179)* ___ @@ -1194,7 +1211,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L180)* ___ @@ -1204,7 +1221,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L169)* ___ @@ -1214,7 +1231,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L170)* ___ @@ -1224,7 +1241,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L168)*
@@ -1241,7 +1258,7 @@ ethAmount: The amount of eth (in Wei) sent to the forwarder contract. • **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)* +*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L181)* ___ @@ -1249,7 +1266,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L179)* ___ @@ -1257,7 +1274,28 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L180)* + +
+ +# Interface: GetExtensionContractTypeOpts + + +## Properties + +### `Optional` ethAmount + +• **ethAmount**? : *`BigNumber`* + +*Defined in [asset-swapper/src/types.ts:188](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L188)* + +___ + +### `Optional` takerAddress + +• **takerAddress**? : *undefined | string* + +*Defined in [asset-swapper/src/types.ts:187](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L187)*
@@ -1272,7 +1310,7 @@ Represents available liquidity for a given assetData • **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)* +*Defined in [asset-swapper/src/types.ts:321](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L321)* ___ @@ -1280,7 +1318,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:322](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L322)*
@@ -1298,7 +1336,7 @@ type: Specified MarketOperation the SwapQuote is provided for *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)* +*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L219)* ___ @@ -1308,7 +1346,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L218)* ___ @@ -1318,7 +1356,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L216)* ___ @@ -1326,7 +1364,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:237](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L237)* ___ @@ -1336,7 +1374,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L217)* ___ @@ -1346,7 +1384,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L215)* ___ @@ -1354,7 +1392,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:238](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L238)* ___ @@ -1364,7 +1402,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L220)*
@@ -1379,7 +1417,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L219)* ___ @@ -1389,7 +1427,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L218)* ___ @@ -1399,7 +1437,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:242](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L242)* ___ @@ -1409,7 +1447,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L216)* ___ @@ -1419,7 +1457,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:237](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L237)* ___ @@ -1429,7 +1467,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L217)* ___ @@ -1439,7 +1477,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L215)* ___ @@ -1449,7 +1487,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:238](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L238)* ___ @@ -1459,7 +1497,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L220)*
@@ -1477,7 +1515,7 @@ type: Specified MarketOperation the SwapQuote is provided for *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)* +*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L219)* ___ @@ -1487,7 +1525,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L218)* ___ @@ -1497,7 +1535,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L216)* ___ @@ -1507,7 +1545,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L217)* ___ @@ -1517,7 +1555,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L215)* ___ @@ -1525,7 +1563,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:228](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L228)* ___ @@ -1533,7 +1571,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:229](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L229)* ___ @@ -1543,7 +1581,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L220)*
@@ -1558,7 +1596,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L219)* ___ @@ -1568,7 +1606,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L218)* ___ @@ -1578,7 +1616,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:242](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L242)* ___ @@ -1588,7 +1626,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L216)* ___ @@ -1598,7 +1636,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L217)* ___ @@ -1608,7 +1646,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L215)* ___ @@ -1618,7 +1656,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:228](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L228)* ___ @@ -1628,7 +1666,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:229](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L229)* ___ @@ -1638,7 +1676,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L220)*
@@ -1671,7 +1709,7 @@ methodAbi: The ABI of the smart contract method to call with params. • **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)* +*Defined in [asset-swapper/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L55)* ___ @@ -1679,7 +1717,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L56)* ___ @@ -1687,7 +1725,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L53)* ___ @@ -1695,7 +1733,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L54)*
@@ -1724,7 +1762,7 @@ executeSwapQuoteOrThrowAsync: Executes a web3 transaction to swap for tokens wit ▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* -*Defined in [asset-swapper/src/types.ts:147](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L147)* +*Defined in [asset-swapper/src/types.ts:147](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L147)* **Parameters:** @@ -1741,7 +1779,7 @@ ___ ▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* -*Defined in [asset-swapper/src/types.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L142)* +*Defined in [asset-swapper/src/types.ts:142](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L142)* **Parameters:** @@ -1758,7 +1796,7 @@ ___ ▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* -*Defined in [asset-swapper/src/types.ts:143](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L143)* +*Defined in [asset-swapper/src/types.ts:143](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L143)* **Parameters:** @@ -1782,7 +1820,7 @@ networkId: The networkId that the desired orders should be for. • **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)* +*Defined in [asset-swapper/src/types.ts:154](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L154)*
@@ -1801,7 +1839,7 @@ Represents the options for executing a swap quote with SwapQuoteConsumer *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)* +*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L181)* ___ @@ -1813,7 +1851,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L179)* ___ @@ -1825,7 +1863,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L180)* ___ @@ -1835,7 +1873,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L169)* ___ @@ -1845,7 +1883,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L170)* ___ @@ -1853,21 +1891,19 @@ ___ • **takerAddress**? : *undefined | string* -*Inherited from [SwapQuoteGetOutputOpts](#interface-swapquotegetoutputopts).[takerAddress](#optional-takeraddress)* +*Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[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)* +*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L168)* ___ -### `Optional` useConsumerType +### useExtensionContract -• **useConsumerType**? : *[ConsumerType](#enumeration-consumertype)* +• **useExtensionContract**: *[ExtensionContractType](#enumeration-extensioncontracttype)* -*Inherited from [SwapQuoteGetOutputOpts](#interface-swapquotegetoutputopts).[useConsumerType](#optional-useconsumertype)* +*Inherited from [SwapQuoteGetOutputOpts](#interface-swapquotegetoutputopts).[useExtensionContract](#useextensioncontract)* -*Defined in [asset-swapper/src/types.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/asset-swapper/src/types.ts#L192)* +*Defined in [asset-swapper/src/types.ts:196](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L196)*
@@ -1884,7 +1920,7 @@ gasPrice: Gas price in Wei to use for a transaction • **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)* +*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L169)* ___ @@ -1892,7 +1928,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L170)* ___ @@ -1900,7 +1936,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L168)*
@@ -1918,7 +1954,7 @@ useConsumerType: If provided, defaults the SwapQuoteConsumer to create output co *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)* +*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L181)* ___ @@ -1928,7 +1964,7 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L179)* ___ @@ -1938,23 +1974,15 @@ ___ *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)* +*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L180)* ___ -### `Optional` takerAddress +### useExtensionContract -• **takerAddress**? : *undefined | string* +• **useExtensionContract**: *[ExtensionContractType](#enumeration-extensioncontracttype)* -*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)* +*Defined in [asset-swapper/src/types.ts:196](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L196)*
@@ -1974,7 +2002,7 @@ Represents the options provided to a generic SwapQuoteConsumer • **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)* +*Defined in [asset-swapper/src/types.ts:258](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L258)* ___ @@ -1982,7 +2010,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:261](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L261)* ___ @@ -1990,7 +2018,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:260](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L260)* ___ @@ -1998,7 +2026,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:259](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L259)*
@@ -2014,7 +2042,7 @@ slippagePercentage: The percentage buffer to add to account for slippage. Affect • **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)* +*Defined in [asset-swapper/src/types.ts:269](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L269)* ___ @@ -2022,7 +2050,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:270](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L270)*
@@ -2039,7 +2067,7 @@ expiryBufferMs: The number of seconds to add when calculating whether an order i • **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)* +*Defined in [asset-swapper/src/types.ts:281](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L281)* ___ @@ -2047,7 +2075,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:279](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L279)* ___ @@ -2055,7 +2083,7 @@ ___ • **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)* +*Defined in [asset-swapper/src/types.ts:280](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L280)*
@@ -2098,7 +2126,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L131)* ___ @@ -2106,7 +2134,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L129)* ___ @@ -2114,7 +2142,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L130)*
@@ -2133,7 +2161,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -2141,7 +2169,7 @@ ___ ▸ **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)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -2165,7 +2193,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -2199,7 +2227,7 @@ Name | Type | ▸ **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)* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -2223,7 +2251,7 @@ Name | Type | • **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)* +*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L324)* ___ @@ -2231,7 +2259,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L325)* ___ @@ -2239,7 +2267,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L323)* ___ @@ -2247,7 +2275,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L322)*
@@ -2260,7 +2288,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L330)* ___ @@ -2268,7 +2296,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L329)*
@@ -2281,7 +2309,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L337)* ___ @@ -2289,7 +2317,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L335)* ___ @@ -2297,7 +2325,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L336)* ___ @@ -2305,7 +2333,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L334)*
@@ -2324,7 +2352,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L94)* ___ @@ -2332,7 +2360,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L92)* ___ @@ -2340,7 +2368,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L91)* ___ @@ -2348,7 +2376,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L93)* ___ @@ -2356,7 +2384,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L96)* ___ @@ -2364,7 +2392,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L95)* ___ @@ -2372,7 +2400,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L90)*
@@ -2397,8 +2425,6 @@ ___ - - @@ -2413,7 +2439,7 @@ Error class representing insufficient asset liquidity \+ **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)* +*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/errors.ts#L12)* **Parameters:** @@ -2429,7 +2455,7 @@ Name | Type | Description | • **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)* +*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/errors.ts#L12)* The amount availabe to fill (in base units) factoring in slippage. @@ -2475,6 +2501,8 @@ ___
+ + # Interface: TupleDataItem @@ -2486,7 +2514,7 @@ ___ *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)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L135)* ___ @@ -2496,7 +2524,7 @@ ___ *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)* +*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L129)* ___ @@ -2506,7 +2534,7 @@ ___ *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)* +*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L130)*
@@ -2527,7 +2555,7 @@ This interface allowed sending synchonous requests, support for which was later ▸ **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)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -2543,7 +2571,7 @@ ___ ▸ **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)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -2569,7 +2597,7 @@ before the first attempts to conform to EIP1193 ▸ **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)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -2595,7 +2623,7 @@ however it does not conform entirely. ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -2621,7 +2649,7 @@ add here • **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)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L31)* ___ @@ -2629,7 +2657,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L32)* ___ @@ -2637,7 +2665,7 @@ ___ • **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)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -2645,7 +2673,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -2655,7 +2683,7 @@ ___ ▸ **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)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -2672,7 +2700,7 @@ ___ ▸ **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)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -2687,7 +2715,7 @@ ___ • **accepted**: *`SignedOrder`[]* -*Defined in [orderbook/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L15)* +*Defined in [orderbook/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L15)* ___ @@ -2695,7 +2723,7 @@ ___ • **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)* +*Defined in [orderbook/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L16)*
@@ -2708,7 +2736,7 @@ ___ • **added**: *`APIOrder`[]* -*Defined in [orderbook/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L6)* +*Defined in [orderbook/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L6)* ___ @@ -2716,7 +2744,7 @@ ___ • **assetPairKey**: *string* -*Defined in [orderbook/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L5)* +*Defined in [orderbook/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L5)* ___ @@ -2724,7 +2752,7 @@ ___ • **removed**: *`APIOrder`[]* -*Defined in [orderbook/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L7)* +*Defined in [orderbook/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L7)*
@@ -2739,7 +2767,7 @@ Constructor options for a Mesh Order Provider • **websocketEndpoint**: *string* -*Defined in [orderbook/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L52)* +*Defined in [orderbook/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L52)* ___ @@ -2747,7 +2775,7 @@ ___ • **wsOpts**? : *`WSOpts`* -*Defined in [orderbook/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L54)* +*Defined in [orderbook/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L54)*
@@ -2760,7 +2788,7 @@ ___ • **message**: *string* -*Defined in [orderbook/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L11)* +*Defined in [orderbook/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L11)* ___ @@ -2768,7 +2796,7 @@ ___ • **order**: *`SignedOrder`* -*Defined in [orderbook/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L12)* +*Defined in [orderbook/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L12)*
@@ -2783,7 +2811,7 @@ Constructor options for a SRA Polling Order Provider • **httpEndpoint**: *string* -*Defined in [orderbook/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L38)* +*Defined in [orderbook/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L38)* ___ @@ -2791,7 +2819,7 @@ ___ • **networkId**? : *undefined | number* -*Defined in [orderbook/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L44)* +*Defined in [orderbook/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L44)* ___ @@ -2799,7 +2827,7 @@ ___ • **perPage**? : *undefined | number* -*Defined in [orderbook/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L42)* +*Defined in [orderbook/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L42)* ___ @@ -2807,7 +2835,7 @@ ___ • **pollingIntervalMs**: *number* -*Defined in [orderbook/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L40)* +*Defined in [orderbook/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L40)*
@@ -2822,7 +2850,7 @@ Constructor options for a SRA Websocket Order Provider • **httpEndpoint**: *string* -*Defined in [orderbook/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L26)* +*Defined in [orderbook/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L26)* ___ @@ -2830,7 +2858,7 @@ ___ • **networkId**? : *undefined | number* -*Defined in [orderbook/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L30)* +*Defined in [orderbook/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L30)* ___ @@ -2838,7 +2866,7 @@ ___ • **websocketEndpoint**: *string* -*Defined in [orderbook/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/orderbook/src/types.ts#L28)* +*Defined in [orderbook/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/types.ts#L28)*
@@ -2851,7 +2879,7 @@ ___ • **metaData**: *object* -*Defined in [types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L403)* +*Defined in [types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L403)* ___ @@ -2859,7 +2887,7 @@ ___ • **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)* +*Defined in [types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L402)*
@@ -2874,7 +2902,7 @@ ___ • **assetData**: *string* -*Defined in [types/src/index.ts:419](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L419)* +*Defined in [types/src/index.ts:419](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L419)* ___ @@ -2882,7 +2910,7 @@ ___ • **maxAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:421](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L421)* +*Defined in [types/src/index.ts:421](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L421)* ___ @@ -2890,7 +2918,7 @@ ___ • **minAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:420](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L420)* +*Defined in [types/src/index.ts:420](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L420)* ___ @@ -2898,7 +2926,7 @@ ___ • **precision**: *number* -*Defined in [types/src/index.ts:422](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L422)* +*Defined in [types/src/index.ts:422](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L422)*
@@ -2911,7 +2939,7 @@ ___ • **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)* +*Defined in [types/src/index.ts:414](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L414)* ___ @@ -2919,7 +2947,7 @@ ___ • **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)* +*Defined in [types/src/index.ts:415](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L415)*
@@ -3020,7 +3048,7 @@ ___ *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)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L20)* ___ @@ -3030,7 +3058,7 @@ ___ *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)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L22)* ___ @@ -3040,7 +3068,7 @@ ___ *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)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L21)* ___ @@ -3050,7 +3078,7 @@ ___ *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)* +*Defined in [types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L11)* ___ @@ -3060,7 +3088,7 @@ ___ *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)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L15)* ___ @@ -3070,7 +3098,7 @@ ___ *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)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L17)* ___ @@ -3080,7 +3108,7 @@ ___ *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)* +*Defined in [types/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L13)* ___ @@ -3090,7 +3118,7 @@ ___ *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)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L19)* ___ @@ -3100,7 +3128,7 @@ ___ *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)* +*Defined in [types/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L10)* ___ @@ -3108,7 +3136,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L41)* +*Defined in [types/src/index.ts:41](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L41)* ___ @@ -3118,7 +3146,7 @@ ___ *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)* +*Defined in [types/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L12)* ___ @@ -3128,7 +3156,7 @@ ___ *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)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L16)* ___ @@ -3138,7 +3166,7 @@ ___ *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)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L18)* ___ @@ -3148,7 +3176,7 @@ ___ *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)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/types/src/index.ts#L14)*
@@ -3250,7 +3278,7 @@ ___ Ƭ **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)* +*Defined in [asset-swapper/src/types.ts:184](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/asset-swapper/src/types.ts#L184)* ___ @@ -3269,7 +3297,7 @@ ___ Ƭ **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)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L84)* ___ @@ -3281,7 +3309,7 @@ ___ Ƭ **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)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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 @@ -3298,7 +3326,7 @@ ___ Ƭ **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)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -3325,7 +3353,7 @@ ___ Ƭ **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)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L85)* ___ @@ -3333,7 +3361,7 @@ ___ Ƭ **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)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/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. @@ -3348,7 +3376,7 @@ ___ Ƭ **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)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/ethereum-types/src/index.ts#L11)*
@@ -3361,7 +3389,7 @@ ___ • **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)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/11d3d6804/packages/orderbook/src/order_provider/base_order_provider.ts#L9)*
diff --git a/packages/asset-swapper/src/swap_quoter.ts b/packages/asset-swapper/src/swap_quoter.ts index 075a548939..ac4cb14d16 100644 --- a/packages/asset-swapper/src/swap_quoter.ts +++ b/packages/asset-swapper/src/swap_quoter.ts @@ -422,7 +422,8 @@ export class SwapQuoter { const isMakerAssetZrxToken = makerAssetData === zrxTokenAssetData; // get the relevant orders for the makerAsset const ordersAndFillableAmounts = await this.getOrdersAndFillableAmountsAsync(makerAssetData, takerAssetData); - const isRequestingFeeOrders = !shouldDisableRequestingFeeOrders || (!isMakerAssetZrxToken && utils.isFeeOrdersRequiredToFillOrders(ordersAndFillableAmounts)); + const doesOrdersRequireFeeOrders = (!isMakerAssetZrxToken && utils.isFeeOrdersRequiredToFillOrders(ordersAndFillableAmounts)); + const isRequestingFeeOrders = !shouldDisableRequestingFeeOrders && doesOrdersRequireFeeOrders; let feeOrdersAndFillableAmounts = constants.EMPTY_ORDERS_AND_FILLABLE_AMOUNTS; if (isRequestingFeeOrders) { feeOrdersAndFillableAmounts = await this.getOrdersAndFillableAmountsAsync(zrxTokenAssetData, takerAssetData); @@ -436,6 +437,14 @@ export class SwapQuoter { ); } + if (isRequestingFeeOrders && feeOrdersAndFillableAmounts.orders.length === 0) { + throw new Error( + `${ + SwapQuoterError.FeeAssetUnavailable + }: For makerAssetdata ${makerAssetData} and takerAssetdata ${takerAssetData}`, + ); + } + let swapQuote: SwapQuote; if (marketOperation === MarketOperation.Buy) { diff --git a/packages/asset-swapper/src/types.ts b/packages/asset-swapper/src/types.ts index c77e48ad8b..112b353d0e 100644 --- a/packages/asset-swapper/src/types.ts +++ b/packages/asset-swapper/src/types.ts @@ -299,6 +299,7 @@ export enum SwapQuoterError { InsufficientZrxLiquidity = 'INSUFFICIENT_ZRX_LIQUIDITY', InvalidOrderProviderResponse = 'INVALID_ORDER_PROVIDER_RESPONSE', AssetUnavailable = 'ASSET_UNAVAILABLE', + FeeAssetUnavailable = 'FEE_ASSET_UNAVAILABLE', } /** diff --git a/packages/asset-swapper/src/utils/utils.ts b/packages/asset-swapper/src/utils/utils.ts index 248445275c..7fef225fba 100644 --- a/packages/asset-swapper/src/utils/utils.ts +++ b/packages/asset-swapper/src/utils/utils.ts @@ -1,3 +1,4 @@ +import { SignedOrder } from '@0x/types'; import { BigNumber } from '@0x/utils'; import { Web3Wrapper } from '@0x/web3-wrapper'; import { AbiDefinition, ContractAbi, MethodAbi } from 'ethereum-types'; @@ -5,7 +6,6 @@ import * as _ from 'lodash'; import { constants } from '../constants'; import { OrdersAndFillableAmounts } from '../types'; -import { SignedOrder } from '@0x/types'; // tslint:disable:no-unnecessary-type-assertion export const utils = { @@ -31,8 +31,8 @@ export const utils = { const { orders, remainingFillableMakerAssetAmounts } = ordersAndFillableAmounts; return _.some(orders, (order: SignedOrder, index: number): boolean => { const remainingFillableMakerAssetAmount = remainingFillableMakerAssetAmounts[index]; - // If makerFee is a non zero value and order is still fillable, fee orders are required - return !order.makerFee.isZero() && !remainingFillableMakerAssetAmount.isZero(); + // If takerFee is a non zero value and order is still fillable, fee orders are required + return !order.takerFee.isZero() && !remainingFillableMakerAssetAmount.isZero(); }); }, }; diff --git a/packages/asset-swapper/test/utils_test.ts b/packages/asset-swapper/test/utils_test.ts new file mode 100644 index 0000000000..f60911379f --- /dev/null +++ b/packages/asset-swapper/test/utils_test.ts @@ -0,0 +1,78 @@ +import { orderFactory } from '@0x/order-utils/lib/src/order_factory'; +import { SignedOrder } from '@0x/types'; +import { BigNumber } from '@0x/utils'; +import { Web3Wrapper } from '@0x/web3-wrapper'; +import * as chai from 'chai'; +import 'mocha'; + +import { constants } from '../src/constants'; +import { utils } from '../src/utils/utils'; + +import { chaiSetup } from './utils/chai_setup'; + +chaiSetup.configure(); +const expect = chai.expect; + +const TOKEN_DECIMALS = 18; +const WETH_DECIMALS = constants.ETHER_TOKEN_DECIMALS; + +const baseUnitAmount = (unitAmount: number, decimals = TOKEN_DECIMALS): BigNumber => { + return Web3Wrapper.toBaseUnitAmount(new BigNumber(unitAmount), decimals); +}; + +// tslint:disable:custom-no-magic-numbers +describe('utils', () => { + // orders + const sellTwoTokensFor1Weth: SignedOrder = orderFactory.createSignedOrderFromPartial({ + makerAssetAmount: baseUnitAmount(2), + takerAssetAmount: baseUnitAmount(1, WETH_DECIMALS), + }); + const sellTenTokensFor10Weth: SignedOrder = orderFactory.createSignedOrderFromPartial({ + makerAssetAmount: baseUnitAmount(10), + takerAssetAmount: baseUnitAmount(10, WETH_DECIMALS), + }); + const sellTwoTokensFor1WethWithTwoTokenFee: SignedOrder = orderFactory.createSignedOrderFromPartial({ + makerAssetAmount: baseUnitAmount(2), + takerAssetAmount: baseUnitAmount(1, WETH_DECIMALS), + takerFee: baseUnitAmount(2), + }); + const sellTenTokensFor1WethWithFourTokenFee: SignedOrder = orderFactory.createSignedOrderFromPartial({ + makerAssetAmount: baseUnitAmount(2), + takerAssetAmount: baseUnitAmount(1, WETH_DECIMALS), + takerFee: baseUnitAmount(4), + }); + describe('isFeeOrdersRequiredToFillOrders', async () => { + it('should return true if ordersAndFillableAmounts is completed unfilled and has fees', () => { + const ordersAndFillableAmounts = { + orders: [sellTwoTokensFor1WethWithTwoTokenFee, sellTenTokensFor1WethWithFourTokenFee], + remainingFillableMakerAssetAmounts: [baseUnitAmount(1), baseUnitAmount(10)], + }; + const isFeeOrdersRequired = utils.isFeeOrdersRequiredToFillOrders(ordersAndFillableAmounts); + expect(isFeeOrdersRequired).to.equal(true); + }); + it('should return true if ordersAndFillableAmounts is partially unfilled and has fees', () => { + const ordersAndFillableAmounts = { + orders: [sellTwoTokensFor1WethWithTwoTokenFee, sellTenTokensFor1WethWithFourTokenFee], + remainingFillableMakerAssetAmounts: [baseUnitAmount(0), baseUnitAmount(5)], + }; + const isFeeOrdersRequired = utils.isFeeOrdersRequiredToFillOrders(ordersAndFillableAmounts); + expect(isFeeOrdersRequired).to.equal(true); + }); + it('should return false if ordersAndFillableAmounts is completed filled and has fees', () => { + const ordersAndFillableAmounts = { + orders: [sellTwoTokensFor1WethWithTwoTokenFee, sellTenTokensFor1WethWithFourTokenFee], + remainingFillableMakerAssetAmounts: [baseUnitAmount(0), baseUnitAmount(0)], + }; + const isFeeOrdersRequired = utils.isFeeOrdersRequiredToFillOrders(ordersAndFillableAmounts); + expect(isFeeOrdersRequired).to.equal(false); + }); + it('should return false if ordersAndFillableAmounts is completely unfilled and doesn\'t have fees', () => { + const ordersAndFillableAmounts = { + orders: [sellTwoTokensFor1Weth, sellTenTokensFor10Weth], + remainingFillableMakerAssetAmounts: [baseUnitAmount(1), baseUnitAmount(10)], + }; + const isFeeOrdersRequired = utils.isFeeOrdersRequiredToFillOrders(ordersAndFillableAmounts); + expect(isFeeOrdersRequired).to.equal(false); + }); + }); +});