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

Final update of reference docs

Browse Source
This commit is contained in:
fabioberger
2019-09-03 12:30:05 +02:00
parent 6292c0703c
commit 3264bd223d
14 changed files with 3789 additions and 3789 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -7,7 +7,7 @@
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L14)*
*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L14)*
**Parameters:**
@@ -37,7 +37,7 @@ Name | Type |
• **assetProxyOwner**: *string*
*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L9)*
*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L9)*
___
@@ -45,7 +45,7 @@ ___
• **coordinator**: *string*
*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L14)*
*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L14)*
___
@@ -53,7 +53,7 @@ ___
• **coordinatorRegistry**: *string*
*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L13)*
*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L13)*
___
@@ -61,7 +61,7 @@ ___
• **devUtils**: *string*
*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L18)*
*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L18)*
___
@@ -69,7 +69,7 @@ ___
• **dutchAuction**: *string*
*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L12)*
*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L12)*
___
@@ -77,7 +77,7 @@ ___
• **erc1155Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L17)*
*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L17)*
___
@@ -85,7 +85,7 @@ ___
• **erc20Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L4)*
*Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L4)*
___
@@ -93,7 +93,7 @@ ___
• **erc721Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L5)*
*Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L5)*
___
@@ -101,7 +101,7 @@ ___
• **etherToken**: *string*
*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L7)*
*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L7)*
___
@@ -109,7 +109,7 @@ ___
• **exchange**: *string*
*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L8)*
*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L8)*
___
@@ -117,7 +117,7 @@ ___
• **forwarder**: *string*
*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L10)*
*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L10)*
___
@@ -125,7 +125,7 @@ ___
• **multiAssetProxy**: *string*
*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L15)*
*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L15)*
___
@@ -133,7 +133,7 @@ ___
• **orderValidator**: *string*
*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L11)*
*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L11)*
___
@@ -141,7 +141,7 @@ ___
• **staticCallProxy**: *string*
*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L16)*
*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L16)*
___
@@ -149,7 +149,7 @@ ___
• **zrxToken**: *string*
*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L6)*
*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L6)*
<hr />
@@ -198,7 +198,7 @@ ___
• **isEIP1193**: *boolean*
*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L73)*
*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L73)*
## Methods
@@ -206,7 +206,7 @@ ___
▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this*
*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L75)*
*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L75)*
**Parameters:**
@@ -230,7 +230,7 @@ ___
▸ **send**(`method`: string, `params?`: any[]): *`Promise<any>`*
*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L74)*
*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L74)*
**Parameters:**
@@ -268,7 +268,7 @@ Name | Type |
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L324)*
*Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L324)*
___
@@ -276,7 +276,7 @@ ___
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L325)*
*Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L325)*
___
@@ -284,7 +284,7 @@ ___
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L323)*
*Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L323)*
___
@@ -292,7 +292,7 @@ ___
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L322)*
*Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L322)*
<hr />
@@ -305,7 +305,7 @@ ___
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L330)*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L330)*
___
@@ -313,7 +313,7 @@ ___
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L329)*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L329)*
<hr />
@@ -326,7 +326,7 @@ ___
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L337)*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L337)*
___
@@ -334,7 +334,7 @@ ___
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L335)*
*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L335)*
___
@@ -342,7 +342,7 @@ ___
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L336)*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L336)*
___
@@ -350,7 +350,7 @@ ___
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L334)*
*Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L334)*
<hr />
@@ -403,7 +403,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[data](#optional-data)*
*Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L387)*
*Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L387)*
___
@@ -411,7 +411,7 @@ ___
• **from**: *string*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L392)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L392)*
___
@@ -421,7 +421,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[gas](#optional-gas)*
*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L385)*
*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L385)*
___
@@ -431,7 +431,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[gasPrice](#optional-gasprice)*
*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L386)*
*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L386)*
___
@@ -441,7 +441,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[nonce](#optional-nonce)*
*Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L388)*
*Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L388)*
___
@@ -451,7 +451,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[to](#optional-to)*
*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L383)*
*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L383)*
___
@@ -461,7 +461,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)*
*Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L384)*
*Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L384)*
<hr />
@@ -476,7 +476,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[data](#optional-data)*
*Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L387)*
*Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L387)*
___
@@ -486,7 +486,7 @@ ___
*Inherited from [TxData](_ethereum_types_src_index_.txdata.md).[from](#from)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L392)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L392)*
___
@@ -496,7 +496,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[gas](#optional-gas)*
*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L385)*
*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L385)*
___
@@ -506,7 +506,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[gasPrice](#optional-gasprice)*
*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L386)*
*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L386)*
___
@@ -516,7 +516,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[nonce](#optional-nonce)*
*Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L388)*
*Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L388)*
___
@@ -526,7 +526,7 @@ ___
*Inherited from [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[to](#optional-to)*
*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L383)*
*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L383)*
___
@@ -536,7 +536,7 @@ ___
*Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)*
*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L434)*
*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L434)*
<hr />
@@ -553,7 +553,7 @@ This interface allowed sending synchonous requests, support for which was later
▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)*
*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L45)*
*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L45)*
**Parameters:**
@@ -569,7 +569,7 @@ ___
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L44)*
*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L44)*
**Parameters:**
@@ -595,7 +595,7 @@ before the first attempts to conform to EIP1193
▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L54)*
*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L54)*
**Parameters:**
@@ -621,7 +621,7 @@ however it does not conform entirely.
▸ **send**(`method`: string, `params?`: any[]): *`Promise<any>`*
*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L63)*
*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L63)*
**Parameters:**
@@ -647,7 +647,7 @@ add here
• **isMetaMask**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L31)*
*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L31)*
___
@@ -655,7 +655,7 @@ ___
• **isParity**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L32)*
*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L32)*
___
@@ -663,7 +663,7 @@ ___
• **isZeroExProvider**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L30)*
*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L30)*
## Methods
@@ -671,7 +671,7 @@ ___
▸ **enable**(): *`Promise<void>`*
*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L34)*
*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L34)*
**Returns:** *`Promise<void>`*
@@ -681,7 +681,7 @@ ___
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L35)*
*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L35)*
**Parameters:**
@@ -698,7 +698,7 @@ ___
▸ **stop**(): *void*
*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L33)*
*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L33)*
**Returns:** *void*
@@ -713,7 +713,7 @@ ___
▸ **runMigrationsAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `TxData`): *`Promise<ContractAddresses>`*
*Defined in [migrations/src/migration.ts:20](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/migrations/src/migration.ts#L20)*
*Defined in [migrations/src/migration.ts:20](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/migrations/src/migration.ts#L20)*
Creates and deploys all the contracts that are required for the latest
version of the 0x protocol.
@@ -735,7 +735,7 @@ ___
▸ **runMigrationsOnceAsync**(`provider`: `Web3ProviderEngine`, `txDefaults`: `TxData`): *`Promise<ContractAddresses>`*
*Defined in [migrations/src/migration.ts:296](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/migrations/src/migration.ts#L296)*
*Defined in [migrations/src/migration.ts:296](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/migrations/src/migration.ts#L296)*
Exactly like runMigrationsAsync but will only run the migrations the first
time it is called. Any subsequent calls will return the cached contract
@@ -763,7 +763,7 @@ The addresses of the contracts that were deployed.
▸ **getContractAddressesForNetworkOrThrow**(`networkId`: [NetworkId](#enumeration-networkid)): *[ContractAddresses](#interface-contractaddresses)*
*Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/contract-addresses/src/index.ts#L128)*
*Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/contract-addresses/src/index.ts#L128)*
Used to get addresses of contracts that have been deployed to either the
Ethereum mainnet or a supported testnet. Throws if there are no known
@@ -801,7 +801,7 @@ given networkId.
Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"*
*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L70)*
*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L70)*
Interface for providers that conform to EIP 1193
Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md
@@ -818,7 +818,7 @@ ___
Ƭ **JSONRPCErrorCallback**: *function*
*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L3)*
*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L3)*
#### Type declaration:
@@ -847,7 +847,7 @@ ___
Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)*
*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L9)*
*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L9)*
Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library
Read more about Providers in the guides section of the 0x docs.
@@ -862,7 +862,7 @@ ___
Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)*
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/140cf4d37/packages/ethereum-types/src/index.ts#L11)*
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/6292c0703/packages/ethereum-types/src/index.ts#L11)*
<hr />