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

Update ts-docs-gen dep and re-generate the reference docs

Browse Source
This commit is contained in:
fabioberger
2019-08-03 22:14:20 +02:00
parent 67322ba39f
commit 326539f1f5
30 changed files with 1536 additions and 1536 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/0x.js/package.json
View File

@@ -48,7 +48,7 @@
"@0x/contract-addresses": "^3.1.0",
"@0x/dev-utils": "^2.3.1",
"@0x/migrations": "^4.3.0",
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@types/lodash": "4.14.104",
"@types/mocha": "^5.2.7",

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

@@ -35,7 +35,7 @@
\+ **new AssetBuyer**(`supportedProvider`: `SupportedProvider`, `orderProvider`: [OrderProvider](#class-assetbuyer)*
*Defined in [asset_buyer.ts:84](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L84)*
*Defined in [asset_buyer.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L84)*
Instantiates a new AssetBuyer instance
@@ -57,7 +57,7 @@ An instance of AssetBuyer
• **expiryBufferSeconds**: *number*
*Defined in [asset_buyer.ts:41](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L41)*
*Defined in [asset_buyer.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L41)*
___
@@ -65,7 +65,7 @@ ___
• **networkId**: *number*
*Defined in [asset_buyer.ts:39](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L39)*
*Defined in [asset_buyer.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L39)*
___
@@ -73,7 +73,7 @@ ___
• **orderProvider**: *[OrderProvider](#interface-orderprovider)*
*Defined in [asset_buyer.ts:38](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L38)*
*Defined in [asset_buyer.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L38)*
___
@@ -81,7 +81,7 @@ ___
• **orderRefreshIntervalMs**: *number*
*Defined in [asset_buyer.ts:40](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L40)*
*Defined in [asset_buyer.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L40)*
___
@@ -89,7 +89,7 @@ ___
• **provider**: *`ZeroExProvider`*
*Defined in [asset_buyer.ts:37](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L37)*
*Defined in [asset_buyer.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L37)*
## Methods
@@ -97,7 +97,7 @@ ___
▸ **executeBuyQuoteAsync**(`buyQuote`: [BuyQuote](#interface-buyquote), `options`: `Partial<BuyQuoteExecutionOpts>`): *`Promise<string>`*
*Defined in [asset_buyer.ts:227](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L227)*
*Defined in [asset_buyer.ts:227](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L227)*
Given a BuyQuote and desired rate, attempt to execute the buy.
@@ -118,7 +118,7 @@ ___
▸ **getAvailableAssetDatasAsync**(): *`Promise<string[]>`*
*Defined in [asset_buyer.ts:297](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L297)*
*Defined in [asset_buyer.ts:297](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L297)*
Get the asset data of all assets that are purchaseable with ether token (wETH) in the order provider passed in at init.
@@ -132,7 +132,7 @@ ___
▸ **getBuyQuoteAsync**(`assetData`: string, `assetBuyAmount`: `BigNumber`, `options`: `Partial<BuyQuoteRequestOpts>`): *`Promise<BuyQuote>`*
*Defined in [asset_buyer.ts:126](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L126)*
*Defined in [asset_buyer.ts:126](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L126)*
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.
@@ -155,7 +155,7 @@ ___
▸ **getBuyQuoteForERC20TokenAddressAsync**(`tokenAddress`: string, `assetBuyAmount`: `BigNumber`, `options`: `Partial<BuyQuoteRequestOpts>`): *`Promise<BuyQuote>`*
*Defined in [asset_buyer.ts:174](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L174)*
*Defined in [asset_buyer.ts:174](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L174)*
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.
@@ -178,7 +178,7 @@ ___
▸ **getLiquidityForAssetDataAsync**(`assetData`: string, `options`: `Partial<LiquidityRequestOpts>`): *`Promise<LiquidityForAssetData>`*
*Defined in [asset_buyer.ts:193](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L193)*
*Defined in [asset_buyer.ts:193](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L193)*
Returns information about available liquidity for an asset
Does not factor in slippage or fees
@@ -200,7 +200,7 @@ ___
▸ **getOrdersAndFillableAmountsAsync**(`assetData`: string, `shouldForceOrderRefresh`: boolean): *`Promise<OrdersAndFillableAmounts>`*
*Defined in [asset_buyer.ts:306](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L306)*
*Defined in [asset_buyer.ts:306](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L306)*
Grab orders from the map, if there is a miss or it is time to refresh, fetch and process the orders
@@ -219,7 +219,7 @@ ___
▸ **getAssetBuyerForProvidedOrders**(`supportedProvider`: `SupportedProvider`, `orders`: `SignedOrder`[], `options`: `Partial<AssetBuyerOpts>`): *[AssetBuyer](#class-assetbuyer)*
*Defined in [asset_buyer.ts:54](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L54)*
*Defined in [asset_buyer.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L54)*
Instantiates a new AssetBuyer instance given existing liquidity in the form of orders and feeOrders.
@@ -241,7 +241,7 @@ ___
▸ **getAssetBuyerForStandardRelayerAPIUrl**(`supportedProvider`: `SupportedProvider`, `sraApiUrl`: string, `options`: `Partial<AssetBuyerOpts>`): *[AssetBuyer](#class-assetbuyer)*
*Defined in [asset_buyer.ts:73](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/asset_buyer.ts#L73)*
*Defined in [asset_buyer.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L73)*
Instantiates a new AssetBuyer instance given a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint
@@ -289,7 +289,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/61e50a1cd/packages/asset-buyer/src/errors.ts#L12)*
*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/errors.ts#L12)*
**Parameters:**
@@ -305,7 +305,7 @@ Name | Type | Description |
• **amountAvailableToFill**: *`BigNumber`*
*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/errors.ts#L12)*
*Defined in [errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/errors.ts#L12)*
The amount availabe to fill (in base units) factoring in slippage.
@@ -382,7 +382,7 @@ Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typed
\+ **new BasicOrderProvider**(`orders`: `SignedOrder`[]): *[BasicOrderProvider](#class-basicorderprovider)*
*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)*
Instantiates a new BasicOrderProvider instance
@@ -402,7 +402,7 @@ An instance of BasicOrderProvider
• **orders**: *`SignedOrder`[]*
*Defined in [order_providers/basic_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/asset-buyer/src/order_providers/basic_order_provider.ts#L9)*
## Methods
@@ -410,7 +410,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/61e50a1cd/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/6dd77d5c8/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.
@@ -430,7 +430,7 @@ ___
▸ **getOrdersAsync**(`orderProviderRequest`: [OrderProviderRequest](#interface-orderproviderrequest)): *`Promise<OrderProviderResponse>`*
*Defined in [order_providers/basic_order_provider.ts:24](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/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.
@@ -478,7 +478,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/61e50a1cd/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/6dd77d5c8/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L48)*
Instantiates a new StandardRelayerAPIOrderProvider instance
@@ -499,7 +499,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/61e50a1cd/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/6dd77d5c8/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L17)*
___
@@ -507,7 +507,7 @@ ___
• **networkId**: *number*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/asset-buyer/src/order_providers/standard_relayer_api_order_provider.ts#L18)*
## Methods
@@ -515,7 +515,7 @@ ___
▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise<string[]>`*
*Defined in [order_providers/standard_relayer_api_order_provider.ts:91](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/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.
@@ -535,7 +535,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/61e50a1cd/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/6dd77d5c8/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.
@@ -576,7 +576,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/61e50a1cd/packages/asset-buyer/src/types.ts#L122)*
*Defined in [types.ts:122](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L122)*
___
@@ -584,7 +584,7 @@ ___
• **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY"
*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L118)*
*Defined in [types.ts:118](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L118)*
___
@@ -592,7 +592,7 @@ ___
• **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY"
*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L119)*
*Defined in [types.ts:119](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L119)*
___
@@ -600,7 +600,7 @@ ___
• **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE"
*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L121)*
*Defined in [types.ts:121](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L121)*
___
@@ -608,7 +608,7 @@ ___
• **NoAddressAvailable**: = "NO_ADDRESS_AVAILABLE"
*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L120)*
*Defined in [types.ts:120](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L120)*
___
@@ -616,7 +616,7 @@ ___
• **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND"
*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L115)*
*Defined in [types.ts:115](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L115)*
___
@@ -624,7 +624,7 @@ ___
• **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND"
*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L116)*
*Defined in [types.ts:116](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L116)*
___
@@ -632,7 +632,7 @@ ___
• **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED"
*Defined in [types.ts:123](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L123)*
*Defined in [types.ts:123](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L123)*
___
@@ -640,7 +640,7 @@ ___
• **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR"
*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L117)*
*Defined in [types.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L117)*
___
@@ -648,7 +648,7 @@ ___
• **TransactionValueTooLow**: = "TRANSACTION_VALUE_TOO_LOW"
*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L124)*
*Defined in [types.ts:124](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L124)*
<hr />
@@ -676,7 +676,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/61e50a1cd/packages/asset-buyer/src/types.ts#L108)*
*Defined in [types.ts:108](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L108)*
___
@@ -684,7 +684,7 @@ ___
• **networkId**: *number*
*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L106)*
*Defined in [types.ts:106](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L106)*
___
@@ -692,7 +692,7 @@ ___
• **orderRefreshIntervalMs**: *number*
*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L107)*
*Defined in [types.ts:107](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L107)*
<hr />
@@ -728,7 +728,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/61e50a1cd/packages/asset-buyer/src/types.ts#L48)*
*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L48)*
___
@@ -736,7 +736,7 @@ ___
• **assetData**: *string*
*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L47)*
*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L47)*
___
@@ -744,7 +744,7 @@ ___
• **bestCaseQuoteInfo**: *[BuyQuoteInfo](#interface-buyquoteinfo)*
*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L52)*
*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L52)*
___
@@ -752,7 +752,7 @@ ___
• **feeOrders**: *`SignedOrder`[]*
*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L50)*
*Defined in [types.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L50)*
___
@@ -760,7 +760,7 @@ ___
• **feePercentage**? : *undefined | number*
*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L51)*
*Defined in [types.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L51)*
___
@@ -768,7 +768,7 @@ ___
• **orders**: *`SignedOrder`[]*
*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L49)*
*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L49)*
___
@@ -776,7 +776,7 @@ ___
• **worstCaseQuoteInfo**: *[BuyQuoteInfo](#interface-buyquoteinfo)*
*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L53)*
*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L53)*
<hr />
@@ -808,7 +808,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/61e50a1cd/packages/asset-buyer/src/types.ts#L93)*
*Defined in [types.ts:93](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L93)*
___
@@ -816,7 +816,7 @@ ___
• **feeRecipient**: *string*
*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L97)*
*Defined in [types.ts:97](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L97)*
___
@@ -824,7 +824,7 @@ ___
• **gasLimit**? : *undefined | number*
*Defined in [types.ts:95](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L95)*
*Defined in [types.ts:95](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L95)*
___
@@ -832,7 +832,7 @@ ___
• **gasPrice**? : *`BigNumber`*
*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L96)*
*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L96)*
___
@@ -840,7 +840,7 @@ ___
• **takerAddress**? : *undefined | string*
*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L94)*
*Defined in [types.ts:94](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L94)*
<hr />
@@ -868,7 +868,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/61e50a1cd/packages/asset-buyer/src/types.ts#L62)*
*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L62)*
___
@@ -876,7 +876,7 @@ ___
• **feeEthAmount**: *`BigNumber`*
*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L63)*
*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L63)*
___
@@ -884,7 +884,7 @@ ___
• **totalEthAmount**: *`BigNumber`*
*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L64)*
*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L64)*
<hr />
@@ -912,7 +912,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/61e50a1cd/packages/asset-buyer/src/types.ts#L73)*
*Defined in [types.ts:73](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L73)*
___
@@ -920,7 +920,7 @@ ___
• **shouldForceOrderRefresh**: *boolean*
*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L74)*
*Defined in [types.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L74)*
___
@@ -928,7 +928,7 @@ ___
• **slippagePercentage**: *number*
*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L75)*
*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L75)*
<hr />
@@ -953,7 +953,7 @@ Represents available liquidity for a given assetData
• **ethValueAvailableInWei**: *`BigNumber`*
*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L141)*
*Defined in [types.ts:141](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L141)*
___
@@ -961,7 +961,7 @@ ___
• **tokensAvailableInBaseUnits**: *`BigNumber`*
*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L140)*
*Defined in [types.ts:140](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L140)*
<hr />
@@ -992,7 +992,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/61e50a1cd/packages/asset-buyer/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L34)*
#### Type declaration:
@@ -1010,7 +1010,7 @@ ___
• **getOrdersAsync**: *function*
*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L33)*
*Defined in [types.ts:33](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L33)*
#### Type declaration:
@@ -1047,7 +1047,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/61e50a1cd/packages/asset-buyer/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L10)*
___
@@ -1055,7 +1055,7 @@ ___
• **takerAssetData**: *string*
*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L11)*
*Defined in [types.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L11)*
<hr />
@@ -1079,7 +1079,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/61e50a1cd/packages/asset-buyer/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L18)*
<hr />
@@ -1105,7 +1105,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/61e50a1cd/packages/asset-buyer/src/types.ts#L132)*
*Defined in [types.ts:132](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L132)*
___
@@ -1113,7 +1113,7 @@ ___
• **remainingFillableMakerAssetAmounts**: *`BigNumber`[]*
*Defined in [types.ts:133](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L133)*
*Defined in [types.ts:133](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L133)*
<hr />
@@ -1224,7 +1224,7 @@ ___
• **remainingFillableMakerAssetAmount**? : *`BigNumber`*
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/asset-buyer/src/types.ts#L26)*
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/types.ts#L26)*
___

2
packages/asset-buyer/package.json
View File

@@ -53,7 +53,7 @@
"lodash": "^4.17.11"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@types/lodash": "4.14.104",
"@types/mocha": "^5.2.7",

376
packages/asset-swapper/docs/reference.md
View File

File diff suppressed because it is too large Load Diff

2
packages/asset-swapper/package.json
View File

@@ -57,7 +57,7 @@
"lodash": "^4.17.11"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@types/lodash": "4.14.104",
"@types/mocha": "^5.2.7",

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

@@ -33,7 +33,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/61e50a1cd/packages/connect/src/http_client.ts#L44)*
*Defined in [http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L44)*
Instantiates a new HttpClient instance
@@ -53,7 +53,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/61e50a1cd/packages/connect/src/http_client.ts#L59)*
*Defined in [http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L59)*
Retrieve assetData pair info from the API
@@ -73,7 +73,7 @@ ___
▸ **getFeeRecipientsAsync**(`requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<FeeRecipientsResponse>`*
*Defined in [http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/http_client.ts#L160)*
*Defined in [http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L160)*
Retrieve the list of fee recipient addresses used by the relayer.
@@ -93,7 +93,7 @@ ___
▸ **getOrderAsync**(`orderHash`: string, `requestOpts?`: `RequestOpts`): *`Promise<APIOrder>`*
*Defined in [http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/http_client.ts#L99)*
*Defined in [http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L99)*
Retrieve a specific order from the API
@@ -114,7 +114,7 @@ ___
▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`, `requestOpts?`: `RequestOpts`): *`Promise<OrderConfigResponse>`*
*Defined in [http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/http_client.ts#L139)*
*Defined in [http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L139)*
Retrieve fee information from the API
@@ -135,7 +135,7 @@ ___
▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise<OrderbookResponse>`*
*Defined in [http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/http_client.ts#L117)*
*Defined in [http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L117)*
Retrieve an orderbook from the API
@@ -156,7 +156,7 @@ ___
▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise<OrdersResponse>`*
*Defined in [http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/http_client.ts#L79)*
*Defined in [http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L79)*
Retrieve orders from the API
@@ -176,7 +176,7 @@ ___
▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`, `requestOpts?`: `RequestOpts`): *`Promise<void>`*
*Defined in [http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/http_client.ts#L177)*
*Defined in [http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/http_client.ts#L177)*
Submit a signed order to the API
@@ -221,7 +221,7 @@ that implements the standard relayer API v0
\+ **new WebSocketOrdersChannel**(`client`: `w3cwebsocket`, `handler`: [OrdersChannelHandler](#class-websocketorderschannel)*
*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/ws_orders_channel.ts#L21)*
*Defined in [ws_orders_channel.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/ws_orders_channel.ts#L21)*
Instantiates a new WebSocketOrdersChannel instance
@@ -242,7 +242,7 @@ An instance of WebSocketOrdersChannel
▸ **close**(): *void*
*Defined in [ws_orders_channel.ts:66](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/ws_orders_channel.ts#L66)*
*Defined in [ws_orders_channel.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/ws_orders_channel.ts#L66)*
Close the websocket and stop receiving updates
@@ -254,7 +254,7 @@ ___
▸ **subscribe**(`subscriptionOpts`: `OrdersChannelSubscriptionOpts`): *void*
*Defined in [ws_orders_channel.ts:50](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/ws_orders_channel.ts#L50)*
*Defined in [ws_orders_channel.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/ws_orders_channel.ts#L50)*
Subscribe to orderbook snapshots and updates from the websocket
@@ -283,7 +283,7 @@ Name | Type | Description |
• **Get**: = "GET"
*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L46)*
*Defined in [types.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L46)*
___
@@ -291,7 +291,7 @@ ___
• **Post**: = "POST"
*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L47)*
*Defined in [types.ts:47](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L47)*
<hr />
@@ -323,7 +323,7 @@ ___
• **getAssetPairsAsync**: *function*
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L18)*
#### Type declaration:
@@ -341,7 +341,7 @@ ___
• **getFeeRecipientsAsync**: *function*
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L25)*
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L25)*
#### Type declaration:
@@ -359,7 +359,7 @@ ___
• **getOrderAsync**: *function*
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L22)*
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L22)*
#### Type declaration:
@@ -377,7 +377,7 @@ ___
• **getOrderConfigAsync**: *function*
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L24)*
#### Type declaration:
@@ -395,7 +395,7 @@ ___
• **getOrderbookAsync**: *function*
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L23)*
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L23)*
#### Type declaration:
@@ -414,7 +414,7 @@ ___
• **getOrdersAsync**: *function*
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L21)*
#### Type declaration:
@@ -432,7 +432,7 @@ ___
• **submitOrderAsync**: *function*
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L26)*
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L26)*
#### Type declaration:
@@ -465,7 +465,7 @@ Name | Type |
• **params**? : *undefined | object*
*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L41)*
*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L41)*
___
@@ -473,7 +473,7 @@ ___
• **payload**? : *undefined | object*
*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L42)*
*Defined in [types.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L42)*
<hr />
@@ -500,7 +500,7 @@ ___
• **close**: *function*
*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L31)*
*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L31)*
#### Type declaration:
@@ -512,7 +512,7 @@ ___
• **subscribe**: *function*
*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L30)*
*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L30)*
#### Type declaration:
@@ -546,7 +546,7 @@ Name | Type |
• **onClose**: *function*
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L37)*
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L37)*
#### Type declaration:
@@ -564,7 +564,7 @@ ___
• **onError**: *function*
*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L36)*
*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L36)*
#### Type declaration:
@@ -584,7 +584,7 @@ ___
• **onUpdate**: *function*
*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/connect/src/types.ts#L35)*
*Defined in [types.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/connect/src/types.ts#L35)*
#### Type declaration:

2
packages/connect/package.json
View File

@@ -60,7 +60,7 @@
"websocket": "^1.0.26"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@types/fetch-mock": "^6.0.3",
"@types/lodash": "4.14.104",

592
packages/contract-wrappers/docs/reference.md
View File

File diff suppressed because it is too large Load Diff

2
packages/contract-wrappers/package.json
View File

@@ -50,7 +50,7 @@
"devDependencies": {
"@0x/abi-gen": "^4.1.1",
"@0x/assert": "^2.1.4",
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/contracts-test-utils": "^3.1.14",
"@0x/coordinator-server": "^0.1.3",
"@0x/json-schemas": "^4.0.0",

908
packages/ethereum-types/docs/reference.md
View File

File diff suppressed because it is too large Load Diff

2
packages/ethereum-types/package.json
View File

@@ -32,7 +32,7 @@
},
"homepage": "https://github.com/0xProject/0x-monorepo/packages/ethereum-types/README.md",
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"make-promises-safe": "^1.1.0",
"shx": "^0.2.2",

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

@@ -24,7 +24,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/61e50a1cd/packages/json-schemas/src/schema_validator.ts#L15)*
*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/json-schemas/src/schema_validator.ts#L15)*
Instantiates a SchemaValidator instance
@@ -36,7 +36,7 @@ Instantiates a SchemaValidator instance
▸ **addSchema**(`schema`: `Schema`): *void*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/json-schemas/src/schema_validator.ts#L32)*
*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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
@@ -56,7 +56,7 @@ ___
▸ **isValid**(`instance`: any, `schema`: `Schema`): *boolean*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/json-schemas/src/schema_validator.ts#L57)*
*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/json-schemas/src/schema_validator.ts#L57)*
Check whether an instance properly adheres to a JSON schema
@@ -77,7 +77,7 @@ ___
▸ **validate**(`instance`: any, `schema`: `Schema`): *`ValidatorResult`*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/json-schemas/src/schema_validator.ts#L46)*
*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/json-schemas/src/schema_validator.ts#L46)*
Validate the JS object conforms to a specific JSON schema

2
packages/json-schemas/package.json
View File

@@ -48,7 +48,7 @@
"lodash.values": "^4.3.0"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@0x/utils": "^4.5.0",
"@types/lodash.foreach": "^4.5.3",

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

@@ -22,7 +22,7 @@
• **AccountLevels**: = "AccountLevels"
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L26)*
*Defined in [types.ts:26](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L26)*
___
@@ -30,7 +30,7 @@ ___
• **Arbitrage**: = "Arbitrage"
*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L28)*
*Defined in [types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L28)*
___
@@ -38,7 +38,7 @@ ___
• **DummyToken**: = "DummyToken"
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L23)*
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L23)*
___
@@ -46,7 +46,7 @@ ___
• **EtherDelta**: = "EtherDelta"
*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L27)*
*Defined in [types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L27)*
___
@@ -54,7 +54,7 @@ ___
• **Exchange**: = "Exchange"
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L21)*
___
@@ -62,7 +62,7 @@ ___
• **MultiSigWalletWithTimeLock**: = "MultiSigWalletWithTimeLock"
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L20)*
___
@@ -70,7 +70,7 @@ ___
• **MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress**: = "MultiSigWalletWithTimeLockExceptRemoveAuthorizedAddress"
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L25)*
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L25)*
___
@@ -78,7 +78,7 @@ ___
• **TokenRegistry**: = "TokenRegistry"
*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L19)*
___
@@ -86,7 +86,7 @@ ___
• **TokenTransferProxy**: = "TokenTransferProxy"
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L18)*
___
@@ -94,7 +94,7 @@ ___
• **WETH9**: = "WETH9"
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L24)*
___
@@ -102,7 +102,7 @@ ___
• **ZRXToken**: = "ZRXToken"
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L22)*
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L22)*
<hr />
@@ -129,7 +129,7 @@ ___
• **address**? : *undefined | string*
*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L4)*
*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L4)*
___
@@ -137,7 +137,7 @@ ___
• **decimals**: *`BigNumber`*
*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L7)*
*Defined in [types.ts:7](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L7)*
___
@@ -145,7 +145,7 @@ ___
• **ipfsHash**: *string*
*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L8)*
*Defined in [types.ts:8](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L8)*
___
@@ -153,7 +153,7 @@ ___
• **name**: *string*
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L5)*
___
@@ -161,7 +161,7 @@ ___
• **swarmHash**: *string*
*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L9)*
___
@@ -169,7 +169,7 @@ ___
• **symbol**: *string*
*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L6)*
*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L6)*
<hr />
@@ -192,7 +192,7 @@ ___
• **name**: *string*
*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L13)*
___
@@ -200,7 +200,7 @@ ___
• **symbol**: *string*
*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/migrations/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/migrations/src/types.ts#L14)*
<hr />

2
packages/migrations/package.json
View File

@@ -40,7 +40,7 @@
"license": "Apache-2.0",
"devDependencies": {
"@0x/dev-utils": "^2.3.1",
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@0x/types": "^2.4.1",
"@types/yargs": "^11.0.0",

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

@@ -21,7 +21,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L15)*
Get balance of assetData for userAddress
@@ -42,7 +42,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L22)*
Get the 0x asset proxy allowance of assetData for userAddress
@@ -87,7 +87,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)*
**Returns:** *void*
@@ -97,7 +97,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)*
**Parameters:**
@@ -114,7 +114,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)*
**Parameters:**
@@ -131,7 +131,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)*
**Parameters:**
@@ -148,7 +148,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)*
**Parameters:**
@@ -165,7 +165,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)*
**Parameters:**
@@ -183,7 +183,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)*
**Parameters:**
@@ -221,7 +221,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L15)*
Get the amount of the order's takerToken amount already filled
@@ -241,7 +241,7 @@ ___
▸ **getZRXAssetData**(): *string*
*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L22)*
**Returns:** *string*
@@ -251,7 +251,7 @@ ___
▸ **isOrderCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise<boolean>`*
*Defined in [abstract/abstract_order_filled_cancelled_fetcher.ts:21](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L21)*
Whether an order is cancelled
@@ -296,7 +296,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L11)*
**Returns:** *void*
@@ -306,7 +306,7 @@ ___
▸ **deleteFilledTakerAmount**(`orderHash`: string): *void*
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L8)*
**Parameters:**
@@ -322,7 +322,7 @@ ___
▸ **deleteIsCancelled**(`orderHash`: string): *void*
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L10)*
**Parameters:**
@@ -338,7 +338,7 @@ ___
▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise<BigNumber>`*
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L5)*
**Parameters:**
@@ -354,7 +354,7 @@ ___
▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise<boolean>`*
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L6)*
**Parameters:**
@@ -370,7 +370,7 @@ ___
▸ **getZRXAssetData**(): *string*
*Defined in [abstract/abstract_order_filled_cancelled_lazy_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L12)*
**Returns:** *string*
@@ -380,7 +380,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L7)*
**Parameters:**
@@ -397,7 +397,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L9)*
**Parameters:**
@@ -435,7 +435,7 @@ An exchange transfer simulator which simulates asset transfers exactly how the
\+ **new ExchangeTransferSimulator**(`store`: [AbstractBalanceAndProxyAllowanceLazyStore](#class-exchangetransfersimulator)*
*Defined in [exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/exchange_transfer_simulator.ts#L50)*
*Defined in [exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/exchange_transfer_simulator.ts#L50)*
Instantiate a ExchangeTransferSimulator
@@ -455,7 +455,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/61e50a1cd/packages/order-utils/src/exchange_transfer_simulator.ts#L70)*
*Defined in [exchange_transfer_simulator.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/exchange_transfer_simulator.ts#L70)*
Simulates transferFrom call performed by a proxy
@@ -498,7 +498,7 @@ Name | Type | Description |
\+ **new OrderStateUtils**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](#class-orderstateutils)*
*Defined in [order_state_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/order_state_utils.ts#L98)*
*Defined in [order_state_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_state_utils.ts#L98)*
Instantiate OrderStateUtils
@@ -519,7 +519,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/61e50a1cd/packages/order-utils/src/order_state_utils.ts#L192)*
*Defined in [order_state_utils.ts:192](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_state_utils.ts#L192)*
Get the max amount of the supplied order's takerAmount that could still be filled
@@ -540,7 +540,7 @@ ___
▸ **getOpenOrderRelevantStateAsync**(`signedOrder`: `SignedOrder`): *`Promise<OrderRelevantState>`*
*Defined in [order_state_utils.ts:162](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/order_state_utils.ts#L162)*
*Defined in [order_state_utils.ts:162](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_state_utils.ts#L162)*
Get state relevant to an order (i.e makerBalance, makerAllowance, filledTakerAssetAmount, etc...
@@ -560,7 +560,7 @@ ___
▸ **getOpenOrderStateAsync**(`signedOrder`: `SignedOrder`, `transactionHash?`: undefined | string): *`Promise<OrderState>`*
*Defined in [order_state_utils.ts:122](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/order_state_utils.ts#L122)*
*Defined in [order_state_utils.ts:122](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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
@@ -608,7 +608,7 @@ A utility class for validating orders
\+ **new OrderValidationUtils**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](#class-ordervalidationutils)*
*Defined in [order_validation_utils.ts:159](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/order_validation_utils.ts#L159)*
*Defined in [order_validation_utils.ts:159](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L159)*
Instantiate OrderValidationUtils
@@ -629,7 +629,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:236](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/order_validation_utils.ts#L236)*
*Defined in [order_validation_utils.ts:236](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L236)*
Validate a call to FillOrder and throw if it wouldn't succeed
@@ -652,7 +652,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/61e50a1cd/packages/order-utils/src/order_validation_utils.ts#L185)*
*Defined in [order_validation_utils.ts:185](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L185)*
Validate if the supplied order is fillable, and throw if it isn't
@@ -673,7 +673,7 @@ ___
▸ **isRoundingErrorFloor**(`numerator`: `BigNumber`, `denominator`: `BigNumber`, `target`: `BigNumber`): *boolean*
*Defined in [order_validation_utils.ts:34](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/order_validation_utils.ts#L34)*
*Defined in [order_validation_utils.ts:34](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/order_validation_utils.ts#L34)*
A Typescript implementation mirroring the implementation of isRoundingError in the
Exchange smart contract
@@ -694,7 +694,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/61e50a1cd/packages/order-utils/src/order_validation_utils.ts#L61)*
*Defined in [order_validation_utils.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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
@@ -717,7 +717,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/61e50a1cd/packages/order-utils/src/order_validation_utils.ts#L127)*
*Defined in [order_validation_utils.ts:127](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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.
@@ -758,7 +758,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/61e50a1cd/packages/order-utils/src/remaining_fillable_calculator.ts#L11)*
*Defined in [remaining_fillable_calculator.ts:11](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/remaining_fillable_calculator.ts#L11)*
**Parameters:**
@@ -779,7 +779,7 @@ Name | Type |
▸ **computeRemainingFillable**(): *`BigNumber`*
*Defined in [remaining_fillable_calculator.ts:30](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/remaining_fillable_calculator.ts#L30)*
*Defined in [remaining_fillable_calculator.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/remaining_fillable_calculator.ts#L30)*
**Returns:** *`BigNumber`*
@@ -820,7 +820,7 @@ Copy on read store for balances/proxyAllowances of tokens/accounts
\+ **new BalanceAndProxyAllowanceLazyStore**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](#class-balanceandproxyallowancelazystore)*
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:23](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L23)*
Instantiates a BalanceAndProxyAllowanceLazyStore
@@ -840,7 +840,7 @@ Instance of BalanceAndProxyAllowanceLazyStore
▸ **deleteAll**(): *void*
*Defined in [store/balance_and_proxy_allowance_lazy_store.ts:136](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L136)*
Delete all balances & allowances
@@ -852,7 +852,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/61e50a1cd/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/6dd77d5c8/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
@@ -871,7 +871,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L63)*
Clear the balance of an asset for a user
@@ -890,7 +890,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L106)*
Clear the 0x asset proxy allowance
@@ -909,7 +909,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L39)*
Get a users balance of an asset
@@ -928,7 +928,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L76)*
Get the 0x asset proxy allowance
@@ -947,7 +947,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L52)*
Set the balance of an asset for a user
@@ -967,7 +967,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/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L95)*
Set the 0x asset proxy allowance
@@ -1020,7 +1020,7 @@ Copy on read store for balances/proxyAllowances of tokens/accounts
\+ **new OrderFilledCancelledLazyStore**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](#class-orderfilledcancelledlazystore)*
*Defined in [store/order_filled_cancelled_lazy_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L19)*
Instantiate a OrderFilledCancelledLazyStore
@@ -1040,7 +1040,7 @@ An instance of OrderFilledCancelledLazyStore
▸ **deleteAll**(): *void*
*Defined in [store/order_filled_cancelled_lazy_store.ts:90](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L90)*
Clear all filled/cancelled state
@@ -1052,7 +1052,7 @@ ___
▸ **deleteAllFilled**(): *void*
*Defined in [store/order_filled_cancelled_lazy_store.ts:103](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L103)*
Clear all filled state
@@ -1064,7 +1064,7 @@ ___
▸ **deleteAllIsCancelled**(): *void*
*Defined in [store/order_filled_cancelled_lazy_store.ts:97](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L97)*
Clear all cancelled state
@@ -1076,7 +1076,7 @@ ___
▸ **deleteFilledTakerAmount**(`orderHash`: string): *void*
*Defined in [store/order_filled_cancelled_lazy_store.ts:55](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L55)*
Clear the filledTakerAssetAmount of an order
@@ -1094,7 +1094,7 @@ ___
▸ **deleteIsCancelled**(`orderHash`: string): *void*
*Defined in [store/order_filled_cancelled_lazy_store.ts:84](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L84)*
Clear whether the order has been cancelled if already set
@@ -1112,7 +1112,7 @@ ___
▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise<BigNumber>`*
*Defined in [store/order_filled_cancelled_lazy_store.ts:35](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L35)*
Get the filledTakerAssetAmount of an order
@@ -1132,7 +1132,7 @@ ___
▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise<boolean>`*
*Defined in [store/order_filled_cancelled_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L63)*
Check if an order has been cancelled
@@ -1152,7 +1152,7 @@ ___
▸ **getZRXAssetData**(): *string*
*Defined in [store/order_filled_cancelled_lazy_store.ts:109](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L109)*
Get the ZRX assetData
@@ -1164,7 +1164,7 @@ ___
▸ **setFilledTakerAmount**(`orderHash`: string, `filledTakerAmount`: `BigNumber`): *void*
*Defined in [store/order_filled_cancelled_lazy_store.ts:48](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L48)*
Set the filledTakerAssetAmount of an order
@@ -1183,7 +1183,7 @@ ___
▸ **setIsCancelled**(`orderHash`: string, `isCancelled`: boolean): *void*
*Defined in [store/order_filled_cancelled_lazy_store.ts:77](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/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/6dd77d5c8/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L77)*
Set whether an order has been cancelled or not
@@ -1213,7 +1213,7 @@ Name | Type | Description |
• **Maker**: = "maker"
*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L9)*
___
@@ -1221,7 +1221,7 @@ ___
• **Taker**: = "taker"
*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L10)*
<hr />
@@ -1240,7 +1240,7 @@ ___
• **Fee**: = "fee"
*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L15)*
*Defined in [types.ts:15](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L15)*
___
@@ -1248,7 +1248,7 @@ ___
• **Trade**: = "trade"
*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L14)*
<hr />
@@ -1267,7 +1267,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/61e50a1cd/packages/order-utils/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L5)*
___
@@ -1275,7 +1275,7 @@ ___
• **InvalidSignature**: = "INVALID_SIGNATURE"
*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L4)*
*Defined in [types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L4)*
<hr />
@@ -1303,7 +1303,7 @@ ___
• **expirationTimeSeconds**? : *`BigNumber`*
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L25)*
*Defined in [types.ts:25](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L25)*
___
@@ -1311,7 +1311,7 @@ ___
• **feeRecipientAddress**? : *undefined | string*
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L23)*
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L23)*
___
@@ -1319,7 +1319,7 @@ ___
• **makerFee**? : *`BigNumber`*
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L21)*
___
@@ -1327,7 +1327,7 @@ ___
• **salt**? : *`BigNumber`*
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L24)*
___
@@ -1335,7 +1335,7 @@ ___
• **senderAddress**? : *undefined | string*
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L20)*
___
@@ -1343,7 +1343,7 @@ ___
• **takerAddress**? : *undefined | string*
*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L19)*
___
@@ -1351,7 +1351,7 @@ ___
• **takerFee**? : *`BigNumber`*
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L22)*
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L22)*
<hr />
@@ -1379,7 +1379,7 @@ ___
• **feeOrdersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]*
*Defined in [types.ts:70](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L70)*
*Defined in [types.ts:70](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L70)*
___
@@ -1387,7 +1387,7 @@ ___
• **remainingFeeAmount**: *`BigNumber`*
*Defined in [types.ts:71](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L71)*
*Defined in [types.ts:71](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L71)*
___
@@ -1395,7 +1395,7 @@ ___
• **resultFeeOrders**: *`T`[]*
*Defined in [types.ts:69](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L69)*
*Defined in [types.ts:69](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L69)*
<hr />
@@ -1428,7 +1428,7 @@ Defaults to 0
• **remainingFillableFeeAmounts**? : *`BigNumber`[]*
*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L64)*
*Defined in [types.ts:64](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L64)*
___
@@ -1436,7 +1436,7 @@ ___
• **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]*
*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L63)*
*Defined in [types.ts:63](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L63)*
___
@@ -1444,7 +1444,7 @@ ___
• **slippageBufferAmount**? : *`BigNumber`*
*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L65)*
*Defined in [types.ts:65](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L65)*
<hr />
@@ -1473,7 +1473,7 @@ Defaults to 0
• **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]*
*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L36)*
*Defined in [types.ts:36](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L36)*
___
@@ -1481,7 +1481,7 @@ ___
• **slippageBufferAmount**? : *`BigNumber`*
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L37)*
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L37)*
<hr />
@@ -1510,7 +1510,7 @@ Defaults to 0
• **remainingFillableTakerAssetAmounts**? : *`BigNumber`[]*
*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L48)*
*Defined in [types.ts:48](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L48)*
___
@@ -1518,7 +1518,7 @@ ___
• **slippageBufferAmount**? : *`BigNumber`*
*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L49)*
*Defined in [types.ts:49](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L49)*
<hr />
@@ -1546,7 +1546,7 @@ ___
• **ordersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]*
*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L76)*
*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L76)*
___
@@ -1554,7 +1554,7 @@ ___
• **remainingFillAmount**: *`BigNumber`*
*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L77)*
*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L77)*
___
@@ -1562,7 +1562,7 @@ ___
• **resultOrders**: *`T`[]*
*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L75)*
*Defined in [types.ts:75](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L75)*
<hr />
@@ -1590,7 +1590,7 @@ ___
• **ordersRemainingFillableTakerAssetAmounts**: *`BigNumber`[]*
*Defined in [types.ts:82](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L82)*
*Defined in [types.ts:82](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L82)*
___
@@ -1598,7 +1598,7 @@ ___
• **remainingFillAmount**: *`BigNumber`*
*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L83)*
*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L83)*
___
@@ -1606,7 +1606,7 @@ ___
• **resultOrders**: *`T`[]*
*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-utils/src/types.ts#L81)*
*Defined in [types.ts:81](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-utils/src/types.ts#L81)*
<hr />

2
packages/order-utils/package.json
View File

@@ -39,7 +39,7 @@
"homepage": "https://github.com/0xProject/0x-monorepo/packages/order-utils/README.md",
"devDependencies": {
"@0x/dev-utils": "^2.3.1",
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@types/bn.js": "^4.11.0",
"@types/lodash": "4.14.104",

128
packages/order-watcher/docs/reference.md
View File

@@ -32,7 +32,7 @@ You can pass it by calling `this.addERC20Token(address)` or `this.addERC721Token
\+ **new CollisionResistanceAbiDecoder**(`erc20Abi`: `ContractAbi`, `erc721Abi`: `ContractAbi`, `abis`: `ContractAbi`[]): *[CollisionResistanceAbiDecoder](#class-collisionresistanceabidecoder)*
*Defined in [order_watcher/collision_resistant_abi_decoder.ts:22](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/collision_resistant_abi_decoder.ts#L22)*
*Defined in [order_watcher/collision_resistant_abi_decoder.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/collision_resistant_abi_decoder.ts#L22)*
**Parameters:**
@@ -50,7 +50,7 @@ Name | Type |
▸ **addERC20Token**(`address`: string): *void*
*Defined in [order_watcher/collision_resistant_abi_decoder.ts:44](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/collision_resistant_abi_decoder.ts#L44)*
*Defined in [order_watcher/collision_resistant_abi_decoder.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/collision_resistant_abi_decoder.ts#L44)*
**Parameters:**
@@ -66,7 +66,7 @@ ___
▸ **addERC721Token**(`address`: string): *void*
*Defined in [order_watcher/collision_resistant_abi_decoder.ts:51](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/collision_resistant_abi_decoder.ts#L51)*
*Defined in [order_watcher/collision_resistant_abi_decoder.ts:51](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/collision_resistant_abi_decoder.ts#L51)*
**Parameters:**
@@ -82,7 +82,7 @@ ___
▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs<ArgsType>` | `RawLog`*
*Defined in [order_watcher/collision_resistant_abi_decoder.ts:28](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/collision_resistant_abi_decoder.ts#L28)*
*Defined in [order_watcher/collision_resistant_abi_decoder.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/collision_resistant_abi_decoder.ts#L28)*
**Type parameters:**
@@ -124,7 +124,7 @@ Name | Type |
\+ **new DependentOrderHashesTracker**(`zrxTokenAddress`: string): *[DependentOrderHashesTracker](#class-dependentorderhashestracker)*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:35](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L35)*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:35](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L35)*
**Parameters:**
@@ -140,7 +140,7 @@ Name | Type |
▸ **addToDependentOrderHashes**(`signedOrder`: `SignedOrder`): *void*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:69](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L69)*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:69](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L69)*
**Parameters:**
@@ -156,7 +156,7 @@ ___
▸ **getDependentOrderHashesByAssetDataByMaker**(`makerAddress`: string, `assetData`: string): *string[]*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:61](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L61)*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L61)*
**Parameters:**
@@ -173,7 +173,7 @@ ___
▸ **getDependentOrderHashesByERC721ByMaker**(`makerAddress`: string, `tokenAddress`: string): *string[]*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:39](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L39)*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L39)*
**Parameters:**
@@ -190,7 +190,7 @@ ___
▸ **getDependentOrderHashesByMaker**(`makerAddress`: string): *string[]*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:57](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L57)*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:57](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L57)*
**Parameters:**
@@ -206,7 +206,7 @@ ___
▸ **removeFromDependentOrderHashes**(`signedOrder`: `SignedOrder`): *void*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:74](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L74)*
*Defined in [order_watcher/dependent_order_hashes_tracker.ts:74](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/dependent_order_hashes_tracker.ts#L74)*
**Parameters:**
@@ -244,7 +244,7 @@ depth.
\+ **new EventWatcher**(`supportedProvider`: `SupportedProvider`, `pollingIntervalIfExistsMs`: undefined | number, `isVerbose`: boolean): *[EventWatcher](#class-eventwatcher)*
*Defined in [order_watcher/event_watcher.ts:28](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/event_watcher.ts#L28)*
*Defined in [order_watcher/event_watcher.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/event_watcher.ts#L28)*
**Parameters:**
@@ -262,7 +262,7 @@ Name | Type |
▸ **subscribe**(`callback`: [EventWatcherCallback](#eventwatchercallback)): *void*
*Defined in [order_watcher/event_watcher.ts:43](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/event_watcher.ts#L43)*
*Defined in [order_watcher/event_watcher.ts:43](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/event_watcher.ts#L43)*
**Parameters:**
@@ -278,7 +278,7 @@ ___
▸ **unsubscribe**(): *void*
*Defined in [order_watcher/event_watcher.ts:50](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/event_watcher.ts#L50)*
*Defined in [order_watcher/event_watcher.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/event_watcher.ts#L50)*
**Returns:** *void*
@@ -312,7 +312,7 @@ It stores them in a min heap by expiration time and checks for expired ones ever
\+ **new ExpirationWatcher**(`expirationMarginIfExistsMs?`: undefined | number, `orderExpirationCheckingIntervalIfExistsMs?`: undefined | number): *[ExpirationWatcher](#class-expirationwatcher)*
*Defined in [order_watcher/expiration_watcher.ts:20](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/expiration_watcher.ts#L20)*
*Defined in [order_watcher/expiration_watcher.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/expiration_watcher.ts#L20)*
**Parameters:**
@@ -329,7 +329,7 @@ Name | Type |
▸ **addOrder**(`orderHash`: string, `expirationUnixTimestampMs`: `BigNumber`): *void*
*Defined in [order_watcher/expiration_watcher.ts:57](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/expiration_watcher.ts#L57)*
*Defined in [order_watcher/expiration_watcher.ts:57](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/expiration_watcher.ts#L57)*
**Parameters:**
@@ -346,7 +346,7 @@ ___
▸ **removeOrder**(`orderHash`: string): *void*
*Defined in [order_watcher/expiration_watcher.ts:61](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/expiration_watcher.ts#L61)*
*Defined in [order_watcher/expiration_watcher.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/expiration_watcher.ts#L61)*
**Parameters:**
@@ -362,7 +362,7 @@ ___
▸ **subscribe**(`callback`: function): *void*
*Defined in [order_watcher/expiration_watcher.ts:40](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/expiration_watcher.ts#L40)*
*Defined in [order_watcher/expiration_watcher.ts:40](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/expiration_watcher.ts#L40)*
**Parameters:**
@@ -384,7 +384,7 @@ ___
▸ **unsubscribe**(): *void*
*Defined in [order_watcher/expiration_watcher.ts:50](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/expiration_watcher.ts#L50)*
*Defined in [order_watcher/expiration_watcher.ts:50](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/expiration_watcher.ts#L50)*
**Returns:** *void*
@@ -421,7 +421,7 @@ the order should be deemed invalid.
\+ **new OrderWatcher**(`supportedProvider`: `SupportedProvider`, `networkId`: number, `contractAddresses?`: `ContractAddresses`, `partialConfig`: `Partial<OrderWatcherConfig>`): *[OrderWatcher](#class-orderwatcher)*
*Defined in [order_watcher/order_watcher.ts:98](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/order_watcher.ts#L98)*
*Defined in [order_watcher/order_watcher.ts:98](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/order_watcher.ts#L98)*
Instantiate a new OrderWatcher
@@ -442,7 +442,7 @@ Name | Type | Default | Description |
▸ **addOrderAsync**(`signedOrder`: `SignedOrder`): *`Promise<void>`*
*Defined in [order_watcher/order_watcher.ts:160](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/order_watcher.ts#L160)*
*Defined in [order_watcher/order_watcher.ts:160](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/order_watcher.ts#L160)*
Add an order to the orderWatcher. Before the order is added, it's
signature is verified.
@@ -461,7 +461,7 @@ ___
▸ **getStats**(): *`Stats`*
*Defined in [order_watcher/order_watcher.ts:231](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/order_watcher.ts#L231)*
*Defined in [order_watcher/order_watcher.ts:231](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/order_watcher.ts#L231)*
Gets statistics of the OrderWatcher Instance.
@@ -473,7 +473,7 @@ ___
▸ **removeOrder**(`orderHash`: string): *void*
*Defined in [order_watcher/order_watcher.ts:178](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/order_watcher.ts#L178)*
*Defined in [order_watcher/order_watcher.ts:178](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/order_watcher.ts#L178)*
Removes an order from the orderWatcher
@@ -491,7 +491,7 @@ ___
▸ **subscribe**(`callback`: [OnOrderStateChangeCallback](#onorderstatechangecallback)): *void*
*Defined in [order_watcher/order_watcher.ts:195](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/order_watcher.ts#L195)*
*Defined in [order_watcher/order_watcher.ts:195](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/order_watcher.ts#L195)*
Starts an orderWatcher subscription. The callback will be called every time a watched order's
backing blockchain state has changed. This is a call-to-action for the caller to re-validate the order.
@@ -510,7 +510,7 @@ ___
▸ **unsubscribe**(): *void*
*Defined in [order_watcher/order_watcher.ts:217](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/order_watcher.ts#L217)*
*Defined in [order_watcher/order_watcher.ts:217](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/order_watcher.ts#L217)*
Ends an orderWatcher subscription.
@@ -541,7 +541,7 @@ Ends an orderWatcher subscription.
\+ **new OrderWatcherWebSocketServer**(`supportedProvider`: `SupportedProvider`, `networkId`: number, `contractAddresses?`: `ContractAddresses`, `orderWatcherConfig?`: `Partial<OrderWatcherConfig>`): *[OrderWatcherWebSocketServer](#class-orderwatcherwebsocketserver)*
*Defined in [order_watcher/order_watcher_web_socket_server.ts:42](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/order_watcher_web_socket_server.ts#L42)*
*Defined in [order_watcher/order_watcher_web_socket_server.ts:42](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/order_watcher_web_socket_server.ts#L42)*
Instantiate a new WebSocket server which provides OrderWatcher functionality
@param supportedProvider Web3 provider to use for JSON RPC calls.
@@ -568,7 +568,7 @@ Name | Type |
▸ **start**(): *void*
*Defined in [order_watcher/order_watcher_web_socket_server.ts:92](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/order_watcher_web_socket_server.ts#L92)*
*Defined in [order_watcher/order_watcher_web_socket_server.ts:92](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/order_watcher_web_socket_server.ts#L92)*
Activates the WebSocket server by subscribing to the OrderWatcher and
starting the WebSocket's HTTP server
@@ -581,7 +581,7 @@ ___
▸ **stop**(): *void*
*Defined in [order_watcher/order_watcher_web_socket_server.ts:107](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/order_watcher/order_watcher_web_socket_server.ts#L107)*
*Defined in [order_watcher/order_watcher_web_socket_server.ts:107](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/order_watcher/order_watcher_web_socket_server.ts#L107)*
Deactivates the WebSocket server by stopping the HTTP server from accepting
new connections and unsubscribing from the OrderWatcher
@@ -606,7 +606,7 @@ new connections and unsubscribing from the OrderWatcher
• **NoAbiDecoder**: = "NO_ABI_DECODER"
*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L30)*
*Defined in [types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L30)*
___
@@ -614,7 +614,7 @@ ___
• **WethNotInTokenRegistry**: = "WETH_NOT_IN_TOKEN_REGISTRY"
*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L32)*
*Defined in [types.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L32)*
___
@@ -622,7 +622,7 @@ ___
• **ZrxNotInTokenRegistry**: = "ZRX_NOT_IN_TOKEN_REGISTRY"
*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L31)*
*Defined in [types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L31)*
<hr />
@@ -641,7 +641,7 @@ ___
• **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT"
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L5)*
___
@@ -649,7 +649,7 @@ ___
• **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND"
*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L6)*
*Defined in [types.ts:6](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L6)*
<hr />
@@ -670,7 +670,7 @@ ___
• **AddOrder**: = "ADD_ORDER"
*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L38)*
___
@@ -678,7 +678,7 @@ ___
• **GetStats**: = "GET_STATS"
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L37)*
*Defined in [types.ts:37](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L37)*
___
@@ -686,7 +686,7 @@ ___
• **RemoveOrder**: = "REMOVE_ORDER"
*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L39)*
*Defined in [types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L39)*
___
@@ -694,7 +694,7 @@ ___
• **Update**: = "UPDATE"
*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L41)*
*Defined in [types.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L41)*
<hr />
@@ -761,7 +761,7 @@ ___
• **id**: *number*
*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L52)*
*Defined in [types.ts:52](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L52)*
___
@@ -769,7 +769,7 @@ ___
• **jsonrpc**: *string*
*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L53)*
*Defined in [types.ts:53](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L53)*
___
@@ -777,7 +777,7 @@ ___
• **method**: *[AddOrder](#addorder)*
*Defined in [types.ts:54](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L54)*
*Defined in [types.ts:54](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L54)*
___
@@ -785,7 +785,7 @@ ___
• **params**: *object*
*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L55)*
*Defined in [types.ts:55](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L55)*
#### Type declaration:
@@ -812,7 +812,7 @@ ___
• **error**: *[JSONRPCError](#interface-jsonrpcerror)*
*Defined in [types.ts:86](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L86)*
*Defined in [types.ts:86](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L86)*
___
@@ -820,7 +820,7 @@ ___
• **id**: *number | null*
*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L83)*
*Defined in [types.ts:83](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L83)*
___
@@ -828,7 +828,7 @@ ___
• **jsonrpc**: *string*
*Defined in [types.ts:84](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L84)*
*Defined in [types.ts:84](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L84)*
___
@@ -836,7 +836,7 @@ ___
• **method**: *null*
*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L85)*
*Defined in [types.ts:85](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L85)*
<hr />
@@ -860,7 +860,7 @@ ___
• **id**: *number*
*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L66)*
*Defined in [types.ts:66](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L66)*
___
@@ -868,7 +868,7 @@ ___
• **jsonrpc**: *string*
*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L67)*
*Defined in [types.ts:67](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L67)*
___
@@ -876,7 +876,7 @@ ___
• **method**: *[GetStats](#getstats)*
*Defined in [types.ts:68](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L68)*
*Defined in [types.ts:68](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L68)*
<hr />
@@ -898,7 +898,7 @@ ___
• **orderCount**: *number*
*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L96)*
*Defined in [types.ts:96](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L96)*
<hr />
@@ -922,7 +922,7 @@ ___
• **code**: *number*
*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L90)*
*Defined in [types.ts:90](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L90)*
___
@@ -930,7 +930,7 @@ ___
• **data**? : *string | object*
*Defined in [types.ts:92](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L92)*
*Defined in [types.ts:92](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L92)*
___
@@ -938,7 +938,7 @@ ___
• **message**: *string*
*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L91)*
*Defined in [types.ts:91](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L91)*
<hr />
@@ -971,7 +971,7 @@ isVerbose: Weather the order watcher should be verbose. Default=true.
• **cleanupJobIntervalMs**: *number*
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L23)*
*Defined in [types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L23)*
___
@@ -979,7 +979,7 @@ ___
• **eventPollingIntervalMs**: *number*
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L21)*
___
@@ -987,7 +987,7 @@ ___
• **expirationMarginMs**: *number*
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L22)*
*Defined in [types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L22)*
___
@@ -995,7 +995,7 @@ ___
• **isVerbose**: *boolean*
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L24)*
___
@@ -1003,7 +1003,7 @@ ___
• **orderExpirationCheckingIntervalMs**: *number*
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L20)*
<hr />
@@ -1028,7 +1028,7 @@ ___
• **id**: *number*
*Defined in [types.ts:59](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L59)*
*Defined in [types.ts:59](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L59)*
___
@@ -1036,7 +1036,7 @@ ___
• **jsonrpc**: *string*
*Defined in [types.ts:60](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L60)*
*Defined in [types.ts:60](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L60)*
___
@@ -1044,7 +1044,7 @@ ___
• **method**: *[RemoveOrder](#removeorder)*
*Defined in [types.ts:61](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L61)*
*Defined in [types.ts:61](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L61)*
___
@@ -1052,7 +1052,7 @@ ___
• **params**: *object*
*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L62)*
*Defined in [types.ts:62](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L62)*
#### Type declaration:
@@ -1079,7 +1079,7 @@ ___
• **id**: *number*
*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L76)*
*Defined in [types.ts:76](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L76)*
___
@@ -1087,7 +1087,7 @@ ___
• **jsonrpc**: *string*
*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L77)*
*Defined in [types.ts:77](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L77)*
___
@@ -1095,7 +1095,7 @@ ___
• **method**: *[OrderWatcherMethod](#enumeration-orderwatchermethod)*
*Defined in [types.ts:78](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L78)*
*Defined in [types.ts:78](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L78)*
___
@@ -1103,7 +1103,7 @@ ___
• **result**: *`OrderState` | [GetStatsResult](#interface-getstatsresult) | undefined*
*Defined in [types.ts:79](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/order-watcher/src/types.ts#L79)*
*Defined in [types.ts:79](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/order-watcher/src/types.ts#L79)*
<hr />

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

@@ -25,7 +25,7 @@ to artifact files.
\+ **new Compiler**(`opts?`: `CompilerOptions`): *[Compiler](#class-compiler)*
*Defined in [compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/compiler.ts#L94)*
*Defined in [compiler.ts:94](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/compiler.ts#L94)*
Instantiates a new instance of the Compiler class.
@@ -45,7 +45,7 @@ An instance of the Compiler class.
▸ **compileAsync**(): *`Promise<void>`*
*Defined in [compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/compiler.ts#L132)*
*Defined in [compiler.ts:132](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/compiler.ts#L132)*
Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`.
@@ -57,7 +57,7 @@ ___
▸ **getCompilerOutputsAsync**(): *`Promise<StandardOutput[]>`*
*Defined in [compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/compiler.ts#L145)*
*Defined in [compiler.ts:145](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/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:
@@ -74,7 +74,7 @@ ___
▸ **watchAsync**(): *`Promise<void>`*
*Defined in [compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/compiler.ts#L149)*
*Defined in [compiler.ts:149](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/compiler.ts#L149)*
**Returns:** *`Promise<void>`*
@@ -109,7 +109,7 @@ ___
\+ **new CompilationError**(`errorsCount`: number): *[CompilationError](#class-compilationerror)*
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L39)*
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L39)*
**Parameters:**
@@ -125,7 +125,7 @@ Name | Type |
• **errorsCount**: *number*
*Defined in [utils/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L38)*
*Defined in [utils/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L38)*
___
@@ -165,7 +165,7 @@ ___
• **typeName**: *string* = "CompilationError"
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L39)*
*Defined in [utils/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L39)*
___
@@ -194,7 +194,7 @@ Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typed
• **Constructor**: = "constructor"
*Defined in [utils/types.ts:3](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L3)*
*Defined in [utils/types.ts:3](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L3)*
___
@@ -202,7 +202,7 @@ ___
• **Event**: = "event"
*Defined in [utils/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L4)*
*Defined in [utils/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L4)*
___
@@ -210,7 +210,7 @@ ___
• **Fallback**: = "fallback"
*Defined in [utils/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L5)*
*Defined in [utils/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L5)*
___
@@ -218,7 +218,7 @@ ___
• **Function**: = "function"
*Defined in [utils/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L2)*
*Defined in [utils/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L2)*
<hr />
@@ -266,7 +266,7 @@ ___
• **solcVersionRange**: *string*
*Defined in [utils/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L21)*
*Defined in [utils/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L21)*
___
@@ -274,7 +274,7 @@ ___
• **sourceHash**: *`Buffer`*
*Defined in [utils/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L22)*
*Defined in [utils/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L22)*
___
@@ -282,7 +282,7 @@ ___
• **sourceTreeHash**: *`Buffer`*
*Defined in [utils/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L23)*
*Defined in [utils/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L23)*
<hr />
@@ -321,7 +321,7 @@ ___
• **address**? : *undefined | string*
*Defined in [utils/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L27)*
*Defined in [utils/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L27)*
___
@@ -329,7 +329,7 @@ ___
• **decimals**: *number*
*Defined in [utils/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L30)*
*Defined in [utils/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L30)*
___
@@ -337,7 +337,7 @@ ___
• **ipfsHash**: *string*
*Defined in [utils/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L31)*
*Defined in [utils/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L31)*
___
@@ -345,7 +345,7 @@ ___
• **name**: *string*
*Defined in [utils/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L28)*
*Defined in [utils/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L28)*
___
@@ -353,7 +353,7 @@ ___
• **swarmHash**: *string*
*Defined in [utils/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L32)*
*Defined in [utils/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L32)*
___
@@ -361,7 +361,7 @@ ___
• **symbol**: *string*
*Defined in [utils/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-compiler/src/utils/types.ts#L29)*
*Defined in [utils/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-compiler/src/utils/types.ts#L29)*
<hr />

2
packages/sol-compiler/package.json
View File

@@ -46,7 +46,7 @@
"homepage": "https://github.com/0xProject/0x-monorepo/packages/sol-compiler/README.md",
"devDependencies": {
"@0x/dev-utils": "^2.3.1",
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@types/mkdirp": "^0.5.2",
"@types/mocha": "^5.2.7",

8
packages/sol-coverage/docs/reference.md
View File

@@ -32,7 +32,7 @@ It's used to compute your code coverage while running solidity tests.
*Overrides void*
*Defined in [coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
*Defined in [coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L44)*
Instantiates a CoverageSubprovider instance
@@ -154,7 +154,7 @@ ___
▸ **writeCoverageAsync**(): *`Promise<void>`*
*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
*Defined in [coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L78)*
Write the test coverage results to a file in Istanbul format.
@@ -185,7 +185,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/61e50a1cd/packages/sol-coverage/src/coverage_subprovider.ts#L28)*
*Defined in [coverage_subprovider.ts:28](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L28)*
___
@@ -193,7 +193,7 @@ ___
• **isVerbose**: *boolean*
*Defined in [coverage_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-coverage/src/coverage_subprovider.ts#L27)*
*Defined in [coverage_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-coverage/src/coverage_subprovider.ts#L27)*
<hr />

2
packages/sol-coverage/package.json
View File

@@ -42,7 +42,7 @@
"web3-provider-engine": "14.0.6"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@types/node": "*",
"@types/web3-provider-engine": "^14.0.0",

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

@@ -32,7 +32,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/61e50a1cd/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
*Defined in [profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-profiler/src/profiler_subprovider.ts#L30)*
Instantiates a ProfilerSubprovider instance
@@ -154,7 +154,7 @@ ___
▸ **writeProfilerOutputAsync**(): *`Promise<void>`*
*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/61e50a1cd/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
*Defined in [profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-profiler/src/profiler_subprovider.ts#L104)*
Write the test profiler results to a file in Istanbul format.

2
packages/sol-profiler/package.json
View File

@@ -42,7 +42,7 @@
"web3-provider-engine": "14.0.6"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@types/node": "*",
"@types/web3-provider-engine": "^14.0.0",

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

@@ -31,7 +31,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/61e50a1cd/packages/sol-trace/src/revert_trace_subprovider.ts#L27)*
*Defined in [revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/sol-trace/src/revert_trace_subprovider.ts#L27)*
Instantiates a RevertTraceSubprovider instance

2
packages/sol-trace/package.json
View File

@@ -43,7 +43,7 @@
"web3-provider-engine": "14.0.6"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@types/loglevel": "^1.5.3",
"@types/node": "*",

296
packages/subproviders/docs/reference.md
View File

File diff suppressed because it is too large Load Diff

2
packages/subproviders/package.json
View File

@@ -54,7 +54,7 @@
"web3-provider-engine": "14.0.6"
},
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@types/bip39": "^2.4.0",
"@types/bn.js": "^4.11.0",

290
packages/web3-wrapper/docs/reference.md
View File

File diff suppressed because it is too large Load Diff

2
packages/web3-wrapper/package.json
View File

@@ -39,7 +39,7 @@
},
"homepage": "https://github.com/0xProject/0x-monorepo/packages/web3-wrapper/README.md",
"devDependencies": {
"@0x/ts-doc-gen": "^0.0.6",
"@0x/ts-doc-gen": "^0.0.7",
"@0x/tslint-config": "^3.0.1",
"@types/lodash": "4.14.104",
"@types/mocha": "^5.2.7",