# Class: CoordinatorRegistryContract ## Constructors \+ **new CoordinatorRegistryContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:516](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L516)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* ## Properties ### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### getLogsAsync ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:500](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L500)* 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 of logs that match the parameters ___ ### 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:458](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L458)* 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:483](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L483)* 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:489](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L489)* Cancels all existing subscriptions **Returns:** *void* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:386](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L386)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:344](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L344)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:313](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L313)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### getCoordinatorEndpoint #### ▪ **getCoordinatorEndpoint**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:227](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L227)* Gets the endpoint for a Coordinator. #### callAsync ▸ **callAsync**(`coordinatorOperator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:234](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L234)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `coordinatorOperator` | string | - | operator of the Coordinator endpoint. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:304](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L304)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:292](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L292)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`coordinatorOperator`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:279](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L279)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `coordinatorOperator` | string | operator of the Coordinator endpoint. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### setCoordinatorEndpoint #### ▪ **setCoordinatorEndpoint**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L52)* Called by a Coordinator operator to set the endpoint of their Coordinator. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:88](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L88)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `coordinatorEndpoint` | string | endpoint of the Coordinator. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`coordinatorEndpoint`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:148](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L148)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `coordinatorEndpoint` | string | - | endpoint of the Coordinator. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:115](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L115)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `coordinatorEndpoint` | string | endpoint of the Coordinator. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:216](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L216)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:204](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L204)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`coordinatorEndpoint`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:191](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L191)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `coordinatorEndpoint` | string | endpoint of the Coordinator. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L60)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `coordinatorEndpoint` | string | endpoint of the Coordinator. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:134](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L134)* **Parameters:** Name | Type | ------ | ------ | `coordinatorEndpoint` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: DevUtilsContract ## Constructors \+ **new DevUtilsContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DevUtilsContract](#class-devutilscontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3329](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3329)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[DevUtilsContract](#class-devutilscontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2549](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2549)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2501](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2501)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | `_zrxAssetData` | string | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2466](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2466)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | `_zrxAssetData` | string | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### ERC1155_PROXY_ID #### ▪ **ERC1155_PROXY_ID**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:206](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L206)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L212)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:271](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L271)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:259](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L259)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:249](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L249)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### ERC20_PROXY_ID #### ▪ **ERC20_PROXY_ID**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1008](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1008)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1014](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1014)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1073](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1073)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1061](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1061)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1051](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1051)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### ERC721_PROXY_ID #### ▪ **ERC721_PROXY_ID**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1499](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1499)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1505](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1505)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1564](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1564)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1552](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1552)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1542](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1542)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### MULTI_ASSET_PROXY_ID #### ▪ **MULTI_ASSET_PROXY_ID**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1660](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1660)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1666](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1666)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1725](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1725)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1713](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1713)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1703](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1703)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### STATIC_CALL_PROXY_ID #### ▪ **STATIC_CALL_PROXY_ID**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2295](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2295)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2301](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2301)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2360](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2360)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2348](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2348)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2338](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2338)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### decodeERC1155AssetData #### ▪ **decodeERC1155AssetData**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1336](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1336)* Decode ERC-1155 asset data from the format described in the AssetProxy contract specification. #### callAsync ▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber[], BigNumber[], string]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1345](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1345)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `assetData` | string | - | AssetProxy-compliant asset data describing an ERC-1155 set of assets. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise<[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 `memory` are returned as pointers to locations within the memory of the input parameter `assetData`. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, `BigNumber`[], `BigNumber`[], string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1404](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1404)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[string, string, `BigNumber`[], `BigNumber`[], string]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1392](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1392)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`assetData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1381](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1381)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | AssetProxy-compliant asset data describing an ERC-1155 set of assets. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### decodeERC20AssetData #### ▪ **decodeERC20AssetData**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1084](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1084)* Decode ERC-20 asset data from the format described in the AssetProxy contract specification. #### callAsync ▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1092](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1092)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `assetData` | string | - | AssetProxy-compliant asset data describing an ERC-20 asset. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise<[string, string]>`* The ERC-20 AssetProxy identifier, and the address of the ERC-20 contract hosting this asset. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1148](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1148)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[string, string]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1136)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`assetData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1125](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1125)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | AssetProxy-compliant asset data describing an ERC-20 asset. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### decodeERC721AssetData #### ▪ **decodeERC721AssetData**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L34)* Decode ERC-721 asset data from the format described in the AssetProxy contract specification. #### callAsync ▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L43)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `assetData` | string | - | AssetProxy-compliant asset data describing an ERC-721 asset. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise<[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. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[string, string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:100](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L100)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[string, string, `BigNumber`]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:88](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L88)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`assetData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:77](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L77)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | AssetProxy-compliant asset data describing an ERC-721 asset. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### decodeMultiAssetData #### ▪ **decodeMultiAssetData**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1937](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1937)* Decode multi-asset data from the format described in the AssetProxy contract specification. #### callAsync ▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, BigNumber[], string[]]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1945](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1945)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `assetData` | string | - | AssetProxy-compliant data describing a multi-asset basket. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise<[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. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[string, `BigNumber`[], string[]]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2001](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2001)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[string, `BigNumber`[], string[]]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1989](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1989)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`assetData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1978](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1978)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | AssetProxy-compliant data describing a multi-asset basket. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### decodeZeroExTransactionData #### ▪ **decodeZeroExTransactionData**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:559](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L559)* Decodes the call data for an Exchange contract method call. #### callAsync ▸ **callAsync**(`transactionData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, Array, BigNumber[], string[]]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:568](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L568)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `transactionData` | string | - | ABI-encoded calldata for an Exchange contract method call. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise<[string, Array, 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. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[string, `Array`, `BigNumber`[], string[]]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:667](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L667)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[string, `Array`, `BigNumber`[], string[]]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:655](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L655)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`transactionData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:642](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L642)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `transactionData` | string | ABI-encoded calldata for an Exchange contract method call. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### encodeERC1155AssetData #### ▪ **encodeERC1155AssetData**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1736](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1736)* Encode ERC-1155 asset data into the format described in the AssetProxy contract specification. #### callAsync ▸ **callAsync**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1749](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1749)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* AssetProxy-compliant asset data describing the set of assets. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1830](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1830)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1818](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1818)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1796](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1796)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string ___ ### encodeERC20AssetData #### ▪ **encodeERC20AssetData**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:478](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L478)* Encode ERC-20 asset data into the format described in the AssetProxy contract specification. #### callAsync ▸ **callAsync**(`tokenAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:487](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L487)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `tokenAddress` | string | - | The address of the ERC-20 contract hosting the asset to be traded. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* AssetProxy-compliant data describing the asset. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L548)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:536](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L536)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`tokenAddress`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:523](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L523)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `tokenAddress` | string | The address of the ERC-20 contract hosting the asset to be traded. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### encodeERC721AssetData #### ▪ **encodeERC721AssetData**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1575](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1575)* Encode ERC-721 asset data into the format described in the AssetProxy specification. #### callAsync ▸ **callAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1585](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1585)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* AssetProxy-compliant asset data describing the asset. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1652](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1652)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1640](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1640)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1625](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1625)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string ___ ### encodeMultiAssetData #### ▪ **encodeMultiAssetData**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2210](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2210)* Encode data for multiple assets, per the AssetProxy contract specification. #### callAsync ▸ **callAsync**(`amounts`: `BigNumber`[], `nestedAssetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2220](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2220)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `amounts` | `BigNumber`[] | - | The amounts of each asset to be traded. | `nestedAssetData` | string[] | - | AssetProxy-compliant data describing each asset to be traded. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* AssetProxy-compliant data describing the set of assets. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2287](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2287)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`[]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2275](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2275)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`BigNumber`[]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2260](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2260)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string ___ ### getAssetProxyAllowance #### ▪ **getAssetProxyAllowance**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2112](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2112)* 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. #### callAsync ▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2122](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2122)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `ownerAddress` | string | - | Owner of the assets specified by assetData. | `assetData` | string | - | Details of asset, encoded per the AssetProxy contract specification. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2199](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2199)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2187](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2187)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2172](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2172)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string ___ ### getBalance #### ▪ **getBalance**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:718](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L718)* 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. #### callAsync ▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:728](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L728)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `ownerAddress` | string | - | Owner of the assets specified by assetData. | `assetData` | string | - | Details of asset, encoded per the AssetProxy contract specification. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Number of assets (or asset baskets) held by owner. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:805](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L805)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:793](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L793)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:778](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L778)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string ___ ### getBalanceAndAssetProxyAllowance #### ▪ **getBalanceAndAssetProxyAllowance**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:111](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L111)* Calls getBalance() and getAllowance() for assetData. #### callAsync ▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:121](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L121)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `ownerAddress` | string | - | Owner of the assets specified by assetData. | `assetData` | string | - | Details of asset, encoded per the AssetProxy contract specification. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise<[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. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:198](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L198)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[`BigNumber`, `BigNumber`]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:186](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L186)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:171](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L171)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string ___ ### getBatchAssetProxyAllowances #### ▪ **getBatchAssetProxyAllowances**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:380](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L380)* Calls getAssetProxyAllowance() for each element of assetData. #### callAsync ▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:390](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L390)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `ownerAddress` | string | - | Owner of the assets specified by assetData. | `assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* An array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:467](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L467)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`[]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:455](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L455)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:440](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L440)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string ___ ### getBatchBalances #### ▪ **getBatchBalances**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2014](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2014)* Calls getBalance() for each element of assetData. #### callAsync ▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2024](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2024)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `ownerAddress` | string | - | Owner of the assets specified by assetData. | `assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Array of asset balances from getBalance(), with each element corresponding to the same-indexed element in the assetData input. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2101](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2101)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`[]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2089](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2089)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2074](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2074)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string ___ ### getBatchBalancesAndAssetProxyAllowances #### ▪ **getBatchBalancesAndAssetProxyAllowances**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2371](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2371)* Calls getBatchBalances() and getBatchAllowances() for each element of assetData. #### callAsync ▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber[], BigNumber[]]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2381](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2381)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `ownerAddress` | string | - | Owner of the assets specified by assetData. | `assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise<[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. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`[], `BigNumber`[]]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2458](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2458)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[`BigNumber`[], `BigNumber`[]]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string[]]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2446](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2446)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string[]]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2431](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2431)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string ___ ### getERC721TokenOwner #### ▪ **getERC721TokenOwner**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1841](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1841)* Calls `asset.ownerOf(tokenId)`, but returns a null owner instead of reverting on an unowned asset. #### callAsync ▸ **callAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1850](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1850)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `tokenAddress` | string | - | Address of ERC721 asset. | `tokenId` | `BigNumber` | - | The identifier for the specific NFT. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Owner of tokenId or null address if unowned. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1926](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1926)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1914](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1914)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1899)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `tokenAddress` | string | Address of ERC721 asset. | `tokenId` | `BigNumber` | The identifier for the specific NFT. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getEthBalances #### ▪ **getEthBalances**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1417)* Batch fetches ETH balances #### callAsync ▸ **callAsync**(`addresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1425)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `addresses` | string[] | - | Array of addresses. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Array of ETH balances. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`[]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1491](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1491)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`[]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string[]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1479](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1479)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string[]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`addresses`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1468](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1468)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `addresses` | string[] | Array of addresses. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getOrderRelevantState #### ▪ **getOrderRelevantState**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1159](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1159)* Fetches all order-relevant information needed to validate if the supplied order is fillable. #### callAsync ▸ **callAsync**(`order`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, BigNumber, boolean]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1170)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise<[object, BigNumber, boolean]>`* The orderInfo (hash, status, and `takerAssetAmount` already filled for the given order), fillableTakerAssetAmount (amount of the order's `takerAssetAmount` that is fillable given all on-chain state), and isValidSignature (validity of the provided signature). NOTE: If the `takerAssetData` encodes data for multiple assets, `fillableTakerAssetAmount` will represent a "scaled" amount, meaning it must be multiplied by all the individual asset amounts within the `takerAssetData` to get the final amount of each asset that can be filled. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[object, `BigNumber`, boolean]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1319](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1319)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[object, `BigNumber`, boolean]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1269](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1269)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[object, string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`order`: object, `signature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1239](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1239)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string ___ ### getOrderRelevantStates #### ▪ **getOrderRelevantStates**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:816](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L816)* Fetches all order-relevant information needed to validate if the supplied orders are fillable. #### callAsync ▸ **callAsync**(`orders`: `Array`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[Array, BigNumber[], boolean[]]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:827](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L827)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise<[Array, BigNumber[], boolean[]]>`* The ordersInfo (array of the hash, status, and `takerAssetAmount` already filled for each order), fillableTakerAssetAmounts (array of amounts for each order's `takerAssetAmount` that is fillable given all on-chain state), and isValidSignature (array containing the validity of each provided signature). NOTE: If the `takerAssetData` encodes data for multiple assets, each element of `fillableTakerAssetAmounts` will represent a "scaled" amount, meaning it must be multiplied by all the individual asset amounts within the `takerAssetData` to get the final amount of each asset that can be filled. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[`Array`, `BigNumber`[], boolean[]]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:986](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L986)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[`Array`, `BigNumber`[], boolean[]]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, string[]]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:936](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L936)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[`Array`, string[]]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `signatures`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:905](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L905)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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:** *string* The ABI encoded transaction data as a string ___ ### getTransferableAssetAmount #### ▪ **getTransferableAssetAmount**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:282](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L282)* Gets the amount of an asset transferable by the owner. #### callAsync ▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:292](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L292)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `ownerAddress` | string | - | Address of the owner of the asset. | `assetData` | string | - | Description of tokens, per the AssetProxy contract specification. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* The amount of the asset tranferable by the owner. NOTE: If the `assetData` encodes data for multiple assets, the `transferableAssetAmount` will represent the amount of times the entire `assetData` can be transferred. To calculate the total individual transferable amounts, this scaled `transferableAmount` must be multiplied by the individual asset amounts located within the `assetData`. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:369](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L369)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:357](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L357)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`ownerAddress`: string, `assetData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:342](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L342)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `ownerAddress` | string | Address of the owner of the asset. | `assetData` | string | Description of tokens, per the AssetProxy contract specification. | **Returns:** *string* The ABI encoded transaction data as a string
# Class: DummyERC20TokenContract ## Constructors \+ **new DummyERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2321)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### getLogsAsync ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2305](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2305)* 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 of logs that match the parameters ___ ### 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:2263](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2263)* 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 ___ ### unsubscribe ▸ **unsubscribe**(`subscriptionToken`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:2288](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2288)* 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:2294](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L2294)* Cancels all existing subscriptions **Returns:** *void* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1934](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1934)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1884](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1884)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_name` | string | `_symbol` | string | `_decimals` | `BigNumber` | `_totalSupply` | `BigNumber` | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1845](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1845)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_name` | string | `_symbol` | string | `_decimals` | `BigNumber` | `_totalSupply` | `BigNumber` | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### MAX_MINT_AMOUNT #### ▪ **MAX_MINT_AMOUNT**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1771](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1771)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1777](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1777)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1836](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1836)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1824](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1824)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1814](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1814)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### allowance #### ▪ **allowance**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1312](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1312)* #### callAsync ▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1321)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_owner` | string | - | The address of the account owning tokens | `_spender` | string | - | The address of the account able to transfer the tokens | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Amount of remaining tokens allowed to spent #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1397](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1397)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1385](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1385)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1370](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1370)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_owner` | string | The address of the account owning tokens | `_spender` | string | The address of the account able to transfer the tokens | **Returns:** *string* The ABI encoded transaction data as a string ___ ### approve #### ▪ **approve**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:133](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L133)* `msg.sender` approves `_spender` to spend `_value` tokens #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:179](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L179)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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 | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:253](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L253)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_spender` | string | - | The address of the account able to transfer the tokens | `_value` | `BigNumber` | - | The amount of wei to be approved for transfer | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Always true if the call has enough gas to complete execution #### estimateGasAsync ▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:209](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L209)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:329](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L329)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:317](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L317)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:302](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L302)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L142)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:236](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L236)* **Parameters:** Name | Type | ------ | ------ | `_spender` | string | `_value` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### balanceOf #### ▪ **balanceOf**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:721](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L721)* Query the balance of owner #### callAsync ▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:729](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L729)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_owner` | string | - | The address from which the balance will be retrieved | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Balance of owner #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:795](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L795)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:783](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L783)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_owner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:772](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L772)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_owner` | string | The address from which the balance will be retrieved | **Returns:** *string* The ABI encoded transaction data as a string ___ ### decimals #### ▪ **decimals**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:645](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L645)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:651](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L651)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:710](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L710)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:698](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L698)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:688](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L688)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### mint #### ▪ **mint**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:952](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L952)* Mints new tokens for sender #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:988](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L988)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_value` | `BigNumber` | Amount of tokens to mint | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1048](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1048)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_value` | `BigNumber` | - | Amount of tokens to mint | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1015](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1015)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_value` | `BigNumber` | Amount of tokens to mint | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1110](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1110)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1098](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1098)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[`BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_value`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1087](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1087)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_value` | `BigNumber` | Amount of tokens to mint | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:960](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L960)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_value` | `BigNumber` | Amount of tokens to mint | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1034](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1034)* **Parameters:** Name | Type | ------ | ------ | `_value` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### name #### ▪ **name**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L57)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L63)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:122](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L122)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:110](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L110)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:100](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L100)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### owner #### ▪ **owner**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:803](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L803)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:809](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L809)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:868](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L868)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:856](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L856)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:846](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L846)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### setBalance #### ▪ **setBalance**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1408](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1408)* Sets the balance of target address #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1454](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1454)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_target` | string | Address or which balance will be updated | `_value` | `BigNumber` | New balance of target address | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_target`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1527](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1527)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_target` | string | - | Address or which balance will be updated | `_value` | `BigNumber` | - | New balance of target address | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1484](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1484)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_target` | string | Address or which balance will be updated | `_value` | `BigNumber` | New balance of target address | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1603](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1603)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1591](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1591)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_target`: string, `_value`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1576](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1576)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_target` | string | Address or which balance will be updated | `_value` | `BigNumber` | New balance of target address | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1417)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_target` | string | Address or which balance will be updated | `_value` | `BigNumber` | New balance of target address | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1511](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1511)* **Parameters:** Name | Type | ------ | ------ | `_target` | string | `_value` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### symbol #### ▪ **symbol**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:876](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L876)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:882](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L882)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:941](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L941)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:929](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L929)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:919](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L919)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### totalSupply #### ▪ **totalSupply**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:340](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L340)* Query total supply of token #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:347](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L347)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* Total supply of token #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:406](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L406)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:394](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L394)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:384](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L384)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### transfer #### ▪ **transfer**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1121](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1121)* send `value` token to `to` from `msg.sender` #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1164](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1164)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_to` | string | The address of the recipient | `_value` | `BigNumber` | The amount of token to be transferred | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1231](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1231)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_to` | string | - | The address of the recipient | `_value` | `BigNumber` | - | The amount of token to be transferred | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* True if transfer was successful #### estimateGasAsync ▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1194](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1194)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_to` | string | The address of the recipient | `_value` | `BigNumber` | The amount of token to be transferred | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1304](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1304)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1292](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1292)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1277](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1277)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_to` | string | The address of the recipient | `_value` | `BigNumber` | The amount of token to be transferred | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1130)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_to` | string | The address of the recipient | `_value` | `BigNumber` | The amount of token to be transferred | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1214](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1214)* **Parameters:** Name | Type | ------ | ------ | `_to` | string | `_value` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transferFrom #### ▪ **transferFrom**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L417)* ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. See https://github.com/ethereum/EIPs/issues/717 #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:468](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L468)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | Address to transfer from. | `_to` | string | Address to transfer to. | `_value` | `BigNumber` | Amount to transfer. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:555](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L555)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_from` | string | - | Address to transfer from. | `_to` | string | - | Address to transfer to. | `_value` | `BigNumber` | - | Amount to transfer. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Success of transfer. #### estimateGasAsync ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:506](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L506)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | Address to transfer from. | `_to` | string | Address to transfer to. | `_value` | `BigNumber` | Amount to transfer. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:637](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L637)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:625](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L625)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:608](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L608)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | Address to transfer from. | `_to` | string | Address to transfer to. | `_value` | `BigNumber` | Amount to transfer. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L427)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | Address to transfer from. | `_to` | string | Address to transfer to. | `_value` | `BigNumber` | Amount to transfer. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:536](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L536)* **Parameters:** Name | Type | ------ | ------ | `_from` | string | `_to` | string | `_value` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transferOwnership #### ▪ **transferOwnership**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1611](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1611)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1645](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1645)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1700](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1700)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `newOwner` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1671](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1671)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1763](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1763)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1751](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1751)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1738](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1738)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1618](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1618)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1690](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1690)* **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: DummyERC721TokenContract ## Constructors \+ **new DummyERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2860](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2860)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### getLogsAsync ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2844](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2844)* 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 of logs that match the parameters ___ ### 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:2802](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2802)* 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 ___ ### unsubscribe ▸ **unsubscribe**(`subscriptionToken`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2827](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2827)* 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:2833](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2833)* Cancels all existing subscriptions **Returns:** *void* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2425)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2377](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2377)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_name` | string | `_symbol` | string | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2342](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2342)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_name` | string | `_symbol` | string | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### approve #### ▪ **approve**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:230](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L230)* 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. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:276](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L276)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_approved` | string | The new approved NFT controller | `_tokenId` | `BigNumber` | The NFT to approve | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:349](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L349)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_approved` | string | - | The new approved NFT controller | `_tokenId` | `BigNumber` | - | The NFT to approve | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:306](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L306)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_approved` | string | The new approved NFT controller | `_tokenId` | `BigNumber` | The NFT to approve | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L425)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:413](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L413)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:398](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L398)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_approved` | string | The new approved NFT controller | `_tokenId` | `BigNumber` | The NFT to approve | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:239](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L239)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_approved` | string | The new approved NFT controller | `_tokenId` | `BigNumber` | The NFT to approve | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:333](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L333)* **Parameters:** Name | Type | ------ | ------ | `_approved` | string | `_tokenId` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### balanceOf #### ▪ **balanceOf**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1185](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1185)* NFTs assigned to the zero address are considered invalid, and this function throws for queries about the zero address. #### callAsync ▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1193](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1193)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_owner` | string | - | An address for whom to query the balance | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* The number of NFTs owned by `_owner`, possibly zero #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1259](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1259)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1247](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1247)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_owner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1236](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1236)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_owner` | string | An address for whom to query the balance | **Returns:** *string* The ABI encoded transaction data as a string ___ ### burn #### ▪ **burn**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1417)* Function to burn a token Reverts if the given token ID doesn't exist or not called by contract owner #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1460](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1460)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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 | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1530](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1530)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_owner` | string | - | Owner of token with given token ID | `_tokenId` | `BigNumber` | - | ID of the token to be burned by the msg.sender | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1490](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1490)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1603](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1603)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1591](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1591)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_owner`: string, `_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1576](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1576)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1426)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1514](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1514)* **Parameters:** Name | Type | ------ | ------ | `_owner` | string | `_tokenId` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### getApproved #### ▪ **getApproved**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:143](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L143)* Throws if `_tokenId` is not a valid NFT. #### callAsync ▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:151](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L151)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_tokenId` | `BigNumber` | - | The NFT to find the approved address for | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* The approved address for this NFT, or the zero address if there is none #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L217)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:205](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L205)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`BigNumber`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:194](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L194)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_tokenId` | `BigNumber` | The NFT to find the approved address for | **Returns:** *string* The ABI encoded transaction data as a string ___ ### isApprovedForAll #### ▪ **isApprovedForAll**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2088](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2088)* #### callAsync ▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2097](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2097)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_owner` | string | - | The address that owns the NFTs | `_operator` | string | - | The address that acts on behalf of the owner | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* True if `_operator` is an approved operator for `_owner`, false otherwise #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2173](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2173)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2161](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2161)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_owner`: string, `_operator`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2146](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2146)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_owner` | string | The address that owns the NFTs | `_operator` | string | The address that acts on behalf of the owner | **Returns:** *string* The ABI encoded transaction data as a string ___ ### mint #### ▪ **mint**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:670](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L670)* Function to mint a new token Reverts if the given token ID already exists #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:713](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L713)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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 | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:783](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L783)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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 | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:743](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L743)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:856](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L856)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:844](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L844)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_to`: string, `_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:829](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L829)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:679](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L679)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:767](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L767)* **Parameters:** Name | Type | ------ | ------ | `_to` | string | `_tokenId` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### name #### ▪ **name**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:67](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L67)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:73](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L73)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:132](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L132)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:120](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L120)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:110](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L110)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### owner #### ▪ **owner**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1267](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1267)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1273)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1332](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1332)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1320](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1320)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1310](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1310)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### ownerOf #### ▪ **ownerOf**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1099](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1099)* NFTs assigned to zero address are considered invalid, and queries about them do throw. #### callAsync ▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1107)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_tokenId` | `BigNumber` | - | The identifier for an NFT | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* The address of the owner of the NFT #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1173](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1173)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1161](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1161)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`BigNumber`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1150](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1150)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_tokenId` | `BigNumber` | The identifier for an NFT | **Returns:** *string* The ABI encoded transaction data as a string ___ ### safeTransferFrom1 #### ▪ **safeTransferFrom1**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:868](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L868)* This works identically to the other function with an extra data parameter, except this function just sets data to "". #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:919](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L919)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1005](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1005)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_from` | string | - | The current owner of the NFT | `_to` | string | - | The new owner | `_tokenId` | `BigNumber` | - | The NFT to transfer | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:957](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L957)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1087](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1087)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1075](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1075)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1058](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1058)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:878](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L878)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:987](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L987)* **Parameters:** Name | Type | ------ | ------ | `_from` | string | `_to` | string | `_tokenId` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### safeTransferFrom2 #### ▪ **safeTransferFrom2**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1831](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1831)* 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)"))`. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1893](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1893)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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` | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1994](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1994)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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` | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1935](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1935)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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` | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2080](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2080)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`, string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2068](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2068)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string, `BigNumber`, string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2051](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2051)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1842](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1842)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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` | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1968](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1968)* **Parameters:** Name | Type | ------ | ------ | `_from` | string | `_to` | string | `_tokenId` | `BigNumber` | `_data` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### setApprovalForAll #### ▪ **setApprovalForAll**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1615](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1615)* Emits the ApprovalForAll event. The contract MUST allow multiple operators per owner. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1661](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1661)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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 | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_operator`: string, `_approved`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1738](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1738)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_operator` | string | - | Address to add to the set of authorized operators | `_approved` | boolean | - | True if the operator is approved, false to revoke approval | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1695](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1695)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1814](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1814)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, boolean]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1802](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1802)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, boolean]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1787](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1787)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1624](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1624)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1722](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1722)* **Parameters:** Name | Type | ------ | ------ | `_operator` | string | `_approved` | boolean | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### symbol #### ▪ **symbol**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1340](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1340)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1346](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1346)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1405](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1405)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1393](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1393)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1383](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1383)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### transferFrom #### ▪ **transferFrom**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:439](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L439)* 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. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:490](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L490)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:576](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L576)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_from` | string | - | The current owner of the NFT | `_to` | string | - | The new owner | `_tokenId` | `BigNumber` | - | The NFT to transfer | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:528](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L528)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:658](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L658)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:646](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L646)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:629](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L629)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:449](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L449)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:558](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L558)* **Parameters:** Name | Type | ------ | ------ | `_from` | string | `_to` | string | `_tokenId` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transferOwnership #### ▪ **transferOwnership**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2181)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2215](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2215)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2270](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2270)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `newOwner` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2241](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2241)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2333](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2333)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2321)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2308](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2308)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2188](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2188)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2260](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2260)* **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: DutchAuctionContract ## Constructors \+ **new DutchAuctionContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[DutchAuctionContract](#class-dutchauctioncontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:1248](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L1248)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[DutchAuctionContract](#class-dutchauctioncontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:956](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L956)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:909](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L909)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:876](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L876)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### getAuctionDetails #### ▪ **getAuctionDetails**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L34)* Calculates the Auction Details for the given order #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:88](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L88)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | object | The sell order | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L192)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `order` | object | - | The sell order | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* AuctionDetails #### estimateGasAsync ▸ **estimateGasAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:127](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L127)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | object | The sell order | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:334](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L334)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:292](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L292)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *object* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`order`: object): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:266](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L266)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | object | The sell order | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L42)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | object | The sell order | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:164](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L164)* **Parameters:** Name | Type | ------ | ------ | `order` | object | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### matchOrders #### ▪ **matchOrders**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:377](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L377)* Matches the buy and sell orders at an amount given the following: the current block time, the auction start time and the auction begin amount. The sell order is a an order at the lowest amount at the end of the auction. Excess from the match is transferred to the seller. Over time the price moves from beginAmount to endAmount given the current block.timestamp. sellOrder.expiryTimeSeconds is the end time of the auction. sellOrder.takerAssetAmount is the end amount of the auction (lowest possible amount). sellOrder.makerAssetData is the ABI encoded Asset Proxy data with the following data appended buyOrder.makerAssetData is the buyers bid on the auction, must meet the amount for the current block timestamp (uint256 beginTimeSeconds, uint256 beginAmount). This function reverts in the following scenarios: * Auction has not started (auctionDetails.currentTimeSeconds < auctionDetails.beginTimeSeconds) * Auction has expired (auctionDetails.endTimeSeconds < auctionDetails.currentTimeSeconds) * Amount is invalid: Buy order amount is too low (buyOrder.makerAssetAmount < auctionDetails.currentAmount) * Amount is invalid: Invalid begin amount (auctionDetails.beginAmount > auctionDetails.endAmount) * Any failure in the 0x Match Orders #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:459](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L459)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | `sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | `buySignature` | string | Proof that order was created by the buyer. | `sellSignature` | string | Proof that order was created by the seller. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:637](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L637)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `buyOrder` | object | - | The Buyer's order. This order is for the current expected price of the auction. | `sellOrder` | object | - | The Seller's order. This order is for the lowest amount (at the end of the auction). | `buySignature` | string | - | Proof that order was created by the buyer. | `sellSignature` | string | - | Proof that order was created by the seller. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* matchedFillResults amounts filled and fees paid by maker and taker of matched orders. #### estimateGasAsync ▸ **estimateGasAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:527](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L527)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | `sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | `buySignature` | string | Proof that order was created by the buyer. | `sellSignature` | string | Proof that order was created by the seller. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:836](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L836)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:794](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L794)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *object* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L748)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | `sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | `buySignature` | string | Proof that order was created by the buyer. | `sellSignature` | string | Proof that order was created by the seller. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:390](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L390)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `buyOrder` | object | The Buyer's order. This order is for the current expected price of the auction. | `sellOrder` | object | The Seller's order. This order is for the lowest amount (at the end of the auction). | `buySignature` | string | Proof that order was created by the buyer. | `sellSignature` | string | Proof that order was created by the seller. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:582](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L582)* **Parameters:** Name | Type | ------ | ------ | `buyOrder` | object | `sellOrder` | object | `buySignature` | string | `sellSignature` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: ERC1155ProxyContract ## Constructors \+ **new ERC1155ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC1155ProxyContract](#class-erc1155proxycontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1744](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1744)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[ERC1155ProxyContract](#class-erc1155proxycontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### getLogsAsync ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC1155ProxyEvents](#enumeration-erc1155proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1728](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1728)* Gets historical logs without creating a subscription **Type parameters:** ▪ **ArgsType**: *[ERC1155ProxyEventArgs](#erc1155proxyeventargs)* **Parameters:** Name | Type | Description | ------ | ------ | ------ | `eventName` | [ERC1155ProxyEvents](#enumeration-erc1155proxyevents) | The ERC1155Proxy 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 of logs that match the parameters ___ ### subscribe ▸ **subscribe**<**ArgsType**>(`eventName`: [ERC1155ProxyEvents](#enumeration-erc1155proxyevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1686](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1686)* Subscribe to an event type emitted by the ERC1155Proxy contract. **Type parameters:** ▪ **ArgsType**: *[ERC1155ProxyEventArgs](#erc1155proxyeventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `eventName` | [ERC1155ProxyEvents](#enumeration-erc1155proxyevents) | - | The ERC1155Proxy 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/erc1155_proxy.ts:1711](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1711)* 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/erc1155_proxy.ts:1717](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1717)* Cancels all existing subscriptions **Returns:** *void* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1470](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1470)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1428)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1403](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1403)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### addAuthorizedAddress #### ▪ **addAuthorizedAddress**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L60)* Authorizes an address. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:96](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L96)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:153](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L153)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `target` | string | - | Address to authorize. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:123](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L123)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L217)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:205](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L205)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`target`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L192)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L68)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L142)* **Parameters:** Name | Type | ------ | ------ | `target` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### authorities #### ▪ **authorities**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L225)* #### callAsync ▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:231](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L231)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | `BigNumber` | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:296](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L296)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:284](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L284)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`BigNumber`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L273)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | `BigNumber` | **Returns:** *string* The ABI encoded transaction data as a string ___ ### authorized #### ▪ **authorized**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1084](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1084)* #### callAsync ▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1090](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1090)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1157](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1157)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1145](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1145)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1132](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1132)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getAuthorizedAddresses #### ▪ **getAuthorizedAddresses**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1168)* Gets all authorized addresses. #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1175](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1175)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* Array of authorized addresses. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1234](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1234)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string[]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1222](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1222)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1212)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### getProxyId #### ▪ **getProxyId**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1020](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1020)* Gets the proxy id associated with the proxy address. #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1027](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1027)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* Proxy id. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1076](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1076)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1064](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1064)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1054](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1054)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### owner #### ▪ **owner**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:472](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L472)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:478](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L478)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:537](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L537)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:525](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L525)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:515](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L515)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### removeAuthorizedAddress #### ▪ **removeAuthorizedAddress**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:307](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L307)* Removes authorizion of an address. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:343](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L343)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:400](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L400)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `target` | string | - | Address to remove authorization from. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:370](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L370)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:464](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L464)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:452](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L452)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`target`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:439](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L439)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:315](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L315)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:389](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L389)* **Parameters:** Name | Type | ------ | ------ | `target` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### removeAuthorizedAddressAtIndex #### ▪ **removeAuthorizedAddressAtIndex**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L548)* Removes authorizion of an address. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:594](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L594)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`target`: string, `index`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:675](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L675)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `target` | string | - | Address to remove authorization from. | `index` | `BigNumber` | - | Index of target in authorities array. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:628](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L628)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:751](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L751)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:739](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L739)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:724](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L724)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:557](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L557)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:655](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L655)* **Parameters:** Name | Type | ------ | ------ | `target` | string | `index` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transferFrom #### ▪ **transferFrom**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:762](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L762)* Transfers batch of ERC1155 assets. Either succeeds or throws. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:822](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L822)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | `from` | string | Address to transfer assets from. | `to` | string | Address to transfer assets to. | `amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:921](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L921)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `assetData` | string | - | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | `from` | string | - | Address to transfer assets from. | `to` | string | - | Address to transfer assets to. | `amount` | `BigNumber` | - | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:866](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L866)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | `from` | string | Address to transfer assets from. | `to` | string | Address to transfer assets to. | `amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1009](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1009)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:997](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L997)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string, string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:980](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L980)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | `from` | string | Address to transfer assets from. | `to` | string | Address to transfer assets to. | `amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:775](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L775)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Byte array encoded with ERC1155 token address, array of ids, array of values, and callback data. | `from` | string | Address to transfer assets from. | `to` | string | Address to transfer assets to. | `amount` | `BigNumber` | Amount that will be multiplied with each element of `assetData.values` to scale the values that will be transferred. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L899)* **Parameters:** Name | Type | ------ | ------ | `assetData` | string | `from` | string | `to` | string | `amount` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transferOwnership #### ▪ **transferOwnership**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1242](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1242)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1276](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1276)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1331](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1331)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `newOwner` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1302](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1302)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1394](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1394)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1382](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1382)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1369](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1369)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1249](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1249)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1321)* **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: ERC20ProxyContract ## Constructors \+ **new ERC20ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC20ProxyContract](#class-erc20proxycontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1467](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1467)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[ERC20ProxyContract](#class-erc20proxycontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### getLogsAsync ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20ProxyEvents](#enumeration-erc20proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1451](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1451)* Gets historical logs without creating a subscription **Type parameters:** ▪ **ArgsType**: *[ERC20ProxyEventArgs](#erc20proxyeventargs)* **Parameters:** Name | Type | Description | ------ | ------ | ------ | `eventName` | [ERC20ProxyEvents](#enumeration-erc20proxyevents) | The ERC20Proxy 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 of logs that match the parameters ___ ### subscribe ▸ **subscribe**<**ArgsType**>(`eventName`: [ERC20ProxyEvents](#enumeration-erc20proxyevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1409](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1409)* Subscribe to an event type emitted by the ERC20Proxy contract. **Type parameters:** ▪ **ArgsType**: *[ERC20ProxyEventArgs](#erc20proxyeventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `eventName` | [ERC20ProxyEvents](#enumeration-erc20proxyevents) | - | The ERC20Proxy 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/erc20_proxy.ts:1434](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1434)* 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_proxy.ts:1440](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1440)* Cancels all existing subscriptions **Returns:** *void* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1212)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1170)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1145](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1145)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### addAuthorizedAddress #### ▪ **addAuthorizedAddress**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L60)* Authorizes an address. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:96](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L96)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:153](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L153)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `target` | string | - | Address to authorize. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:123](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L123)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L217)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:205](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L205)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`target`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L192)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L68)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L142)* **Parameters:** Name | Type | ------ | ------ | `target` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### authorities #### ▪ **authorities**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L225)* #### callAsync ▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:231](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L231)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | `BigNumber` | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:296](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L296)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:284](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L284)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`BigNumber`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L273)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | `BigNumber` | **Returns:** *string* The ABI encoded transaction data as a string ___ ### authorized #### ▪ **authorized**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:826](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L826)* #### callAsync ▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:832](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L832)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L899)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:887](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L887)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:874](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L874)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getAuthorizedAddresses #### ▪ **getAuthorizedAddresses**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:910](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L910)* Gets all authorized addresses. #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:917](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L917)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* Array of authorized addresses. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:976](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L976)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string[]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:964](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L964)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:954](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L954)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### getProxyId #### ▪ **getProxyId**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:762](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L762)* Gets the proxy id associated with the proxy address. #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:769](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L769)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* Proxy id. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:818](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L818)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:806](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L806)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:796](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L796)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### owner #### ▪ **owner**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:472](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L472)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:478](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L478)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:537](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L537)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:525](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L525)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:515](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L515)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### removeAuthorizedAddress #### ▪ **removeAuthorizedAddress**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:307](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L307)* Removes authorizion of an address. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:343](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L343)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:400](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L400)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `target` | string | - | Address to remove authorization from. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:370](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L370)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:464](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L464)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:452](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L452)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`target`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:439](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L439)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:315](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L315)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:389](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L389)* **Parameters:** Name | Type | ------ | ------ | `target` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### removeAuthorizedAddressAtIndex #### ▪ **removeAuthorizedAddressAtIndex**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L548)* Removes authorizion of an address. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:594](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L594)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`target`: string, `index`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:675](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L675)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `target` | string | - | Address to remove authorization from. | `index` | `BigNumber` | - | Index of target in authorities array. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:628](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L628)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:751](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L751)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:739](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L739)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:724](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L724)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:557](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L557)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:655](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L655)* **Parameters:** Name | Type | ------ | ------ | `target` | string | `index` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transferOwnership #### ▪ **transferOwnership**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:984](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L984)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1018](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1018)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1073](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1073)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `newOwner` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1044](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1044)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1136)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1124)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1111](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1111)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:991](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L991)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1063](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1063)* **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: ERC20TokenContract ## Constructors \+ **new ERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC20TokenContract](#class-erc20tokencontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1259](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1259)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[ERC20TokenContract](#class-erc20tokencontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### getLogsAsync ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1243](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1243)* 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 of logs that match the parameters ___ ### 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:1201](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1201)* 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 ___ ### unsubscribe ▸ **unsubscribe**(`subscriptionToken`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1226](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1226)* 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:1232](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1232)* Cancels all existing subscriptions **Returns:** *void* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1012](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1012)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:970](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L970)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:945](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L945)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### allowance #### ▪ **allowance**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:851](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L851)* #### callAsync ▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:860](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L860)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_owner` | string | - | The address of the account owning tokens | `_spender` | string | - | The address of the account able to transfer the tokens | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Amount of remaining tokens allowed to spent #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:936](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L936)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:924](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L924)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:909](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L909)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_owner` | string | The address of the account owning tokens | `_spender` | string | The address of the account able to transfer the tokens | **Returns:** *string* The ABI encoded transaction data as a string ___ ### approve #### ▪ **approve**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L60)* `msg.sender` approves `_spender` to spend `_value` tokens #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:106](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L106)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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 | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:180](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L180)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_spender` | string | - | The address of the account able to transfer the tokens | `_value` | `BigNumber` | - | The amount of wei to be approved for transfer | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Always true if the call has enough gas to complete execution #### estimateGasAsync ▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L136)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:256](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L256)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:244](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L244)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:229](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L229)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:69](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L69)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:163](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L163)* **Parameters:** Name | Type | ------ | ------ | `_spender` | string | `_value` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### balanceOf #### ▪ **balanceOf**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:575](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L575)* Query the balance of owner #### callAsync ▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:583](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L583)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_owner` | string | - | The address from which the balance will be retrieved | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Balance of owner #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:649](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L649)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:637](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L637)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_owner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:626](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L626)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_owner` | string | The address from which the balance will be retrieved | **Returns:** *string* The ABI encoded transaction data as a string ___ ### totalSupply #### ▪ **totalSupply**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:267](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L267)* Query total supply of token #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:274](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L274)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* Total supply of token #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:333](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L333)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L321)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:311](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L311)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### transfer #### ▪ **transfer**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:660](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L660)* send `value` token to `to` from `msg.sender` #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:703](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L703)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_to` | string | The address of the recipient | `_value` | `BigNumber` | The amount of token to be transferred | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:770](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L770)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_to` | string | - | The address of the recipient | `_value` | `BigNumber` | - | The amount of token to be transferred | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* True if transfer was successful #### estimateGasAsync ▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:733](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L733)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_to` | string | The address of the recipient | `_value` | `BigNumber` | The amount of token to be transferred | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:843](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L843)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:831](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L831)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:816](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L816)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_to` | string | The address of the recipient | `_value` | `BigNumber` | The amount of token to be transferred | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:669](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L669)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_to` | string | The address of the recipient | `_value` | `BigNumber` | The amount of token to be transferred | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:753](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L753)* **Parameters:** Name | Type | ------ | ------ | `_to` | string | `_value` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transferFrom #### ▪ **transferFrom**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:344](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L344)* send `value` token to `to` from `from` on the condition it is approved by `from` #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:395](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L395)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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 | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:482](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L482)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_from` | string | - | The address of the sender | `_to` | string | - | The address of the recipient | `_value` | `BigNumber` | - | The amount of token to be transferred | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* True if transfer was successful #### estimateGasAsync ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:433](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L433)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:564](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L564)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:552](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L552)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:535](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L535)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:354](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L354)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:463](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L463)* **Parameters:** Name | Type | ------ | ------ | `_from` | string | `_to` | string | `_value` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: ERC721ProxyContract ## Constructors \+ **new ERC721ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC721ProxyContract](#class-erc721proxycontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1467](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1467)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[ERC721ProxyContract](#class-erc721proxycontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### getLogsAsync ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721ProxyEvents](#enumeration-erc721proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1451](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1451)* Gets historical logs without creating a subscription **Type parameters:** ▪ **ArgsType**: *[ERC721ProxyEventArgs](#erc721proxyeventargs)* **Parameters:** Name | Type | Description | ------ | ------ | ------ | `eventName` | [ERC721ProxyEvents](#enumeration-erc721proxyevents) | The ERC721Proxy 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 of logs that match the parameters ___ ### subscribe ▸ **subscribe**<**ArgsType**>(`eventName`: [ERC721ProxyEvents](#enumeration-erc721proxyevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1409](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1409)* Subscribe to an event type emitted by the ERC721Proxy contract. **Type parameters:** ▪ **ArgsType**: *[ERC721ProxyEventArgs](#erc721proxyeventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `eventName` | [ERC721ProxyEvents](#enumeration-erc721proxyevents) | - | The ERC721Proxy 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/erc721_proxy.ts:1434](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1434)* 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_proxy.ts:1440](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1440)* Cancels all existing subscriptions **Returns:** *void* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1212)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1170)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1145](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1145)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### addAuthorizedAddress #### ▪ **addAuthorizedAddress**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L60)* Authorizes an address. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:96](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L96)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:153](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L153)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `target` | string | - | Address to authorize. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:123](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L123)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L217)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:205](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L205)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`target`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L192)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L68)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to authorize. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L142)* **Parameters:** Name | Type | ------ | ------ | `target` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### authorities #### ▪ **authorities**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L225)* #### callAsync ▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:231](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L231)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | `BigNumber` | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:296](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L296)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:284](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L284)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`BigNumber`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L273)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | `BigNumber` | **Returns:** *string* The ABI encoded transaction data as a string ___ ### authorized #### ▪ **authorized**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:826](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L826)* #### callAsync ▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:832](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L832)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L899)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:887](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L887)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:874](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L874)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getAuthorizedAddresses #### ▪ **getAuthorizedAddresses**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:910](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L910)* Gets all authorized addresses. #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:917](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L917)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* Array of authorized addresses. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string[]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:976](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L976)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string[]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:964](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L964)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:954](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L954)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### getProxyId #### ▪ **getProxyId**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:762](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L762)* Gets the proxy id associated with the proxy address. #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:769](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L769)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* Proxy id. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:818](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L818)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:806](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L806)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:796](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L796)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### owner #### ▪ **owner**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:472](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L472)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:478](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L478)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:537](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L537)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:525](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L525)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:515](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L515)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### removeAuthorizedAddress #### ▪ **removeAuthorizedAddress**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:307](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L307)* Removes authorizion of an address. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:343](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L343)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`target`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:400](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L400)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `target` | string | - | Address to remove authorization from. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:370](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L370)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:464](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L464)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:452](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L452)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`target`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:439](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L439)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:315](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L315)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:389](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L389)* **Parameters:** Name | Type | ------ | ------ | `target` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### removeAuthorizedAddressAtIndex #### ▪ **removeAuthorizedAddressAtIndex**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L548)* Removes authorizion of an address. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:594](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L594)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`target`: string, `index`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:675](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L675)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `target` | string | - | Address to remove authorization from. | `index` | `BigNumber` | - | Index of target in authorities array. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:628](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L628)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:751](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L751)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:739](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L739)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:724](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L724)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:557](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L557)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `target` | string | Address to remove authorization from. | `index` | `BigNumber` | Index of target in authorities array. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:655](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L655)* **Parameters:** Name | Type | ------ | ------ | `target` | string | `index` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transferOwnership #### ▪ **transferOwnership**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:984](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L984)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1018](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1018)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1073](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1073)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `newOwner` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1044](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1044)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1136)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1124)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1111](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1111)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:991](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L991)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1063](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1063)* **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: ERC721TokenContract ## Constructors \+ **new ERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ERC721TokenContract](#class-erc721tokencontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1961](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1961)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[ERC721TokenContract](#class-erc721tokencontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### getLogsAsync ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1945](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1945)* 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 of logs that match the parameters ___ ### 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:1903](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1903)* 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 ___ ### unsubscribe ▸ **unsubscribe**(`subscriptionToken`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1928](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1928)* 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:1934](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1934)* Cancels all existing subscriptions **Returns:** *void* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1634](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1634)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1592](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1592)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1567](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1567)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### approve #### ▪ **approve**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:157](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L157)* 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. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:203](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L203)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_approved` | string | The new approved NFT controller | `_tokenId` | `BigNumber` | The NFT to approve | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:276](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L276)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_approved` | string | - | The new approved NFT controller | `_tokenId` | `BigNumber` | - | The NFT to approve | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:233](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L233)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_approved` | string | The new approved NFT controller | `_tokenId` | `BigNumber` | The NFT to approve | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:352](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L352)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:340](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L340)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:325](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L325)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_approved` | string | The new approved NFT controller | `_tokenId` | `BigNumber` | The NFT to approve | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:166](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L166)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_approved` | string | The new approved NFT controller | `_tokenId` | `BigNumber` | The NFT to approve | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:260](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L260)* **Parameters:** Name | Type | ------ | ------ | `_approved` | string | `_tokenId` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### balanceOf #### ▪ **balanceOf**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:914](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L914)* NFTs assigned to the zero address are considered invalid, and this function throws for queries about the zero address. #### callAsync ▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:922](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L922)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_owner` | string | - | An address for whom to query the balance | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* The number of NFTs owned by `_owner`, possibly zero #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:988](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L988)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:976](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L976)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_owner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:965](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L965)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_owner` | string | An address for whom to query the balance | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getApproved #### ▪ **getApproved**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L70)* Throws if `_tokenId` is not a valid NFT. #### callAsync ▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:78](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L78)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_tokenId` | `BigNumber` | - | The NFT to find the approved address for | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* The approved address for this NFT, or the zero address if there is none #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:144](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L144)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:132](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L132)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`BigNumber`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:121](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L121)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_tokenId` | `BigNumber` | The NFT to find the approved address for | **Returns:** *string* The ABI encoded transaction data as a string ___ ### isApprovedForAll #### ▪ **isApprovedForAll**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1473](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1473)* #### callAsync ▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1482](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1482)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_owner` | string | - | The address that owns the NFTs | `_operator` | string | - | The address that acts on behalf of the owner | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* True if `_operator` is an approved operator for `_owner`, false otherwise #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1558](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1558)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1546](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1546)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_owner`: string, `_operator`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1531](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1531)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_owner` | string | The address that owns the NFTs | `_operator` | string | The address that acts on behalf of the owner | **Returns:** *string* The ABI encoded transaction data as a string ___ ### ownerOf #### ▪ **ownerOf**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:828](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L828)* NFTs assigned to zero address are considered invalid, and queries about them do throw. #### callAsync ▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:836](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L836)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_tokenId` | `BigNumber` | - | The identifier for an NFT | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* The address of the owner of the NFT #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:902](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L902)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:890](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L890)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`BigNumber`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:879](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L879)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_tokenId` | `BigNumber` | The identifier for an NFT | **Returns:** *string* The ABI encoded transaction data as a string ___ ### safeTransferFrom1 #### ▪ **safeTransferFrom1**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:597](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L597)* This works identically to the other function with an extra data parameter, except this function just sets data to "". #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:648](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L648)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:734](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L734)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_from` | string | - | The current owner of the NFT | `_to` | string | - | The new owner | `_tokenId` | `BigNumber` | - | The NFT to transfer | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:686](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L686)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:816](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L816)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:804](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L804)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:787](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L787)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:607](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L607)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:716](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L716)* **Parameters:** Name | Type | ------ | ------ | `_from` | string | `_to` | string | `_tokenId` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### safeTransferFrom2 #### ▪ **safeTransferFrom2**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1216](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1216)* 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)"))`. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1278](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1278)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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` | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1379](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1379)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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` | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1320](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1320)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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` | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1465](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1465)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`, string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1453](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1453)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string, `BigNumber`, string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1436](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1436)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1227](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1227)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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` | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1353](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1353)* **Parameters:** Name | Type | ------ | ------ | `_from` | string | `_to` | string | `_tokenId` | `BigNumber` | `_data` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### setApprovalForAll #### ▪ **setApprovalForAll**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1000](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1000)* Emits the ApprovalForAll event. The contract MUST allow multiple operators per owner. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1046](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1046)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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 | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_operator`: string, `_approved`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1123](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1123)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_operator` | string | - | Address to add to the set of authorized operators | `_approved` | boolean | - | True if the operator is approved, false to revoke approval | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1080](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1080)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1199](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1199)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, boolean]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1187](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1187)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, boolean]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1172](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1172)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1009](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1009)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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 | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1107)* **Parameters:** Name | Type | ------ | ------ | `_operator` | string | `_approved` | boolean | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transferFrom #### ▪ **transferFrom**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:366](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L366)* 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. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L417)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:503](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L503)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_from` | string | - | The current owner of the NFT | `_to` | string | - | The new owner | `_tokenId` | `BigNumber` | - | The NFT to transfer | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:455](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L455)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:585](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L585)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:573](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L573)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:556](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L556)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:376](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L376)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | The current owner of the NFT | `_to` | string | The new owner | `_tokenId` | `BigNumber` | The NFT to transfer | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:485](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L485)* **Parameters:** Name | Type | ------ | ------ | `_from` | string | `_to` | string | `_tokenId` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: ExchangeContract ## Constructors \+ **new ExchangeContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ExchangeContract](#class-exchangecontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9704](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9704)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[ExchangeContract](#class-exchangecontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### getLogsAsync ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9688](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9688)* 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 of logs that match the parameters ___ ### 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:9646](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9646)* 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 ___ ### unsubscribe ▸ **unsubscribe**(`subscriptionToken`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:9671](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9671)* 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:9677](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L9677)* Cancels all existing subscriptions **Returns:** *void* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7661](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7661)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_zrxAssetData`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7614](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7614)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_zrxAssetData` | string | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_zrxAssetData`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7581](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7581)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_zrxAssetData` | string | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### EIP712_DOMAIN_HASH #### ▪ **EIP712_DOMAIN_HASH**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6829](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6829)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6835](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6835)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6894](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6894)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6882](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6882)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6872](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6872)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### VERSION #### ▪ **VERSION**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7507](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7507)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7513](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7513)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7572](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7572)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7560](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7560)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7550](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7550)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### ZRX_ASSET_DATA #### ▪ **ZRX_ASSET_DATA**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6383](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6383)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6389](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6389)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6448](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6448)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6436](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6436)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6426)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### allowedValidators #### ▪ **allowedValidators**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3783](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3783)* #### callAsync ▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3789](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3789)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `index_1` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3863](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3863)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3851](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3851)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3836](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3836)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | `index_1` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### assetProxies #### ▪ **assetProxies**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1715](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1715)* #### callAsync ▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1721](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1721)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1782](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1782)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1770](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1770)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1759](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1759)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### batchCancelOrders #### ▪ **batchCancelOrders**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1793](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1793)* Synchronously cancels multiple orders in a single transaction. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1848](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1848)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`orders`: `Array`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1953](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1953)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | Array of order specifications. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1888](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1888)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2091](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2091)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2043](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2043)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[`Array`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2014](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2014)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1801](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1801)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1926](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1926)* **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### batchFillOrKillOrders #### ▪ **batchFillOrKillOrders**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2104](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2104)* Synchronously executes multiple calls of fillOrKill. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2169](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2169)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2301](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2301)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Amounts filled and fees paid by makers and taker. NOTE: makerAssetFilledAmount and takerAssetFilledAmount may include amounts filled of different assets. #### estimateGasAsync ▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2221](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2221)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2456](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2456)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2412](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2412)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`Array`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2379](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2379)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2115](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2115)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2263](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2263)* **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `takerAssetFillAmounts` | `BigNumber`[] | `signatures` | string[] | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### batchFillOrders #### ▪ **batchFillOrders**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:175](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L175)* Synchronously executes multiple calls of fillOrder. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:240](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L240)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:372](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L372)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Amounts filled and fees paid by makers and taker. NOTE: makerAssetFilledAmount and takerAssetFilledAmount may include amounts filled of different assets. #### estimateGasAsync ▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:292](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L292)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:527](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L527)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:483](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L483)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`Array`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:450](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L450)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:186](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L186)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:334](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L334)* **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `takerAssetFillAmounts` | `BigNumber`[] | `signatures` | string[] | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### batchFillOrdersNoThrow #### ▪ **batchFillOrdersNoThrow**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2663](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2663)* Fills an order with specified parameters and ECDSA signature. Returns false if the transaction would otherwise revert. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2728](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2728)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2860](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2860)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Amounts filled and fees paid by makers and taker. NOTE: makerAssetFilledAmount and takerAssetFilledAmount may include amounts filled of different assets. #### estimateGasAsync ▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2780](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2780)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3015](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3015)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2971](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2971)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`Array`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2938](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2938)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2674](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2674)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | 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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2822](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2822)* **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `takerAssetFillAmounts` | `BigNumber`[] | `signatures` | string[] | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### cancelOrder #### ▪ **cancelOrder**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5994](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5994)* After calling, the order can not be filled anymore. Throws if order is invalid or sender does not have permission to cancel. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6048](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6048)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6151](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6151)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `order` | object | - | Order to cancel. Order must be OrderStatus.FILLABLE. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6087](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6087)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6285](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6285)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[object]* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6237](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6237)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[object]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`order`: object): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6211](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6211)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6002](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6002)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | object | Order to cancel. Order must be OrderStatus.FILLABLE. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6124)* **Parameters:** Name | Type | ------ | ------ | `order` | object | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### cancelOrdersUpTo #### ▪ **cancelOrdersUpTo**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2482](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2482)* 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). #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2520](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2520)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`targetOrderEpoch`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2582](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2582)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `targetOrderEpoch` | `BigNumber` | - | Orders created with a salt less or equal to this value will be cancelled. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2548)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2651](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2651)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2639](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2639)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[`BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`targetOrderEpoch`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2626](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2626)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2491](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2491)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2567](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2567)* **Parameters:** Name | Type | ------ | ------ | `targetOrderEpoch` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### cancelled #### ▪ **cancelled**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:549](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L549)* #### callAsync ▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:555](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L555)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:620](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L620)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:608](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L608)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:597](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L597)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### currentContextAddress #### ▪ **currentContextAddress**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7274](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7274)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7280](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7280)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7339](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7339)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7327](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7327)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7317](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7317)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### executeTransaction #### ▪ **executeTransaction**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5404](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5404)* Executes an exchange method call in the context of signer. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5460](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5460)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | `signerAddress` | string | Address of transaction signer. | `data` | string | AbiV2 encoded calldata. | `signature` | string | Proof of signer transaction by signer. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5561](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5561)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `salt` | `BigNumber` | - | Arbitrary number to ensure uniqueness of transaction hash. | `signerAddress` | string | - | Address of transaction signer. | `data` | string | - | AbiV2 encoded calldata. | `signature` | string | - | Proof of signer transaction by signer. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5502](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5502)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | `signerAddress` | string | Address of transaction signer. | `data` | string | AbiV2 encoded calldata. | `signature` | string | Proof of signer transaction by signer. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5647](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5647)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`, string, string, string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5635](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5635)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[`BigNumber`, string, string, string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5618](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5618)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | `signerAddress` | string | Address of transaction signer. | `data` | string | AbiV2 encoded calldata. | `signature` | string | Proof of signer transaction by signer. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5415](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5415)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `salt` | `BigNumber` | Arbitrary number to ensure uniqueness of transaction hash. | `signerAddress` | string | Address of transaction signer. | `data` | string | AbiV2 encoded calldata. | `signature` | string | Proof of signer transaction by signer. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`salt`: `BigNumber`, `signerAddress`: string, `data`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5535](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5535)* **Parameters:** Name | Type | ------ | ------ | `salt` | `BigNumber` | `signerAddress` | string | `data` | string | `signature` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### fillOrKillOrder #### ▪ **fillOrKillOrder**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3204](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3204)* Fills the input order. Reverts if exact takerAssetFillAmount not filled. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3266](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3266)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3393](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3393)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3316](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3316)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3543](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3543)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3501](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3501)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *object* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3469](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3469)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3214](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3214)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3357](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3357)* **Parameters:** Name | Type | ------ | ------ | `order` | object | `takerAssetFillAmount` | `BigNumber` | `signature` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### fillOrder #### ▪ **fillOrder**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5044](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5044)* Fills the input order. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5106](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5106)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5229](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5229)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Amounts filled and fees paid by maker and taker. #### estimateGasAsync ▸ **estimateGasAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5151](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5151)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5379](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5379)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5337](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5337)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *object* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5305](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5305)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5054](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5054)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5192](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5192)* **Parameters:** Name | Type | ------ | ------ | `order` | object | `takerAssetFillAmount` | `BigNumber` | `signature` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### fillOrderNoThrow #### ▪ **fillOrderNoThrow**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1353](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1353)* Fills the input order. Returns false if the transaction would otherwise revert. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1415](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1415)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1543](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1543)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Amounts filled and fees paid by maker and taker. #### estimateGasAsync ▸ **estimateGasAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1465](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1465)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1693](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1693)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1651](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1651)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *object* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1619](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1619)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1363](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1363)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1506](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1506)* **Parameters:** Name | Type | ------ | ------ | `order` | object | `takerAssetFillAmount` | `BigNumber` | `signature` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### filled #### ▪ **filled**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:93](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L93)* #### callAsync ▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:99](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L99)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:164](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L164)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:152](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L152)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:141](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L141)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getAssetProxy #### ▪ **getAssetProxy**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3040](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3040)* Gets an asset proxy. #### callAsync ▸ **callAsync**(`assetProxyId`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3048](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3048)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `assetProxyId` | string | - | Id of the asset proxy. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* The asset proxy registered to assetProxyId. Returns 0x0 if no proxy is registered. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3114](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3114)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3102](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3102)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`assetProxyId`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3091](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3091)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetProxyId` | string | Id of the asset proxy. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getOrderInfo #### ▪ **getOrderInfo**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5834](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5834)* Gets information about an order: status, hash, and amount filled. #### callAsync ▸ **callAsync**(`order`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5842](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5842)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `order` | object | - | Order to gather information on. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* OrderInfo Information about the order and its state. See LibOrder.OrderInfo for a complete description. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5974](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5974)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5932](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5932)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *object* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`order`: object): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5906](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5906)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | object | Order to gather information on. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getOrdersInfo #### ▪ **getOrdersInfo**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4246](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4246)* Fetches information for all passed in orders. #### callAsync ▸ **callAsync**(`orders`: `Array`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4254](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4254)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | Array of order specifications. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise>`* Array of OrderInfo instances that correspond to each order. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4390](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4390)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`Array`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4346](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4346)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`Array`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4317](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4317)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### isValidSignature #### ▪ **isValidSignature**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4568](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4568)* Verifies that a hash has been signed by the given signer. #### callAsync ▸ **callAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4578](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4578)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* True if the address recovered from the provided signature matches the input signer address. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4660](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4660)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4648](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4648)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4631](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4631)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string ___ ### marketBuyOrders #### ▪ **marketBuyOrders**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6905](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6905)* Synchronously executes multiple calls of fillOrder until total amount of makerAsset is bought by taker. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6968](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6968)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | `signatures` | string[] | Proofs that orders have been signed by makers. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7098](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7098)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | Array of order specifications. | `makerAssetFillAmount` | `BigNumber` | - | Desired amount of makerAsset to buy. | `signatures` | string[] | - | Proofs that orders have been signed by makers. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Amounts filled and fees paid by makers and taker. #### estimateGasAsync ▸ **estimateGasAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7019](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7019)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | `signatures` | string[] | Proofs that orders have been signed by makers. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7252](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7252)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7208](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7208)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`Array`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7175](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7175)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | `signatures` | string[] | Proofs that orders have been signed by makers. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6915](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6915)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | `signatures` | string[] | Proofs that orders have been signed by makers. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7061](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7061)* **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `makerAssetFillAmount` | `BigNumber` | `signatures` | string[] | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### marketBuyOrdersNoThrow #### ▪ **marketBuyOrdersNoThrow**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4672](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4672)* Synchronously executes multiple fill orders in a single transaction until total amount is bought by taker. Returns false if the transaction would otherwise revert. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4735](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4735)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | `signatures` | string[] | Proofs that orders have been signed by makers. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4865](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4865)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | Array of order specifications. | `makerAssetFillAmount` | `BigNumber` | - | Desired amount of makerAsset to buy. | `signatures` | string[] | - | Proofs that orders have been signed by makers. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Amounts filled and fees paid by makers and taker. #### estimateGasAsync ▸ **estimateGasAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4786](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4786)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | `signatures` | string[] | Proofs that orders have been signed by makers. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5019](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5019)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4975](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4975)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`Array`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4942](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4942)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | `signatures` | string[] | Proofs that orders have been signed by makers. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4682](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4682)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to buy. | `signatures` | string[] | Proofs that orders have been signed by makers. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4828](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4828)* **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `makerAssetFillAmount` | `BigNumber` | `signatures` | string[] | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### marketSellOrders #### ▪ **marketSellOrders**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3874](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3874)* Synchronously executes multiple calls of fillOrder until total amount of takerAsset is sold by taker. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3937](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3937)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | `signatures` | string[] | Proofs that orders have been created by makers. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4067](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4067)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | Array of order specifications. | `takerAssetFillAmount` | `BigNumber` | - | Desired amount of takerAsset to sell. | `signatures` | string[] | - | Proofs that orders have been created by makers. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Amounts filled and fees paid by makers and taker. #### estimateGasAsync ▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3988](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3988)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | `signatures` | string[] | Proofs that orders have been created by makers. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4221](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4221)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4177](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4177)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`Array`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4144](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4144)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | `signatures` | string[] | Proofs that orders have been created by makers. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3884](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3884)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | `signatures` | string[] | Proofs that orders have been created by makers. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4030](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4030)* **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `takerAssetFillAmount` | `BigNumber` | `signatures` | string[] | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### marketSellOrdersNoThrow #### ▪ **marketSellOrdersNoThrow**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6460](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6460)* Synchronously executes multiple calls of fillOrder until total amount of takerAsset is sold by taker. Returns false if the transaction would otherwise revert. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6523](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6523)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | `signatures` | string[] | Proofs that orders have been signed by makers. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6653](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6653)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | Array of order specifications. | `takerAssetFillAmount` | `BigNumber` | - | Desired amount of takerAsset to sell. | `signatures` | string[] | - | Proofs that orders have been signed by makers. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Amounts filled and fees paid by makers and taker. #### estimateGasAsync ▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6574](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6574)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | `signatures` | string[] | Proofs that orders have been signed by makers. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6807](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6807)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6763](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6763)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`Array`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6730](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6730)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | `signatures` | string[] | Proofs that orders have been signed by makers. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6470](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6470)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications. | `takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | `signatures` | string[] | Proofs that orders have been signed by makers. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6616](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6616)* **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `takerAssetFillAmount` | `BigNumber` | `signatures` | string[] | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### matchOrders #### ▪ **matchOrders**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:860](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L860)* 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). #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:938](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L938)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1112](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1112)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* matchedFillResults Amounts filled and fees paid by maker and taker of matched orders. #### estimateGasAsync ▸ **estimateGasAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1004](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1004)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1309](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1309)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1267](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1267)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *object* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1221](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1221)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:871](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L871)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1059](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1059)* **Parameters:** Name | Type | ------ | ------ | `leftOrder` | object | `rightOrder` | object | `leftSignature` | string | `rightSignature` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### orderEpoch #### ▪ **orderEpoch**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6295](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6295)* #### callAsync ▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6301](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6301)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `index_1` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6375](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6375)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6363](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6363)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6348](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6348)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | `index_1` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### owner #### ▪ **owner**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4492](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4492)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4498](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4498)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4557](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4557)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4545](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4545)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4535](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4535)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### preSign #### ▪ **preSign**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:632](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L632)* Approves a hash on-chain using any valid signature type. After presigning a hash, the preSign signature type will become valid for that hash and signer. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:681](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L681)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `hash` | string | - | `signerAddress` | string | Address that should have signed the given hash. | `signature` | string | Proof that the hash has been signed by signer. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:765](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L765)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `hash` | string | - | - | `signerAddress` | string | - | Address that should have signed the given hash. | `signature` | string | - | Proof that the hash has been signed by signer. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:718](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L718)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `hash` | string | - | `signerAddress` | string | Address that should have signed the given hash. | `signature` | string | Proof that the hash has been signed by signer. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:846](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L846)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string, string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:834](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L834)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string, string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:817](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L817)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `hash` | string | - | `signerAddress` | string | Address that should have signed the given hash. | `signature` | string | Proof that the hash has been signed by signer. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:641](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L641)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `hash` | string | - | `signerAddress` | string | Address that should have signed the given hash. | `signature` | string | Proof that the hash has been signed by signer. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L748)* **Parameters:** Name | Type | ------ | ------ | `hash` | string | `signerAddress` | string | `signature` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### preSigned #### ▪ **preSigned**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4404](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4404)* #### callAsync ▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4410](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4410)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `index_1` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4484](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4484)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4472](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4472)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4457](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4457)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | `index_1` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### registerAssetProxy #### ▪ **registerAssetProxy**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5659](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5659)* Registers an asset proxy to its asset proxy id. Once an asset proxy is registered, it cannot be unregistered. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`assetProxy`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5695](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5695)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetProxy` | string | Address of new asset proxy to register. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`assetProxy`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5755](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5755)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `assetProxy` | string | - | Address of new asset proxy to register. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5722](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5722)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetProxy` | string | Address of new asset proxy to register. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5823](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5823)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5811](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5811)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`assetProxy`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5798](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5798)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetProxy` | string | Address of new asset proxy to register. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5667](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5667)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetProxy` | string | Address of new asset proxy to register. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5741](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5741)* **Parameters:** Name | Type | ------ | ------ | `assetProxy` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### setSignatureValidatorApproval #### ▪ **setSignatureValidatorApproval**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3568](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3568)* Approves/unnapproves a Validator contract to verify signatures on signer's behalf. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3618](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3618)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `validatorAddress` | string | Address of Validator contract. | `approval` | boolean | Approval or disapproval of Validator contract. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`validatorAddress`: string, `approval`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3699](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3699)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `validatorAddress` | string | - | Address of Validator contract. | `approval` | boolean | - | Approval or disapproval of Validator contract. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3652](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3652)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `validatorAddress` | string | Address of Validator contract. | `approval` | boolean | Approval or disapproval of Validator contract. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3775](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3775)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, boolean]* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3763](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3763)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, boolean]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`validatorAddress`: string, `approval`: boolean): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3748)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `validatorAddress` | string | Address of Validator contract. | `approval` | boolean | Approval or disapproval of Validator contract. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3577](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3577)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `validatorAddress` | string | Address of Validator contract. | `approval` | boolean | Approval or disapproval of Validator contract. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3679](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3679)* **Parameters:** Name | Type | ------ | ------ | `validatorAddress` | string | `approval` | boolean | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transactions #### ▪ **transactions**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3122](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3122)* #### callAsync ▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3128](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3128)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3193](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3193)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3181)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3170)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### transferOwnership #### ▪ **transferOwnership**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7347](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7347)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7381](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7381)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7436](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7436)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `newOwner` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7407](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7407)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7499](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7499)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7487](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7487)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7474](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7474)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7354](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7354)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7426)* **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: ForwarderContract ## Constructors \+ **new ForwarderContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ForwarderContract](#class-forwardercontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:2273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L2273)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[ForwarderContract](#class-forwardercontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1834](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1834)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string, `_wethAssetData`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1785](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1785)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | `_zrxAssetData` | string | `_wethAssetData` | string | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string, `_wethAssetData`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1748)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | `_zrxAssetData` | string | `_wethAssetData` | string | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### marketBuyOrdersWithEth #### ▪ **marketBuyOrdersWithEth**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:36](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L36)* Attempt to purchase makerAssetFillAmount of makerAsset by selling ETH provided with transaction. Any ZRX required to pay fees for primary orders will automatically be purchased by this contract. Any ETH not spent will be refunded to sender. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:151](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L151)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | `signatures` | string[] | Proofs that orders have been created by makers. | `feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | `feeSignatures` | string[] | Proofs that feeOrders 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. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, object]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:379](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L379)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `makerAssetFillAmount` | `BigNumber` | - | Desired amount of makerAsset to purchase. | `signatures` | string[] | - | Proofs that orders have been created by makers. | `feeOrders` | `Array` | - | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | `feeSignatures` | string[] | - | Proofs that feeOrders 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise<[object, object]>`* Amounts filled and fees paid by maker and taker for both sets of orders. #### estimateGasAsync ▸ **estimateGasAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:234](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L234)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | `signatures` | string[] | Proofs that orders have been created by makers. | `feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | `feeSignatures` | string[] | Proofs that feeOrders 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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[object, object]* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:660](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L660)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[object, object]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, `BigNumber`, string[], `Array`, string[], `BigNumber`, string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:574](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L574)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[`Array`, `BigNumber`, string[], `Array`, string[], `BigNumber`, string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:512](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L512)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | `signatures` | string[] | Proofs that orders have been created by makers. | `feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | `feeSignatures` | string[] | Proofs that feeOrders 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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L53)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `makerAssetFillAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | `signatures` | string[] | Proofs that orders have been created by makers. | `feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | `feeSignatures` | string[] | Proofs that feeOrders 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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:305](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L305)* **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `makerAssetFillAmount` | `BigNumber` | `signatures` | string[] | `feeOrders` | `Array` | `feeSignatures` | string[] | `feePercentage` | `BigNumber` | `feeRecipient` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### marketSellOrdersWithEth #### ▪ **marketSellOrdersWithEth**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:978](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L978)* Purchases as much of orders' makerAssets as possible by selling up to 95% of transaction's ETH value. Any ZRX required to pay fees for primary orders will automatically be purchased by this contract. 5% of ETH value is reserved for paying fees to order feeRecipients (in ZRX) and forwarding contract feeRecipient (in ETH). Any ETH not spent will be refunded to sender. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1080](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1080)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `signatures` | string[] | Proofs that orders have been created by makers. | `feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | `feeSignatures` | string[] | Proofs that feeOrders 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. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, object]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1290](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1290)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `Array` | - | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `signatures` | string[] | - | Proofs that orders have been created by makers. | `feeOrders` | `Array` | - | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | `feeSignatures` | string[] | - | Proofs that feeOrders 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. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise<[object, object]>`* Amounts filled and fees paid by maker and taker for both sets of orders. #### estimateGasAsync ▸ **estimateGasAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1159](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1159)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `signatures` | string[] | Proofs that orders have been created by makers. | `feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | `feeSignatures` | string[] | Proofs that feeOrders 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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[object, object]* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1548](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1548)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[object, object]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, string[], `Array`, string[], `BigNumber`, string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1464](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1464)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[`Array`, string[], `Array`, string[], `BigNumber`, string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1412](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1412)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `signatures` | string[] | Proofs that orders have been created by makers. | `feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | `feeSignatures` | string[] | Proofs that feeOrders 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:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:994](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L994)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | `signatures` | string[] | Proofs that orders have been created by makers. | `feeOrders` | `Array` | Array of order specifications containing ZRX as makerAsset and WETH as takerAsset. Used to purchase ZRX for primary order fees. | `feeSignatures` | string[] | Proofs that feeOrders 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. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`orders`: `Array`, `signatures`: string[], `feeOrders`: `Array`, `feeSignatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1220](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1220)* **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `signatures` | string[] | `feeOrders` | `Array` | `feeSignatures` | string[] | `feePercentage` | `BigNumber` | `feeRecipient` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### owner #### ▪ **owner**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L899)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:905](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L905)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:964](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L964)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:952](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L952)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:942](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L942)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### transferOwnership #### ▪ **transferOwnership**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1588](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1588)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1622](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1622)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1677](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1677)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `newOwner` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1648](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1648)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1740](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1740)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1728](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1728)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1715](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1715)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1595](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1595)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `newOwner` | string | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1667](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1667)* **Parameters:** Name | Type | ------ | ------ | `newOwner` | string | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### withdrawAsset #### ▪ **withdrawAsset**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:705](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L705)* Withdraws assets from this contract. The contract requires 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. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L748)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Byte array encoded for the respective asset proxy. | `amount` | `BigNumber` | Amount of ERC20 token to withdraw. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`assetData`: string, `amount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:818](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L818)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `assetData` | string | - | Byte array encoded for the respective asset proxy. | `amount` | `BigNumber` | - | Amount of ERC20 token to withdraw. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:778](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L778)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Byte array encoded for the respective asset proxy. | `amount` | `BigNumber` | Amount of ERC20 token to withdraw. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:891](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L891)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:879](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L879)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, `BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`assetData`: string, `amount`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:864](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L864)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Byte array encoded for the respective asset proxy. | `amount` | `BigNumber` | Amount of ERC20 token to withdraw. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:714](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L714)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Byte array encoded for the respective asset proxy. | `amount` | `BigNumber` | Amount of ERC20 token to withdraw. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:802](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L802)* **Parameters:** Name | Type | ------ | ------ | `assetData` | string | `amount` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: IValidatorContract ## Constructors \+ **new IValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[IValidatorContract](#class-ivalidatorcontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:232](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L232)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[IValidatorContract](#class-ivalidatorcontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:201](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L201)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:159](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L159)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:134](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L134)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### isValidSignature #### ▪ **isValidSignature**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L34)* Verifies that a signature is valid. #### callAsync ▸ **callAsync**(`hash`: string, `signerAddress`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L44)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `hash` | string | - | Message hash that is signed. | `signerAddress` | string | - | Address that should have signed the given hash. | `signature` | string | - | Proof of signing. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Magic bytes4 value if the signature is valid. Magic value is bytes4(keccak256("isValidValidatorSignature(address,bytes32,address,bytes)")) #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:126](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L126)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:114](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L114)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`hash`: string, `signerAddress`: string, `signature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:97](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L97)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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:** *string* The ABI encoded transaction data as a string
# Class: IWalletContract ## Constructors \+ **new IWalletContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[IWalletContract](#class-iwalletcontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:218](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L218)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[IWalletContract](#class-iwalletcontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:191](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L191)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:149](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L149)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L124)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### isValidSignature #### ▪ **isValidSignature**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L34)* Verifies that a signature is valid. #### callAsync ▸ **callAsync**(`hash`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L43)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `hash` | string | - | Message hash that is signed. | `signature` | string | - | Proof of signing. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Magic bytes4 value if the signature is valid. Magic value is bytes4(keccak256("isValidWalletSignature(bytes32,address,bytes)")) #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:116](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L116)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:104](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L104)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`hash`: string, `signature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:89](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L89)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `hash` | string | Message hash that is signed. | `signature` | string | Proof of signing. | **Returns:** *string* The ABI encoded transaction data as a string
# Class: OrderValidatorContract ## Constructors \+ **new OrderValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[OrderValidatorContract](#class-ordervalidatorcontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1751](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1751)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[OrderValidatorContract](#class-ordervalidatorcontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1190](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1190)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1142)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | `_zrxAssetData` | string | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1107)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | `_zrxAssetData` | string | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### getBalanceAndAllowance #### ▪ **getBalanceAndAllowance**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:244](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L244)* #### callAsync ▸ **callAsync**(`target`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:250](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L250)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `target` | string | - | `assetData` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise<[BigNumber, BigNumber]>`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`, `BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:324](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L324)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[`BigNumber`, `BigNumber`]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:312](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L312)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`target`: string, `assetData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:297](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L297)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `target` | string | `assetData` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getBalancesAndAllowances #### ▪ **getBalancesAndAllowances**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:832](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L832)* #### callAsync ▸ **callAsync**(`target`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber[], BigNumber[]]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:838](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L838)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `target` | string | - | `assetData` | string[] | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise<[BigNumber[], BigNumber[]]>`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[`BigNumber`[], `BigNumber`[]]* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:912](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L912)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[`BigNumber`[], `BigNumber`[]]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[string, string[]]* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:900](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L900)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[string, string[]]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`target`: string, `assetData`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:885](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L885)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `target` | string | `assetData` | string[] | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getERC721TokenOwner #### ▪ **getERC721TokenOwner**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:744](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L744)* #### callAsync ▸ **callAsync**(`token`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:750](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L750)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `token` | string | - | `tokenId` | `BigNumber` | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:824](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L824)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:812](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L812)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`token`: string, `tokenId`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:797](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L797)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `token` | string | `tokenId` | `BigNumber` | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getOrderAndTraderInfo #### ▪ **getOrderAndTraderInfo**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:31](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L31)* #### callAsync ▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, object]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L37)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `order` | object | - | `takerAddress` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise<[object, object]>`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[object, object]* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:206](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L206)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[object, object]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string]* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:156](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L156)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[object, string]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:126](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L126)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `order` | object | `takerAddress` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getOrdersAndTradersInfo #### ▪ **getOrdersAndTradersInfo**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:332](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L332)* #### callAsync ▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[Array, Array]>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:338](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L338)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `orders` | `Array` | - | `takerAddresses` | string[] | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise<[Array, Array]>`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *[`Array`, `Array`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:509](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L509)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *[`Array`, `Array`]* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[`Array`, string[]]* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:459](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L459)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[`Array`, string[]]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L428)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `takerAddresses` | string[] | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getTraderInfo #### ▪ **getTraderInfo**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:920](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L920)* #### callAsync ▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:926](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L926)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `order` | object | - | `takerAddress` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1077](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1077)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *object* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1035](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1035)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *object* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1005](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1005)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `order` | object | `takerAddress` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getTradersInfo #### ▪ **getTradersInfo**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:547](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L547)* #### callAsync ▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:553](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L553)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `orders` | `Array` | - | `takerAddresses` | string[] | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise>`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:712](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L712)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`Array`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:668](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L668)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *`Array`* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:637](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L637)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `orders` | `Array` | `takerAddresses` | string[] | **Returns:** *string* The ABI encoded transaction data as a string
# Class: WETH9Contract ## Constructors \+ **new WETH9Contract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[WETH9Contract](#class-weth9contract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1831](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1831)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[WETH9Contract](#class-weth9contract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### getLogsAsync ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1815](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1815)* 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 of logs that match the parameters ___ ### 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:1773](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1773)* 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 ___ ### unsubscribe ▸ **unsubscribe**(`subscriptionToken`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1798](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1798)* 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:1804](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1804)* Cancels all existing subscriptions **Returns:** *void* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1476](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1476)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1434](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1434)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1409](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1409)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### allowance #### ▪ **allowance**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1320](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1320)* #### callAsync ▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1326](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1326)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `index_1` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1400](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1400)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1388](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1388)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string, `index_1`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1373](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1373)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | `index_1` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### approve #### ▪ **approve**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:146](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L146)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L181)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `guy` | string | - | `wad` | `BigNumber` | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`guy`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:243](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L243)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `guy` | string | - | `wad` | `BigNumber` | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:209](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L209)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `guy` | string | - | `wad` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:314](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L314)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:302](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L302)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`guy`: string, `wad`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:287](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L287)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `guy` | string | `wad` | `BigNumber` | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:153](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L153)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `guy` | string | - | `wad` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:229](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L229)* **Parameters:** Name | Type | ------ | ------ | `guy` | string | `wad` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### balanceOf #### ▪ **balanceOf**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:838](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L838)* #### callAsync ▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:844](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L844)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `index_0` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:911](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L911)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:899](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L899)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`index_0`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:886](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L886)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `index_0` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### decimals #### ▪ **decimals**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:765](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L765)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:771](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L771)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *number* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:830](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L830)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *number* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:818](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L818)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:808](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L808)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### deposit #### ▪ **deposit**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1168)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1201](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1201)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1253](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1253)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1225)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1312](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1312)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1300](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1300)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1290](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1290)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1175](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1175)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1243](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1243)* **Parameters:** Name | Type | ------ | ------ | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### name #### ▪ **name**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:73](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L73)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:79](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L79)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:138](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L138)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:126](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L126)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:116](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L116)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### symbol #### ▪ **symbol**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:919](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L919)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:925](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L925)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:984](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L984)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:972](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L972)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:962](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L962)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### totalSupply #### ▪ **totalSupply**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:322](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L322)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:328](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L328)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:387](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L387)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:375](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L375)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:365](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L365)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### transfer #### ▪ **transfer**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:992](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L992)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1027](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1027)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `dst` | string | - | `wad` | `BigNumber` | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`dst`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1089](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1089)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `dst` | string | - | `wad` | `BigNumber` | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1055](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1055)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `dst` | string | - | `wad` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1160](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1160)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1148](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1148)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`dst`: string, `wad`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1133](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1133)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `dst` | string | `wad` | `BigNumber` | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:999](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L999)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `dst` | string | - | `wad` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1075](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1075)* **Parameters:** Name | Type | ------ | ------ | `dst` | string | `wad` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transferFrom #### ▪ **transferFrom**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:395](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L395)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:440](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L440)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `src` | string | - | `dst` | string | - | `wad` | `BigNumber` | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:520](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L520)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `src` | string | - | `dst` | string | - | `wad` | `BigNumber` | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:475](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L475)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `src` | string | - | `dst` | string | - | `wad` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:599](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L599)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:587](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L587)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`src`: string, `dst`: string, `wad`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:570](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L570)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `src` | string | `dst` | string | `wad` | `BigNumber` | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:402](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L402)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `src` | string | - | `dst` | string | - | `wad` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:505](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L505)* **Parameters:** Name | Type | ------ | ------ | `src` | string | `dst` | string | `wad` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### withdraw #### ▪ **withdraw**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:607](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L607)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`wad`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:641](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L641)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `wad` | `BigNumber` | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:696](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L696)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `wad` | `BigNumber` | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:667](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L667)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `wad` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:757](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L757)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[`BigNumber`]* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:745](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L745)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[`BigNumber`]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`wad`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:734](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L734)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `wad` | `BigNumber` | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:614](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L614)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `wad` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:686](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L686)* **Parameters:** Name | Type | ------ | ------ | `wad` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# Class: ZRXTokenContract ## Constructors \+ **new ZRXTokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[ZRXTokenContract](#class-zrxtokencontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1474](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1474)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[ZRXTokenContract](#class-zrxtokencontract)* ## Properties #### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### getLogsAsync ▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ZRXTokenEvents](#enumeration-zrxtokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1458](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1458)* Gets historical logs without creating a subscription **Type parameters:** ▪ **ArgsType**: *[ZRXTokenEventArgs](#zrxtokeneventargs)* **Parameters:** Name | Type | Description | ------ | ------ | ------ | `eventName` | [ZRXTokenEvents](#enumeration-zrxtokenevents) | The ZRXToken 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 of logs that match the parameters ___ ### subscribe ▸ **subscribe**<**ArgsType**>(`eventName`: [ZRXTokenEvents](#enumeration-zrxtokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1416](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1416)* Subscribe to an event type emitted by the ZRXToken contract. **Type parameters:** ▪ **ArgsType**: *[ZRXTokenEventArgs](#zrxtokeneventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `eventName` | [ZRXTokenEvents](#enumeration-zrxtokenevents) | - | The ZRXToken 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/zrx_token.ts:1441](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1441)* 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/zrx_token.ts:1447](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1447)* Cancels all existing subscriptions **Returns:** *void* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1188](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1188)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1146](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1146)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1121](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1121)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### allowance #### ▪ **allowance**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1032](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1032)* #### callAsync ▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1038](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1038)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `_owner` | string | - | `_spender` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1112](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1112)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1100](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1100)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_owner`: string, `_spender`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1085](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1085)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `_owner` | string | `_spender` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### approve #### ▪ **approve**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L130)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:172](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L172)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_spender` | string | - | `_value` | `BigNumber` | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:241](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L241)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `_spender` | string | - | `_value` | `BigNumber` | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:200](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L200)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_spender` | string | - | `_value` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:315](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L315)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:303](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L303)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:288](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L288)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `_spender` | string | `_value` | `BigNumber` | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:137](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L137)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_spender` | string | - | `_value` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:227](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L227)* **Parameters:** Name | Type | ------ | ------ | `_spender` | string | `_value` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### balanceOf #### ▪ **balanceOf**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:700](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L700)* #### callAsync ▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:706](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L706)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `_owner` | string | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:771](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L771)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:759](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L759)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_owner`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:748](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L748)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `_owner` | string | **Returns:** *string* The ABI encoded transaction data as a string ___ ### decimals #### ▪ **decimals**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:627](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L627)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:633](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L633)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *number* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:692](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L692)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *number* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:680](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L680)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:670](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L670)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### name #### ▪ **name**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L57)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L63)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:122](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L122)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:110](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L110)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:100](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L100)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### symbol #### ▪ **symbol**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:779](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L779)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:785](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L785)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:844](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L844)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:832](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L832)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:822](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L822)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### totalSupply #### ▪ **totalSupply**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:323](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L323)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:329](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L329)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:388](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L388)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`BigNumber`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:376](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L376)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:366](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L366)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### transfer #### ▪ **transfer**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:852](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L852)* #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:891](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L891)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_to` | string | - | `_value` | `BigNumber` | - | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:953](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L953)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `_to` | string | - | `_value` | `BigNumber` | - | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:919](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L919)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_to` | string | - | `_value` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1024](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1024)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1012](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1012)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:997](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L997)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | ------ | ------ | `_to` | string | `_value` | `BigNumber` | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:859](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L859)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_to` | string | - | `_value` | `BigNumber` | - | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:939](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L939)* **Parameters:** Name | Type | ------ | ------ | `_to` | string | `_value` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### transferFrom #### ▪ **transferFrom**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:399](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L399)* ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:450](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L450)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | Address to transfer from. | `_to` | string | Address to transfer to. | `_value` | `BigNumber` | Amount to transfer. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:537](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L537)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `_from` | string | - | Address to transfer from. | `_to` | string | - | Address to transfer to. | `_value` | `BigNumber` | - | Amount to transfer. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* Success of transfer. #### estimateGasAsync ▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:488](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L488)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | Address to transfer from. | `_to` | string | Address to transfer to. | `_value` | `BigNumber` | Amount to transfer. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:619](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L619)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *boolean* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:607](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L607)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:590](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L590)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | Address to transfer from. | `_to` | string | Address to transfer to. | `_value` | `BigNumber` | Amount to transfer. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:409](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L409)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `_from` | string | Address to transfer from. | `_to` | string | Address to transfer to. | `_value` | `BigNumber` | Amount to transfer. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:518](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L518)* **Parameters:** Name | Type | ------ | ------ | `_from` | string | `_to` | string | `_value` | `BigNumber` | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`*
# 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:84](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L84)* 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:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L43)* An index of the default contract addresses for this network. ___ ### coordinator • **coordinator**: *[CoordinatorWrapper](#class-coordinatorwrapper)* *Defined in [contract-wrappers/src/contract_wrappers.ts:82](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L82)* An instance of the CoordinatorWrapper class containing methods for interacting with the Coordinator extension contract. ___ ### devUtils • **devUtils**: *`DevUtilsContract`* *Defined in [contract-wrappers/src/contract_wrappers.ts:78](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L78)* An instance of the DevUtilsContract class containing methods for interacting with the DevUtils smart contract. ___ ### dutchAuction • **dutchAuction**: *`DutchAuctionContract`* *Defined in [contract-wrappers/src/contract_wrappers.ts:74](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L74)* An instance of the DutchAuctionContract class containing methods for interacting with any DutchAuction smart contract. ___ ### erc20Proxy • **erc20Proxy**: *`ERC20ProxyContract`* *Defined in [contract-wrappers/src/contract_wrappers.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L52)* An instance of the ERC20ProxyContract class containing methods for interacting with the erc20Proxy smart contract. ___ ### erc721Proxy • **erc721Proxy**: *`ERC721ProxyContract`* *Defined in [contract-wrappers/src/contract_wrappers.ts:57](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L57)* An instance of the ERC721ProxyContract class containing methods for interacting with the erc721Proxy smart contract. ___ ### exchange • **exchange**: *`ExchangeContract`* *Defined in [contract-wrappers/src/contract_wrappers.ts:47](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L47)* 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:66](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L66)* 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:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L70)* 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:62](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L62)* 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:155](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L155)* 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:148](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L148)* 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:138](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/contract_wrappers.ts#L138)* Unsubscribes from all subscriptions for all contracts. **Returns:** *void*
# Class: CoordinatorWrapper This class includes all the functionality related to filling or cancelling orders through the 0x V2 Coordinator extension contract. ## Constructors \+ **new CoordinatorWrapper**(`provider`: [SupportedProvider](#supportedprovider), `networkId`: number, `address?`: undefined | string, `exchangeAddress?`: undefined | string, `registryAddress?`: undefined | string): *[CoordinatorWrapper](#class-coordinatorwrapper)* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L43)* Instantiate CoordinatorWrapper **Parameters:** Name | Type | Description | ------ | ------ | ------ | `provider` | [SupportedProvider](#supportedprovider) | - | `networkId` | number | Desired networkId. | `address?` | undefined \| string | The address of the Coordinator contract. If undefined, will default to the known address corresponding to the networkId. | `exchangeAddress?` | undefined \| string | The address of the Exchange contract. If undefined, will default to the known address corresponding to the networkId. | `registryAddress?` | undefined \| string | The address of the CoordinatorRegistry contract. If undefined, will default to the known address corresponding to the networkId. | **Returns:** *[CoordinatorWrapper](#class-coordinatorwrapper)* ## Properties ### abi • **abi**: *[ContractAbi](#contractabi)* = Coordinator.compilerOutput.abi *Defined in [contract-wrappers/src/coordinator_wrapper.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L34)* ___ ### address • **address**: *string* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:36](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L36)* ___ ### exchangeAddress • **exchangeAddress**: *string* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L37)* ___ ### networkId • **networkId**: *number* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:35](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L35)* ___ ### registryAddress • **registryAddress**: *string* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L38)* ## Methods ### assertValidCoordinatorApprovalsOrThrowAsync ▸ **assertValidCoordinatorApprovalsOrThrowAsync**(`transaction`: `ZeroExTransaction`, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:637](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L637)* Validates that the 0x transaction has been approved by all of the feeRecipients that correspond to each order in the transaction's Exchange calldata. Throws an error if the transaction approvals are not valid. Will not detect failures that would occur when the transaction is executed on the Exchange contract. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `transaction` | `ZeroExTransaction` | 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. | `approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | `approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | **Returns:** *`Promise`* ___ ### batchFillOrKillOrdersAsync ▸ **batchFillOrKillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:273](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L273)* Batch version of fillOrKillOrderAsync. Executes multiple fills atomically in a single transaction. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | `takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | `takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### batchFillOrdersAsync ▸ **batchFillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:203](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L203)* Batch version of fillOrderAsync. Executes multiple fills atomically in a single transaction. Under-the-hood, this method uses the `feeRecipientAddress`s of the orders to looks up the coordinator server endpoints registered in the coordinator registry contract. It requests a signature from each coordinator server before submitting the orders and signatures as a 0x transaction to the coordinator extension contract, which validates the signatures and then fills the order through the Exchange contract. If any `feeRecipientAddress` in the batch is not registered to a coordinator server, the whole batch fails. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | `takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | `takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### batchFillOrdersNoThrowAsync ▸ **batchFillOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:238](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L238)* No throw version of batchFillOrdersAsync **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | `takerAssetFillAmounts` | `BigNumber`[] | - | The amounts of the orders (in taker asset baseUnits) that you wish to fill. | `takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### batchHardCancelOrdersAsync ▸ **batchHardCancelOrdersAsync**(`orders`: `SignedOrder`[], `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:568](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L568)* Batch version of hardCancelOrderAsync. Cancels orders on-chain by submitting an Ethereum transaction. Executes multiple cancels atomically in a single transaction. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `orders` | `SignedOrder`[] | - | An array of orders to cancel. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### batchSoftCancelOrdersAsync ▸ **batchSoftCancelOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:482](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L482)* Batch version of softCancelOrderAsync. Requests multiple soft cancels **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orders` | `SignedOrder`[] | An array of orders to cancel. | **Returns:** *`Promise`* CoordinatorServerCancellationResponse. See [Cancellation Response](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#response). ___ ### fillOrKillOrderAsync ▸ **fillOrKillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:166](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L166)* Attempts to fill a specific amount of an order. If the entire amount specified cannot be filled, the fill order is abandoned. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `signedOrder` | `SignedOrder` | - | An object that conforms to the SignedOrder interface. | `takerAssetFillAmount` | `BigNumber` | - | The amount of the order (in taker asset baseUnits) that you wish to fill. | `takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### fillOrderAsync ▸ **fillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:101](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L101)* Fills a signed order with an amount denominated in baseUnits of the taker asset. Under-the-hood, this method uses the `feeRecipientAddress` of the order to look up the coordinator server endpoint registered in the coordinator registry contract. It requests a signature from that coordinator server before submitting the order and signature as a 0x transaction to the coordinator extension contract. The coordinator extension contract validates signatures and then fills the order via the Exchange contract. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `signedOrder` | `SignedOrder` | - | An object that conforms to the SignedOrder interface. | `takerAssetFillAmount` | `BigNumber` | - | The amount of the order (in taker asset baseUnits) that you wish to fill. | `takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### fillOrderNoThrowAsync ▸ **fillOrderNoThrowAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:133](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L133)* No-throw version of fillOrderAsync. This version will not throw if the fill fails. This allows the caller to save gas at the expense of not knowing the reason the fill failed. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `signedOrder` | `SignedOrder` | - | An object that conforms to the SignedOrder interface. | `takerAssetFillAmount` | `BigNumber` | - | The amount of the order (in taker asset baseUnits) that you wish to fill. | `takerAddress` | string | - | The user Ethereum address who would like to fill this order. Must be available via the supplied Provider provided at instantiation. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### getSignerAddressAsync ▸ **getSignerAddressAsync**(`hash`: string, `signature`: string): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:669](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L669)* 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:** *`Promise`* Signer address. ___ ### hardCancelOrderAsync ▸ **hardCancelOrderAsync**(`order`: `Order` | `SignedOrder`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:536](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L536)* Cancels an order on-chain by submitting an Ethereum transaction. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `order` | `Order` \| `SignedOrder` | - | An object that conforms to the Order or SignedOrder interface. The order you would like to cancel. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### hardCancelOrdersUpToAsync ▸ **hardCancelOrdersUpToAsync**(`targetOrderEpoch`: `BigNumber`, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:603](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L603)* Cancels orders on-chain by submitting an Ethereum transaction. Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch and senderAddress equal to coordinator extension contract address. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `targetOrderEpoch` | `BigNumber` | - | Target order epoch. | `senderAddress` | string | - | Address that should send the transaction. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### marketBuyOrdersAsync ▸ **marketBuyOrdersAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:313](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L313)* Synchronously executes multiple calls to fillOrder until total amount of makerAsset is bought by taker. Under-the-hood, this method uses the `feeRecipientAddress`s of the orders to looks up the coordinator server endpoints registered in the coordinator registry contract. It requests a signature from each coordinator server before submitting the orders and signatures as a 0x transaction to the coordinator extension contract, which validates the signatures and then fills the order through the Exchange contract. If any `feeRecipientAddress` in the batch is not registered to a coordinator server, the whole batch fails. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | `makerAssetFillAmount` | `BigNumber` | - | Maker asset fill amount. | `takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### marketBuyOrdersNoThrowAsync ▸ **marketBuyOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:384](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L384)* No throw version of marketBuyOrdersAsync **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | `makerAssetFillAmount` | `BigNumber` | - | Maker asset fill amount. | `takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### marketSellOrdersAsync ▸ **marketSellOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:351](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L351)* Synchronously executes multiple calls to fillOrder until total amount of makerAsset is bought by taker. Under-the-hood, this method uses the `feeRecipientAddress`s of the orders to looks up the coordinator server endpoints registered in the coordinator registry contract. It requests a signature from each coordinator server before submitting the orders and signatures as a 0x transaction to the coordinator extension contract, which validates the signatures and then fills the order through the Exchange contract. If any `feeRecipientAddress` in the batch is not registered to a coordinator server, the whole batch fails. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | `takerAssetFillAmount` | `BigNumber` | - | Taker asset fill amount. | `takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### marketSellOrdersNoThrowAsync ▸ **marketSellOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L417)* No throw version of marketSellOrdersAsync **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `signedOrders` | `SignedOrder`[] | - | An array of signed orders to fill. | `takerAssetFillAmount` | `BigNumber` | - | Taker asset fill amount. | `takerAddress` | string | - | The user Ethereum address who would like to fill these orders. Must be available via the supplied Provider provided at instantiation. | `orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | **Returns:** *`Promise`* Transaction hash. ___ ### softCancelOrderAsync ▸ **softCancelOrderAsync**(`order`: `Order` | `SignedOrder`): *`Promise`* *Defined in [contract-wrappers/src/coordinator_wrapper.ts:447](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/coordinator_wrapper.ts#L447)* Soft cancel a given order. Soft cancels are recorded only on coordinator operator servers and do not involve an Ethereum transaction. See [soft cancels](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#soft-cancels). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | `Order` \| `SignedOrder` | An object that conforms to the Order or SignedOrder interface. The order you would like to cancel. | **Returns:** *`Promise`* CoordinatorServerCancellationResponse. See [Cancellation Response](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#response).
# Class: MetamaskSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface and the provider sendAsync interface. It handles inconsistencies with Metamask implementations of various JSON RPC methods. It forwards JSON RPC requests involving the domain of a signer (getAccounts, sendTransaction, signMessage etc...) to the provider instance supplied at instantiation. All other requests are passed onwards for subsequent subproviders to handle. ## Constructors \+ **new MetamaskSubprovider**(`supportedProvider`: [SupportedProvider](#supportedprovider)): *[MetamaskSubprovider](#class-metamasksubprovider)* *Defined in [subproviders/src/subproviders/metamask_subprovider.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/metamask_subprovider.ts#L19)* Instantiates a new MetamaskSubprovider **Parameters:** Name | Type | Description | ------ | ------ | ------ | `supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider that should handle all user account related requests | **Returns:** *[MetamaskSubprovider](#class-metamasksubprovider)* ## Methods ### emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/subprovider.ts#L55)* Emits a JSON RPC payload that will then be handled by the ProviderEngine instance this subprovider is a part of. The payload will cascade down the subprovider middleware stack until finding the responsible entity for handling the request. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `payload` | `Partial` | JSON RPC payload | **Returns:** *`Promise`* JSON RPC response payload ___ ### handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#callback), `end`: [ErrorCallback](#errorcallback)): *`Promise`* *Overrides void* *Defined in [subproviders/src/subproviders/metamask_subprovider.ts:39](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/metamask_subprovider.ts#L39)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders turn to handle a JSON RPC request. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `payload` | `JSONRPCRequestPayload` | JSON RPC payload | `next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | `end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | **Returns:** *`Promise`* ___ ### sendAsync ▸ **sendAsync**(`payload`: `JSONRPCRequestPayload`, `callback`: [ErrorCallback](#errorcallback)): *void* *Defined in [subproviders/src/subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/metamask_subprovider.ts#L117)* This method conforms to the provider sendAsync interface. Allowing the MetamaskSubprovider to be used as a generic provider (outside of Web3ProviderEngine) with the addition of wrapping the inconsistent Metamask behaviour **Parameters:** Name | Type | Description | ------ | ------ | ------ | `payload` | `JSONRPCRequestPayload` | JSON RPC payload | `callback` | [ErrorCallback](#errorcallback) | - | **Returns:** *void* The contents nested under the result key of the response body ___ ### setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/subprovider.ts#L68)* Set's the subprovider's engine to the ProviderEngine it is added to. This is only called within the ProviderEngine source code, do not call directly. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | **Returns:** *void*
# Class: RPCSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. It forwards on JSON RPC requests to the supplied `rpcUrl` endpoint ## Constructors \+ **new RPCSubprovider**(`rpcUrl`: string, `requestTimeoutMs`: number): *[RPCSubprovider](#class-rpcsubprovider)* *Defined in [subproviders/src/subproviders/rpc_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `rpcUrl` | string | - | URL to the backing Ethereum node to which JSON RPC requests should be sent | `requestTimeoutMs` | number | 20000 | Amount of miliseconds to wait before timing out the JSON RPC request | **Returns:** *[RPCSubprovider](#class-rpcsubprovider)* ## Methods ### emitPayloadAsync ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* *Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/subprovider.ts#L55)* Emits a JSON RPC payload that will then be handled by the ProviderEngine instance this subprovider is a part of. The payload will cascade down the subprovider middleware stack until finding the responsible entity for handling the request. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `payload` | `Partial` | JSON RPC payload | **Returns:** *`Promise`* JSON RPC response payload ___ ### handleRequest ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `_next`: [Callback](#callback), `end`: [ErrorCallback](#errorcallback)): *`Promise`* *Overrides void* *Defined in [subproviders/src/subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/rpc_subprovider.ts#L38)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders turn to handle a JSON RPC request. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `payload` | `JSONRPCRequestPayload` | JSON RPC payload | `_next` | [Callback](#callback) | Callback to call if this subprovider decides not to handle the request | `end` | [ErrorCallback](#errorcallback) | Callback to call if subprovider handled the request and wants to pass back the request. | **Returns:** *`Promise`* ___ ### setEngine ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* *Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/subproviders/subprovider.ts#L68)* Set's the subprovider's engine to the ProviderEngine it is added to. This is only called within the ProviderEngine source code, do not call directly. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | **Returns:** *void*
# 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/23602ec6b/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/23602ec6b/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/23602ec6b/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` | [RawLog](#rawlog)* *Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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` | [RawLog](#rawlog)* The decoded log if the requisite ABI was available. Otherwise the log unaltered.
# Enumeration: CoordinatorRegistryEvents ## Enumeration members ### CoordinatorEndpointSet • **CoordinatorEndpointSet**: = "CoordinatorEndpointSet" *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L37)*
# Enumeration: DummyERC20TokenEvents ## Enumeration members ### Approval • **Approval**: = "Approval" *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L38)* ___ ### Transfer • **Transfer**: = "Transfer" *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L37)*
# Enumeration: DummyERC721TokenEvents ## Enumeration members ### Approval • **Approval**: = "Approval" *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L41)* ___ ### ApprovalForAll • **ApprovalForAll**: = "ApprovalForAll" *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L42)* ___ ### Transfer • **Transfer**: = "Transfer" *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L40)*
# Enumeration: ERC1155ProxyEvents ## Enumeration members ### AuthorizedAddressAdded • **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L39)* ___ ### AuthorizedAddressRemoved • **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L40)*
# Enumeration: ERC20ProxyEvents ## Enumeration members ### AuthorizedAddressAdded • **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L39)* ___ ### AuthorizedAddressRemoved • **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L40)*
# Enumeration: ERC20TokenEvents ## Enumeration members ### Approval • **Approval**: = "Approval" *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L38)* ___ ### Transfer • **Transfer**: = "Transfer" *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L37)*
# Enumeration: ERC721ProxyEvents ## Enumeration members ### AuthorizedAddressAdded • **AuthorizedAddressAdded**: = "AuthorizedAddressAdded" *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:39](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L39)* ___ ### AuthorizedAddressRemoved • **AuthorizedAddressRemoved**: = "AuthorizedAddressRemoved" *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L40)*
# Enumeration: ERC721TokenEvents ## Enumeration members ### Approval • **Approval**: = "Approval" *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L41)* ___ ### ApprovalForAll • **ApprovalForAll**: = "ApprovalForAll" *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L42)* ___ ### Transfer • **Transfer**: = "Transfer" *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L40)*
# Enumeration: ExchangeEvents ## Enumeration members ### AssetProxyRegistered • **AssetProxyRegistered**: = "AssetProxyRegistered" *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:46](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L46)* ___ ### Cancel • **Cancel**: = "Cancel" *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L44)* ___ ### CancelUpTo • **CancelUpTo**: = "CancelUpTo" *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:45](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L45)* ___ ### Fill • **Fill**: = "Fill" *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L43)* ___ ### SignatureValidatorApproval • **SignatureValidatorApproval**: = "SignatureValidatorApproval" *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L42)*
# Enumeration: WETH9Events ## Enumeration members ### Approval • **Approval**: = "Approval" *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L41)* ___ ### Deposit • **Deposit**: = "Deposit" *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L43)* ___ ### Transfer • **Transfer**: = "Transfer" *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L42)* ___ ### Withdrawal • **Withdrawal**: = "Withdrawal" *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)*
# Enumeration: ZRXTokenEvents ## Enumeration members ### Approval • **Approval**: = "Approval" *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L38)* ___ ### Transfer • **Transfer**: = "Transfer" *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L37)*
# Enumeration: OrderStatus ## Enumeration members ### Cancelled • **Cancelled**: *Defined in [contract-wrappers/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L91)* ___ ### Expired • **Expired**: *Defined in [contract-wrappers/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L89)* ___ ### Fillable • **Fillable**: *Defined in [contract-wrappers/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L88)* ___ ### FullyFilled • **FullyFilled**: *Defined in [contract-wrappers/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L90)* ___ ### Invalid • **Invalid**: = 0 *Defined in [contract-wrappers/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L85)* ___ ### InvalidMakerAssetAmount • **InvalidMakerAssetAmount**: *Defined in [contract-wrappers/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L86)* ___ ### InvalidTakerAssetAmount • **InvalidTakerAssetAmount**: *Defined in [contract-wrappers/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L87)*
# Enumeration: BlockParamLiteral ## Enumeration members ### Earliest • **Earliest**: = "earliest" *Defined in [ethereum-types/src/index.ts:470](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L470)* ___ ### Latest • **Latest**: = "latest" *Defined in [ethereum-types/src/index.ts:471](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L471)* ___ ### Pending • **Pending**: = "pending" *Defined in [ethereum-types/src/index.ts:472](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L472)*
# Enumeration: AssetProxyId ## Enumeration members ### ERC1155 • **ERC1155**: = "0xa7cb5fb7" *Defined in [types/src/index.ts:171](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L171)* ___ ### ERC20 • **ERC20**: = "0xf47261b0" *Defined in [types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L168)* ___ ### ERC721 • **ERC721**: = "0x02571792" *Defined in [types/src/index.ts:169](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L169)* ___ ### MultiAsset • **MultiAsset**: = "0x94cfcdd7" *Defined in [types/src/index.ts:170](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L170)* ___ ### StaticCall • **StaticCall**: = "0xc339d10a" *Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L172)*
# Enumeration: SignatureType ## Enumeration members ### EIP712 • **EIP712**: *Defined in [types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L159)* ___ ### EthSign • **EthSign**: *Defined in [types/src/index.ts:160](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L160)* ___ ### Illegal • **Illegal**: *Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L157)* ___ ### Invalid • **Invalid**: *Defined in [types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L158)* ___ ### NSignatureTypes • **NSignatureTypes**: *Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L164)* ___ ### PreSigned • **PreSigned**: *Defined in [types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L163)* ___ ### Validator • **Validator**: *Defined in [types/src/index.ts:162](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L162)* ___ ### Wallet • **Wallet**: *Defined in [types/src/index.ts:161](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L161)*
# Interface: CoordinatorRegistryCoordinatorEndpointSetEventArgs ## Index ### Properties * [coordinatorEndpoint](#coordinatorendpoint) * [coordinatorOperator](#coordinatoroperator) ## Properties ### coordinatorEndpoint • **coordinatorEndpoint**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L42)* ___ ### coordinatorOperator • **coordinatorOperator**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L41)*
# 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:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L48)* ___ ### _spender • **_spender**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L49)* ___ ### _value • **_value**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L50)*
# 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:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L42)* ___ ### _to • **_to**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L43)* ___ ### _value • **_value**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L44)*
# 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:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L53)* ___ ### _owner • **_owner**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L52)* ___ ### _tokenId • **_tokenId**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L54)*
# 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:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L60)* ___ ### _operator • **_operator**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L59)* ___ ### _owner • **_owner**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L58)*
# 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:46](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L46)* ___ ### _to • **_to**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L47)* ___ ### _tokenId • **_tokenId**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L48)*
# Interface: ERC1155ProxyAuthorizedAddressAddedEventArgs ## Index ### Properties * [caller](#caller) * [target](#target) ## Properties ### caller • **caller**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:45](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L45)* ___ ### target • **target**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L44)*
# Interface: ERC1155ProxyAuthorizedAddressRemovedEventArgs ## Index ### Properties * [caller](#caller) * [target](#target) ## Properties ### caller • **caller**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L50)* ___ ### target • **target**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L49)*
# Interface: ERC20ProxyAuthorizedAddressAddedEventArgs ## Index ### Properties * [caller](#caller) * [target](#target) ## Properties ### caller • **caller**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:45](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L45)* ___ ### target • **target**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L44)*
# Interface: ERC20ProxyAuthorizedAddressRemovedEventArgs ## Index ### Properties * [caller](#caller) * [target](#target) ## Properties ### caller • **caller**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L50)* ___ ### target • **target**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L49)*
# 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:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L48)* ___ ### _spender • **_spender**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L49)* ___ ### _value • **_value**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L50)*
# 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:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L42)* ___ ### _to • **_to**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L43)* ___ ### _value • **_value**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L44)*
# Interface: ERC721ProxyAuthorizedAddressAddedEventArgs ## Index ### Properties * [caller](#caller) * [target](#target) ## Properties ### caller • **caller**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:45](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L45)* ___ ### target • **target**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L44)*
# Interface: ERC721ProxyAuthorizedAddressRemovedEventArgs ## Index ### Properties * [caller](#caller) * [target](#target) ## Properties ### caller • **caller**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L50)* ___ ### target • **target**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L49)*
# 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:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L53)* ___ ### _owner • **_owner**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L52)* ___ ### _tokenId • **_tokenId**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L54)*
# 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:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L60)* ___ ### _operator • **_operator**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L59)* ___ ### _owner • **_owner**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L58)*
# 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:46](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L46)* ___ ### _to • **_to**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L47)* ___ ### _tokenId • **_tokenId**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L48)*
# Interface: ExchangeAssetProxyRegisteredEventArgs ## Index ### Properties * [assetProxy](#assetproxy) * [id](#id) ## Properties ### assetProxy • **assetProxy**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L86)* ___ ### id • **id**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L85)*
# 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:71](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L71)* ___ ### makerAddress • **makerAddress**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L70)* ___ ### makerAssetData • **makerAssetData**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:74](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L74)* ___ ### orderHash • **orderHash**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:73](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L73)* ___ ### senderAddress • **senderAddress**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:72](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L72)* ___ ### takerAssetData • **takerAssetData**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L75)*
# Interface: ExchangeCancelUpToEventArgs ## Index ### Properties * [makerAddress](#makeraddress) * [orderEpoch](#orderepoch) * [senderAddress](#senderaddress) ## Properties ### makerAddress • **makerAddress**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)* ___ ### orderEpoch • **orderEpoch**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)* ___ ### senderAddress • **senderAddress**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)*
# Interface: ExchangeFillEventArgs ## Index ### Properties * [feeRecipientAddress](#feerecipientaddress) * [makerAddress](#makeraddress) * [makerAssetData](#makerassetdata) * [makerAssetFilledAmount](#makerassetfilledamount) * [makerFeePaid](#makerfeepaid) * [orderHash](#orderhash) * [senderAddress](#senderaddress) * [takerAddress](#takeraddress) * [takerAssetData](#takerassetdata) * [takerAssetFilledAmount](#takerassetfilledamount) * [takerFeePaid](#takerfeepaid) ## Properties ### feeRecipientAddress • **feeRecipientAddress**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:57](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L57)* ___ ### makerAddress • **makerAddress**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L56)* ___ ### makerAssetData • **makerAssetData**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)* ___ ### makerAssetFilledAmount • **makerAssetFilledAmount**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L60)* ___ ### makerFeePaid • **makerFeePaid**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:62](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L62)* ___ ### orderHash • **orderHash**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)* ___ ### senderAddress • **senderAddress**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:59](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L59)* ___ ### takerAddress • **takerAddress**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:58](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L58)* ___ ### takerAssetData • **takerAssetData**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)* ___ ### takerAssetFilledAmount • **takerAssetFilledAmount**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:61](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L61)* ___ ### takerFeePaid • **takerFeePaid**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L63)*
# Interface: ExchangeSignatureValidatorApprovalEventArgs ## Index ### Properties * [approved](#approved) * [signerAddress](#signeraddress) * [validatorAddress](#validatoraddress) ## Properties ### approved • **approved**: *boolean* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L52)* ___ ### signerAddress • **signerAddress**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)* ___ ### validatorAddress • **validatorAddress**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)*
# Interface: WETH9ApprovalEventArgs ## Index ### Properties * [_owner](#_owner) * [_spender](#_spender) * [_value](#_value) ## Properties ### _owner • **_owner**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L48)* ___ ### _spender • **_spender**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L49)* ___ ### _value • **_value**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L50)*
# Interface: WETH9DepositEventArgs ## Index ### Properties * [_owner](#_owner) * [_value](#_value) ## Properties ### _owner • **_owner**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L60)* ___ ### _value • **_value**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:61](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L61)*
# Interface: WETH9TransferEventArgs ## Index ### Properties * [_from](#_from) * [_to](#_to) * [_value](#_value) ## Properties ### _from • **_from**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L54)* ___ ### _to • **_to**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L55)* ___ ### _value • **_value**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L56)*
# Interface: WETH9WithdrawalEventArgs ## Index ### Properties * [_owner](#_owner) * [_value](#_value) ## Properties ### _owner • **_owner**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:65](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L65)* ___ ### _value • **_value**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:66](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L66)*
# Interface: ZRXTokenApprovalEventArgs ## Index ### Properties * [_owner](#_owner) * [_spender](#_spender) * [_value](#_value) ## Properties ### _owner • **_owner**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L48)* ___ ### _spender • **_spender**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L49)* ___ ### _value • **_value**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L50)*
# Interface: ZRXTokenTransferEventArgs ## Index ### Properties * [_from](#_from) * [_to](#_to) * [_value](#_value) ## Properties ### _from • **_from**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L42)* ___ ### _to • **_to**: *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L43)* ___ ### _value • **_value**: *`BigNumber`* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L44)*
# Interface: ContractAddresses ## Properties ### assetProxyOwner • **assetProxyOwner**: *string* *Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L9)* ___ ### coordinator • **coordinator**: *string* *Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L14)* ___ ### coordinatorRegistry • **coordinatorRegistry**: *string* *Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L13)* ___ ### devUtils • **devUtils**: *string* *Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L18)* ___ ### dutchAuction • **dutchAuction**: *string* *Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L12)* ___ ### erc1155Proxy • **erc1155Proxy**: *string* *Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L17)* ___ ### erc20Proxy • **erc20Proxy**: *string* *Defined in [contract-addresses/src/index.ts:4](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L4)* ___ ### erc721Proxy • **erc721Proxy**: *string* *Defined in [contract-addresses/src/index.ts:5](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L5)* ___ ### etherToken • **etherToken**: *string* *Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L7)* ___ ### exchange • **exchange**: *string* *Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L8)* ___ ### forwarder • **forwarder**: *string* *Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L10)* ___ ### multiAssetProxy • **multiAssetProxy**: *string* *Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L15)* ___ ### orderValidator • **orderValidator**: *string* *Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L11)* ___ ### staticCallProxy • **staticCallProxy**: *string* *Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L16)* ___ ### zrxToken • **zrxToken**: *string* *Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L6)*
# Interface: ContractWrappersConfig networkId: The id of the underlying ethereum network your provider is connected to. (1-mainnet, 3-ropsten, 4-rinkeby, 42-kovan, 50-testrpc) gasPrice: Gas price to use with every transaction contractAddresses: The address of all contracts to use. Defaults to the known addresses based on networkId. 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:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L56)* ___ ### `Optional` contractAddresses • **contractAddresses**? : *[ContractAddresses](#class-contractaddresses)* *Defined in [contract-wrappers/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L55)* ___ ### `Optional` gasPrice • **gasPrice**? : *`BigNumber`* *Defined in [contract-wrappers/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L54)* ___ ### networkId • **networkId**: *number* *Defined in [contract-wrappers/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L53)*
# Interface: DecodedLogEvent <**ArgsType**> ## Type parameters ▪ **ArgsType**: *`DecodedLogArgs`* ## Properties ### isRemoved • **isRemoved**: *boolean* *Defined in [contract-wrappers/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L7)* ___ ### log • **log**: *`LogWithDecodedArgs`* *Defined in [contract-wrappers/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L8)*
# Interface: IndexedFilterValues ## Hierarchy * **OrderAndTraderInfo** ## Properties ### orderInfo • **orderInfo**: *[OrderInfo](#class-orderinfo)* *Defined in [contract-wrappers/src/types.ts:106](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L106)* ___ ### traderInfo • **traderInfo**: *[TraderInfo](#class-traderinfo)* *Defined in [contract-wrappers/src/types.ts:107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L107)*
# Interface: OrderInfo ## Properties ### orderHash • **orderHash**: *string* *Defined in [contract-wrappers/src/types.ts:80](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L80)* ___ ### orderStatus • **orderStatus**: *[OrderStatus](#enumeration-orderstatus)* *Defined in [contract-wrappers/src/types.ts:79](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L79)* ___ ### orderTakerAssetFilledAmount • **orderTakerAssetFilledAmount**: *`BigNumber`* *Defined in [contract-wrappers/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L81)*
# Interface: OrderTransactionOpts shouldValidate: Flag indicating whether the library should make attempts to validate a transaction before broadcasting it. For example, order has a valid signature, maker has sufficient funds, etc. Default=true. ## Properties ### `Optional` gasLimit • **gasLimit**? : *undefined | number* *Inherited from [TransactionOpts](#interface-transactionopts).[gasLimit](#optional-gaslimit)* *Defined in [contract-wrappers/src/types.ts:66](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L66)* ___ ### `Optional` gasPrice • **gasPrice**? : *`BigNumber`* *Inherited from [TransactionOpts](#interface-transactionopts).[gasPrice](#optional-gasprice)* *Defined in [contract-wrappers/src/types.ts:65](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L65)* ___ ### `Optional` nonce • **nonce**? : *undefined | number* *Inherited from [TransactionOpts](#interface-transactionopts).[nonce](#optional-nonce)* *Defined in [contract-wrappers/src/types.ts:67](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L67)* ___ ### `Optional` shouldValidate • **shouldValidate**? : *undefined | false | true* *Defined in [contract-wrappers/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L75)*
# Interface: BlockRange ## Properties ### fromBlock • **fromBlock**: *[BlockParam](#blockparam)* *Defined in [ethereum-types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L732)* ___ ### toBlock • **toBlock**: *[BlockParam](#blockparam)* *Defined in [ethereum-types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L733)*
# Interface: CallData ## Properties ### `Optional` data • **data**? : *undefined | string* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* *Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L387)* ___ ### `Optional` from • **from**? : *undefined | string* *Defined in [ethereum-types/src/index.ts:396](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L396)* ___ ### `Optional` gas • **gas**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* *Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L385)* ___ ### `Optional` gasPrice • **gasPrice**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* *Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L386)* ___ ### `Optional` nonce • **nonce**? : *undefined | number* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* *Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L388)* ___ ### `Optional` to • **to**? : *undefined | string* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* *Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L383)* ___ ### `Optional` value • **value**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* *Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L384)*
# Interface: CompilerOpts ## Properties ### name • **name**: *"solc"* *Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L647)* ___ ### settings • **settings**: *[CompilerSettings](#class-compilersettings)* *Defined in [ethereum-types/src/index.ts:649](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L649)* ___ ### version • **version**: *string* *Defined in [ethereum-types/src/index.ts:648](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L648)*
# Interface: CompilerSettings ## Properties ### `Optional` evmVersion • **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"* *Defined in [ethereum-types/src/index.ts:681](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L681)* ___ ### `Optional` libraries • **libraries**? : *undefined | object* *Defined in [ethereum-types/src/index.ts:683](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L683)* ___ ### `Optional` metadata • **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* *Defined in [ethereum-types/src/index.ts:682](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L682)* ___ ### `Optional` optimizer • **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* *Defined in [ethereum-types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L680)* ___ ### outputSelection • **outputSelection**: *object* *Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L688)* #### Type declaration: ● \[▪ **fileName**: *string*\]: object ● \[▪ **contractName**: *string*\]: [OutputField](#outputfield)[] ___ ### `Optional` remappings • **remappings**? : *string[]* *Defined in [ethereum-types/src/index.ts:679](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L679)*
# Interface: CompilerSettingsMetadata ## Properties ### useLiteralContent • **useLiteralContent**: *true* *Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L696)*
# Interface: ConstructorAbi ## Properties ### inputs • **inputs**: *[DataItem](#class-dataitem)[]* *Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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/23602ec6b/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/23602ec6b/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/23602ec6b/packages/ethereum-types/src/index.ts#L102)*
# 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 networks: Network specific information by network (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 ### compiler • **compiler**: *[CompilerOpts](#class-compileropts)* *Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)* *Defined in [ethereum-types/src/index.ts:633](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L633)* ___ ### compilerOutput • **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* *Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* *Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L643)* ___ ### contractName • **contractName**: *string* *Defined in [ethereum-types/src/index.ts:667](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L667)* ___ ### networks • **networks**: *[ContractNetworks](#class-contractnetworks)* *Defined in [ethereum-types/src/index.ts:668](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L668)* ___ ### schemaVersion • **schemaVersion**: *string* *Defined in [ethereum-types/src/index.ts:666](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L666)* ___ ### sourceCodes • **sourceCodes**: *object* *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* *Defined in [ethereum-types/src/index.ts:639](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L639)* #### Type declaration: ● \[▪ **sourceName**: *string*\]: string ___ ### sourceTreeHashHex • **sourceTreeHashHex**: *string* *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* *Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L642)* ___ ### sources • **sources**: *object* *Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* *Defined in [ethereum-types/src/index.ts:634](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L634)* #### Type declaration: ● \[▪ **sourceName**: *string*\]: object
# Interface: ContractNetworkData ## Properties ### address • **address**: *string* *Defined in [ethereum-types/src/index.ts:546](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L546)* ___ Args • **constructorArgs**: *string* *Defined in [ethereum-types/src/index.ts:550](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L550)* ___ ### links • **links**: *object* *Defined in [ethereum-types/src/index.ts:547](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L547)* #### Type declaration: ● \[▪ **linkName**: *string*\]: string
# Interface: ContractNetworks ## Hierarchy * **ContractVersionData** * [ContractArtifact](#class-contractartifact) ## Properties ### compiler • **compiler**: *[CompilerOpts](#class-compileropts)* *Defined in [ethereum-types/src/index.ts:633](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L633)* ___ ### compilerOutput • **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* *Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L643)* ___ ### sourceCodes • **sourceCodes**: *object* *Defined in [ethereum-types/src/index.ts:639](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L639)* #### Type declaration: ● \[▪ **sourceName**: *string*\]: string ___ ### sourceTreeHashHex • **sourceTreeHashHex**: *string* *Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L642)* ___ ### sources • **sources**: *object* *Defined in [ethereum-types/src/index.ts:634](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L634)* #### Type declaration: ● \[▪ **sourceName**: *string*\]: object
# Interface: DataItem ## Properties ### `Optional` components • **components**? : *[DataItem](#class-dataitem)[]* *Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L131)* ___ ### name • **name**: *string* *Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L129)* ___ ### type • **type**: *string* *Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L130)*
# Interface: DecodedLogArgs ## Type parameters ▪ **A** ## Properties ### address • **address**: *string* *Inherited from [LogEntry](#interface-logentry).[address](#address)* *Defined in [ethereum-types/src/index.ts:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L428)* ___ ### args • **args**: *`A`* *Defined in [ethereum-types/src/index.ts:411](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L411)* ___ ### blockHash • **blockHash**: *string | null* *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* *Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L426)* ___ ### blockNumber • **blockNumber**: *number | null* *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* *Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L427)* ___ ### data • **data**: *string* *Inherited from [LogEntry](#interface-logentry).[data](#data)* *Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L429)* ___ ### event • **event**: *string* *Defined in [ethereum-types/src/index.ts:410](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L410)* ___ ### logIndex • **logIndex**: *number | null* *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* *Defined in [ethereum-types/src/index.ts:423](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L423)* ___ ### topics • **topics**: *string[]* *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* *Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L430)* ___ ### transactionHash • **transactionHash**: *string* *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* *Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L425)* ___ ### transactionIndex • **transactionIndex**: *number | null* *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* *Defined in [ethereum-types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L424)*
# Interface: DecodedLogEntryEvent <**A**> ## Type parameters ▪ **A** ## Properties ### address • **address**: *string* *Inherited from [LogEntry](#interface-logentry).[address](#address)* *Defined in [ethereum-types/src/index.ts:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L428)* ___ ### args • **args**: *`A`* *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* *Defined in [ethereum-types/src/index.ts:411](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L411)* ___ ### blockHash • **blockHash**: *string | null* *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* *Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L426)* ___ ### blockNumber • **blockNumber**: *number | null* *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* *Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L427)* ___ ### data • **data**: *string* *Inherited from [LogEntry](#interface-logentry).[data](#data)* *Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L429)* ___ ### event • **event**: *string* *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* *Defined in [ethereum-types/src/index.ts:410](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L410)* ___ ### logIndex • **logIndex**: *number | null* *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* *Defined in [ethereum-types/src/index.ts:423](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L423)* ___ ### removed • **removed**: *boolean* *Defined in [ethereum-types/src/index.ts:415](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L415)* ___ ### topics • **topics**: *string[]* *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* *Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L430)* ___ ### transactionHash • **transactionHash**: *string* *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* *Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L425)* ___ ### transactionIndex • **transactionIndex**: *number | null* *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* *Defined in [ethereum-types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L424)*
# Interface: DevdocOutput ## Properties ### `Optional` author • **author**? : *undefined | string* *Defined in [ethereum-types/src/index.ts:620](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L620)* ___ ### methods • **methods**: *object* *Defined in [ethereum-types/src/index.ts:621](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L621)* #### Type declaration: ● \[▪ **signature**: *string*\]: object ___ ### `Optional` title • **title**? : *undefined | string* *Defined in [ethereum-types/src/index.ts:619](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L619)*
# Interface: EIP1193Provider ## Properties ### isEIP1193 • **isEIP1193**: *boolean* *Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L73)* ## Methods ### on ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* *Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L75)* **Parameters:** ▪ **event**: *[EIP1193Event](#eip1193event)* ▪ **listener**: *function* ▸ (`result`: any): *void* **Parameters:** Name | Type | ------ | ------ | `result` | any | **Returns:** *this* ___ ### send ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* *Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L74)* **Parameters:** Name | Type | ------ | ------ | `method` | string | `params?` | any[] | **Returns:** *`Promise`*
# Interface: EvmBytecodeOutput ## Properties ### object • **object**: *string* *Defined in [ethereum-types/src/index.ts:614](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L614)* ___ ### sourceMap • **sourceMap**: *string* *Defined in [ethereum-types/src/index.ts:615](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L615)*
# Interface: EvmOutput ## Properties ### bytecode • **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* *Defined in [ethereum-types/src/index.ts:609](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L609)* ___ ### deployedBytecode • **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* *Defined in [ethereum-types/src/index.ts:610](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L610)*
# Interface: FallbackAbi ## Properties ### payable • **payable**: *boolean* *Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/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/23602ec6b/packages/ethereum-types/src/index.ts#L111)*
# 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/23602ec6b/packages/ethereum-types/src/index.ts#L14)* **Parameters:** Name | Type | ------ | ------ | `payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | `callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | **Returns:** *void*
# Interface: JSONRPCRequestPayload ## Properties ### id • **id**: *number* *Defined in [ethereum-types/src/index.ts:324](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L324)* ___ ### jsonrpc • **jsonrpc**: *string* *Defined in [ethereum-types/src/index.ts:325](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L325)* ___ ### method • **method**: *string* *Defined in [ethereum-types/src/index.ts:323](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L323)* ___ ### params • **params**: *any[]* *Defined in [ethereum-types/src/index.ts:322](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L322)*
# Interface: JSONRPCResponseError ## Properties ### code • **code**: *number* *Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L330)* ___ ### message • **message**: *string* *Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L329)*
# Interface: JSONRPCResponsePayload ## Properties ### `Optional` error • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* *Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L337)* ___ ### id • **id**: *number* *Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L335)* ___ ### jsonrpc • **jsonrpc**: *string* *Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L336)* ___ ### result • **result**: *any* *Defined in [ethereum-types/src/index.ts:334](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L334)*
# Interface: LogEntry ## Properties ### address • **address**: *string* *Defined in [ethereum-types/src/index.ts:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L428)* ___ ### blockHash • **blockHash**: *string | null* *Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L426)* ___ ### blockNumber • **blockNumber**: *number | null* *Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L427)* ___ ### data • **data**: *string* *Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L429)* ___ ### logIndex • **logIndex**: *number | null* *Defined in [ethereum-types/src/index.ts:423](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L423)* ___ ### topics • **topics**: *string[]* *Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L430)* ___ ### transactionHash • **transactionHash**: *string* *Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L425)* ___ ### transactionIndex • **transactionIndex**: *number | null* *Defined in [ethereum-types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L424)*
# Interface: LogEntryEvent ## Properties ### address • **address**: *string* *Inherited from [LogEntry](#interface-logentry).[address](#address)* *Defined in [ethereum-types/src/index.ts:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L428)* ___ ### blockHash • **blockHash**: *string | null* *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* *Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L426)* ___ ### blockNumber • **blockNumber**: *number | null* *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* *Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L427)* ___ ### data • **data**: *string* *Inherited from [LogEntry](#interface-logentry).[data](#data)* *Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L429)* ___ ### logIndex • **logIndex**: *number | null* *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* *Defined in [ethereum-types/src/index.ts:423](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L423)* ___ ### removed • **removed**: *boolean* *Defined in [ethereum-types/src/index.ts:419](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L419)* ___ ### topics • **topics**: *string[]* *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* *Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L430)* ___ ### transactionHash • **transactionHash**: *string* *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* *Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L425)* ___ ### transactionIndex • **transactionIndex**: *number | null* *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* *Defined in [ethereum-types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L424)*
# 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:428](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L428)* ___ ### args • **args**: *`ArgsType`* *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* *Defined in [ethereum-types/src/index.ts:411](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L411)* ___ ### blockHash • **blockHash**: *string | null* *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* *Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L426)* ___ ### blockNumber • **blockNumber**: *number | null* *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* *Defined in [ethereum-types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L427)* ___ ### data • **data**: *string* *Inherited from [LogEntry](#interface-logentry).[data](#data)* *Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L429)* ___ ### event • **event**: *string* *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* *Defined in [ethereum-types/src/index.ts:410](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L410)* ___ ### logIndex • **logIndex**: *number | null* *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* *Defined in [ethereum-types/src/index.ts:423](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L423)* ___ ### topics • **topics**: *string[]* *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* *Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L430)* ___ ### transactionHash • **transactionHash**: *string* *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* *Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L425)* ___ ### transactionIndex • **transactionIndex**: *number | null* *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* *Defined in [ethereum-types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L424)*
# Interface: MethodAbi ## Properties ### constant • **constant**: *boolean* *Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L94)* ___ ### inputs • **inputs**: *[DataItem](#class-dataitem)[]* *Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L92)* ___ ### name • **name**: *string* *Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L91)* ___ ### outputs • **outputs**: *[DataItem](#class-dataitem)[]* *Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L93)* ___ ### payable • **payable**: *boolean* *Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L96)* ___ ### stateMutability • **stateMutability**: *[StateMutability](#statemutability)* *Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L95)* ___ ### type • **type**: *string* *Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L90)*
# Interface: OptimizerSettings ## Properties ### enabled • **enabled**: *boolean* *Defined in [ethereum-types/src/index.ts:700](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L700)* ___ ### `Optional` runs • **runs**? : *undefined | number* *Defined in [ethereum-types/src/index.ts:701](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L701)*
# Interface: StandardContractOutput ## Properties ### abi • **abi**: *[ContractAbi](#contractabi)* *Defined in [ethereum-types/src/index.ts:556](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L556)* ___ ### `Optional` devdoc • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* *Defined in [ethereum-types/src/index.ts:558](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L558)* ___ ### evm • **evm**: *[EvmOutput](#class-evmoutput)* *Defined in [ethereum-types/src/index.ts:557](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L557)*
# Class: CoordinatorContract ## Constructors \+ **new CoordinatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object): *[CoordinatorContract](#class-coordinatorcontract)* *Overrides void* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1452](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1452)* **Parameters:** Name | Type | ------ | ------ | `address` | string | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults?` | `Partial` | `logDecodeDependencies?` | undefined \| object | **Returns:** *[CoordinatorContract](#class-coordinatorcontract)* ## Properties ### abi • **abi**: *[ContractAbi](#contractabi)* Defined in base-contract/lib/src/index.d.ts:25 ___ ### address • **address**: *string* Defined in base-contract/lib/src/index.d.ts:26 ___ Args • **constructorArgs**: *any[]* Defined in base-contract/lib/src/index.d.ts:28 ___ ### contractName • **contractName**: *string* Defined in base-contract/lib/src/index.d.ts:27 ## Methods ### evmExecAsync ▸ **evmExecAsync**(`input`: `Buffer`): *`Promise`* Defined in base-contract/lib/src/index.d.ts:38 **Parameters:** Name | Type | ------ | ------ | `input` | `Buffer` | **Returns:** *`Promise`* ___ ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1158](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1158)* **Returns:** *[ContractAbi](#contractabi)* The contract ABI ___ ### `Static` deployAsync ▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1111](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1111)* **Parameters:** Name | Type | ------ | ------ | `bytecode` | string | `abi` | [ContractAbi](#contractabi) | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | **Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync ▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1078](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1078)* **Parameters:** Name | Type | ------ | ------ | `artifact` | `ContractArtifact` \| `SimpleContractArtifact` | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | `_exchange` | string | **Returns:** *`Promise`* ___ ### `Static` strictArgumentEncodingCheck ▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* Defined in base-contract/lib/src/index.d.ts:37 **Parameters:** Name | Type | ------ | ------ | `inputAbi` | `DataItem`[] | `args` | any[] | **Returns:** *string* ## Object literals ### EIP712_COORDINATOR_DOMAIN_HASH #### ▪ **EIP712_COORDINATOR_DOMAIN_HASH**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1005](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1005)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1011](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1011)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1070](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1070)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1058](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1058)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1048](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1048)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### EIP712_EXCHANGE_DOMAIN_HASH #### ▪ **EIP712_EXCHANGE_DOMAIN_HASH**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:652](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L652)* #### callAsync ▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:658](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L658)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | ------ | ------ | ------ | `callData` | `Partial` | {} | `defaultBlock?` | [BlockParam](#blockparam) | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:717](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L717)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:705](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L705)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *void* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:695](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L695)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Returns:** *string* The ABI encoded transaction data as a string ___ ### assertValidCoordinatorApprovals #### ▪ **assertValidCoordinatorApprovals**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:729](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L729)* Validates that the 0x transaction has been approved by all of the feeRecipients that correspond to each order in the transaction's Exchange calldata. #### callAsync ▸ **callAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:744](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L744)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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. | `approvalExpirationTimeSeconds` | `BigNumber`[] | - | Array of expiration times in seconds for which each corresponding approval signature expires. | `approvalSignatures` | string[] | - | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:860](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L860)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string, string, `BigNumber`[], string[]]* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:842](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L842)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[object, string, string, `BigNumber`[], string[]]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:813](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L813)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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. | `approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | `approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### decodeOrdersFromFillData #### ▪ **decodeOrdersFromFillData**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:873](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L873)* Decodes the orders from Exchange calldata representing any fill method. #### callAsync ▸ **callAsync**(`data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:881](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L881)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `data` | string | - | Exchange calldata representing a fill method. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise>`* The orders from the Exchange calldata. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *`Array`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:967](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L967)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *`Array`* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:955](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L955)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`data`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:944](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L944)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `data` | string | Exchange calldata representing a fill method. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### executeTransaction #### ▪ **executeTransaction**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:321](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L321)* Executes a 0x transaction that has been signed by the feeRecipients that correspond to each order in the transaction's Exchange calldata. #### awaitTransactionSuccessAsync ▸ **awaitTransactionSuccessAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial`, `pollingIntervalMs?`: undefined | number, `timeoutMs?`: undefined | number): *`PromiseWithTransactionHash`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:399](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L399)* Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown. **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. | `approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | `approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | `txData?` | `Partial` | Additional data for transaction | `pollingIntervalMs?` | undefined \| number | Interval at which to poll for success | `timeoutMs?` | undefined \| number | - | **Returns:** *`PromiseWithTransactionHash`* A promise that resolves when the transaction is successful #### callAsync ▸ **callAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:526](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L526)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | 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. | `approvalExpirationTimeSeconds` | `BigNumber`[] | - | Array of expiration times in seconds for which each corresponding approval signature expires. | `approvalSignatures` | string[] | - | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### estimateGasAsync ▸ **estimateGasAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:448](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L448)* Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. **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. | `approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | `approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *void* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:642](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L642)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *void* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *[object, string, string, `BigNumber`[], string[]]* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:624](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L624)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *[object, string, string, `BigNumber`[], string[]]* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:595](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L595)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **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. | `approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | `approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | **Returns:** *string* The ABI encoded transaction data as a string #### sendTransactionAsync ▸ **sendTransactionAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:337](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L337)* Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas. **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. | `approvalExpirationTimeSeconds` | `BigNumber`[] | Array of expiration times in seconds for which each corresponding approval signature expires. | `approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | `txData?` | `Partial` \| undefined | Additional data for transaction | **Returns:** *`Promise`* The hash of the transaction #### validateAndSendTransactionAsync ▸ **validateAndSendTransactionAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:486](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L486)* **Parameters:** Name | Type | ------ | ------ | `transaction` | object | `txOrigin` | string | `transactionSignature` | string | `approvalExpirationTimeSeconds` | `BigNumber`[] | `approvalSignatures` | string[] | `txData?` | `Partial` \| undefined | **Returns:** *`Promise`* ___ ### getCoordinatorApprovalHash #### ▪ **getCoordinatorApprovalHash**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:208](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L208)* Calculated the EIP712 hash of the Coordinator approval mesasage using the domain separator of this contract. #### callAsync ▸ **callAsync**(`approval`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L217)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `approval` | object | - | Coordinator approval message containing the transaction hash, transaction signature, and expiration of the approval. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* EIP712 hash of the Coordinator approval message with the domain separator of this contract. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:310](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L310)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:286](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L286)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *object* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`approval`: object): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:268](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L268)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `approval` | object | Coordinator approval message containing the transaction hash, transaction signature, and expiration of the approval. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getSignerAddress #### ▪ **getSignerAddress**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L34)* Recovers the address of a signer given a hash and signature. #### callAsync ▸ **callAsync**(`hash`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:42](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L42)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `hash` | string | - | Any 32 byte hash. | `signature` | string | - | Proof that the hash has been signed by signer. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:105](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L105)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:93](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L93)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *string* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`hash`: string, `signature`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:78](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L78)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `hash` | string | Any 32 byte hash. | `signature` | string | Proof that the hash has been signed by signer. | **Returns:** *string* The ABI encoded transaction data as a string ___ ### getTransactionHash #### ▪ **getTransactionHash**: *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:116](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L116)* Calculates the EIP712 hash of a 0x transaction using the domain separator of the Exchange contract. #### callAsync ▸ **callAsync**(`transaction`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:124](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L124)* Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state. **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | `transaction` | object | - | 0x transaction containing salt, signerAddress, and data. | `callData` | `Partial` | {} | - | `defaultBlock?` | [BlockParam](#blockparam) | - | - | **Returns:** *`Promise`* EIP712 hash of the transaction with the domain separator of this contract. #### getABIDecodedReturnData ▸ **getABIDecodedReturnData**(`returnData`: string): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:197](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L197)* Decode the ABI-encoded return data from a transaction **Parameters:** Name | Type | Description | ------ | ------ | ------ | `returnData` | string | the data returned after transaction execution | **Returns:** *string* An array representing the output results in order. Keynames of nested structs are preserved. #### getABIDecodedTransactionData ▸ **getABIDecodedTransactionData**(`callData`: string): *object* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L181)* Decode the ABI-encoded transaction data into its input arguments **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callData` | string | The ABI-encoded transaction data | **Returns:** *object* An array representing the input arguments in order. Keynames of nested structs are preserved. #### getABIEncodedTransactionData ▸ **getABIEncodedTransactionData**(`transaction`: object): *string* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L168)* Returns the ABI encoded transaction data needed to send an Ethereum transaction calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details). **Parameters:** Name | Type | Description | ------ | ------ | ------ | `transaction` | object | 0x transaction containing salt, signerAddress, and data. | **Returns:** *string* The ABI encoded transaction data as a string
# 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:135](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L135)* ___ ### name • **name**: *string* *Inherited from [DataItem](#interface-dataitem).[name](#name)* *Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L129)* ___ ### type • **type**: *string* *Inherited from [DataItem](#interface-dataitem).[type](#type)* *Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L130)*
# Interface: TxData ## Properties ### `Optional` data • **data**? : *undefined | string* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* *Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L387)* ___ ### from • **from**: *string* *Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L392)* ___ ### `Optional` gas • **gas**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* *Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L385)* ___ ### `Optional` gasPrice • **gasPrice**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* *Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L386)* ___ ### `Optional` nonce • **nonce**? : *undefined | number* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* *Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L388)* ___ ### `Optional` to • **to**? : *undefined | string* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* *Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L383)* ___ ### `Optional` value • **value**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* *Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L384)*
# Interface: TxDataPayable ## Properties ### `Optional` data • **data**? : *undefined | string* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* *Defined in [ethereum-types/src/index.ts:387](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L387)* ___ ### from • **from**: *string* *Inherited from [TxData](#interface-txdata).[from](#from)* *Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L392)* ___ ### `Optional` gas • **gas**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* *Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L385)* ___ ### `Optional` gasPrice • **gasPrice**? : *number | string | `BigNumber`* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* *Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L386)* ___ ### `Optional` nonce • **nonce**? : *undefined | number* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* *Defined in [ethereum-types/src/index.ts:388](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L388)* ___ ### `Optional` to • **to**? : *undefined | string* *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* *Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L383)* ___ ### `Optional` value • **value**? : *`BigNumber`* *Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)* *Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L434)*
# 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/23602ec6b/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/23602ec6b/packages/ethereum-types/src/index.ts#L44)* **Parameters:** Name | Type | ------ | ------ | `payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | `callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | **Returns:** *void*
# 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/23602ec6b/packages/ethereum-types/src/index.ts#L54)* **Parameters:** Name | Type | ------ | ------ | `payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | `callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | **Returns:** *void*
# 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`* *Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L63)* **Parameters:** Name | Type | ------ | ------ | `method` | string | `params?` | any[] | **Returns:** *`Promise`*
# 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/23602ec6b/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/23602ec6b/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/23602ec6b/packages/ethereum-types/src/index.ts#L30)* ## Methods ### `Optional` enable ▸ **enable**(): *`Promise`* *Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* ___ ### 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/23602ec6b/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/23602ec6b/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void*
# Interface: JSONRPCRequestPayloadWithMethod ## Properties ### id • **id**: *number* Defined in ethereum-types/lib/index.d.ts:262 ___ ### jsonrpc • **jsonrpc**: *string* Defined in ethereum-types/lib/index.d.ts:263 ___ ### method • **method**: *string* *Overrides void* *Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/types.ts#L136)* ___ ### params • **params**: *any[]* Defined in ethereum-types/lib/index.d.ts:260
# Interface: DutchAuctionData ## Properties ### assetData • **assetData**: *[AssetData](#assetdata)* *Defined in [types/src/index.ts:223](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L223)* ___ ### beginAmount • **beginAmount**: *`BigNumber`* *Defined in [types/src/index.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L225)* ___ ### beginTimeSeconds • **beginTimeSeconds**: *`BigNumber`* *Defined in [types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L224)*
# Interface: ECSignature Elliptic Curve signature ## Properties ### r • **r**: *string* *Defined in [types/src/index.ts:68](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L68)* ___ ### s • **s**: *string* *Defined in [types/src/index.ts:69](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L69)* ___ ### v • **v**: *number* *Defined in [types/src/index.ts:67](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L67)*
# Interface: ERC1155AssetData ## Properties ### assetProxyId • **assetProxyId**: *string* *Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L187)* ___ ### callbackData • **callbackData**: *string* *Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L191)* ___ ### tokenAddress • **tokenAddress**: *string* *Defined in [types/src/index.ts:188](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L188)* ___ ### tokenIds • **tokenIds**: *`BigNumber`[]* *Defined in [types/src/index.ts:189](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L189)* ___ ### tokenValues • **tokenValues**: *`BigNumber`[]* *Defined in [types/src/index.ts:190](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L190)*
# Interface: ERC20AssetData ## Properties ### assetProxyId • **assetProxyId**: *string* *Defined in [types/src/index.ts:176](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L176)* ___ ### tokenAddress • **tokenAddress**: *string* *Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L177)*
# Interface: ERC721AssetData ## Properties ### assetProxyId • **assetProxyId**: *string* *Defined in [types/src/index.ts:181](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L181)* ___ ### tokenAddress • **tokenAddress**: *string* *Defined in [types/src/index.ts:182](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L182)* ___ ### tokenId • **tokenId**: *`BigNumber`* *Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L183)*
# Interface: MultiAssetData ## Properties ### amounts • **amounts**: *`BigNumber`[]* *Defined in [types/src/index.ts:212](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L212)* ___ ### assetProxyId • **assetProxyId**: *string* *Defined in [types/src/index.ts:211](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L211)* ___ ### nestedAssetData • **nestedAssetData**: *string[]* *Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L213)*
# Interface: MultiAssetDataWithRecursiveDecoding ## Properties ### amounts • **amounts**: *`BigNumber`[]* *Defined in [types/src/index.ts:218](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L218)* ___ ### assetProxyId • **assetProxyId**: *string* *Defined in [types/src/index.ts:217](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L217)* ___ ### nestedAssetData • **nestedAssetData**: *[SingleAssetData](#singleassetdata)[]* *Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L219)*
# Interface: SignedOrder ## Properties ### exchangeAddress • **exchangeAddress**: *string* *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* *Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L20)* ___ ### expirationTimeSeconds • **expirationTimeSeconds**: *`BigNumber`* *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* *Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L22)* ___ ### feeRecipientAddress • **feeRecipientAddress**: *string* *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* *Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L21)* ___ ### makerAddress • **makerAddress**: *string* *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* *Defined in [types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L11)* ___ ### makerAssetAmount • **makerAssetAmount**: *`BigNumber`* *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* *Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L15)* ___ ### makerAssetData • **makerAssetData**: *string* *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* *Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L17)* ___ ### makerFee • **makerFee**: *`BigNumber`* *Inherited from [Order](#interface-order).[makerFee](#makerfee)* *Defined in [types/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L13)* ___ ### salt • **salt**: *`BigNumber`* *Inherited from [Order](#interface-order).[salt](#salt)* *Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L19)* ___ ### senderAddress • **senderAddress**: *string* *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* *Defined in [types/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L10)* ___ ### signature • **signature**: *string* *Defined in [types/src/index.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L41)* ___ ### takerAddress • **takerAddress**: *string* *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* *Defined in [types/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L12)* ___ ### takerAssetAmount • **takerAssetAmount**: *`BigNumber`* *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* *Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L16)* ___ ### takerAssetData • **takerAssetData**: *string* *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* *Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L18)* ___ ### takerFee • **takerFee**: *`BigNumber`* *Inherited from [Order](#interface-order).[takerFee](#takerfee)* *Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L14)*
# Interface: SignedZeroExTransaction ## Properties ### data • **data**: *string* *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[data](#data)* *Defined in [types/src/index.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L56)* ___ ### salt • **salt**: *`BigNumber`* *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[salt](#salt)* *Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L54)* ___ ### signature • **signature**: *string* *Defined in [types/src/index.ts:60](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L60)* ___ ### signerAddress • **signerAddress**: *string* *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[signerAddress](#signeraddress)* *Defined in [types/src/index.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L55)* ___ ### verifyingContractAddress • **verifyingContractAddress**: *string* *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[verifyingContractAddress](#verifyingcontractaddress)* *Defined in [types/src/index.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L53)*
# Interface: SimpleContractArtifact ## Properties ### compilerOutput • **compilerOutput**: *[SimpleStandardContractOutput](#class-simplestandardcontractoutput)* *Defined in [types/src/index.ts:739](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L739)* ___ ### contractName • **contractName**: *string* *Defined in [types/src/index.ts:738](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L738)* ___ ### networks • **networks**: *`ContractNetworks`* *Defined in [types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L740)* ___ ### schemaVersion • **schemaVersion**: *string* *Defined in [types/src/index.ts:737](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L737)*
# Interface: SimpleEvmBytecodeOutput ## Properties ### object • **object**: *string* *Defined in [types/src/index.ts:754](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L754)*
# Interface: SimpleEvmOutput ## Properties ### bytecode • **bytecode**: *[SimpleEvmBytecodeOutput](#class-simpleevmbytecodeoutput)* *Defined in [types/src/index.ts:750](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L750)*
# Interface: SimpleStandardContractOutput ## Properties ### abi • **abi**: *[ContractAbi](#contractabi)* *Defined in [types/src/index.ts:744](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L744)* ___ ### `Optional` devdoc • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* *Defined in [types/src/index.ts:746](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L746)* ___ ### evm • **evm**: *[SimpleEvmOutput](#class-simpleevmoutput)* *Defined in [types/src/index.ts:745](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L745)*
# Interface: StaticCallAssetData ## Properties ### assetProxyId • **assetProxyId**: *string* *Defined in [types/src/index.ts:195](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L195)* ___ ### callResultHash • **callResultHash**: *string* *Defined in [types/src/index.ts:198](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L198)* ___ ### callTarget • **callTarget**: *string* *Defined in [types/src/index.ts:196](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L196)* ___ ### staticCallData • **staticCallData**: *string* *Defined in [types/src/index.ts:197](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L197)*
# Interface: ValidatorSignature Validator signature components ## Properties ### signature • **signature**: *string* *Defined in [types/src/index.ts:77](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L77)* ___ ### validatorAddress • **validatorAddress**: *string* *Defined in [types/src/index.ts:76](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L76)*
# Interface: ZeroExTransaction ZeroExTransaction for use with 0x Exchange executeTransaction ## Properties ### data • **data**: *string* *Defined in [types/src/index.ts:56](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L56)* ___ ### salt • **salt**: *`BigNumber`* *Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L54)* ___ ### signerAddress • **signerAddress**: *string* *Defined in [types/src/index.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L55)* ___ ### verifyingContractAddress • **verifyingContractAddress**: *string* *Defined in [types/src/index.ts:53](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L53)*
## Type aliases ### CoordinatorRegistryEventArgs Ƭ **CoordinatorRegistryEventArgs**: *[CoordinatorRegistryCoordinatorEndpointSetEventArgs](#interface-coordinatorregistrycoordinatorendpointseteventargs)* *Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L34)*
## Type aliases ### DummyERC20TokenEventArgs Ƭ **DummyERC20TokenEventArgs**: *[DummyERC20TokenTransferEventArgs](#interface-dummyerc20tokentransfereventargs) | [DummyERC20TokenApprovalEventArgs](#interface-dummyerc20tokenapprovaleventargs)* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L34)*
## Type aliases ### DummyERC721TokenEventArgs Ƭ **DummyERC721TokenEventArgs**: *[DummyERC721TokenTransferEventArgs](#interface-dummyerc721tokentransfereventargs) | [DummyERC721TokenApprovalEventArgs](#interface-dummyerc721tokenapprovaleventargs) | [DummyERC721TokenApprovalForAllEventArgs](#interface-dummyerc721tokenapprovalforalleventargs)* *Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L34)*
## Type aliases ### ERC1155ProxyEventArgs Ƭ **ERC1155ProxyEventArgs**: *[ERC1155ProxyAuthorizedAddressAddedEventArgs](#interface-erc1155proxyauthorizedaddressaddedeventargs) | [ERC1155ProxyAuthorizedAddressRemovedEventArgs](#interface-erc1155proxyauthorizedaddressremovedeventargs)* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L34)*
## Type aliases ### ERC20ProxyEventArgs Ƭ **ERC20ProxyEventArgs**: *[ERC20ProxyAuthorizedAddressAddedEventArgs](#interface-erc20proxyauthorizedaddressaddedeventargs) | [ERC20ProxyAuthorizedAddressRemovedEventArgs](#interface-erc20proxyauthorizedaddressremovedeventargs)* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L34)*
## Type aliases ### ERC20TokenEventArgs Ƭ **ERC20TokenEventArgs**: *[ERC20TokenTransferEventArgs](#interface-erc20tokentransfereventargs) | [ERC20TokenApprovalEventArgs](#interface-erc20tokenapprovaleventargs)* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L34)*
## Type aliases ### ERC721ProxyEventArgs Ƭ **ERC721ProxyEventArgs**: *[ERC721ProxyAuthorizedAddressAddedEventArgs](#interface-erc721proxyauthorizedaddressaddedeventargs) | [ERC721ProxyAuthorizedAddressRemovedEventArgs](#interface-erc721proxyauthorizedaddressremovedeventargs)* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L34)*
## Type aliases ### ERC721TokenEventArgs Ƭ **ERC721TokenEventArgs**: *[ERC721TokenTransferEventArgs](#interface-erc721tokentransfereventargs) | [ERC721TokenApprovalEventArgs](#interface-erc721tokenapprovaleventargs) | [ERC721TokenApprovalForAllEventArgs](#interface-erc721tokenapprovalforalleventargs)* *Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L34)*
## Type aliases ### ExchangeEventArgs Ƭ **ExchangeEventArgs**: *[ExchangeSignatureValidatorApprovalEventArgs](#interface-exchangesignaturevalidatorapprovaleventargs) | [ExchangeFillEventArgs](#interface-exchangefilleventargs) | [ExchangeCancelEventArgs](#interface-exchangecanceleventargs) | [ExchangeCancelUpToEventArgs](#interface-exchangecanceluptoeventargs) | [ExchangeAssetProxyRegisteredEventArgs](#interface-exchangeassetproxyregisteredeventargs)* *Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L34)*
## 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:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L34)*
## Type aliases ### ZRXTokenEventArgs Ƭ **ZRXTokenEventArgs**: *[ZRXTokenTransferEventArgs](#interface-zrxtokentransfereventargs) | [ZRXTokenApprovalEventArgs](#interface-zrxtokenapprovaleventargs)* *Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L34)*
## Functions ### getContractAddressesForNetworkOrThrow ▸ **getContractAddressesForNetworkOrThrow**(`networkId`: [NetworkId](#enumeration-networkid)): *[ContractAddresses](#interface-contractaddresses)* *Defined in [contract-addresses/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L128)* Used to get addresses of contracts that have been deployed to either the Ethereum mainnet or a supported testnet. Throws if there are no known contracts deployed on the corresponding network. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `networkId` | [NetworkId](#enumeration-networkid) | The desired networkId. | **Returns:** *[ContractAddresses](#interface-contractaddresses)* The set of addresses for contracts which have been deployed on the given networkId. ___ ### getNetworkIdByExchangeAddressOrThrow ▸ **getNetworkIdByExchangeAddressOrThrow**(`exchangeAddress`: string): *[NetworkId](#enumeration-networkid)* *Defined in [contract-addresses/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-addresses/src/index.ts#L142)* Uses a given exchange address to look up the network id that the exchange contract is deployed on. Only works for Ethereum mainnet or a supported testnet. Throws if the exchange address does not correspond to a known deployed exchange contract. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `exchangeAddress` | string | The exchange address of concern | **Returns:** *[NetworkId](#enumeration-networkid)* The network ID on which the exchange contract is deployed
## Type aliases ### EventCallback Ƭ **EventCallback**: *function* *Defined in [contract-wrappers/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/contract-wrappers/src/types.ts#L11)* #### Type declaration: ▸ (`err`: null | `Error`, `log?`: [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*›): *void* **Parameters:** Name | Type | ------ | ------ | `err` | null \| `Error` | `log?` | [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*› |
## Type aliases ### AbiDefinition Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi)* *Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L80)* ___ ### BlockParam Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* *Defined in [ethereum-types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L475)* ___ ### ConstructorStateMutability Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* *Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L84)* ___ ### ContractAbi Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* *Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L78)* ___ ### ContractEventArg Ƭ **ContractEventArg**: *any* *Defined in [ethereum-types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L460)* ___ ### EIP1193Event Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* *Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L70)* 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/23602ec6b/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/23602ec6b/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:517](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L517)* ___ ### ParamDescription Ƭ **ParamDescription**: *string* *Defined in [ethereum-types/src/index.ts:553](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L553)* ___ ### RawLog Ƭ **RawLog**: *[LogEntry](#interface-logentry)* *Defined in [ethereum-types/src/index.ts:467](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L467)* ___ ### StateMutability Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* *Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/ethereum-types/src/index.ts#L85)* ___ ### 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/23602ec6b/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/23602ec6b/packages/ethereum-types/src/index.ts#L11)*
## Object literals ### `Const` assetDataUtils #### ▪ **assetDataUtils**: *object* *Defined in [order-utils/src/asset_data_utils.ts:23](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L23)* #### assertIsERC1155AssetData ▸ **assertIsERC1155AssetData**(`assetData`: string): *void* *Defined in [order-utils/src/asset_data_utils.ts:397](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L397)* Throws if the assetData is not ERC1155. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string | **Returns:** *void* #### assertIsERC20AssetData ▸ **assertIsERC20AssetData**(`assetData`: string): *void* *Defined in [order-utils/src/asset_data_utils.ts:353](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L353)* Throws if the length or assetProxyId are invalid for the ERC20Proxy. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string | **Returns:** *void* #### assertIsERC721AssetData ▸ **assertIsERC721AssetData**(`assetData`: string): *void* *Defined in [order-utils/src/asset_data_utils.ts:375](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L375)* Throws if the length or assetProxyId are invalid for the ERC721Proxy. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string | **Returns:** *void* #### assertIsMultiAssetData ▸ **assertIsMultiAssetData**(`assetData`: string): *void* *Defined in [order-utils/src/asset_data_utils.ts:419](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L419)* Throws if the length or assetProxyId are invalid for the MultiAssetProxy. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string | **Returns:** *void* #### assertIsStaticCallAssetData ▸ **assertIsStaticCallAssetData**(`assetData`: string): *void* *Defined in [order-utils/src/asset_data_utils.ts:441](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L441)* Throws if the assetData is not StaticCallData. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string | **Returns:** *void* #### assertWordAlignedAssetData ▸ **assertWordAlignedAssetData**(`assetData`: string): *void* *Defined in [order-utils/src/asset_data_utils.ts:463](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L463)* Throws if the assetData is not padded to 32 bytes. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string | **Returns:** *void* #### decodeAssetDataOrThrow ▸ **decodeAssetDataOrThrow**(`assetData`: string): *[SingleAssetData](#singleassetdata) | `MultiAssetData`* *Defined in [order-utils/src/asset_data_utils.ts:502](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L502)* Decode any assetData into its corresponding assetData object **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string to decode | **Returns:** *[SingleAssetData](#singleassetdata) | `MultiAssetData`* Either a ERC20, ERC721, ERC1155, or MultiAsset assetData object #### decodeAssetProxyId ▸ **decodeAssetProxyId**(`assetData`: string): *`AssetProxyId`* *Defined in [order-utils/src/asset_data_utils.ts:294](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L294)* Decode and return the assetProxyId from the assetData **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string to decode | **Returns:** *`AssetProxyId`* The assetProxyId #### decodeDutchAuctionData ▸ **decodeDutchAuctionData**(`dutchAuctionData`: string): *`DutchAuctionData`* *Defined in [order-utils/src/asset_data_utils.ts:263](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L263)* Dutch auction details are encoded with the asset data for a 0x order. This function decodes a hex encoded assetData string, containing information both about the asset being traded and the dutch auction. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `dutchAuctionData` | string | Hex encoded assetData string for the asset being auctioned. | **Returns:** *`DutchAuctionData`* An object containing the auction asset, auction begin time and auction begin amount. #### decodeERC1155AssetData ▸ **decodeERC1155AssetData**(`assetData`: string): *`ERC1155AssetData`* *Defined in [order-utils/src/asset_data_utils.ts:107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L107)* Decodes an ERC1155 assetData hex string into its corresponding ERC1155 components. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string to decode | **Returns:** *`ERC1155AssetData`* An object containing the decoded tokenAddress, tokenIds, tokenValues, callbackData & assetProxyId #### decodeERC20AssetData ▸ **decodeERC20AssetData**(`assetData`: string): *`ERC20AssetData`* *Defined in [order-utils/src/asset_data_utils.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L41)* Decodes an ERC20 assetData hex string into its corresponding ERC20 tokenAddress & assetProxyId **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string to decode | **Returns:** *`ERC20AssetData`* An object containing the decoded tokenAddress & assetProxyId #### decodeERC721AssetData ▸ **decodeERC721AssetData**(`assetData`: string): *`ERC721AssetData`* *Defined in [order-utils/src/asset_data_utils.ts:70](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L70)* Decodes an ERC721 assetData hex string into its corresponding ERC721 tokenAddress, tokenId & assetProxyId **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string to decode | **Returns:** *`ERC721AssetData`* An object containing the decoded tokenAddress, tokenId & assetProxyId #### decodeMultiAssetData ▸ **decodeMultiAssetData**(`assetData`: string): *`MultiAssetData`* *Defined in [order-utils/src/asset_data_utils.ts:149](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L149)* Decodes a MultiAsset assetData hex string into its corresponding amounts and nestedAssetData **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string to decode | **Returns:** *`MultiAssetData`* An object containing the decoded amounts and nestedAssetData #### decodeMultiAssetDataRecursively ▸ **decodeMultiAssetDataRecursively**(`assetData`: string): *`MultiAssetDataWithRecursiveDecoding`* *Defined in [order-utils/src/asset_data_utils.ts:175](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L175)* Decodes a MultiAsset assetData hex string into its corresponding amounts and decoded nestedAssetData elements (all nested elements are flattened) **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string to decode | **Returns:** *`MultiAssetDataWithRecursiveDecoding`* An object containing the decoded amounts and nestedAssetData #### decodeStaticCallAssetData ▸ **decodeStaticCallAssetData**(`assetData`: string): *`StaticCallAssetData`* *Defined in [order-utils/src/asset_data_utils.ts:225](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L225)* Decoded StaticCall assetData into its corresponding callTarget, staticCallData, and expected callResultHash **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string to decode | **Returns:** *`StaticCallAssetData`* An object containing the decoded callTarget, staticCallData, and expected callResultHash #### encodeDutchAuctionAssetData ▸ **encodeDutchAuctionAssetData**(`assetData`: string, `beginTimeSeconds`: `BigNumber`, `beginAmount`: `BigNumber`): *string* *Defined in [order-utils/src/asset_data_utils.ts:245](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L245)* Dutch auction details are encoded with the asset data for a 0x order. This function produces a hex encoded assetData string, containing information both about the asset being traded and the dutch auction; which is usable in the makerAssetData or takerAssetData fields in a 0x order. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string for the asset being auctioned. | `beginTimeSeconds` | `BigNumber` | Begin time of the dutch auction. | `beginAmount` | `BigNumber` | Starting amount being sold in the dutch auction. | **Returns:** *string* The hex encoded assetData string. #### encodeERC1155AssetData ▸ **encodeERC1155AssetData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *string* *Defined in [order-utils/src/asset_data_utils.ts:91](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L91)* Encodes a set of ERC1155 assets into an assetData string, usable in the makerAssetData or takerAssetData fields of a 0x order. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `tokenAddress` | string | The token address of the ERC1155 contract | `tokenIds` | `BigNumber`[] | The Id's of the ERC1155 tokens to transfer | `tokenValues` | `BigNumber`[] | The values of each respective token Id to transfer | `callbackData` | string | The data forwarded to a receiver, if receiver is a contract. | **Returns:** *string* The hex encoded assetData string #### encodeERC20AssetData ▸ **encodeERC20AssetData**(`tokenAddress`: string): *string* *Defined in [order-utils/src/asset_data_utils.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L30)* Encodes an ERC20 token address into a hex encoded assetData string, usable in the makerAssetData or takerAssetData fields in a 0x order. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `tokenAddress` | string | The ERC20 token address to encode | **Returns:** *string* The hex encoded assetData string #### encodeERC721AssetData ▸ **encodeERC721AssetData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string* *Defined in [order-utils/src/asset_data_utils.ts:59](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L59)* Encodes an ERC721 token address into a hex encoded assetData string, usable in the makerAssetData or takerAssetData fields in a 0x order. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `tokenAddress` | string | The ERC721 token address to encode | `tokenId` | `BigNumber` | The ERC721 tokenId to encode | **Returns:** *string* The hex encoded assetData string #### encodeMultiAssetData ▸ **encodeMultiAssetData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *string* *Defined in [order-utils/src/asset_data_utils.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L130)* Encodes assetData for multiple AssetProxies into a single hex encoded assetData string, usable in the makerAssetData or takerAssetData fields in a 0x order. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `amounts` | `BigNumber`[] | Amounts of each asset that correspond to a single unit within an order. | `nestedAssetData` | string[] | assetData strings that correspond to a valid assetProxyId. | **Returns:** *string* The hex encoded assetData string #### encodeStaticCallAssetData ▸ **encodeStaticCallAssetData**(`callTarget`: string, `staticCallData`: string, `callResultHash`: string): *string* *Defined in [order-utils/src/asset_data_utils.ts:214](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L214)* Encodes StaticCallProxy data into an assetData hex string **Parameters:** Name | Type | Description | ------ | ------ | ------ | `callTarget` | string | Address of contract to call from StaticCallProxy | `staticCallData` | string | The function data that will be called on the callTarget contract | `callResultHash` | string | The keccak256 hash of the ABI encoded expected output of the static call | **Returns:** *string* The hex encoded assetData string #### isERC1155AssetData ▸ **isERC1155AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* *Defined in [order-utils/src/asset_data_utils.ts:332](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L332)* Checks if the decoded asset data is valid ERC1155 data **Parameters:** Name | Type | Description | ------ | ------ | ------ | `decodedAssetData` | [SingleAssetData](#singleassetdata) \| `MultiAssetData` | The decoded asset data to check | **Returns:** *boolean* #### isERC20AssetData ▸ **isERC20AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* *Defined in [order-utils/src/asset_data_utils.ts:318](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L318)* Checks if the decoded asset data is valid ERC20 data **Parameters:** Name | Type | Description | ------ | ------ | ------ | `decodedAssetData` | [SingleAssetData](#singleassetdata) \| `MultiAssetData` | The decoded asset data to check | **Returns:** *boolean* #### isERC721AssetData ▸ **isERC721AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* *Defined in [order-utils/src/asset_data_utils.ts:325](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L325)* Checks if the decoded asset data is valid ERC721 data **Parameters:** Name | Type | Description | ------ | ------ | ------ | `decodedAssetData` | [SingleAssetData](#singleassetdata) \| `MultiAssetData` | The decoded asset data to check | **Returns:** *boolean* #### isMultiAssetData ▸ **isMultiAssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* *Defined in [order-utils/src/asset_data_utils.ts:339](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L339)* Checks if the decoded asset data is valid MultiAsset data **Parameters:** Name | Type | Description | ------ | ------ | ------ | `decodedAssetData` | [SingleAssetData](#singleassetdata) \| `MultiAssetData` | The decoded asset data to check | **Returns:** *boolean* #### isStaticCallAssetData ▸ **isStaticCallAssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* *Defined in [order-utils/src/asset_data_utils.ts:346](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L346)* Checks if the decoded asset data is valid StaticCall data **Parameters:** Name | Type | Description | ------ | ------ | ------ | `decodedAssetData` | [SingleAssetData](#singleassetdata) \| `MultiAssetData` | The decoded asset data to check | **Returns:** *boolean* #### validateAssetDataOrThrow ▸ **validateAssetDataOrThrow**(`assetData`: string): *void* *Defined in [order-utils/src/asset_data_utils.ts:475](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/asset_data_utils.ts#L475)* Throws if the length or assetProxyId are invalid for the corresponding AssetProxy. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `assetData` | string | Hex encoded assetData string | **Returns:** *void*
## Object literals #### `Const` orderHashUtils #### ▪ **orderHashUtils**: *object* *Defined in [order-utils/src/order_hash.ts:12](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_hash.ts#L12)* #### getOrderHashBuffer ▸ **getOrderHashBuffer**(`order`: `SignedOrder` | `Order`): *`Buffer`* *Defined in [order-utils/src/order_hash.ts:55](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_hash.ts#L55)* Computes the orderHash for a supplied order **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | `SignedOrder` \| `Order` | An object that conforms to the Order or SignedOrder interface definitions. | **Returns:** *`Buffer`* A Buffer containing the resulting orderHash from hashing the supplied order #### getOrderHashHex ▸ **getOrderHashHex**(`order`: `SignedOrder` | `Order`): *string* *Defined in [order-utils/src/order_hash.ts:33](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_hash.ts#L33)* Computes the orderHash for a supplied order. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `order` | `SignedOrder` \| `Order` | An object that conforms to the Order or SignedOrder interface definitions. | **Returns:** *string* Hex encoded string orderHash from hashing the supplied order. #### isValidOrderHash ▸ **isValidOrderHash**(`orderHash`: string): *boolean* *Defined in [order-utils/src/order_hash.ts:20](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/order_hash.ts#L20)* Checks if the supplied hex encoded order hash is valid. Note: Valid means it has the expected format, not that an order with the orderHash exists. Use this method when processing orderHashes submitted as user input. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `orderHash` | string | Hex encoded orderHash. | **Returns:** *boolean* Whether the supplied orderHash has the expected format.
## Functions #### generatePseudoRandomSalt ▸ **generatePseudoRandomSalt**(): *`BigNumber`* *Defined in [order-utils/src/salt.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/salt.ts#L9)* Generates a pseudo-random 256-bit salt. The salt can be included in a 0x order, ensuring that the order generates a unique orderHash and will not collide with other outstanding orders that are identical in all other parameters. **Returns:** *`BigNumber`* A pseudo-random 256-bit number that can be used as a salt.
## Object literals #### `Const` signatureUtils #### ▪ **signatureUtils**: *object* *Defined in [order-utils/src/signature_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L27)* #### addSignedMessagePrefix ▸ **addSignedMessagePrefix**(`message`: string): *string* *Defined in [order-utils/src/signature_utils.ts:500](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L500)* Adds the relevant prefix to the message being signed. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `message` | string | Message to sign | **Returns:** *string* Prefixed message #### convertECSignatureToSignatureHex ▸ **convertECSignatureToSignatureHex**(`ecSignature`: `ECSignature`): *string* *Defined in [order-utils/src/signature_utils.ts:474](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L474)* Combines ECSignature with V,R,S and the EthSign signature type for use in 0x protocol **Parameters:** Name | Type | Description | ------ | ------ | ------ | `ecSignature` | `ECSignature` | The ECSignature of the signed data | **Returns:** *string* Hex encoded string of signature (v,r,s) with Signature Type #### convertToSignatureWithType ▸ **convertToSignatureWithType**(`signature`: string, `signatureType`: `SignatureType`): *string* *Defined in [order-utils/src/signature_utils.ts:490](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L490)* Combines the signature proof and the Signature Type. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `signature` | string | The hex encoded signature proof | `signatureType` | `SignatureType` | The signature type, i.e EthSign, Wallet etc. | **Returns:** *string* Hex encoded string of signature proof with Signature Type #### ecSignHashAsync ▸ **ecSignHashAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `msgHash`: string, `signerAddress`: string): *`Promise`* *Defined in [order-utils/src/signature_utils.ts:417](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L417)* Signs a hash using `eth_sign` and returns its elliptic curve signature and signature type. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests | `msgHash` | string | Hex encoded message to sign. | `signerAddress` | string | The hex encoded Ethereum address you wish to sign it with. This address must be available via the supplied Provider. | **Returns:** *`Promise`* A hex encoded string containing the Elliptic curve signature generated by signing the msgHash and the Signature Type. #### ecSignOrderAsync ▸ **ecSignOrderAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `order`: `Order`, `signerAddress`: string): *`Promise`* *Defined in [order-utils/src/signature_utils.ts:252](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L252)* Signs an order and returns a SignedOrder. First `eth_signTypedData` is requested then a fallback to `eth_sign` if not available on the supplied provider. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests | `order` | `Order` | The Order to sign. | `signerAddress` | string | The hex encoded Ethereum address you wish to sign it with. This address must be available via the supplied Provider. | **Returns:** *`Promise`* A SignedOrder containing the order and Elliptic curve signature with Signature Type. #### ecSignTransactionAsync ▸ **ecSignTransactionAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `transaction`: `ZeroExTransaction`, `signerAddress`: string): *`Promise`* *Defined in [order-utils/src/signature_utils.ts:331](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L331)* Signs a transaction and returns a SignedZeroExTransaction. First `eth_signTypedData` is requested then a fallback to `eth_sign` if not available on the supplied provider. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests | `transaction` | `ZeroExTransaction` | The ZeroExTransaction to sign. | `signerAddress` | string | The hex encoded Ethereum address you wish to sign it with. This address must be available via the supplied Provider. | **Returns:** *`Promise`* A SignedTransaction containing the order and Elliptic curve signature with Signature Type. #### ecSignTypedDataOrderAsync ▸ **ecSignTypedDataOrderAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `order`: `Order`, `signerAddress`: string): *`Promise`* *Defined in [order-utils/src/signature_utils.ts:287](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L287)* Signs an order using `eth_signTypedData` and returns a SignedOrder. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests | `order` | `Order` | The Order to sign. | `signerAddress` | string | The hex encoded Ethereum address you wish to sign it with. This address must be available via the supplied Provider. | **Returns:** *`Promise`* A SignedOrder containing the order and Elliptic curve signature with Signature Type. #### ecSignTypedDataTransactionAsync ▸ **ecSignTypedDataTransactionAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `transaction`: `ZeroExTransaction`, `signerAddress`: string): *`Promise`* *Defined in [order-utils/src/signature_utils.ts:374](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L374)* Signs a ZeroExTransaction using `eth_signTypedData` and returns a SignedZeroExTransaction. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests | `transaction` | `ZeroExTransaction` | The ZeroEx Transaction to sign. | `signerAddress` | string | The hex encoded Ethereum address you wish to sign it with. This address must be available via the supplied Provider. | **Returns:** *`Promise`* A SignedZeroExTransaction containing the ZeroExTransaction and Elliptic curve signature with Signature Type. #### isValidECSignature ▸ **isValidECSignature**(`data`: string, `signature`: `ECSignature`, `signerAddress`: string): *boolean* *Defined in [order-utils/src/signature_utils.ts:222](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L222)* Checks if the supplied elliptic curve signature corresponds to signing `data` with the private key corresponding to `signerAddress` **Parameters:** Name | Type | Description | ------ | ------ | ------ | `data` | string | The hex encoded data signed by the supplied signature. | `signature` | `ECSignature` | An object containing the elliptic curve signature parameters. | `signerAddress` | string | The hex encoded address that signed the data, producing the supplied signature. | **Returns:** *boolean* Whether the ECSignature is valid. #### isValidPresignedSignatureAsync ▸ **isValidPresignedSignatureAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `data`: string, `signerAddress`: string, `exchangeAddress?`: undefined | string): *`Promise`* *Defined in [order-utils/src/signature_utils.ts:107](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L107)* Verifies that the provided presigned signature is valid according to the 0x Protocol smart contracts **Parameters:** Name | Type | Description | ------ | ------ | ------ | `supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests | `data` | string | The hex encoded data signed by the supplied signature | `signerAddress` | string | The hex encoded address that signed the data, producing the supplied signature. | `exchangeAddress?` | undefined \| string | The address of the Exchange contract to validate the signature against. | **Returns:** *`Promise`* Whether the data was preSigned by the supplied signerAddress #### isValidSignatureAsync ▸ **isValidSignatureAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `data`: string, `signature`: string, `signerAddress`: string, `exchangeAddress?`: undefined | string): *`Promise`* *Defined in [order-utils/src/signature_utils.ts:38](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L38)* Verifies that the provided signature is valid according to the 0x Protocol smart contracts **Parameters:** Name | Type | Description | ------ | ------ | ------ | `supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests | `data` | string | The hex encoded data signed by the supplied signature. | `signature` | string | A hex encoded 0x Protocol signature made up of: [TypeSpecificData][SignatureType]. E.g [vrs][SignatureType.EIP712] | `signerAddress` | string | The hex encoded address that signed the data, producing the supplied signature. | `exchangeAddress?` | undefined \| string | Optional address of the Exchange contract to validate the signature against. | **Returns:** *`Promise`* Whether the signature is valid for the supplied signerAddress and data. #### isValidValidatorSignatureAsync ▸ **isValidValidatorSignatureAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `data`: string, `signature`: string, `signerAddress`: string, `exchangeAddress?`: undefined | string): *`Promise`* *Defined in [order-utils/src/signature_utils.ts:168](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L168)* Verifies that the provided validator signature is valid according to the 0x Protocol smart contracts **Parameters:** Name | Type | Description | ------ | ------ | ------ | `supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests | `data` | string | The hex encoded data signed by the supplied signature. | `signature` | string | A hex encoded presigned 0x Protocol signature made up of: [SignatureType.Presigned] | `signerAddress` | string | The hex encoded address that signed the data, producing the supplied signature. | `exchangeAddress?` | undefined \| string | The address of the Exchange contract to validate the signature against. | **Returns:** *`Promise`* Whether the data was preSigned by the supplied signerAddress. #### isValidWalletSignatureAsync ▸ **isValidWalletSignatureAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `data`: string, `signature`: string, `signerAddress`: string): *`Promise`* *Defined in [order-utils/src/signature_utils.ts:139](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L139)* Verifies that the provided wallet signature is valid according to the 0x Protocol smart contracts **Parameters:** Name | Type | Description | ------ | ------ | ------ | `supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for all JSON RPC requests | `data` | string | The hex encoded data signed by the supplied signature. | `signature` | string | A hex encoded presigned 0x Protocol signature made up of: [SignatureType.Presigned] | `signerAddress` | string | The hex encoded address that signed the data, producing the supplied signature. | **Returns:** *`Promise`* Whether the data was preSigned by the supplied signerAddress. #### parseECSignature ▸ **parseECSignature**(`signature`: string): *`ECSignature`* *Defined in [order-utils/src/signature_utils.ts:512](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L512)* Parse a 0x protocol hex-encoded signature string into its ECSignature components **Parameters:** Name | Type | Description | ------ | ------ | ------ | `signature` | string | A hex encoded ecSignature 0x Protocol signature | **Returns:** *`ECSignature`* An ECSignature object with r,s,v parameters #### parseValidatorSignature ▸ **parseValidatorSignature**(`signature`: string): *`ValidatorSignature`* *Defined in [order-utils/src/signature_utils.ts:529](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/signature_utils.ts#L529)* Parse a hex-encoded Validator signature into validator address and signature components **Parameters:** Name | Type | Description | ------ | ------ | ------ | `signature` | string | A hex encoded Validator 0x Protocol signature | **Returns:** *`ValidatorSignature`* A ValidatorSignature with validatorAddress and signature parameters
## Object literals #### `Const` transactionHashUtils #### ▪ **transactionHashUtils**: *object* *Defined in [order-utils/src/transaction_hash.ts:9](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/transaction_hash.ts#L9)* #### getTransactionHashBuffer ▸ **getTransactionHashBuffer**(`transaction`: `ZeroExTransaction` | `SignedZeroExTransaction`): *`Buffer`* *Defined in [order-utils/src/transaction_hash.ts:41](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/transaction_hash.ts#L41)* Computes the transactionHash for a supplied 0x transaction. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `transaction` | `ZeroExTransaction` \| `SignedZeroExTransaction` | An object that conforms to the ZeroExTransaction or SignedZeroExTransaction interface definitions. | **Returns:** *`Buffer`* A Buffer containing the resulting transactionHash from hashing the supplied 0x transaction. #### getTransactionHashHex ▸ **getTransactionHashHex**(`transaction`: `ZeroExTransaction` | `SignedZeroExTransaction`): *string* *Defined in [order-utils/src/transaction_hash.ts:30](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/transaction_hash.ts#L30)* Computes the transactionHash for a supplied 0x transaction. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `transaction` | `ZeroExTransaction` \| `SignedZeroExTransaction` | An object that conforms to the ZeroExTransaction or SignedZeroExTransaction interface definitions. | **Returns:** *string* Hex encoded string transactionHash from hashing the supplied order. #### isValidTransactionHash ▸ **isValidTransactionHash**(`transactionHash`: string): *boolean* *Defined in [order-utils/src/transaction_hash.ts:17](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/order-utils/src/transaction_hash.ts#L17)* Checks if the supplied hex encoded 0x transaction hash is valid. Note: Valid means it has the expected format, not that a transaction with the transactionHash exists. Use this method when processing transactionHashes submitted as user input. **Parameters:** Name | Type | Description | ------ | ------ | ------ | `transactionHash` | string | Hex encoded transactionHash. | **Returns:** *boolean* Whether the supplied transactionHash has the expected format.
## Type aliases #### Callback Ƭ **Callback**: *function* *Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/types.ts#L131)* ##### Type declaration: ▸ (): *void* ___ ### ErrorCallback Ƭ **ErrorCallback**: *function* *Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/subproviders/src/types.ts#L130)* #### Type declaration: ▸ (`err`: `Error` | null, `data?`: any): *void* **Parameters:** Name | Type | ------ | ------ | `err` | `Error` \| null | `data?` | any | ___ ## Type aliases ### AssetData Ƭ **AssetData**: *[SingleAssetData](_types_src_index_.md#singleassetdata) | [MultiAssetData](#interface-multiassetdata) | [MultiAssetDataWithRecursiveDecoding](#interface-multiassetdatawithrecursivedecoding)* *Defined in [types/src/index.ts:228](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L228)* ___ ### SingleAssetData Ƭ **SingleAssetData**: *[ERC20AssetData](#interface-erc20assetdata) | [ERC721AssetData](#interface-erc721assetdata) | [ERC1155AssetData](#interface-erc1155assetdata) | [StaticCallAssetData](#interface-staticcallassetdata)* *Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/23602ec6b/packages/types/src/index.ts#L208)*