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

Final docs gen

Browse Source
This commit is contained in:
fabioberger
2019-08-26 07:11:29 +02:00
parent 6474a4e08c
commit e452cfcd59
14 changed files with 1604 additions and 1604 deletions
Download Patch File Download Diff File Expand all files Collapse all files

132
packages/asset-buyer/docs/reference.mdx
View File

@@ -11,7 +11,7 @@
\+ **new AssetBuyer**(`supportedProvider`: `SupportedProvider`, `orderProvider`: [OrderProvider](#interface-orderprovider), `options`: `Partial<AssetBuyerOpts>`): *[AssetBuyer](#class-assetbuyer)*
*Defined in [asset_buyer.ts:83](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L83)*
*Defined in [asset_buyer.ts:83](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L83)*
Instantiates a new AssetBuyer instance
@@ -33,7 +33,7 @@ An instance of AssetBuyer
• **expiryBufferSeconds**: *number*
*Defined in [asset_buyer.ts:40](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L40)*
*Defined in [asset_buyer.ts:40](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L40)*
___
@@ -41,7 +41,7 @@ ___
• **networkId**: *number*
*Defined in [asset_buyer.ts:38](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L38)*
*Defined in [asset_buyer.ts:38](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L38)*
___
@@ -49,7 +49,7 @@ ___
• **orderProvider**: *[OrderProvider](#interface-orderprovider)*
*Defined in [asset_buyer.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L37)*
*Defined in [asset_buyer.ts:37](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L37)*
___
@@ -57,7 +57,7 @@ ___
• **orderRefreshIntervalMs**: *number*
*Defined in [asset_buyer.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L39)*
*Defined in [asset_buyer.ts:39](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L39)*
___
@@ -65,7 +65,7 @@ ___
• **provider**: *`ZeroExProvider`*
*Defined in [asset_buyer.ts:36](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L36)*
*Defined in [asset_buyer.ts:36](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L36)*
### Methods
@@ -73,7 +73,7 @@ ___
▸ **executeBuyQuoteAsync**(`buyQuote`: [BuyQuote](#interface-buyquote), `options`: `Partial<BuyQuoteExecutionOpts>`): *`Promise<string>`*
*Defined in [asset_buyer.ts:226](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L226)*
*Defined in [asset_buyer.ts:226](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L226)*
Given a BuyQuote and desired rate, attempt to execute the buy.
@@ -94,7 +94,7 @@ ___
▸ **getAvailableAssetDatasAsync**(): *`Promise<string[]>`*
*Defined in [asset_buyer.ts:302](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L302)*
*Defined in [asset_buyer.ts:302](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L302)*
Get the asset data of all assets that are purchaseable with ether token (wETH) in the order provider passed in at init.
@@ -108,7 +108,7 @@ ___
▸ **getBuyQuoteAsync**(`assetData`: string, `assetBuyAmount`: `BigNumber`, `options`: `Partial<BuyQuoteRequestOpts>`): *`Promise<BuyQuote>`*
*Defined in [asset_buyer.ts:125](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L125)*
*Defined in [asset_buyer.ts:125](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L125)*
Get a `BuyQuote` containing all information relevant to fulfilling a buy given a desired assetData.
You can then pass the `BuyQuote` to `executeBuyQuoteAsync` to execute the buy.
@@ -131,7 +131,7 @@ ___
▸ **getBuyQuoteForERC20TokenAddressAsync**(`tokenAddress`: string, `assetBuyAmount`: `BigNumber`, `options`: `Partial<BuyQuoteRequestOpts>`): *`Promise<BuyQuote>`*
*Defined in [asset_buyer.ts:173](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L173)*
*Defined in [asset_buyer.ts:173](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L173)*
Get a `BuyQuote` containing all information relevant to fulfilling a buy given a desired ERC20 token address.
You can then pass the `BuyQuote` to `executeBuyQuoteAsync` to execute the buy.
@@ -154,7 +154,7 @@ ___
▸ **getLiquidityForAssetDataAsync**(`assetData`: string, `options`: `Partial<LiquidityRequestOpts>`): *`Promise<LiquidityForAssetData>`*
*Defined in [asset_buyer.ts:192](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L192)*
*Defined in [asset_buyer.ts:192](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L192)*
Returns information about available liquidity for an asset
Does not factor in slippage or fees
@@ -176,7 +176,7 @@ ___
▸ **getOrdersAndFillableAmountsAsync**(`assetData`: string, `shouldForceOrderRefresh`: boolean): *`Promise<OrdersAndFillableAmounts>`*
*Defined in [asset_buyer.ts:311](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L311)*
*Defined in [asset_buyer.ts:311](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L311)*
Grab orders from the map, if there is a miss or it is time to refresh, fetch and process the orders
@@ -195,7 +195,7 @@ ___
▸ **getAssetBuyerForProvidedOrders**(`supportedProvider`: `SupportedProvider`, `orders`: `SignedOrder`[], `options`: `Partial<AssetBuyerOpts>`): *[AssetBuyer](#class-assetbuyer)*
*Defined in [asset_buyer.ts:53](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L53)*
*Defined in [asset_buyer.ts:53](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L53)*
Instantiates a new AssetBuyer instance given existing liquidity in the form of orders and feeOrders.
@@ -217,7 +217,7 @@ ___
▸ **getAssetBuyerForStandardRelayerAPIUrl**(`supportedProvider`: `SupportedProvider`, `sraApiUrl`: string, `options`: `Partial<AssetBuyerOpts>`): *[AssetBuyer](#class-assetbuyer)*
*Defined in [asset_buyer.ts:72](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/asset_buyer.ts#L72)*
*Defined in [asset_buyer.ts:72](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/asset_buyer.ts#L72)*
Instantiates a new AssetBuyer instance given a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint
@@ -252,7 +252,7 @@ Error class representing insufficient asset liquidity
\+ **new InsufficientAssetLiquidityError**(`amountAvailableToFill`: `BigNumber`): *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)*
*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/errors.ts#L12)*
*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/errors.ts#L12)*
**Parameters:**
@@ -268,7 +268,7 @@ Name | Type | Description |
• **amountAvailableToFill**: *`BigNumber`*
*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/errors.ts#L12)*
*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/errors.ts#L12)*
The amount availabe to fill (in base units) factoring in slippage.
@@ -331,7 +331,7 @@ ___
\+ **new BasicOrderProvider**(`orders`: `SignedOrder`[]): *[BasicOrderProvider](#class-basicorderprovider)*
*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)*
*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)*
Instantiates a new BasicOrderProvider instance
@@ -351,7 +351,7 @@ An instance of BasicOrderProvider
• **orders**: *`SignedOrder`[]*
*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)*
*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)*
### Methods
@@ -359,7 +359,7 @@ An instance of BasicOrderProvider
▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise<string[]>`*
*Defined in [order_providers/basic_order_provider.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L37)*
*Defined in [order_providers/basic_order_provider.ts:37](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L37)*
Given a taker asset data string, return all availabled paired maker asset data strings.
@@ -379,7 +379,7 @@ ___
▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise<OrderProviderResponse>`*
*Defined in [order_providers/basic_order_provider.ts:24](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L24)*
*Defined in [order_providers/basic_order_provider.ts:24](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L24)*
Given an object that conforms to OrderFetcherRequest, return the corresponding OrderProviderResponse that satisfies the request.
@@ -412,7 +412,7 @@ An instance of OrderProviderResponse. See type for more information.
\+ **new StandardRelayerAPIOrderProvider**(`apiUrl`: string, `networkId`: number): *[StandardRelayerAPIOrderProvider](#class-standardrelayerapiorderprovider)*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:48](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L48)*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:48](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L48)*
Instantiates a new StandardRelayerAPIOrderProvider instance
@@ -433,7 +433,7 @@ An instance of StandardRelayerAPIOrderProvider
• **apiUrl**: *string*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:17](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L17)*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:17](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L17)*
___
@@ -441,7 +441,7 @@ ___
• **networkId**: *number*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L18)*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L18)*
### Methods
@@ -449,7 +449,7 @@ ___
▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise<string[]>`*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:91](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L91)*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:91](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L91)*
Given a taker asset data string, return all availabled paired maker asset data strings.
@@ -469,7 +469,7 @@ ___
▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise<OrderProviderResponse>`*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:67](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L67)*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:67](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L67)*
Given an object that conforms to OrderProviderRequest, return the corresponding OrderProviderResponse that satisfies the request.
@@ -496,7 +496,7 @@ Possible error messages thrown by an AssetBuyer instance or associated static me
• **AssetUnavailable**: = "ASSET_UNAVAILABLE"
*Defined in [types.ts:122](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L122)*
*Defined in [types.ts:122](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L122)*
___
@@ -504,7 +504,7 @@ ___
• **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY"
*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L118)*
*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L118)*
___
@@ -512,7 +512,7 @@ ___
• **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY"
*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L119)*
*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L119)*
___
@@ -520,7 +520,7 @@ ___
• **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE"
*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L121)*
*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L121)*
___
@@ -528,7 +528,7 @@ ___
• **NoAddressAvailable**: = "NO_ADDRESS_AVAILABLE"
*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L120)*
*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L120)*
___
@@ -536,7 +536,7 @@ ___
• **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND"
*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L115)*
*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L115)*
___
@@ -544,7 +544,7 @@ ___
• **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND"
*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L116)*
*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L116)*
___
@@ -552,7 +552,7 @@ ___
• **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED"
*Defined in [types.ts:123](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L123)*
*Defined in [types.ts:123](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L123)*
___
@@ -560,7 +560,7 @@ ___
• **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR"
*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L117)*
*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L117)*
___
@@ -568,7 +568,7 @@ ___
• **TransactionValueTooLow**: = "TRANSACTION_VALUE_TOO_LOW"
*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L124)*
*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L124)*
<hr />
@@ -589,7 +589,7 @@ expiryBufferSeconds: The number of seconds to add when calculating whether an or
• **expiryBufferSeconds**: *number*
*Defined in [types.ts:108](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L108)*
*Defined in [types.ts:108](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L108)*
___
@@ -597,7 +597,7 @@ ___
• **networkId**: *number*
*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L106)*
*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L106)*
___
@@ -605,7 +605,7 @@ ___
• **orderRefreshIntervalMs**: *number*
*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L107)*
*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L107)*
<hr />
@@ -630,7 +630,7 @@ worstCaseQuoteInfo: Info about the worst case price for the asset.
• **assetBuyAmount**: *`BigNumber`*
*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L48)*
*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L48)*
___
@@ -638,7 +638,7 @@ ___
• **assetData**: *string*
*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L47)*
*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L47)*
___
@@ -646,7 +646,7 @@ ___
• **bestCaseQuoteInfo**: *[BuyQuoteInfo](#interface-buyquoteinfo)*
*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L52)*
*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L52)*
___
@@ -654,7 +654,7 @@ ___
• **feeOrders**: *`SignedOrder`[]*
*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L50)*
*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L50)*
___
@@ -662,7 +662,7 @@ ___
• **feePercentage**? : *undefined | number*
*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L51)*
*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L51)*
___
@@ -670,7 +670,7 @@ ___
• **orders**: *`SignedOrder`[]*
*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L49)*
*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L49)*
___
@@ -678,7 +678,7 @@ ___
• **worstCaseQuoteInfo**: *[BuyQuoteInfo](#interface-buyquoteinfo)*
*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L53)*
*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L53)*
<hr />
@@ -701,7 +701,7 @@ feeRecipient: The address where affiliate fees are sent. Defaults to null addres
• **ethAmount**? : *`BigNumber`*
*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L93)*
*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L93)*
___
@@ -709,7 +709,7 @@ ___
• **feeRecipient**: *string*
*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L97)*
*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L97)*
___
@@ -717,7 +717,7 @@ ___
• **gasLimit**? : *undefined | number*
*Defined in [types.ts:95](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L95)*
*Defined in [types.ts:95](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L95)*
___
@@ -725,7 +725,7 @@ ___
• **gasPrice**? : *`BigNumber`*
*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L96)*
*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L96)*
___
@@ -733,7 +733,7 @@ ___
• **takerAddress**? : *undefined | string*
*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L94)*
*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L94)*
<hr />
@@ -754,7 +754,7 @@ totalEthAmount: The total amount of eth required to complete the buy (filling or
• **assetEthAmount**: *`BigNumber`*
*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L62)*
*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L62)*
___
@@ -762,7 +762,7 @@ ___
• **feeEthAmount**: *`BigNumber`*
*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L63)*
*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L63)*
___
@@ -770,7 +770,7 @@ ___
• **totalEthAmount**: *`BigNumber`*
*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L64)*
*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L64)*
<hr />
@@ -791,7 +791,7 @@ slippagePercentage: The percentage buffer to add to account for slippage. Affect
• **feePercentage**: *number*
*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L73)*
*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L73)*
___
@@ -799,7 +799,7 @@ ___
• **shouldForceOrderRefresh**: *boolean*
*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L74)*
*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L74)*
___
@@ -807,7 +807,7 @@ ___
• **slippagePercentage**: *number*
*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L75)*
*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L75)*
<hr />
@@ -826,7 +826,7 @@ Represents available liquidity for a given assetData
• **ethValueAvailableInWei**: *`BigNumber`*
*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L141)*
*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L141)*
___
@@ -834,7 +834,7 @@ ___
• **tokensAvailableInBaseUnits**: *`BigNumber`*
*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L140)*
*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L140)*
<hr />
@@ -859,7 +859,7 @@ getAvailableMakerAssetDatasAsync: Given a taker asset data string, return all av
• **getAvailableMakerAssetDatasAsync**: *function*
*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L34)*
#### Type declaration:
@@ -877,7 +877,7 @@ ___
• **getOrdersAsync**: *function*
*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L33)*
*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L33)*
#### Type declaration:
@@ -908,7 +908,7 @@ networkId: The networkId that the desired orders should be for.
• **makerAssetData**: *string*
*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L10)*
___
@@ -916,7 +916,7 @@ ___
• **takerAssetData**: *string*
*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L11)*
*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L11)*
<hr />
@@ -935,7 +935,7 @@ orders: An array of orders with optional remaining fillable makerAsset amounts.
• **orders**: *[SignedOrderWithRemainingFillableMakerAssetAmount](#interface-signedorderwithremainingfillablemakerassetamount)[]*
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L18)*
<hr />
@@ -955,7 +955,7 @@ remainingFillableMakerAssetAmounts: A list of fillable amounts for the signed or
• **orders**: *`SignedOrder`[]*
*Defined in [types.ts:132](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L132)*
*Defined in [types.ts:132](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L132)*
___
@@ -963,7 +963,7 @@ ___
• **remainingFillableMakerAssetAmounts**: *`BigNumber`[]*
*Defined in [types.ts:133](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L133)*
*Defined in [types.ts:133](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L133)*
<hr />
@@ -1055,7 +1055,7 @@ ___
• **remainingFillableMakerAssetAmount**? : *`BigNumber`*
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/asset-buyer/src/types.ts#L26)*
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/asset-buyer/src/types.ts#L26)*
___

514
packages/asset-swapper/docs/reference.mdx
View File

File diff suppressed because it is too large Load Diff

54
packages/connect/docs/reference.mdx
View File

@@ -18,7 +18,7 @@ that implement the standard relayer API v2
\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)*
*Defined in [http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L44)*
*Defined in [http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L44)*
Instantiates a new HttpClient instance
@@ -38,7 +38,7 @@ An instance of HttpClient
▸ **getAssetPairsAsync**(`requestOpts?`: `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise<AssetPairsResponse>`*
*Defined in [http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L59)*
*Defined in [http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L59)*
Retrieve assetData pair info from the API
@@ -58,7 +58,7 @@ ___
▸ **getFeeRecipientsAsync**(`requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<FeeRecipientsResponse>`*
*Defined in [http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L160)*
*Defined in [http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L160)*
Retrieve the list of fee recipient addresses used by the relayer.
@@ -78,7 +78,7 @@ ___
▸ **getOrderAsync**(`orderHash`: string, `requestOpts?`: `RequestOpts`): *`Promise<APIOrder>`*
*Defined in [http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L99)*
*Defined in [http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L99)*
Retrieve a specific order from the API
@@ -99,7 +99,7 @@ ___
▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`, `requestOpts?`: `RequestOpts`): *`Promise<OrderConfigResponse>`*
*Defined in [http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L139)*
*Defined in [http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L139)*
Retrieve fee information from the API
@@ -120,7 +120,7 @@ ___
▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<OrderbookResponse>`*
*Defined in [http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L117)*
*Defined in [http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L117)*
Retrieve an orderbook from the API
@@ -141,7 +141,7 @@ ___
▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise<OrdersResponse>`*
*Defined in [http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L79)*
*Defined in [http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L79)*
Retrieve orders from the API
@@ -161,7 +161,7 @@ ___
▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`, `requestOpts?`: `RequestOpts`): *`Promise<void>`*
*Defined in [http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/http_client.ts#L177)*
*Defined in [http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/http_client.ts#L177)*
Submit a signed order to the API
@@ -196,7 +196,7 @@ that implements the standard relayer API v0
\+ **new WebSocketOrdersChannel**(`client`: `w3cwebsocket`, `handler`: [OrdersChannelHandler](#interface-orderschannelhandler)): *[WebSocketOrdersChannel](#class-websocketorderschannel)*
*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/ws_orders_channel.ts#L21)*
*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/ws_orders_channel.ts#L21)*
Instantiates a new WebSocketOrdersChannel instance
@@ -217,7 +217,7 @@ An instance of WebSocketOrdersChannel
▸ **close**(): *void*
*Defined in [ws_orders_channel.ts:66](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/ws_orders_channel.ts#L66)*
*Defined in [ws_orders_channel.ts:66](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/ws_orders_channel.ts#L66)*
Close the websocket and stop receiving updates
@@ -229,7 +229,7 @@ ___
▸ **subscribe**(`subscriptionOpts`: `OrdersChannelSubscriptionOpts`): *void*
*Defined in [ws_orders_channel.ts:50](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/ws_orders_channel.ts#L50)*
*Defined in [ws_orders_channel.ts:50](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/ws_orders_channel.ts#L50)*
Subscribe to orderbook snapshots and updates from the websocket
@@ -252,7 +252,7 @@ Name | Type | Description |
• **Get**: = "GET"
*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L46)*
*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L46)*
___
@@ -260,7 +260,7 @@ ___
• **Post**: = "POST"
*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L47)*
*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L47)*
<hr />
@@ -281,7 +281,7 @@ ___
• **getAssetPairsAsync**: *function*
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L18)*
#### Type declaration:
@@ -299,7 +299,7 @@ ___
• **getFeeRecipientsAsync**: *function*
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L25)*
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L25)*
#### Type declaration:
@@ -317,7 +317,7 @@ ___
• **getOrderAsync**: *function*
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L22)*
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L22)*
#### Type declaration:
@@ -335,7 +335,7 @@ ___
• **getOrderConfigAsync**: *function*
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L24)*
#### Type declaration:
@@ -353,7 +353,7 @@ ___
• **getOrderbookAsync**: *function*
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L23)*
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L23)*
#### Type declaration:
@@ -372,7 +372,7 @@ ___
• **getOrdersAsync**: *function*
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L21)*
#### Type declaration:
@@ -390,7 +390,7 @@ ___
• **submitOrderAsync**: *function*
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L26)*
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L26)*
#### Type declaration:
@@ -417,7 +417,7 @@ Name | Type |
• **params**? : *undefined | object*
*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L41)*
*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L41)*
___
@@ -425,7 +425,7 @@ ___
• **payload**? : *undefined | object*
*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L42)*
*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L42)*
<hr />
@@ -446,7 +446,7 @@ ___
• **close**: *function*
*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L31)*
*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L31)*
#### Type declaration:
@@ -458,7 +458,7 @@ ___
• **subscribe**: *function*
*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L30)*
*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L30)*
#### Type declaration:
@@ -485,7 +485,7 @@ Name | Type |
• **onClose**: *function*
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L37)*
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L37)*
#### Type declaration:
@@ -503,7 +503,7 @@ ___
• **onError**: *function*
*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L36)*
*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L36)*
#### Type declaration:
@@ -523,7 +523,7 @@ ___
• **onUpdate**: *function*
*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/connect/src/types.ts#L35)*
*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/connect/src/types.ts#L35)*
#### Type declaration:

278
packages/contract-wrappers/docs/reference.mdx
View File

File diff suppressed because it is too large Load Diff

1140
packages/ethereum-types/docs/reference.mdx
View File

File diff suppressed because it is too large Load Diff

8
packages/json-schemas/docs/reference.mdx
View File

@@ -13,7 +13,7 @@ A validator for [JSON-schemas](http://json-schema.org/)
\+ **new SchemaValidator**(): *[SchemaValidator](#class-schemavalidator)*
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/json-schemas/src/schema_validator.ts#L15)*
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/json-schemas/src/schema_validator.ts#L15)*
Instantiates a SchemaValidator instance
@@ -25,7 +25,7 @@ Instantiates a SchemaValidator instance
▸ **addSchema**(`schema`: `Schema`): *void*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/json-schemas/src/schema_validator.ts#L32)*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/json-schemas/src/schema_validator.ts#L32)*
Add a schema to the validator. All schemas and sub-schemas must be added to
the validator before the `validate` and `isValid` methods can be called with
@@ -45,7 +45,7 @@ ___
▸ **isValid**(`instance`: any, `schema`: `Schema`): *boolean*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/json-schemas/src/schema_validator.ts#L57)*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/json-schemas/src/schema_validator.ts#L57)*
Check whether an instance properly adheres to a JSON schema
@@ -66,7 +66,7 @@ ___
▸ **validate**(`instance`: any, `schema`: `Schema`): *`ValidatorResult`*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/json-schemas/src/schema_validator.ts#L46)*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/json-schemas/src/schema_validator.ts#L46)*
Validate the JS object conforms to a specific JSON schema

38
packages/migrations/docs/reference.mdx
View File

@@ -7,7 +7,7 @@
• **AccountLevels**: = "AccountLevels"
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L26)*
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L26)*
___
@@ -15,7 +15,7 @@ ___
• **Arbitrage**: = "Arbitrage"
*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L28)*
*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L28)*
___
@@ -23,7 +23,7 @@ ___
• **DummyToken**: = "DummyToken"
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L23)*
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L23)*
___
@@ -31,7 +31,7 @@ ___
• **EtherDelta**: = "EtherDelta"
*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L27)*
*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L27)*
___
@@ -39,7 +39,7 @@ ___
• **Exchange**: = "Exchange"
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L21)*
___
@@ -47,7 +47,7 @@ ___
• **MultiSigWalletWithTimeLock**: = "MultiSigWalletWithTimeLock"
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L20)*
___
@@ -55,7 +55,7 @@ ___
• **MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress**: = "MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress"
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L25)*
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L25)*
___
@@ -63,7 +63,7 @@ ___
• **TokenRegistry**: = "TokenRegistry"
*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L19)*
___
@@ -71,7 +71,7 @@ ___
• **TokenTransferProxy**: = "TokenTransferProxy"
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L18)*
___
@@ -79,7 +79,7 @@ ___
• **WETH9**: = "WETH9"
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L24)*
___
@@ -87,7 +87,7 @@ ___
• **ZRXToken**: = "ZRXToken"
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L22)*
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L22)*
<hr />
@@ -104,7 +104,7 @@ ___
• **address**? : *undefined | string*
*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L4)*
*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L4)*
___
@@ -112,7 +112,7 @@ ___
• **decimals**: *`BigNumber`*
*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L7)*
*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L7)*
___
@@ -120,7 +120,7 @@ ___
• **ipfsHash**: *string*
*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L8)*
*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L8)*
___
@@ -128,7 +128,7 @@ ___
• **name**: *string*
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L5)*
___
@@ -136,7 +136,7 @@ ___
• **swarmHash**: *string*
*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L9)*
___
@@ -144,7 +144,7 @@ ___
• **symbol**: *string*
*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L6)*
*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L6)*
<hr />
@@ -161,7 +161,7 @@ ___
• **name**: *string*
*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L13)*
___
@@ -169,7 +169,7 @@ ___
• **symbol**: *string*
*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/migrations/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/migrations/src/types.ts#L14)*
<hr />

166
packages/order-utils/docs/reference.mdx
View File

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

40
packages/sol-compiler/docs/reference.mdx
View File

@@ -14,7 +14,7 @@ to artifact files.
\+ **new Compiler**(`opts?`: `CompilerOptions`): *[Compiler](#class-compiler)*
*Defined in [compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/compiler.ts#L94)*
*Defined in [compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/compiler.ts#L94)*
Instantiates a new instance of the Compiler class.
@@ -34,7 +34,7 @@ An instance of the Compiler class.
▸ **compileAsync**(): *`Promise<void>`*
*Defined in [compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/compiler.ts#L132)*
*Defined in [compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/compiler.ts#L132)*
Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`.
@@ -46,7 +46,7 @@ ___
▸ **getCompilerOutputsAsync**(): *`Promise<StandardOutput[]>`*
*Defined in [compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/compiler.ts#L145)*
*Defined in [compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/compiler.ts#L145)*
Compiles Solidity files specified during instantiation, and returns the
compiler output given by solc. Return value is an array of outputs:
@@ -63,7 +63,7 @@ ___
▸ **watchAsync**(): *`Promise<void>`*
*Defined in [compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/compiler.ts#L149)*
*Defined in [compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/compiler.ts#L149)*
**Returns:** *`Promise<void>`*
@@ -84,7 +84,7 @@ ___
\+ **new CompilationError**(`errorsCount`: number): *[CompilationError](#class-compilationerror)*
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L39)*
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L39)*
**Parameters:**
@@ -100,7 +100,7 @@ Name | Type |
• **errorsCount**: *number*
*Defined in [utils/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L38)*
*Defined in [utils/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L38)*
___
@@ -140,7 +140,7 @@ ___
• **typeName**: *string* = "CompilationError"
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L39)*
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L39)*
___
@@ -161,7 +161,7 @@ ___
• **Constructor**: = "constructor"
*Defined in [utils/types.ts:3](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L3)*
*Defined in [utils/types.ts:3](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L3)*
___
@@ -169,7 +169,7 @@ ___
• **Event**: = "event"
*Defined in [utils/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L4)*
*Defined in [utils/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L4)*
___
@@ -177,7 +177,7 @@ ___
• **Fallback**: = "fallback"
*Defined in [utils/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L5)*
*Defined in [utils/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L5)*
___
@@ -185,7 +185,7 @@ ___
• **Function**: = "function"
*Defined in [utils/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L2)*
*Defined in [utils/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L2)*
<hr />
@@ -212,7 +212,7 @@ ___
• **solcVersionRange**: *string*
*Defined in [utils/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L21)*
*Defined in [utils/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L21)*
___
@@ -220,7 +220,7 @@ ___
• **sourceHash**: *`Buffer`*
*Defined in [utils/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L22)*
*Defined in [utils/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L22)*
___
@@ -228,7 +228,7 @@ ___
• **sourceTreeHash**: *`Buffer`*
*Defined in [utils/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L23)*
*Defined in [utils/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L23)*
<hr />
@@ -250,7 +250,7 @@ ___
• **address**? : *undefined | string*
*Defined in [utils/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L27)*
*Defined in [utils/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L27)*
___
@@ -258,7 +258,7 @@ ___
• **decimals**: *number*
*Defined in [utils/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L30)*
*Defined in [utils/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L30)*
___
@@ -266,7 +266,7 @@ ___
• **ipfsHash**: *string*
*Defined in [utils/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L31)*
*Defined in [utils/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L31)*
___
@@ -274,7 +274,7 @@ ___
• **name**: *string*
*Defined in [utils/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L28)*
*Defined in [utils/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L28)*
___
@@ -282,7 +282,7 @@ ___
• **swarmHash**: *string*
*Defined in [utils/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L32)*
*Defined in [utils/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L32)*
___
@@ -290,7 +290,7 @@ ___
• **symbol**: *string*
*Defined in [utils/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-compiler/src/utils/types.ts#L29)*
*Defined in [utils/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-compiler/src/utils/types.ts#L29)*
<hr />

10
packages/sol-coverage/docs/reference.mdx
View File

@@ -14,11 +14,11 @@ It's used to compute your code coverage while running solidity tests.
## constructer
\+ **new CoverageSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `partialConfig`: [CoverageSubproviderPartialConfig](#coveragesubproviderpartialconfig)): *[CoverageSubprovider](#class-coveragesubprovider)*
\+ **new CoverageSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `partialConfig`: [CoverageSubproviderPartialConfig](../modules/_coverage_subprovider_.md#coveragesubproviderpartialconfig)): *[CoverageSubprovider](#class-coveragesubprovider)*
*Overrides void*
*Defined in [coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
*Defined in [coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
Instantiates a CoverageSubprovider instance
@@ -140,7 +140,7 @@ ___
▸ **writeCoverageAsync**(): *`Promise<void>`*
*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
Write the test coverage results to a file in Istanbul format.
@@ -165,7 +165,7 @@ ignoreFilesGlobs: The list of globs matching the file names of the files we want
• **ignoreFilesGlobs**: *string[]*
*Defined in [coverage_subprovider.ts:28](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-coverage/src/coverage_subprovider.ts#L28)*
*Defined in [coverage_subprovider.ts:28](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-coverage/src/coverage_subprovider.ts#L28)*
___
@@ -173,7 +173,7 @@ ___
• **isVerbose**: *boolean*
*Defined in [coverage_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-coverage/src/coverage_subprovider.ts#L27)*
*Defined in [coverage_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-coverage/src/coverage_subprovider.ts#L27)*
<hr />

4
packages/sol-profiler/docs/reference.mdx
View File

@@ -18,7 +18,7 @@ ProfilerSubprovider is used to profile Solidity code while running tests.
*Overrides void*
*Defined in [profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
*Defined in [profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
Instantiates a ProfilerSubprovider instance
@@ -140,7 +140,7 @@ ___
▸ **writeProfilerOutputAsync**(): *`Promise<void>`*
*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
Write the test profiler results to a file in Istanbul format.

2
packages/sol-trace/docs/reference.mdx
View File

@@ -18,7 +18,7 @@ It is used to report call stack traces whenever a revert occurs.
*Overrides void*
*Defined in [revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/bfbc78c95/packages/sol-trace/src/revert_trace_subprovider.ts#L27)*
*Defined in [revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/6474a4e08/packages/sol-trace/src/revert_trace_subprovider.ts#L27)*
Instantiates a RevertTraceSubprovider instance

440
packages/subproviders/docs/reference.mdx
View File

File diff suppressed because it is too large Load Diff

382
packages/web3-wrapper/docs/reference.mdx
View File

File diff suppressed because it is too large Load Diff