crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
protocol/packages/contract-wrappers/docs/reference.mdx
xianny cb5f9ba97d Updated CHANGELOGS & MD docs
2019-11-17 18:03:13 -05:00

10867 lines
308 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Class: CoordinatorRegistryContract
## Constructors
\+ **new CoordinatorRegistryContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:465](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L465)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | CoordinatorRegistryContract.deployedBytecode |
**Returns:** *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:208](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L208)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:201](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L201)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getCoordinatorEndpoint
▸ **getCoordinatorEndpoint**(`coordinatorOperator`: string): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:227](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L227)*
Gets the endpoint for a Coordinator.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`coordinatorOperator` | string | Operator of the Coordinator endpoint. |
**Returns:** *`ContractFunctionObj<string>`*
coordinatorEndpoint Endpoint of the Coordinator as a string.
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:195](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L195)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getLogsAsync
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:449](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L449)*
Gets historical logs without creating a subscription
**Type parameters:**
▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`eventName` | [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents) | The CoordinatorRegistry contract event you would like to subscribe to. |
`blockRange` | `BlockRange` | Block range to get logs from. |
`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` |
**Returns:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
Array of logs that match the parameters
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L215)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### setCoordinatorEndpoint
▸ **setCoordinatorEndpoint**(`coordinatorEndpoint`: string): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:283](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L283)*
Called by a Coordinator operator to set the endpoint of their Coordinator.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`coordinatorEndpoint` | string | Endpoint of the Coordinator as a string. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### subscribe
▸ **subscribe**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:407](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L407)*
Subscribe to an event type emitted by the CoordinatorRegistry contract.
**Type parameters:**
▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)*
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`eventName` | [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents) | - | The CoordinatorRegistry contract event you would like to subscribe to. |
`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` |
`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed |
`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) |
`blockPollingIntervalMs?` | undefined \| number | - | - |
**Returns:** *string*
Subscription token used later to unsubscribe
___
### unsubscribe
▸ **unsubscribe**(`subscriptionToken`: string): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L432)*
Cancel a subscription
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`subscriptionToken` | string | Subscription token returned by `subscribe()` |
**Returns:** *void*
___
### unsubscribeAll
▸ **unsubscribeAll**(): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:438](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L438)*
Cancels all existing subscriptions
**Returns:** *void*
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L131)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<CoordinatorRegistryContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:89](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L89)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<CoordinatorRegistryContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<CoordinatorRegistryContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L58)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<CoordinatorRegistryContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: DevUtilsContract
## Constructors
\+ **new DevUtilsContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DevUtilsContract](#class-devutilscontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3929](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3929)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | DevUtilsContract.deployedBytecode |
**Returns:** *[DevUtilsContract](#class-devutilscontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### decodeAssetProxyDispatchError
▸ **decodeAssetProxyDispatchError**(`encoded`: string): *`ContractFunctionObj<[number, string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1516](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1516)*
Decompose an ABI-encoded AssetProxyDispatchError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[number, string, string]>`*
errorCode The error code.orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched.
___
### decodeAssetProxyExistsError
▸ **decodeAssetProxyExistsError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1564](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1564)*
Decompose an ABI-encoded AssetProxyExistsError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[string, string]>`*
assetProxyId Id of asset proxy.assetProxyAddress The address of the asset proxy.
___
### decodeAssetProxyId
▸ **decodeAssetProxyId**(`assetData`: string): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1610](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1610)*
Decode AssetProxy identifier
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetProxy-compliant asset data describing an ERC-20, ERC- 721, ERC1155, or MultiAsset asset. |
**Returns:** *`ContractFunctionObj<string>`*
The AssetProxy identifier
___
### decodeAssetProxyTransferError
▸ **decodeAssetProxyTransferError**(`encoded`: string): *`ContractFunctionObj<[string, string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1653](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1653)*
Decompose an ABI-encoded AssetProxyTransferError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[string, string, string]>`*
orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched.errorData ABI-encoded revert data from the asset proxy.
___
### decodeEIP1271SignatureError
▸ **decodeEIP1271SignatureError**(`encoded`: string): *`ContractFunctionObj<[string, string, string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1701](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1701)*
Decompose an ABI-encoded SignatureValidatorError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[string, string, string, string]>`*
signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract.
___
### decodeERC1155AssetData
▸ **decodeERC1155AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, BigNumber[], BigNumber[], string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1750](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1750)*
Decode ERC-1155 asset data from the format described in the AssetProxy contract specification.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetProxy-compliant asset data describing an ERC-1155 set of assets. |
**Returns:** *`ContractFunctionObj<[string, string, BigNumber[], BigNumber[], string]>`*
The ERC-1155 AssetProxy identifier, the address of the ERC-1155 contract hosting the assets, an array of the identifiers of the assets to be traded, an array of asset amounts to be traded, and callback data. Each element of the arrays corresponds to the same-indexed element of the other array. Return values specified as &#x60;memory&#x60; are returned as pointers to locations within the memory of the input parameter &#x60;assetData&#x60;.
___
### decodeERC20AssetData
▸ **decodeERC20AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1802](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1802)*
Decode ERC-20 asset data from the format described in the AssetProxy contract specification.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetProxy-compliant asset data describing an ERC-20 asset. |
**Returns:** *`ContractFunctionObj<[string, string]>`*
The AssetProxy identifier, and the address of the ERC-20 contract hosting this asset.
___
### decodeERC721AssetData
▸ **decodeERC721AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, BigNumber]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1848](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1848)*
Decode ERC-721 asset data from the format described in the AssetProxy contract specification.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetProxy-compliant asset data describing an ERC-721 asset. |
**Returns:** *`ContractFunctionObj<[string, string, BigNumber]>`*
The ERC-721 AssetProxy identifier, the address of the ERC-721 contract hosting this asset, and the identifier of the specific asset to be traded.
___
### decodeExchangeInvalidContextError
▸ **decodeExchangeInvalidContextError**(`encoded`: string): *`ContractFunctionObj<[number, string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1896](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1896)*
Decompose an ABI-encoded OrderStatusError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[number, string, string]>`*
errorCode Error code that corresponds to invalid maker, taker, or sender.orderHash The order hash.contextAddress The maker, taker, or sender address
___
### decodeFillError
▸ **decodeFillError**(`encoded`: string): *`ContractFunctionObj<[number, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1945](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1945)*
Decompose an ABI-encoded FillError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[number, string]>`*
errorCode The error code.orderHash The order hash.
___
### decodeIncompleteFillError
▸ **decodeIncompleteFillError**(`encoded`: string): *`ContractFunctionObj<[number, BigNumber, BigNumber]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1988](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1988)*
Decompose an ABI-encoded IncompleteFillError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[number, BigNumber, BigNumber]>`*
orderHash Hash of the order being filled.
___
### decodeMultiAssetData
▸ **decodeMultiAssetData**(`assetData`: string): *`ContractFunctionObj<[string, BigNumber[], string[]]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2036](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2036)*
Decode multi-asset data from the format described in the AssetProxy contract specification.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetProxy-compliant data describing a multi-asset basket. |
**Returns:** *`ContractFunctionObj<[string, BigNumber[], string[]]>`*
The Multi-Asset AssetProxy identifier, an array of the amounts of the assets to be traded, and an array of the AssetProxy-compliant data describing each asset to be traded. Each element of the arrays corresponds to the same-indexed element of the other array.
___
### decodeNegativeSpreadError
▸ **decodeNegativeSpreadError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2084](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2084)*
Decompose an ABI-encoded NegativeSpreadError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[string, string]>`*
leftOrderHash Hash of the left order being matched.rightOrderHash Hash of the right order being matched.
___
### decodeOrderEpochError
▸ **decodeOrderEpochError**(`encoded`: string): *`ContractFunctionObj<[string, string, BigNumber]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2129](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2129)*
Decompose an ABI-encoded OrderEpochError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[string, string, BigNumber]>`*
makerAddress The order maker.orderSenderAddress The order sender.currentEpoch The current epoch for the maker.
___
### decodeOrderStatusError
▸ **decodeOrderStatusError**(`encoded`: string): *`ContractFunctionObj<[string, number]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2177)*
Decompose an ABI-encoded OrderStatusError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[string, number]>`*
orderHash The order hash.orderStatus The order status.
___
### decodeSignatureError
▸ **decodeSignatureError**(`encoded`: string): *`ContractFunctionObj<[number, string, string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2222](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2222)*
Decompose an ABI-encoded SignatureError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[number, string, string, string]>`*
errorCode The error code.signerAddress The expected signer of the hash.signature The full signature.
___
### decodeSignatureValidatorNotApprovedError
▸ **decodeSignatureValidatorNotApprovedError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2268](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2268)*
Decompose an ABI-encoded SignatureValidatorNotApprovedError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[string, string]>`*
signerAddress The expected signer of the hash.validatorAddress The expected validator.
___
### decodeSignatureWalletError
▸ **decodeSignatureWalletError**(`encoded`: string): *`ContractFunctionObj<[string, string, string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2316](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2316)*
Decompose an ABI-encoded SignatureWalletError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[string, string, string, string]>`*
errorCode The error code.signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract.
___
### decodeStaticCallAssetData
▸ **decodeStaticCallAssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2365](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2365)*
Decode StaticCall asset data from the format described in the AssetProxy contract specification.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | AssetProxy-compliant asset data describing a StaticCall asset |
**Returns:** *`ContractFunctionObj<[string, string, string, string]>`*
The StaticCall AssetProxy identifier, the target address of the StaticCAll, the data to be passed to the target address, and the expected Keccak-256 hash of the static call return data.
___
### decodeTransactionError
▸ **decodeTransactionError**(`encoded`: string): *`ContractFunctionObj<[number, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2413](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2413)*
Decompose an ABI-encoded TransactionError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[number, string]>`*
errorCode The error code.transactionHash Hash of the transaction.
___
### decodeTransactionExecutionError
▸ **decodeTransactionExecutionError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2458)*
Decompose an ABI-encoded TransactionExecutionError.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`encoded` | string | ABI-encoded revert error. |
**Returns:** *`ContractFunctionObj<[string, string]>`*
transactionHash Hash of the transaction.errorData Error thrown by exeucteTransaction().
___
### decodeZeroExTransactionData
▸ **decodeZeroExTransactionData**(`transactionData`: string): *`ContractFunctionObj<[string, Array<object>, BigNumber[], string[]]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2505](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2505)*
Decodes the call data for an Exchange contract method call.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`transactionData` | string | ABI-encoded calldata for an Exchange contract method call. |
**Returns:** *`ContractFunctionObj<[string, Array<object>, BigNumber[], string[]]>`*
The name of the function called, and the parameters it was given. For single-order fills and cancels, the arrays will have just one element.
___
### encodeERC1155AssetData
▸ **encodeERC1155AssetData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2628)*
Encode ERC-1155 asset data into the format described in the AssetProxy contract specification.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`tokenAddress` | string | The address of the ERC-1155 contract hosting the asset(s) to be traded. |
`tokenIds` | `BigNumber`[] | The identifiers of the specific assets to be traded. |
`tokenValues` | `BigNumber`[] | The amounts of each asset to be traded. |
`callbackData` | string | Data to be passed to receiving contracts when a transfer is performed. |
**Returns:** *`ContractFunctionObj<string>`*
AssetProxy-compliant asset data describing the set of assets.
___
### encodeERC20AssetData
▸ **encodeERC20AssetData**(`tokenAddress`: string): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2686](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2686)*
Encode ERC-20 asset data into the format described in the AssetProxy contract specification.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`tokenAddress` | string | The address of the ERC-20 contract hosting the asset to be traded. |
**Returns:** *`ContractFunctionObj<string>`*
AssetProxy-compliant data describing the asset.
___
### encodeERC721AssetData
▸ **encodeERC721AssetData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2735](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2735)*
Encode ERC-721 asset data into the format described in the AssetProxy specification.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`tokenAddress` | string | The address of the ERC-721 contract hosting the asset to be traded. |
`tokenId` | `BigNumber` | The identifier of the specific asset to be traded. |
**Returns:** *`ContractFunctionObj<string>`*
AssetProxy-compliant asset data describing the asset.
___
### encodeMultiAssetData
▸ **encodeMultiAssetData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2787](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2787)*
Encode data for multiple assets, per the AssetProxy contract specification.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`amounts` | `BigNumber`[] | The amounts of each asset to be traded. |
`nestedAssetData` | string[] | AssetProxy-compliant data describing each asset to be traded. |
**Returns:** *`ContractFunctionObj<string>`*
AssetProxy-compliant data describing the set of assets.
___
### encodeStaticCallAssetData
▸ **encodeStaticCallAssetData**(`staticCallTargetAddress`: string, `staticCallData`: string, `expectedReturnDataHash`: string): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2841](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2841)*
Encode StaticCall asset data into the format described in the AssetProxy contract specification.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`staticCallTargetAddress` | string | Target address of StaticCall. |
`staticCallData` | string | Data that will be passed to staticCallTargetAddress in the StaticCall. |
`expectedReturnDataHash` | string | Expected Keccak-256 hash of the StaticCall return data. |
**Returns:** *`ContractFunctionObj<string>`*
AssetProxy-compliant asset data describing the set of assets.
___
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1497](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1497)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1490](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1490)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getAssetProxyAllowance
▸ **getAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2899](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2899)*
Returns the number of asset(s) (described by assetData) that the corresponding AssetProxy contract is authorized to spend. When the asset data contains multiple assets (eg for Multi-Asset), the return value indicates how many complete "baskets" of those assets may be spent by all of the corresponding AssetProxy contracts.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`ownerAddress` | string | Owner of the assets specified by assetData. |
`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. |
**Returns:** *`ContractFunctionObj<BigNumber>`*
Number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend.
___
### getBalance
▸ **getBalance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2961](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2961)*
Returns the owner's balance of the assets(s) specified in assetData. When the asset data contains multiple assets (eg in ERC1155 or Multi-Asset), the return value indicates how many complete "baskets" of those assets are owned by owner.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`ownerAddress` | string | Owner of the assets specified by assetData. |
`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. |
**Returns:** *`ContractFunctionObj<BigNumber>`*
Number of assets (or asset baskets) held by owner.
___
### getBalanceAndAssetProxyAllowance
▸ **getBalanceAndAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj<[BigNumber, BigNumber]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3023](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3023)*
Calls getBalance() and getAllowance() for assetData.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`ownerAddress` | string | Owner of the assets specified by assetData. |
`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. |
**Returns:** *`ContractFunctionObj<[BigNumber, BigNumber]>`*
Number of assets (or asset baskets) held by owner, and number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend.
___
### getBatchAssetProxyAllowances
▸ **getBatchAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj<BigNumber[]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3091](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3091)*
Calls getAssetProxyAllowance() for each element of assetData.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`ownerAddress` | string | Owner of the assets specified by assetData. |
`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. |
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
An array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input.
___
### getBatchBalances
▸ **getBatchBalances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj<BigNumber[]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3153)*
Calls getBalance() for each element of assetData.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`ownerAddress` | string | Owner of the assets specified by assetData. |
`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. |
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
Array of asset balances from getBalance(), with each element corresponding to the same-indexed element in the assetData input.
___
### getBatchBalancesAndAssetProxyAllowances
▸ **getBatchBalancesAndAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3215)*
Calls getBatchBalances() and getBatchAllowances() for each element of assetData.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`ownerAddress` | string | Owner of the assets specified by assetData. |
`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. |
**Returns:** *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`*
An array of asset balances from getBalance(), and an array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input.
___
### getEthBalances
▸ **getEthBalances**(`addresses`: string[]): *`ContractFunctionObj<BigNumber[]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3281](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3281)*
Batch fetches ETH balances
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`addresses` | string[] | Array of addresses. |
**Returns:** *`ContractFunctionObj<BigNumber[]>`*
Array of ETH balances.
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1484)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getOrderRelevantState
▸ **getOrderRelevantState**(`order`: object, `signature`: string): *`ContractFunctionObj<[object, BigNumber, boolean]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3337)*
Fetches all order-relevant information needed to validate if the supplied order is fillable.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | object | The order structure. |
`signature` | string | Signature provided by maker that proves the order's authenticity. `0x01` can always be provided if the signature does not need to be validated. |
**Returns:** *`ContractFunctionObj<[object, BigNumber, boolean]>`*
The orderInfo (hash, status, and &#x60;takerAssetAmount&#x60; already filled for the given order), fillableTakerAssetAmount (amount of the order&#x27;s &#x60;takerAssetAmount&#x60; that is fillable given all on-chain state), and isValidSignature (validity of the provided signature). NOTE: If the &#x60;takerAssetData&#x60; encodes data for multiple assets, &#x60;fillableTakerAssetAmount&#x60; will represent a &quot;scaled&quot; amount, meaning it must be multiplied by all the individual asset amounts within the &#x60;takerAssetData&#x60; to get the final amount of each asset that can be filled.
___
### getOrderRelevantStates
▸ **getOrderRelevantStates**(`orders`: `Array<object>`, `signatures`: string[]): *`ContractFunctionObj<[Array<object>, BigNumber[], boolean[]]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3433)*
Fetches all order-relevant information needed to validate if the supplied orders are fillable.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of order structures. |
`signatures` | string[] | Array of signatures provided by makers that prove the authenticity of the orders. `0x01` can always be provided if a signature does not need to be validated. |
**Returns:** *`ContractFunctionObj<[Array<object>, BigNumber[], boolean[]]>`*
The ordersInfo (array of the hash, status, and &#x60;takerAssetAmount&#x60; already filled for each order), fillableTakerAssetAmounts (array of amounts for each order&#x27;s &#x60;takerAssetAmount&#x60; that is fillable given all on-chain state), and isValidSignature (array containing the validity of each provided signature). NOTE: If the &#x60;takerAssetData&#x60; encodes data for multiple assets, each element of &#x60;fillableTakerAssetAmounts&#x60; will represent a &quot;scaled&quot; amount, meaning it must be multiplied by all the individual asset amounts within the &#x60;takerAssetData&#x60; to get the final amount of each asset that can be filled.
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1504](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1504)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getSimulatedOrderTransferResults
▸ **getSimulatedOrderTransferResults**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *`ContractTxFunctionObj<number>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3537](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3537)*
Simulates all of the transfers within an order and returns the index of the first failed transfer.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | object | The order to simulate transfers for. |
`takerAddress` | string | The address of the taker that will fill the order. |
`takerAssetFillAmount` | `BigNumber` | The amount of takerAsset that the taker wished to fill. |
**Returns:** *`ContractTxFunctionObj<number>`*
The index of the first failed transfer (or 4 if all transfers are successful).
___
### getSimulatedOrdersTransferResults
▸ **getSimulatedOrdersTransferResults**(`orders`: `Array<object>`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[]): *`ContractTxFunctionObj<number[]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3687](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3687)*
Simulates all of the transfers for each given order and returns the indices of each first failed transfer.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of orders to individually simulate transfers for. |
`takerAddresses` | string[] | Array of addresses of takers that will fill each order. |
`takerAssetFillAmounts` | `BigNumber`[] | Array of amounts of takerAsset that will be filled for each order. |
**Returns:** *`ContractTxFunctionObj<number[]>`*
The indices of the first failed transfer (or 4 if all transfers are successful) for each order.
___
### getTransferableAssetAmount
▸ **getTransferableAssetAmount**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3835](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3835)*
Gets the amount of an asset transferable by the owner.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`ownerAddress` | string | Address of the owner of the asset. |
`assetData` | string | Description of tokens, per the AssetProxy contract specification. |
**Returns:** *`ContractFunctionObj<BigNumber>`*
The amount of the asset tranferable by the owner. NOTE: If the &#x60;assetData&#x60; encodes data for multiple assets, the &#x60;transferableAssetAmount&#x60; will represent the amount of times the entire &#x60;assetData&#x60; can be transferred. To calculate the total individual transferable amounts, this scaled &#x60;transferableAmount&#x60; must be multiplied by the individual asset amounts located within the &#x60;assetData&#x60;.
___
### revertIfInvalidAssetData
▸ **revertIfInvalidAssetData**(`assetData`: string): *`ContractFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3890](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3890)*
**Parameters:**
Name | Type |
------ | ------ |
`assetData` | string |
**Returns:** *`ContractFunctionObj<void>`*
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:125](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L125)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise<DevUtilsContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L78)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`_exchange` | string |
**Returns:** *`Promise<DevUtilsContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise<DevUtilsContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L45)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`_exchange` | string |
**Returns:** *`Promise<DevUtilsContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: DummyERC20TokenContract
## Constructors
\+ **new DummyERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC20TokenContract](#class-dummyerc20tokencontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1690)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | DummyERC20TokenContract.deployedBytecode |
**Returns:** *[DummyERC20TokenContract](#class-dummyerc20tokencontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### MAX_MINT_AMOUNT
▸ **MAX_MINT_AMOUNT**(): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:503](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L503)*
**Returns:** *`ContractFunctionObj<BigNumber>`*
___
### allowance
▸ **allowance**(`_owner`: string, `_spender`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:550](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L550)*
**Parameters:**
Name | Type |
------ | ------ |
`_owner` | string |
`_spender` | string |
**Returns:** *`ContractFunctionObj<BigNumber>`*
___
### approve
▸ **approve**(`_spender`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:611](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L611)*
`msg.sender` approves `_spender` to spend `_value` tokens
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_spender` | string | The address of the account able to transfer the tokens |
`_value` | `BigNumber` | The amount of wei to be approved for transfer |
**Returns:** *`ContractTxFunctionObj<boolean>`*
Always true if the call has enough gas to complete execution
___
### balanceOf
▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:735](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L735)*
Query the balance of owner
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_owner` | string | The address from which the balance will be retrieved |
**Returns:** *`ContractFunctionObj<BigNumber>`*
Balance of owner
___
### decimals
▸ **decimals**(): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:785](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L785)*
**Returns:** *`ContractFunctionObj<BigNumber>`*
___
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:489](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L489)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:482](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L482)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:476](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L476)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getLogsAsync
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1674](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1674)*
Gets historical logs without creating a subscription
**Type parameters:**
▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`eventName` | [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents) | The DummyERC20Token contract event you would like to subscribe to. |
`blockRange` | `BlockRange` | Block range to get logs from. |
`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` |
**Returns:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
Array of logs that match the parameters
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:496](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L496)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### mint
▸ **mint**(`_value`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:836](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L836)*
Mints new tokens for sender
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_value` | `BigNumber` | Amount of tokens to mint |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### name
▸ **name**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:942](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L942)*
**Returns:** *`ContractFunctionObj<string>`*
___
### owner
▸ **owner**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:989](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L989)*
**Returns:** *`ContractFunctionObj<string>`*
___
### setBalance
▸ **setBalance**(`_target`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1041](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1041)*
Sets the balance of target address
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_target` | string | Address or which balance will be updated |
`_value` | `BigNumber` | New balance of target address |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### subscribe
▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1632](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1632)*
Subscribe to an event type emitted by the DummyERC20Token contract.
**Type parameters:**
▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)*
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`eventName` | [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents) | - | The DummyERC20Token contract event you would like to subscribe to. |
`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` |
`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed |
`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) |
`blockPollingIntervalMs?` | undefined \| number | - | - |
**Returns:** *string*
Subscription token used later to unsubscribe
___
### symbol
▸ **symbol**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1160](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1160)*
**Returns:** *`ContractFunctionObj<string>`*
___
### totalSupply
▸ **totalSupply**(): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1211](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1211)*
Query total supply of token
**Returns:** *`ContractFunctionObj<BigNumber>`*
Total supply of token
___
### transfer
▸ **transfer**(`_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1264](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1264)*
send `value` token to `to` from `msg.sender`
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_to` | string | The address of the recipient |
`_value` | `BigNumber` | The amount of token to be transferred |
**Returns:** *`ContractTxFunctionObj<boolean>`*
True if transfer was successful
___
### transferFrom
▸ **transferFrom**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1390)*
ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. See https://github.com/ethereum/EIPs/issues/717
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_from` | string | Address to transfer from. |
`_to` | string | Address to transfer to. |
`_value` | `BigNumber` | Amount to transfer. |
**Returns:** *`ContractTxFunctionObj<boolean>`*
Success of transfer.
___
### transferOwnership
▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1514](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1514)*
**Parameters:**
Name | Type |
------ | ------ |
`newOwner` | string |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### unsubscribe
▸ **unsubscribe**(`subscriptionToken`: string): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1657](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1657)*
Cancel a subscription
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`subscriptionToken` | string | Subscription token returned by `subscribe()` |
**Returns:** *void*
___
### unsubscribeAll
▸ **unsubscribeAll**(): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1663](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1663)*
Cancels all existing subscriptions
**Returns:** *void*
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:155](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L155)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise<DummyERC20TokenContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L105)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`_name` | string |
`_symbol` | string |
`_decimals` | `BigNumber` |
`_totalSupply` | `BigNumber` |
**Returns:** *`Promise<DummyERC20TokenContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise<DummyERC20TokenContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L66)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`_name` | string |
`_symbol` | string |
`_decimals` | `BigNumber` |
`_totalSupply` | `BigNumber` |
**Returns:** *`Promise<DummyERC20TokenContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: DummyERC721TokenContract
## Constructors
\+ **new DummyERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC721TokenContract](#class-dummyerc721tokencontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1990](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1990)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | DummyERC721TokenContract.deployedBytecode |
**Returns:** *[DummyERC721TokenContract](#class-dummyerc721tokencontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### approve
▸ **approve**(`_approved`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:562](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L562)*
The zero address indicates there is no approved address.
Throws unless `msg.sender` is the current NFT owner, or an authorized
operator of the current owner.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_approved` | string | The new approved NFT controller |
`_tokenId` | `BigNumber` | The NFT to approve |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### balanceOf
▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:687](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L687)*
NFTs assigned to the zero address are considered invalid, and this
function throws for queries about the zero address.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_owner` | string | An address for whom to query the balance |
**Returns:** *`ContractFunctionObj<BigNumber>`*
The number of NFTs owned by &#x60;_owner&#x60;, possibly zero
___
### burn
▸ **burn**(`_owner`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:743](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L743)*
Function to burn a token
Reverts if the given token ID doesn't exist or not called by contract owner
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_owner` | string | Owner of token with given token ID |
`_tokenId` | `BigNumber` | ID of the token to be burned by the msg.sender |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:541](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L541)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:534](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L534)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getApproved
▸ **getApproved**(`_tokenId`: `BigNumber`): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:867](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L867)*
Throws if `_tokenId` is not a valid NFT.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_tokenId` | `BigNumber` | The NFT to find the approved address for |
**Returns:** *`ContractFunctionObj<string>`*
The approved address for this NFT, or the zero address if there is none
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:528](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L528)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getLogsAsync
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1974](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1974)*
Gets historical logs without creating a subscription
**Type parameters:**
▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`eventName` | [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents) | The DummyERC721Token contract event you would like to subscribe to. |
`blockRange` | `BlockRange` | Block range to get logs from. |
`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` |
**Returns:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
Array of logs that match the parameters
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:548](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L548)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### isApprovedForAll
▸ **isApprovedForAll**(`_owner`: string, `_operator`: string): *`ContractFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:915](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L915)*
**Parameters:**
Name | Type |
------ | ------ |
`_owner` | string |
`_operator` | string |
**Returns:** *`ContractFunctionObj<boolean>`*
___
### mint
▸ **mint**(`_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:976](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L976)*
Function to mint a new token
Reverts if the given token ID already exists
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_to` | string | Address of the beneficiary that will own the minted token |
`_tokenId` | `BigNumber` | ID of the token to be minted by the msg.sender |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### name
▸ **name**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1086](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1086)*
**Returns:** *`ContractFunctionObj<string>`*
___
### owner
▸ **owner**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1133)*
**Returns:** *`ContractFunctionObj<string>`*
___
### ownerOf
▸ **ownerOf**(`_tokenId`: `BigNumber`): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1186](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1186)*
NFTs assigned to zero address are considered invalid, and queries
about them do throw.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_tokenId` | `BigNumber` | The identifier for an NFT |
**Returns:** *`ContractFunctionObj<string>`*
The address of the owner of the NFT
___
### safeTransferFrom1
▸ **safeTransferFrom1**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1241](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1241)*
This works identically to the other function with an extra data parameter,
except this function just sets data to "".
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_from` | string | The current owner of the NFT |
`_to` | string | The new owner |
`_tokenId` | `BigNumber` | The NFT to transfer |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### safeTransferFrom2
▸ **safeTransferFrom2**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1377](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1377)*
Throws unless `msg.sender` is the current owner, an authorized
operator, or the approved address for this NFT. Throws if `_from` is
not the current owner. Throws if `_to` is the zero address. Throws if
`_tokenId` is not a valid NFT. When transfer is complete, this function
checks if `_to` is a smart contract (code size > 0). If so, it calls
`onERC721Received` on `_to` and throws if the return value is not
`bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_from` | string | The current owner of the NFT |
`_to` | string | The new owner |
`_tokenId` | `BigNumber` | The NFT to transfer |
`_data` | string | Additional data with no specified format, sent in call to `_to` |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### setApprovalForAll
▸ **setApprovalForAll**(`_operator`: string, `_approved`: boolean): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1515](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1515)*
Emits the ApprovalForAll event. The contract MUST allow
multiple operators per owner.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_operator` | string | Address to add to the set of authorized operators |
`_approved` | boolean | True if the operator is approved, false to revoke approval |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### subscribe
▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1932](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1932)*
Subscribe to an event type emitted by the DummyERC721Token contract.
**Type parameters:**
▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)*
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`eventName` | [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents) | - | The DummyERC721Token contract event you would like to subscribe to. |
`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` |
`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed |
`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) |
`blockPollingIntervalMs?` | undefined \| number | - | - |
**Returns:** *string*
Subscription token used later to unsubscribe
___
### symbol
▸ **symbol**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1634](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1634)*
**Returns:** *`ContractFunctionObj<string>`*
___
### transferFrom
▸ **transferFrom**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1690)*
Throws unless `msg.sender` is the current owner, an authorized
operator, or the approved address for this NFT. Throws if `_from` is
not the current owner. Throws if `_to` is the zero address. Throws if
`_tokenId` is not a valid NFT.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_from` | string | The current owner of the NFT |
`_to` | string | The new owner |
`_tokenId` | `BigNumber` | The NFT to transfer |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### transferOwnership
▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1814](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1814)*
**Parameters:**
Name | Type |
------ | ------ |
`newOwner` | string |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### unsubscribe
▸ **unsubscribe**(`subscriptionToken`: string): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1957](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1957)*
Cancel a subscription
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`subscriptionToken` | string | Subscription token returned by `subscribe()` |
**Returns:** *void*
___
### unsubscribeAll
▸ **unsubscribeAll**(): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1963](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1963)*
Cancels all existing subscriptions
**Returns:** *void*
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:159](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L159)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise<DummyERC721TokenContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L111)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`_name` | string |
`_symbol` | string |
**Returns:** *`Promise<DummyERC721TokenContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise<DummyERC721TokenContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:76](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L76)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`_name` | string |
`_symbol` | string |
**Returns:** *`Promise<DummyERC721TokenContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: ERC20TokenContract
## Constructors
\+ **new ERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC20TokenContract](#class-erc20tokencontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:951](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L951)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | ERC20TokenContract.deployedBytecode |
**Returns:** *[ERC20TokenContract](#class-erc20tokencontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### allowance
▸ **allowance**(`_owner`: string, `_spender`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:828](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L828)*
**Parameters:**
Name | Type |
------ | ------ |
`_owner` | string |
`_spender` | string |
**Returns:** *`ContractFunctionObj<BigNumber>`*
___
### approve
▸ **approve**(`_spender`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:347](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L347)*
`msg.sender` approves `_spender` to spend `_value` tokens
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_spender` | string | The address of the account able to transfer the tokens |
`_value` | `BigNumber` | The amount of wei to be approved for transfer |
**Returns:** *`ContractTxFunctionObj<boolean>`*
Always true if the call has enough gas to complete execution
___
### balanceOf
▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:653](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L653)*
Query the balance of owner
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_owner` | string | The address from which the balance will be retrieved |
**Returns:** *`ContractFunctionObj<BigNumber>`*
Balance of owner
___
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:327](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L327)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:320](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L320)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:314](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L314)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getLogsAsync
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:935](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L935)*
Gets historical logs without creating a subscription
**Type parameters:**
▪ **ArgsType**: *[ERC20TokenEventArgs](#erc20tokeneventargs)*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`eventName` | [ERC20TokenEvents](#enumeration-erc20tokenevents) | The ERC20Token contract event you would like to subscribe to. |
`blockRange` | `BlockRange` | Block range to get logs from. |
`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` |
**Returns:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
Array of logs that match the parameters
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:334](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L334)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### subscribe
▸ **subscribe**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:893](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L893)*
Subscribe to an event type emitted by the ERC20Token contract.
**Type parameters:**
▪ **ArgsType**: *[ERC20TokenEventArgs](#erc20tokeneventargs)*
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`eventName` | [ERC20TokenEvents](#enumeration-erc20tokenevents) | - | The ERC20Token contract event you would like to subscribe to. |
`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` |
`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed |
`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) |
`blockPollingIntervalMs?` | undefined \| number | - | - |
**Returns:** *string*
Subscription token used later to unsubscribe
___
### totalSupply
▸ **totalSupply**(): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:470](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L470)*
Query total supply of token
**Returns:** *`ContractFunctionObj<BigNumber>`*
Total supply of token
___
### transfer
▸ **transfer**(`_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L709)*
send `value` token to `to` from `msg.sender`
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_to` | string | The address of the recipient |
`_value` | `BigNumber` | The amount of token to be transferred |
**Returns:** *`ContractTxFunctionObj<boolean>`*
True if transfer was successful
___
### transferFrom
▸ **transferFrom**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:524](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L524)*
send `value` token to `to` from `from` on the condition it is approved by `from`
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_from` | string | The address of the sender |
`_to` | string | The address of the recipient |
`_value` | `BigNumber` | The amount of token to be transferred |
**Returns:** *`ContractTxFunctionObj<boolean>`*
True if transfer was successful
___
### unsubscribe
▸ **unsubscribe**(`subscriptionToken`: string): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:918](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L918)*
Cancel a subscription
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`subscriptionToken` | string | Subscription token returned by `subscribe()` |
**Returns:** *void*
___
### unsubscribeAll
▸ **unsubscribeAll**(): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:924](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L924)*
Cancels all existing subscriptions
**Returns:** *void*
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L133)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC20TokenContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L91)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<ERC20TokenContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC20TokenContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L66)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<ERC20TokenContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: ERC721TokenContract
## Constructors
\+ **new ERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC721TokenContract](#class-erc721tokencontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1376](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1376)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | ERC721TokenContract.deployedBytecode |
**Returns:** *[ERC721TokenContract](#class-erc721tokencontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### approve
▸ **approve**(`_approved`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:438](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L438)*
The zero address indicates there is no approved address.
Throws unless `msg.sender` is the current NFT owner, or an authorized
operator of the current owner.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_approved` | string | The new approved NFT controller |
`_tokenId` | `BigNumber` | The NFT to approve |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### balanceOf
▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:563](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L563)*
NFTs assigned to the zero address are considered invalid, and this
function throws for queries about the zero address.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_owner` | string | An address for whom to query the balance |
**Returns:** *`ContractFunctionObj<BigNumber>`*
The number of NFTs owned by &#x60;_owner&#x60;, possibly zero
___
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L417)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:410](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L410)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getApproved
▸ **getApproved**(`_tokenId`: `BigNumber`): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L618)*
Throws if `_tokenId` is not a valid NFT.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_tokenId` | `BigNumber` | The NFT to find the approved address for |
**Returns:** *`ContractFunctionObj<string>`*
The approved address for this NFT, or the zero address if there is none
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:404](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L404)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getLogsAsync
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1360](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1360)*
Gets historical logs without creating a subscription
**Type parameters:**
▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`eventName` | [ERC721TokenEvents](#enumeration-erc721tokenevents) | The ERC721Token contract event you would like to subscribe to. |
`blockRange` | `BlockRange` | Block range to get logs from. |
`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` |
**Returns:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
Array of logs that match the parameters
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:424](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L424)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### isApprovedForAll
▸ **isApprovedForAll**(`_owner`: string, `_operator`: string): *`ContractFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:666](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L666)*
**Parameters:**
Name | Type |
------ | ------ |
`_owner` | string |
`_operator` | string |
**Returns:** *`ContractFunctionObj<boolean>`*
___
### ownerOf
▸ **ownerOf**(`_tokenId`: `BigNumber`): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:727](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L727)*
NFTs assigned to zero address are considered invalid, and queries
about them do throw.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_tokenId` | `BigNumber` | The identifier for an NFT |
**Returns:** *`ContractFunctionObj<string>`*
The address of the owner of the NFT
___
### safeTransferFrom1
▸ **safeTransferFrom1**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:782](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L782)*
This works identically to the other function with an extra data parameter,
except this function just sets data to "".
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_from` | string | The current owner of the NFT |
`_to` | string | The new owner |
`_tokenId` | `BigNumber` | The NFT to transfer |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### safeTransferFrom2
▸ **safeTransferFrom2**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:918](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L918)*
Throws unless `msg.sender` is the current owner, an authorized
operator, or the approved address for this NFT. Throws if `_from` is
not the current owner. Throws if `_to` is the zero address. Throws if
`_tokenId` is not a valid NFT. When transfer is complete, this function
checks if `_to` is a smart contract (code size > 0). If so, it calls
`onERC721Received` on `_to` and throws if the return value is not
`bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_from` | string | The current owner of the NFT |
`_to` | string | The new owner |
`_tokenId` | `BigNumber` | The NFT to transfer |
`_data` | string | Additional data with no specified format, sent in call to `_to` |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### setApprovalForAll
▸ **setApprovalForAll**(`_operator`: string, `_approved`: boolean): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1056](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1056)*
Emits the ApprovalForAll event. The contract MUST allow
multiple operators per owner.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_operator` | string | Address to add to the set of authorized operators |
`_approved` | boolean | True if the operator is approved, false to revoke approval |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### subscribe
▸ **subscribe**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1318](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1318)*
Subscribe to an event type emitted by the ERC721Token contract.
**Type parameters:**
▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)*
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`eventName` | [ERC721TokenEvents](#enumeration-erc721tokenevents) | - | The ERC721Token contract event you would like to subscribe to. |
`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` |
`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed |
`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) |
`blockPollingIntervalMs?` | undefined \| number | - | - |
**Returns:** *string*
Subscription token used later to unsubscribe
___
### transferFrom
▸ **transferFrom**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1184](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1184)*
Throws unless `msg.sender` is the current owner, an authorized
operator, or the approved address for this NFT. Throws if `_from` is
not the current owner. Throws if `_to` is the zero address. Throws if
`_tokenId` is not a valid NFT.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`_from` | string | The current owner of the NFT |
`_to` | string | The new owner |
`_tokenId` | `BigNumber` | The NFT to transfer |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### unsubscribe
▸ **unsubscribe**(`subscriptionToken`: string): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1343)*
Cancel a subscription
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`subscriptionToken` | string | Subscription token returned by `subscribe()` |
**Returns:** *void*
___
### unsubscribeAll
▸ **unsubscribeAll**(): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1349](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1349)*
Cancels all existing subscriptions
**Returns:** *void*
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:143](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L143)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC721TokenContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:101](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L101)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<ERC721TokenContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<ERC721TokenContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:76](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L76)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<ERC721TokenContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: ExchangeContract
## Constructors
\+ **new ExchangeContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ExchangeContract](#class-exchangecontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8066](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8066)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | ExchangeContract.deployedBytecode |
**Returns:** *[ExchangeContract](#class-exchangecontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### EIP1271_MAGIC_VALUE
▸ **EIP1271_MAGIC_VALUE**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3106)*
**Returns:** *`ContractFunctionObj<string>`*
___
### EIP712_EXCHANGE_DOMAIN_HASH
▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3153)*
**Returns:** *`ContractFunctionObj<string>`*
___
### allowedValidators
▸ **allowedValidators**(`index_0`: string, `index_1`: string): *`ContractFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3200](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3200)*
**Parameters:**
Name | Type |
------ | ------ |
`index_0` | string |
`index_1` | string |
**Returns:** *`ContractFunctionObj<boolean>`*
___
### batchCancelOrders
▸ **batchCancelOrders**(`orders`: `Array<object>`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3259](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3259)*
Executes multiple calls of cancelOrder.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of order specifications. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### batchExecuteTransactions
▸ **batchExecuteTransactions**(`transactions`: `Array<object>`, `signatures`: string[]): *`ContractTxFunctionObj<string[]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3403](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3403)*
Executes a batch of Exchange method calls in the context of signer(s).
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`transactions` | `Array<object>` | Array of 0x transaction structures. |
`signatures` | string[] | Array of proofs that transactions have been signed by signer(s). |
**Returns:** *`ContractTxFunctionObj<string[]>`*
Array containing ABI encoded return data for each of the underlying Exchange function calls.
___
### batchFillOrKillOrders
▸ **batchFillOrKillOrders**(`orders`: `Array<object>`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj<Array<object>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3541](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3541)*
Executes multiple calls of fillOrKillOrder.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of order specifications. |
`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. |
`signatures` | string[] | Proofs that orders have been created by makers. |
**Returns:** *`ContractTxFunctionObj<Array<object>>`*
Array of amounts filled and fees paid by makers and taker.
___
### batchFillOrders
▸ **batchFillOrders**(`orders`: `Array<object>`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj<Array<object>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3717](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3717)*
Executes multiple calls of fillOrder.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of order specifications. |
`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. |
`signatures` | string[] | Proofs that orders have been created by makers. |
**Returns:** *`ContractTxFunctionObj<Array<object>>`*
Array of amounts filled and fees paid by makers and taker.
___
### batchFillOrdersNoThrow
▸ **batchFillOrdersNoThrow**(`orders`: `Array<object>`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj<Array<object>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3893](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3893)*
Executes multiple calls of fillOrder. If any fill reverts, the error is caught and ignored.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of order specifications. |
`takerAssetFillAmounts` | `BigNumber`[] | Array of desired amounts of takerAsset to sell in orders. |
`signatures` | string[] | Proofs that orders have been created by makers. |
**Returns:** *`ContractTxFunctionObj<Array<object>>`*
Array of amounts filled and fees paid by makers and taker.
___
### batchMatchOrders
▸ **batchMatchOrders**(`leftOrders`: `Array<object>`, `rightOrders`: `Array<object>`, `leftSignatures`: string[], `rightSignatures`: string[]): *`ContractTxFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4073](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4073)*
Match complementary orders that have a profitable spread.
Each order is filled at their respective price point, and
the matcher receives a profit denominated in the left maker asset.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`leftOrders` | `Array<object>` | Set of orders with the same maker / taker asset. |
`rightOrders` | `Array<object>` | Set of orders to match against `leftOrders` |
`leftSignatures` | string[] | Proof that left orders were created by the left makers. |
`rightSignatures` | string[] | Proof that right orders were created by the right makers. |
**Returns:** *`ContractTxFunctionObj<object>`*
batchMatchedFillResults Amounts filled and profit generated.
___
### batchMatchOrdersWithMaximalFill
▸ **batchMatchOrdersWithMaximalFill**(`leftOrders`: `Array<object>`, `rightOrders`: `Array<object>`, `leftSignatures`: string[], `rightSignatures`: string[]): *`ContractTxFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4298](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4298)*
Match complementary orders that have a profitable spread.
Each order is maximally filled at their respective price point, and
the matcher receives a profit denominated in either the left maker asset,
right maker asset, or a combination of both.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`leftOrders` | `Array<object>` | Set of orders with the same maker / taker asset. |
`rightOrders` | `Array<object>` | Set of orders to match against `leftOrders` |
`leftSignatures` | string[] | Proof that left orders were created by the left makers. |
`rightSignatures` | string[] | Proof that right orders were created by the right makers. |
**Returns:** *`ContractTxFunctionObj<object>`*
batchMatchedFillResults Amounts filled and profit generated.
___
### cancelOrder
▸ **cancelOrder**(`order`: object): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4514](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4514)*
After calling, the order can not be filled anymore.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | object | Order struct containing order specifications. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### cancelOrdersUpTo
▸ **cancelOrdersUpTo**(`targetOrderEpoch`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4654](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4654)*
Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch
and senderAddress equal to msg.sender (or null address if msg.sender == makerAddress).
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### cancelled
▸ **cancelled**(`index_0`: string): *`ContractFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4762](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4762)*
**Parameters:**
Name | Type |
------ | ------ |
`index_0` | string |
**Returns:** *`ContractFunctionObj<boolean>`*
___
### currentContextAddress
▸ **currentContextAddress**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4810](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4810)*
**Returns:** *`ContractFunctionObj<string>`*
___
### executeTransaction
▸ **executeTransaction**(`transaction`: object, `signature`: string): *`ContractTxFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4863](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4863)*
Executes an Exchange method call in the context of signer.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`transaction` | object | 0x transaction structure. |
`signature` | string | Proof that transaction has been signed by signer. |
**Returns:** *`ContractTxFunctionObj<string>`*
ABI encoded return data of the underlying Exchange function call.
___
### fillOrKillOrder
▸ **fillOrKillOrder**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *`ContractTxFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4999](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4999)*
Fills the input order. Reverts if exact takerAssetFillAmount not filled.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | object | Order struct containing order specifications. |
`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. |
`signature` | string | Proof that order has been created by maker. |
**Returns:** *`ContractTxFunctionObj<object>`*
___
### fillOrder
▸ **fillOrder**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *`ContractTxFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5168](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5168)*
Fills the input order.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | object | Order struct containing order specifications. |
`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. |
`signature` | string | Proof that order has been created by maker. |
**Returns:** *`ContractTxFunctionObj<object>`*
Amounts filled and fees paid by maker and taker.
___
### filled
▸ **filled**(`index_0`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5330)*
**Parameters:**
Name | Type |
------ | ------ |
`index_0` | string |
**Returns:** *`ContractFunctionObj<BigNumber>`*
___
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3092](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3092)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3085](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3085)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getAssetProxy
▸ **getAssetProxy**(`assetProxyId`: string): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5383](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5383)*
Gets an asset proxy.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetProxyId` | string | Id of the asset proxy. |
**Returns:** *`ContractFunctionObj<string>`*
The asset proxy registered to assetProxyId. Returns 0x0 if no proxy is registered.
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3079](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3079)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getLogsAsync
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8050](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8050)*
Gets historical logs without creating a subscription
**Type parameters:**
▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`eventName` | [ExchangeEvents](#enumeration-exchangeevents) | The Exchange contract event you would like to subscribe to. |
`blockRange` | `BlockRange` | Block range to get logs from. |
`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` |
**Returns:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
Array of logs that match the parameters
___
### getOrderInfo
▸ **getOrderInfo**(`order`: object): *`ContractFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5436)*
Gets information about an order: status, hash, and amount filled.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | object | Order to gather information on. |
**Returns:** *`ContractFunctionObj<object>`*
OrderInfo Information about the order and its state. See LibOrder.OrderInfo for a complete description.
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3099](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3099)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### isValidHashSignature
▸ **isValidHashSignature**(`hash`: string, `signerAddress`: string, `signature`: string): *`ContractFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5520](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5520)*
Verifies that a hash has been signed by the given signer.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`hash` | string | Any 32-byte hash. |
`signerAddress` | string | Address that should have signed the given hash. |
`signature` | string | Proof that the hash has been signed by signer. |
**Returns:** *`ContractFunctionObj<boolean>`*
isValid &#x60;true&#x60; if the signature is valid for the given hash and signer.
___
### isValidOrderSignature
▸ **isValidOrderSignature**(`order`: object, `signature`: string): *`ContractFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5583](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5583)*
Verifies that a signature for an order is valid.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`order` | object | The order. |
`signature` | string | Proof that the order has been signed by signer. |
**Returns:** *`ContractFunctionObj<boolean>`*
isValid &#x60;true&#x60; if the signature is valid for the given order and signer.
___
### isValidTransactionSignature
▸ **isValidTransactionSignature**(`transaction`: object, `signature`: string): *`ContractFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5664](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5664)*
Verifies that a signature for a transaction is valid.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`transaction` | object | The transaction. |
`signature` | string | Proof that the order has been signed by signer. |
**Returns:** *`ContractFunctionObj<boolean>`*
isValid &#x60;true&#x60; if the signature is valid for the given transaction and signer.
___
### marketBuyOrdersFillOrKill
▸ **marketBuyOrdersFillOrKill**(`orders`: `Array<object>`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5738](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5738)*
Calls marketBuyOrdersNoThrow then reverts if < makerAssetFillAmount has been bought.
NOTE: This function does not enforce that the makerAsset is the same for each order.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of order specifications. |
`makerAssetFillAmount` | `BigNumber` | Minimum amount of makerAsset to buy. |
`signatures` | string[] | Proofs that orders have been signed by makers. |
**Returns:** *`ContractTxFunctionObj<object>`*
Amounts filled and fees paid by makers and taker.
___
### marketBuyOrdersNoThrow
▸ **marketBuyOrdersNoThrow**(`orders`: `Array<object>`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5909](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5909)*
Executes multiple calls of fillOrder until total amount of makerAsset is bought by taker.
If any fill reverts, the error is caught and ignored.
NOTE: This function does not enforce that the makerAsset is the same for each order.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of order specifications. |
`makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. |
`signatures` | string[] | Proofs that orders have been signed by makers. |
**Returns:** *`ContractTxFunctionObj<object>`*
Amounts filled and fees paid by makers and taker.
___
### marketSellOrdersFillOrKill
▸ **marketSellOrdersFillOrKill**(`orders`: `Array<object>`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6079](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6079)*
Calls marketSellOrdersNoThrow then reverts if < takerAssetFillAmount has been sold.
NOTE: This function does not enforce that the takerAsset is the same for each order.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of order specifications. |
`takerAssetFillAmount` | `BigNumber` | Minimum amount of takerAsset to sell. |
`signatures` | string[] | Proofs that orders have been signed by makers. |
**Returns:** *`ContractTxFunctionObj<object>`*
Amounts filled and fees paid by makers and taker.
___
### marketSellOrdersNoThrow
▸ **marketSellOrdersNoThrow**(`orders`: `Array<object>`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6250](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6250)*
Executes multiple calls of fillOrder until total amount of takerAsset is sold by taker.
If any fill reverts, the error is caught and ignored.
NOTE: This function does not enforce that the takerAsset is the same for each order.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of order specifications. |
`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. |
`signatures` | string[] | Proofs that orders have been signed by makers. |
**Returns:** *`ContractTxFunctionObj<object>`*
Amounts filled and fees paid by makers and taker.
___
### matchOrders
▸ **matchOrders**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *`ContractTxFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6423](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6423)*
Match two complementary orders that have a profitable spread.
Each order is filled at their respective price point. However, the calculations are
carried out as though the orders are both being filled at the right order's price point.
The profit made by the left order goes to the taker (who matched the two orders).
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`leftOrder` | object | First order to match. |
`rightOrder` | object | Second order to match. |
`leftSignature` | string | Proof that order was created by the left maker. |
`rightSignature` | string | Proof that order was created by the right maker. |
**Returns:** *`ContractTxFunctionObj<object>`*
matchedFillResults Amounts filled and fees paid by maker and taker of matched orders.
___
### matchOrdersWithMaximalFill
▸ **matchOrdersWithMaximalFill**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *`ContractTxFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6645](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6645)*
Match two complementary orders that have a profitable spread.
Each order is maximally filled at their respective price point, and
the matcher receives a profit denominated in either the left maker asset,
right maker asset, or a combination of both.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`leftOrder` | object | First order to match. |
`rightOrder` | object | Second order to match. |
`leftSignature` | string | Proof that order was created by the left maker. |
`rightSignature` | string | Proof that order was created by the right maker. |
**Returns:** *`ContractTxFunctionObj<object>`*
matchedFillResults Amounts filled by maker and taker of matched orders.
___
### orderEpoch
▸ **orderEpoch**(`index_0`: string, `index_1`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6856](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6856)*
**Parameters:**
Name | Type |
------ | ------ |
`index_0` | string |
`index_1` | string |
**Returns:** *`ContractFunctionObj<BigNumber>`*
___
### owner
▸ **owner**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6911](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6911)*
**Returns:** *`ContractFunctionObj<string>`*
___
### preSign
▸ **preSign**(`hash`: string): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6963](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6963)*
Approves a hash on-chain.
After presigning a hash, the preSign signature type will become valid for that hash and signer.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`hash` | string | Any 32-byte hash. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### preSigned
▸ **preSigned**(`index_0`: string, `index_1`: string): *`ContractFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7069](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7069)*
**Parameters:**
Name | Type |
------ | ------ |
`index_0` | string |
`index_1` | string |
**Returns:** *`ContractFunctionObj<boolean>`*
___
### protocolFeeCollector
▸ **protocolFeeCollector**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7124](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7124)*
**Returns:** *`ContractFunctionObj<string>`*
___
### protocolFeeMultiplier
▸ **protocolFeeMultiplier**(): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7171](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7171)*
**Returns:** *`ContractFunctionObj<BigNumber>`*
___
### registerAssetProxy
▸ **registerAssetProxy**(`assetProxy`: string): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7223](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7223)*
Registers an asset proxy to its asset proxy id.
Once an asset proxy is registered, it cannot be unregistered.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetProxy` | string | Address of new asset proxy to register. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### setProtocolFeeCollectorAddress
▸ **setProtocolFeeCollectorAddress**(`updatedProtocolFeeCollector`: string): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7342)*
Allows the owner to update the protocolFeeCollector address.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### setProtocolFeeMultiplier
▸ **setProtocolFeeMultiplier**(`updatedProtocolFeeMultiplier`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7461](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7461)*
Allows the owner to update the protocol fee multiplier.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### setSignatureValidatorApproval
▸ **setSignatureValidatorApproval**(`validatorAddress`: string, `approval`: boolean): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7581](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7581)*
Approves/unnapproves a Validator contract to verify signatures on signer's behalf
using the `Validator` signature type.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`validatorAddress` | string | Address of Validator contract. |
`approval` | boolean | Approval or disapproval of Validator contract. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### simulateDispatchTransferFromCalls
▸ **simulateDispatchTransferFromCalls**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[]): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7712](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7712)*
This function may be used to simulate any amount of transfers As they would occur through the Exchange contract. Note that this function will always revert, even if all transfers are successful. However, it may be used with eth_call or with a try/catch pattern in order to simulate the results of the transfers.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. |
`fromAddresses` | string[] | Array containing the `from` addresses that correspond with each transfer. |
`toAddresses` | string[] | Array containing the `to` addresses that correspond with each transfer. |
`amounts` | `BigNumber`[] | Array containing the amounts that correspond to each transfer. |
**Returns:** *`ContractTxFunctionObj<void>`*
This function does not return a value. However, it will always revert with &#x60;Error(&quot;TRANSFERS_SUCCESSFUL&quot;)&#x60; if all of the transfers were successful.
___
### subscribe
▸ **subscribe**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8008](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8008)*
Subscribe to an event type emitted by the Exchange contract.
**Type parameters:**
▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)*
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`eventName` | [ExchangeEvents](#enumeration-exchangeevents) | - | The Exchange contract event you would like to subscribe to. |
`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` |
`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed |
`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) |
`blockPollingIntervalMs?` | undefined \| number | - | - |
**Returns:** *string*
Subscription token used later to unsubscribe
___
### transactionsExecuted
▸ **transactionsExecuted**(`index_0`: string): *`ContractFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7840](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7840)*
**Parameters:**
Name | Type |
------ | ------ |
`index_0` | string |
**Returns:** *`ContractFunctionObj<boolean>`*
___
### transferOwnership
▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7890](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7890)*
**Parameters:**
Name | Type |
------ | ------ |
`newOwner` | string |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### unsubscribe
▸ **unsubscribe**(`subscriptionToken`: string): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8033](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8033)*
Cancel a subscription
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`subscriptionToken` | string | Subscription token returned by `subscribe()` |
**Returns:** *void*
___
### unsubscribeAll
▸ **unsubscribeAll**(): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8039](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8039)*
Cancels all existing subscriptions
**Returns:** *void*
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:198](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L198)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise<ExchangeContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:151](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L151)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`chainId` | `BigNumber` |
**Returns:** *`Promise<ExchangeContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise<ExchangeContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:125](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L125)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`chainId` | `BigNumber` |
**Returns:** *`Promise<ExchangeContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: ForwarderContract
## Constructors
\+ **new ForwarderContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ForwarderContract](#class-forwardercontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1147](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1147)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | ForwarderContract.deployedBytecode |
**Returns:** *[ForwarderContract](#class-forwardercontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### approveMakerAssetProxy
▸ **approveMakerAssetProxy**(`assetData`: string): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:449](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L449)*
Approves the respective proxy for a given asset to transfer tokens on the Forwarder contract's behalf.
This is necessary because an order fee denominated in the maker asset (i.e. a percentage fee) is sent by the
Forwarder contract to the fee recipient.
This method needs to be called before forwarding orders of a maker asset that hasn't
previously been approved.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Byte array encoded for the respective asset proxy. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:427](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L427)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:420](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L420)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:414](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L414)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L434)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### marketBuyOrdersWithEth
▸ **marketBuyOrdersWithEth**(`orders`: `Array<object>`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:571](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L571)*
Attempt to buy makerAssetBuyAmount of makerAsset by selling ETH provided with transaction.
The Forwarder may *fill* more than makerAssetBuyAmount of the makerAsset so that it can
pay takerFees where takerFeeAssetData == makerAssetData (i.e. percentage fees).
Any ETH not spent will be refunded to sender.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. |
`makerAssetBuyAmount` | `BigNumber` | Desired amount of makerAsset to purchase. |
`signatures` | string[] | Proofs that orders have been created by makers. |
`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. |
`feeRecipient` | string | Address that will receive ETH when orders are filled. |
**Returns:** *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`*
wethSpentAmount Amount of WETH spent on the given set of orders.makerAssetAcquiredAmount Amount of maker asset acquired from the given set of orders.ethFeePaid Amount of ETH spent on the given forwarder fee.
___
### marketSellOrdersWithEth
▸ **marketSellOrdersWithEth**(`orders`: `Array<object>`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:730](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L730)*
Purchases as much of orders' makerAssets as possible by selling as much of the ETH value sent
as possible, accounting for order and forwarder fees.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`orders` | `Array<object>` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. |
`signatures` | string[] | Proofs that orders have been created by makers. |
`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. |
`feeRecipient` | string | Address that will receive ETH when orders are filled. |
**Returns:** *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`*
wethSpentAmount Amount of WETH spent on the given set of orders.makerAssetAcquiredAmount Amount of maker asset acquired from the given set of orders.ethFeePaid Amount of ETH spent on the given forwarder fee.
___
### owner
▸ **owner**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:876](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L876)*
**Returns:** *`ContractFunctionObj<string>`*
___
### transferOwnership
▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:923](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L923)*
**Parameters:**
Name | Type |
------ | ------ |
`newOwner` | string |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### withdrawAsset
▸ **withdrawAsset**(`assetData`: string, `amount`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1038](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1038)*
Withdraws assets from this contract. The contract formerly required a ZRX balance in order
to function optimally, and this function allows the ZRX to be withdrawn by owner.
It may also be used to withdraw assets that were accidentally sent to this contract.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`assetData` | string | Byte array encoded for the respective asset proxy. |
`amount` | `BigNumber` | Amount of ERC20 token to withdraw. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:127](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L127)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_exchange`: string, `_wethAssetData`: string): *`Promise<ForwarderContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L79)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`_exchange` | string |
`_wethAssetData` | string |
**Returns:** *`Promise<ForwarderContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_exchange`: string, `_wethAssetData`: string): *`Promise<ForwarderContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L44)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`_exchange` | string |
`_wethAssetData` | string |
**Returns:** *`Promise<ForwarderContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: IValidatorContract
## Constructors
\+ **new IValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IValidatorContract](#class-ivalidatorcontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:234](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L234)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | IValidatorContract.deployedBytecode |
**Returns:** *[IValidatorContract](#class-ivalidatorcontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:157](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L157)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:150](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L150)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:144](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L144)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:164](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L164)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### isValidSignature
▸ **isValidSignature**(`hash`: string, `signerAddress`: string, `signature`: string): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:178](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L178)*
Verifies that a signature is valid.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`hash` | string | Message hash that is signed. |
`signerAddress` | string | Address that should have signed the given hash. |
`signature` | string | Proof of signing. |
**Returns:** *`ContractFunctionObj<string>`*
Magic bytes4 value if the signature is valid. Magic value is bytes4(keccak256(&quot;isValidValidatorSignature(address,bytes32,address,bytes)&quot;))
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L111)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IValidatorContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L69)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<IValidatorContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IValidatorContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L44)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<IValidatorContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: IWalletContract
## Constructors
\+ **new IWalletContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IWalletContract](#class-iwalletcontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:224](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L224)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | IWalletContract.deployedBytecode |
**Returns:** *[IWalletContract](#class-iwalletcontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L153)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:146](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L146)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:140](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L140)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:160](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L160)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### isValidSignature
▸ **isValidSignature**(`hash`: string, `signature`: string): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:173](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L173)*
Validates a hash with the `Wallet` signature type.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`hash` | string | Message hash that is signed. |
`signature` | string | Proof of signing. |
**Returns:** *`ContractFunctionObj<string>`*
magicValue &#x60;bytes4(0xb0671381)&#x60; if the signature check succeeds.
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L111)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IWalletContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L69)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<IWalletContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<IWalletContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L44)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<IWalletContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: OrderValidatorContract
## Constructors
\+ **new OrderValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[OrderValidatorContract](#class-ordervalidatorcontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1338](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1338)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | OrderValidatorContract.deployedBytecode |
**Returns:** *[OrderValidatorContract](#class-ordervalidatorcontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:703](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L703)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:696](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L696)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getBalanceAndAllowance
▸ **getBalanceAndAllowance**(`target`: string, `assetData`: string): *`ContractFunctionObj<[BigNumber, BigNumber]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:835](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L835)*
**Parameters:**
Name | Type |
------ | ------ |
`target` | string |
`assetData` | string |
**Returns:** *`ContractFunctionObj<[BigNumber, BigNumber]>`*
___
### getBalancesAndAllowances
▸ **getBalancesAndAllowances**(`target`: string, `assetData`: string[]): *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1175](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1175)*
**Parameters:**
Name | Type |
------ | ------ |
`target` | string |
`assetData` | string[] |
**Returns:** *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`*
___
### getERC721TokenOwner
▸ **getERC721TokenOwner**(`token`: string, `tokenId`: `BigNumber`): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1120)*
**Parameters:**
Name | Type |
------ | ------ |
`token` | string |
`tokenId` | `BigNumber` |
**Returns:** *`ContractFunctionObj<string>`*
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L690)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getOrderAndTraderInfo
▸ **getOrderAndTraderInfo**(`order`: object, `takerAddress`: string): *`ContractFunctionObj<[object, object]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:717](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L717)*
**Parameters:**
Name | Type |
------ | ------ |
`order` | object |
`takerAddress` | string |
**Returns:** *`ContractFunctionObj<[object, object]>`*
___
### getOrdersAndTradersInfo
▸ **getOrdersAndTradersInfo**(`orders`: `Array<object>`, `takerAddresses`: string[]): *`ContractFunctionObj<[Array<object>, Array<object>]>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:893](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L893)*
**Parameters:**
Name | Type |
------ | ------ |
`orders` | `Array<object>` |
`takerAddresses` | string[] |
**Returns:** *`ContractFunctionObj<[Array<object>, Array<object>]>`*
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:710](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L710)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getTraderInfo
▸ **getTraderInfo**(`order`: object, `takerAddress`: string): *`ContractFunctionObj<object>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1236](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1236)*
**Parameters:**
Name | Type |
------ | ------ |
`order` | object |
`takerAddress` | string |
**Returns:** *`ContractFunctionObj<object>`*
___
### getTradersInfo
▸ **getTradersInfo**(`orders`: `Array<object>`, `takerAddresses`: string[]): *`ContractFunctionObj<Array<object>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1011](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1011)*
**Parameters:**
Name | Type |
------ | ------ |
`orders` | `Array<object>` |
`takerAddresses` | string[] |
**Returns:** *`ContractFunctionObj<Array<object>>`*
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:127](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L127)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise<OrderValidatorContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L79)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`_exchange` | string |
`_zrxAssetData` | string |
**Returns:** *`Promise<OrderValidatorContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise<OrderValidatorContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L44)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`_exchange` | string |
`_zrxAssetData` | string |
**Returns:** *`Promise<OrderValidatorContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: WETH9Contract
## Constructors
\+ **new WETH9Contract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[WETH9Contract](#class-weth9contract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1381](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1381)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | WETH9Contract.deployedBytecode |
**Returns:** *[WETH9Contract](#class-weth9contract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### allowance
▸ **allowance**(`index_0`: string, `index_1`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1258](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1258)*
**Parameters:**
Name | Type |
------ | ------ |
`index_0` | string |
`index_1` | string |
**Returns:** *`ContractFunctionObj<BigNumber>`*
___
### approve
▸ **approve**(`guy`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:512](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L512)*
**Parameters:**
Name | Type |
------ | ------ |
`guy` | string |
`wad` | `BigNumber` |
**Returns:** *`ContractTxFunctionObj<boolean>`*
___
### balanceOf
▸ **balanceOf**(`index_0`: string): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:946](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L946)*
**Parameters:**
Name | Type |
------ | ------ |
`index_0` | string |
**Returns:** *`ContractFunctionObj<BigNumber>`*
___
### decimals
▸ **decimals**(): *`ContractFunctionObj<number>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:899](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L899)*
**Returns:** *`ContractFunctionObj<number>`*
___
### deposit
▸ **deposit**(): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1153)*
**Returns:** *`ContractTxFunctionObj<void>`*
___
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:451](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L451)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:444](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L444)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:438](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L438)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getLogsAsync
▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1365](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1365)*
Gets historical logs without creating a subscription
**Type parameters:**
▪ **ArgsType**: *[WETH9EventArgs](#weth9eventargs)*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`eventName` | [WETH9Events](#enumeration-weth9events) | The WETH9 contract event you would like to subscribe to. |
`blockRange` | `BlockRange` | Block range to get logs from. |
`indexFilterValues` | `IndexedFilterValues` | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{_from: aUserAddressHex}` |
**Returns:** *`Promise<Array<LogWithDecodedArgs<ArgsType>>>`*
Array of logs that match the parameters
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L458)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### name
▸ **name**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:465](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L465)*
**Returns:** *`ContractFunctionObj<string>`*
___
### subscribe
▸ **subscribe**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1323](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1323)*
Subscribe to an event type emitted by the WETH9 contract.
**Type parameters:**
▪ **ArgsType**: *[WETH9EventArgs](#weth9eventargs)*
**Parameters:**
Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`eventName` | [WETH9Events](#enumeration-weth9events) | - | The WETH9 contract event you would like to subscribe to. |
`indexFilterValues` | `IndexedFilterValues` | - | An object where the keys are indexed args returned by the event and the value is the value you are interested in. E.g `{maker: aUserAddressHex}` |
`callback` | [EventCallback](#eventcallback)‹*`ArgsType`*› | - | Callback that gets called when a log is added/removed |
`isVerbose` | boolean | false | Enable verbose subscription warnings (e.g recoverable network issues encountered) |
`blockPollingIntervalMs?` | undefined \| number | - | - |
**Returns:** *string*
Subscription token used later to unsubscribe
___
### symbol
▸ **symbol**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:996](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L996)*
**Returns:** *`ContractFunctionObj<string>`*
___
### totalSupply
▸ **totalSupply**(): *`ContractFunctionObj<BigNumber>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:622](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L622)*
**Returns:** *`ContractFunctionObj<BigNumber>`*
___
### transfer
▸ **transfer**(`dst`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1043](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1043)*
**Parameters:**
Name | Type |
------ | ------ |
`dst` | string |
`wad` | `BigNumber` |
**Returns:** *`ContractTxFunctionObj<boolean>`*
___
### transferFrom
▸ **transferFrom**(`src`: string, `dst`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj<boolean>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:669](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L669)*
**Parameters:**
Name | Type |
------ | ------ |
`src` | string |
`dst` | string |
`wad` | `BigNumber` |
**Returns:** *`ContractTxFunctionObj<boolean>`*
___
### unsubscribe
▸ **unsubscribe**(`subscriptionToken`: string): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1348](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1348)*
Cancel a subscription
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`subscriptionToken` | string | Subscription token returned by `subscribe()` |
**Returns:** *void*
___
### unsubscribeAll
▸ **unsubscribeAll**(): *void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1354](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1354)*
Cancels all existing subscriptions
**Returns:** *void*
___
### withdraw
▸ **withdraw**(`wad`: `BigNumber`): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:793](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L793)*
**Parameters:**
Name | Type |
------ | ------ |
`wad` | `BigNumber` |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:149](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L149)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<WETH9Contract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:107](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L107)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<WETH9Contract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object): *`Promise<WETH9Contract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L82)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
**Returns:** *`Promise<WETH9Contract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Class: ContractWrappers
The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol.
## Constructors
\+ **new ContractWrappers**(`supportedProvider`: [SupportedProvider](#supportedprovider), `config`: [ContractWrappersConfig](#interface-contractwrappersconfig)): *[ContractWrappers](#class-contractwrappers)*
*Defined in [contract-wrappers/src/contract_wrappers.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L66)*
Instantiates a new ContractWrappers instance.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`supportedProvider` | [SupportedProvider](#supportedprovider) | The Provider instance you would like the contract-wrappers library to use for interacting with the Ethereum network. |
`config` | [ContractWrappersConfig](#interface-contractwrappersconfig) | The configuration object. Look up the type for the description. |
**Returns:** *[ContractWrappers](#class-contractwrappers)*
An instance of the ContractWrappers class.
## Properties
### contractAddresses
• **contractAddresses**: *`ContractAddresses`*
*Defined in [contract-wrappers/src/contract_wrappers.ts:38](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L38)*
An index of the default contract addresses for this chain.
___
### coordinator
• **coordinator**: *`CoordinatorContract`*
*Defined in [contract-wrappers/src/contract_wrappers.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L64)*
An instance of the CoordinatorContract class containing methods for interacting with the Coordinator extension contract.
___
### devUtils
• **devUtils**: *`DevUtilsContract`*
*Defined in [contract-wrappers/src/contract_wrappers.ts:60](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L60)*
An instance of the DevUtilsContract class containing methods for interacting with the DevUtils smart contract.
___
### exchange
• **exchange**: *`ExchangeContract`*
*Defined in [contract-wrappers/src/contract_wrappers.ts:42](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L42)*
An instance of the ExchangeContract class containing methods for interacting with the 0x Exchange smart contract.
___
### forwarder
• **forwarder**: *`ForwarderContract`*
*Defined in [contract-wrappers/src/contract_wrappers.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L51)*
An instance of the ForwarderContract class containing methods for interacting with any Forwarder smart contract.
___
### orderValidator
• **orderValidator**: *`OrderValidatorContract`*
*Defined in [contract-wrappers/src/contract_wrappers.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L56)*
An instance of the OrderValidatorContract class containing methods for interacting with any OrderValidator smart contract.
___
### weth9
• **weth9**: *`WETH9Contract`*
*Defined in [contract-wrappers/src/contract_wrappers.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L47)*
An instance of the WETH9Contract class containing methods for interacting with the
WETH9 smart contract.
## Methods
### getAbiDecoder
▸ **getAbiDecoder**(): *`AbiDecoder`*
*Defined in [contract-wrappers/src/contract_wrappers.ts:124](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L124)*
Get the abi decoder instance currently used by contract-wrappers
**Returns:** *`AbiDecoder`*
AbiDecoder instance
___
### getProvider
▸ **getProvider**(): *[SupportedProvider](#supportedprovider)*
*Defined in [contract-wrappers/src/contract_wrappers.ts:117](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L117)*
Get the provider instance currently used by contract-wrappers
**Returns:** *[SupportedProvider](#supportedprovider)*
Web3 provider instance
___
### unsubscribeAll
▸ **unsubscribeAll**(): *void*
*Defined in [contract-wrappers/src/contract_wrappers.ts:109](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L109)*
Unsubscribes from all subscriptions for all contracts.
**Returns:** *void*
<hr />
# Class: AbiDecoder
AbiDecoder allows you to decode event logs given a set of supplied contract ABI's. It takes the contract's event
signature from the ABI and attempts to decode the logs using it.
## Constructors
\+ **new AbiDecoder**(`abiArrays`: [AbiDefinition](#abidefinition)[][]): *[AbiDecoder](#class-abidecoder)*
*Defined in [utils/src/abi_decoder.ts:42](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L42)*
Instantiate an AbiDecoder
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`abiArrays` | [AbiDefinition](#abidefinition)[][] | An array of contract ABI's |
**Returns:** *[AbiDecoder](#class-abidecoder)*
AbiDecoder instance
## Methods
### addABI
▸ **addABI**(`abiArray`: [AbiDefinition](#abidefinition)[], `contractName?`: undefined | string): *void*
*Defined in [utils/src/abi_decoder.ts:158](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L158)*
Adds a set of ABI definitions, after which calldata and logs targeting these ABI's can be decoded.
Additional properties can be included to disambiguate similar ABI's. For example, if two functions
have the same signature but different parameter names, then their ABI definitions can be disambiguated
by specifying a contract name.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`abiArray` | [AbiDefinition](#abidefinition)[] | - |
`contractName?` | undefined \| string | Name of contract that encapsulates the ABI definitions (optional). This can be used when decoding calldata to disambiguate methods with the same signature but different parameter names. |
**Returns:** *void*
___
### decodeCalldataOrThrow
▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`*
*Defined in [utils/src/abi_decoder.ts:118](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L118)*
Decodes calldata for a known ABI.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`calldata` | string | hex-encoded calldata. |
`contractName?` | undefined \| string | used to disambiguate similar ABI's (optional). |
**Returns:** *`DecodedCalldata`*
Decoded calldata. Includes: function name and signature, along with the decoded arguments.
___
### tryToDecodeLogOrNoop
▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs<ArgsType>` | [RawLog](#rawlog)*
*Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L58)*
Attempt to decode a log given the ABI's the AbiDecoder knows about.
**Type parameters:**
▪ **ArgsType**: *`DecodedLogArgs`*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`log` | `LogEntry` | The log to attempt to decode |
**Returns:** *`LogWithDecodedArgs<ArgsType>` | [RawLog](#rawlog)*
The decoded log if the requisite ABI was available. Otherwise the log unaltered.
<hr />
# Enumeration: CoordinatorRegistryEvents
## Enumeration members
### CoordinatorEndpointSet
• **CoordinatorEndpointSet**: = "CoordinatorEndpointSet"
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L40)*
<hr />
# Enumeration: DummyERC20TokenEvents
## Enumeration members
### Approval
• **Approval**: = "Approval"
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L40)*
___
### Transfer
• **Transfer**: = "Transfer"
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L41)*
<hr />
# Enumeration: DummyERC721TokenEvents
## Enumeration members
### Approval
• **Approval**: = "Approval"
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L43)*
___
### ApprovalForAll
• **ApprovalForAll**: = "ApprovalForAll"
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L44)*
___
### Transfer
• **Transfer**: = "Transfer"
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L45)*
<hr />
# Enumeration: ERC20TokenEvents
## Enumeration members
### Approval
• **Approval**: = "Approval"
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L41)*
___
### Transfer
• **Transfer**: = "Transfer"
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L40)*
<hr />
# Enumeration: ERC721TokenEvents
## Enumeration members
### Approval
• **Approval**: = "Approval"
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L43)*
___
### ApprovalForAll
• **ApprovalForAll**: = "ApprovalForAll"
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L44)*
___
### Transfer
• **Transfer**: = "Transfer"
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L45)*
<hr />
# Enumeration: ExchangeEvents
## Enumeration members
### AssetProxyRegistered
• **AssetProxyRegistered**: = "AssetProxyRegistered"
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:48](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L48)*
___
### Cancel
• **Cancel**: = "Cancel"
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L49)*
___
### CancelUpTo
• **CancelUpTo**: = "CancelUpTo"
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)*
___
### Fill
• **Fill**: = "Fill"
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)*
___
### ProtocolFeeCollectorAddress
• **ProtocolFeeCollectorAddress**: = "ProtocolFeeCollectorAddress"
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L52)*
___
### ProtocolFeeMultiplier
• **ProtocolFeeMultiplier**: = "ProtocolFeeMultiplier"
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L53)*
___
### SignatureValidatorApproval
• **SignatureValidatorApproval**: = "SignatureValidatorApproval"
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L54)*
___
### TransactionExecution
• **TransactionExecution**: = "TransactionExecution"
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L55)*
<hr />
# Enumeration: WETH9Events
## Enumeration members
### Approval
• **Approval**: = "Approval"
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)*
___
### Deposit
• **Deposit**: = "Deposit"
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L46)*
___
### Transfer
• **Transfer**: = "Transfer"
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L45)*
___
### Withdrawal
• **Withdrawal**: = "Withdrawal"
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L47)*
<hr />
# Enumeration: ContractError
## Enumeration members
### ContractNotDeployedOnChain
• **ContractNotDeployedOnChain**: = "CONTRACT_NOT_DEPLOYED_ON_CHAIN"
*Defined in [contract-wrappers/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L16)*
___
### ERC721NoApproval
• **ERC721NoApproval**: = "ERC_721_NO_APPROVAL"
*Defined in [contract-wrappers/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L26)*
___
### ERC721OwnerNotFound
• **ERC721OwnerNotFound**: = "ERC_721_OWNER_NOT_FOUND"
*Defined in [contract-wrappers/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L25)*
___
### InsufficientAllowanceForTransfer
• **InsufficientAllowanceForTransfer**: = "INSUFFICIENT_ALLOWANCE_FOR_TRANSFER"
*Defined in [contract-wrappers/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L17)*
___
### InsufficientBalanceForTransfer
• **InsufficientBalanceForTransfer**: = "INSUFFICIENT_BALANCE_FOR_TRANSFER"
*Defined in [contract-wrappers/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L18)*
___
### InsufficientEthBalanceForDeposit
• **InsufficientEthBalanceForDeposit**: = "INSUFFICIENT_ETH_BALANCE_FOR_DEPOSIT"
*Defined in [contract-wrappers/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L19)*
___
### InsufficientWEthBalanceForWithdrawal
• **InsufficientWEthBalanceForWithdrawal**: = "INSUFFICIENT_WETH_BALANCE_FOR_WITHDRAWAL"
*Defined in [contract-wrappers/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L20)*
___
### InvalidJump
• **InvalidJump**: = "INVALID_JUMP"
*Defined in [contract-wrappers/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L21)*
___
### OutOfGas
• **OutOfGas**: = "OUT_OF_GAS"
*Defined in [contract-wrappers/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L22)*
___
### SignatureRequestDenied
• **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED"
*Defined in [contract-wrappers/src/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L27)*
___
### SubscriptionAlreadyPresent
• **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT"
*Defined in [contract-wrappers/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L24)*
___
### SubscriptionNotFound
• **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND"
*Defined in [contract-wrappers/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L23)*
<hr />
# Enumeration: ForwarderError
## Enumeration members
### CompleteFillFailed
• **CompleteFillFailed**: = "COMPLETE_FILL_FAILED"
*Defined in [contract-wrappers/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L12)*
<hr />
# Enumeration: BlockParamLiteral
## Enumeration members
### Earliest
• **Earliest**: = "earliest"
*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L479)*
___
### Latest
• **Latest**: = "latest"
*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L480)*
___
### Pending
• **Pending**: = "pending"
*Defined in [ethereum-types/src/index.ts:481](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L481)*
<hr />
<hr />
# Interface: CoordinatorRegistryCoordinatorEndpointSetEventArgs
## Index
### Properties
* [coordinatorEndpoint](#coordinatorendpoint)
* [coordinatorOperator](#coordinatoroperator)
## Properties
### coordinatorEndpoint
• **coordinatorEndpoint**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L45)*
___
### coordinatorOperator
• **coordinatorOperator**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L44)*
<hr />
# Interface: DummyERC20TokenApprovalEventArgs
## Index
### Properties
* [_owner](#_owner)
* [_spender](#_spender)
* [_value](#_value)
## Properties
### _owner
• **_owner**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L45)*
___
### _spender
• **_spender**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L46)*
___
### _value
• **_value**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L47)*
<hr />
# Interface: DummyERC20TokenTransferEventArgs
## Index
### Properties
* [_from](#_from)
* [_to](#_to)
* [_value](#_value)
## Properties
### _from
• **_from**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L51)*
___
### _to
• **_to**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L52)*
___
### _value
• **_value**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L53)*
<hr />
# Interface: DummyERC721TokenApprovalEventArgs
## Index
### Properties
* [_approved](#_approved)
* [_owner](#_owner)
* [_tokenId](#_tokenid)
## Properties
### _approved
• **_approved**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L50)*
___
### _owner
• **_owner**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L49)*
___
### _tokenId
• **_tokenId**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L51)*
<hr />
# Interface: DummyERC721TokenApprovalForAllEventArgs
## Index
### Properties
* [_approved](#_approved)
* [_operator](#_operator)
* [_owner](#_owner)
## Properties
### _approved
• **_approved**: *boolean*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L57)*
___
### _operator
• **_operator**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L56)*
___
### _owner
• **_owner**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L55)*
<hr />
# Interface: DummyERC721TokenTransferEventArgs
## Index
### Properties
* [_from](#_from)
* [_to](#_to)
* [_tokenId](#_tokenid)
## Properties
### _from
• **_from**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L61)*
___
### _to
• **_to**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L62)*
___
### _tokenId
• **_tokenId**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L63)*
<hr />
# Interface: ERC20TokenApprovalEventArgs
## Index
### Properties
* [_owner](#_owner)
* [_spender](#_spender)
* [_value](#_value)
## Properties
### _owner
• **_owner**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L51)*
___
### _spender
• **_spender**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L52)*
___
### _value
• **_value**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L53)*
<hr />
# Interface: ERC20TokenTransferEventArgs
## Index
### Properties
* [_from](#_from)
* [_to](#_to)
* [_value](#_value)
## Properties
### _from
• **_from**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L45)*
___
### _to
• **_to**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L46)*
___
### _value
• **_value**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L47)*
<hr />
# Interface: ERC721TokenApprovalEventArgs
## Index
### Properties
* [_approved](#_approved)
* [_owner](#_owner)
* [_tokenId](#_tokenid)
## Properties
### _approved
• **_approved**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L50)*
___
### _owner
• **_owner**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L49)*
___
### _tokenId
• **_tokenId**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L51)*
<hr />
# Interface: ERC721TokenApprovalForAllEventArgs
## Index
### Properties
* [_approved](#_approved)
* [_operator](#_operator)
* [_owner](#_owner)
## Properties
### _approved
• **_approved**: *boolean*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L57)*
___
### _operator
• **_operator**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L56)*
___
### _owner
• **_owner**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L55)*
<hr />
# Interface: ERC721TokenTransferEventArgs
## Index
### Properties
* [_from](#_from)
* [_to](#_to)
* [_tokenId](#_tokenid)
## Properties
### _from
• **_from**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L61)*
___
### _to
• **_to**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L62)*
___
### _tokenId
• **_tokenId**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L63)*
<hr />
# Interface: ExchangeAssetProxyRegisteredEventArgs
## Index
### Properties
* [assetProxy](#assetproxy)
* [id](#id)
## Properties
### assetProxy
• **assetProxy**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:60](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L60)*
___
### id
• **id**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L59)*
<hr />
# Interface: ExchangeCancelEventArgs
## Index
### Properties
* [feeRecipientAddress](#feerecipientaddress)
* [makerAddress](#makeraddress)
* [makerAssetData](#makerassetdata)
* [orderHash](#orderhash)
* [senderAddress](#senderaddress)
* [takerAssetData](#takerassetdata)
## Properties
### feeRecipientAddress
• **feeRecipientAddress**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)*
___
### makerAddress
• **makerAddress**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)*
___
### makerAssetData
• **makerAssetData**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)*
___
### orderHash
• **orderHash**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L69)*
___
### senderAddress
• **senderAddress**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L68)*
___
### takerAssetData
• **takerAssetData**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:67](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L67)*
<hr />
# Interface: ExchangeCancelUpToEventArgs
## Index
### Properties
* [makerAddress](#makeraddress)
* [orderEpoch](#orderepoch)
* [orderSenderAddress](#ordersenderaddress)
## Properties
### makerAddress
• **makerAddress**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L73)*
___
### orderEpoch
• **orderEpoch**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L75)*
___
### orderSenderAddress
• **orderSenderAddress**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L74)*
<hr />
# Interface: ExchangeFillEventArgs
## Index
### Properties
* [feeRecipientAddress](#feerecipientaddress)
* [makerAddress](#makeraddress)
* [makerAssetData](#makerassetdata)
* [makerAssetFilledAmount](#makerassetfilledamount)
* [makerFeeAssetData](#makerfeeassetdata)
* [makerFeePaid](#makerfeepaid)
* [orderHash](#orderhash)
* [protocolFeePaid](#protocolfeepaid)
* [senderAddress](#senderaddress)
* [takerAddress](#takeraddress)
* [takerAssetData](#takerassetdata)
* [takerAssetFilledAmount](#takerassetfilledamount)
* [takerFeeAssetData](#takerfeeassetdata)
* [takerFeePaid](#takerfeepaid)
## Properties
### feeRecipientAddress
• **feeRecipientAddress**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)*
___
### makerAddress
• **makerAddress**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)*
___
### makerAssetData
• **makerAssetData**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)*
___
### makerAssetFilledAmount
• **makerAssetFilledAmount**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:88](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L88)*
___
### makerFeeAssetData
• **makerFeeAssetData**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:83](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L83)*
___
### makerFeePaid
• **makerFeePaid**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L90)*
___
### orderHash
• **orderHash**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L85)*
___
### protocolFeePaid
• **protocolFeePaid**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L92)*
___
### senderAddress
• **senderAddress**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:87](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L87)*
___
### takerAddress
• **takerAddress**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L86)*
___
### takerAssetData
• **takerAssetData**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L82)*
___
### takerAssetFilledAmount
• **takerAssetFilledAmount**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:89](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L89)*
___
### takerFeeAssetData
• **takerFeeAssetData**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L84)*
___
### takerFeePaid
• **takerFeePaid**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L91)*
<hr />
# Interface: ExchangeProtocolFeeCollectorAddressEventArgs
## Index
### Properties
* [oldProtocolFeeCollector](#oldprotocolfeecollector)
* [updatedProtocolFeeCollector](#updatedprotocolfeecollector)
## Properties
### oldProtocolFeeCollector
• **oldProtocolFeeCollector**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L96)*
___
### updatedProtocolFeeCollector
• **updatedProtocolFeeCollector**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:97](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L97)*
<hr />
# Interface: ExchangeProtocolFeeMultiplierEventArgs
## Index
### Properties
* [oldProtocolFeeMultiplier](#oldprotocolfeemultiplier)
* [updatedProtocolFeeMultiplier](#updatedprotocolfeemultiplier)
## Properties
### oldProtocolFeeMultiplier
• **oldProtocolFeeMultiplier**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:101](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L101)*
___
### updatedProtocolFeeMultiplier
• **updatedProtocolFeeMultiplier**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L102)*
<hr />
# Interface: ExchangeSignatureValidatorApprovalEventArgs
## Index
### Properties
* [isApproved](#isapproved)
* [signerAddress](#signeraddress)
* [validatorAddress](#validatoraddress)
## Properties
### isApproved
• **isApproved**: *boolean*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:108](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L108)*
___
### signerAddress
• **signerAddress**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L106)*
___
### validatorAddress
• **validatorAddress**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:107](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L107)*
<hr />
# Interface: ExchangeTransactionExecutionEventArgs
## Index
### Properties
* [transactionHash](#transactionhash)
## Properties
### transactionHash
• **transactionHash**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L112)*
<hr />
# Interface: WETH9ApprovalEventArgs
## Index
### Properties
* [_owner](#_owner)
* [_spender](#_spender)
* [_value](#_value)
## Properties
### _owner
• **_owner**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L51)*
___
### _spender
• **_spender**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L52)*
___
### _value
• **_value**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L53)*
<hr />
# Interface: WETH9DepositEventArgs
## Index
### Properties
* [_owner](#_owner)
* [_value](#_value)
## Properties
### _owner
• **_owner**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L63)*
___
### _value
• **_value**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L64)*
<hr />
# Interface: WETH9TransferEventArgs
## Index
### Properties
* [_from](#_from)
* [_to](#_to)
* [_value](#_value)
## Properties
### _from
• **_from**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L57)*
___
### _to
• **_to**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L58)*
___
### _value
• **_value**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L59)*
<hr />
# Interface: WETH9WithdrawalEventArgs
## Index
### Properties
* [_owner](#_owner)
* [_value](#_value)
## Properties
### _owner
• **_owner**: *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L68)*
___
### _value
• **_value**: *`BigNumber`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L69)*
<hr />
# Interface: AwaitTransactionSuccessOpts
Used with `awaitTransactionSuccessAsync`
* pollingIntervalMs: Determine polling intervals in milliseconds
* timeoutMs: Determines timeout in milliseconds
## Properties
### `Optional` pollingIntervalMs
• **pollingIntervalMs**? : *undefined | number*
*Defined in [base-contract/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L39)*
___
### `Optional` shouldValidate
• **shouldValidate**? : *undefined | false | true*
*Inherited from [SendTransactionOpts](#interface-sendtransactionopts).[shouldValidate](#optional-shouldvalidate)*
*Defined in [base-contract/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L30)*
___
### `Optional` timeoutMs
• **timeoutMs**? : *undefined | number*
*Defined in [base-contract/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L40)*
<hr />
# Interface: ContractFunctionObj <**T**>
## Type parameters
▪ **T**
## Methods
### callAsync
▸ **callAsync**(`callData?`: `Partial<CallData>`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<T>`*
*Defined in [base-contract/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L44)*
**Parameters:**
Name | Type |
------ | ------ |
`callData?` | `Partial<CallData>` |
`defaultBlock?` | [BlockParam](#blockparam) |
**Returns:** *`Promise<T>`*
___
### getABIEncodedTransactionData
▸ **getABIEncodedTransactionData**(): *string*
*Defined in [base-contract/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L45)*
**Returns:** *string*
<hr />
# Interface: ContractTxFunctionObj <**T**>
## Type parameters
▪ **T**
## Methods
### awaitTransactionSuccessAsync
▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial<TxData>`, `opts?`: [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts)): *`PromiseWithTransactionHash<TransactionReceiptWithDecodedLogs>`*
*Defined in [base-contract/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L50)*
**Parameters:**
Name | Type |
------ | ------ |
`txData?` | `Partial<TxData>` |
`opts?` | [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts) |
**Returns:** *`PromiseWithTransactionHash<TransactionReceiptWithDecodedLogs>`*
___
### callAsync
▸ **callAsync**(`callData?`: `Partial<CallData>`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<T>`*
*Inherited from [ContractFunctionObj](#interface-contractfunctionobj).[callAsync](#callasync)*
*Defined in [base-contract/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L44)*
**Parameters:**
Name | Type |
------ | ------ |
`callData?` | `Partial<CallData>` |
`defaultBlock?` | [BlockParam](#blockparam) |
**Returns:** *`Promise<T>`*
___
### estimateGasAsync
▸ **estimateGasAsync**(`txData?`: `Partial<TxData>`): *`Promise<number>`*
*Defined in [base-contract/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L54)*
**Parameters:**
Name | Type |
------ | ------ |
`txData?` | `Partial<TxData>` |
**Returns:** *`Promise<number>`*
___
### getABIEncodedTransactionData
▸ **getABIEncodedTransactionData**(): *string*
*Inherited from [ContractFunctionObj](#interface-contractfunctionobj).[getABIEncodedTransactionData](#getabiencodedtransactiondata)*
*Defined in [base-contract/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L45)*
**Returns:** *string*
___
### sendTransactionAsync
▸ **sendTransactionAsync**(`txData?`: `Partial<TxData>`, `opts?`: [SendTransactionOpts](#class-sendtransactionopts)): *`Promise<string>`*
*Defined in [base-contract/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L49)*
**Parameters:**
Name | Type |
------ | ------ |
`txData?` | `Partial<TxData>` |
`opts?` | [SendTransactionOpts](#class-sendtransactionopts) |
**Returns:** *`Promise<string>`*
<hr />
# Interface: ContractAddresses
## Properties
### assetProxyOwner
• **assetProxyOwner**: *string*
*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L12)*
___
### coordinator
• **coordinator**: *string*
*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L18)*
___
### coordinatorRegistry
• **coordinatorRegistry**: *string*
*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L17)*
___
### devUtils
• **devUtils**: *string*
*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L22)*
___
### dutchAuction
• **dutchAuction**: *string*
*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L16)*
___
### erc1155Proxy
• **erc1155Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L21)*
___
### erc20BridgeProxy
• **erc20BridgeProxy**: *string*
*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L26)*
___
### erc20Proxy
• **erc20Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L6)*
___
### erc721Proxy
• **erc721Proxy**: *string*
*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L7)*
___
### etherToken
• **etherToken**: *string*
*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L9)*
___
### exchange
• **exchange**: *string*
*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L11)*
___
### exchangeV2
• **exchangeV2**: *string*
*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L10)*
___
### forwarder
• **forwarder**: *string*
*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L14)*
___
### multiAssetProxy
• **multiAssetProxy**: *string*
*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L19)*
___
### orderValidator
• **orderValidator**: *string*
*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L15)*
___
### staking
• **staking**: *string*
*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L24)*
___
### stakingProxy
• **stakingProxy**: *string*
*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L25)*
___
### staticCallProxy
• **staticCallProxy**: *string*
*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L20)*
___
### zeroExGovernor
• **zeroExGovernor**: *string*
*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L13)*
___
### zrxToken
• **zrxToken**: *string*
*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L8)*
___
### zrxVault
• **zrxVault**: *string*
*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L23)*
<hr />
# Interface: ContractWrappersConfig
chainId: The id of the underlying ethereum chain your provider is connected to. (1-mainnet, 3-ropsten, 4-rinkeby, 42-kovan, 1337-testrpc)
gasPrice: Gas price to use with every transaction
contractAddresses: The address of all contracts to use. Defaults to the known addresses based on chainId.
blockPollingIntervalMs: The interval to use for block polling in event watching methods (defaults to 1000)
## Properties
### `Optional` blockPollingIntervalMs
• **blockPollingIntervalMs**? : *undefined | number*
*Defined in [contract-wrappers/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L40)*
___
### chainId
• **chainId**: *number*
*Defined in [contract-wrappers/src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L37)*
___
### `Optional` contractAddresses
• **contractAddresses**? : *[ContractAddresses](#class-contractaddresses)*
*Defined in [contract-wrappers/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L39)*
___
### `Optional` gasPrice
• **gasPrice**? : *`BigNumber`*
*Defined in [contract-wrappers/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L38)*
<hr />
# Interface: BlockRange
## Properties
### fromBlock
• **fromBlock**: *[BlockParam](#blockparam)*
*Defined in [ethereum-types/src/index.ts:743](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L743)*
___
### toBlock
• **toBlock**: *[BlockParam](#blockparam)*
*Defined in [ethereum-types/src/index.ts:744](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L744)*
<hr />
# Interface: CallData
## Properties
### `Optional` data
• **data**? : *undefined | string*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)*
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)*
___
### `Optional` from
• **from**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L403)*
___
### `Optional` gas
• **gas**? : *number | string | `BigNumber`*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)*
___
### `Optional` gasPrice
• **gasPrice**? : *number | string | `BigNumber`*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)*
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)*
___
### `Optional` nonce
• **nonce**? : *undefined | number*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)*
*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)*
___
### `Optional` to
• **to**? : *undefined | string*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)*
*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)*
___
### `Optional` value
• **value**? : *number | string | `BigNumber`*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)*
*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)*
<hr />
# Interface: CompilerOpts
## Properties
### name
• **name**: *"solc"*
*Defined in [ethereum-types/src/index.ts:656](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L656)*
___
### settings
• **settings**: *[CompilerSettings](#class-compilersettings)*
*Defined in [ethereum-types/src/index.ts:658](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L658)*
___
### version
• **version**: *string*
*Defined in [ethereum-types/src/index.ts:657](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L657)*
<hr />
# Interface: CompilerSettings
## Properties
### `Optional` evmVersion
• **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"*
*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L690)*
___
### `Optional` libraries
• **libraries**? : *undefined | object*
*Defined in [ethereum-types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L692)*
___
### `Optional` metadata
• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)*
*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L691)*
___
### `Optional` optimizer
• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)*
*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L689)*
___
### outputSelection
• **outputSelection**: *object*
*Defined in [ethereum-types/src/index.ts:697](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L697)*
#### Type declaration:
● \[▪ **fileName**: *string*\]: object
● \[▪ **contractName**: *string*\]: [OutputField](#outputfield)[]
___
### `Optional` remappings
• **remappings**? : *string[]*
*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L688)*
<hr />
# Interface: CompilerSettingsMetadata
## Properties
### useLiteralContent
• **useLiteralContent**: *true*
*Defined in [ethereum-types/src/index.ts:705](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L705)*
<hr />
# Interface: ConstructorAbi
## Properties
### inputs
• **inputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L103)*
___
### payable
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L104)*
___
### stateMutability
• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)*
*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L105)*
___
### type
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L102)*
<hr />
# Interface: ContractArtifact
This type defines the schema of the artifact.json file generated by Sol-compiler
schemaVersion: The version of the artifact schema
contractName: The contract name it represents
chains: Chain specific information by chain (address, id, constructor args, etc...)
compilerOutput: The Solidity compiler output generated from the specified compiler input
description (http://solidity.readthedocs.io/en/v0.4.24/using-the-compiler.html#compiler-input-and-output-json-description)
compiler: The compiler settings used
sourceCodes: The source code of the contract and all it's dependencies
sources: A mapping from source filePath to sourceMap id
sourceTreeHashHex: A unique hash generated from the contract source and that of it's dependencies.
If any of the sources change, the hash would change notifying us that a re-compilation is necessary
## Properties
### chains
• **chains**: *[ContractChains](#class-contractchains)*
*Defined in [ethereum-types/src/index.ts:677](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L677)*
___
### compiler
• **compiler**: *[CompilerOpts](#class-compileropts)*
*Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)*
*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L642)*
___
### compilerOutput
• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)*
*Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)*
*Defined in [ethereum-types/src/index.ts:652](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L652)*
___
### contractName
• **contractName**: *string*
*Defined in [ethereum-types/src/index.ts:676](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L676)*
___
### schemaVersion
• **schemaVersion**: *string*
*Defined in [ethereum-types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L675)*
___
### sourceCodes
• **sourceCodes**: *object*
*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)*
*Defined in [ethereum-types/src/index.ts:648](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L648)*
#### Type declaration:
● \[▪ **sourceName**: *string*\]: string
___
### sourceTreeHashHex
• **sourceTreeHashHex**: *string*
*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)*
*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L651)*
___
### sources
• **sources**: *object*
*Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)*
*Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L643)*
#### Type declaration:
● \[▪ **sourceName**: *string*\]: object
<hr />
# Interface: ContractChainData
## Properties
### address
• **address**: *string*
*Defined in [ethereum-types/src/index.ts:555](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L555)*
___
Args
• **constructorArgs**: *string*
*Defined in [ethereum-types/src/index.ts:559](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L559)*
___
### links
• **links**: *object*
*Defined in [ethereum-types/src/index.ts:556](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L556)*
#### Type declaration:
● \[▪ **linkName**: *string*\]: string
<hr />
# Interface: ContractChains
## Hierarchy
* **ContractVersionData**
* [ContractArtifact](#class-contractartifact)
## Properties
### compiler
• **compiler**: *[CompilerOpts](#class-compileropts)*
*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L642)*
___
### compilerOutput
• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)*
*Defined in [ethereum-types/src/index.ts:652](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L652)*
___
### sourceCodes
• **sourceCodes**: *object*
*Defined in [ethereum-types/src/index.ts:648](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L648)*
#### Type declaration:
● \[▪ **sourceName**: *string*\]: string
___
### sourceTreeHashHex
• **sourceTreeHashHex**: *string*
*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L651)*
___
### sources
• **sources**: *object*
*Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L643)*
#### Type declaration:
● \[▪ **sourceName**: *string*\]: object
<hr />
# Interface: DataItem
## Properties
### `Optional` components
• **components**? : *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)*
___
### `Optional` internalType
• **internalType**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)*
___
### name
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)*
___
### type
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
<hr />
# Interface: DecodedLogArgs
## Type parameters
▪ **A**
## Properties
### address
• **address**: *string*
*Inherited from [LogEntry](#interface-logentry).[address](#address)*
*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)*
___
### args
• **args**: *`A`*
*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)*
___
### blockHash
• **blockHash**: *string | null*
*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)*
*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)*
___
### blockNumber
• **blockNumber**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)*
*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)*
___
### data
• **data**: *string*
*Inherited from [LogEntry](#interface-logentry).[data](#data)*
*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)*
___
### event
• **event**: *string*
*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)*
___
### logIndex
• **logIndex**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)*
*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)*
___
### topics
• **topics**: *string[]*
*Inherited from [LogEntry](#interface-logentry).[topics](#topics)*
*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)*
___
### transactionHash
• **transactionHash**: *string*
*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)*
*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)*
___
### transactionIndex
• **transactionIndex**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)*
*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
<hr />
# Interface: DecodedLogEntryEvent <**A**>
## Type parameters
▪ **A**
## Properties
### address
• **address**: *string*
*Inherited from [LogEntry](#interface-logentry).[address](#address)*
*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)*
___
### args
• **args**: *`A`*
*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)*
*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)*
___
### blockHash
• **blockHash**: *string | null*
*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)*
*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)*
___
### blockNumber
• **blockNumber**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)*
*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)*
___
### data
• **data**: *string*
*Inherited from [LogEntry](#interface-logentry).[data](#data)*
*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)*
___
### event
• **event**: *string*
*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)*
*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)*
___
### logIndex
• **logIndex**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)*
*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)*
___
### removed
• **removed**: *boolean*
*Defined in [ethereum-types/src/index.ts:422](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L422)*
___
### topics
• **topics**: *string[]*
*Inherited from [LogEntry](#interface-logentry).[topics](#topics)*
*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)*
___
### transactionHash
• **transactionHash**: *string*
*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)*
*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)*
___
### transactionIndex
• **transactionIndex**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)*
*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
<hr />
# Interface: DevdocOutput
## Properties
### `Optional` author
• **author**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L629)*
___
### methods
• **methods**: *object*
*Defined in [ethereum-types/src/index.ts:630](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L630)*
#### Type declaration:
● \[▪ **signature**: *string*\]: object
___
### `Optional` title
• **title**? : *undefined | string*
*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L628)*
<hr />
# Interface: EIP1193Provider
## Properties
### isEIP1193
• **isEIP1193**: *boolean*
*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L73)*
## Methods
### on
▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this*
*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L75)*
**Parameters:**
▪ **event**: *[EIP1193Event](#eip1193event)*
▪ **listener**: *function*
▸ (`result`: any): *void*
**Parameters:**
Name | Type |
------ | ------ |
`result` | any |
**Returns:** *this*
___
### send
▸ **send**(`method`: string, `params?`: any[]): *`Promise<any>`*
*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L74)*
**Parameters:**
Name | Type |
------ | ------ |
`method` | string |
`params?` | any[] |
**Returns:** *`Promise<any>`*
<hr />
# Interface: EvmBytecodeOutput
## Properties
### object
• **object**: *string*
*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L623)*
___
### sourceMap
• **sourceMap**: *string*
*Defined in [ethereum-types/src/index.ts:624](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L624)*
<hr />
# Interface: EvmOutput
## Properties
### bytecode
• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L618)*
___
### deployedBytecode
• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)*
*Defined in [ethereum-types/src/index.ts:619](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L619)*
<hr />
# Interface: FallbackAbi
## Properties
### payable
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L112)*
___
### type
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L111)*
<hr />
# Interface: GanacheProvider
## Methods
### sendAsync
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L14)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
<hr />
# Interface: JSONRPCRequestPayload
## Properties
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)*
___
### method
• **method**: *string*
*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)*
___
### params
• **params**: *any[]*
*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
<hr />
# Interface: JSONRPCResponseError
## Properties
### code
• **code**: *number*
*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)*
___
### message
• **message**: *string*
*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
<hr />
# Interface: JSONRPCResponsePayload
## Properties
### `Optional` error
• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)*
*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)*
___
### id
• **id**: *number*
*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)*
___
### jsonrpc
• **jsonrpc**: *string*
*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)*
___
### result
• **result**: *any*
*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
<hr />
# Interface: LogEntry
## Properties
### address
• **address**: *string*
*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)*
___
### blockHash
• **blockHash**: *string | null*
*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)*
___
### blockNumber
• **blockNumber**: *number | null*
*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)*
___
### data
• **data**: *string*
*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)*
___
### logIndex
• **logIndex**: *number | null*
*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)*
___
### topics
• **topics**: *string[]*
*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)*
___
### transactionHash
• **transactionHash**: *string*
*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)*
___
### transactionIndex
• **transactionIndex**: *number | null*
*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
<hr />
# Interface: LogEntryEvent
## Properties
### address
• **address**: *string*
*Inherited from [LogEntry](#interface-logentry).[address](#address)*
*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)*
___
### blockHash
• **blockHash**: *string | null*
*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)*
*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)*
___
### blockNumber
• **blockNumber**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)*
*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)*
___
### data
• **data**: *string*
*Inherited from [LogEntry](#interface-logentry).[data](#data)*
*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)*
___
### logIndex
• **logIndex**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)*
*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)*
___
### removed
• **removed**: *boolean*
*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L426)*
___
### topics
• **topics**: *string[]*
*Inherited from [LogEntry](#interface-logentry).[topics](#topics)*
*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)*
___
### transactionHash
• **transactionHash**: *string*
*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)*
*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)*
___
### transactionIndex
• **transactionIndex**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)*
*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
<hr />
# Interface: LogWithDecodedArgs <**ArgsType**>
## Type parameters
▪ **ArgsType**: *[DecodedLogArgs](#class-decodedlogargs)*
## Properties
### address
• **address**: *string*
*Inherited from [LogEntry](#interface-logentry).[address](#address)*
*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)*
___
### args
• **args**: *`ArgsType`*
*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)*
*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)*
___
### blockHash
• **blockHash**: *string | null*
*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)*
*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)*
___
### blockNumber
• **blockNumber**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)*
*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)*
___
### data
• **data**: *string*
*Inherited from [LogEntry](#interface-logentry).[data](#data)*
*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)*
___
### event
• **event**: *string*
*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)*
*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)*
___
### logIndex
• **logIndex**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)*
*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)*
___
### topics
• **topics**: *string[]*
*Inherited from [LogEntry](#interface-logentry).[topics](#topics)*
*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)*
___
### transactionHash
• **transactionHash**: *string*
*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)*
*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)*
___
### transactionIndex
• **transactionIndex**: *number | null*
*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)*
*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
<hr />
# Interface: MethodAbi
## Properties
### constant
• **constant**: *boolean*
*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L94)*
___
### inputs
• **inputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L92)*
___
### name
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L91)*
___
### outputs
• **outputs**: *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L93)*
___
### payable
• **payable**: *boolean*
*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L96)*
___
### stateMutability
• **stateMutability**: *[StateMutability](#statemutability)*
*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L95)*
___
### type
• **type**: *string*
*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L90)*
<hr />
# Interface: OptimizerSettings
## Properties
### enabled
• **enabled**: *boolean*
*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L709)*
___
### `Optional` runs
• **runs**? : *undefined | number*
*Defined in [ethereum-types/src/index.ts:710](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L710)*
<hr />
# Interface: RevertErrorAbi
## Properties
### `Optional` arguments
• **arguments**? : *[DataItem](#class-dataitem)[]*
*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L122)*
___
### name
• **name**: *string*
*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L121)*
___
### type
• **type**: *"error"*
*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L120)*
<hr />
# Class: CoordinatorContract
## Constructors
\+ **new CoordinatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial<TxData>`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[CoordinatorContract](#class-coordinatorcontract)*
*Overrides void*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1163](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1163)*
**Parameters:**
Name | Type | Default |
------ | ------ | ------ |
`address` | string | - |
`supportedProvider` | [SupportedProvider](#supportedprovider) | - |
`txDefaults?` | `Partial<TxData>` | - |
`logDecodeDependencies?` | undefined \| object | - |
`deployedBytecode` | string \| undefined | CoordinatorContract.deployedBytecode |
**Returns:** *[CoordinatorContract](#class-coordinatorcontract)*
## Properties
### `Optional` _deployedBytecodeIfExists
• **_deployedBytecodeIfExists**? : *`Buffer`*
Defined in base-contract/lib/src/index.d.ts:32
___
### abi
• **abi**: *[ContractAbi](#contractabi)*
Defined in base-contract/lib/src/index.d.ts:28
___
### address
• **address**: *string*
Defined in base-contract/lib/src/index.d.ts:29
___
Args
• **constructorArgs**: *any[]*
Defined in base-contract/lib/src/index.d.ts:31
___
### contractName
• **contractName**: *string*
Defined in base-contract/lib/src/index.d.ts:30
## Methods
### EIP712_COORDINATOR_APPROVAL_SCHEMA_HASH
▸ **EIP712_COORDINATOR_APPROVAL_SCHEMA_HASH**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:483](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L483)*
**Returns:** *`ContractFunctionObj<string>`*
___
### EIP712_COORDINATOR_DOMAIN_HASH
▸ **EIP712_COORDINATOR_DOMAIN_HASH**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:533](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L533)*
**Returns:** *`ContractFunctionObj<string>`*
___
### EIP712_COORDINATOR_DOMAIN_NAME
▸ **EIP712_COORDINATOR_DOMAIN_NAME**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:580](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L580)*
**Returns:** *`ContractFunctionObj<string>`*
___
### EIP712_COORDINATOR_DOMAIN_VERSION
▸ **EIP712_COORDINATOR_DOMAIN_VERSION**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:627](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L627)*
**Returns:** *`ContractFunctionObj<string>`*
___
### EIP712_EXCHANGE_DOMAIN_HASH
▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:677](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L677)*
**Returns:** *`ContractFunctionObj<string>`*
___
### assertValidCoordinatorApprovals
▸ **assertValidCoordinatorApprovals**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalSignatures`: string[]): *`ContractFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:736](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L736)*
Validates that the 0x transaction has been approved by all of the feeRecipients
that correspond to each order in the transaction's Exchange calldata.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`transaction` | object | 0x transaction containing salt, signerAddress, and data. |
`txOrigin` | string | Required signer of Ethereum transaction calling this function. |
`transactionSignature` | string | Proof that the transaction has been signed by the signer. |
`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. |
**Returns:** *`ContractFunctionObj<void>`*
___
### decodeOrdersFromFillData
▸ **decodeOrdersFromFillData**(`data`: string): *`ContractFunctionObj<Array<object>>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:811](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L811)*
Decodes the orders from Exchange calldata representing any fill method.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`data` | string | Exchange calldata representing a fill method. |
**Returns:** *`ContractFunctionObj<Array<object>>`*
orders The orders from the Exchange calldata.
___
### executeTransaction
▸ **executeTransaction**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalSignatures`: string[]): *`ContractTxFunctionObj<void>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:919](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L919)*
Executes a 0x transaction that has been signed by the feeRecipients that correspond to
each order in the transaction's Exchange calldata.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`transaction` | object | 0x transaction containing salt, signerAddress, and data. |
`txOrigin` | string | Required signer of Ethereum transaction calling this function. |
`transactionSignature` | string | Proof that the transaction has been signed by the signer. |
`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. |
**Returns:** *`ContractTxFunctionObj<void>`*
___
### getABIDecodedReturnData
▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:469](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L469)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getABIDecodedTransactionData
▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:462](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L462)*
**Type parameters:**
▪ **T**
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
`callData` | string |
**Returns:** *`T`*
___
### getCoordinatorApprovalHash
▸ **getCoordinatorApprovalHash**(`approval`: object): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1060](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1060)*
Calculates the EIP712 hash of the Coordinator approval mesasage using the domain
separator of this contract.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`approval` | object | Coordinator approval message containing the transaction hash, and transaction signature. |
**Returns:** *`ContractFunctionObj<string>`*
approvalHash EIP712 hash of the Coordinator approval message with the domain separator of this contract.
___
### getFunctionSignature
▸ **getFunctionSignature**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:456](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L456)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getSelector
▸ **getSelector**(`methodName`: string): *string*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:476](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L476)*
**Parameters:**
Name | Type |
------ | ------ |
`methodName` | string |
**Returns:** *string*
___
### getSignerAddress
▸ **getSignerAddress**(`hash`: string, `signature`: string): *`ContractFunctionObj<string>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1122)*
Recovers the address of a signer given a hash and signature.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`hash` | string | Any 32 byte hash. |
`signature` | string | Proof that the hash has been signed by signer. |
**Returns:** *`ContractFunctionObj<string>`*
signerAddress Address of the signer.
___
### `Static` ABI
▸ **ABI**(): *[ContractAbi](#contractabi)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:128](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L128)*
**Returns:** *[ContractAbi](#contractabi)*
The contract ABI
___
### `Static` deployAsync
▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise<CoordinatorContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L80)*
**Parameters:**
Name | Type |
------ | ------ |
`bytecode` | string |
`abi` | [ContractAbi](#contractabi) |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`exchange` | string |
`chainId` | `BigNumber` |
**Returns:** *`Promise<CoordinatorContract>`*
___
### `Static` deployFrom0xArtifactAsync
▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial<TxData>`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise<CoordinatorContract>`*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L45)*
**Parameters:**
Name | Type |
------ | ------ |
`artifact` | `ContractArtifact` \| `SimpleContractArtifact` |
`supportedProvider` | [SupportedProvider](#supportedprovider) |
`txDefaults` | `Partial<TxData>` |
`logDecodeDependencies` | object |
`exchange` | string |
`chainId` | `BigNumber` |
**Returns:** *`Promise<CoordinatorContract>`*
___
### `Static` strictArgumentEncodingCheck
▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string*
Defined in base-contract/lib/src/index.d.ts:42
**Parameters:**
Name | Type |
------ | ------ |
`inputAbi` | `DataItem`[] |
`args` | any[] |
**Returns:** *string*
<hr />
# Interface: StandardContractOutput
## Properties
### abi
• **abi**: *[ContractAbi](#contractabi)*
*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L565)*
___
### `Optional` devdoc
• **devdoc**? : *[DevdocOutput](#class-devdocoutput)*
*Defined in [ethereum-types/src/index.ts:567](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L567)*
___
### evm
• **evm**: *[EvmOutput](#class-evmoutput)*
*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L566)*
<hr />
# Interface: TupleDataItem
## Properties
### components
• **components**: *[DataItem](#class-dataitem)[]*
*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)*
*Defined in [ethereum-types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L142)*
___
### `Optional` internalType
• **internalType**? : *undefined | string*
*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)*
*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)*
___
### name
• **name**: *string*
*Inherited from [DataItem](#interface-dataitem).[name](#name)*
*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)*
___
### type
• **type**: *string*
*Inherited from [DataItem](#interface-dataitem).[type](#type)*
*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
<hr />
# Interface: TxData
## Properties
### `Optional` data
• **data**? : *undefined | string*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)*
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)*
___
### from
• **from**: *string*
*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)*
___
### `Optional` gas
• **gas**? : *number | string | `BigNumber`*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)*
___
### `Optional` gasPrice
• **gasPrice**? : *number | string | `BigNumber`*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)*
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)*
___
### `Optional` nonce
• **nonce**? : *undefined | number*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)*
*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)*
___
### `Optional` to
• **to**? : *undefined | string*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)*
*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)*
___
### `Optional` value
• **value**? : *number | string | `BigNumber`*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)*
*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)*
<hr />
# Interface: TxDataPayable
## Properties
### `Optional` data
• **data**? : *undefined | string*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)*
*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)*
___
### from
• **from**: *string*
*Inherited from [TxData](#interface-txdata).[from](#from)*
*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)*
___
### `Optional` gas
• **gas**? : *number | string | `BigNumber`*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)*
*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)*
___
### `Optional` gasPrice
• **gasPrice**? : *number | string | `BigNumber`*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)*
*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)*
___
### `Optional` nonce
• **nonce**? : *undefined | number*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)*
*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)*
___
### `Optional` to
• **to**? : *undefined | string*
*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)*
*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)*
___
### `Optional` value
• **value**? : *`BigNumber`*
*Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)*
*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L443)*
<hr />
# Interface: Web3JsV1Provider
Web3.js version 1 provider interface
This provider interface was implemented in the pre-1.0Beta releases for Web3.js.
This interface allowed sending synchonous requests, support for which was later dropped.
## Methods
### send
▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)*
*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L45)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
**Returns:** *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)*
___
### sendAsync
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L44)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
<hr />
# Interface: Web3JsV2Provider
Web3.js version 2 provider interface
This provider interface was used in a couple of Web3.js 1.0 beta releases
before the first attempts to conform to EIP1193
## Methods
### send
▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L54)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
<hr />
# Interface: Web3JsV3Provider
Web3.js version 3 provider interface
This provider interface was implemented with the hopes for conforming to the EIP1193 spec,
however it does not conform entirely.
## Methods
### send
▸ **send**(`method`: string, `params?`: any[]): *`Promise<any>`*
*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L63)*
**Parameters:**
Name | Type |
------ | ------ |
`method` | string |
`params?` | any[] |
**Returns:** *`Promise<any>`*
<hr />
# Interface: ZeroExProvider
The interface for the provider used internally by 0x libraries
Any property we use from any SupportedProvider should we explicitly
add here
## Properties
### `Optional` isMetaMask
• **isMetaMask**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L31)*
___
### `Optional` isParity
• **isParity**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L32)*
___
### `Optional` isZeroExProvider
• **isZeroExProvider**? : *undefined | false | true*
*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L30)*
## Methods
### `Optional` enable
▸ **enable**(): *`Promise<void>`*
*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L34)*
**Returns:** *`Promise<void>`*
___
### sendAsync
▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void*
*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L35)*
**Parameters:**
Name | Type |
------ | ------ |
`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) |
`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) |
**Returns:** *void*
___
### `Optional` stop
▸ **stop**(): *void*
*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L33)*
**Returns:** *void*
<hr />
# Interface: DecodedLogEvent <**ArgsType**>
## Type parameters
▪ **ArgsType**: *`DecodedLogArgs`*
## Properties
### isRemoved
• **isRemoved**: *boolean*
*Defined in [types/src/index.ts:844](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L844)*
___
### log
• **log**: *`LogWithDecodedArgs<ArgsType>`*
*Defined in [types/src/index.ts:845](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L845)*
<hr />
# Interface: IndexedFilterValues
## Hierarchy
* **IndexSignature**
## Properties
### keyName
• **keyName**: *string*
*Defined in [types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L691)*
___
### keyType
• **keyType**: *[Type](#class-type)*
*Defined in [types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L692)*
___
### valueName
• **valueName**: *string*
*Defined in [types/src/index.ts:693](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L693)*
<hr />
# Interface: SimpleContractArtifact
## Properties
### chains
• **chains**: *`ContractChains`*
*Defined in [types/src/index.ts:861](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L861)*
___
### compilerOutput
• **compilerOutput**: *[SimpleStandardContractOutput](#class-simplestandardcontractoutput)*
*Defined in [types/src/index.ts:860](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L860)*
___
### contractName
• **contractName**: *string*
*Defined in [types/src/index.ts:859](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L859)*
___
### schemaVersion
• **schemaVersion**: *string*
*Defined in [types/src/index.ts:858](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L858)*
<hr />
# Interface: SimpleEvmBytecodeOutput
## Properties
### object
• **object**: *string*
*Defined in [types/src/index.ts:875](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L875)*
<hr />
# Interface: SimpleEvmOutput
## Properties
### bytecode
• **bytecode**: *[SimpleEvmBytecodeOutput](#class-simpleevmbytecodeoutput)*
*Defined in [types/src/index.ts:871](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L871)*
<hr />
# Interface: SimpleStandardContractOutput
## Properties
### abi
• **abi**: *[ContractAbi](#contractabi)*
*Defined in [types/src/index.ts:865](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L865)*
___
### `Optional` devdoc
• **devdoc**? : *[DevdocOutput](#class-devdocoutput)*
*Defined in [types/src/index.ts:867](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L867)*
___
### evm
• **evm**: *[SimpleEvmOutput](#class-simpleevmoutput)*
*Defined in [types/src/index.ts:866](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L866)*
<hr />
## Type aliases
### EventCallback
Ƭ **EventCallback**: *function*
*Defined in [types/src/index.ts:848](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L848)*
#### Type declaration:
▸ (`err`: null | `Error`, `log?`: [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*›): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | null \| `Error` |
`log?` | [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*› |
___
<hr />
## Type aliases
### CoordinatorRegistryEventArgs
Ƭ **CoordinatorRegistryEventArgs**: *[CoordinatorRegistryCoordinatorEndpointSetEventArgs](#interface-coordinatorregistrycoordinatorendpointseteventargs)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L37)*
<hr />
<hr />
## Type aliases
### DummyERC20TokenEventArgs
Ƭ **DummyERC20TokenEventArgs**: *[DummyERC20TokenApprovalEventArgs](#interface-dummyerc20tokenapprovaleventargs) | [DummyERC20TokenTransferEventArgs](#interface-dummyerc20tokentransfereventargs)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L37)*
<hr />
## Type aliases
### DummyERC721TokenEventArgs
Ƭ **DummyERC721TokenEventArgs**: *[DummyERC721TokenApprovalEventArgs](#interface-dummyerc721tokenapprovaleventargs) | [DummyERC721TokenApprovalForAllEventArgs](#interface-dummyerc721tokenapprovalforalleventargs) | [DummyERC721TokenTransferEventArgs](#interface-dummyerc721tokentransfereventargs)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L37)*
<hr />
## Type aliases
### ERC20TokenEventArgs
Ƭ **ERC20TokenEventArgs**: *[ERC20TokenTransferEventArgs](#interface-erc20tokentransfereventargs) | [ERC20TokenApprovalEventArgs](#interface-erc20tokenapprovaleventargs)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L37)*
<hr />
## Type aliases
### ERC721TokenEventArgs
Ƭ **ERC721TokenEventArgs**: *[ERC721TokenApprovalEventArgs](#interface-erc721tokenapprovaleventargs) | [ERC721TokenApprovalForAllEventArgs](#interface-erc721tokenapprovalforalleventargs) | [ERC721TokenTransferEventArgs](#interface-erc721tokentransfereventargs)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L37)*
<hr />
## Type aliases
### ExchangeEventArgs
Ƭ **ExchangeEventArgs**: *[ExchangeAssetProxyRegisteredEventArgs](#interface-exchangeassetproxyregisteredeventargs) | [ExchangeCancelEventArgs](#interface-exchangecanceleventargs) | [ExchangeCancelUpToEventArgs](#interface-exchangecanceluptoeventargs) | [ExchangeFillEventArgs](#interface-exchangefilleventargs) | [ExchangeProtocolFeeCollectorAddressEventArgs](#interface-exchangeprotocolfeecollectoraddresseventargs) | [ExchangeProtocolFeeMultiplierEventArgs](#interface-exchangeprotocolfeemultipliereventargs) | [ExchangeSignatureValidatorApprovalEventArgs](#interface-exchangesignaturevalidatorapprovaleventargs) | [ExchangeTransactionExecutionEventArgs](#interface-exchangetransactionexecutioneventargs)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L37)*
<hr />
<hr />
<hr />
<hr />
<hr />
## Type aliases
### WETH9EventArgs
Ƭ **WETH9EventArgs**: *[WETH9ApprovalEventArgs](#interface-weth9approvaleventargs) | [WETH9TransferEventArgs](#interface-weth9transfereventargs) | [WETH9DepositEventArgs](#interface-weth9depositeventargs) | [WETH9WithdrawalEventArgs](#interface-weth9withdrawaleventargs)*
*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L37)*
<hr />
## Type aliases
## Functions
### getContractAddressesForChainOrThrow
▸ **getContractAddressesForChainOrThrow**(`chainId`: [ChainId](#enumeration-chainid)): *[ContractAddresses](#interface-contractaddresses)*
*Defined in [contract-addresses/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L45)*
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
contracts deployed on the corresponding chain.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`chainId` | [ChainId](#enumeration-chainid) | The desired chainId. |
**Returns:** *[ContractAddresses](#interface-contractaddresses)*
The set of addresses for contracts which have been deployed on the
given chainId.
<hr />
<hr />
<hr />
## Type aliases
### AbiDefinition
Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)*
*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L80)*
___
### BlockParam
Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number*
*Defined in [ethereum-types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L484)*
___
### ConstructorStateMutability
Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"*
*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L84)*
___
### ContractAbi
Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]*
*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L78)*
___
### ContractEventArg
Ƭ **ContractEventArg**: *any*
*Defined in [ethereum-types/src/index.ts:469](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L469)*
___
### EIP1193Event
Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"*
*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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
___
### FunctionAbi
Ƭ **FunctionAbi**: *[MethodAbi](#interface-methodabi) | [ConstructorAbi](#interface-constructorabi) | [FallbackAbi](#interface-fallbackabi)*
*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L82)*
___
### JSONRPCErrorCallback
Ƭ **JSONRPCErrorCallback**: *function*
*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L3)*
#### Type declaration:
▸ (`err`: `Error` | null, `result?`: [JSONRPCResponsePayload](#interface-jsonrpcresponsepayload)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`err` | `Error` \| null |
`result?` | [JSONRPCResponsePayload](#interface-jsonrpcresponsepayload) |
___
### OutputField
Ƭ **OutputField**: *"*" | "ast" | "legacyAST" | "abi" | "devdoc" | "userdoc" | "metadata" | "ir" | "evm.assembly" | "evm.legacyAssembly" | "evm.bytecode.object" | "evm.bytecode.opcodes" | "evm.bytecode.sourceMap" | "evm.bytecode.linkReferences" | "evm.deployedBytecode.object" | "evm.deployedBytecode.opcodes" | "evm.deployedBytecode.sourceMap" | "evm.deployedBytecode.linkReferences" | "evm.methodIdentifiers" | "evm.gasEstimates" | "ewasm.wast" | "ewasm.wasm"*
*Defined in [ethereum-types/src/index.ts:526](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L526)*
___
### ParamDescription
Ƭ **ParamDescription**: *string*
*Defined in [ethereum-types/src/index.ts:562](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L562)*
___
### RawLog
Ƭ **RawLog**: *[LogEntry](#interface-logentry)*
*Defined in [ethereum-types/src/index.ts:476](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L476)*
___
### StateMutability
Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)*
*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L85)*
___
### SupportedProvider
Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)*
*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L9)*
Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library
Read more about Providers in the guides section of the 0x docs.
___
### Web3JsProvider
Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)*
*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L11)*
<hr />
Reference in New Issue View Git Blame Copy Permalink