diff --git a/contracts/asset-proxy/CHANGELOG.json b/contracts/asset-proxy/CHANGELOG.json index 83585535c9..9026806648 100644 --- a/contracts/asset-proxy/CHANGELOG.json +++ b/contracts/asset-proxy/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils", "pr": 2330 } - ] + ], + "timestamp": 1574030254 }, { "version": "2.3.0-beta.1", diff --git a/contracts/asset-proxy/CHANGELOG.md b/contracts/asset-proxy/CHANGELOG.md index 882260ebc4..3b3e0e3c36 100644 --- a/contracts/asset-proxy/CHANGELOG.md +++ b/contracts/asset-proxy/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.3.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + ## v2.3.0-beta.1 - _November 7, 2019_ * ERC20Wrapper and ERC1155ProxyWrapper constructors now require an instance of DevUtilsContract (#2034) diff --git a/contracts/coordinator/CHANGELOG.json b/contracts/coordinator/CHANGELOG.json index 8468459169..2a8b4cc22c 100644 --- a/contracts/coordinator/CHANGELOG.json +++ b/contracts/coordinator/CHANGELOG.json @@ -14,7 +14,8 @@ "note": "Added dependency on @0x/contracts-utils", "pr": 2321 } - ] + ], + "timestamp": 1574030254 }, { "version": "2.1.0-beta.1", diff --git a/contracts/coordinator/CHANGELOG.md b/contracts/coordinator/CHANGELOG.md index e92e0e0326..4539a8f328 100644 --- a/contracts/coordinator/CHANGELOG.md +++ b/contracts/coordinator/CHANGELOG.md @@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.1.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + * Introduced new export CoordinatorRevertErrors (#2321) + * Added dependency on @0x/contracts-utils (#2321) + ## v2.1.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/contracts/dev-utils/CHANGELOG.json b/contracts/dev-utils/CHANGELOG.json index 74d14f0574..a8d2e42a36 100644 --- a/contracts/dev-utils/CHANGELOG.json +++ b/contracts/dev-utils/CHANGELOG.json @@ -14,7 +14,8 @@ "note": "Add new method getTransactionHash() to DevUtils contract", "pr": 2321 } - ] + ], + "timestamp": 1574030254 }, { "version": "0.1.0-beta.1", diff --git a/contracts/dev-utils/CHANGELOG.md b/contracts/dev-utils/CHANGELOG.md index 0e170f613a..9824c02846 100644 --- a/contracts/dev-utils/CHANGELOG.md +++ b/contracts/dev-utils/CHANGELOG.md @@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v0.1.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + * Add new method getOrderHash() to DevUtils contract (#2321) + * Add new method getTransactionHash() to DevUtils contract (#2321) + ## v0.1.0-beta.1 - _November 7, 2019_ * Add `encodeStaticCallAssetData` and `decodeStaticCallAssetData` in LibAssetData (#2034) diff --git a/contracts/erc1155/CHANGELOG.json b/contracts/erc1155/CHANGELOG.json index 4e372b26b8..1d305e525d 100644 --- a/contracts/erc1155/CHANGELOG.json +++ b/contracts/erc1155/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils", "pr": 2330 } - ] + ], + "timestamp": 1574030254 }, { "version": "1.2.0-beta.1", diff --git a/contracts/erc1155/CHANGELOG.md b/contracts/erc1155/CHANGELOG.md index 5b7231a7bc..c43a761cb6 100644 --- a/contracts/erc1155/CHANGELOG.md +++ b/contracts/erc1155/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v1.2.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + ## v1.2.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/contracts/erc20/CHANGELOG.json b/contracts/erc20/CHANGELOG.json index 5db312aba7..b44d8f21af 100644 --- a/contracts/erc20/CHANGELOG.json +++ b/contracts/erc20/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils", "pr": 2330 } - ] + ], + "timestamp": 1574030254 }, { "version": "2.3.0-beta.1", diff --git a/contracts/erc20/CHANGELOG.md b/contracts/erc20/CHANGELOG.md index d07b2faad3..81784d653c 100644 --- a/contracts/erc20/CHANGELOG.md +++ b/contracts/erc20/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.3.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + ## v2.3.0-beta.1 - _November 7, 2019_ * Create `LibERC20Token` (#2309) diff --git a/contracts/erc721/CHANGELOG.json b/contracts/erc721/CHANGELOG.json index 562d6545c7..771ef0bf9e 100644 --- a/contracts/erc721/CHANGELOG.json +++ b/contracts/erc721/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils", "pr": 2330 } - ] + ], + "timestamp": 1574030254 }, { "version": "2.2.0-beta.1", diff --git a/contracts/erc721/CHANGELOG.md b/contracts/erc721/CHANGELOG.md index 3effd9e47b..e3de36e5e4 100644 --- a/contracts/erc721/CHANGELOG.md +++ b/contracts/erc721/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.2.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + ## v2.2.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/contracts/exchange-forwarder/CHANGELOG.json b/contracts/exchange-forwarder/CHANGELOG.json index de5500643b..4f986c7386 100644 --- a/contracts/exchange-forwarder/CHANGELOG.json +++ b/contracts/exchange-forwarder/CHANGELOG.json @@ -10,7 +10,8 @@ "note": "Introduced new export ForwarderRevertErrors", "pr": 2321 } - ] + ], + "timestamp": 1574030254 }, { "version": "3.1.0-beta.1", diff --git a/contracts/exchange-forwarder/CHANGELOG.md b/contracts/exchange-forwarder/CHANGELOG.md index b9ecb689bb..4e58cca8a1 100644 --- a/contracts/exchange-forwarder/CHANGELOG.md +++ b/contracts/exchange-forwarder/CHANGELOG.md @@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.1.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + * Introduced new export ForwarderRevertErrors (#2321) + ## v3.1.0-beta.1 - _November 7, 2019_ * Use `LibERC20Token` in `MixinAssets` (#2309) diff --git a/contracts/exchange-libs/CHANGELOG.json b/contracts/exchange-libs/CHANGELOG.json index 07051cc835..ba30190203 100644 --- a/contracts/exchange-libs/CHANGELOG.json +++ b/contracts/exchange-libs/CHANGELOG.json @@ -10,7 +10,8 @@ "note": "Introduced new export LibMathRevertErrors", "pr": 2321 } - ] + ], + "timestamp": 1574030254 }, { "version": "3.1.0-beta.1", diff --git a/contracts/exchange-libs/CHANGELOG.md b/contracts/exchange-libs/CHANGELOG.md index a2b102e093..ab6d1bc03d 100644 --- a/contracts/exchange-libs/CHANGELOG.md +++ b/contracts/exchange-libs/CHANGELOG.md @@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.1.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + * Introduced new export LibMathRevertErrors (#2321) + ## v3.1.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/contracts/exchange/CHANGELOG.json b/contracts/exchange/CHANGELOG.json index 414be2dc11..e42c694cda 100644 --- a/contracts/exchange/CHANGELOG.json +++ b/contracts/exchange/CHANGELOG.json @@ -14,7 +14,8 @@ "note": "Round up in `marketBuyOrdersNoThrow()` so `marketBuyOrdersFillOrKill()` doesn't throw up.", "pr": 2338 } - ] + ], + "timestamp": 1574030254 }, { "version": "2.2.0-beta.1", diff --git a/contracts/exchange/CHANGELOG.md b/contracts/exchange/CHANGELOG.md index 0550528b3d..c184d6379f 100644 --- a/contracts/exchange/CHANGELOG.md +++ b/contracts/exchange/CHANGELOG.md @@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.2.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + * Introduced new export ExchangeRevertErrors (#2321) + * Round up in `marketBuyOrdersNoThrow()` so `marketBuyOrdersFillOrKill()` doesn't throw up. (#2338) + ## v2.2.0-beta.1 - _November 7, 2019_ * LocalBalanceStore.create and constructor now require an instance of DevUtilsContract (#2304) diff --git a/contracts/extensions/CHANGELOG.json b/contracts/extensions/CHANGELOG.json index 367e7892bf..d499117017 100644 --- a/contracts/extensions/CHANGELOG.json +++ b/contracts/extensions/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils", "pr": 2330 } - ] + ], + "timestamp": 1574030254 }, { "version": "4.1.0-beta.1", diff --git a/contracts/extensions/CHANGELOG.md b/contracts/extensions/CHANGELOG.md index 1607589c2f..31157ae3c3 100644 --- a/contracts/extensions/CHANGELOG.md +++ b/contracts/extensions/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v4.1.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + ## v4.1.0-beta.1 - _November 7, 2019_ * Replaced the use of `SafeMath` with `LibSafeMath` (#2254) diff --git a/contracts/integrations/CHANGELOG.json b/contracts/integrations/CHANGELOG.json index 3e0dc5ed61..d57c3866a7 100644 --- a/contracts/integrations/CHANGELOG.json +++ b/contracts/integrations/CHANGELOG.json @@ -1,4 +1,13 @@ [ + { + "timestamp": 1574030254, + "version": "1.0.2", + "changes": [ + { + "note": "Dependencies updated" + } + ] + }, { "timestamp": 1573159180, "version": "1.0.1", diff --git a/contracts/integrations/CHANGELOG.md b/contracts/integrations/CHANGELOG.md index 6165c4267c..acd0e67e6b 100644 --- a/contracts/integrations/CHANGELOG.md +++ b/contracts/integrations/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v1.0.2 - _November 17, 2019_ + + * Dependencies updated + ## v1.0.1 - _November 7, 2019_ * Dependencies updated diff --git a/contracts/multisig/CHANGELOG.json b/contracts/multisig/CHANGELOG.json index 43e3f9273a..d4da0bdee8 100644 --- a/contracts/multisig/CHANGELOG.json +++ b/contracts/multisig/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils", "pr": 2330 } - ] + ], + "timestamp": 1574030254 }, { "version": "3.2.0-beta.1", diff --git a/contracts/multisig/CHANGELOG.md b/contracts/multisig/CHANGELOG.md index dc882a7623..90226b7398 100644 --- a/contracts/multisig/CHANGELOG.md +++ b/contracts/multisig/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.2.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + ## v3.2.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/contracts/staking/CHANGELOG.json b/contracts/staking/CHANGELOG.json index 3b82b83675..b5d0629ec0 100644 --- a/contracts/staking/CHANGELOG.json +++ b/contracts/staking/CHANGELOG.json @@ -10,7 +10,8 @@ "note": "Introduce new exports FixedMathRevertErrors and StakingRevertErrors", "pr": 2321 } - ] + ], + "timestamp": 1574030254 }, { "version": "1.1.0-beta.1", diff --git a/contracts/staking/CHANGELOG.md b/contracts/staking/CHANGELOG.md index b93586f7c0..5654a6bbfb 100644 --- a/contracts/staking/CHANGELOG.md +++ b/contracts/staking/CHANGELOG.md @@ -5,8 +5,17 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v1.1.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + * Introduce new exports FixedMathRevertErrors and StakingRevertErrors (#2321) + ## v1.1.0-beta.1 - _November 7, 2019_ + * Removed handshake when adding maker to pool. (#2250) + * Removed upper limit on number of makers in a pool. (#2250) + * Removed operator permissions from makers. (#2250) + * Pool Id starts at 1 and increases by 1. (#2250) * Add more overflow safeguards to `LibFixedMath` (#2255) * Refactored finalization state. (#2276) * Removed protocol fee != 0 assertion. (#2278) @@ -35,10 +44,3 @@ CHANGELOG * Introduce multi-block finalization. (#2155) * Removed reference counting for cumulative rewards. (#2188) * Removed explicit dependency on epoch+1 when delegating. (#2188) - -## v1.1.0-beta.1 - _Invalid date_ - - * Removed handshake when adding maker to pool. (#2250) - * Removed upper limit on number of makers in a pool. (#2250) - * Removed operator permissions from makers. (#2250) - * Pool Id starts at 1 and increases by 1. (#2250) diff --git a/contracts/test-utils/CHANGELOG.json b/contracts/test-utils/CHANGELOG.json index 545e3b207e..f71cd9a850 100644 --- a/contracts/test-utils/CHANGELOG.json +++ b/contracts/test-utils/CHANGELOG.json @@ -14,7 +14,8 @@ "note": "Remove TransactionHelper and MutatorContractFunction", "pr": 2325 } - ] + ], + "timestamp": 1574030254 }, { "version": "3.2.0-beta.1", diff --git a/contracts/test-utils/CHANGELOG.md b/contracts/test-utils/CHANGELOG.md index 8c32c22277..ed27e2a9f6 100644 --- a/contracts/test-utils/CHANGELOG.md +++ b/contracts/test-utils/CHANGELOG.md @@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.2.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + * Add new exports orderHashUtils and transactionHashUtils (#2321) + * Remove TransactionHelper and MutatorContractFunction (#2325) + ## v3.2.0-beta.1 - _November 7, 2019_ * OrderFactory default order expiration time increased from ten minutes to fifteen minutes (#2304) diff --git a/contracts/utils/CHANGELOG.json b/contracts/utils/CHANGELOG.json index 5527467c0c..5dd0ed0887 100644 --- a/contracts/utils/CHANGELOG.json +++ b/contracts/utils/CHANGELOG.json @@ -10,7 +10,8 @@ "note": "Introduced new exports AuthorizableRevertErrors, LibAddressArrayRevertErrors, LibBytesRevertErrors, OwnableRevertErrors, ReentrancyGuardRevertErrors and SafeMathRevertErrors", "pr": 2321 } - ] + ], + "timestamp": 1574030254 }, { "version": "3.3.0-beta.1", diff --git a/contracts/utils/CHANGELOG.md b/contracts/utils/CHANGELOG.md index beabb232ed..7e2267eeeb 100644 --- a/contracts/utils/CHANGELOG.md +++ b/contracts/utils/CHANGELOG.md @@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.3.0-beta.2 - _November 17, 2019_ + + * Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils (#2330) + * Introduced new exports AuthorizableRevertErrors, LibAddressArrayRevertErrors, LibBytesRevertErrors, OwnableRevertErrors, ReentrancyGuardRevertErrors and SafeMathRevertErrors (#2321) + ## v3.3.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/0x.js/CHANGELOG.json b/packages/0x.js/CHANGELOG.json index c354319342..ec763a3fbe 100644 --- a/packages/0x.js/CHANGELOG.json +++ b/packages/0x.js/CHANGELOG.json @@ -26,7 +26,8 @@ "note": "Update BigNumber version to ~9.0.0", "pr": 2342 } - ] + ], + "timestamp": 1574030254 }, { "version": "8.0.0-beta.0", diff --git a/packages/0x.js/CHANGELOG.md b/packages/0x.js/CHANGELOG.md index 7e1d2e1d2f..4cb382a554 100644 --- a/packages/0x.js/CHANGELOG.md +++ b/packages/0x.js/CHANGELOG.md @@ -5,6 +5,15 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v8.0.0-beta.1 - _November 17, 2019_ + + * Remove ZRXToken contract wrapper (#2324) + * ContractWrappers no longer exposes `erc20Proxy`, `erc721Proxy` and `dutchAuction` wrappers (#2324) + * [Breaking] Big refactor of contract wrapper interface. See https://github.com/0xProject/0x-monorepo/pull/2325 for details (#2325) + * Remove IWallet and IValidator contract wrappers (#2337) + * Remove exports orderHashUtils and transactionHashUtils (#2321) + * Update BigNumber version to ~9.0.0 (#2342) + ## v8.0.0-beta.0 - _November 7, 2019_ * Exported intefaces changed: from getContractAddressesForNetworkOrThrow to getContractAddressesForChainOrThrow, from NetworkId to ChainId, from ContractNetworks to ContractChains, and from ContractNetworkData to ContractChainData. (#2313) diff --git a/packages/0x.js/docs/reference.mdx b/packages/0x.js/docs/reference.mdx index b4b9045d4f..a0abb2672e 100644 --- a/packages/0x.js/docs/reference.mdx +++ b/packages/0x.js/docs/reference.mdx @@ -1,15 +1,17 @@ -# Class: DevUtilsContract + + +# Class: ERC20TokenContract ## Constructors -\+ **new DevUtilsContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DevUtilsContract](#class-devutilscontract)* +\+ **new ERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC20TokenContract](#class-erc20tokencontract)* *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4076](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4076)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:951](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L951)* **Parameters:** @@ -19,9 +21,9 @@ Name | Type | Default | `supportedProvider` | [SupportedProvider](#supportedprovider) | - | `txDefaults?` | `Partial` | - | `logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | DevUtilsContract.deployedBytecode | +`deployedBytecode` | string \| undefined | ERC20TokenContract.deployedBytecode | -**Returns:** *[DevUtilsContract](#class-devutilscontract)* +**Returns:** *[ERC20TokenContract](#class-erc20tokencontract)* ## Properties @@ -31,7 +33,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:32 ___ @@ -41,7 +43,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -51,7 +53,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:29 ___ @@ -61,7 +63,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -71,2384 +73,2176 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:30 ## Methods -### `Static` ABI +### allowance -▸ **ABI**(): *[ContractAbi](#contractabi)* +▸ **allowance**(`_owner`: string, `_spender`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2719](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2719)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:828](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L828)* -**Returns:** *[ContractAbi](#contractabi)* +**Parameters:** -The contract ABI +Name | Type | +------ | ------ | +`_owner` | string | +`_spender` | string | + +**Returns:** *`ContractFunctionObj`* ___ -### `Static` deployAsync +### approve -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* +▸ **approve**(`_spender`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:347](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L347)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2672](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2672)* +`msg.sender` approves `_spender` to spend `_value` tokens **Parameters:** -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | +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:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* + +Always true if the call has enough gas to complete execution ___ -### `Static` deployFrom0xArtifactAsync +### balanceOf -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* +▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:653](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L653)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2639](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2639)* +Query the balance of owner **Parameters:** -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | The address from which the balance will be retrieved | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* + +Balance of owner ___ -### `Static` strictArgumentEncodingCheck +### getABIDecodedReturnData -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:327](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L327)* +**Type parameters:** -Defined in base-contract/lib/src/index.d.ts:41 +▪ **T** **Parameters:** Name | Type | ------ | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* +`methodName` | string | +`callData` | string | -## Object literals - -### decodeAssetProxyDispatchError - -#### ▪ **decodeAssetProxyDispatchError**: *object* +**Returns:** *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L45)* +___ -Decompose an ABI-encoded AssetProxyDispatchError. +### getABIDecodedTransactionData -#### callAsync +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:320](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L320)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L53)* +**Type parameters:** -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. +▪ **T** **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[number, string, string]>`* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -errorCode The error code.orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched. +**Returns:** *`T`* ___ -### decodeAssetProxyExistsError +### getFunctionSignature -#### ▪ **decodeAssetProxyExistsError**: *object* +▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L90)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:314](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L314)* -Decompose an ABI-encoded AssetProxyExistsError. +**Parameters:** -#### callAsync +Name | Type | +------ | ------ | +`methodName` | string | -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* +**Returns:** *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L98)* +___ -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. +### getLogsAsync -**Parameters:** +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:935](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L935)* -**Returns:** *`Promise<[string, string]>`* +Gets historical logs without creating a subscription -assetProxyId Id of asset proxy.assetProxyAddress The address of the asset proxy. +**Type parameters:** -___ +▪ **ArgsType**: *[ERC20TokenEventArgs](#erc20tokeneventargs)* -### decodeAssetProxyId +**Parameters:** -#### ▪ **decodeAssetProxyId**: *object* +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}` | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L135)* +**Returns:** *`Promise>>`* -Decode AssetProxy identifier +Array of logs that match the parameters -#### callAsync +___ -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### getSelector -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:144](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L144)* +▸ **getSelector**(`methodName`: string): *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:334](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L334)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-20, ERC- 721, ERC1155, or MultiAsset asset. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`methodName` | string | -The AssetProxy identifier +**Returns:** *string* ___ -### decodeAssetProxyTransferError - -#### ▪ **decodeAssetProxyTransferError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:181](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L181)* +### subscribe -Decompose an ABI-encoded AssetProxyTransferError. +▸ **subscribe**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:893](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L893)* -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string]>`* +Subscribe to an event type emitted by the ERC20Token contract. -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:189](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L189)* +**Type parameters:** -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. +▪ **ArgsType**: *[ERC20TokenEventArgs](#erc20tokeneventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +`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:** *`Promise<[string, string, string]>`* +**Returns:** *string* -orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched.errorData ABI-encoded revert data from the asset proxy. +Subscription token used later to unsubscribe ___ -### decodeEIP1271SignatureError - -#### ▪ **decodeEIP1271SignatureError**: *object* +### totalSupply -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:226](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L226)* +▸ **totalSupply**(): *`ContractFunctionObj`* -Decompose an ABI-encoded SignatureValidatorError. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:470](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L470)* -#### callAsync +Query total supply of token -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* +**Returns:** *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:234](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L234)* +Total supply of token -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:** +### transfer -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +▸ **transfer**(`_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -**Returns:** *`Promise<[string, string, string, string]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L709)* -signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. +send `value` token to `to` from `msg.sender` -___ +**Parameters:** -### decodeERC1155AssetData +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | -#### ▪ **decodeERC1155AssetData**: *object* +**Returns:** *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:271](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L271)* +True if transfer was successful -Decode ERC-1155 asset data from the format described in the AssetProxy contract specification. +___ -#### callAsync +### transferFrom -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber[], BigNumber[], string]>`* +▸ **transferFrom**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:280](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L280)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:524](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L524)* -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. +send `value` token to `to` from `from` on the condition it is approved by `from` **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-1155 set of assets. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +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:** *`Promise<[string, string, BigNumber[], BigNumber[], string]>`* +**Returns:** *`ContractTxFunctionObj`* -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`. +True if transfer was successful ___ -### decodeERC20AssetData - -#### ▪ **decodeERC20AssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:319](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L319)* - -Decode ERC-20 asset data from the format described in the AssetProxy contract specification. - -#### callAsync +### unsubscribe -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* +▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:327](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L327)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:918](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L918)* -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. +Cancel a subscription **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]>`* +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | -The AssetProxy identifier, and the address of the ERC-20 contract hosting this asset. +**Returns:** *void* ___ -### decodeERC721AssetData - -#### ▪ **decodeERC721AssetData**: *object* +### unsubscribeAll -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:364](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L364)* +▸ **unsubscribeAll**(): *void* -Decode ERC-721 asset data from the format described in the AssetProxy contract specification. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:924](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L924)* -#### callAsync +Cancels all existing subscriptions -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber]>`* +**Returns:** *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:373](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L373)* +___ -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. +### `Static` ABI -**Parameters:** +▸ **ABI**(): *[ContractAbi](#contractabi)* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-721 asset. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L133)* -**Returns:** *`Promise<[string, string, BigNumber]>`* +**Returns:** *[ContractAbi](#contractabi)* -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. +The contract ABI ___ -### decodeExchangeInvalidContextError +### `Static` deployAsync -#### ▪ **decodeExchangeInvalidContextError**: *object* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:410](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L410)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L91)* -Decompose an ABI-encoded OrderStatusError. +**Parameters:** -#### callAsync +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string]>`* +**Returns:** *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:418](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L418)* +___ -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. +### `Static` deployFrom0xArtifactAsync -**Parameters:** +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L66)* -**Returns:** *`Promise<[number, string, string]>`* +**Parameters:** -errorCode Error code that corresponds to invalid maker, taker, or sender.orderHash The order hash.contextAddress The maker, taker, or sender address +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | + +**Returns:** *`Promise`* ___ -### decodeFillError +### `Static` strictArgumentEncodingCheck -#### ▪ **decodeFillError**: *object* +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:455](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L455)* -Decompose an ABI-encoded FillError. -#### callAsync +Defined in base-contract/lib/src/index.d.ts:42 -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string]>`* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:463](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L463)* +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -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. +**Returns:** *string* -**Parameters:** +
-Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +# Class: ERC721TokenContract -**Returns:** *`Promise<[number, string]>`* -errorCode The error code.orderHash The order hash. +## Constructors -___ -### decodeIncompleteFillError -#### ▪ **decodeIncompleteFillError**: *object* +\+ **new ERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC721TokenContract](#class-erc721tokencontract)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:500](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L500)* +*Overrides void* -Decompose an ABI-encoded IncompleteFillError. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1376](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1376)* -#### callAsync +**Parameters:** -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, BigNumber, BigNumber]>`* +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC721TokenContract.deployedBytecode | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:508](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L508)* +**Returns:** *[ERC721TokenContract](#class-erc721tokencontract)* -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. +## Properties -**Parameters:** +### `Optional` _deployedBytecodeIfExists -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +• **_deployedBytecodeIfExists**? : *`Buffer`* -**Returns:** *`Promise<[number, BigNumber, BigNumber]>`* -orderHash Hash of the order being filled. -___ +Defined in base-contract/lib/src/index.d.ts:32 -### decodeMultiAssetData +___ -#### ▪ **decodeMultiAssetData**: *object* +### abi -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:545](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L545)* +• **abi**: *[ContractAbi](#contractabi)* -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 base-contract/lib/src/index.d.ts:28 -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:553](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.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. +### address -**Parameters:** +• **address**: *string* -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. +Defined in base-contract/lib/src/index.d.ts:29 ___ -### decodeNegativeSpreadError +Args -#### ▪ **decodeNegativeSpreadError**: *object* +• **constructorArgs**: *any[]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:590](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L590)* -Decompose an ABI-encoded NegativeSpreadError. -#### callAsync +Defined in base-contract/lib/src/index.d.ts:31 -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:598](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L598)* +### contractName -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. +• **contractName**: *string* -**Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise<[string, string]>`* +Defined in base-contract/lib/src/index.d.ts:30 -leftOrderHash Hash of the left order being matched.rightOrderHash Hash of the right order being matched. +## Methods -___ +### approve -### decodeOrderEpochError +▸ **approve**(`_approved`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -#### ▪ **decodeOrderEpochError**: *object* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:438](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L438)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:635](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L635)* +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. -Decompose an ABI-encoded OrderEpochError. +**Parameters:** -#### callAsync +Name | Type | Description | +------ | ------ | ------ | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber]>`* +**Returns:** *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:643](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L643)* +___ -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. +### balanceOf -**Parameters:** +▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj`* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:563](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L563)* -**Returns:** *`Promise<[string, string, BigNumber]>`* +NFTs assigned to the zero address are considered invalid, and this +function throws for queries about the zero address. -makerAddress The order maker.orderSenderAddress The order sender.currentEpoch The current epoch for the maker. +**Parameters:** -___ +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | An address for whom to query the balance | -### decodeOrderStatusError +**Returns:** *`ContractFunctionObj`* -#### ▪ **decodeOrderStatusError**: *object* +The number of NFTs owned by `_owner`, possibly zero -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:680](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L680)* +___ -Decompose an ABI-encoded OrderStatusError. +### getABIDecodedReturnData -#### callAsync +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, number]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L417)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:688](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L688)* +**Type parameters:** -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. +▪ **T** **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, number]>`* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -orderHash The order hash.orderStatus The order status. +**Returns:** *`T`* ___ -### decodeSignatureError +### getABIDecodedTransactionData -#### ▪ **decodeSignatureError**: *object* +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:725](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L725)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:410](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L410)* -Decompose an ABI-encoded SignatureError. +**Type parameters:** -#### callAsync +▪ **T** -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string, string]>`* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:733](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L733)* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -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. +**Returns:** *`T`* -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +### getApproved -**Returns:** *`Promise<[number, string, string, string]>`* +▸ **getApproved**(`_tokenId`: `BigNumber`): *`ContractFunctionObj`* -errorCode The error code.signerAddress The expected signer of the hash.signature The full signature. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L618)* -___ +Throws if `_tokenId` is not a valid NFT. -### decodeSignatureValidatorNotApprovedError +**Parameters:** -#### ▪ **decodeSignatureValidatorNotApprovedError**: *object* +Name | Type | Description | +------ | ------ | ------ | +`_tokenId` | `BigNumber` | The NFT to find the approved address for | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:770](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L770)* +**Returns:** *`ContractFunctionObj`* -Decompose an ABI-encoded SignatureValidatorNotApprovedError. +The approved address for this NFT, or the zero address if there is none -#### callAsync +___ -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* +### getFunctionSignature -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:778](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L778)* +▸ **getFunctionSignature**(`methodName`: string): *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:404](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L404)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[string, string]>`* +Name | Type | +------ | ------ | +`methodName` | string | -signerAddress The expected signer of the hash.validatorAddress The expected validator. +**Returns:** *string* ___ -### decodeSignatureWalletError - -#### ▪ **decodeSignatureWalletError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:817](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L817)* +### getLogsAsync -Decompose an ABI-encoded SignatureWalletError. +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1360](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1360)* -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* +Gets historical logs without creating a subscription -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:825](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L825)* +**Type parameters:** -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. +▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +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<[string, string, string, string]>`* +**Returns:** *`Promise>>`* -errorCode The error code.signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. +Array of logs that match the parameters ___ -### decodeStaticCallAssetData - -#### ▪ **decodeStaticCallAssetData**: *object* +### getSelector -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:862](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L862)* +▸ **getSelector**(`methodName`: string): *string* -Decode StaticCall asset data from the format described in the AssetProxy contract specification. - -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:424](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L424)* -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:871](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L871)* +**Parameters:** -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. +Name | Type | +------ | ------ | +`methodName` | string | -**Parameters:** +**Returns:** *string* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing a StaticCall asset | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +___ -**Returns:** *`Promise<[string, string, string, string]>`* +### isApprovedForAll -The StaticCall AssetProxy identifier, the target address of the StaticCAll, the data to be passed to the target address, and the expected Keccak-256 hash of the static call return data. +▸ **isApprovedForAll**(`_owner`: string, `_operator`: string): *`ContractFunctionObj`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:666](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L666)* -### decodeTransactionError +**Parameters:** -#### ▪ **decodeTransactionError**: *object* +Name | Type | +------ | ------ | +`_owner` | string | +`_operator` | string | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:908](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L908)* +**Returns:** *`ContractFunctionObj`* -Decompose an ABI-encoded TransactionError. +___ -#### callAsync +### ownerOf -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string]>`* +▸ **ownerOf**(`_tokenId`: `BigNumber`): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:916](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L916)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:727](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L727)* -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. +NFTs assigned to zero address are considered invalid, and queries +about them do throw. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`_tokenId` | `BigNumber` | The identifier for an NFT | -**Returns:** *`Promise<[number, string]>`* +**Returns:** *`ContractFunctionObj`* -errorCode The error code.transactionHash Hash of the transaction. +The address of the owner of the NFT ___ -### decodeTransactionExecutionError - -#### ▪ **decodeTransactionExecutionError**: *object* +### safeTransferFrom1 -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:953](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L953)* +▸ **safeTransferFrom1**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -Decompose an ABI-encoded TransactionExecutionError. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:782](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L782)* -#### callAsync +This works identically to the other function with an extra data parameter, +except this function just sets data to "". -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:961](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L961)* +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | -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. +**Returns:** *`ContractTxFunctionObj`* -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +### safeTransferFrom2 -**Returns:** *`Promise<[string, string]>`* +▸ **safeTransferFrom2**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *`ContractTxFunctionObj`* -transactionHash Hash of the transaction.errorData Error thrown by exeucteTransaction(). +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:918](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L918)* -___ +Throws unless `msg.sender` is the current owner, an authorized +operator, or the approved address for this NFT. Throws if `_from` is +not the current owner. Throws if `_to` is the zero address. Throws if +`_tokenId` is not a valid NFT. When transfer is complete, this function +checks if `_to` is a smart contract (code size > 0). If so, it calls +`onERC721Received` on `_to` and throws if the return value is not +`bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`. -### decodeZeroExTransactionData +**Parameters:** -#### ▪ **decodeZeroExTransactionData**: *object* +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` | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:998](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L998)* +**Returns:** *`ContractTxFunctionObj`* -Decodes the call data for an Exchange contract method call. +___ -#### callAsync +### setApprovalForAll -▸ **callAsync**(`transactionData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, Array, BigNumber[], string[]]>`* +▸ **setApprovalForAll**(`_operator`: string, `_approved`: boolean): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1007](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1007)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1056](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1056)* -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. +Emits the ApprovalForAll event. The contract MUST allow +multiple operators per owner. **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[]]>`* +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 | -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. +**Returns:** *`ContractTxFunctionObj`* ___ -### encodeERC1155AssetData - -#### ▪ **encodeERC1155AssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1088](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1088)* +### subscribe -Encode ERC-1155 asset data into the format described in the AssetProxy contract specification. +▸ **subscribe**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1318](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1318)* -▸ **callAsync**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +Subscribe to an event type emitted by the ERC721Token contract. -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1101](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1101)* +**Type parameters:** -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. +▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)* **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) | - | - | +`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:** *`Promise`* +**Returns:** *string* -AssetProxy-compliant asset data describing the set of assets. +Subscription token used later to unsubscribe ___ -### encodeERC20AssetData +### transferFrom -#### ▪ **encodeERC20AssetData**: *object* +▸ **transferFrom**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1147](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1147)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1184](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1184)* -Encode ERC-20 asset data into the format described in the AssetProxy contract specification. +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. -#### callAsync +**Parameters:** -▸ **callAsync**(`tokenAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1156](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1156)* +**Returns:** *`ContractTxFunctionObj`* -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:** +### unsubscribe -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`tokenAddress` | string | - | The address of the ERC-20 contract hosting the asset to be traded. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +▸ **unsubscribe**(`subscriptionToken`: string): *void* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1343)* -AssetProxy-compliant data describing the asset. +Cancel a subscription -___ +**Parameters:** -### encodeERC721AssetData +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | -#### ▪ **encodeERC721AssetData**: *object* +**Returns:** *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1195](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1195)* +___ -Encode ERC-721 asset data into the format described in the AssetProxy specification. +### unsubscribeAll -#### callAsync +▸ **unsubscribeAll**(): *void* -▸ **callAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1349](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1349)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1205](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1205)* +Cancels all existing subscriptions -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. +**Returns:** *void* -**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) | - | - | +### `Static` ABI -**Returns:** *`Promise`* +▸ **ABI**(): *[ContractAbi](#contractabi)* -AssetProxy-compliant asset data describing the asset. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:143](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L143)* -___ +**Returns:** *[ContractAbi](#contractabi)* -### encodeMultiAssetData +The contract ABI -#### ▪ **encodeMultiAssetData**: *object* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1247](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1247)* +### `Static` deployAsync -Encode data for multiple assets, per the AssetProxy contract specification. +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:101](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L101)* -▸ **callAsync**(`amounts`: `BigNumber`[], `nestedAssetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1257](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1257)* +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -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. +**Returns:** *`Promise`* -**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) | - | - | +### `Static` deployFrom0xArtifactAsync -**Returns:** *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -AssetProxy-compliant data describing the set of assets. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:76](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L76)* -___ +**Parameters:** -### encodeStaticCallAssetData +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -#### ▪ **encodeStaticCallAssetData**: *object* +**Returns:** *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1299](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1299)* +___ -Encode StaticCall asset data into the format described in the AssetProxy contract specification. +### `Static` strictArgumentEncodingCheck -#### callAsync +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -▸ **callAsync**(`staticCallTargetAddress`: string, `staticCallData`: string, `expectedReturnDataHash`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1311](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1311)* -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. +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`staticCallTargetAddress` | string | - | Target address of StaticCall. | -`staticCallData` | string | - | Data that will be passed to staticCallTargetAddress in the StaticCall. | -`expectedReturnDataHash` | string | - | Expected Keccak-256 hash of the StaticCall return data. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -AssetProxy-compliant asset data describing the set of assets. +**Returns:** *string* -___ +
-### getAssetProxyAllowance +# Class: ExchangeContract -#### ▪ **getAssetProxyAllowance**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1356](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1356)* +## Constructors -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`* +\+ **new ExchangeContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ExchangeContract](#class-exchangecontract)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1366](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1366)* +*Overrides void* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8066](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8066)* **Parameters:** -Name | Type | Default | 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. +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ExchangeContract.deployedBytecode | -___ +**Returns:** *[ExchangeContract](#class-exchangecontract)* -### getBalance +## Properties -#### ▪ **getBalance**: *object* +### `Optional` _deployedBytecodeIfExists -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1416)* +• **_deployedBytecodeIfExists**? : *`Buffer`* -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 base-contract/lib/src/index.d.ts:32 -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1426](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1426)* +___ -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. +### abi -**Parameters:** +• **abi**: *[ContractAbi](#contractabi)* -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. +Defined in base-contract/lib/src/index.d.ts:28 ___ -### getBalanceAndAssetProxyAllowance - -#### ▪ **getBalanceAndAssetProxyAllowance**: *object* +### address -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1476](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1476)* +• **address**: *string* -Calls getBalance() and getAllowance() for assetData. -#### callAsync -▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber]>`* +Defined in base-contract/lib/src/index.d.ts:29 -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1486](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1486)* +___ -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. +Args -**Parameters:** +• **constructorArgs**: *any[]* -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. +Defined in base-contract/lib/src/index.d.ts:31 ___ -### getBatchAssetProxyAllowances - -#### ▪ **getBatchAssetProxyAllowances**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1536](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1536)* +### contractName -Calls getAssetProxyAllowance() for each element of assetData. +• **contractName**: *string* -#### callAsync -▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1546](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1546)* +Defined in base-contract/lib/src/index.d.ts:30 -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. +## Methods -**Parameters:** +### EIP1271_MAGIC_VALUE -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) | - | - | +▸ **EIP1271_MAGIC_VALUE**(): *`ContractFunctionObj`* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3106)* -An array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. +**Returns:** *`ContractFunctionObj`* ___ -### getBatchBalances +### EIP712_EXCHANGE_DOMAIN_HASH -#### ▪ **getBatchBalances**: *object* +▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1596](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1596)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3153)* -Calls getBalance() for each element of assetData. +**Returns:** *`ContractFunctionObj`* -#### callAsync +___ -▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### allowedValidators -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1606](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1606)* +▸ **allowedValidators**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3200](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3200)* **Parameters:** -Name | Type | 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`* +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | -Array of asset balances from getBalance(), with each element corresponding to the same-indexed element in the assetData input. +**Returns:** *`ContractFunctionObj`* ___ -### getBatchBalancesAndAssetProxyAllowances +### batchCancelOrders -#### ▪ **getBatchBalancesAndAssetProxyAllowances**: *object* +▸ **batchCancelOrders**(`orders`: `Array`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1656](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1656)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3259](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3259)* -Calls getBatchBalances() and getBatchAllowances() for each element of assetData. +Executes multiple calls of cancelOrder. -#### callAsync +**Parameters:** -▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber[], BigNumber[]]>`* +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1666](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1666)* +**Returns:** *`ContractTxFunctionObj`* -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:** +### batchExecuteTransactions -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) | - | - | +▸ **batchExecuteTransactions**(`transactions`: `Array`, `signatures`: string[]): *`ContractTxFunctionObj`* -**Returns:** *`Promise<[BigNumber[], BigNumber[]]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3403](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3403)* -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. +Executes a batch of Exchange method calls in the context of signer(s). -___ +**Parameters:** -### getEthBalances +Name | Type | Description | +------ | ------ | ------ | +`transactions` | `Array` | Array of 0x transaction structures. | +`signatures` | string[] | Array of proofs that transactions have been signed by signer(s). | -#### ▪ **getEthBalances**: *object* +**Returns:** *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1716](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1716)* +Array containing ABI encoded return data for each of the underlying Exchange function calls. -Batch fetches ETH balances +___ -#### callAsync +### batchFillOrKillOrders -▸ **callAsync**(`addresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **batchFillOrKillOrders**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1724](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1724)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3541](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3541)* -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. +Executes multiple calls of fillOrKillOrder. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`addresses` | string[] | - | Array of addresses. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +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:** *`Promise`* +**Returns:** *`ContractTxFunctionObj>`* -Array of ETH balances. +Array of amounts filled and fees paid by makers and taker. ___ -### getOrderRelevantState - -#### ▪ **getOrderRelevantState**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1769](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1769)* - -Fetches all order-relevant information needed to validate if the supplied order is fillable. - -#### callAsync +### batchFillOrders -▸ **callAsync**(`order`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, BigNumber, boolean]>`* +▸ **batchFillOrders**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1780](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1780)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3717](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3717)* -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. +Executes multiple calls of fillOrder. **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) | - | - | +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:** *`Promise<[object, BigNumber, boolean]>`* +**Returns:** *`ContractTxFunctionObj>`* -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. +Array of amounts filled and fees paid by makers and taker. ___ -### getOrderRelevantStates - -#### ▪ **getOrderRelevantStates**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1850](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1850)* - -Fetches all order-relevant information needed to validate if the supplied orders are fillable. - -#### callAsync +### batchFillOrdersNoThrow -▸ **callAsync**(`orders`: `Array`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[Array, BigNumber[], boolean[]]>`* +▸ **batchFillOrdersNoThrow**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1861](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1861)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3893](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3893)* -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. +Executes multiple calls of fillOrder. If any fill reverts, the error is caught and ignored. **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) | - | - | +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:** *`Promise<[Array, BigNumber[], boolean[]]>`* +**Returns:** *`ContractTxFunctionObj>`* -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. +Array of amounts filled and fees paid by makers and taker. ___ -### getSimulatedOrderTransferResults - -#### ▪ **getSimulatedOrderTransferResults**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1940](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1940)* - -Simulates all of the transfers within an order and returns the index of the first failed transfer. - -#### awaitTransactionSuccessAsync +### batchMatchOrders -▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +▸ **batchMatchOrders**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2015](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2015)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4073](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4073)* -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. +Match complementary orders that have a profitable spread. +Each order is filled at their respective price point, and +the matcher receives a profit denominated in the left maker asset. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | The order to simulate transfers for. | -`takerAddress` | string | - | The address of the taker that will fill the order. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of takerAsset that the taker wished to fill. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +Name | Type | Description | +------ | ------ | ------ | +`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | +`rightOrders` | `Array` | Set of orders to match against `leftOrders` | +`leftSignatures` | string[] | Proof that left orders were created by the left makers. | +`rightSignatures` | string[] | Proof that right orders were created by the right makers. | -**Returns:** *`PromiseWithTransactionHash`* +**Returns:** *`ContractTxFunctionObj`* + +batchMatchedFillResults Amounts filled and profit generated. -A promise that resolves when the transaction is successful +___ -#### callAsync +### batchMatchOrdersWithMaximalFill -▸ **callAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **batchMatchOrdersWithMaximalFill**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2121](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2121)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4298](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4298)* -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. +Match complementary orders that have a profitable spread. +Each order is maximally filled at their respective price point, and +the matcher receives a profit denominated in either the left maker asset, +right maker asset, or a combination of both. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | The order to simulate transfers for. | -`takerAddress` | string | - | The address of the taker that will fill the order. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of takerAsset that the taker wished to fill. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | +`rightOrders` | `Array` | Set of orders to match against `leftOrders` | +`leftSignatures` | string[] | Proof that left orders were created by the left makers. | +`rightSignatures` | string[] | Proof that right orders were created by the right makers. | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* -The index of the first failed transfer (or 4 if all transfers are successful). +batchMatchedFillResults Amounts filled and profit generated. + +___ -#### estimateGasAsync +### cancelOrder -▸ **estimateGasAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +▸ **cancelOrder**(`order`: object): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2068](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2068)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4514](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4514)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +After calling, the order can not be filled anymore. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`order` | object | The order to simulate transfers for. | -`takerAddress` | string | The address of the taker that will fill the order. | -`takerAssetFillAmount` | `BigNumber` | The amount of takerAsset that the taker wished to fill. | -`txData?` | `Partial` \| undefined | Additional data for transaction | +`order` | object | Order struct containing order specifications. | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* -The hash of the transaction +___ -#### getABIEncodedTransactionData +### cancelOrdersUpTo -▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *string* +▸ **cancelOrdersUpTo**(`targetOrderEpoch`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2195](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2195)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4654](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4654)* -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). +Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch +and senderAddress equal to msg.sender (or null address if msg.sender == makerAddress). **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`order` | object | The order to simulate transfers for. | -`takerAddress` | string | The address of the taker that will fill the order. | -`takerAssetFillAmount` | `BigNumber` | The amount of takerAsset that the taker wished to fill. | +`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | -**Returns:** *string* +**Returns:** *`ContractTxFunctionObj`* -The ABI encoded transaction data as a string +___ -#### getSelector +### cancelled -▸ **getSelector**(): *string* +▸ **cancelled**(`index_0`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2227](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2227)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4762](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4762)* -Returns the 4 byte function selector as a hex string. +**Parameters:** -**Returns:** *string* +Name | Type | +------ | ------ | +`index_0` | string | -#### sendTransactionAsync +**Returns:** *`ContractFunctionObj`* -▸ **sendTransactionAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1951](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1951)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +___ -**Parameters:** +### currentContextAddress -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | The order to simulate transfers for. | -`takerAddress` | string | - | The address of the taker that will fill the order. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of takerAsset that the taker wished to fill. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +▸ **currentContextAddress**(): *`ContractFunctionObj`* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4810](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4810)* -The hash of the transaction +**Returns:** *`ContractFunctionObj`* ___ -### getSimulatedOrdersTransferResults - -#### ▪ **getSimulatedOrdersTransferResults**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2238](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2238)* - -Simulates all of the transfers for each given order and returns the indices of each first failed transfer. - -#### awaitTransactionSuccessAsync +### executeTransaction -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +▸ **executeTransaction**(`transaction`: object, `signature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2316](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2316)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4863](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4863)* -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. +Executes an Exchange method call in the context of signer. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of orders to individually simulate transfers for. | -`takerAddresses` | string[] | - | Array of addresses of takers that will fill each order. | -`takerAssetFillAmounts` | `BigNumber`[] | - | Array of amounts of takerAsset that will be filled for each order. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction structure. | +`signature` | string | Proof that transaction has been signed by signer. | -**Returns:** *`PromiseWithTransactionHash`* +**Returns:** *`ContractTxFunctionObj`* + +ABI encoded return data of the underlying Exchange function call. -A promise that resolves when the transaction is successful +___ -#### callAsync +### fillOrKillOrder -▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **fillOrKillOrder**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2426](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2426)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4999](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4999)* -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. +Fills the input order. Reverts if exact takerAssetFillAmount not filled. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of orders to individually simulate transfers for. | -`takerAddresses` | string[] | - | Array of addresses of takers that will fill each order. | -`takerAssetFillAmounts` | `BigNumber`[] | - | Array of amounts of takerAsset that will be filled for each order. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +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:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* -The indices of the first failed transfer (or 4 if all transfers are successful) for each order. +___ -#### estimateGasAsync +### fillOrder -▸ **estimateGasAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* +▸ **fillOrder**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2371](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2371)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5168](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5168)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +Fills the input order. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`orders` | `Array` | Array of orders to individually simulate transfers for. | -`takerAddresses` | string[] | Array of addresses of takers that will fill each order. | -`takerAssetFillAmounts` | `BigNumber`[] | Array of amounts of takerAsset that will be filled for each order. | -`txData?` | `Partial` \| undefined | Additional data for transaction | +`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:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* -The hash of the transaction +Amounts filled and fees paid by maker and taker. -#### getABIEncodedTransactionData +___ -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[]): *string* +### filled -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2502](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2502)* +▸ **filled**(`index_0`: string): *`ContractFunctionObj`* -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). +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5330)* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of orders to individually simulate transfers for. | -`takerAddresses` | string[] | Array of addresses of takers that will fill each order. | -`takerAssetFillAmounts` | `BigNumber`[] | Array of amounts of takerAsset that will be filled for each order. | +Name | Type | +------ | ------ | +`index_0` | string | -**Returns:** *string* +**Returns:** *`ContractFunctionObj`* -The ABI encoded transaction data as a string +___ -#### getSelector +### getABIDecodedReturnData -▸ **getSelector**(): *string* +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2535](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2535)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3092](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3092)* -Returns the 4 byte function selector as a hex string. +**Type parameters:** -**Returns:** *string* +▪ **T** -#### sendTransactionAsync +**Parameters:** -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2250](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2250)* +**Returns:** *`T`* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +___ -**Parameters:** +### getABIDecodedTransactionData -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of orders to individually simulate transfers for. | -`takerAddresses` | string[] | - | Array of addresses of takers that will fill each order. | -`takerAssetFillAmounts` | `BigNumber`[] | - | Array of amounts of takerAsset that will be filled for each order. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3085](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3085)* -The hash of the transaction +**Type parameters:** -___ +▪ **T** -### getTransferableAssetAmount +**Parameters:** -#### ▪ **getTransferableAssetAmount**: *object* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2546](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2546)* +**Returns:** *`T`* -Gets the amount of an asset transferable by the owner. +___ -#### callAsync +### getAssetProxy -▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **getAssetProxy**(`assetProxyId`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2556](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2556)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5383](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5383)* -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. +Gets an asset proxy. **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) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`assetProxyId` | string | Id of the asset proxy. | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -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`. +The asset proxy registered to assetProxyId. Returns 0x0 if no proxy is registered. ___ -### revertIfInvalidAssetData +### getFunctionSignature -#### ▪ **revertIfInvalidAssetData**: *object* +▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2603](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2603)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3079](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3079)* -#### callAsync +**Parameters:** -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +Name | Type | +------ | ------ | +`methodName` | string | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2609](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2609)* +**Returns:** *string* -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:** +### getLogsAsync -Name | Type | Default | ------- | ------ | ------ | -`assetData` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8050](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8050)* -
+Gets historical logs without creating a subscription -# Class: ERC20TokenContract +**Type parameters:** +▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)* -## Constructors +**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>>`* -\+ **new ERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC20TokenContract](#class-erc20tokencontract)* +Array of logs that match the parameters -*Overrides void* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1113](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1113)* +### getOrderInfo + +▸ **getOrderInfo**(`order`: object): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5436)* + +Gets information about an order: status, hash, and amount filled. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ERC20TokenContract.deployedBytecode | +`order` | object | Order to gather information on. | -**Returns:** *[ERC20TokenContract](#class-erc20tokencontract)* +**Returns:** *`ContractFunctionObj`* -## Properties +OrderInfo Information about the order and its state. See LibOrder.OrderInfo for a complete description. + +___ -#### `Optional` _deployedBytecodeIfExists +### getSelector -• **_deployedBytecodeIfExists**? : *`Buffer`* +▸ **getSelector**(`methodName`: string): *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3099](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3099)* +**Parameters:** -Defined in base-contract/lib/src/index.d.ts:31 +Name | Type | +------ | ------ | +`methodName` | string | + +**Returns:** *string* ___ -### abi +### isValidHashSignature -• **abi**: *[ContractAbi](#contractabi)* +▸ **isValidHashSignature**(`hash`: string, `signerAddress`: string, `signature`: string): *`ContractFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5520](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5520)* +Verifies that a hash has been signed by the given signer. -Defined in base-contract/lib/src/index.d.ts:27 +**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. | -### address +**Returns:** *`ContractFunctionObj`* -• **address**: *string* +isValid `true` if the signature is valid for the given hash and signer. +___ +### isValidOrderSignature -Defined in base-contract/lib/src/index.d.ts:28 +▸ **isValidOrderSignature**(`order`: object, `signature`: string): *`ContractFunctionObj`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5583](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5583)* -Args +Verifies that a signature for an order is valid. -• **constructorArgs**: *any[]* +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The order. | +`signature` | string | Proof that the order has been signed by signer. | +**Returns:** *`ContractFunctionObj`* -Defined in base-contract/lib/src/index.d.ts:30 +isValid `true` if the signature is valid for the given order and signer. ___ -### contractName +### isValidTransactionSignature -• **contractName**: *string* +▸ **isValidTransactionSignature**(`transaction`: object, `signature`: string): *`ContractFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5664](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5664)* +Verifies that a signature for a transaction is valid. -Defined in base-contract/lib/src/index.d.ts:29 +**Parameters:** -## Methods +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | The transaction. | +`signature` | string | Proof that the order has been signed by signer. | -### getLogsAsync +**Returns:** *`ContractFunctionObj`* -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* +isValid `true` if the signature is valid for the given transaction and signer. -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1097](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1097)* +___ -Gets historical logs without creating a subscription +### marketBuyOrdersFillOrKill -**Type parameters:** +▸ **marketBuyOrdersFillOrKill**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* -▪ **ArgsType**: *[ERC20TokenEventArgs](#erc20tokeneventargs)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5738](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5738)* + +Calls marketBuyOrdersNoThrow then reverts if < makerAssetFillAmount has been bought. +NOTE: This function does not enforce that the makerAsset is the same for each order. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`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}` | +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Minimum amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | -**Returns:** *`Promise>>`* +**Returns:** *`ContractTxFunctionObj`* -Array of logs that match the parameters +Amounts filled and fees paid by makers and taker. ___ -### 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:1055](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1055)* +### marketBuyOrdersNoThrow -Subscribe to an event type emitted by the ERC20Token contract. +▸ **marketBuyOrdersNoThrow**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* -**Type parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5909](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5909)* -▪ **ArgsType**: *[ERC20TokenEventArgs](#erc20tokeneventargs)* +Executes multiple calls of fillOrder until total amount of makerAsset is bought by taker. +If any fill reverts, the error is caught and ignored. +NOTE: This function does not enforce that the makerAsset is the same for each order. **Parameters:** -Name | Type | 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 | - | - | +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* +**Returns:** *`ContractTxFunctionObj`* -Subscription token used later to unsubscribe +Amounts filled and fees paid by makers and taker. ___ -### unsubscribe +### marketSellOrdersFillOrKill -▸ **unsubscribe**(`subscriptionToken`: string): *void* +▸ **marketSellOrdersFillOrKill**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1080](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1080)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6079](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6079)* -Cancel a subscription +Calls marketSellOrdersNoThrow then reverts if < takerAssetFillAmount has been sold. +NOTE: This function does not enforce that the takerAsset is the same for each order. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Minimum amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | -### unsubscribeAll +**Returns:** *`ContractTxFunctionObj`* -▸ **unsubscribeAll**(): *void* +Amounts filled and fees paid by makers and taker. -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1086](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1086)* +___ -Cancels all existing subscriptions +### marketSellOrdersNoThrow -**Returns:** *void* +▸ **marketSellOrdersNoThrow**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6250](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6250)* -### `Static` ABI +Executes multiple calls of fillOrder until total amount of takerAsset is sold by taker. +If any fill reverts, the error is caught and ignored. +NOTE: This function does not enforce that the takerAsset is the same for each order. -▸ **ABI**(): *[ContractAbi](#contractabi)* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:866](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L866)* +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:** *[ContractAbi](#contractabi)* +**Returns:** *`ContractTxFunctionObj`* -The contract ABI +Amounts filled and fees paid by makers and taker. ___ -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +### matchOrders -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:824](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L824)* +▸ **matchOrders**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *`ContractTxFunctionObj`* -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6423](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6423)* -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | +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). -**Returns:** *`Promise`* +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | + +**Returns:** *`ContractTxFunctionObj`* + +matchedFillResults Amounts filled and fees paid by maker and taker of matched orders. ___ -### `Static` deployFrom0xArtifactAsync +### matchOrdersWithMaximalFill -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **matchOrdersWithMaximalFill**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:799](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L799)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6645](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6645)* -**Parameters:** +Match two complementary orders that have a profitable spread. +Each order is maximally filled at their respective price point, and +the matcher receives a profit denominated in either the left maker asset, +right maker asset, or a combination of both. -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | +**Parameters:** -**Returns:** *`Promise`* +Name | Type | Description | +------ | ------ | ------ | +`leftOrder` | object | First order to match. | +`rightOrder` | object | Second order to match. | +`leftSignature` | string | Proof that order was created by the left maker. | +`rightSignature` | string | Proof that order was created by the right maker. | -___ +**Returns:** *`ContractTxFunctionObj`* -### `Static` strictArgumentEncodingCheck +matchedFillResults Amounts filled by maker and taker of matched orders. -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* +___ +### orderEpoch +▸ **orderEpoch**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* -Defined in base-contract/lib/src/index.d.ts:41 +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6856](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6856)* **Parameters:** Name | Type | ------ | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals +`index_0` | string | +`index_1` | string | -### allowance +**Returns:** *`ContractFunctionObj`* -#### ▪ **allowance**: *object* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:742](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L742)* +### owner -#### callAsync +▸ **owner**(): *`ContractFunctionObj`* -▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6911](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6911)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:751](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L751)* +**Returns:** *`ContractFunctionObj`* -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:** +### preSign -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) | - | - | +▸ **preSign**(`hash`: string): *`ContractTxFunctionObj`* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6963](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6963)* -Amount of remaining tokens allowed to spent +Approves a hash on-chain. +After presigning a hash, the preSign signature type will become valid for that hash and signer. -___ +**Parameters:** -### approve +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Any 32-byte hash. | -#### ▪ **approve**: *object* +**Returns:** *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:64](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L64)* +___ -`msg.sender` approves `_spender` to spend `_value` tokens +### preSigned -#### awaitTransactionSuccessAsync +▸ **preSigned**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* -▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7069](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7069)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:114](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L114)* +**Parameters:** -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. +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | -**Parameters:** +**Returns:** *`ContractFunctionObj`* -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 | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +___ -**Returns:** *`PromiseWithTransactionHash`* +### protocolFeeCollector -A promise that resolves when the transaction is successful +▸ **protocolFeeCollector**(): *`ContractFunctionObj`* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7124](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7124)* -▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +**Returns:** *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:178](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L178)* +___ -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. +### protocolFeeMultiplier -**Parameters:** +▸ **protocolFeeMultiplier**(): *`ContractFunctionObj`* -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) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7171](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7171)* -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -Always true if the call has enough gas to complete execution +___ -#### estimateGasAsync +### registerAssetProxy -▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +▸ **registerAssetProxy**(`assetProxy`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:143](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L143)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7223](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7223)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +Registers an asset proxy to its asset proxy id. +Once an asset proxy is registered, it cannot be unregistered. **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 | +`assetProxy` | string | Address of new asset proxy to register. | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* -The hash of the transaction +___ -#### getABIEncodedTransactionData +### setProtocolFeeCollectorAddress -▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* +▸ **setProtocolFeeCollectorAddress**(`updatedProtocolFeeCollector`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:232](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L232)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7342)* -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). +Allows the owner to update the protocolFeeCollector address. **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* +`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. | -The ABI encoded transaction data as a string +**Returns:** *`ContractTxFunctionObj`* -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:245](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L245)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* +___ -#### sendTransactionAsync +### setProtocolFeeMultiplier -▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +▸ **setProtocolFeeMultiplier**(`updatedProtocolFeeMultiplier`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L73)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7461](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7461)* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +Allows the owner to update the protocol fee multiplier. **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 | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* +Name | Type | Description | +------ | ------ | ------ | +`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. | -The hash of the transaction +**Returns:** *`ContractTxFunctionObj`* ___ -### balanceOf - -#### ▪ **balanceOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:515](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L515)* - -Query the balance of owner - -#### callAsync +### setSignatureValidatorApproval -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **setSignatureValidatorApproval**(`validatorAddress`: string, `approval`: boolean): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:523](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L523)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7581](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7581)* -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. +Approves/unnapproves a Validator contract to verify signatures on signer's behalf +using the `Validator` signature type. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_owner` | string | - | The address from which the balance will be retrieved | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* +Name | Type | Description | +------ | ------ | ------ | +`validatorAddress` | string | Address of Validator contract. | +`approval` | boolean | Approval or disapproval of Validator contract. | -Balance of owner +**Returns:** *`ContractTxFunctionObj`* ___ -### totalSupply - -#### ▪ **totalSupply**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:254](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L254)* - -Query total supply of token - -#### callAsync +### simulateDispatchTransferFromCalls -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **simulateDispatchTransferFromCalls**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:261](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L261)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7712](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7712)* -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. +This function may be used to simulate any amount of transfers As they would occur through the Exchange contract. Note that this function will always revert, even if all transfers are successful. However, it may be used with eth_call or with a try/catch pattern in order to simulate the results of the transfers. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | +`fromAddresses` | string[] | Array containing the `from` addresses that correspond with each transfer. | +`toAddresses` | string[] | Array containing the `to` addresses that correspond with each transfer. | +`amounts` | `BigNumber`[] | Array containing the amounts that correspond to each transfer. | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* -Total supply of token +This function does not return a value. However, it will always revert with `Error("TRANSFERS_SUCCESSFUL")` if all of the transfers were successful. ___ -### transfer - -#### ▪ **transfer**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:568](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L568)* +### subscribe -send `value` token to `to` from `msg.sender` +▸ **subscribe**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -#### awaitTransactionSuccessAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8008](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8008)* -▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +Subscribe to an event type emitted by the Exchange contract. -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:615](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L615)* +**Type parameters:** -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. +▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`_to` | string | - | The address of the recipient | -`_value` | `BigNumber` | - | The amount of token to be transferred | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +`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:** *`PromiseWithTransactionHash`* +**Returns:** *string* -A promise that resolves when the transaction is successful +Subscription token used later to unsubscribe -#### callAsync +___ -▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### transactionsExecuted -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:672](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L672)* +▸ **transactionsExecuted**(`index_0`: string): *`ContractFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7840](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7840)* **Parameters:** -Name | Type | 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`* +Name | Type | +------ | ------ | +`index_0` | string | -True if transfer was successful +**Returns:** *`ContractFunctionObj`* -#### estimateGasAsync +___ -▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +### transferOwnership -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:644](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L644)* +▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7890](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7890)* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | The address of the recipient | -`_value` | `BigNumber` | The amount of token to be transferred | -`txData?` | `Partial` \| undefined | Additional data for transaction | +Name | Type | +------ | ------ | +`newOwner` | string | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* -The hash of the transaction +___ -#### getABIEncodedTransactionData +### unsubscribe -▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* +▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:723](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L723)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8033](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8033)* -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). +Cancel a subscription **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_to` | string | The address of the recipient | -`_value` | `BigNumber` | The amount of token to be transferred | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | -**Returns:** *string* +**Returns:** *void* -The ABI encoded transaction data as a string +___ -#### getSelector +### unsubscribeAll -▸ **getSelector**(): *string* +▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:736](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L736)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8039](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8039)* -Returns the 4 byte function selector as a hex string. +Cancels all existing subscriptions -**Returns:** *string* +**Returns:** *void* -#### sendTransactionAsync +___ -▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +### `Static` ABI -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:577](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L577)* +▸ **ABI**(): *[ContractAbi](#contractabi)* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:198](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L198)* -**Parameters:** +**Returns:** *[ContractAbi](#contractabi)* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | The address of the recipient | -`_value` | `BigNumber` | - | The amount of token to be transferred | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +The contract ABI -**Returns:** *`Promise`* +___ -The hash of the transaction +### `Static` deployAsync -___ +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* -### transferFrom +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:151](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L151)* -#### ▪ **transferFrom**: *object* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:301](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L301)* +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`chainId` | `BigNumber` | -send `value` token to `to` from `from` on the condition it is approved by `from` +**Returns:** *`Promise`* -#### awaitTransactionSuccessAsync +___ -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +### `Static` deployFrom0xArtifactAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:356](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L356)* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:125](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L125)* **Parameters:** -Name | Type | 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 | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`chainId` | `BigNumber` | -**Returns:** *`PromiseWithTransactionHash`* +**Returns:** *`Promise`* + +___ -A promise that resolves when the transaction is successful +### `Static` strictArgumentEncodingCheck -#### callAsync +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L433)* -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. +Defined in base-contract/lib/src/index.d.ts:42 **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) | - | - | +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -**Returns:** *`Promise`* +**Returns:** *string* -True if transfer was successful +
-#### estimateGasAsync +# Class: WETH9Contract -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L394)* +## Constructors -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. -**Parameters:** -Name | Type | Description | +\+ **new WETH9Contract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[WETH9Contract](#class-weth9contract)* + +*Overrides void* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1381](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1381)* + +**Parameters:** + +Name | Type | Default | ------ | ------ | ------ | -`_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 | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | WETH9Contract.deployedBytecode | -**Returns:** *`Promise`* +**Returns:** *[WETH9Contract](#class-weth9contract)* -The hash of the transaction +## Properties -#### getABIEncodedTransactionData +### `Optional` _deployedBytecodeIfExists -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* +• **_deployedBytecodeIfExists**? : *`Buffer`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:491](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L491)* -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:** +Defined in base-contract/lib/src/index.d.ts:32 -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* +### abi + +• **abi**: *[ContractAbi](#contractabi)* -The ABI encoded transaction data as a string -#### getSelector -▸ **getSelector**(): *string* +Defined in base-contract/lib/src/index.d.ts:28 -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:506](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L506)* +___ -Returns the 4 byte function selector as a hex string. +### address -**Returns:** *string* +• **address**: *string* -#### sendTransactionAsync -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:311](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L311)* +Defined in base-contract/lib/src/index.d.ts:29 -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +___ -**Parameters:** +Args -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 | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +• **constructorArgs**: *any[]* -**Returns:** *`Promise`* -The hash of the transaction -
+Defined in base-contract/lib/src/index.d.ts:31 -# Class: ERC721TokenContract +___ +### contractName -## Constructors +• **contractName**: *string* -\+ **new ERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC721TokenContract](#class-erc721tokencontract)* +Defined in base-contract/lib/src/index.d.ts:30 -*Overrides void* +## Methods -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1735](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1735)* +### allowance + +▸ **allowance**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1258](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1258)* **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ERC721TokenContract.deployedBytecode | +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | -**Returns:** *[ERC721TokenContract](#class-erc721tokencontract)* +**Returns:** *`ContractFunctionObj`* -## Properties +___ + +### approve -#### `Optional` _deployedBytecodeIfExists +▸ **approve**(`guy`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj`* -• **_deployedBytecodeIfExists**? : *`Buffer`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:512](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L512)* +**Parameters:** +Name | Type | +------ | ------ | +`guy` | string | +`wad` | `BigNumber` | -Defined in base-contract/lib/src/index.d.ts:31 +**Returns:** *`ContractTxFunctionObj`* ___ -### abi +### balanceOf -• **abi**: *[ContractAbi](#contractabi)* +▸ **balanceOf**(`index_0`: string): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:946](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L946)* +**Parameters:** +Name | Type | +------ | ------ | +`index_0` | string | -Defined in base-contract/lib/src/index.d.ts:27 +**Returns:** *`ContractFunctionObj`* ___ -### address +### decimals -• **address**: *string* +▸ **decimals**(): *`ContractFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:899](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L899)* +**Returns:** *`ContractFunctionObj`* -Defined in base-contract/lib/src/index.d.ts:28 +___ + +### deposit + +▸ **deposit**(): *`ContractTxFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1153)* + +**Returns:** *`ContractTxFunctionObj`* ___ -Args +### getABIDecodedReturnData -• **constructorArgs**: *any[]* +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:451](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L451)* +**Type parameters:** +▪ **T** -Defined in base-contract/lib/src/index.d.ts:30 +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | + +**Returns:** *`T`* ___ -### contractName +### getABIDecodedTransactionData -• **contractName**: *string* +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:444](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L444)* +**Type parameters:** -Defined in base-contract/lib/src/index.d.ts:29 +▪ **T** -## Methods +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | + +**Returns:** *`T`* + +___ + +### getFunctionSignature + +▸ **getFunctionSignature**(`methodName`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:438](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L438)* + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | + +**Returns:** *string* + +___ ### getLogsAsync -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1719](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1719)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1365](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1365)* Gets historical logs without creating a subscription **Type parameters:** -▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)* +▪ **ArgsType**: *[WETH9EventArgs](#weth9eventargs)* **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`eventName` | [ERC721TokenEvents](#enumeration-erc721tokenevents) | The ERC721Token contract event you would like to subscribe to. | +`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}` | @@ -2458,23 +2252,49 @@ Array of logs that match the parameters ___ +### getSelector + +▸ **getSelector**(`methodName`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L458)* + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | + +**Returns:** *string* + +___ + +### name + +▸ **name**(): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:465](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L465)* + +**Returns:** *`ContractFunctionObj`* + +___ + ### subscribe -▸ **subscribe**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* +▸ **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/erc721_token.ts:1677](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1677)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1323](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1323)* -Subscribe to an event type emitted by the ERC721Token contract. +Subscribe to an event type emitted by the WETH9 contract. **Type parameters:** -▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)* +▪ **ArgsType**: *[WETH9EventArgs](#weth9eventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`eventName` | [ERC721TokenEvents](#enumeration-erc721tokenevents) | - | The ERC721Token contract event you would like to subscribe to. | +`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) | @@ -2486,11 +2306,66 @@ Subscription token used later to unsubscribe ___ +### symbol + +▸ **symbol**(): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:996](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L996)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### totalSupply + +▸ **totalSupply**(): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:622](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L622)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### transfer + +▸ **transfer**(`dst`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1043](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1043)* + +**Parameters:** + +Name | Type | +------ | ------ | +`dst` | string | +`wad` | `BigNumber` | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### transferFrom + +▸ **transferFrom**(`src`: string, `dst`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:669](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L669)* + +**Parameters:** + +Name | Type | +------ | ------ | +`src` | string | +`dst` | string | +`wad` | `BigNumber` | + +**Returns:** *`ContractTxFunctionObj`* + +___ + ### unsubscribe ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1702](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1702)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1348](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1348)* Cancel a subscription @@ -2508,7 +2383,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1708](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1708)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1354](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1354)* Cancels all existing subscriptions @@ -2516,11 +2391,27 @@ Cancels all existing subscriptions ___ +### withdraw + +▸ **withdraw**(`wad`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:793](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L793)* + +**Parameters:** + +Name | Type | +------ | ------ | +`wad` | `BigNumber` | + +**Returns:** *`ContractTxFunctionObj`* + +___ + ### `Static` ABI ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1408](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1408)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:149](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L149)* **Returns:** *[ContractAbi](#contractabi)* @@ -2530,9 +2421,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **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:1366](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1366)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:107](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L107)* **Parameters:** @@ -2544,15 +2435,15 @@ Name | Type | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1341)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L82)* **Parameters:** @@ -2563,7 +2454,7 @@ Name | Type | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ @@ -2573,7 +2464,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:41 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -2584,8590 +2475,2798 @@ Name | Type | **Returns:** *string* -## Object literals +
-### approve +# Class: MetamaskSubprovider -#### ▪ **approve**: *object* +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. -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:76](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L76)* -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. +## Constructors -#### awaitTransactionSuccessAsync -▸ **awaitTransactionSuccessAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:126](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L126)* +\+ **new MetamaskSubprovider**(`supportedProvider`: [SupportedProvider](#supportedprovider)): *[MetamaskSubprovider](#class-metamasksubprovider)* + +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/metamask_subprovider.ts#L19)* -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. +Instantiates a new MetamaskSubprovider **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_approved` | string | - | The new approved NFT controller | -`_tokenId` | `BigNumber` | - | The NFT to approve | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +Name | Type | Description | +------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider that should handle all user account related requests | -**Returns:** *`PromiseWithTransactionHash`* +**Returns:** *[MetamaskSubprovider](#class-metamasksubprovider)* -A promise that resolves when the transaction is successful +## Methods -#### callAsync +### emitPayloadAsync -▸ **callAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:189](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L189)* -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:** +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/subprovider.ts#L55)* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_approved` | string | - | The new approved NFT controller | -`_tokenId` | `BigNumber` | - | The NFT to approve | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +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. -**Returns:** *`Promise`* +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`payload` | `Partial` | JSON RPC payload | + +**Returns:** *`Promise`* + +JSON RPC response payload + +___ + +### handleRequest -#### estimateGasAsync +▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#callback), `end`: [ErrorCallback](#errorcallback)): *`Promise`* -▸ **estimateGasAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +*Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:155](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L155)* +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/metamask_subprovider.ts#L39)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +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 | ------ | ------ | ------ | -`_approved` | string | The new approved NFT controller | -`_tokenId` | `BigNumber` | The NFT to approve | -`txData?` | `Partial` \| undefined | Additional data for transaction | +`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`* +**Returns:** *`Promise`* -The hash of the transaction +___ -#### getABIEncodedTransactionData +### sendAsync -▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* +▸ **sendAsync**(`payload`: `JSONRPCRequestPayload`, `callback`: [ErrorCallback](#errorcallback)): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:243](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L243)* +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/metamask_subprovider.ts#L117)* -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). +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 | ------ | ------ | ------ | -`_approved` | string | The new approved NFT controller | -`_tokenId` | `BigNumber` | The NFT to approve | - -**Returns:** *string* - -The ABI encoded transaction data as a string +`payload` | `JSONRPCRequestPayload` | JSON RPC payload | +`callback` | [ErrorCallback](#errorcallback) | - | -#### getSelector +**Returns:** *void* -▸ **getSelector**(): *string* +The contents nested under the result key of the response body -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:256](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L256)* +___ -Returns the 4 byte function selector as a hex string. +### setEngine -**Returns:** *string* +▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* -#### sendTransactionAsync -▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L85)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/subprovider.ts#L68)* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +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 | Default | Description | ------- | ------ | ------ | ------ | -`_approved` | string | - | The new approved NFT controller | -`_tokenId` | `BigNumber` | - | The NFT to approve | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* +Name | Type | Description | +------ | ------ | ------ | +`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | -The hash of the transaction +**Returns:** *void* -___ +
-### balanceOf +# Class: RPCSubprovider -#### ▪ **balanceOf**: *object* +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 -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:266](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L266)* -NFTs assigned to the zero address are considered invalid, and this -function throws for queries about the zero address. +## Constructors -#### callAsync -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:274](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L274)* +\+ **new RPCSubprovider**(`rpcUrl`: string, `requestTimeoutMs`: number): *[RPCSubprovider](#class-rpcsubprovider)* -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. +*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* **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 - -___ +`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 | -### getApproved +**Returns:** *[RPCSubprovider](#class-rpcsubprovider)* -#### ▪ **getApproved**: *object* +## Methods -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:319](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L319)* +### emitPayloadAsync -Throws if `_tokenId` is not a valid NFT. +▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* -#### callAsync -▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:327](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L327)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/subprovider.ts#L55)* -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. +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 | Default | Description | ------- | ------ | ------ | ------ | -`_tokenId` | `BigNumber` | - | The NFT to find the approved address for | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`payload` | `Partial` | JSON RPC payload | -**Returns:** *`Promise`* +**Returns:** *`Promise`* -The approved address for this NFT, or the zero address if there is none +JSON RPC response payload ___ -### isApprovedForAll - -#### ▪ **isApprovedForAll**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:369](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L369)* +### handleRequest -#### callAsync +▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `_next`: [Callback](#callback), `end`: [ErrorCallback](#errorcallback)): *`Promise`* -▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +*Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:378](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L378)* +*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/rpc_subprovider.ts#L38)* -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. +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 | 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`* +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. | -True if `_operator` is an approved operator for `_owner`, false otherwise +**Returns:** *`Promise`* ___ -### ownerOf - -#### ▪ **ownerOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L429)* +### setEngine -NFTs assigned to zero address are considered invalid, and queries -about them do throw. +▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* -#### callAsync -▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:437](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L437)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/subprovider.ts#L68)* -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. +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 | Default | Description | ------- | ------ | ------ | ------ | -`_tokenId` | `BigNumber` | - | The identifier for an NFT | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* +Name | Type | Description | +------ | ------ | ------ | +`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | -The address of the owner of the NFT +**Returns:** *void* -___ +
-### safeTransferFrom1 +# Enumeration: ERC20TokenEvents -#### ▪ **safeTransferFrom1**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:483](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L483)* +## Enumeration members -This works identically to the other function with an extra data parameter, -except this function just sets data to "". +### Approval -#### awaitTransactionSuccessAsync +• **Approval**: = "Approval" -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L41)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:538](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L538)* +___ -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. +### Transfer -**Parameters:** +• **Transfer**: = "Transfer" -Name | Type | Default | 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 | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L40)* -**Returns:** *`PromiseWithTransactionHash`* +
-A promise that resolves when the transaction is successful +# Enumeration: ERC721TokenEvents -#### callAsync -▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +## Enumeration members -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:614](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L614)* +### Approval -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. +• **Approval**: = "Approval" -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L43)* -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`* +### ApprovalForAll -#### estimateGasAsync +• **ApprovalForAll**: = "ApprovalForAll" -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L44)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:576](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L576)* +___ -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +### Transfer -**Parameters:** +• **Transfer**: = "Transfer" -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 | +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L45)* -**Returns:** *`Promise`* +
-The hash of the transaction +# Enumeration: ExchangeEvents -#### getABIEncodedTransactionData -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* +## Enumeration members -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:672](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L672)* +### AssetProxyRegistered -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). +• **AssetProxyRegistered**: = "AssetProxyRegistered" -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:48](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L48)* -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | The current owner of the NFT | -`_to` | string | The new owner | -`_tokenId` | `BigNumber` | The NFT to transfer | +___ -**Returns:** *string* +### Cancel -The ABI encoded transaction data as a string +• **Cancel**: = "Cancel" -#### getSelector +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L49)* -▸ **getSelector**(): *string* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:687](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L687)* +### CancelUpTo -Returns the 4 byte function selector as a hex string. +• **CancelUpTo**: = "CancelUpTo" -**Returns:** *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)* -#### sendTransactionAsync +___ -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +### Fill -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:493](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L493)* +• **Fill**: = "Fill" -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)* -**Parameters:** +___ -Name | Type | Default | 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 | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +### ProtocolFeeCollectorAddress -**Returns:** *`Promise`* +• **ProtocolFeeCollectorAddress**: = "ProtocolFeeCollectorAddress" -The hash of the transaction +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L52)* ___ -### safeTransferFrom2 +### ProtocolFeeMultiplier -#### ▪ **safeTransferFrom2**: *object* +• **ProtocolFeeMultiplier**: = "ProtocolFeeMultiplier" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:702](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L702)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L53)* -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 +### SignatureValidatorApproval -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +• **SignatureValidatorApproval**: = "SignatureValidatorApproval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:762](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L762)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L54)* -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:** +### TransactionExecution -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` | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +• **TransactionExecution**: = "TransactionExecution" -**Returns:** *`PromiseWithTransactionHash`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L55)* -A promise that resolves when the transaction is successful +
-#### callAsync +# Enumeration: WETH9Events -▸ **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:846](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L846)* +## Enumeration members -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. +### Approval -**Parameters:** +• **Approval**: = "Approval" -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) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)* -**Returns:** *`Promise`* +___ -#### estimateGasAsync +### Deposit -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* +• **Deposit**: = "Deposit" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:804](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L804)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L46)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +___ -**Parameters:** +### Transfer -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 | +• **Transfer**: = "Transfer" -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L45)* -The hash of the transaction +___ -#### getABIEncodedTransactionData +### Withdrawal -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* +• **Withdrawal**: = "Withdrawal" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:908](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L908)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L47)* -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:** +# Enumeration: SubscriptionErrors -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* +## Enumeration members -The ABI encoded transaction data as a string +### SubscriptionAlreadyPresent -#### getSelector +• **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT" -▸ **getSelector**(): *string* +*Defined in [base-contract/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L21)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:923](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L923)* +___ -Returns the 4 byte function selector as a hex string. +### SubscriptionNotFound -**Returns:** *string* +• **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND" -#### sendTransactionAsync +*Defined in [base-contract/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L20)* -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +
-*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:713](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L713)* +# Enumeration: ChainId -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. -**Parameters:** +## Enumeration members -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` | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +### Ganache -**Returns:** *`Promise`* +• **Ganache**: = 1337 -The hash of the transaction +*Defined in [contract-addresses/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L34)* ___ -### setApprovalForAll +### Kovan -#### ▪ **setApprovalForAll**: *object* +• **Kovan**: = 42 -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:933](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L933)* +*Defined in [contract-addresses/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L33)* -Emits the ApprovalForAll event. The contract MUST allow -multiple operators per owner. +___ + +### Mainnet -#### awaitTransactionSuccessAsync +• **Mainnet**: = 1 -▸ **awaitTransactionSuccessAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +*Defined in [contract-addresses/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L30)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:983](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L983)* +___ -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. +### Rinkeby -**Parameters:** +• **Rinkeby**: = 4 -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 | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +*Defined in [contract-addresses/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L32)* -**Returns:** *`PromiseWithTransactionHash`* +___ -A promise that resolves when the transaction is successful +### Ropsten -#### callAsync +• **Ropsten**: = 3 -▸ **callAsync**(`_operator`: string, `_approved`: boolean, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +*Defined in [contract-addresses/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L31)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1051](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1051)* +
-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) | - | - | +# Enumeration: BlockParamLiteral -**Returns:** *`Promise`* -#### estimateGasAsync +## Enumeration members -▸ **estimateGasAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined): *`Promise`* +### Earliest -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1017](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1017)* +• **Earliest**: = "earliest" -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L479)* -**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 | +### Latest -**Returns:** *`Promise`* +• **Latest**: = "latest" -The hash of the transaction +*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L480)* -#### getABIEncodedTransactionData +___ -▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* +### Pending -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1105)* +• **Pending**: = "pending" -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). +*Defined in [ethereum-types/src/index.ts:481](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L481)* -**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 -#### getSelector -▸ **getSelector**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1118](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1118)* -Returns the 4 byte function selector as a hex string. -**Returns:** *string* -#### sendTransactionAsync -▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:942](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L942)* +# Enumeration: AssetProxyId -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. -**Parameters:** +## Enumeration members -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 | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +### ERC1155 -**Returns:** *`Promise`* +• **ERC1155**: = "0xa7cb5fb7" -The hash of the transaction +*Defined in [types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L166)* ___ -### transferFrom +### ERC20 -#### ▪ **transferFrom**: *object* +• **ERC20**: = "0xf47261b0" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1130)* +*Defined in [types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L163)* -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 +### ERC20Bridge -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +• **ERC20Bridge**: = "0xdc1600f3" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1185](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1185)* +*Defined in [types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L168)* -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:** +### ERC721 -Name | Type | Default | 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 | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +• **ERC721**: = "0x02571792" -**Returns:** *`PromiseWithTransactionHash`* +*Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L164)* -A promise that resolves when the transaction is successful +___ -#### callAsync +### MultiAsset -▸ **callAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +• **MultiAsset**: = "0x94cfcdd7" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1261](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1261)* +*Defined in [types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L165)* -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:** +### StaticCall -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) | - | - | +• **StaticCall**: = "0xc339d10a" -**Returns:** *`Promise`* +*Defined in [types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L167)* -#### estimateGasAsync +
-▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1223](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1223)* -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 -#### getABIEncodedTransactionData -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1319](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1319)* -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 | +# Enumeration: SignatureType -**Returns:** *string* -The ABI encoded transaction data as a string +## Enumeration members -#### getSelector +### EIP1271Wallet -▸ **getSelector**(): *string* +• **EIP1271Wallet**: -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1334](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1334)* +*Defined in [types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L158)* -Returns the 4 byte function selector as a hex string. +___ -**Returns:** *string* +### EIP712 -#### sendTransactionAsync +• **EIP712**: -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +*Defined in [types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L153)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1140](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1140)* +___ -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +### EthSign -**Parameters:** +• **EthSign**: -Name | Type | Default | 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 | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +*Defined in [types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L154)* -**Returns:** *`Promise`* +___ -The hash of the transaction +### Illegal -
+• **Illegal**: -# Class: ExchangeContract +*Defined in [types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L151)* +___ -## Constructors +### Invalid +• **Invalid**: +*Defined in [types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L152)* -\+ **new ExchangeContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ExchangeContract](#class-exchangecontract)* +___ -*Overrides void* +### NSignatureTypes -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10951](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10951)* +• **NSignatureTypes**: -**Parameters:** +*Defined in [types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L159)* -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ExchangeContract.deployedBytecode | +___ -**Returns:** *[ExchangeContract](#class-exchangecontract)* +### PreSigned -## Properties +• **PreSigned**: -#### `Optional` _deployedBytecodeIfExists +*Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L157)* -• **_deployedBytecodeIfExists**? : *`Buffer`* +___ +### Validator +• **Validator**: -Defined in base-contract/lib/src/index.d.ts:31 +*Defined in [types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L156)* ___ -### abi +### Wallet -• **abi**: *[ContractAbi](#contractabi)* +• **Wallet**: +*Defined in [types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L155)* +
-Defined in base-contract/lib/src/index.d.ts:27 -___ -### address -• **address**: *string* -Defined in base-contract/lib/src/index.d.ts:28 -___ -Args -• **constructorArgs**: *any[]* +
+# Interface: ERC20TokenApprovalEventArgs -Defined in base-contract/lib/src/index.d.ts:30 -___ +## Index -### contractName +### Properties -• **contractName**: *string* +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) +## Properties +### _owner -Defined in base-contract/lib/src/index.d.ts:29 +• **_owner**: *string* -## Methods +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L51)* -### getLogsAsync +___ -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* +### _spender -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10935](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10935)* +• **_spender**: *string* -Gets historical logs without creating a subscription +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L52)* -**Type parameters:** +___ -▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)* +### _value -**Parameters:** +• **_value**: *`BigNumber`* -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}` | +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L53)* -**Returns:** *`Promise>>`* +
-Array of logs that match the parameters +# Interface: ERC20TokenTransferEventArgs -___ -### subscribe +## Index -▸ **subscribe**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* +### Properties -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10893](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10893)* +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) -Subscribe to an event type emitted by the Exchange contract. +## Properties -**Type parameters:** +### _from -▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)* +• **_from**: *string* -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L45)* -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* +### _to -Subscription token used later to unsubscribe +• **_to**: *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L46)* ___ -### unsubscribe +### _value -▸ **unsubscribe**(`subscriptionToken`: string): *void* +• **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10918](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10918)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L47)* -Cancel a subscription +
-**Parameters:** +# Interface: ERC721TokenApprovalEventArgs -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | -**Returns:** *void* +## Index -___ +### Properties -### unsubscribeAll +* [_approved](#_approved) +* [_owner](#_owner) +* [_tokenId](#_tokenid) -▸ **unsubscribeAll**(): *void* +## Properties -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10924](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10924)* +### _approved -Cancels all existing subscriptions +• **_approved**: *string* -**Returns:** *void* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L50)* ___ -### `Static` ABI +### _owner -▸ **ABI**(): *[ContractAbi](#contractabi)* +• **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8004](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8004)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7957](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7957)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`chainId` | `BigNumber` | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7931](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7931)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`chainId` | `BigNumber` | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:41 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### EIP1271_MAGIC_VALUE - -#### ▪ **EIP1271_MAGIC_VALUE**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L120)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:126](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L126)* - -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`* - -___ - -### EIP712_EXCHANGE_DOMAIN_HASH - -#### ▪ **EIP712_EXCHANGE_DOMAIN_HASH**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:163](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L163)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:169](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L169)* - -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`* - -___ - -### allowedValidators - -#### ▪ **allowedValidators**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:206](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L206)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:212](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.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 | ------- | ------ | ------ | -`index_0` | string | - | -`index_1` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### batchCancelOrders - -#### ▪ **batchCancelOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:262](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L262)* - -Executes multiple calls of cancelOrder. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:323](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L323)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:410](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L410)* - -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:364](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L364)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:478](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L478)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:507](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L507)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:270](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L270)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchExecuteTransactions - -#### ▪ **batchExecuteTransactions**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:518](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L518)* - -Executes a batch of Exchange method calls in the context of signer(s). - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:576](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L576)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`transactions` | `Array` | - | Array of 0x transaction structures. | -`signatures` | string[] | - | Array of proofs that transactions have been signed by signer(s). | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`transactions`: `Array`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:659](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L659)* - -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 | ------- | ------ | ------ | ------ | -`transactions` | `Array` | - | Array of 0x transaction structures. | -`signatures` | string[] | - | Array of proofs that transactions have been signed by signer(s). | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Array containing ABI encoded return data for each of the underlying Exchange function calls. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:617](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L617)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transactions` | `Array` | Array of 0x transaction structures. | -`signatures` | string[] | Array of proofs that transactions have been signed by signer(s). | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transactions`: `Array`, `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:722](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L722)* - -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 | ------- | ------ | ------ | -`transactions` | `Array` | Array of 0x transaction structures. | -`signatures` | string[] | Array of proofs that transactions have been signed by signer(s). | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:744](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L744)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:528](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L528)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`transactions` | `Array` | - | Array of 0x transaction structures. | -`signatures` | string[] | - | Array of proofs that transactions have been signed by signer(s). | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchFillOrKillOrders - -#### ▪ **batchFillOrKillOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:755](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L755)* - -Executes multiple calls of fillOrKillOrder. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:831](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L831)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:939](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L939)* - -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>`* - -Array of amounts filled and fees paid by makers and taker. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:885](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L885)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1030](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1030)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1063](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1063)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:766](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L766)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchFillOrders - -#### ▪ **batchFillOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1074](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1074)* - -Executes multiple calls of fillOrder. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1145](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1145)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1253](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.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 | 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>`* - -Array of amounts filled and fees paid by makers and taker. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1199](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1199)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1344](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1344)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1377](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1377)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1085](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1085)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchFillOrdersNoThrow - -#### ▪ **batchFillOrdersNoThrow**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1388](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1388)* - -Executes multiple calls of fillOrder. If any fill reverts, the error is caught and ignored. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1464](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1464)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1572](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1572)* - -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>`* - -Array of amounts filled and fees paid by makers and taker. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1518](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1518)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1663](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1663)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1696](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1696)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1399](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1399)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchMatchOrders - -#### ▪ **batchMatchOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1709](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1709)* - -Match complementary orders that have a profitable spread. -Each order is filled at their respective price point, and -the matcher receives a profit denominated in the left maker asset. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1807](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1807)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1954](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1954)* - -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 | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -batchMatchedFillResults Amounts filled and profit generated. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1881](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1881)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | Proof that right orders were created by the right makers. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2082](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2082)* - -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 | ------- | ------ | ------ | -`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | Proof that right orders were created by the right makers. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2132](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2132)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1722](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1722)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchMatchOrdersWithMaximalFill - -#### ▪ **batchMatchOrdersWithMaximalFill**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2146](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2146)* - -Match complementary orders that have a profitable spread. -Each order is maximally filled at their respective price point, and -the matcher receives a profit denominated in either the left maker asset, -right maker asset, or a combination of both. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2244](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2244)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2391)* - -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 | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -batchMatchedFillResults Amounts filled and profit generated. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2318](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2318)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | Proof that right orders were created by the right makers. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2519](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2519)* - -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 | ------- | ------ | ------ | -`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | Proof that right orders were created by the right makers. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2569](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2569)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2159](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2159)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### cancelOrder - -#### ▪ **cancelOrder**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2580](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2580)* - -After calling, the order can not be filled anymore. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2640](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2640)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | Order struct containing order specifications. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:2725](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2725)* - -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. | -`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:2680](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2680)* - -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. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2792](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2792)* - -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. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2818](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2818)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2588](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2588)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | Order struct containing order specifications. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### cancelOrdersUpTo - -#### ▪ **cancelOrdersUpTo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2830](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2830)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2875](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2875)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`targetOrderEpoch` | `BigNumber` | - | Orders created with a salt less or equal to this value will be cancelled. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:2928](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2928)* - -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:2902](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2902)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`targetOrderEpoch`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2977](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2977)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2988](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2988)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2839](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2839)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`targetOrderEpoch` | `BigNumber` | - | Orders created with a salt less or equal to this value will be cancelled. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### cancelled - -#### ▪ **cancelled**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2994](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2994)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3000](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3000)* - -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`* - -___ - -### currentContextAddress - -#### ▪ **currentContextAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3042](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3042)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3048](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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 | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### executeTransaction - -#### ▪ **executeTransaction**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3088](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3088)* - -Executes an Exchange method call in the context of signer. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3143](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3143)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`transaction` | object | - | 0x transaction structure. | -`signature` | string | - | Proof that transaction has been signed by signer. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`transaction`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3217](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3217)* - -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 structure. | -`signature` | string | - | Proof that transaction has been signed by signer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -ABI encoded return data of the underlying Exchange function call. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3177)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transaction` | object | 0x transaction structure. | -`signature` | string | Proof that transaction has been signed by signer. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transaction`: object, `signature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3278](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3278)* - -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 structure. | -`signature` | string | Proof that transaction has been signed by signer. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3299](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3299)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3097](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3097)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`transaction` | object | - | 0x transaction structure. | -`signature` | string | - | Proof that transaction has been signed by signer. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### fillOrKillOrder - -#### ▪ **fillOrKillOrder**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3310](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3310)* - -Fills the input order. Reverts if exact takerAssetFillAmount not filled. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3378](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3378)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:3481](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3481)* - -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:3430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3430)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3566](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3566)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3598](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3598)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3320](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3320)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### fillOrder - -#### ▪ **fillOrder**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3609](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3609)* - -Fills the input order. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3677](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3677)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:3781](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3781)* - -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:3729](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3729)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3866](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3866)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3898](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3898)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3619](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3619)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### filled - -#### ▪ **filled**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3906](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3906)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3912](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3912)* - -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`* - -___ - -### getAssetProxy - -#### ▪ **getAssetProxy**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3957](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3957)* - -Gets an asset proxy. - -#### callAsync - -▸ **callAsync**(`assetProxyId`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3965](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3965)* - -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. - -___ - -### getOrderInfo - -#### ▪ **getOrderInfo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4010](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4010)* - -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:4018](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4018)* - -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. - -___ - -### isValidHashSignature - -#### ▪ **isValidHashSignature**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4086](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4086)* - -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:4096](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4096)* - -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`* - -isValid `true` if the signature is valid for the given hash and signer. - -___ - -### isValidOrderSignature - -#### ▪ **isValidOrderSignature**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4149](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4149)* - -Verifies that a signature for an order is valid. - -#### callAsync - -▸ **callAsync**(`order`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4158](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4158)* - -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. | -`signature` | string | - | Proof that the order has been signed by signer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -isValid `true` if the signature is valid for the given order and signer. - -___ - -### isValidTransactionSignature - -#### ▪ **isValidTransactionSignature**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4224](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4224)* - -Verifies that a signature for a transaction is valid. - -#### callAsync - -▸ **callAsync**(`transaction`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4233](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4233)* - -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 | - | The transaction. | -`signature` | string | - | Proof that the order has been signed by signer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -isValid `true` if the signature is valid for the given transaction and signer. - -___ - -### marketBuyOrdersFillOrKill - -#### ▪ **marketBuyOrdersFillOrKill**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4291](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4291)* - -Calls marketBuyOrdersNoThrow then reverts if < makerAssetFillAmount has been bought. -NOTE: This function does not enforce that the makerAsset is the same for each order. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4365](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4365)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`makerAssetFillAmount` | `BigNumber` | - | Minimum amount of makerAsset to buy. | -`signatures` | string[] | - | Proofs that orders have been signed by makers. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:4471](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4471)* - -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` | - | Minimum 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:4418](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4418)* - -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` | Minimum 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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4557](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4557)* - -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` | Minimum 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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4590](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4590)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4301](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4301)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`makerAssetFillAmount` | `BigNumber` | - | Minimum amount of makerAsset to buy. | -`signatures` | string[] | - | Proofs that orders have been signed by makers. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### marketBuyOrdersNoThrow - -#### ▪ **marketBuyOrdersNoThrow**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4603](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4603)* - -Executes multiple calls of fillOrder until total amount of makerAsset is bought by taker. -If any fill reverts, the error is caught and ignored. -NOTE: This function does not enforce that the makerAsset is the same for each order. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4677](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4677)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:4783](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4783)* - -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:4730](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4730)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4869](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4869)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4902](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4902)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4613](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4613)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### marketSellOrdersFillOrKill - -#### ▪ **marketSellOrdersFillOrKill**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4914](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4914)* - -Calls marketSellOrdersNoThrow then reverts if < takerAssetFillAmount has been sold. -NOTE: This function does not enforce that the takerAsset is the same for each order. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4988](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4988)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`takerAssetFillAmount` | `BigNumber` | - | Minimum amount of takerAsset to sell. | -`signatures` | string[] | - | Proofs that orders have been signed by makers. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:5094](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5094)* - -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` | - | Minimum 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:5041](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5041)* - -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` | Minimum 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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5180](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5180)* - -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` | Minimum 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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5213](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5213)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4924](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4924)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`takerAssetFillAmount` | `BigNumber` | - | Minimum amount of takerAsset to sell. | -`signatures` | string[] | - | Proofs that orders have been signed by makers. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### marketSellOrdersNoThrow - -#### ▪ **marketSellOrdersNoThrow**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5226](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5226)* - -Executes multiple calls of fillOrder until total amount of takerAsset is sold by taker. -If any fill reverts, the error is caught and ignored. -NOTE: This function does not enforce that the takerAsset is the same for each order. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5300](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5300)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:5406](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5406)* - -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:5353](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5353)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5492](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5492)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5525](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5525)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5236](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5236)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### matchOrders - -#### ▪ **matchOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5539](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5539)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5631](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5631)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:5770](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5770)* - -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:5701](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5701)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5894](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5894)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5942](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5942)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5550](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5550)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### matchOrdersWithMaximalFill - -#### ▪ **matchOrdersWithMaximalFill**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5956](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5956)* - -Match two complementary orders that have a profitable spread. -Each order is maximally filled at their respective price point, and -the matcher receives a profit denominated in either the left maker asset, -right maker asset, or a combination of both. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6048](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:6187](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6187)* - -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 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:6118](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6118)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6311](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6311)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6359](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6359)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5967](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5967)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### orderEpoch - -#### ▪ **orderEpoch**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6367](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6367)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6373](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6373)* - -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`* - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6420](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6420)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6426](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6426)* - -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`* - -___ - -### preSign - -#### ▪ **preSign**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6467](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6467)* - -Approves a hash on-chain. -After presigning a hash, the preSign signature type will become valid for that hash and signer. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`hash`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6510](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6510)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`hash` | string | - | Any 32-byte hash. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`hash`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6561](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6561)* - -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. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`hash`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6536](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6536)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`hash` | string | Any 32-byte hash. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`hash`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6605](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6605)* - -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. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6614](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6614)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`hash`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6475](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6475)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`hash` | string | - | Any 32-byte hash. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### preSigned - -#### ▪ **preSigned**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6620](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6620)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6626](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6626)* - -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`* - -___ - -### protocolFeeCollector - -#### ▪ **protocolFeeCollector**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6673](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6673)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6679](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6679)* - -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`* - -___ - -### protocolFeeMultiplier - -#### ▪ **protocolFeeMultiplier**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6716](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6716)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6722](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6722)* - -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`* - -___ - -### registerAssetProxy - -#### ▪ **registerAssetProxy**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6763](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6763)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6806](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6806)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`assetProxy` | string | - | Address of new asset proxy to register. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:6857](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6857)* - -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:6832](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6832)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetProxy`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6905](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6905)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6916](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6916)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6771](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6771)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`assetProxy` | string | - | Address of new asset proxy to register. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### setProtocolFeeCollectorAddress - -#### ▪ **setProtocolFeeCollectorAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6925](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6925)* - -Allows the owner to update the protocolFeeCollector address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6972](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6972)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`updatedProtocolFeeCollector` | string | - | The updated protocolFeeCollector contract address. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`updatedProtocolFeeCollector`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7034](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7034)* - -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 | ------- | ------ | ------ | ------ | -`updatedProtocolFeeCollector` | string | - | The updated protocolFeeCollector contract address. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7003](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7003)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`updatedProtocolFeeCollector`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7085](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7085)* - -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 | ------- | ------ | ------ | -`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7096](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7096)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6934](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6934)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`updatedProtocolFeeCollector` | string | - | The updated protocolFeeCollector contract address. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### setProtocolFeeMultiplier - -#### ▪ **setProtocolFeeMultiplier**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7105)* - -Allows the owner to update the protocol fee multiplier. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7150](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7150)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`updatedProtocolFeeMultiplier` | `BigNumber` | - | The updated protocol fee multiplier. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7210](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7210)* - -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 | ------- | ------ | ------ | ------ | -`updatedProtocolFeeMultiplier` | `BigNumber` | - | The updated protocol fee multiplier. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7180](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7180)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`updatedProtocolFeeMultiplier`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7260](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7260)* - -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 | ------- | ------ | ------ | -`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7271](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7271)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7113](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7113)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`updatedProtocolFeeMultiplier` | `BigNumber` | - | The updated protocol fee multiplier. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### setSignatureValidatorApproval - -#### ▪ **setSignatureValidatorApproval**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7281](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7281)* - -Approves/unnapproves a Validator contract to verify signatures on signer's behalf -using the `Validator` signature type. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7331)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`validatorAddress` | string | - | Address of Validator contract. | -`approval` | boolean | - | Approval or disapproval of Validator contract. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:7399](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7399)* - -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:7365](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7365)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`validatorAddress`: string, `approval`: boolean): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7453](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7453)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7466](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7466)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7290](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7290)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`validatorAddress` | string | - | Address of Validator contract. | -`approval` | boolean | - | Approval or disapproval of Validator contract. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### simulateDispatchTransferFromCalls - -#### ▪ **simulateDispatchTransferFromCalls**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7475](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7475)* - -This function may be used to simulate any amount of transfers As they would occur through the Exchange contract. Note that this function will always revert, even if all transfers are successful. However, it may be used with eth_call or with a try/catch pattern in order to simulate the results of the transfers. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7547](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7547)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | -`fromAddresses` | string[] | - | Array containing the `from` addresses that correspond with each transfer. | -`toAddresses` | string[] | - | Array containing the `to` addresses that correspond with each transfer. | -`amounts` | `BigNumber`[] | - | Array containing the amounts that correspond to each transfer. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7638](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7638)* - -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[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | -`fromAddresses` | string[] | - | Array containing the `from` addresses that correspond with each transfer. | -`toAddresses` | string[] | - | Array containing the `to` addresses that correspond with each transfer. | -`amounts` | `BigNumber`[] | - | Array containing the amounts that correspond to each transfer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -This function does not return a value. However, it will always revert with `Error("TRANSFERS_SUCCESSFUL")` if all of the transfers were successful. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7593](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7593)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | -`fromAddresses` | string[] | Array containing the `from` addresses that correspond with each transfer. | -`toAddresses` | string[] | Array containing the `to` addresses that correspond with each transfer. | -`amounts` | `BigNumber`[] | Array containing the amounts that correspond to each transfer. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7704](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7704)* - -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[] | Array of asset details, each encoded per the AssetProxy contract specification. | -`fromAddresses` | string[] | Array containing the `from` addresses that correspond with each transfer. | -`toAddresses` | string[] | Array containing the `to` addresses that correspond with each transfer. | -`amounts` | `BigNumber`[] | Array containing the amounts that correspond to each transfer. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7724](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7724)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7490](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7490)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | -`fromAddresses` | string[] | - | Array containing the `from` addresses that correspond with each transfer. | -`toAddresses` | string[] | - | Array containing the `to` addresses that correspond with each transfer. | -`amounts` | `BigNumber`[] | - | Array containing the amounts that correspond to each transfer. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### transactionsExecuted - -#### ▪ **transactionsExecuted**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7732](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7732)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7738](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7738)* - -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`* - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7780](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7780)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7821](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7821)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:7870](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7870)* - -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:7846](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7846)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7913](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7913)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7924](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7924)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7787](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7787)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: IValidatorContract - - -## Constructors - - - -\+ **new IValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IValidatorContract](#class-ivalidatorcontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:202](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L202)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | IValidatorContract.deployedBytecode | - -**Returns:** *[IValidatorContract](#class-ivalidatorcontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:171](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L171)* - -**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:129](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L129)* - -**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:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L104)* - -**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:41 - -**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:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L44)* - -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:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L54)* - -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)")) - -
- -# Class: IWalletContract - - -## Constructors - - - -\+ **new IWalletContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IWalletContract](#class-iwalletcontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:191](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L191)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | IWalletContract.deployedBytecode | - -**Returns:** *[IWalletContract](#class-iwalletcontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:164](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L164)* - -**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:122](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L122)* - -**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:97](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L97)* - -**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:41 - -**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:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L44)* - -Validates a hash with the `Wallet` signature type. - -#### callAsync - -▸ **callAsync**(`hash`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L53)* - -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`* - -magicValue `bytes4(0xb0671381)` if the signature check succeeds. - -
- -# Class: WETH9Contract - - -## Constructors - - - -\+ **new WETH9Contract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[WETH9Contract](#class-weth9contract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1583](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1583)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | WETH9Contract.deployedBytecode | - -**Returns:** *[WETH9Contract](#class-weth9contract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1567](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1567)* - -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:1525](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1525)* - -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:1550](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1550)* - -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:1556](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1556)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1228](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1228)* - -**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:1186](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1186)* - -**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:1161](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1161)* - -**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:41 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### allowance - -#### ▪ **allowance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1107](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1107)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1113](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1113)* - -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`* - -___ - -### approve - -#### ▪ **approve**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L120)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:163](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L163)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`guy` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:215](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L215)* - -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:190](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L190)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`guy`: string, `wad`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:264](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L264)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:277](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L277)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:127](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L127)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`guy` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### balanceOf - -#### ▪ **balanceOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:712](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L712)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:718](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L718)* - -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`* - -___ - -### decimals - -#### ▪ **decimals**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:669](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L669)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:675](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.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 | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### deposit - -#### ▪ **deposit**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:966](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L966)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1005](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1005)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1051](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1051)* - -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:1028](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1028)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1093](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1093)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1101](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1101)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:973](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L973)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### name - -#### ▪ **name**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:77](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L77)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:83](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L83)* - -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`* - -___ - -### symbol - -#### ▪ **symbol**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:760](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L760)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:766](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L766)* - -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`* - -___ - -### totalSupply - -#### ▪ **totalSupply**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:283](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L283)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:289](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L289)* - -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`* - -___ - -### transfer - -#### ▪ **transfer**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:803](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L803)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:846](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L846)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`dst` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:898](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L898)* - -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:873](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L873)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`dst`: string, `wad`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:947](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L947)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:960](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L960)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:810](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L810)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`dst` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### transferFrom - -#### ▪ **transferFrom**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:326](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L326)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:375](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L375)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`src` | string | - | - | -`dst` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:445](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L445)* - -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:410](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L410)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`src`: string, `dst`: string, `wad`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:500](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L500)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:515](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L515)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:333](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L333)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`src` | string | - | - | -`dst` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### withdraw - -#### ▪ **withdraw**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:521](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L521)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`wad`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:562](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L562)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:611](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L611)* - -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:587](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L587)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`wad`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:654](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L654)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:663](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L663)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:528](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L528)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: ZRXTokenContract - - -## Constructors - - - -\+ **new ZRXTokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ZRXTokenContract](#class-zrxtokencontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1241](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1241)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ZRXTokenContract.deployedBytecode | - -**Returns:** *[ZRXTokenContract](#class-zrxtokencontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ZRXTokenEvents](#enumeration-zrxtokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1225](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1225)* - -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:1183](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1183)* - -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:1208](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1208)* - -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:1214](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1214)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:955](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L955)* - -**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:913](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L913)* - -**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:888](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L888)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | - -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L49)* ___ -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:41 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | +### _tokenId -**Returns:** *string* +• **_tokenId**: *`BigNumber`* -## Object literals +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L51)* -### allowance +
-#### ▪ **allowance**: *object* +# Interface: ERC721TokenApprovalForAllEventArgs -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:834](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L834)* -#### callAsync +## Index -▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### Properties -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:840](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L840)* +* [_approved](#_approved) +* [_operator](#_operator) +* [_owner](#_owner) -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. +## Properties -**Parameters:** +### _approved -Name | Type | Default | ------- | ------ | ------ | -`_owner` | string | - | -`_spender` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +• **_approved**: *boolean* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L57)* ___ -### approve - -#### ▪ **approve**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L104)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:150](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L150)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`_spender` | string | - | - | -`_value` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:209](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L209)* - -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:177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L177)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:261](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L261)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:274](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L274)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:111](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L111)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`_spender` | string | - | - | -`_value` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +### _operator -**Returns:** *`Promise`* +• **_operator**: *string* -The hash of the transaction +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L56)* ___ -### balanceOf - -#### ▪ **balanceOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:580](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L580)* - -#### callAsync - -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### _owner -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:586](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L586)* +• **_owner**: *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L55)* -**Parameters:** +
-Name | Type | Default | ------- | ------ | ------ | -`_owner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +# Interface: ERC721TokenTransferEventArgs -**Returns:** *`Promise`* -___ +## Index -### decimals +### Properties -#### ▪ **decimals**: *object* +* [_from](#_from) +* [_to](#_to) +* [_tokenId](#_tokenid) -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:537](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L537)* +## Properties -#### callAsync +### _from -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +• **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:543](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L543)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L61)* -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:** +### _to -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +• **_to**: *string* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L62)* ___ -### name - -#### ▪ **name**: *object* +### _tokenId -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L61)* +• **_tokenId**: *`BigNumber`* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L63)* -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +
-*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:67](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L67)* +# Interface: ExchangeAssetProxyRegisteredEventArgs -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:** +## Index -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +### Properties -**Returns:** *`Promise`* +* [assetProxy](#assetproxy) +* [id](#id) -___ +## Properties -### symbol +### assetProxy -#### ▪ **symbol**: *object* +• **assetProxy**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:628](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L628)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:60](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L60)* -#### callAsync +___ -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### id -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:634](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L634)* +• **id**: *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L59)* -**Parameters:** +
-Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +# Interface: ExchangeCancelEventArgs -**Returns:** *`Promise`* -___ +## Index -### totalSupply +### Properties -#### ▪ **totalSupply**: *object* +* [feeRecipientAddress](#feerecipientaddress) +* [makerAddress](#makeraddress) +* [makerAssetData](#makerassetdata) +* [orderHash](#orderhash) +* [senderAddress](#senderaddress) +* [takerAssetData](#takerassetdata) -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:280](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L280)* +## Properties -#### callAsync +### feeRecipientAddress -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +• **feeRecipientAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:286](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L286)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)* -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:** +### makerAddress -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +• **makerAddress**: *string* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)* ___ -### transfer +### makerAssetData -#### ▪ **transfer**: *object* +• **makerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:671](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L671)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)* -#### awaitTransactionSuccessAsync +___ -▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +### orderHash -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:714](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L714)* +• **orderHash**: *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L69)* -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | - | -`_value` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +### senderAddress -**Returns:** *`PromiseWithTransactionHash`* +• **senderAddress**: *string* -A promise that resolves when the transaction is successful +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L68)* -#### callAsync +___ -▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### takerAssetData -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:766](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L766)* +• **takerAssetData**: *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:67](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L67)* -**Parameters:** +
-Name | Type | Default | ------- | ------ | ------ | -`_to` | string | - | -`_value` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +# Interface: ExchangeCancelUpToEventArgs -**Returns:** *`Promise`* -#### estimateGasAsync +## Index -▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +### Properties -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:741](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L741)* +* [makerAddress](#makeraddress) +* [orderEpoch](#orderepoch) +* [orderSenderAddress](#ordersenderaddress) -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +## Properties -**Parameters:** +### makerAddress -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | - | -`_value` | `BigNumber` | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | +• **makerAddress**: *string* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L73)* -The hash of the transaction +___ -#### getABIEncodedTransactionData +### orderEpoch -▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* +• **orderEpoch**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:815](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L815)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L75)* -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:** +### orderSenderAddress -Name | Type | ------- | ------ | -`_to` | string | -`_value` | `BigNumber` | +• **orderSenderAddress**: *string* -**Returns:** *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L74)* -The ABI encoded transaction data as a string +
-#### getSelector +# Interface: ExchangeFillEventArgs -▸ **getSelector**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:828](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L828)* +## Index -Returns the 4 byte function selector as a hex string. +### Properties -**Returns:** *string* +* [feeRecipientAddress](#feerecipientaddress) +* [makerAddress](#makeraddress) +* [makerAssetData](#makerassetdata) +* [makerAssetFilledAmount](#makerassetfilledamount) +* [makerFeeAssetData](#makerfeeassetdata) +* [makerFeePaid](#makerfeepaid) +* [orderHash](#orderhash) +* [protocolFeePaid](#protocolfeepaid) +* [senderAddress](#senderaddress) +* [takerAddress](#takeraddress) +* [takerAssetData](#takerassetdata) +* [takerAssetFilledAmount](#takerassetfilledamount) +* [takerFeeAssetData](#takerfeeassetdata) +* [takerFeePaid](#takerfeepaid) -#### sendTransactionAsync +## Properties -▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +### feeRecipientAddress -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:678](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L678)* +• **feeRecipientAddress**: *string* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)* -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | - | -`_value` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +### makerAddress -**Returns:** *`Promise`* +• **makerAddress**: *string* -The hash of the transaction +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)* ___ -### transferFrom - -#### ▪ **transferFrom**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:326](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L326)* +### makerAssetData -ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. +• **makerAssetData**: *string* -#### awaitTransactionSuccessAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)* -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:381](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L381)* +### makerAssetFilledAmount -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. +• **makerAssetFilledAmount**: *`BigNumber`* -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:88](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L88)* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_from` | string | - | Address to transfer from. | -`_to` | string | - | Address to transfer to. | -`_value` | `BigNumber` | - | Amount to transfer. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +___ -**Returns:** *`PromiseWithTransactionHash`* +### makerFeeAssetData -A promise that resolves when the transaction is successful +• **makerFeeAssetData**: *string* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:83](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L83)* -▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:458](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L458)* +### makerFeePaid -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. +• **makerFeePaid**: *`BigNumber`* -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L90)* -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`* +### orderHash -Success of transfer. +• **orderHash**: *string* -#### estimateGasAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L85)* -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:419](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L419)* +### protocolFeePaid -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +• **protocolFeePaid**: *`BigNumber`* -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L92)* -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`* +### senderAddress -The hash of the transaction +• **senderAddress**: *string* -#### getABIEncodedTransactionData +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:87](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L87)* -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:516](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L516)* +### takerAddress -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). +• **takerAddress**: *string* -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L86)* -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | +___ -**Returns:** *string* +### takerAssetData -The ABI encoded transaction data as a string +• **takerAssetData**: *string* -#### getSelector +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L82)* -▸ **getSelector**(): *string* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:531](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L531)* +### takerAssetFilledAmount -Returns the 4 byte function selector as a hex string. +• **takerAssetFilledAmount**: *`BigNumber`* -**Returns:** *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:89](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L89)* -#### sendTransactionAsync +___ -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +### takerFeeAssetData -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L336)* +• **takerFeeAssetData**: *string* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L84)* -**Parameters:** +___ -Name | Type | Default | 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 | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +### takerFeePaid -**Returns:** *`Promise`* +• **takerFeePaid**: *`BigNumber`* -The hash of the transaction +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L91)*
-# Class: MetamaskSubprovider +# Interface: ExchangeProtocolFeeCollectorAddressEventArgs -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. +## Index -## Constructors +### Properties +* [oldProtocolFeeCollector](#oldprotocolfeecollector) +* [updatedProtocolFeeCollector](#updatedprotocolfeecollector) +## Properties -\+ **new MetamaskSubprovider**(`supportedProvider`: [SupportedProvider](#supportedprovider)): *[MetamaskSubprovider](#class-metamasksubprovider)* +### oldProtocolFeeCollector -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/metamask_subprovider.ts#L19)* +• **oldProtocolFeeCollector**: *string* -Instantiates a new MetamaskSubprovider +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L96)* -**Parameters:** +___ -Name | Type | Description | ------- | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider that should handle all user account related requests | +### updatedProtocolFeeCollector -**Returns:** *[MetamaskSubprovider](#class-metamasksubprovider)* +• **updatedProtocolFeeCollector**: *string* -## Methods +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:97](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L97)* -#### emitPayloadAsync +
-▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* +# Interface: ExchangeProtocolFeeMultiplierEventArgs +## Index -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +### Properties -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. +* [oldProtocolFeeMultiplier](#oldprotocolfeemultiplier) +* [updatedProtocolFeeMultiplier](#updatedprotocolfeemultiplier) -**Parameters:** +## Properties -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | +### oldProtocolFeeMultiplier -**Returns:** *`Promise`* +• **oldProtocolFeeMultiplier**: *`BigNumber`* -JSON RPC response payload +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:101](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L101)* ___ -### handleRequest +### updatedProtocolFeeMultiplier -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#callback), `end`: [ErrorCallback](#errorcallback)): *`Promise`* +• **updatedProtocolFeeMultiplier**: *`BigNumber`* -*Overrides void* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L102)* -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:39](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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. +# Interface: ExchangeSignatureValidatorApprovalEventArgs -**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. | +## Index -**Returns:** *`Promise`* +### Properties -___ +* [isApproved](#isapproved) +* [signerAddress](#signeraddress) +* [validatorAddress](#validatoraddress) -### sendAsync +## Properties -▸ **sendAsync**(`payload`: `JSONRPCRequestPayload`, `callback`: [ErrorCallback](#errorcallback)): *void* +### isApproved -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/metamask_subprovider.ts#L117)* +• **isApproved**: *boolean* -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 +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:108](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L108)* -**Parameters:** +___ -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`callback` | [ErrorCallback](#errorcallback) | - | +### signerAddress -**Returns:** *void* +• **signerAddress**: *string* -The contents nested under the result key of the response body +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L106)* ___ -### setEngine +### validatorAddress -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* +• **validatorAddress**: *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:107](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L107)* +
-*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +# Interface: ExchangeTransactionExecutionEventArgs -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:** +## Index -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | +### Properties -**Returns:** *void* +* [transactionHash](#transactionhash) -
+## Properties -# Class: RPCSubprovider +### transactionHash -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 +• **transactionHash**: *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L112)* -## Constructors +
+# Interface: WETH9ApprovalEventArgs -\+ **new RPCSubprovider**(`rpcUrl`: string, `requestTimeoutMs`: number): *[RPCSubprovider](#class-rpcsubprovider)* +## Index -*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* +### Properties -**Parameters:** +* [_owner](#_owner) +* [_spender](#_spender) +* [_value](#_value) -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 | +## Properties -**Returns:** *[RPCSubprovider](#class-rpcsubprovider)* +### _owner -## Methods +• **_owner**: *string* -### emitPayloadAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L51)* -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* +___ +### _spender +• **_spender**: *string* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L52)* -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:** +### _value -Name | Type | Description | ------- | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | +• **_value**: *`BigNumber`* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L53)* -JSON RPC response payload +
-___ +# Interface: WETH9DepositEventArgs -### handleRequest -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `_next`: [Callback](#callback), `end`: [ErrorCallback](#errorcallback)): *`Promise`* +## Index -*Overrides void* +### Properties -*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/rpc_subprovider.ts#L38)* +* [_owner](#_owner) +* [_value](#_value) -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. +## Properties -**Parameters:** +### _owner -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. | +• **_owner**: *string* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L63)* ___ -### setEngine +### _value -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* +• **_value**: *`BigNumber`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L64)* +
-*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +# Interface: WETH9TransferEventArgs -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:** +## Index -Name | Type | Description | ------- | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | +### Properties -**Returns:** *void* +* [_from](#_from) +* [_to](#_to) +* [_value](#_value) -
+## Properties -# Enumeration: ERC20TokenEvents +### _from +• **_from**: *string* -## Enumeration members +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L57)* -### Approval +___ -• **Approval**: = "Approval" +### _to + +• **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L38)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L58)* ___ -### Transfer +### _value -• **Transfer**: = "Transfer" +• **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L37)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L59)*
-# Enumeration: ERC721TokenEvents - +# Interface: WETH9WithdrawalEventArgs -## Enumeration members -### Approval +## Index -• **Approval**: = "Approval" +### Properties -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L40)* +* [_owner](#_owner) +* [_value](#_value) -___ +## Properties -### ApprovalForAll +### _owner -• **ApprovalForAll**: = "ApprovalForAll" +• **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L41)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L68)* ___ -### Transfer +### _value -• **Transfer**: = "Transfer" +• **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L42)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L69)*
-# Enumeration: ExchangeEvents +# Interface: AwaitTransactionSuccessOpts + +Used with `awaitTransactionSuccessAsync` +* pollingIntervalMs: Determine polling intervals in milliseconds +* timeoutMs: Determines timeout in milliseconds -## Enumeration members +## Properties -### AssetProxyRegistered +### `Optional` pollingIntervalMs -• **AssetProxyRegistered**: = "AssetProxyRegistered" +• **pollingIntervalMs**? : *undefined | number* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L45)* +*Defined in [base-contract/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L39)* ___ -### Cancel +### `Optional` shouldValidate -• **Cancel**: = "Cancel" +• **shouldValidate**? : *undefined | false | true* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L46)* +*Inherited from [SendTransactionOpts](#interface-sendtransactionopts).[shouldValidate](#optional-shouldvalidate)* + +*Defined in [base-contract/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L30)* ___ -### CancelUpTo +### `Optional` timeoutMs -• **CancelUpTo**: = "CancelUpTo" +• **timeoutMs**? : *undefined | number* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L47)* +*Defined in [base-contract/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L40)* -___ +
-### Fill +# Interface: ContractEvent <**ContractEventArgs**> -• **Fill**: = "Fill" +## Type parameters -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L48)* +▪ **ContractEventArgs** -___ -### ProtocolFeeCollectorAddress +## Properties -• **ProtocolFeeCollectorAddress**: = "ProtocolFeeCollectorAddress" +### address -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L49)* +• **address**: *string* + +*Defined in [base-contract/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L13)* ___ -### ProtocolFeeMultiplier +### args -• **ProtocolFeeMultiplier**: = "ProtocolFeeMultiplier" +• **args**: *`ContractEventArgs`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)* +*Defined in [base-contract/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L16)* ___ -### SignatureValidatorApproval +### blockHash -• **SignatureValidatorApproval**: = "SignatureValidatorApproval" +• **blockHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)* +*Defined in [base-contract/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L11)* ___ -### TransactionExecution +### blockNumber -• **TransactionExecution**: = "TransactionExecution" +• **blockNumber**: *number* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L52)* +*Defined in [base-contract/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L12)* -
+___ -# Enumeration: WETH9Events +### event +• **event**: *string* -## Enumeration members +*Defined in [base-contract/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L15)* -### Approval +___ -• **Approval**: = "Approval" +### logIndex + +• **logIndex**: *number* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L41)* +*Defined in [base-contract/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L8)* ___ -### Deposit +### transactionHash -• **Deposit**: = "Deposit" +• **transactionHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:43](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L43)* +*Defined in [base-contract/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L10)* ___ -### Transfer +### transactionIndex -• **Transfer**: = "Transfer" +• **transactionIndex**: *number* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L42)* +*Defined in [base-contract/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L9)* ___ -### Withdrawal +### type -• **Withdrawal**: = "Withdrawal" +• **type**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)* +*Defined in [base-contract/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L14)*
-# Enumeration: ZRXTokenEvents +# Interface: ContractFunctionObj <**T**> +## Type parameters -## Enumeration members +▪ **T** -### Approval -• **Approval**: = "Approval" +## Methods + +### callAsync + +▸ **callAsync**(`callData?`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [base-contract/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L44)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData?` | `Partial` | +`defaultBlock?` | [BlockParam](#blockparam) | -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L38)* +**Returns:** *`Promise`* ___ -### Transfer +### getABIEncodedTransactionData -• **Transfer**: = "Transfer" +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [base-contract/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L45)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L37)* +**Returns:** *string*
-# Enumeration: ChainId +# Interface: ContractTxFunctionObj <**T**> +## Type parameters -## Enumeration members +▪ **T** -### Ganache -• **Ganache**: = 1337 +## Methods -*Defined in [contract-addresses/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L34)* +### awaitTransactionSuccessAsync -___ +▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial`, `opts?`: [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts)): *`PromiseWithTransactionHash`* -### Kovan +*Defined in [base-contract/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L50)* -• **Kovan**: = 42 +**Parameters:** + +Name | Type | +------ | ------ | +`txData?` | `Partial` | +`opts?` | [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts) | -*Defined in [contract-addresses/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L33)* +**Returns:** *`PromiseWithTransactionHash`* ___ -### Mainnet +### callAsync -• **Mainnet**: = 1 +▸ **callAsync**(`callData?`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [contract-addresses/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L30)* +*Inherited from [ContractFunctionObj](#interface-contractfunctionobj).[callAsync](#callasync)* -___ +*Defined in [base-contract/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L44)* -### Rinkeby +**Parameters:** -• **Rinkeby**: = 4 +Name | Type | +------ | ------ | +`callData?` | `Partial` | +`defaultBlock?` | [BlockParam](#blockparam) | -*Defined in [contract-addresses/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L32)* +**Returns:** *`Promise`* ___ -### Ropsten +### estimateGasAsync -• **Ropsten**: = 3 +▸ **estimateGasAsync**(`txData?`: `Partial`): *`Promise`* -*Defined in [contract-addresses/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L31)* +*Defined in [base-contract/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L54)* -
+**Parameters:** +Name | Type | +------ | ------ | +`txData?` | `Partial` | +**Returns:** *`Promise`* -# Enumeration: BlockParamLiteral +___ +### getABIEncodedTransactionData -## Enumeration members +▸ **getABIEncodedTransactionData**(): *string* -### Earliest +*Inherited from [ContractFunctionObj](#interface-contractfunctionobj).[getABIEncodedTransactionData](#getabiencodedtransactiondata)* -• **Earliest**: = "earliest" +*Defined in [base-contract/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L45)* -*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L478)* +**Returns:** *string* ___ -### Latest - -• **Latest**: = "latest" +### sendTransactionAsync -*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L479)* +▸ **sendTransactionAsync**(`txData?`: `Partial`, `opts?`: [SendTransactionOpts](#class-sendtransactionopts)): *`Promise`* -___ +*Defined in [base-contract/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L49)* -### Pending +**Parameters:** -• **Pending**: = "pending" +Name | Type | +------ | ------ | +`txData?` | `Partial` | +`opts?` | [SendTransactionOpts](#class-sendtransactionopts) | -*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L480)* +**Returns:** *`Promise`*
+# Interface: ContractAddresses +## Properties +### assetProxyOwner +• **assetProxyOwner**: *string* +*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L12)* +___ +### coordinator -# Enumeration: AssetProxyId +• **coordinator**: *string* +*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L18)* -## Enumeration members +___ -### ERC1155 +### coordinatorRegistry -• **ERC1155**: = "0xa7cb5fb7" +• **coordinatorRegistry**: *string* -*Defined in [types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L166)* +*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L17)* ___ -### ERC20 +### devUtils -• **ERC20**: = "0xf47261b0" +• **devUtils**: *string* -*Defined in [types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L163)* +*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L22)* ___ -### ERC20Bridge +### dutchAuction -• **ERC20Bridge**: = "0xdc1600f3" +• **dutchAuction**: *string* -*Defined in [types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L168)* +*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L16)* ___ -### ERC721 +### erc1155Proxy -• **ERC721**: = "0x02571792" +• **erc1155Proxy**: *string* -*Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L164)* +*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L21)* ___ -### MultiAsset +### erc20BridgeProxy -• **MultiAsset**: = "0x94cfcdd7" +• **erc20BridgeProxy**: *string* -*Defined in [types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L165)* +*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L26)* ___ -### StaticCall +### erc20Proxy -• **StaticCall**: = "0xc339d10a" +• **erc20Proxy**: *string* -*Defined in [types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L167)* +*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L6)* -
+___ +### erc721Proxy +• **erc721Proxy**: *string* +*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L7)* +___ +### etherToken +• **etherToken**: *string* +*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L9)* +___ +### exchange +• **exchange**: *string* +*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L11)* +___ -# Enumeration: SignatureType +### exchangeV2 +• **exchangeV2**: *string* -## Enumeration members +*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L10)* -### EIP1271Wallet +___ -• **EIP1271Wallet**: +### forwarder + +• **forwarder**: *string* -*Defined in [types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L158)* +*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L14)* ___ -### EIP712 +### multiAssetProxy -• **EIP712**: +• **multiAssetProxy**: *string* -*Defined in [types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L153)* +*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L19)* ___ -### EthSign +### orderValidator -• **EthSign**: +• **orderValidator**: *string* -*Defined in [types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L154)* +*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L15)* ___ -### Illegal +### staking -• **Illegal**: +• **staking**: *string* -*Defined in [types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L151)* +*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L24)* ___ -### Invalid +### stakingProxy -• **Invalid**: +• **stakingProxy**: *string* -*Defined in [types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L152)* +*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L25)* ___ -### NSignatureTypes +### staticCallProxy -• **NSignatureTypes**: +• **staticCallProxy**: *string* -*Defined in [types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L159)* +*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L20)* ___ -### PreSigned +### zeroExGovernor -• **PreSigned**: +• **zeroExGovernor**: *string* -*Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L157)* +*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L13)* ___ -### Validator +### zrxToken -• **Validator**: +• **zrxToken**: *string* -*Defined in [types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L156)* +*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L8)* ___ -### Wallet +### zrxVault -• **Wallet**: +• **zrxVault**: *string* -*Defined in [types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L155)* +*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L23)*
+# Interface: BlockRange +## Properties +### fromBlock +• **fromBlock**: *[BlockParam](#blockparam)* +*Defined in [ethereum-types/src/index.ts:743](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L743)* -# Interface: ERC20TokenApprovalEventArgs +___ +### toBlock -## Index +• **toBlock**: *[BlockParam](#blockparam)* -### Properties +*Defined in [ethereum-types/src/index.ts:744](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L744)* -* [_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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L48)* -___ +# Interface: CallData -### _spender -• **_spender**: *string* +## Properties + +### `Optional` data + +• **data**? : *undefined | string* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L49)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ -### _value +### `Optional` from -• **_value**: *`BigNumber`* +• **from**? : *undefined | string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L50)* +*Defined in [ethereum-types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L403)* -
+___ -# Interface: ERC20TokenTransferEventArgs +### `Optional` gas +• **gas**? : *number | string | `BigNumber`* -## Index +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -### Properties +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) +___ -## Properties +### `Optional` gasPrice -### _from +• **gasPrice**? : *number | string | `BigNumber`* -• **_from**: *string* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L42)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ -### _to +### `Optional` nonce -• **_to**: *string* +• **nonce**? : *undefined | number* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L43)* +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ -### _value +### `Optional` to -• **_value**: *`BigNumber`* +• **to**? : *undefined | string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L44)* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -
+*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* -# Interface: ERC721TokenApprovalEventArgs +___ +### `Optional` value -## Index +• **value**? : *number | string | `BigNumber`* -### Properties +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -* [_approved](#_approved) -* [_owner](#_owner) -* [_tokenId](#_tokenid) +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)* -## Properties +
-### _approved -• **_approved**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L47)* -___ -### _owner +# Interface: CompilerOpts -• **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L46)* +## Properties -___ +### name -### _tokenId +• **name**: *"solc"* -• **_tokenId**: *`BigNumber`* +*Defined in [ethereum-types/src/index.ts:656](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L656)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L48)* +___ -
+### settings -# Interface: ERC721TokenApprovalForAllEventArgs +• **settings**: *[CompilerSettings](#class-compilersettings)* +*Defined in [ethereum-types/src/index.ts:658](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L658)* -## Index +___ -### Properties +### version -* [_approved](#_approved) -* [_operator](#_operator) -* [_owner](#_owner) +• **version**: *string* -## Properties +*Defined in [ethereum-types/src/index.ts:657](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L657)* -### _approved +
-• **_approved**: *boolean* +# Interface: CompilerSettings -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L54)* -___ +## Properties -### _operator +### `Optional` evmVersion -• **_operator**: *string* +• **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L53)* +*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L690)* ___ -### _owner +### `Optional` libraries -• **_owner**: *string* +• **libraries**? : *undefined | object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L52)* +*Defined in [ethereum-types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L692)* -
+___ -# Interface: ERC721TokenTransferEventArgs +### `Optional` metadata +• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* -## Index +*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L691)* -### Properties +___ -* [_from](#_from) -* [_to](#_to) -* [_tokenId](#_tokenid) +### `Optional` optimizer -## Properties +• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* -### _from +*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L689)* -• **_from**: *string* +___ + +### outputSelection -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L58)* +• **outputSelection**: *object* -___ +*Defined in [ethereum-types/src/index.ts:697](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L697)* -### _to +#### Type declaration: -• **_to**: *string* +● \[▪ **fileName**: *string*\]: object -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L59)* +● \[▪ **contractName**: *string*\]: [OutputField](#outputfield)[] ___ -### _tokenId +### `Optional` remappings -• **_tokenId**: *`BigNumber`* +• **remappings**? : *string[]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L60)* +*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L688)*
-# Interface: ExchangeAssetProxyRegisteredEventArgs +# Interface: CompilerSettingsMetadata -## Index +## Properties -### Properties +### useLiteralContent -* [assetProxy](#assetproxy) -* [id](#id) +• **useLiteralContent**: *true* -## Properties +*Defined in [ethereum-types/src/index.ts:705](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L705)* -### assetProxy +
-• **assetProxy**: *string* +# Interface: ConstructorAbi -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:57](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L57)* -___ +## Properties -### id +### inputs -• **id**: *string* +• **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:56](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L56)* +*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L103)* -
+___ -# Interface: ExchangeCancelEventArgs +### payable +• **payable**: *boolean* -## Index +*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L104)* -### Properties +___ -* [feeRecipientAddress](#feerecipientaddress) -* [makerAddress](#makeraddress) -* [makerAssetData](#makerassetdata) -* [orderHash](#orderhash) -* [senderAddress](#senderaddress) -* [takerAssetData](#takerassetdata) +### stateMutability -## Properties +• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -### feeRecipientAddress +*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L105)* -• **feeRecipientAddress**: *string* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:62](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L62)* +### type -___ +• **type**: *string* -### makerAddress +*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L102)* -• **makerAddress**: *string* +
-*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L61)* +# Interface: ContractArtifact -___ +This type defines the schema of the artifact.json file generated by Sol-compiler +schemaVersion: The version of the artifact schema +contractName: The contract name it represents +chains: Chain specific information by chain (address, id, constructor args, etc...) +compilerOutput: The Solidity compiler output generated from the specified compiler input +description (http://solidity.readthedocs.io/en/v0.4.24/using-the-compiler.html#compiler-input-and-output-json-description) +compiler: The compiler settings used +sourceCodes: The source code of the contract and all it's dependencies +sources: A mapping from source filePath to sourceMap id +sourceTreeHashHex: A unique hash generated from the contract source and that of it's dependencies. +If any of the sources change, the hash would change notifying us that a re-compilation is necessary -### makerAssetData -• **makerAssetData**: *string* +## Properties + +### chains -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L63)* +• **chains**: *[ContractChains](#class-contractchains)* + +*Defined in [ethereum-types/src/index.ts:677](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L677)* ___ -### orderHash +### compiler -• **orderHash**: *string* +• **compiler**: *[CompilerOpts](#class-compileropts)* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)* +*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L642)* ___ -### senderAddress +### compilerOutput -• **senderAddress**: *string* +• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)* +*Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* + +*Defined in [ethereum-types/src/index.ts:652](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L652)* ___ -### takerAssetData +### contractName -• **takerAssetData**: *string* +• **contractName**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)* +*Defined in [ethereum-types/src/index.ts:676](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L676)* -
+___ -# Interface: ExchangeCancelUpToEventArgs +### schemaVersion +• **schemaVersion**: *string* -## Index +*Defined in [ethereum-types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L675)* -### Properties +___ -* [makerAddress](#makeraddress) -* [orderEpoch](#orderepoch) -* [orderSenderAddress](#ordersenderaddress) +### sourceCodes -## Properties +• **sourceCodes**: *object* -### makerAddress +*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* -• **makerAddress**: *string* +*Defined in [ethereum-types/src/index.ts:648](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L648)* + +#### Type declaration: -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L70)* +● \[▪ **sourceName**: *string*\]: string ___ -### orderEpoch +### sourceTreeHashHex -• **orderEpoch**: *`BigNumber`* +• **sourceTreeHashHex**: *string* + +*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:72](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L72)* +*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L651)* ___ -### orderSenderAddress +### sources -• **orderSenderAddress**: *string* +• **sources**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:71](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L71)* +*Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* -
+*Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L643)* -# Interface: ExchangeFillEventArgs +#### Type declaration: +● \[▪ **sourceName**: *string*\]: object -## Index +
-### Properties +# Interface: ContractChainData -* [feeRecipientAddress](#feerecipientaddress) -* [makerAddress](#makeraddress) -* [makerAssetData](#makerassetdata) -* [makerAssetFilledAmount](#makerassetfilledamount) -* [makerFeeAssetData](#makerfeeassetdata) -* [makerFeePaid](#makerfeepaid) -* [orderHash](#orderhash) -* [protocolFeePaid](#protocolfeepaid) -* [senderAddress](#senderaddress) -* [takerAddress](#takeraddress) -* [takerAssetData](#takerassetdata) -* [takerAssetFilledAmount](#takerassetfilledamount) -* [takerFeeAssetData](#takerfeeassetdata) -* [takerFeePaid](#takerfeepaid) -## Properties +## Properties -### feeRecipientAddress +### address -• **feeRecipientAddress**: *string* +• **address**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:77](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L77)* +*Defined in [ethereum-types/src/index.ts:555](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L555)* ___ -### makerAddress +Args -• **makerAddress**: *string* +• **constructorArgs**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:76](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L76)* +*Defined in [ethereum-types/src/index.ts:559](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L559)* ___ -### makerAssetData +### links -• **makerAssetData**: *string* +• **links**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L78)* +*Defined in [ethereum-types/src/index.ts:556](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L556)* -___ +#### Type declaration: -### makerAssetFilledAmount +● \[▪ **linkName**: *string*\]: string -• **makerAssetFilledAmount**: *`BigNumber`* +
+ +# Interface: ContractChains -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L85)* -___ +## Hierarchy -### makerFeeAssetData +* **ContractVersionData** -• **makerFeeAssetData**: *string* + * [ContractArtifact](#class-contractartifact) -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)* -___ +## Properties -### makerFeePaid +### compiler -• **makerFeePaid**: *`BigNumber`* +• **compiler**: *[CompilerOpts](#class-compileropts)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:87](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L87)* +*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L642)* ___ -### orderHash +### compilerOutput -• **orderHash**: *string* +• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:82](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L82)* +*Defined in [ethereum-types/src/index.ts:652](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L652)* ___ -### protocolFeePaid - -• **protocolFeePaid**: *`BigNumber`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:89](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L89)* +### sourceCodes -___ +• **sourceCodes**: *object* -### senderAddress +*Defined in [ethereum-types/src/index.ts:648](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L648)* -• **senderAddress**: *string* +#### Type declaration: -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L84)* +● \[▪ **sourceName**: *string*\]: string ___ -### takerAddress +### sourceTreeHashHex -• **takerAddress**: *string* +• **sourceTreeHashHex**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:83](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L83)* +*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L651)* ___ -### takerAssetData +### sources -• **takerAssetData**: *string* +• **sources**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)* +*Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L643)* -___ +#### Type declaration: -### takerAssetFilledAmount +● \[▪ **sourceName**: *string*\]: object -• **takerAssetFilledAmount**: *`BigNumber`* +
-*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L86)* +# Interface: DataItem -___ -### takerFeeAssetData +## Properties -• **takerFeeAssetData**: *string* +### `Optional` components -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)* +• **components**? : *[DataItem](#class-dataitem)[]* -___ +*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)* -### takerFeePaid +___ -• **takerFeePaid**: *`BigNumber`* +### `Optional` internalType -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:88](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L88)* +• **internalType**? : *undefined | string* -
+*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* -# Interface: ExchangeProtocolFeeCollectorAddressEventArgs +___ +### name -## Index +• **name**: *string* -### Properties +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* -* [oldProtocolFeeCollector](#oldprotocolfeecollector) -* [updatedProtocolFeeCollector](#updatedprotocolfeecollector) +___ -## Properties +### type -### oldProtocolFeeCollector +• **type**: *string* -• **oldProtocolFeeCollector**: *string* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:93](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L93)* +
-___ +# Interface: DecodedLogArgs -### updatedProtocolFeeCollector -• **updatedProtocolFeeCollector**: *string* +## Type parameters -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:94](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L94)* +▪ **A** -
-# Interface: ExchangeProtocolFeeMultiplierEventArgs +## Properties +### address -## Index +• **address**: *string* -### Properties +*Inherited from [LogEntry](#interface-logentry).[address](#address)* -* [oldProtocolFeeMultiplier](#oldprotocolfeemultiplier) -* [updatedProtocolFeeMultiplier](#updatedprotocolfeemultiplier) +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* -## Properties +___ -### oldProtocolFeeMultiplier +### args -• **oldProtocolFeeMultiplier**: *`BigNumber`* +• **args**: *`A`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:98](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L98)* +*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* ___ -### updatedProtocolFeeMultiplier +### blockHash -• **updatedProtocolFeeMultiplier**: *`BigNumber`* +• **blockHash**: *string | null* + +*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:99](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L99)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* -
+___ -# Interface: ExchangeSignatureValidatorApprovalEventArgs +### blockNumber +• **blockNumber**: *number | null* -## Index +*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -### Properties +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* -* [isApproved](#isapproved) -* [signerAddress](#signeraddress) -* [validatorAddress](#validatoraddress) +___ -## Properties +### data -### isApproved +• **data**: *string* -• **isApproved**: *boolean* +*Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L105)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ -### signerAddress +### event -• **signerAddress**: *string* +• **event**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L103)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* ___ -### validatorAddress +### logIndex -• **validatorAddress**: *string* +• **logIndex**: *number | null* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L104)* +*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -
+*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* -# Interface: ExchangeTransactionExecutionEventArgs +___ +### topics -## Index +• **topics**: *string[]* -### Properties +*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -* [transactionHash](#transactionhash) +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* -## Properties +___ ### transactionHash • **transactionHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:109](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L109)* +*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -
+*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* -# Interface: WETH9ApprovalEventArgs +___ +### transactionIndex -## Index +• **transactionIndex**: *number | null* -### Properties +*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)* -## Properties +
-### _owner -• **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L48)* +# Interface: DevdocOutput + -___ +## Properties -### _spender +### `Optional` author -• **_spender**: *string* +• **author**? : *undefined | string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L49)* +*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L629)* ___ -### _value +### methods -• **_value**: *`BigNumber`* +• **methods**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L50)* +*Defined in [ethereum-types/src/index.ts:630](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L630)* -
+#### Type declaration: -# Interface: WETH9DepositEventArgs +● \[▪ **signature**: *string*\]: object +___ -## Index +### `Optional` title -### Properties +• **title**? : *undefined | string* -* [_owner](#_owner) -* [_value](#_value) +*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L628)* -## Properties +
-### _owner +# Interface: EIP1193Provider -• **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:60](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L60)* +## Properties -___ +### isEIP1193 -### _value +• **isEIP1193**: *boolean* -• **_value**: *`BigNumber`* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L73)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L61)* +## Methods -
+### on -# Interface: WETH9TransferEventArgs +▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L75)* -## Index +**Parameters:** -### Properties +▪ **event**: *[EIP1193Event](#eip1193event)* -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) +▪ **listener**: *function* -## Properties +▸ (`result`: any): *void* -### _from +**Parameters:** -• **_from**: *string* +Name | Type | +------ | ------ | +`result` | any | -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L54)* +**Returns:** *this* ___ -### _to - -• **_to**: *string* +### send -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L55)* +▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -___ +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L74)* -### _value +**Parameters:** -• **_value**: *`BigNumber`* +Name | Type | +------ | ------ | +`method` | string | +`params?` | any[] | -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:56](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L56)* +**Returns:** *`Promise`*
-# Interface: WETH9WithdrawalEventArgs -## Index -### Properties -* [_owner](#_owner) -* [_value](#_value) +# Interface: EvmBytecodeOutput -## Properties -### _owner +## Properties -• **_owner**: *string* +### object -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:65](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L65)* +• **object**: *string* + +*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L623)* ___ -### _value +### sourceMap -• **_value**: *`BigNumber`* +• **sourceMap**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:66](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L66)* +*Defined in [ethereum-types/src/index.ts:624](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L624)*
-# Interface: ZRXTokenApprovalEventArgs +# Interface: EvmOutput -## Index +## Properties -### Properties +### bytecode -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) +• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -## Properties +*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L618)* -### _owner +___ -• **_owner**: *string* +### deployedBytecode -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L48)* +• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -___ +*Defined in [ethereum-types/src/index.ts:619](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L619)* -### _spender +
-• **_spender**: *string* +# Interface: FallbackAbi -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L49)* -___ +## Properties -### _value +### payable -• **_value**: *`BigNumber`* +• **payable**: *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L50)* +*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L112)* -
+___ -# Interface: ZRXTokenTransferEventArgs +### type +• **type**: *string* -## Index +*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L111)* -### Properties +
-* [_from](#_from) -* [_to](#_to) -* [_value](#_value) -## Properties -### _from +# Interface: GanacheProvider -• **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L42)* +## Methods -___ +### sendAsync -### _to +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -• **_to**: *string* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L14)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L43)* +**Parameters:** -___ +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | -### _value +**Returns:** *void* -• **_value**: *`BigNumber`* +
-*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L44)* -
-# Interface: ContractAddresses +# Interface: JSONRPCRequestPayload ## Properties -### assetProxyOwner +### id -• **assetProxyOwner**: *string* +• **id**: *number* -*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L12)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* ___ -### coordinator +### jsonrpc -• **coordinator**: *string* +• **jsonrpc**: *string* -*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L18)* +*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* ___ -### coordinatorRegistry +### method -• **coordinatorRegistry**: *string* +• **method**: *string* -*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L17)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* ___ -### devUtils - -• **devUtils**: *string* +### params -*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L22)* +• **params**: *any[]* -___ +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)* -### dutchAuction +
-• **dutchAuction**: *string* +# Interface: JSONRPCResponseError -*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L16)* -___ +## Properties -### erc1155Proxy +### code -• **erc1155Proxy**: *string* +• **code**: *number* -*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L21)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* ___ -### erc20BridgeProxy +### message -• **erc20BridgeProxy**: *string* +• **message**: *string* -*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L26)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)* -___ +
-### erc20Proxy +# Interface: JSONRPCResponsePayload -• **erc20Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L6)* +## Properties + +### `Optional` error + +• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* + +*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* ___ -### erc721Proxy +### id -• **erc721Proxy**: *string* +• **id**: *number* -*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L7)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* ___ -### etherToken +### jsonrpc -• **etherToken**: *string* +• **jsonrpc**: *string* -*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* + +___ + +### result -___ +• **result**: *any* -### exchange +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)* -• **exchange**: *string* +
-*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L11)* -___ -### exchangeV2 -• **exchangeV2**: *string* -*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L10)* +# Interface: LogWithDecodedArgs <**ArgsType**> -___ +## Type parameters -### forwarder +▪ **ArgsType**: *[DecodedLogArgs](#class-decodedlogargs)* -• **forwarder**: *string* -*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L14)* +## Properties -___ +### address -### multiAssetProxy +• **address**: *string* -• **multiAssetProxy**: *string* +*Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L19)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ -### orderValidator +### args -• **orderValidator**: *string* +• **args**: *`ArgsType`* + +*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L15)* +*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* ___ -### staking +### blockHash -• **staking**: *string* +• **blockHash**: *string | null* + +*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L24)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ -### stakingProxy +### blockNumber -• **stakingProxy**: *string* +• **blockNumber**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L25)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ -### staticCallProxy +### data -• **staticCallProxy**: *string* +• **data**: *string* + +*Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L20)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ -### zeroExGovernor +### event -• **zeroExGovernor**: *string* +• **event**: *string* + +*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L13)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* ___ -### zrxToken +### logIndex -• **zrxToken**: *string* +• **logIndex**: *number | null* + +*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L8)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ -### zrxVault +### topics -• **zrxVault**: *string* +• **topics**: *string[]* + +*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L23)* +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* -
+___ +### transactionHash +• **transactionHash**: *string* -# Interface: BlockRange +*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* -## Properties +___ -### fromBlock +### transactionIndex -• **fromBlock**: *[BlockParam](#blockparam)* +• **transactionIndex**: *number | null* -*Defined in [ethereum-types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L740)* +*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -___ +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)* -### toBlock +
-• **toBlock**: *[BlockParam](#blockparam)* +# Interface: MethodAbi -*Defined in [ethereum-types/src/index.ts:741](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L741)* -
+## Properties +### constant +• **constant**: *boolean* +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L94)* +___ -# Interface: CallData +### inputs +• **inputs**: *[DataItem](#class-dataitem)[]* -## Properties +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L92)* -### `Optional` data +___ -• **data**? : *undefined | string* +### name -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* +• **name**: *string* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L91)* ___ -### `Optional` from +### outputs -• **from**? : *undefined | string* +• **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L402)* +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L93)* ___ -### `Optional` gas - -• **gas**? : *number | string | `BigNumber`* +### payable -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* +• **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L96)* ___ -### `Optional` gasPrice - -• **gasPrice**? : *number | string | `BigNumber`* +### stateMutability -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* +• **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L95)* ___ -### `Optional` nonce +### type -• **nonce**? : *undefined | number* +• **type**: *string* -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L90)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +
-___ +# Interface: OptimizerSettings -### `Optional` to -• **to**? : *undefined | string* +## Properties -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* +### enabled -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +• **enabled**: *boolean* -___ +*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L709)* -### `Optional` value +___ -• **value**? : *number | string | `BigNumber`* +### `Optional` runs -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* +• **runs**? : *undefined | number* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:710](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L710)*
@@ -11175,133 +5274,116 @@ ___ -# Interface: CompilerOpts +# Interface: RevertErrorAbi ## Properties -### name +### `Optional` arguments -• **name**: *"solc"* +• **arguments**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:655](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L655)* +*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L122)* ___ -### settings +### name -• **settings**: *[CompilerSettings](#class-compilersettings)* +• **name**: *string* -*Defined in [ethereum-types/src/index.ts:657](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L657)* +*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L121)* ___ -### version +### type -• **version**: *string* +• **type**: *"error"* -*Defined in [ethereum-types/src/index.ts:656](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L656)* +*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L120)*
-# Interface: CompilerSettings - - -## Properties -### `Optional` evmVersion -• **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"* -*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L689)* -___ -### `Optional` libraries -• **libraries**? : *undefined | object* +# Interface: StandardContractOutput -*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L691)* -___ +## Properties -### `Optional` metadata +### abi -• **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* +• **abi**: *[ContractAbi](#contractabi)* -*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L690)* +*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L565)* ___ -### `Optional` optimizer +### `Optional` devdoc -• **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* +• **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L688)* +*Defined in [ethereum-types/src/index.ts:567](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L567)* ___ -### outputSelection +### evm -• **outputSelection**: *object* +• **evm**: *[EvmOutput](#class-evmoutput)* -*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L696)* +*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L566)* -#### Type declaration: +
-● \[▪ **fileName**: *string*\]: object -● \[▪ **contractName**: *string*\]: [OutputField](#outputfield)[] -___ -### `Optional` remappings -• **remappings**? : *string[]* -*Defined in [ethereum-types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L687)* -
-# Interface: CompilerSettingsMetadata -## Properties -### useLiteralContent -• **useLiteralContent**: *true* -*Defined in [ethereum-types/src/index.ts:704](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L704)* -
-# Interface: ConstructorAbi +# Interface: TupleDataItem ## Properties -### inputs +### components -• **inputs**: *[DataItem](#class-dataitem)[]* +• **components**: *[DataItem](#class-dataitem)[]* + +*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L103)* +*Defined in [ethereum-types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L142)* ___ -### payable +### `Optional` internalType -• **payable**: *boolean* +• **internalType**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L104)* +*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ -### stateMutability +### name -• **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* +• **name**: *string* + +*Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L105)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -11309,1243 +5391,1366 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L102)* +*Inherited from [DataItem](#interface-dataitem).[type](#type)* -
+*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)* -# Interface: ContractArtifact +
-This type defines the schema of the artifact.json file generated by Sol-compiler -schemaVersion: The version of the artifact schema -contractName: The contract name it represents -chains: Chain specific information by chain (address, id, constructor args, etc...) -compilerOutput: The Solidity compiler output generated from the specified compiler input -description (http://solidity.readthedocs.io/en/v0.4.24/using-the-compiler.html#compiler-input-and-output-json-description) -compiler: The compiler settings used -sourceCodes: The source code of the contract and all it's dependencies -sources: A mapping from source filePath to sourceMap id -sourceTreeHashHex: A unique hash generated from the contract source and that of it's dependencies. -If any of the sources change, the hash would change notifying us that a re-compilation is necessary +# Interface: TxData ## Properties -### chains +### `Optional` data -• **chains**: *[ContractChains](#class-contractchains)* +• **data**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:676](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L676)* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -___ +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* -### compiler +___ -• **compiler**: *[CompilerOpts](#class-compileropts)* +### from -*Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)* +• **from**: *string* -*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L641)* +*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* ___ -### compilerOutput +### `Optional` gas -• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* +• **gas**? : *number | string | `BigNumber`* -*Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L651)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* ___ -### contractName - -• **contractName**: *string* - -*Defined in [ethereum-types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L675)* - -___ +### `Optional` gasPrice -### schemaVersion +• **gasPrice**? : *number | string | `BigNumber`* -• **schemaVersion**: *string* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:674](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L674)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ -### sourceCodes - -• **sourceCodes**: *object* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* +### `Optional` nonce -*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L647)* +• **nonce**? : *undefined | number* -#### Type declaration: +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -● \[▪ **sourceName**: *string*\]: string +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ -### sourceTreeHashHex +### `Optional` to -• **sourceTreeHashHex**: *string* +• **to**? : *undefined | string* -*Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L650)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ -### sources - -• **sources**: *object* - -*Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* +### `Optional` value -*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L642)* +• **value**? : *number | string | `BigNumber`* -#### Type declaration: +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -● \[▪ **sourceName**: *string*\]: object +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)*
-# Interface: ContractChainData +# Interface: TxDataPayable ## Properties -### address - -• **address**: *string* - -*Defined in [ethereum-types/src/index.ts:554](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L554)* - -___ +### `Optional` data -Args +• **data**? : *undefined | string* -• **constructorArgs**: *string* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:558](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L558)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ -### links - -• **links**: *object* - -*Defined in [ethereum-types/src/index.ts:555](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L555)* +### from -#### Type declaration: +• **from**: *string* -● \[▪ **linkName**: *string*\]: string +*Inherited from [TxData](#interface-txdata).[from](#from)* -
+*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* -# Interface: ContractChains +___ +### `Optional` gas -## Hierarchy +• **gas**? : *number | string | `BigNumber`* -* **ContractVersionData** +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* - * [ContractArtifact](#class-contractartifact) +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* +___ -## Properties +### `Optional` gasPrice -### compiler +• **gasPrice**? : *number | string | `BigNumber`* -• **compiler**: *[CompilerOpts](#class-compileropts)* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L641)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ -### compilerOutput +### `Optional` nonce -• **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* +• **nonce**? : *undefined | number* -*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L651)* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -___ +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* -### sourceCodes +___ -• **sourceCodes**: *object* +### `Optional` to -*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L647)* +• **to**? : *undefined | string* -#### Type declaration: +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -● \[▪ **sourceName**: *string*\]: string +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ -### sourceTreeHashHex - -• **sourceTreeHashHex**: *string* +### `Optional` value -*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L650)* +• **value**? : *`BigNumber`* -___ +*Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)* -### sources +*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L443)* -• **sources**: *object* +
-*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L642)* +# Interface: Web3JsV1Provider -#### Type declaration: +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. -● \[▪ **sourceName**: *string*\]: object -
+## Methods -# Interface: DataItem +### send +▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* -## Properties +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L45)* -### `Optional` components +**Parameters:** -• **components**? : *[DataItem](#class-dataitem)[]* +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L137)* +**Returns:** *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* ___ -### name - -• **name**: *string* +### sendAsync -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -___ +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L44)* -### type +**Parameters:** -• **type**: *string* +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +**Returns:** *void*
-# Interface: DecodedLogArgs +# 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 -## Type parameters -▪ **A** +## Methods +### send -## Properties +▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -### address +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L54)* -• **address**: *string* +**Parameters:** -*Inherited from [LogEntry](#interface-logentry).[address](#address)* +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +**Returns:** *void* -___ +
-### args +# Interface: Web3JsV3Provider -• **args**: *`A`* +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. -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L417)* -___ +## Methods -### blockHash +### send -• **blockHash**: *string | null* +▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L63)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +**Parameters:** -___ +Name | Type | +------ | ------ | +`method` | string | +`params?` | any[] | -### blockNumber +**Returns:** *`Promise`* -• **blockNumber**: *number | null* +
-*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* +# Interface: ZeroExProvider -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +The interface for the provider used internally by 0x libraries +Any property we use from any SupportedProvider should we explicitly +add here -___ -### data +## Properties -• **data**: *string* +### `Optional` isMetaMask -*Inherited from [LogEntry](#interface-logentry).[data](#data)* +• **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L31)* ___ -### event +### `Optional` isParity -• **event**: *string* +• **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L416)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L32)* ___ -### logIndex - -• **logIndex**: *number | null* +### `Optional` isZeroExProvider -*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* +• **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L30)* -___ +## Methods -### topics +### `Optional` enable -• **topics**: *string[]* +▸ **enable**(): *`Promise`* -*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L34)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +**Returns:** *`Promise`* ___ -### transactionHash - -• **transactionHash**: *string* +### sendAsync -*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L35)* -___ +**Parameters:** -### transactionIndex +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | -• **transactionIndex**: *number | null* +**Returns:** *void* -*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* +___ -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +### `Optional` stop -
+▸ **stop**(): *void* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L33)* +**Returns:** *void* -# Interface: DevdocOutput +
-## Properties -### `Optional` author -• **author**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L628)* +# Class: DevUtilsContract -___ -### methods +## Constructors -• **methods**: *object* -*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L629)* -#### Type declaration: +\+ **new DevUtilsContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DevUtilsContract](#class-devutilscontract)* -● \[▪ **signature**: *string*\]: object +*Overrides void* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3929](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3929)* -### `Optional` title +**Parameters:** -• **title**? : *undefined | string* +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | DevUtilsContract.deployedBytecode | -*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L627)* +**Returns:** *[DevUtilsContract](#class-devutilscontract)* -
+## Properties -# Interface: EIP1193Provider +### `Optional` _deployedBytecodeIfExists +• **_deployedBytecodeIfExists**? : *`Buffer`* -## Properties -### isEIP1193 -• **isEIP1193**: *boolean* +Defined in base-contract/lib/src/index.d.ts:32 -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L73)* +___ -## Methods +### abi -### on +• **abi**: *[ContractAbi](#contractabi)* -▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L75)* -**Parameters:** +Defined in base-contract/lib/src/index.d.ts:28 -▪ **event**: *[EIP1193Event](#eip1193event)* +___ -▪ **listener**: *function* +### address -▸ (`result`: any): *void* +• **address**: *string* -**Parameters:** -Name | Type | ------- | ------ | -`result` | any | -**Returns:** *this* +Defined in base-contract/lib/src/index.d.ts:29 ___ -### send - -▸ **send**(`method`: string, `params?`: any[]): *`Promise`* +Args -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L74)* +• **constructorArgs**: *any[]* -**Parameters:** -Name | Type | ------- | ------ | -`method` | string | -`params?` | any[] | -**Returns:** *`Promise`* +Defined in base-contract/lib/src/index.d.ts:31 -
+___ +### contractName +• **contractName**: *string* -# Interface: EvmBytecodeOutput +Defined in base-contract/lib/src/index.d.ts:30 +## Methods -## Properties +### decodeAssetProxyDispatchError -### object +▸ **decodeAssetProxyDispatchError**(`encoded`: string): *`ContractFunctionObj<[number, string, string]>`* -• **object**: *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1516](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1516)* -*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L622)* +Decompose an ABI-encoded AssetProxyDispatchError. -___ +**Parameters:** -### sourceMap +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -• **sourceMap**: *string* +**Returns:** *`ContractFunctionObj<[number, string, string]>`* -*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L623)* +errorCode The error code.orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched. -
+___ -# Interface: EvmOutput +### decodeAssetProxyExistsError +▸ **decodeAssetProxyExistsError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* -## Properties +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1564](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1564)* -### bytecode +Decompose an ABI-encoded AssetProxyExistsError. -• **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* +**Parameters:** -*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L617)* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -___ +**Returns:** *`ContractFunctionObj<[string, string]>`* -### deployedBytecode +assetProxyId Id of asset proxy.assetProxyAddress The address of the asset proxy. -• **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* +___ -*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L618)* +### decodeAssetProxyId -
+▸ **decodeAssetProxyId**(`assetData`: string): *`ContractFunctionObj`* -# Interface: FallbackAbi +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1610](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1610)* +Decode AssetProxy identifier -## Properties +**Parameters:** -### payable +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-20, ERC- 721, ERC1155, or MultiAsset asset. | -• **payable**: *boolean* +**Returns:** *`ContractFunctionObj`* -*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L112)* +The AssetProxy identifier ___ -### type +### decodeAssetProxyTransferError -• **type**: *string* +▸ **decodeAssetProxyTransferError**(`encoded`: string): *`ContractFunctionObj<[string, string, string]>`* -*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L111)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1653](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1653)* -
+Decompose an ABI-encoded AssetProxyTransferError. +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -# Interface: GanacheProvider +**Returns:** *`ContractFunctionObj<[string, string, string]>`* +orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched.errorData ABI-encoded revert data from the asset proxy. -## Methods +___ -### sendAsync +### decodeEIP1271SignatureError -▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* +▸ **decodeEIP1271SignatureError**(`encoded`: string): *`ContractFunctionObj<[string, string, string, string]>`* -*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L14)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1701](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1701)* + +Decompose an ABI-encoded SignatureValidatorError. **Parameters:** -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -**Returns:** *void* +**Returns:** *`ContractFunctionObj<[string, string, string, string]>`* -
+signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. +___ +### decodeERC1155AssetData -# Interface: JSONRPCRequestPayload +▸ **decodeERC1155AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, BigNumber[], BigNumber[], string]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1750](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1750)* -## Properties +Decode ERC-1155 asset data from the format described in the AssetProxy contract specification. -### id +**Parameters:** -• **id**: *number* +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-1155 set of assets. | + +**Returns:** *`ContractFunctionObj<[string, string, BigNumber[], BigNumber[], string]>`* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)* +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`. ___ -### jsonrpc +### decodeERC20AssetData -• **jsonrpc**: *string* +▸ **decodeERC20AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string]>`* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1802](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1802)* -___ +Decode ERC-20 asset data from the format described in the AssetProxy contract specification. -### method +**Parameters:** -• **method**: *string* +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-20 asset. | + +**Returns:** *`ContractFunctionObj<[string, string]>`* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)* +The AssetProxy identifier, and the address of the ERC-20 contract hosting this asset. ___ -### params +### decodeERC721AssetData -• **params**: *any[]* +▸ **decodeERC721AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, BigNumber]>`* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1848](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1848)* -
+Decode ERC-721 asset data from the format described in the AssetProxy contract specification. -# Interface: JSONRPCResponseError +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-721 asset. | -## Properties +**Returns:** *`ContractFunctionObj<[string, string, BigNumber]>`* -### code +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. -• **code**: *number* +___ + +### decodeExchangeInvalidContextError -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)* +▸ **decodeExchangeInvalidContextError**(`encoded`: string): *`ContractFunctionObj<[number, string, string]>`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1896](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1896)* -### message +Decompose an ABI-encoded OrderStatusError. -• **message**: *string* +**Parameters:** -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -
+**Returns:** *`ContractFunctionObj<[number, string, string]>`* -# Interface: JSONRPCResponsePayload +errorCode Error code that corresponds to invalid maker, taker, or sender.orderHash The order hash.contextAddress The maker, taker, or sender address +___ -## Properties +### decodeFillError -### `Optional` error +▸ **decodeFillError**(`encoded`: string): *`ContractFunctionObj<[number, string]>`* -• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1945](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1945)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)* +Decompose an ABI-encoded FillError. -___ +**Parameters:** -### id +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -• **id**: *number* +**Returns:** *`ContractFunctionObj<[number, string]>`* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)* +errorCode The error code.orderHash The order hash. ___ -### jsonrpc +### decodeIncompleteFillError -• **jsonrpc**: *string* +▸ **decodeIncompleteFillError**(`encoded`: string): *`ContractFunctionObj<[number, BigNumber, BigNumber]>`* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1988](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1988)* -___ +Decompose an ABI-encoded IncompleteFillError. -### result +**Parameters:** -• **result**: *any* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)* +**Returns:** *`ContractFunctionObj<[number, BigNumber, BigNumber]>`* -
+orderHash Hash of the order being filled. +___ +### decodeMultiAssetData +▸ **decodeMultiAssetData**(`assetData`: string): *`ContractFunctionObj<[string, BigNumber[], string[]]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2036](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2036)* -# Interface: LogWithDecodedArgs <**ArgsType**> +Decode multi-asset data from the format described in the AssetProxy contract specification. -## Type parameters +**Parameters:** -▪ **ArgsType**: *[DecodedLogArgs](#class-decodedlogargs)* +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant data describing a multi-asset basket. | +**Returns:** *`ContractFunctionObj<[string, BigNumber[], string[]]>`* -## Properties +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. -### address +___ -• **address**: *string* +### decodeNegativeSpreadError -*Inherited from [LogEntry](#interface-logentry).[address](#address)* +▸ **decodeNegativeSpreadError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2084](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2084)* -___ +Decompose an ABI-encoded NegativeSpreadError. -### args +**Parameters:** -• **args**: *`ArgsType`* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* +**Returns:** *`ContractFunctionObj<[string, string]>`* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L417)* +leftOrderHash Hash of the left order being matched.rightOrderHash Hash of the right order being matched. ___ -### blockHash - -• **blockHash**: *string | null* +### decodeOrderEpochError -*Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* +▸ **decodeOrderEpochError**(`encoded`: string): *`ContractFunctionObj<[string, string, BigNumber]>`* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2129](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2129)* -___ +Decompose an ABI-encoded OrderEpochError. -### blockNumber +**Parameters:** -• **blockNumber**: *number | null* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -*Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* +**Returns:** *`ContractFunctionObj<[string, string, BigNumber]>`* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +makerAddress The order maker.orderSenderAddress The order sender.currentEpoch The current epoch for the maker. ___ -### data - -• **data**: *string* +### decodeOrderStatusError -*Inherited from [LogEntry](#interface-logentry).[data](#data)* +▸ **decodeOrderStatusError**(`encoded`: string): *`ContractFunctionObj<[string, number]>`* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2177)* -___ +Decompose an ABI-encoded OrderStatusError. -### event +**Parameters:** -• **event**: *string* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -*Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* +**Returns:** *`ContractFunctionObj<[string, number]>`* -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L416)* +orderHash The order hash.orderStatus The order status. ___ -### logIndex - -• **logIndex**: *number | null* +### decodeSignatureError -*Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* +▸ **decodeSignatureError**(`encoded`: string): *`ContractFunctionObj<[number, string, string, string]>`* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2222](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2222)* -___ +Decompose an ABI-encoded SignatureError. -### topics +**Parameters:** -• **topics**: *string[]* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -*Inherited from [LogEntry](#interface-logentry).[topics](#topics)* +**Returns:** *`ContractFunctionObj<[number, string, string, string]>`* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +errorCode The error code.signerAddress The expected signer of the hash.signature The full signature. ___ -### transactionHash +### decodeSignatureValidatorNotApprovedError -• **transactionHash**: *string* +▸ **decodeSignatureValidatorNotApprovedError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* -*Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2268](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2268)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +Decompose an ABI-encoded SignatureValidatorNotApprovedError. -___ +**Parameters:** -### transactionIndex +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -• **transactionIndex**: *number | null* +**Returns:** *`ContractFunctionObj<[string, string]>`* -*Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* +signerAddress The expected signer of the hash.validatorAddress The expected validator. -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +___ -
+### decodeSignatureWalletError -# Interface: MethodAbi +▸ **decodeSignatureWalletError**(`encoded`: string): *`ContractFunctionObj<[string, string, string, string]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2316](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2316)* -## Properties +Decompose an ABI-encoded SignatureWalletError. -### constant +**Parameters:** -• **constant**: *boolean* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *`ContractFunctionObj<[string, string, string, string]>`* -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L94)* +errorCode The error code.signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. ___ -### inputs +### decodeStaticCallAssetData -• **inputs**: *[DataItem](#class-dataitem)[]* +▸ **decodeStaticCallAssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, string, string]>`* -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L92)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2365](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2365)* -___ +Decode StaticCall asset data from the format described in the AssetProxy contract specification. -### name +**Parameters:** -• **name**: *string* +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing a StaticCall asset | + +**Returns:** *`ContractFunctionObj<[string, string, string, string]>`* -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L91)* +The StaticCall AssetProxy identifier, the target address of the StaticCAll, the data to be passed to the target address, and the expected Keccak-256 hash of the static call return data. ___ -### outputs +### decodeTransactionError -• **outputs**: *[DataItem](#class-dataitem)[]* +▸ **decodeTransactionError**(`encoded`: string): *`ContractFunctionObj<[number, string]>`* -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L93)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2413](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2413)* -___ +Decompose an ABI-encoded TransactionError. -### payable +**Parameters:** -• **payable**: *boolean* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L96)* +**Returns:** *`ContractFunctionObj<[number, string]>`* -___ +errorCode The error code.transactionHash Hash of the transaction. -### stateMutability +___ -• **stateMutability**: *[StateMutability](#statemutability)* +### decodeTransactionExecutionError -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L95)* +▸ **decodeTransactionExecutionError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2458)* -### type +Decompose an ABI-encoded TransactionExecutionError. -• **type**: *string* +**Parameters:** -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L90)* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -
+**Returns:** *`ContractFunctionObj<[string, string]>`* -# Interface: OptimizerSettings +transactionHash Hash of the transaction.errorData Error thrown by exeucteTransaction(). +___ -## Properties +### decodeZeroExTransactionData -### enabled +▸ **decodeZeroExTransactionData**(`transactionData`: string): *`ContractFunctionObj<[string, Array, BigNumber[], string[]]>`* -• **enabled**: *boolean* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2505](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2505)* -*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L708)* +Decodes the call data for an Exchange contract method call. -___ +**Parameters:** -### `Optional` runs +Name | Type | Description | +------ | ------ | ------ | +`transactionData` | string | ABI-encoded calldata for an Exchange contract method call. | -• **runs**? : *undefined | number* +**Returns:** *`ContractFunctionObj<[string, Array, BigNumber[], string[]]>`* -*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L709)* +The name of the function called, and the parameters it was given. For single-order fills and cancels, the arrays will have just one element. -
+___ +### encodeERC1155AssetData +▸ **encodeERC1155AssetData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *`ContractFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2628)* +Encode ERC-1155 asset data into the format described in the AssetProxy contract specification. -# Interface: RevertErrorAbi +**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. | -## Properties +**Returns:** *`ContractFunctionObj`* -### `Optional` arguments +AssetProxy-compliant asset data describing the set of assets. -• **arguments**? : *[DataItem](#class-dataitem)[]* +___ -*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L122)* +### encodeERC20AssetData -___ +▸ **encodeERC20AssetData**(`tokenAddress`: string): *`ContractFunctionObj`* -### name +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2686](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2686)* -• **name**: *string* +Encode ERC-20 asset data into the format described in the AssetProxy contract specification. -*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L121)* +**Parameters:** -___ +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | The address of the ERC-20 contract hosting the asset to be traded. | -### type +**Returns:** *`ContractFunctionObj`* -• **type**: *"error"* +AssetProxy-compliant data describing the asset. -*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L120)* +___ -
+### encodeERC721AssetData +▸ **encodeERC721AssetData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *`ContractFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2735](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2735)* +Encode ERC-721 asset data into the format described in the AssetProxy specification. +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | The address of the ERC-721 contract hosting the asset to be traded. | +`tokenId` | `BigNumber` | The identifier of the specific asset to be traded. | +**Returns:** *`ContractFunctionObj`* -# Interface: StandardContractOutput +AssetProxy-compliant asset data describing the asset. +___ -## Properties +### encodeMultiAssetData -### abi +▸ **encodeMultiAssetData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *`ContractFunctionObj`* -• **abi**: *[ContractAbi](#contractabi)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2787](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2787)* -*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L564)* +Encode data for multiple assets, per the AssetProxy contract specification. -___ +**Parameters:** -### `Optional` devdoc +Name | Type | Description | +------ | ------ | ------ | +`amounts` | `BigNumber`[] | The amounts of each asset to be traded. | +`nestedAssetData` | string[] | AssetProxy-compliant data describing each asset to be traded. | -• **devdoc**? : *[DevdocOutput](#class-devdocoutput)* +**Returns:** *`ContractFunctionObj`* -*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L566)* +AssetProxy-compliant data describing the set of assets. ___ -### evm +### encodeStaticCallAssetData -• **evm**: *[EvmOutput](#class-evmoutput)* +▸ **encodeStaticCallAssetData**(`staticCallTargetAddress`: string, `staticCallData`: string, `expectedReturnDataHash`: string): *`ContractFunctionObj`* -*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L565)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2841](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2841)* -
+Encode StaticCall asset data into the format described in the AssetProxy contract specification. +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`staticCallTargetAddress` | string | Target address of StaticCall. | +`staticCallData` | string | Data that will be passed to staticCallTargetAddress in the StaticCall. | +`expectedReturnDataHash` | string | Expected Keccak-256 hash of the StaticCall return data. | +**Returns:** *`ContractFunctionObj`* +AssetProxy-compliant asset data describing the set of assets. +___ +### getABIDecodedReturnData +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1497](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1497)* +**Type parameters:** +▪ **T** +**Parameters:** +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | +**Returns:** *`T`* +___ +### getABIDecodedTransactionData -# Interface: TupleDataItem +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1490](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1490)* -## Properties +**Type parameters:** -### components +▪ **T** -• **components**: *[DataItem](#class-dataitem)[]* +**Parameters:** -*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L141)* +**Returns:** *`T`* ___ -### name +### getAssetProxyAllowance -• **name**: *string* +▸ **getAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj`* -*Inherited from [DataItem](#interface-dataitem).[name](#name)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2899](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2899)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +Returns the number of asset(s) (described by assetData) that the corresponding AssetProxy contract is authorized to spend. When the asset data contains multiple assets (eg for Multi-Asset), the return value indicates how many complete "baskets" of those assets may be spent by all of the corresponding AssetProxy contracts. -___ +**Parameters:** -### type +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | -• **type**: *string* +**Returns:** *`ContractFunctionObj`* -*Inherited from [DataItem](#interface-dataitem).[type](#type)* +Number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +___ -
+### getBalance -# Interface: TxData +▸ **getBalance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2961](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2961)* -## Properties +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. -### `Optional` data +**Parameters:** -• **data**? : *undefined | string* +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* +**Returns:** *`ContractFunctionObj`* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +Number of assets (or asset baskets) held by owner. ___ -### from +### getBalanceAndAssetProxyAllowance -• **from**: *string* +▸ **getBalanceAndAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj<[BigNumber, BigNumber]>`* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L398)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3023](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3023)* -___ +Calls getBalance() and getAllowance() for assetData. -### `Optional` gas +**Parameters:** -• **gas**? : *number | string | `BigNumber`* +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* +**Returns:** *`ContractFunctionObj<[BigNumber, BigNumber]>`* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +Number of assets (or asset baskets) held by owner, and number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. ___ -### `Optional` gasPrice - -• **gasPrice**? : *number | string | `BigNumber`* +### getBatchAssetProxyAllowances -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* +▸ **getBatchAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj`* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3091](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3091)* -___ +Calls getAssetProxyAllowance() for each element of assetData. -### `Optional` nonce +**Parameters:** -• **nonce**? : *undefined | number* +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. | -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* +**Returns:** *`ContractFunctionObj`* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +An array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. ___ -### `Optional` to +### getBatchBalances -• **to**? : *undefined | string* +▸ **getBatchBalances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj`* -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3153)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +Calls getBalance() for each element of assetData. -___ +**Parameters:** -### `Optional` value +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. | -• **value**? : *number | string | `BigNumber`* +**Returns:** *`ContractFunctionObj`* -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* +Array of asset balances from getBalance(), with each element corresponding to the same-indexed element in the assetData input. -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L390)* +___ -
+### getBatchBalancesAndAssetProxyAllowances -# Interface: TxDataPayable +▸ **getBatchBalancesAndAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3215)* -## Properties +Calls getBatchBalances() and getBatchAllowances() for each element of assetData. -### `Optional` data +**Parameters:** -• **data**? : *undefined | string* +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. | -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* +**Returns:** *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +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. ___ -### from - -• **from**: *string* +### getEthBalances -*Inherited from [TxData](#interface-txdata).[from](#from)* +▸ **getEthBalances**(`addresses`: string[]): *`ContractFunctionObj`* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L398)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3281](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3281)* -___ +Batch fetches ETH balances -### `Optional` gas +**Parameters:** -• **gas**? : *number | string | `BigNumber`* +Name | Type | Description | +------ | ------ | ------ | +`addresses` | string[] | Array of addresses. | -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* +**Returns:** *`ContractFunctionObj`* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +Array of ETH balances. ___ -### `Optional` gasPrice +### getFunctionSignature -• **gasPrice**? : *number | string | `BigNumber`* +▸ **getFunctionSignature**(`methodName`: string): *string* -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1484)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +**Parameters:** -___ +Name | Type | +------ | ------ | +`methodName` | string | -### `Optional` nonce +**Returns:** *string* -• **nonce**? : *undefined | number* +___ -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* +### getOrderRelevantState -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +▸ **getOrderRelevantState**(`order`: object, `signature`: string): *`ContractFunctionObj<[object, BigNumber, boolean]>`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3337)* -### `Optional` to +Fetches all order-relevant information needed to validate if the supplied order is fillable. -• **to**? : *undefined | string* +**Parameters:** -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* +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. | -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +**Returns:** *`ContractFunctionObj<[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. ___ -### `Optional` value +### getOrderRelevantStates -• **value**? : *`BigNumber`* +▸ **getOrderRelevantStates**(`orders`: `Array`, `signatures`: string[]): *`ContractFunctionObj<[Array, BigNumber[], boolean[]]>`* -*Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3433)* -*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L442)* +Fetches all order-relevant information needed to validate if the supplied orders are fillable. -
+**Parameters:** -# Interface: Web3JsV1Provider +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. | -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. +**Returns:** *`ContractFunctionObj<[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. -## Methods +___ -### send +### getSelector -▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* +▸ **getSelector**(`methodName`: string): *string* -*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L45)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1504](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1504)* **Parameters:** Name | Type | ------ | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`methodName` | string | -**Returns:** *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* +**Returns:** *string* ___ -### sendAsync - -▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* +### getSimulatedOrderTransferResults -*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L44)* +▸ **getSimulatedOrderTransferResults**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *`ContractTxFunctionObj`* -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3537](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3537)* -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | +Simulates all of the transfers within an order and returns the index of the first failed transfer. -**Returns:** *void* +**Parameters:** -
+Name | Type | Description | +------ | ------ | ------ | +`order` | object | The order to simulate transfers for. | +`takerAddress` | string | The address of the taker that will fill the order. | +`takerAssetFillAmount` | `BigNumber` | The amount of takerAsset that the taker wished to fill. | -# Interface: Web3JsV2Provider +**Returns:** *`ContractTxFunctionObj`* -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 +The index of the first failed transfer (or 4 if all transfers are successful). +___ -## Methods +### getSimulatedOrdersTransferResults -### send +▸ **getSimulatedOrdersTransferResults**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[]): *`ContractTxFunctionObj`* -▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3687](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3687)* -*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L54)* +Simulates all of the transfers for each given order and returns the indices of each first failed transfer. **Parameters:** -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | - -**Returns:** *void* - -
+Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of orders to individually simulate transfers for. | +`takerAddresses` | string[] | Array of addresses of takers that will fill each order. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of amounts of takerAsset that will be filled for each order. | -# Interface: Web3JsV3Provider +**Returns:** *`ContractTxFunctionObj`* -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. +The indices of the first failed transfer (or 4 if all transfers are successful) for each order. +___ -## Methods +### getTransferableAssetAmount -### send +▸ **getTransferableAssetAmount**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj`* -▸ **send**(`method`: string, `params?`: any[]): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3835](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3835)* -*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L63)* +Gets the amount of an asset transferable by the owner. **Parameters:** -Name | Type | ------- | ------ | -`method` | string | -`params?` | any[] | +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Address of the owner of the asset. | +`assetData` | string | Description of tokens, per the AssetProxy contract specification. | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -
+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`. -# Interface: ZeroExProvider +___ -The interface for the provider used internally by 0x libraries -Any property we use from any SupportedProvider should we explicitly -add here +### revertIfInvalidAssetData +▸ **revertIfInvalidAssetData**(`assetData`: string): *`ContractFunctionObj`* -## Properties +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3890](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3890)* -### `Optional` isMetaMask +**Parameters:** -• **isMetaMask**? : *undefined | false | true* +Name | Type | +------ | ------ | +`assetData` | string | -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L31)* +**Returns:** *`ContractFunctionObj`* ___ -### `Optional` isParity +### `Static` ABI -• **isParity**? : *undefined | false | true* +▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L32)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:125](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L125)* -___ +**Returns:** *[ContractAbi](#contractabi)* -### `Optional` isZeroExProvider +The contract ABI -• **isZeroExProvider**? : *undefined | false | true* +___ -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L30)* +### `Static` deployAsync -## Methods +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* -### `Optional` enable +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L78)* -▸ **enable**(): *`Promise`* +**Parameters:** -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L34)* +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ -### sendAsync +### `Static` deployFrom0xArtifactAsync -▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* -*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L35)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L45)* **Parameters:** Name | Type | ------ | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | -**Returns:** *void* +**Returns:** *`Promise`* ___ -### `Optional` stop - -▸ **stop**(): *void* - -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L33)* +### `Static` strictArgumentEncodingCheck -**Returns:** *void* +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -
+Defined in base-contract/lib/src/index.d.ts:42 +**Parameters:** +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | +**Returns:** *string* +
# Interface: JSONRPCRequestPayloadWithMethod @@ -12558,7 +6763,7 @@ ___ -Defined in ethereum-types/lib/index.d.ts:267 +Defined in ethereum-types/lib/index.d.ts:268 ___ @@ -12568,7 +6773,7 @@ ___ -Defined in ethereum-types/lib/index.d.ts:268 +Defined in ethereum-types/lib/index.d.ts:269 ___ @@ -12578,7 +6783,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L136)* +*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L136)* ___ @@ -12588,7 +6793,7 @@ ___ -Defined in ethereum-types/lib/index.d.ts:265 +Defined in ethereum-types/lib/index.d.ts:266
@@ -12631,47 +6836,6 @@ Defined in ethereum-types/lib/index.d.ts:265 - -# Interface: AwaitTransactionSuccessOpts - -Used with `awaitTransactionSuccessAsync` -* pollingIntervalMs: Determine polling intervals in milliseconds -* timeoutMs: Determines timeout in milliseconds - - -## Properties - -### `Optional` pollingIntervalMs - -• **pollingIntervalMs**? : *undefined | number* - -*Overrides [SendTransactionOpts](_types_src_index_.sendtransactionopts.md).[pollingIntervalMs](#optional-pollingintervalms)* - -*Defined in [types/src/index.ts:877](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L877)* - -___ - -### `Optional` shouldValidate - -• **shouldValidate**? : *undefined | false | true* - -*Inherited from [SendTransactionOpts](#interface-sendtransactionopts).[shouldValidate](#optional-shouldvalidate)* - -*Overrides [SendTransactionOpts](_types_src_index_.sendtransactionopts.md).[shouldValidate](#optional-shouldvalidate)* - -*Defined in [types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L680)* - -___ - -### `Optional` timeoutMs - -• **timeoutMs**? : *undefined | number* - -*Overrides [SendTransactionOpts](_types_src_index_.sendtransactionopts.md).[timeoutMs](#optional-timeoutms)* - -*Defined in [types/src/index.ts:878](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L878)* - -
@@ -12696,7 +6860,7 @@ ___ • **isRemoved**: *boolean* -*Defined in [types/src/index.ts:844](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L844)* +*Defined in [types/src/index.ts:844](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L844)* ___ @@ -12704,7 +6868,7 @@ ___ • **log**: *`LogWithDecodedArgs`* -*Defined in [types/src/index.ts:845](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L845)* +*Defined in [types/src/index.ts:845](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L845)*
@@ -12719,7 +6883,7 @@ ___ • **assetData**: *[AssetData](#assetdata)* -*Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L219)* +*Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L219)* ___ @@ -12727,7 +6891,7 @@ ___ • **beginAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L221)* +*Defined in [types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L221)* ___ @@ -12735,7 +6899,7 @@ ___ • **beginTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L220)* +*Defined in [types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L220)*
@@ -12752,7 +6916,7 @@ Elliptic Curve signature • **r**: *string* -*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L62)* +*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L62)* ___ @@ -12760,7 +6924,7 @@ ___ • **s**: *string* -*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L63)* +*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L63)* ___ @@ -12768,7 +6932,7 @@ ___ • **v**: *number* -*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L61)* +*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L61)*
@@ -12781,7 +6945,7 @@ ___ • **chainId**: *number* -*Defined in [types/src/index.ts:793](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L793)* +*Defined in [types/src/index.ts:793](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L793)* ___ @@ -12789,7 +6953,7 @@ ___ • **name**? : *undefined | string* -*Defined in [types/src/index.ts:791](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L791)* +*Defined in [types/src/index.ts:791](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L791)* ___ @@ -12797,7 +6961,7 @@ ___ • **verifyingContract**: *string* -*Defined in [types/src/index.ts:794](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L794)* +*Defined in [types/src/index.ts:794](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L794)* ___ @@ -12805,7 +6969,7 @@ ___ • **version**? : *undefined | string* -*Defined in [types/src/index.ts:792](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L792)* +*Defined in [types/src/index.ts:792](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L792)*
@@ -12824,7 +6988,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L183)* +*Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L183)* ___ @@ -12832,7 +6996,7 @@ ___ • **callbackData**: *string* -*Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L187)* +*Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L187)* ___ @@ -12840,7 +7004,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L184)* +*Defined in [types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L184)* ___ @@ -12848,7 +7012,7 @@ ___ • **tokenIds**: *`BigNumber`[]* -*Defined in [types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L185)* +*Defined in [types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L185)* ___ @@ -12856,7 +7020,7 @@ ___ • **tokenValues**: *`BigNumber`[]* -*Defined in [types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L186)* +*Defined in [types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L186)*
@@ -12871,7 +7035,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L172)* +*Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L172)* ___ @@ -12879,7 +7043,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L173)* +*Defined in [types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L173)*
@@ -12892,7 +7056,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L177)* +*Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L177)* ___ @@ -12900,7 +7064,7 @@ ___ • **tokenAddress**: *string* -*Defined in [types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L178)* +*Defined in [types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L178)* ___ @@ -12908,7 +7072,7 @@ ___ • **tokenId**: *`BigNumber`* -*Defined in [types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L179)* +*Defined in [types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L179)*
@@ -12936,7 +7100,7 @@ ___ • **keyName**: *string* -*Defined in [types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L691)* +*Defined in [types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L691)* ___ @@ -12944,7 +7108,7 @@ ___ • **keyType**: *[Type](#class-type)* -*Defined in [types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L692)* +*Defined in [types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L692)* ___ @@ -12952,7 +7116,7 @@ ___ • **valueName**: *string* -*Defined in [types/src/index.ts:693](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L693)* +*Defined in [types/src/index.ts:693](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L693)*
@@ -12969,7 +7133,7 @@ ___ • **amounts**: *`BigNumber`[]* -*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L208)* +*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L208)* ___ @@ -12977,7 +7141,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L207)* +*Defined in [types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L207)* ___ @@ -12985,7 +7149,7 @@ ___ • **nestedAssetData**: *string[]* -*Defined in [types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L209)* +*Defined in [types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L209)*
@@ -12998,7 +7162,7 @@ ___ • **amounts**: *`BigNumber`[]* -*Defined in [types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L214)* +*Defined in [types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L214)* ___ @@ -13006,7 +7170,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L213)* +*Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L213)* ___ @@ -13014,7 +7178,7 @@ ___ • **nestedAssetData**: *[SingleAssetData](#singleassetdata)[]* -*Defined in [types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L215)* +*Defined in [types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L215)*
@@ -13054,44 +7218,7 @@ ___ -# Interface: SendTransactionOpts - -* 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. -* pollingIntervalMs: Used with `awaitTransactionSuccessAsync` to determine polling interval in milliseconds -* timeoutMs: Used with `awaitTransactionSuccessAsync` to determine timeout in milliseconds -Used with `sendTransactionAsync` -* 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` pollingIntervalMs - -• **pollingIntervalMs**? : *undefined | number* - -*Defined in [types/src/index.ts:681](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L681)* - -___ - -### `Optional` shouldValidate - -• **shouldValidate**? : *undefined | false | true* - -*Defined in [types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L680)* - -*Defined in [types/src/index.ts:868](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L868)* - -___ - -### `Optional` timeoutMs - -• **timeoutMs**? : *undefined | number* - -*Defined in [types/src/index.ts:682](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L682)* -
# Interface: SignedOrder @@ -13104,7 +7231,7 @@ ___ *Inherited from [Order](#interface-order).[chainId](#chainid)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L14)* ___ @@ -13114,7 +7241,7 @@ ___ *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L15)* ___ @@ -13124,7 +7251,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L24)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L24)* ___ @@ -13134,7 +7261,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L18)* ___ @@ -13144,7 +7271,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L16)* ___ @@ -13154,7 +7281,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L20)* ___ @@ -13164,7 +7291,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L26)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L26)* ___ @@ -13174,7 +7301,7 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L22)* ___ @@ -13184,7 +7311,7 @@ ___ *Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L28)* +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L28)* ___ @@ -13194,7 +7321,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L25)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L25)* ___ @@ -13204,7 +7331,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L19)* ___ @@ -13212,7 +7339,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L33)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L33)* ___ @@ -13222,7 +7349,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L17)* ___ @@ -13232,7 +7359,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L21)* ___ @@ -13242,7 +7369,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L27)* ___ @@ -13252,7 +7379,7 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L23)* ___ @@ -13262,7 +7389,7 @@ ___ *Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L29)*
@@ -13277,7 +7404,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[data](#data)* -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L49)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L49)* ___ @@ -13287,7 +7414,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[domain](#domain)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L50)* +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L50)* ___ @@ -13297,7 +7424,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L46)* +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L46)* ___ @@ -13307,7 +7434,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[gasPrice](#gasprice)* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L47)* +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L47)* ___ @@ -13317,7 +7444,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[salt](#salt)* -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L45)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L45)* ___ @@ -13325,7 +7452,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L54)* +*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L54)* ___ @@ -13335,7 +7462,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[signerAddress](#signeraddress)* -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L48)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L48)*
@@ -13348,7 +7475,7 @@ ___ • **chains**: *`ContractChains`* -*Defined in [types/src/index.ts:885](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L885)* +*Defined in [types/src/index.ts:861](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L861)* ___ @@ -13356,7 +7483,7 @@ ___ • **compilerOutput**: *[SimpleStandardContractOutput](#class-simplestandardcontractoutput)* -*Defined in [types/src/index.ts:884](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L884)* +*Defined in [types/src/index.ts:860](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L860)* ___ @@ -13364,7 +7491,7 @@ ___ • **contractName**: *string* -*Defined in [types/src/index.ts:883](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L883)* +*Defined in [types/src/index.ts:859](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L859)* ___ @@ -13372,7 +7499,7 @@ ___ • **schemaVersion**: *string* -*Defined in [types/src/index.ts:882](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L882)* +*Defined in [types/src/index.ts:858](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L858)*
@@ -13385,7 +7512,7 @@ ___ • **object**: *string* -*Defined in [types/src/index.ts:899](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L899)* +*Defined in [types/src/index.ts:875](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L875)*
@@ -13398,7 +7525,7 @@ ___ • **bytecode**: *[SimpleEvmBytecodeOutput](#class-simpleevmbytecodeoutput)* -*Defined in [types/src/index.ts:895](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L895)* +*Defined in [types/src/index.ts:871](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L871)*
@@ -13411,7 +7538,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [types/src/index.ts:889](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L889)* +*Defined in [types/src/index.ts:865](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L865)* ___ @@ -13419,7 +7546,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [types/src/index.ts:891](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L891)* +*Defined in [types/src/index.ts:867](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L867)* ___ @@ -13427,7 +7554,7 @@ ___ • **evm**: *[SimpleEvmOutput](#class-simpleevmoutput)* -*Defined in [types/src/index.ts:890](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L890)* +*Defined in [types/src/index.ts:866](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L866)*
@@ -13444,7 +7571,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L191)* +*Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L191)* ___ @@ -13452,7 +7579,7 @@ ___ • **callResultHash**: *string* -*Defined in [types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L194)* +*Defined in [types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L194)* ___ @@ -13460,7 +7587,7 @@ ___ • **callTarget**: *string* -*Defined in [types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L192)* +*Defined in [types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L192)* ___ @@ -13468,7 +7595,7 @@ ___ • **staticCallData**: *string* -*Defined in [types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L193)* +*Defined in [types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L193)*
@@ -13509,7 +7636,7 @@ Validator signature components • **signature**: *string* -*Defined in [types/src/index.ts:71](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L71)* +*Defined in [types/src/index.ts:71](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L71)* ___ @@ -13517,7 +7644,7 @@ ___ • **validatorAddress**: *string* -*Defined in [types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L70)* +*Defined in [types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L70)*
@@ -13532,7 +7659,7 @@ ZeroExTransaction for use with 0x Exchange executeTransaction • **data**: *string* -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L49)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L49)* ___ @@ -13540,7 +7667,7 @@ ___ • **domain**: *[EIP712DomainWithDefaultSchema](#class-eip712domainwithdefaultschema)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L50)* +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L50)* ___ @@ -13548,7 +7675,7 @@ ___ • **expirationTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L46)* +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L46)* ___ @@ -13556,7 +7683,7 @@ ___ • **gasPrice**: *`BigNumber`* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L47)* +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L47)* ___ @@ -13564,7 +7691,7 @@ ___ • **salt**: *`BigNumber`* -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L45)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L45)* ___ @@ -13572,37 +7699,80 @@ ___ • **signerAddress**: *string* -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L48)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L48)*
-
+## Type aliases -## Type aliases +### AssetData -### ERC20TokenEventArgs +Ƭ **AssetData**: *[SingleAssetData](_types_src_index_.md#singleassetdata) | [MultiAssetData](#interface-multiassetdata) | [MultiAssetDataWithRecursiveDecoding](#interface-multiassetdatawithrecursivedecoding)* -Ƭ **ERC20TokenEventArgs**: *[ERC20TokenTransferEventArgs](#interface-erc20tokentransfereventargs) | [ERC20TokenApprovalEventArgs](#interface-erc20tokenapprovaleventargs)* +*Defined in [types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L224)* + +___ + + + + + + + +### EventCallback + +Ƭ **EventCallback**: *function* + +*Defined in [types/src/index.ts:848](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L848)* + +#### Type declaration: + +▸ (`err`: null | `Error`, `log?`: [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*›): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`err` | null \| `Error` | +`log?` | [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*› | + +___ + + + + + + + + + +### SingleAssetData -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L34)* +Ƭ **SingleAssetData**: *[ERC20AssetData](#interface-erc20assetdata) | [ERC721AssetData](#interface-erc721assetdata) | [ERC1155AssetData](#interface-erc1155assetdata) | [StaticCallAssetData](#interface-staticcallassetdata)* + +*Defined in [types/src/index.ts:204](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L204)*
+
+ + + ## Type aliases -### ERC721TokenEventArgs +### ERC20TokenEventArgs -Ƭ **ERC721TokenEventArgs**: *[ERC721TokenApprovalEventArgs](#interface-erc721tokenapprovaleventargs) | [ERC721TokenApprovalForAllEventArgs](#interface-erc721tokenapprovalforalleventargs) | [ERC721TokenTransferEventArgs](#interface-erc721tokentransfereventargs)* +Ƭ **ERC20TokenEventArgs**: *[ERC20TokenTransferEventArgs](#interface-erc20tokentransfereventargs) | [ERC20TokenApprovalEventArgs](#interface-erc20tokenapprovaleventargs)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L37)*
@@ -13611,21 +7781,26 @@ ___ ## Type aliases -### ExchangeEventArgs +### ERC721TokenEventArgs -Ƭ **ExchangeEventArgs**: *[ExchangeAssetProxyRegisteredEventArgs](#interface-exchangeassetproxyregisteredeventargs) | [ExchangeCancelEventArgs](#interface-exchangecanceleventargs) | [ExchangeCancelUpToEventArgs](#interface-exchangecanceluptoeventargs) | [ExchangeFillEventArgs](#interface-exchangefilleventargs) | [ExchangeProtocolFeeCollectorAddressEventArgs](#interface-exchangeprotocolfeecollectoraddresseventargs) | [ExchangeProtocolFeeMultiplierEventArgs](#interface-exchangeprotocolfeemultipliereventargs) | [ExchangeSignatureValidatorApprovalEventArgs](#interface-exchangesignaturevalidatorapprovaleventargs) | [ExchangeTransactionExecutionEventArgs](#interface-exchangetransactionexecutioneventargs)* +Ƭ **ERC721TokenEventArgs**: *[ERC721TokenApprovalEventArgs](#interface-erc721tokenapprovaleventargs) | [ERC721TokenApprovalForAllEventArgs](#interface-erc721tokenapprovalforalleventargs) | [ERC721TokenTransferEventArgs](#interface-erc721tokentransfereventargs)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L37)*
-
+## Type aliases + +### ExchangeEventArgs + +Ƭ **ExchangeEventArgs**: *[ExchangeAssetProxyRegisteredEventArgs](#interface-exchangeassetproxyregisteredeventargs) | [ExchangeCancelEventArgs](#interface-exchangecanceleventargs) | [ExchangeCancelUpToEventArgs](#interface-exchangecanceluptoeventargs) | [ExchangeFillEventArgs](#interface-exchangefilleventargs) | [ExchangeProtocolFeeCollectorAddressEventArgs](#interface-exchangeprotocolfeecollectoraddresseventargs) | [ExchangeProtocolFeeMultiplierEventArgs](#interface-exchangeprotocolfeemultipliereventargs) | [ExchangeSignatureValidatorApprovalEventArgs](#interface-exchangesignaturevalidatorapprovaleventargs) | [ExchangeTransactionExecutionEventArgs](#interface-exchangetransactionexecutioneventargs)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L37)* -
+
@@ -13636,7 +7811,7 @@ ___ Ƭ **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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L37)*
@@ -13645,13 +7820,7 @@ ___ ## 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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L34)* -
@@ -13662,7 +7831,7 @@ ___ ▸ **getContractAddressesForChainOrThrow**(`chainId`: [ChainId](#enumeration-chainid)): *[ContractAddresses](#interface-contractaddresses)* -*Defined in [contract-addresses/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L45)* +*Defined in [contract-addresses/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L45)* Used to get addresses of contracts that have been deployed to either the Ethereum mainnet or a supported testnet. Throws if there are no known @@ -13690,7 +7859,7 @@ given chainId. Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)* -*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L80)* +*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L80)* ___ @@ -13698,7 +7867,7 @@ ___ Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* -*Defined in [ethereum-types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L483)* +*Defined in [ethereum-types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L484)* ___ @@ -13706,7 +7875,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L84)* ___ @@ -13714,7 +7883,7 @@ ___ Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* -*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L78)* +*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L78)* ___ @@ -13722,7 +7891,7 @@ ___ Ƭ **ContractEventArg**: *any* -*Defined in [ethereum-types/src/index.ts:468](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L468)* +*Defined in [ethereum-types/src/index.ts:469](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L469)* ___ @@ -13732,7 +7901,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L70)* Interface for providers that conform to EIP 1193 Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md @@ -13747,7 +7916,7 @@ ___ Ƭ **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/c93b02d55/packages/ethereum-types/src/index.ts#L82)* +*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L82)* ___ @@ -13755,7 +7924,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -13776,7 +7945,7 @@ ___ Ƭ **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:525](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L525)* +*Defined in [ethereum-types/src/index.ts:526](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L526)* ___ @@ -13784,7 +7953,7 @@ ___ Ƭ **ParamDescription**: *string* -*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L561)* +*Defined in [ethereum-types/src/index.ts:562](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L562)* ___ @@ -13794,7 +7963,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L85)* ___ @@ -13802,7 +7971,7 @@ ___ Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)* -*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L9)* Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library Read more about Providers in the guides section of the 0x docs. @@ -13817,7 +7986,7 @@ ___ Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)* -*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L11)*
@@ -13830,13 +7999,13 @@ ___ #### ▪ **assetDataUtils**: *object* -*Defined in [order-utils/src/asset_data_utils.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L23)* +*Defined in [order-utils/src/asset_data_utils.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L397)* +*Defined in [order-utils/src/asset_data_utils.ts:397](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L397)* Throws if the assetData is not ERC1155. @@ -13852,7 +8021,7 @@ Name | Type | Description | ▸ **assertIsERC20AssetData**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:353](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L353)* +*Defined in [order-utils/src/asset_data_utils.ts:353](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L353)* Throws if the length or assetProxyId are invalid for the ERC20Proxy. @@ -13868,7 +8037,7 @@ Name | Type | Description | ▸ **assertIsERC721AssetData**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:375](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L375)* +*Defined in [order-utils/src/asset_data_utils.ts:375](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L375)* Throws if the length or assetProxyId are invalid for the ERC721Proxy. @@ -13884,7 +8053,7 @@ Name | Type | Description | ▸ **assertIsMultiAssetData**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:419](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L419)* +*Defined in [order-utils/src/asset_data_utils.ts:419](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L419)* Throws if the length or assetProxyId are invalid for the MultiAssetProxy. @@ -13900,7 +8069,7 @@ Name | Type | Description | ▸ **assertIsStaticCallAssetData**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:441](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L441)* +*Defined in [order-utils/src/asset_data_utils.ts:441](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L441)* Throws if the assetData is not StaticCallData. @@ -13916,7 +8085,7 @@ Name | Type | Description | ▸ **assertWordAlignedAssetData**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:463](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L463)* +*Defined in [order-utils/src/asset_data_utils.ts:463](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L463)* Throws if the assetData is not padded to 32 bytes. @@ -13932,7 +8101,7 @@ Name | Type | Description | ▸ **decodeAssetDataOrThrow**(`assetData`: string): *[SingleAssetData](#singleassetdata) | `MultiAssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:502](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L502)* +*Defined in [order-utils/src/asset_data_utils.ts:502](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L502)* Decode any assetData into its corresponding assetData object @@ -13950,7 +8119,7 @@ Either a ERC20, ERC721, ERC1155, or MultiAsset assetData object ▸ **decodeAssetProxyId**(`assetData`: string): *`AssetProxyId`* -*Defined in [order-utils/src/asset_data_utils.ts:294](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L294)* +*Defined in [order-utils/src/asset_data_utils.ts:294](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L294)* Decode and return the assetProxyId from the assetData @@ -13968,7 +8137,7 @@ The assetProxyId ▸ **decodeDutchAuctionData**(`dutchAuctionData`: string): *`DutchAuctionData`* -*Defined in [order-utils/src/asset_data_utils.ts:263](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L263)* +*Defined in [order-utils/src/asset_data_utils.ts:263](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -13988,7 +8157,7 @@ An object containing the auction asset, auction begin time and auction begin amo ▸ **decodeERC1155AssetData**(`assetData`: string): *`ERC1155AssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:107](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L107)* +*Defined in [order-utils/src/asset_data_utils.ts:107](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L107)* Decodes an ERC1155 assetData hex string into its corresponding ERC1155 components. @@ -14006,7 +8175,7 @@ An object containing the decoded tokenAddress, tokenIds, tokenValues, callbackDa ▸ **decodeERC20AssetData**(`assetData`: string): *`ERC20AssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L41)* +*Defined in [order-utils/src/asset_data_utils.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L41)* Decodes an ERC20 assetData hex string into its corresponding ERC20 tokenAddress & assetProxyId @@ -14024,7 +8193,7 @@ An object containing the decoded tokenAddress & assetProxyId ▸ **decodeERC721AssetData**(`assetData`: string): *`ERC721AssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L70)* +*Defined in [order-utils/src/asset_data_utils.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L70)* Decodes an ERC721 assetData hex string into its corresponding ERC721 tokenAddress, tokenId & assetProxyId @@ -14042,7 +8211,7 @@ An object containing the decoded tokenAddress, tokenId & assetProxyId ▸ **decodeMultiAssetData**(`assetData`: string): *`MultiAssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:149](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L149)* +*Defined in [order-utils/src/asset_data_utils.ts:149](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L149)* Decodes a MultiAsset assetData hex string into its corresponding amounts and nestedAssetData @@ -14060,7 +8229,7 @@ An object containing the decoded amounts and nestedAssetData ▸ **decodeMultiAssetDataRecursively**(`assetData`: string): *`MultiAssetDataWithRecursiveDecoding`* -*Defined in [order-utils/src/asset_data_utils.ts:175](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L175)* +*Defined in [order-utils/src/asset_data_utils.ts:175](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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) @@ -14078,7 +8247,7 @@ An object containing the decoded amounts and nestedAssetData ▸ **decodeStaticCallAssetData**(`assetData`: string): *`StaticCallAssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:225](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L225)* +*Defined in [order-utils/src/asset_data_utils.ts:225](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L225)* Decoded StaticCall assetData into its corresponding callTarget, staticCallData, and expected callResultHash @@ -14096,7 +8265,7 @@ An object containing the decoded callTarget, staticCallData, and expected callRe ▸ **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/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L245)* +*Defined in [order-utils/src/asset_data_utils.ts:245](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -14118,7 +8287,7 @@ The hex encoded assetData string. ▸ **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/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L91)* +*Defined in [order-utils/src/asset_data_utils.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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. @@ -14140,7 +8309,7 @@ The hex encoded assetData string ▸ **encodeERC20AssetData**(`tokenAddress`: string): *string* -*Defined in [order-utils/src/asset_data_utils.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L30)* +*Defined in [order-utils/src/asset_data_utils.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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. @@ -14159,7 +8328,7 @@ The hex encoded assetData string ▸ **encodeERC721AssetData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string* -*Defined in [order-utils/src/asset_data_utils.ts:59](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L59)* +*Defined in [order-utils/src/asset_data_utils.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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. @@ -14179,7 +8348,7 @@ The hex encoded assetData string ▸ **encodeMultiAssetData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *string* -*Defined in [order-utils/src/asset_data_utils.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L130)* +*Defined in [order-utils/src/asset_data_utils.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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. @@ -14199,7 +8368,7 @@ The hex encoded assetData string ▸ **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/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L214)* +*Defined in [order-utils/src/asset_data_utils.ts:214](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L214)* Encodes StaticCallProxy data into an assetData hex string @@ -14219,7 +8388,7 @@ The hex encoded assetData string ▸ **isERC1155AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* -*Defined in [order-utils/src/asset_data_utils.ts:332](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L332)* +*Defined in [order-utils/src/asset_data_utils.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L332)* Checks if the decoded asset data is valid ERC1155 data @@ -14235,7 +8404,7 @@ Name | Type | Description | ▸ **isERC20AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* -*Defined in [order-utils/src/asset_data_utils.ts:318](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L318)* +*Defined in [order-utils/src/asset_data_utils.ts:318](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L318)* Checks if the decoded asset data is valid ERC20 data @@ -14251,7 +8420,7 @@ Name | Type | Description | ▸ **isERC721AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* -*Defined in [order-utils/src/asset_data_utils.ts:325](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L325)* +*Defined in [order-utils/src/asset_data_utils.ts:325](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L325)* Checks if the decoded asset data is valid ERC721 data @@ -14267,7 +8436,7 @@ Name | Type | Description | ▸ **isMultiAssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* -*Defined in [order-utils/src/asset_data_utils.ts:339](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L339)* +*Defined in [order-utils/src/asset_data_utils.ts:339](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L339)* Checks if the decoded asset data is valid MultiAsset data @@ -14283,7 +8452,7 @@ Name | Type | Description | ▸ **isStaticCallAssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* -*Defined in [order-utils/src/asset_data_utils.ts:346](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L346)* +*Defined in [order-utils/src/asset_data_utils.ts:346](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L346)* Checks if the decoded asset data is valid StaticCall data @@ -14299,7 +8468,7 @@ Name | Type | Description | ▸ **validateAssetDataOrThrow**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:475](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L475)* +*Defined in [order-utils/src/asset_data_utils.ts:475](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L475)* Throws if the length or assetProxyId are invalid for the corresponding AssetProxy. @@ -14316,109 +8485,81 @@ Name | Type | Description | -## Object literals - -#### `Const` orderHashUtils - -#### ▪ **orderHashUtils**: *object* - -*Defined in [order-utils/src/order_hash.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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/c93b02d55/packages/order-utils/src/order_hash.ts#L55)* - -Computes the orderHash for a supplied order - -**Parameters:** +## Functions -Name | Type | Description | ------- | ------ | ------ | -`order` | `SignedOrder` \| `Order` | An object that conforms to the Order or SignedOrder interface definitions. | +#### generatePseudoRandomSalt -**Returns:** *`Buffer`* +▸ **generatePseudoRandomSalt**(): *`BigNumber`* -A Buffer containing the resulting orderHash from hashing the supplied order +*Defined in [order-utils/src/salt.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/salt.ts#L9)* -#### getOrderHashHex +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. -▸ **getOrderHashHex**(`order`: `SignedOrder` | `Order`): *string* +**Returns:** *`BigNumber`* -*Defined in [order-utils/src/order_hash.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_hash.ts#L33)* +A pseudo-random 256-bit number that can be used as a salt. -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. +## Functions -#### isValidOrderHash +#### isValidECSignature -▸ **isValidOrderHash**(`orderHash`: string): *boolean* +▸ **isValidECSignature**(`data`: string, `signature`: `ECSignature`, `signerAddress`: string): *boolean* -*Defined in [order-utils/src/order_hash.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_hash.ts#L20)* +*Defined in [order-utils/src/signature_utils.ts:353](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L353)* -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. +Checks if the supplied elliptic curve signature corresponds to signing `data` with +the private key corresponding to `signerAddress` **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`orderHash` | string | Hex encoded orderHash. | +`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 supplied orderHash has the expected format. - -
- - - - -## Functions - -#### generatePseudoRandomSalt - -▸ **generatePseudoRandomSalt**(): *`BigNumber`* +Whether the ECSignature is valid. -*Defined in [order-utils/src/salt.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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. +### parseSignatureHexAsVRS -**Returns:** *`BigNumber`* +▸ **parseSignatureHexAsVRS**(`signatureHex`: string): *`ECSignature`* -A pseudo-random 256-bit number that can be used as a salt. +*Defined in [order-utils/src/signature_utils.ts:311](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L311)* -
+Parses a signature hex string, which is assumed to be in the VRS format. +**Parameters:** +Name | Type | +------ | ------ | +`signatureHex` | string | +**Returns:** *`ECSignature`* -## Object literals +## Object literals -#### `Const` signatureUtils +### `Const` signatureUtils #### ▪ **signatureUtils**: *object* -*Defined in [order-utils/src/signature_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/signature_utils.ts#L27)* +*Defined in [order-utils/src/signature_utils.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L26)* #### addSignedMessagePrefix ▸ **addSignedMessagePrefix**(`message`: string): *string* -*Defined in [order-utils/src/signature_utils.ts:500](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/signature_utils.ts#L500)* +*Defined in [order-utils/src/signature_utils.ts:284](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L284)* Adds the relevant prefix to the message being signed. @@ -14436,7 +8577,7 @@ Prefixed message ▸ **convertECSignatureToSignatureHex**(`ecSignature`: `ECSignature`): *string* -*Defined in [order-utils/src/signature_utils.ts:474](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/signature_utils.ts#L474)* +*Defined in [order-utils/src/signature_utils.ts:258](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L258)* Combines ECSignature with V,R,S and the EthSign signature type for use in 0x protocol @@ -14454,7 +8595,7 @@ Hex encoded string of signature (v,r,s) with Signature Type ▸ **convertToSignatureWithType**(`signature`: string, `signatureType`: `SignatureType`): *string* -*Defined in [order-utils/src/signature_utils.ts:490](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/signature_utils.ts#L490)* +*Defined in [order-utils/src/signature_utils.ts:274](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L274)* Combines the signature proof and the Signature Type. @@ -14473,7 +8614,7 @@ Hex encoded string of signature proof with Signature Type ▸ **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/c93b02d55/packages/order-utils/src/signature_utils.ts#L417)* +*Defined in [order-utils/src/signature_utils.ts:209](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L209)* Signs a hash using `eth_sign` and returns its elliptic curve signature and signature type. @@ -14493,7 +8634,7 @@ A hex encoded string containing the Elliptic curve signature generated by signin ▸ **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/c93b02d55/packages/order-utils/src/signature_utils.ts#L252)* +*Defined in [order-utils/src/signature_utils.ts:36](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L36)* 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. @@ -14514,7 +8655,7 @@ A SignedOrder containing the order and Elliptic curve signature with Signature T ▸ **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/c93b02d55/packages/order-utils/src/signature_utils.ts#L331)* +*Defined in [order-utils/src/signature_utils.ts:117](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L117)* 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. @@ -14535,7 +8676,7 @@ A SignedTransaction containing the order and Elliptic curve signature with Signa ▸ **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/c93b02d55/packages/order-utils/src/signature_utils.ts#L287)* +*Defined in [order-utils/src/signature_utils.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L73)* Signs an order using `eth_signTypedData` and returns a SignedOrder. @@ -14555,7 +8696,7 @@ A SignedOrder containing the order and Elliptic curve signature with Signature T ▸ **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/c93b02d55/packages/order-utils/src/signature_utils.ts#L374)* +*Defined in [order-utils/src/signature_utils.ts:166](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L166)* Signs a ZeroExTransaction using `eth_signTypedData` and returns a SignedZeroExTransaction. @@ -14571,136 +8712,11 @@ Name | Type | Description | 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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/packages/order-utils/src/signature_utils.ts#L529)* +*Defined in [order-utils/src/signature_utils.ts:296](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L296)* Parse a hex-encoded Validator signature into validator address and signature components @@ -14718,75 +8734,6 @@ 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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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. - -
- - -
@@ -14802,7 +8749,7 @@ Whether the supplied transactionHash has the expected format. Ƭ **Callback**: *function* -*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L131)* +*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L131)* ##### Type declaration: @@ -14816,7 +8763,7 @@ ___ Ƭ **ErrorCallback**: *function* -*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L130)* +*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L130)* #### Type declaration: @@ -14837,63 +8784,3 @@ ___ - - - -## Type aliases - - - -### AssetData - -Ƭ **AssetData**: *[SingleAssetData](_types_src_index_.md#singleassetdata) | [MultiAssetData](#interface-multiassetdata) | [MultiAssetDataWithRecursiveDecoding](#interface-multiassetdatawithrecursivedecoding)* - -*Defined in [types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L224)* - -___ - - - - - - - -### EventCallback - -Ƭ **EventCallback**: *function* - -*Defined in [types/src/index.ts:848](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L848)* - -#### Type declaration: - -▸ (`err`: null | `Error`, `log?`: [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*›): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`err` | null \| `Error` | -`log?` | [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*› | - -___ - - - - - - - - - -### SingleAssetData - -Ƭ **SingleAssetData**: *[ERC20AssetData](#interface-erc20assetdata) | [ERC721AssetData](#interface-erc721assetdata) | [ERC1155AssetData](#interface-erc1155assetdata) | [StaticCallAssetData](#interface-staticcallassetdata)* - -*Defined in [types/src/index.ts:204](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L204)* - -
- - - -
- diff --git a/packages/abi-gen-wrappers/CHANGELOG.json b/packages/abi-gen-wrappers/CHANGELOG.json index 97f4e7e588..d9117693f7 100644 --- a/packages/abi-gen-wrappers/CHANGELOG.json +++ b/packages/abi-gen-wrappers/CHANGELOG.json @@ -14,7 +14,8 @@ "note": "Updated Coordinator + Coordinator Registry wrappers", "pr": 2346 } - ] + ], + "timestamp": 1574030254 }, { "version": "5.4.0-beta.1", diff --git a/packages/abi-gen-wrappers/CHANGELOG.md b/packages/abi-gen-wrappers/CHANGELOG.md index 859d1e3678..248bf11593 100644 --- a/packages/abi-gen-wrappers/CHANGELOG.md +++ b/packages/abi-gen-wrappers/CHANGELOG.md @@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v5.4.0-beta.2 - _November 17, 2019_ + + * [Breaking] Remove `erc20Proxy`, `multiAssetProxy`, `erc1155Proxy`, `staticCallProxy`, `erc721Proxy`, `assetProxyOwner`, `ZRXToken` and `dutchAuction` wrappers (#2324) + * [Breaking] Big refactor of contract wrapper interface. See https://github.com/0xProject/0x-monorepo/pull/2325 for details (#2325) + * Updated Coordinator + Coordinator Registry wrappers (#2346) + ## v5.4.0-beta.1 - _November 7, 2019_ * Remove debug functions `getABIDecodedTransactionData` and `getABIDecodedReturnData` (#2243) diff --git a/packages/abi-gen-wrappers/src/generated-wrappers/staking.ts b/packages/abi-gen-wrappers/src/generated-wrappers/staking.ts index 429b09f520..8f844b9780 100644 --- a/packages/abi-gen-wrappers/src/generated-wrappers/staking.ts +++ b/packages/abi-gen-wrappers/src/generated-wrappers/staking.ts @@ -262,11 +262,11 @@ export class StakingContract extends BaseContract { { inputs: [ { - name: 'wethAddress_', + name: 'wethAddress', type: 'address', }, { - name: 'zrxVaultAddress_', + name: 'zrxVaultAddress', type: 'address', }, ], diff --git a/packages/abi-gen/CHANGELOG.json b/packages/abi-gen/CHANGELOG.json index 4eeb68951b..963de661c9 100644 --- a/packages/abi-gen/CHANGELOG.json +++ b/packages/abi-gen/CHANGELOG.json @@ -26,7 +26,8 @@ "note": "Python: Changed the names of generated tuples to use the `internalType` field in the ABI, if it's present, resulting in human readable struct names rather than hashes of component field names.", "pr": 2345 } - ] + ], + "timestamp": 1574030254 }, { "version": "4.4.0-beta.1", diff --git a/packages/abi-gen/CHANGELOG.md b/packages/abi-gen/CHANGELOG.md index 22cbe45b41..231b67ba1f 100644 --- a/packages/abi-gen/CHANGELOG.md +++ b/packages/abi-gen/CHANGELOG.md @@ -5,6 +5,15 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v4.4.0-beta.2 - _November 17, 2019_ + + * Refactored TS wrapper templates to result in a more succint interface. See https://github.com/0xProject/0x-monorepo/pull/2325 for details. (#2284) + * Python: Corrected return types and values for call() interface to generated method wrappers. (Fixes #2298) (#2345) + * Python: Stopped generating send_transaction() interface for constant (view/pure) methods (#2345) + * Python: Added a build_transaction() interface to contract method classes (#2345) + * Python: Removed `validator` argument to contract method classes for methods that don't have any inputs (#2345) + * Python: Changed the names of generated tuples to use the `internalType` field in the ABI, if it's present, resulting in human readable struct names rather than hashes of component field names. (#2345) + ## v4.4.0-beta.1 - _November 7, 2019_ * In Python wrappers, accept string arguments to bytes parameters (#2284) diff --git a/packages/abi-gen/test-cli/output/python/lib_dummy/__init__.py b/packages/abi-gen/test-cli/output/python/lib_dummy/__init__.py index 12e96c147f..6c1375710e 100644 --- a/packages/abi-gen/test-cli/output/python/lib_dummy/__init__.py +++ b/packages/abi-gen/test-cli/output/python/lib_dummy/__init__.py @@ -90,7 +90,7 @@ def __init__( try: for middleware in MIDDLEWARE: web3.middleware_onion.inject( - middleware["function"], layer=middleware["layer"], + middleware["function"], layer=middleware["layer"] ) except ValueError as value_error: if value_error.args == ( diff --git a/packages/assert/CHANGELOG.json b/packages/assert/CHANGELOG.json index f84a70c3d5..75486b0570 100644 --- a/packages/assert/CHANGELOG.json +++ b/packages/assert/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "2.2.0-beta.1", diff --git a/packages/assert/CHANGELOG.md b/packages/assert/CHANGELOG.md index 8655034714..17541fc8c8 100644 --- a/packages/assert/CHANGELOG.md +++ b/packages/assert/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.2.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v2.2.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/asset-buyer/CHANGELOG.json b/packages/asset-buyer/CHANGELOG.json index 75bef5323b..ac0a29e66b 100644 --- a/packages/asset-buyer/CHANGELOG.json +++ b/packages/asset-buyer/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "6.2.0-beta.1", diff --git a/packages/asset-buyer/CHANGELOG.md b/packages/asset-buyer/CHANGELOG.md index e51c51c24f..b81c014b40 100644 --- a/packages/asset-buyer/CHANGELOG.md +++ b/packages/asset-buyer/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v6.2.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v6.2.0-beta.1 - _November 7, 2019_ * All references to network ID have been removed, and references to chain ID have been introduced instead (#2313) diff --git a/packages/asset-swapper/CHANGELOG.json b/packages/asset-swapper/CHANGELOG.json index 85945d3db0..f3f843e37e 100644 --- a/packages/asset-swapper/CHANGELOG.json +++ b/packages/asset-swapper/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Update BigNumber version to ~9.0.0", "pr": 2342 } - ] + ], + "timestamp": 1574030254 }, { "version": "2.1.0-beta.1", diff --git a/packages/asset-swapper/CHANGELOG.md b/packages/asset-swapper/CHANGELOG.md index a9c2f3a6cf..b83b2535ef 100644 --- a/packages/asset-swapper/CHANGELOG.md +++ b/packages/asset-swapper/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.1.0-beta.2 - _November 17, 2019_ + + * Update BigNumber version to ~9.0.0 (#2342) + ## v2.1.0-beta.1 - _November 7, 2019_ * All references to network ID have been removed, and references to chain ID have been introduced instead (#2313) diff --git a/packages/asset-swapper/docs/reference.mdx b/packages/asset-swapper/docs/reference.mdx index 0eb345e2fa..69482509a5 100644 --- a/packages/asset-swapper/docs/reference.mdx +++ b/packages/asset-swapper/docs/reference.mdx @@ -1,43 +1,25 @@ -# Class: InsufficientAssetLiquidityError - -Error class representing insufficient asset liquidity - - -## Constructors - - - -\+ **new InsufficientAssetLiquidityError**(`amountAvailableToFill`: `BigNumber`): *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* - -*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/errors.ts#L12)* - -**Parameters:** +# Interface: TupleDataItem -Name | Type | Description | ------- | ------ | ------ | -`amountAvailableToFill` | `BigNumber` | The amount availabe to fill (in base units) factoring in slippage | -**Returns:** *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* +## Properties -## Properties +### components -### amountAvailableToFill +• **components**: *[DataItem](#class-dataitem)[]* -• **amountAvailableToFill**: *`BigNumber`* +*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* -*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/errors.ts#L12)* - -The amount availabe to fill (in base units) factoring in slippage. +*Defined in [ethereum-types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L142)* ___ -### message - -• **message**: *string* - +### `Optional` internalType +• **internalType**? : *undefined | string* +*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)* +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -45,29 +27,19 @@ ___ • **name**: *string* +*Inherited from [DataItem](#interface-dataitem).[name](#name)* - - - -___ - -### `Optional` stack - -• **stack**? : *undefined | string* - - - -*Overrides void* - - +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ -### `Static` Error +### type -▪ **Error**: *`ErrorConstructor`* +• **type**: *string* +*Inherited from [DataItem](#interface-dataitem).[type](#type)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -85,7 +57,7 @@ ___ \+ **new SwapQuoteConsumer**(`supportedProvider`: [SupportedProvider](#supportedprovider), `options`: `Partial`): *[SwapQuoteConsumer](#class-swapquoteconsumer)* -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L31)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L31)* **Parameters:** @@ -102,7 +74,7 @@ Name | Type | Default | • **chainId**: *number* -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L27)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L27)* ___ @@ -110,7 +82,7 @@ ___ • **provider**: *`ZeroExProvider`* -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L26)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L26)* ## Methods @@ -120,7 +92,7 @@ ___ *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:81](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L81)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:81](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L81)* Given a SwapQuote and desired rate (in takerAsset), attempt to execute the swap. @@ -141,7 +113,7 @@ ___ *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L53)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L53)* Given a SwapQuote, returns 'CalldataInfo' for a 0x exchange call. See type definition of CalldataInfo for more information. @@ -160,7 +132,7 @@ ___ ▸ **getOptimalExtensionContractTypeAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L90)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L90)* **Parameters:** @@ -179,7 +151,7 @@ ___ *Implementation of [SwapQuoteConsumerBase](#interface-swapquoteconsumerbase)* -*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:67](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L67)* +*Defined in [asset-swapper/src/quote_consumers/swap_quote_consumer.ts:67](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/quote_consumers/swap_quote_consumer.ts#L67)* Given a SwapQuote, returns 'SmartContractParamsInfo' for a 0x exchange call. See type definition of SmartContractParamsInfo for more information. @@ -203,7 +175,7 @@ Name | Type | Default | Description | \+ **new SwapQuoter**(`supportedProvider`: [SupportedProvider](#supportedprovider), `orderbook`: `Orderbook`, `options`: `Partial`): *[SwapQuoter](#class-swapquoter)* -*Defined in [asset-swapper/src/swap_quoter.ts:126](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L126)* +*Defined in [asset-swapper/src/swap_quoter.ts:124](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L124)* Instantiates a new SwapQuoter instance @@ -225,7 +197,7 @@ An instance of SwapQuoter • **expiryBufferMs**: *number* -*Defined in [asset-swapper/src/swap_quoter.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L30)* +*Defined in [asset-swapper/src/swap_quoter.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L30)* ___ @@ -233,7 +205,7 @@ ___ • **orderbook**: *`Orderbook`* -*Defined in [asset-swapper/src/swap_quoter.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L29)* +*Defined in [asset-swapper/src/swap_quoter.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L29)* ___ @@ -241,7 +213,7 @@ ___ • **provider**: *`ZeroExProvider`* -*Defined in [asset-swapper/src/swap_quoter.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L28)* +*Defined in [asset-swapper/src/swap_quoter.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L28)* ## Methods @@ -249,7 +221,7 @@ ___ ▸ **destroyAsync**(): *`Promise`* -*Defined in [asset-swapper/src/swap_quoter.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L391)* +*Defined in [asset-swapper/src/swap_quoter.ts:396](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L396)* Destroys any subscriptions or connections. @@ -261,7 +233,7 @@ ___ ▸ **getAvailableMakerAssetDatasAsync**(`takerAssetData`: string): *`Promise`* -*Defined in [asset-swapper/src/swap_quoter.ts:309](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L309)* +*Defined in [asset-swapper/src/swap_quoter.ts:315](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L315)* Get the asset data of all assets that are purchaseable with takerAssetData in the order provider passed in at init. @@ -281,7 +253,7 @@ ___ ▸ **getAvailableTakerAssetDatasAsync**(`makerAssetData`: string): *`Promise`* -*Defined in [asset-swapper/src/swap_quoter.ts:294](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L294)* +*Defined in [asset-swapper/src/swap_quoter.ts:300](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L300)* Get the asset data of all assets that can be used to purchase makerAssetData in the order provider passed in at init. @@ -301,7 +273,7 @@ ___ ▸ **getLiquidityForMakerTakerAssetDataPairAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* -*Defined in [asset-swapper/src/swap_quoter.ts:268](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L268)* +*Defined in [asset-swapper/src/swap_quoter.ts:274](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L274)* Returns information about available liquidity for an asset Does not factor in slippage or fees @@ -323,7 +295,7 @@ ___ ▸ **getMarketBuySwapQuoteAsync**(`makerTokenAddress`: string, `takerTokenAddress`: string, `makerAssetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*Defined in [asset-swapper/src/swap_quoter.ts:210](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L210)* +*Defined in [asset-swapper/src/swap_quoter.ts:208](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L208)* Get a `SwapQuote` containing all information relevant to fulfilling a swap between a desired ERC20 token address and ERC20 owned by a provided address. You can then pass the `SwapQuote` to a `SwapQuoteConsumer` to execute a buy, or process SwapQuote for on-chain consumption. @@ -347,7 +319,7 @@ ___ ▸ **getMarketBuySwapQuoteForAssetDataAsync**(`makerAssetData`: string, `takerAssetData`: string, `makerAssetBuyAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*Defined in [asset-swapper/src/swap_quoter.ts:185](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L185)* +*Defined in [asset-swapper/src/swap_quoter.ts:183](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L183)* Get a `SwapQuote` containing all information relevant to fulfilling a swap between a desired ERC20 token address and ERC20 owned by a provided address. You can then pass the `SwapQuote` to a `SwapQuoteConsumer` to execute a buy, or process SwapQuote for on-chain consumption. @@ -371,7 +343,7 @@ ___ ▸ **getMarketSellSwapQuoteAsync**(`makerTokenAddress`: string, `takerTokenAddress`: string, `takerAssetSellAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*Defined in [asset-swapper/src/swap_quoter.ts:240](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L240)* +*Defined in [asset-swapper/src/swap_quoter.ts:242](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L242)* Get a `SwapQuote` containing all information relevant to fulfilling a swap between a desired ERC20 token address and ERC20 owned by a provided address. You can then pass the `SwapQuote` to a `SwapQuoteConsumer` to execute a buy, or process SwapQuote for on-chain consumption. @@ -395,7 +367,7 @@ ___ ▸ **getMarketSellSwapQuoteForAssetDataAsync**(`makerAssetData`: string, `takerAssetData`: string, `takerAssetSellAmount`: `BigNumber`, `options`: `Partial`): *`Promise`* -*Defined in [asset-swapper/src/swap_quoter.ts:159](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L159)* +*Defined in [asset-swapper/src/swap_quoter.ts:157](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L157)* Get a `SwapQuote` containing all information relevant to fulfilling a swap between a desired ERC20 token address and ERC20 owned by a provided address. You can then pass the `SwapQuote` to a `SwapQuoteConsumer` to execute a buy, or process SwapQuote for on-chain consumption. @@ -419,7 +391,7 @@ ___ ▸ **getOrdersAndFillableAmountsAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* -*Defined in [asset-swapper/src/swap_quoter.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L341)* +*Defined in [asset-swapper/src/swap_quoter.ts:347](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L347)* Grab orders from the map, if there is a miss or it is time to refresh, fetch and process the orders @@ -438,7 +410,7 @@ ___ ▸ **isTakerAddressAllowanceEnoughForBestAndWorstQuoteInfoAsync**(`swapQuote`: [SwapQuote](#swapquote), `takerAddress`: string): *`Promise<[boolean, boolean]>`* -*Defined in [asset-swapper/src/swap_quoter.ts:372](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L372)* +*Defined in [asset-swapper/src/swap_quoter.ts:378](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L378)* Util function to check if takerAddress's allowance is enough for 0x exchange contracts to conduct the swap specified by the swapQuote. @@ -457,7 +429,7 @@ ___ ▸ **isTakerMakerAssetDataPairAvailableAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* -*Defined in [asset-swapper/src/swap_quoter.ts:324](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L324)* +*Defined in [asset-swapper/src/swap_quoter.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L330)* Validates the taker + maker asset pair is available from the order provider provided to `SwapQuote`. @@ -478,7 +450,7 @@ ___ ▸ **getSwapQuoterForMeshEndpoint**(`supportedProvider`: [SupportedProvider](#supportedprovider), `meshEndpoint`: string, `options`: `Partial`): *[SwapQuoter](#class-swapquoter)* -*Defined in [asset-swapper/src/swap_quoter.ts:113](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L113)* +*Defined in [asset-swapper/src/swap_quoter.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L111)* Instantiates a new SwapQuoter instance given a 0x Mesh endpoint. This pulls all available liquidity stored in Mesh @@ -500,7 +472,7 @@ ___ ▸ **getSwapQuoterForProvidedOrders**(`supportedProvider`: [SupportedProvider](#supportedprovider), `orders`: `SignedOrder`[], `options`: `Partial`): *[SwapQuoter](#class-swapquoter)* -*Defined in [asset-swapper/src/swap_quoter.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L41)* +*Defined in [asset-swapper/src/swap_quoter.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L41)* Instantiates a new SwapQuoter instance given existing liquidity in the form of orders and feeOrders. @@ -522,7 +494,7 @@ ___ ▸ **getSwapQuoterForStandardRelayerAPIUrl**(`supportedProvider`: [SupportedProvider](#supportedprovider), `sraApiUrl`: string, `options`: `Partial`): *[SwapQuoter](#class-swapquoter)* -*Defined in [asset-swapper/src/swap_quoter.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L61)* +*Defined in [asset-swapper/src/swap_quoter.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L61)* Instantiates a new SwapQuoter instance given a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint @@ -544,7 +516,7 @@ ___ ▸ **getSwapQuoterForStandardRelayerAPIWebsocket**(`supportedProvider`: [SupportedProvider](#supportedprovider), `sraApiUrl`: string, `sraWebsocketAPIUrl`: string, `options`: `Partial`): *[SwapQuoter](#class-swapquoter)* -*Defined in [asset-swapper/src/swap_quoter.ts:88](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/swap_quoter.ts#L88)* +*Defined in [asset-swapper/src/swap_quoter.ts:87](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/swap_quoter.ts#L87)* Instantiates a new SwapQuoter instance given a [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) endpoint and a websocket endpoint. This is more effecient than `getSwapQuoterForStandardRelayerAPIUrl` when requesting multiple quotes. @@ -573,7 +545,7 @@ An instance of SwapQuoter \+ **new BaseOrderProvider**(`orderStore`: [OrderStore](_orderbook_src_order_store_.orderstore.md)): *[BaseOrderProvider](#class-baseorderprovider)* -*Defined in [orderbook/src/order_provider/base_order_provider.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_provider/base_order_provider.ts#L12)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_provider/base_order_provider.ts#L12)* **Parameters:** @@ -589,7 +561,7 @@ Name | Type | • **_orderStore**: *[OrderStore](#class-orderstore)* -*Defined in [orderbook/src/order_provider/base_order_provider.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_provider/base_order_provider.ts#L12)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_provider/base_order_provider.ts#L12)* ## Methods @@ -597,7 +569,7 @@ Name | Type | ▸ **addOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* -*Defined in [orderbook/src/order_provider/base_order_provider.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_provider/base_order_provider.ts#L27)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_provider/base_order_provider.ts#L27)* **Parameters:** @@ -613,7 +585,7 @@ ___ ▸ **createSubscriptionForAssetPairAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* -*Defined in [orderbook/src/order_provider/base_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_provider/base_order_provider.ts#L18)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_provider/base_order_provider.ts#L18)* **Parameters:** @@ -630,7 +602,7 @@ ___ ▸ **destroyAsync**(): *`Promise`* -*Defined in [orderbook/src/order_provider/base_order_provider.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_provider/base_order_provider.ts#L25)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_provider/base_order_provider.ts#L25)* **Returns:** *`Promise`* @@ -640,7 +612,7 @@ ___ ▸ **getAvailableAssetDatasAsync**(): *`Promise`* -*Defined in [orderbook/src/order_provider/base_order_provider.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_provider/base_order_provider.ts#L23)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_provider/base_order_provider.ts#L23)* **Returns:** *`Promise`* @@ -653,25 +625,19 @@ ___ -\+ **new OrderSet**(`orders`: `APIOrder`[]): *[OrderSet](#class-orderset)* +\+ **new OrderSet**(): *[OrderSet](#class-orderset)* -*Defined in [orderbook/src/order_set.ts:6](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_set.ts#L6)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`orders` | `APIOrder`[] | [] | +*Defined in [orderbook/src/order_set.ts:6](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_set.ts#L6)* **Returns:** *[OrderSet](#class-orderset)* ## Methods -### add +### addAsync -▸ **add**(`item`: `APIOrder`): *void* +▸ **addAsync**(`item`: `APIOrder`): *`Promise`* -*Defined in [orderbook/src/order_set.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_set.ts#L19)* +*Defined in [orderbook/src/order_set.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_set.ts#L16)* **Parameters:** @@ -679,15 +645,15 @@ Name | Type | ------ | ------ | `item` | `APIOrder` | -**Returns:** *void* +**Returns:** *`Promise`* ___ -### addMany +### addManyAsync -▸ **addMany**(`items`: `APIOrder`[]): *void* +▸ **addManyAsync**(`items`: `APIOrder`[]): *`Promise`* -*Defined in [orderbook/src/order_set.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_set.ts#L25)* +*Defined in [orderbook/src/order_set.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_set.ts#L22)* **Parameters:** @@ -695,15 +661,15 @@ Name | Type | ------ | ------ | `items` | `APIOrder`[] | -**Returns:** *void* +**Returns:** *`Promise`* ___ -### delete +### deleteAsync -▸ **delete**(`item`: `APIOrder`): *boolean* +▸ **deleteAsync**(`item`: `APIOrder`): *`Promise`* -*Defined in [orderbook/src/order_set.ts:57](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_set.ts#L57)* +*Defined in [orderbook/src/order_set.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_set.ts#L54)* **Parameters:** @@ -711,15 +677,15 @@ Name | Type | ------ | ------ | `item` | `APIOrder` | -**Returns:** *boolean* +**Returns:** *`Promise`* ___ -### deleteMany +### deleteManyAsync -▸ **deleteMany**(`items`: `APIOrder`[]): *void* +▸ **deleteManyAsync**(`items`: `APIOrder`[]): *`Promise`* -*Defined in [orderbook/src/order_set.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_set.ts#L61)* +*Defined in [orderbook/src/order_set.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_set.ts#L58)* **Parameters:** @@ -727,15 +693,15 @@ Name | Type | ------ | ------ | `items` | `APIOrder`[] | -**Returns:** *void* +**Returns:** *`Promise`* ___ -### diff +### diffAsync -▸ **diff**(`other`: [OrderSet](#class-orderset)): *object* +▸ **diffAsync**(`other`: [OrderSet](#class-orderset)): *`Promise`* -*Defined in [orderbook/src/order_set.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_set.ts#L35)* +*Defined in [orderbook/src/order_set.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_set.ts#L32)* **Parameters:** @@ -743,15 +709,15 @@ Name | Type | ------ | ------ | `other` | [OrderSet](#class-orderset) | -**Returns:** *object* +**Returns:** *`Promise`* ___ -### has +### hasAsync -▸ **has**(`order`: `APIOrder`): *boolean* +▸ **hasAsync**(`order`: `APIOrder`): *`Promise`* -*Defined in [orderbook/src/order_set.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_set.ts#L31)* +*Defined in [orderbook/src/order_set.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_set.ts#L28)* **Parameters:** @@ -759,7 +725,7 @@ Name | Type | ------ | ------ | `order` | `APIOrder` | -**Returns:** *boolean* +**Returns:** *`Promise`* ___ @@ -767,7 +733,7 @@ ___ ▸ **size**(): *number* -*Defined in [orderbook/src/order_set.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_set.ts#L15)* +*Defined in [orderbook/src/order_set.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_set.ts#L12)* **Returns:** *number* @@ -777,7 +743,7 @@ ___ ▸ **values**(): *`IterableIterator`* -*Defined in [orderbook/src/order_set.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_set.ts#L53)* +*Defined in [orderbook/src/order_set.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_set.ts#L50)* **Returns:** *`IterableIterator`* @@ -792,7 +758,7 @@ ___ ▸ **getOrderSetForAssetPair**(`assetPairKey`: string): *[OrderSet](#class-orderset)* -*Defined in [orderbook/src/order_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_store.ts#L19)* +*Defined in [orderbook/src/order_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_store.ts#L19)* **Parameters:** @@ -808,7 +774,7 @@ ___ ▸ **getOrderSetForAssets**(`makerAssetData`: string, `takerAssetData`: string): *[OrderSet](#class-orderset)* -*Defined in [orderbook/src/order_store.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_store.ts#L15)* +*Defined in [orderbook/src/order_store.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_store.ts#L15)* **Parameters:** @@ -825,7 +791,7 @@ ___ ▸ **has**(`assetPairKey`: string): *boolean* -*Defined in [orderbook/src/order_store.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_store.ts#L34)* +*Defined in [orderbook/src/order_store.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_store.ts#L34)* **Parameters:** @@ -841,17 +807,17 @@ ___ ▸ **keys**(): *`IterableIterator`* -*Defined in [orderbook/src/order_store.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_store.ts#L40)* +*Defined in [orderbook/src/order_store.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_store.ts#L40)* **Returns:** *`IterableIterator`* ___ -### update +### updateAsync -▸ **update**(`addedRemoved`: [AddedRemovedOrders](#interface-addedremovedorders)): *void* +▸ **updateAsync**(`addedRemoved`: [AddedRemovedOrders](#interface-addedremovedorders)): *`Promise`* -*Defined in [orderbook/src/order_store.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_store.ts#L28)* +*Defined in [orderbook/src/order_store.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_store.ts#L28)* **Parameters:** @@ -859,7 +825,7 @@ Name | Type | ------ | ------ | `addedRemoved` | [AddedRemovedOrders](#interface-addedremovedorders) | -**Returns:** *void* +**Returns:** *`Promise`* ___ @@ -867,7 +833,7 @@ ___ ▸ **values**(`assetPairKey`: string): *`APIOrder`[]* -*Defined in [orderbook/src/order_store.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_store.ts#L37)* +*Defined in [orderbook/src/order_store.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_store.ts#L37)* **Parameters:** @@ -883,7 +849,7 @@ ___ ▸ **assetPairKeyToAssets**(`assetPairKey`: string): *string[]* -*Defined in [orderbook/src/order_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_store.ts#L12)* +*Defined in [orderbook/src/order_store.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_store.ts#L12)* **Parameters:** @@ -899,7 +865,7 @@ ___ ▸ **getKeyForAssetPair**(`makerAssetData`: string, `takerAssetData`: string): *string* -*Defined in [orderbook/src/order_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_store.ts#L9)* +*Defined in [orderbook/src/order_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_store.ts#L9)* **Parameters:** @@ -921,7 +887,7 @@ Name | Type | \+ **new Orderbook**(`orderProvider`: [BaseOrderProvider](_orderbook_src_order_provider_base_order_provider_.baseorderprovider.md), `orderStore`: [OrderStore](_orderbook_src_order_store_.orderstore.md)): *[Orderbook](#class-orderbook)* -*Defined in [orderbook/src/orderbook.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/orderbook.ts#L55)* +*Defined in [orderbook/src/orderbook.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/orderbook.ts#L55)* Creates an Orderbook with the order provider. All order updates are stored in the `OrderStore`. @@ -941,7 +907,7 @@ Name | Type | Description | ▸ **addOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* -*Defined in [orderbook/src/orderbook.ts:98](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/orderbook.ts#L98)* +*Defined in [orderbook/src/orderbook.ts:98](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/orderbook.ts#L98)* Adds the orders to the Order Provider. All accepted orders will be returned and rejected orders will be returned with an message indicating a reason for its rejection @@ -960,7 +926,7 @@ ___ ▸ **destroyAsync**(): *`Promise`* -*Defined in [orderbook/src/orderbook.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/orderbook.ts#L104)* +*Defined in [orderbook/src/orderbook.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/orderbook.ts#L104)* Destroys any subscriptions or connections. @@ -972,7 +938,7 @@ ___ ▸ **getAvailableAssetDatasAsync**(): *`Promise`* -*Defined in [orderbook/src/orderbook.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/orderbook.ts#L90)* +*Defined in [orderbook/src/orderbook.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/orderbook.ts#L90)* Returns all of the Available Asset Pairs for the provided Order Provider. @@ -984,7 +950,7 @@ ___ ▸ **getOrdersAsync**(`makerAssetData`: string, `takerAssetData`: string): *`Promise`* -*Defined in [orderbook/src/orderbook.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/orderbook.ts#L75)* +*Defined in [orderbook/src/orderbook.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/orderbook.ts#L75)* Returns all orders where the order.makerAssetData == makerAssetData and order.takerAssetData == takerAssetData. This pair is then subscribed to @@ -1007,7 +973,7 @@ ___ ▸ **getOrderbookForMeshProvider**(`opts`: [MeshOrderProviderOpts](#interface-meshorderprovideropts)): *[Orderbook](#class-orderbook)* -*Defined in [orderbook/src/orderbook.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/orderbook.ts#L52)* +*Defined in [orderbook/src/orderbook.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/orderbook.ts#L52)* Creates an Orderbook with a Mesh Order Provider. This Provider fetches ALL orders and subscribes to updates on ALL orders. @@ -1026,7 +992,7 @@ ___ ▸ **getOrderbookForPollingProvider**(`opts`: [SRAPollingOrderProviderOpts](#interface-srapollingorderprovideropts)): *[Orderbook](#class-orderbook)* -*Defined in [orderbook/src/orderbook.ts:43](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/orderbook.ts#L43)* +*Defined in [orderbook/src/orderbook.ts:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/orderbook.ts#L43)* Creates an Orderbook with SRA Polling Provider. This Provider simply polls every interval. @@ -1044,7 +1010,7 @@ ___ ▸ **getOrderbookForProvidedOrders**(`orders`: `SignedOrder`[]): *[Orderbook](#class-orderbook)* -*Defined in [orderbook/src/orderbook.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/orderbook.ts#L26)* +*Defined in [orderbook/src/orderbook.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/orderbook.ts#L26)* Creates an Orderbook with the provided orders. This provider simply stores the orders and allows querying. No validation or subscriptions occur. @@ -1063,7 +1029,7 @@ ___ ▸ **getOrderbookForWebsocketProvider**(`opts`: [SRAWebsocketOrderProviderOpts](#interface-srawebsocketorderprovideropts)): *[Orderbook](#class-orderbook)* -*Defined in [orderbook/src/orderbook.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/orderbook.ts#L35)* +*Defined in [orderbook/src/orderbook.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/orderbook.ts#L35)* Creates an Orderbook with the SRA Websocket Provider. This Provider fetches orders via the SRA http endpoint and then subscribes to the asset pair for future updates. @@ -1089,7 +1055,7 @@ Represents the varying smart contracts that can consume a valid swap quote • **Forwarder**: = "FORWARDER" -*Defined in [asset-swapper/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L90)* +*Defined in [asset-swapper/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L88)* ___ @@ -1097,7 +1063,7 @@ ___ • **None**: = "NONE" -*Defined in [asset-swapper/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L91)* +*Defined in [asset-swapper/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L89)*
@@ -1114,7 +1080,7 @@ Possible error messages thrown by an SwapQuoter instance or associated static me • **AssetUnavailable**: = "ASSET_UNAVAILABLE" -*Defined in [asset-swapper/src/types.ts:305](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L305)* +*Defined in [asset-swapper/src/types.ts:303](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L303)* ___ @@ -1122,7 +1088,7 @@ ___ • **FeeAssetUnavailable**: = "FEE_ASSET_UNAVAILABLE" -*Defined in [asset-swapper/src/types.ts:306](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L306)* +*Defined in [asset-swapper/src/types.ts:304](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L304)* ___ @@ -1130,7 +1096,7 @@ ___ • **InsufficientAssetLiquidity**: = "INSUFFICIENT_ASSET_LIQUIDITY" -*Defined in [asset-swapper/src/types.ts:302](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L302)* +*Defined in [asset-swapper/src/types.ts:300](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L300)* ___ @@ -1138,7 +1104,7 @@ ___ • **InsufficientZrxLiquidity**: = "INSUFFICIENT_ZRX_LIQUIDITY" -*Defined in [asset-swapper/src/types.ts:303](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L303)* +*Defined in [asset-swapper/src/types.ts:301](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L301)* ___ @@ -1146,7 +1112,7 @@ ___ • **InvalidOrderProviderResponse**: = "INVALID_ORDER_PROVIDER_RESPONSE" -*Defined in [asset-swapper/src/types.ts:304](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L304)* +*Defined in [asset-swapper/src/types.ts:302](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L302)* ___ @@ -1154,7 +1120,7 @@ ___ • **NoEtherTokenContractFound**: = "NO_ETHER_TOKEN_CONTRACT_FOUND" -*Defined in [asset-swapper/src/types.ts:299](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L299)* +*Defined in [asset-swapper/src/types.ts:297](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L297)* ___ @@ -1162,7 +1128,7 @@ ___ • **NoZrxTokenContractFound**: = "NO_ZRX_TOKEN_CONTRACT_FOUND" -*Defined in [asset-swapper/src/types.ts:300](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L300)* +*Defined in [asset-swapper/src/types.ts:298](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L298)* ___ @@ -1170,7 +1136,7 @@ ___ • **StandardRelayerApiError**: = "STANDARD_RELAYER_API_ERROR" -*Defined in [asset-swapper/src/types.ts:301](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L301)* +*Defined in [asset-swapper/src/types.ts:299](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L299)*
@@ -1205,6 +1171,10 @@ ___ + + + +
# Interface: CalldataInfo @@ -1221,7 +1191,7 @@ ethAmount: If provided, the eth amount in wei to send with the smart contract ca • **calldataHexString**: *string* -*Defined in [asset-swapper/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L39)* +*Defined in [asset-swapper/src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L37)* ___ @@ -1229,7 +1199,7 @@ ___ • **ethAmount**? : *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L42)* +*Defined in [asset-swapper/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L40)* ___ @@ -1237,7 +1207,7 @@ ___ • **methodAbi**: *`MethodAbi`* -*Defined in [asset-swapper/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L40)* +*Defined in [asset-swapper/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L38)* ___ @@ -1245,7 +1215,7 @@ ___ • **toAddress**: *string* -*Defined in [asset-swapper/src/types.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L41)* +*Defined in [asset-swapper/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L39)*
@@ -1270,7 +1240,7 @@ ___ *Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[ethAmount](#optional-ethamount)* -*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L181)* +*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L179)* ___ @@ -1280,7 +1250,7 @@ ___ *Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feePercentage](#feepercentage)* -*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L179)* +*Defined in [asset-swapper/src/types.ts:177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L177)* ___ @@ -1290,7 +1260,7 @@ ___ *Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feeRecipient](#feerecipient)* -*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L180)* +*Defined in [asset-swapper/src/types.ts:178](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L178)* ___ @@ -1300,7 +1270,7 @@ ___ *Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasLimit](#optional-gaslimit)* -*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L169)* +*Defined in [asset-swapper/src/types.ts:167](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L167)* ___ @@ -1310,7 +1280,7 @@ ___ *Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasPrice](#optional-gasprice)* -*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L170)* +*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L168)* ___ @@ -1320,7 +1290,7 @@ ___ *Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[takerAddress](#optional-takeraddress)* -*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L168)* +*Defined in [asset-swapper/src/types.ts:166](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L166)*
@@ -1337,7 +1307,7 @@ ethAmount: The amount of eth (in Wei) sent to the forwarder contract. • **ethAmount**? : *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L181)* +*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L179)* ___ @@ -1345,7 +1315,7 @@ ___ • **feePercentage**: *number* -*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L179)* +*Defined in [asset-swapper/src/types.ts:177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L177)* ___ @@ -1353,7 +1323,7 @@ ___ • **feeRecipient**: *string* -*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L180)* +*Defined in [asset-swapper/src/types.ts:178](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L178)*
@@ -1366,7 +1336,7 @@ ___ • **ethAmount**? : *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:188](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L188)* +*Defined in [asset-swapper/src/types.ts:186](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L186)* ___ @@ -1374,7 +1344,7 @@ ___ • **takerAddress**? : *undefined | string* -*Defined in [asset-swapper/src/types.ts:187](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L187)* +*Defined in [asset-swapper/src/types.ts:185](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L185)*
@@ -1389,7 +1359,7 @@ Represents available liquidity for a given assetData • **makerTokensAvailableInBaseUnits**: *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:322](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L322)* +*Defined in [asset-swapper/src/types.ts:320](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L320)* ___ @@ -1397,7 +1367,7 @@ ___ • **takerTokensAvailableInBaseUnits**: *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:323](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L323)* +*Defined in [asset-swapper/src/types.ts:321](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L321)*
@@ -1415,7 +1385,7 @@ type: Specified MarketOperation the SwapQuote is provided for *Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* -*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L219)* +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L217)* ___ @@ -1425,7 +1395,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* -*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L218)* +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L216)* ___ @@ -1435,7 +1405,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* -*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L216)* +*Defined in [asset-swapper/src/types.ts:214](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L214)* ___ @@ -1443,7 +1413,7 @@ ___ • **makerAssetFillAmount**: *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:237](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L237)* +*Defined in [asset-swapper/src/types.ts:235](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L235)* ___ @@ -1453,7 +1423,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* -*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L217)* +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L215)* ___ @@ -1463,7 +1433,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* -*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L215)* +*Defined in [asset-swapper/src/types.ts:213](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L213)* ___ @@ -1471,7 +1441,7 @@ ___ • **type**: *`Buy`* -*Defined in [asset-swapper/src/types.ts:238](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L238)* +*Defined in [asset-swapper/src/types.ts:236](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L236)* ___ @@ -1481,7 +1451,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* -*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L220)* +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L218)*
@@ -1496,7 +1466,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* -*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L219)* +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L217)* ___ @@ -1506,7 +1476,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* -*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L218)* +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L216)* ___ @@ -1516,7 +1486,7 @@ ___ *Inherited from [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase).[feePercentage](#feepercentage)* -*Defined in [asset-swapper/src/types.ts:242](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L242)* +*Defined in [asset-swapper/src/types.ts:240](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L240)* ___ @@ -1526,7 +1496,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* -*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L216)* +*Defined in [asset-swapper/src/types.ts:214](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L214)* ___ @@ -1536,7 +1506,7 @@ ___ *Inherited from [MarketBuySwapQuote](#interface-marketbuyswapquote).[makerAssetFillAmount](#makerassetfillamount)* -*Defined in [asset-swapper/src/types.ts:237](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L237)* +*Defined in [asset-swapper/src/types.ts:235](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L235)* ___ @@ -1546,7 +1516,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* -*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L217)* +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L215)* ___ @@ -1556,7 +1526,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* -*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L215)* +*Defined in [asset-swapper/src/types.ts:213](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L213)* ___ @@ -1566,7 +1536,7 @@ ___ *Inherited from [MarketBuySwapQuote](#interface-marketbuyswapquote).[type](#type)* -*Defined in [asset-swapper/src/types.ts:238](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L238)* +*Defined in [asset-swapper/src/types.ts:236](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L236)* ___ @@ -1576,7 +1546,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* -*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L220)* +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L218)*
@@ -1594,7 +1564,7 @@ type: Specified MarketOperation the SwapQuote is provided for *Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* -*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L219)* +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L217)* ___ @@ -1604,7 +1574,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* -*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L218)* +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L216)* ___ @@ -1614,7 +1584,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* -*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L216)* +*Defined in [asset-swapper/src/types.ts:214](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L214)* ___ @@ -1624,7 +1594,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* -*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L217)* +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L215)* ___ @@ -1634,7 +1604,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* -*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L215)* +*Defined in [asset-swapper/src/types.ts:213](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L213)* ___ @@ -1642,7 +1612,7 @@ ___ • **takerAssetFillAmount**: *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:228](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L228)* +*Defined in [asset-swapper/src/types.ts:226](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L226)* ___ @@ -1650,7 +1620,7 @@ ___ • **type**: *`Sell`* -*Defined in [asset-swapper/src/types.ts:229](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L229)* +*Defined in [asset-swapper/src/types.ts:227](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L227)* ___ @@ -1660,7 +1630,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* -*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L220)* +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L218)*
@@ -1675,7 +1645,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[bestCaseQuoteInfo](#bestcasequoteinfo)* -*Defined in [asset-swapper/src/types.ts:219](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L219)* +*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L217)* ___ @@ -1685,7 +1655,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[feeOrders](#feeorders)* -*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L218)* +*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L216)* ___ @@ -1695,7 +1665,7 @@ ___ *Inherited from [SwapQuoteWithAffiliateFeeBase](#interface-swapquotewithaffiliatefeebase).[feePercentage](#feepercentage)* -*Defined in [asset-swapper/src/types.ts:242](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L242)* +*Defined in [asset-swapper/src/types.ts:240](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L240)* ___ @@ -1705,7 +1675,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[makerAssetData](#makerassetdata)* -*Defined in [asset-swapper/src/types.ts:216](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L216)* +*Defined in [asset-swapper/src/types.ts:214](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L214)* ___ @@ -1715,7 +1685,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[orders](#orders)* -*Defined in [asset-swapper/src/types.ts:217](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L217)* +*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L215)* ___ @@ -1725,7 +1695,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[takerAssetData](#takerassetdata)* -*Defined in [asset-swapper/src/types.ts:215](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L215)* +*Defined in [asset-swapper/src/types.ts:213](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L213)* ___ @@ -1735,7 +1705,7 @@ ___ *Inherited from [MarketSellSwapQuote](#interface-marketsellswapquote).[takerAssetFillAmount](#takerassetfillamount)* -*Defined in [asset-swapper/src/types.ts:228](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L228)* +*Defined in [asset-swapper/src/types.ts:226](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L226)* ___ @@ -1745,7 +1715,7 @@ ___ *Inherited from [MarketSellSwapQuote](#interface-marketsellswapquote).[type](#type)* -*Defined in [asset-swapper/src/types.ts:229](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L229)* +*Defined in [asset-swapper/src/types.ts:227](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L227)* ___ @@ -1755,7 +1725,7 @@ ___ *Inherited from [SwapQuoteBase](#interface-swapquotebase).[worstCaseQuoteInfo](#worstcasequoteinfo)* -*Defined in [asset-swapper/src/types.ts:220](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L220)* +*Defined in [asset-swapper/src/types.ts:218](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L218)*
@@ -1788,7 +1758,7 @@ methodAbi: The ABI of the smart contract method to call with params. • **ethAmount**? : *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L55)* +*Defined in [asset-swapper/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L53)* ___ @@ -1796,7 +1766,7 @@ ___ • **methodAbi**: *`MethodAbi`* -*Defined in [asset-swapper/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L56)* +*Defined in [asset-swapper/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L54)* ___ @@ -1804,7 +1774,7 @@ ___ • **params**: *`T`* -*Defined in [asset-swapper/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L53)* +*Defined in [asset-swapper/src/types.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L51)* ___ @@ -1812,7 +1782,7 @@ ___ • **toAddress**: *string* -*Defined in [asset-swapper/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L54)* +*Defined in [asset-swapper/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L52)*
@@ -1841,7 +1811,7 @@ executeSwapQuoteOrThrowAsync: Executes a web3 transaction to swap for tokens wit ▸ **executeSwapQuoteOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* -*Defined in [asset-swapper/src/types.ts:147](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L147)* +*Defined in [asset-swapper/src/types.ts:145](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L145)* **Parameters:** @@ -1858,7 +1828,7 @@ ___ ▸ **getCalldataOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise`* -*Defined in [asset-swapper/src/types.ts:142](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L142)* +*Defined in [asset-swapper/src/types.ts:140](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L140)* **Parameters:** @@ -1875,7 +1845,7 @@ ___ ▸ **getSmartContractParamsOrThrowAsync**(`quote`: [SwapQuote](#swapquote), `opts`: `Partial`): *`Promise>`* -*Defined in [asset-swapper/src/types.ts:143](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L143)* +*Defined in [asset-swapper/src/types.ts:141](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L141)* **Parameters:** @@ -1899,7 +1869,7 @@ chainId: The chainId that the desired orders should be for. • **chainId**: *number* -*Defined in [asset-swapper/src/types.ts:154](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L154)* +*Defined in [asset-swapper/src/types.ts:152](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L152)*
@@ -1918,7 +1888,7 @@ Represents the options for executing a swap quote with SwapQuoteConsumer *Overrides [ForwarderSwapQuoteGetOutputOpts](_asset_swapper_src_types_.forwarderswapquotegetoutputopts.md).[ethAmount](#optional-ethamount)* -*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L181)* +*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L179)* ___ @@ -1930,7 +1900,7 @@ ___ *Overrides [ForwarderSwapQuoteGetOutputOpts](_asset_swapper_src_types_.forwarderswapquotegetoutputopts.md).[feePercentage](#feepercentage)* -*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L179)* +*Defined in [asset-swapper/src/types.ts:177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L177)* ___ @@ -1942,7 +1912,7 @@ ___ *Overrides [ForwarderSwapQuoteGetOutputOpts](_asset_swapper_src_types_.forwarderswapquotegetoutputopts.md).[feeRecipient](#feerecipient)* -*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L180)* +*Defined in [asset-swapper/src/types.ts:178](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L178)* ___ @@ -1952,7 +1922,7 @@ ___ *Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasLimit](#optional-gaslimit)* -*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L169)* +*Defined in [asset-swapper/src/types.ts:167](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L167)* ___ @@ -1962,7 +1932,7 @@ ___ *Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[gasPrice](#optional-gasprice)* -*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L170)* +*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L168)* ___ @@ -1972,7 +1942,7 @@ ___ *Inherited from [SwapQuoteExecutionOptsBase](#interface-swapquoteexecutionoptsbase).[takerAddress](#optional-takeraddress)* -*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L168)* +*Defined in [asset-swapper/src/types.ts:166](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L166)* ___ @@ -1982,7 +1952,7 @@ ___ *Inherited from [SwapQuoteGetOutputOpts](#interface-swapquotegetoutputopts).[useExtensionContract](#useextensioncontract)* -*Defined in [asset-swapper/src/types.ts:196](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L196)* +*Defined in [asset-swapper/src/types.ts:194](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L194)*
@@ -1999,7 +1969,7 @@ gasPrice: Gas price in Wei to use for a transaction • **gasLimit**? : *undefined | number* -*Defined in [asset-swapper/src/types.ts:169](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L169)* +*Defined in [asset-swapper/src/types.ts:167](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L167)* ___ @@ -2007,7 +1977,7 @@ ___ • **gasPrice**? : *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:170](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L170)* +*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L168)* ___ @@ -2015,7 +1985,7 @@ ___ • **takerAddress**? : *undefined | string* -*Defined in [asset-swapper/src/types.ts:168](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L168)* +*Defined in [asset-swapper/src/types.ts:166](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L166)*
@@ -2033,7 +2003,7 @@ useConsumerType: If provided, defaults the SwapQuoteConsumer to create output co *Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[ethAmount](#optional-ethamount)* -*Defined in [asset-swapper/src/types.ts:181](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L181)* +*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L179)* ___ @@ -2043,7 +2013,7 @@ ___ *Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feePercentage](#feepercentage)* -*Defined in [asset-swapper/src/types.ts:179](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L179)* +*Defined in [asset-swapper/src/types.ts:177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L177)* ___ @@ -2053,7 +2023,7 @@ ___ *Inherited from [ForwarderSwapQuoteGetOutputOpts](#interface-forwarderswapquotegetoutputopts).[feeRecipient](#feerecipient)* -*Defined in [asset-swapper/src/types.ts:180](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L180)* +*Defined in [asset-swapper/src/types.ts:178](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L178)* ___ @@ -2061,7 +2031,7 @@ ___ • **useExtensionContract**: *[ExtensionContractType](#enumeration-extensioncontracttype)* -*Defined in [asset-swapper/src/types.ts:196](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L196)* +*Defined in [asset-swapper/src/types.ts:194](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L194)*
@@ -2081,7 +2051,7 @@ Represents the options provided to a generic SwapQuoteConsumer • **feeTakerTokenAmount**: *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:258](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L258)* +*Defined in [asset-swapper/src/types.ts:256](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L256)* ___ @@ -2089,7 +2059,7 @@ ___ • **makerTokenAmount**: *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:261](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L261)* +*Defined in [asset-swapper/src/types.ts:259](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L259)* ___ @@ -2097,7 +2067,7 @@ ___ • **takerTokenAmount**: *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:260](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L260)* +*Defined in [asset-swapper/src/types.ts:258](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L258)* ___ @@ -2105,7 +2075,7 @@ ___ • **totalTakerTokenAmount**: *`BigNumber`* -*Defined in [asset-swapper/src/types.ts:259](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L259)* +*Defined in [asset-swapper/src/types.ts:257](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L257)*
@@ -2121,7 +2091,7 @@ slippagePercentage: The percentage buffer to add to account for slippage. Affect • **shouldDisableRequestingFeeOrders**: *boolean* -*Defined in [asset-swapper/src/types.ts:269](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L269)* +*Defined in [asset-swapper/src/types.ts:267](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L267)* ___ @@ -2129,7 +2099,7 @@ ___ • **slippagePercentage**: *number* -*Defined in [asset-swapper/src/types.ts:270](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L270)* +*Defined in [asset-swapper/src/types.ts:268](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L268)*
@@ -2146,7 +2116,7 @@ expiryBufferMs: The number of seconds to add when calculating whether an order i • **chainId**: *number* -*Defined in [asset-swapper/src/types.ts:279](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L279)* +*Defined in [asset-swapper/src/types.ts:277](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L277)* ___ @@ -2154,7 +2124,7 @@ ___ • **expiryBufferMs**: *number* -*Defined in [asset-swapper/src/types.ts:281](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L281)* +*Defined in [asset-swapper/src/types.ts:279](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L279)* ___ @@ -2162,7 +2132,7 @@ ___ • **orderRefreshIntervalMs**: *number* -*Defined in [asset-swapper/src/types.ts:280](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L280)* +*Defined in [asset-swapper/src/types.ts:278](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L278)*
@@ -2205,7 +2175,15 @@ ___ • **components**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)* + +___ + +### `Optional` internalType + +• **internalType**? : *undefined | string* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -2213,7 +2191,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -2221,7 +2199,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -2240,7 +2218,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -2248,7 +2226,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -2272,7 +2250,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -2306,7 +2284,7 @@ Name | Type | ▸ **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/c93b02d55/packages/ethereum-types/src/index.ts#L14)* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -2330,7 +2308,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* ___ @@ -2338,7 +2316,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* ___ @@ -2346,7 +2324,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* ___ @@ -2354,7 +2332,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
@@ -2367,7 +2345,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* ___ @@ -2375,7 +2353,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
@@ -2388,7 +2366,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* ___ @@ -2396,7 +2374,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* ___ @@ -2404,7 +2382,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* ___ @@ -2412,7 +2390,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
@@ -2431,7 +2409,7 @@ ___ • **constant**: *boolean* -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L94)* +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L94)* ___ @@ -2439,7 +2417,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L92)* +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L92)* ___ @@ -2447,7 +2425,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L91)* +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L91)* ___ @@ -2455,7 +2433,7 @@ ___ • **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L93)* +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L93)* ___ @@ -2463,7 +2441,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L96)* +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L96)* ___ @@ -2471,7 +2449,7 @@ ___ • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L95)* +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L95)* ___ @@ -2479,7 +2457,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L90)* +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L90)*
@@ -2513,18 +2491,46 @@ ___ -# Interface: TupleDataItem +# Class: InsufficientAssetLiquidityError +Error class representing insufficient asset liquidity -## Properties -### components +## Constructors + + + +\+ **new InsufficientAssetLiquidityError**(`amountAvailableToFill`: `BigNumber`): *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* + +*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/errors.ts#L12)* + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`amountAvailableToFill` | `BigNumber` | The amount availabe to fill (in base units) factoring in slippage | + +**Returns:** *[InsufficientAssetLiquidityError](#class-insufficientassetliquidityerror)* + +## Properties + +### amountAvailableToFill + +• **amountAvailableToFill**: *`BigNumber`* + +*Defined in [asset-swapper/src/errors.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/errors.ts#L12)* + +The amount availabe to fill (in base units) factoring in slippage. + +___ + +### message + +• **message**: *string* + -• **components**: *[DataItem](#class-dataitem)[]* -*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L141)* ___ @@ -2532,19 +2538,29 @@ ___ • **name**: *string* -*Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* + + ___ -### type +### `Optional` stack -• **type**: *string* +• **stack**? : *undefined | string* + + + +*Overrides void* + + + +___ + +### `Static` Error + +▪ **Error**: *`ErrorConstructor`* -*Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)*
@@ -2565,7 +2581,7 @@ This interface allowed sending synchonous requests, support for which was later ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* -*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -2581,7 +2597,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -2607,7 +2623,7 @@ before the first attempts to conform to EIP1193 ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -2633,7 +2649,7 @@ however it does not conform entirely. ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -2659,7 +2675,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L31)* ___ @@ -2667,7 +2683,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L32)* ___ @@ -2675,7 +2691,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -2683,7 +2699,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -2693,7 +2709,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -2710,7 +2726,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -2725,7 +2741,7 @@ ___ • **accepted**: *`SignedOrder`[]* -*Defined in [orderbook/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L15)* +*Defined in [orderbook/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L15)* ___ @@ -2733,7 +2749,7 @@ ___ • **rejected**: *[RejectedOrder](#class-rejectedorder)[]* -*Defined in [orderbook/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L16)* +*Defined in [orderbook/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L16)*
@@ -2746,7 +2762,7 @@ ___ • **added**: *`APIOrder`[]* -*Defined in [orderbook/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L6)* +*Defined in [orderbook/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L6)* ___ @@ -2754,7 +2770,7 @@ ___ • **assetPairKey**: *string* -*Defined in [orderbook/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L5)* +*Defined in [orderbook/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L5)* ___ @@ -2762,7 +2778,7 @@ ___ • **removed**: *`APIOrder`[]* -*Defined in [orderbook/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L7)* +*Defined in [orderbook/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L7)*
@@ -2777,7 +2793,7 @@ Constructor options for a Mesh Order Provider • **websocketEndpoint**: *string* -*Defined in [orderbook/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L52)* +*Defined in [orderbook/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L50)* ___ @@ -2785,7 +2801,7 @@ ___ • **wsOpts**? : *`WSOpts`* -*Defined in [orderbook/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L54)* +*Defined in [orderbook/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L52)*
@@ -2798,7 +2814,7 @@ ___ • **message**: *string* -*Defined in [orderbook/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L11)* +*Defined in [orderbook/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L11)* ___ @@ -2806,7 +2822,7 @@ ___ • **order**: *`SignedOrder`* -*Defined in [orderbook/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L12)* +*Defined in [orderbook/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L12)*
@@ -2821,7 +2837,7 @@ Constructor options for a SRA Polling Order Provider • **chainId**? : *undefined | number* -*Defined in [orderbook/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L44)* +*Defined in [orderbook/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L42)* ___ @@ -2829,7 +2845,7 @@ ___ • **httpEndpoint**: *string* -*Defined in [orderbook/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L38)* +*Defined in [orderbook/src/types.ts:36](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L36)* ___ @@ -2837,7 +2853,7 @@ ___ • **perPage**? : *undefined | number* -*Defined in [orderbook/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L42)* +*Defined in [orderbook/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L40)* ___ @@ -2845,7 +2861,7 @@ ___ • **pollingIntervalMs**: *number* -*Defined in [orderbook/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L40)* +*Defined in [orderbook/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L38)*
@@ -2856,19 +2872,11 @@ Constructor options for a SRA Websocket Order Provider ## Properties -### `Optional` chainId - -• **chainId**? : *undefined | number* - -*Defined in [orderbook/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L30)* - -___ - ### httpEndpoint • **httpEndpoint**: *string* -*Defined in [orderbook/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L26)* +*Defined in [orderbook/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L26)* ___ @@ -2876,7 +2884,7 @@ ___ • **websocketEndpoint**: *string* -*Defined in [orderbook/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/types.ts#L28)* +*Defined in [orderbook/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/types.ts#L28)*
@@ -2889,7 +2897,7 @@ ___ • **metaData**: *object* -*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L408)* +*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L408)* ___ @@ -2897,7 +2905,7 @@ ___ • **order**: *[SignedOrder](#class-signedorder)* -*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L407)* +*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L407)*
@@ -2912,7 +2920,7 @@ ___ • **assetData**: *string* -*Defined in [types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L424)* +*Defined in [types/src/index.ts:424](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L424)* ___ @@ -2920,7 +2928,7 @@ ___ • **maxAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L426)* +*Defined in [types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L426)* ___ @@ -2928,7 +2936,7 @@ ___ • **minAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L425)* +*Defined in [types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L425)* ___ @@ -2936,7 +2944,7 @@ ___ • **precision**: *number* -*Defined in [types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L427)* +*Defined in [types/src/index.ts:427](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L427)*
@@ -2949,7 +2957,7 @@ ___ • **assetDataA**: *[Asset](#class-asset)* -*Defined in [types/src/index.ts:419](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L419)* +*Defined in [types/src/index.ts:419](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L419)* ___ @@ -2957,7 +2965,7 @@ ___ • **assetDataB**: *[Asset](#class-asset)* -*Defined in [types/src/index.ts:420](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L420)* +*Defined in [types/src/index.ts:420](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L420)*
@@ -3003,8 +3011,6 @@ ___ - - @@ -3070,7 +3076,7 @@ ___ *Inherited from [Order](#interface-order).[chainId](#chainid)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L14)* ___ @@ -3080,7 +3086,7 @@ ___ *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L15)* ___ @@ -3090,7 +3096,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L24)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L24)* ___ @@ -3100,7 +3106,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L18)* ___ @@ -3110,7 +3116,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L16)* ___ @@ -3120,7 +3126,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L20)* ___ @@ -3130,7 +3136,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L26)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L26)* ___ @@ -3140,7 +3146,7 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L22)* ___ @@ -3150,7 +3156,7 @@ ___ *Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L28)* +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L28)* ___ @@ -3160,7 +3166,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L25)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L25)* ___ @@ -3170,7 +3176,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L19)* ___ @@ -3178,7 +3184,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L33)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L33)* ___ @@ -3188,7 +3194,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L17)* ___ @@ -3198,7 +3204,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L21)* ___ @@ -3208,7 +3214,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L27)* ___ @@ -3218,7 +3224,7 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L23)* ___ @@ -3228,7 +3234,7 @@ ___ *Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L29)*
@@ -3260,6 +3266,33 @@ ___ + + + + + + + + + + + + + + + + + + + + + +## Type aliases + + + + + @@ -3305,7 +3338,7 @@ ___ Ƭ **SwapQuote**: *[MarketBuySwapQuote](#interface-marketbuyswapquote) | [MarketSellSwapQuote](#interface-marketsellswapquote)* -*Defined in [asset-swapper/src/types.ts:184](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/asset-swapper/src/types.ts#L184)* +*Defined in [asset-swapper/src/types.ts:182](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/asset-swapper/src/types.ts#L182)* ___ @@ -3324,7 +3357,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L84)* ___ @@ -3338,7 +3371,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L70)* Interface for providers that conform to EIP 1193 Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md @@ -3355,7 +3388,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -3382,7 +3415,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L85)* ___ @@ -3390,7 +3423,7 @@ ___ Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)* -*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L9)* Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library Read more about Providers in the guides section of the 0x docs. @@ -3405,7 +3438,7 @@ ___ Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)* -*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L11)*
@@ -3418,7 +3451,7 @@ ___ • **DEFAULT_TOKEN_PRECISION**: *`18`* = 18 -*Defined in [orderbook/src/order_provider/base_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/orderbook/src/order_provider/base_order_provider.ts#L9)* +*Defined in [orderbook/src/order_provider/base_order_provider.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/orderbook/src/order_provider/base_order_provider.ts#L9)*
@@ -3441,34 +3474,3 @@ ___ - - - -## Type aliases - - - - - - - - - - - - - - - - - - - - - - - - - -
- diff --git a/packages/base-contract/CHANGELOG.json b/packages/base-contract/CHANGELOG.json index 4d27a2d5dd..ea13c87910 100644 --- a/packages/base-contract/CHANGELOG.json +++ b/packages/base-contract/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "5.5.0-beta.1", diff --git a/packages/base-contract/CHANGELOG.md b/packages/base-contract/CHANGELOG.md index ee321cc760..e8dffefc4f 100644 --- a/packages/base-contract/CHANGELOG.md +++ b/packages/base-contract/CHANGELOG.md @@ -5,10 +5,16 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v5.5.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v5.5.0-beta.1 - _November 7, 2019_ * Make `evmExecAsync` protected and rename to `_evmExecAsync` (#2243) * Remove duplicate types `IndexedFilterValues`, `DecodedLogEvent`, `EventCallback` (#2243) + * Added ContractFunctionObj type and supporting types (#2325) + * Added AwaitTransactionSuccessOpts and SendTransactionOpts (#2325) ## v5.5.0-beta.0 - _October 3, 2019_ diff --git a/packages/connect/CHANGELOG.json b/packages/connect/CHANGELOG.json index c7404b8450..5191d0d3d2 100644 --- a/packages/connect/CHANGELOG.json +++ b/packages/connect/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Removed dependency on @0x/order-utils", "pr": 2321 } - ] + ], + "timestamp": 1574030254 }, { "version": "5.1.0-beta.1", diff --git a/packages/connect/CHANGELOG.md b/packages/connect/CHANGELOG.md index 69e477906b..7c85ab11b6 100644 --- a/packages/connect/CHANGELOG.md +++ b/packages/connect/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v5.1.0-beta.2 - _November 17, 2019_ + + * Removed dependency on @0x/order-utils (#2321) + ## v5.1.0-beta.1 - _November 7, 2019_ * All references to network ID have been removed, and references to chain ID have been introduced instead (#2313) diff --git a/packages/connect/docs/reference.mdx b/packages/connect/docs/reference.mdx index 3d59b4317a..13a1d2c188 100644 --- a/packages/connect/docs/reference.mdx +++ b/packages/connect/docs/reference.mdx @@ -1,172 +1,115 @@ -# Class: HttpClient -This class includes all the functionality related to interacting with a set of HTTP endpoints -that implement the standard relayer API v2 -## Constructors -\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)* -*Defined in [connect/src/http_client.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L44)* -Instantiates a new HttpClient instance -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`url` | string | The relayer API base HTTP url you would like to interact with | -**Returns:** *[HttpClient](#class-httpclient)* -An instance of HttpClient -## Methods -### getAssetPairsAsync -▸ **getAssetPairsAsync**(`requestOpts?`: `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise`* -*Defined in [connect/src/http_client.ts:59](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L59)* -Retrieve assetData pair info from the API -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`requestOpts?` | `RequestOpts` & `AssetPairsRequestOpts` & `PagedRequestOpts` | Options specifying assetData information to retrieve, page information, and chain id. | -**Returns:** *`Promise`* -The resulting AssetPairsResponse that match the request -___ -### getFeeRecipientsAsync -▸ **getFeeRecipientsAsync**(`requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise`* -*Defined in [connect/src/http_client.ts:160](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L160)* -Retrieve the list of fee recipient addresses used by the relayer. -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and chain id. | -**Returns:** *`Promise`* -The resulting FeeRecipientsResponse + +## Type aliases + + + + + +### AssetPairsResponse + +Ƭ **AssetPairsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[AssetPairsItem](#interface-assetpairsitem)*›* + +*Defined in [types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L416)* ___ -### getOrderAsync -▸ **getOrderAsync**(`orderHash`: string, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise`* -*Defined in [connect/src/http_client.ts:99](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L99)* -Retrieve a specific order from the API -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | An orderHash generated from the desired order | -`requestOpts?` | [RequestOpts](#interface-requestopts) | - | -**Returns:** *`Promise`* +### FeeRecipientsResponse -The APIOrder that matches the supplied orderHash +Ƭ **FeeRecipientsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*string*›* -___ +*Defined in [types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L484)* -### getOrderConfigAsync +___ -▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise`* -*Defined in [connect/src/http_client.ts:139](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L139)* -Retrieve fee information from the API -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | `OrderConfigRequest` | A OrderConfigRequest instance describing the specific fees to retrieve | -`requestOpts?` | [RequestOpts](#interface-requestopts) | Options specifying chain id. | +### OrdersResponse -**Returns:** *`Promise`* +Ƭ **OrdersResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[APIOrder](#interface-apiorder)*›* -The resulting OrderConfigResponse that matches the request +*Defined in [types/src/index.ts:404](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L404)* ___ -### getOrderbookAsync -▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: `RequestOpts` & `PagedRequestOpts`): *`Promise`* -*Defined in [connect/src/http_client.ts:117](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L117)* -Retrieve an orderbook from the API -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`request` | `OrderbookRequest` | An OrderbookRequest instance describing the specific orderbook to retrieve | -`requestOpts?` | `RequestOpts` & `PagedRequestOpts` | Options specifying page information, and chain id. | -**Returns:** *`Promise`* -The resulting OrderbookResponse that matches the request + +# Interface: APIOrder + + +## Properties + +### metaData + +• **metaData**: *object* + +*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L408)* ___ -### getOrdersAsync +### order -▸ **getOrdersAsync**(`requestOpts?`: `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise`* +• **order**: *[SignedOrder](#class-signedorder)* -*Defined in [connect/src/http_client.ts:79](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L79)* +*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L407)* -Retrieve orders from the API +
-**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`requestOpts?` | `RequestOpts` & `OrdersRequestOpts` & `PagedRequestOpts` | Options specifying orders to retrieve and page information, page information, and chain id. | -**Returns:** *`Promise`* -The resulting OrdersResponse that match the request -___ -### submitOrderAsync -▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`, `requestOpts?`: [RequestOpts](#interface-requestopts)): *`Promise`* -*Defined in [connect/src/http_client.ts:177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/http_client.ts#L177)* -Submit a signed order to the API -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`signedOrder` | `SignedOrder` | A SignedOrder instance to submit | -`requestOpts?` | [RequestOpts](#interface-requestopts) | Options specifying chain id. | -**Returns:** *`Promise`* -
@@ -200,86 +143,183 @@ Name | Type | Description | -# Interface: APIOrder -## Properties -### metaData + -• **metaData**: *object* -*Defined in [types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L408)* -___ -### order -• **order**: *[SignedOrder](#class-signedorder)* -*Defined in [types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L407)* -
+# Class: HttpClient + +This class includes all the functionality related to interacting with a set of HTTP endpoints +that implement the standard relayer API v2 + + +## Constructors + + + +\+ **new HttpClient**(`url`: string): *[HttpClient](#class-httpclient)* + +*Defined in [connect/src/http_client.ts:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L43)* + +Instantiates a new HttpClient instance + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`url` | string | The relayer API base HTTP url you would like to interact with | +**Returns:** *[HttpClient](#class-httpclient)* +An instance of HttpClient +## Methods +### getAssetPairsAsync +▸ **getAssetPairsAsync**(`requestOpts?`: `AssetPairsRequestOpts` & `PagedRequestOpts`): *`Promise`* +*Defined in [connect/src/http_client.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L58)* +Retrieve assetData pair info from the API +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`requestOpts?` | `AssetPairsRequestOpts` & `PagedRequestOpts` | Options specifying assetData information to retrieve, page information. | +**Returns:** *`Promise`* +The resulting AssetPairsResponse that match the request +___ +### getFeeRecipientsAsync +▸ **getFeeRecipientsAsync**(`requestOpts?`: [PagedRequestOpts](#interface-pagedrequestopts)): *`Promise`* +*Defined in [connect/src/http_client.ts:140](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L140)* +Retrieve the list of fee recipient addresses used by the relayer. +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`requestOpts?` | [PagedRequestOpts](#interface-pagedrequestopts) | Options specifying page information. | +**Returns:** *`Promise`* +The resulting FeeRecipientsResponse +___ +### getOrderAsync +▸ **getOrderAsync**(`orderHash`: string): *`Promise`* +*Defined in [connect/src/http_client.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L94)* +Retrieve a specific order from the API +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`orderHash` | string | An orderHash generated from the desired order | +**Returns:** *`Promise`* +The APIOrder that matches the supplied orderHash +___ +### getOrderConfigAsync +▸ **getOrderConfigAsync**(`request`: `OrderConfigRequest`): *`Promise`* +*Defined in [connect/src/http_client.ts:126](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L126)* +Retrieve fee information from the API +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`request` | `OrderConfigRequest` | A OrderConfigRequest instance describing the specific fees to retrieve | +**Returns:** *`Promise`* +The resulting OrderConfigResponse that matches the request +___ +### getOrderbookAsync +▸ **getOrderbookAsync**(`request`: `OrderbookRequest`, `requestOpts?`: [PagedRequestOpts](#interface-pagedrequestopts)): *`Promise`* +*Defined in [connect/src/http_client.ts:106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L106)* +Retrieve an orderbook from the API +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`request` | `OrderbookRequest` | An OrderbookRequest instance describing the specific orderbook to retrieve | +`requestOpts?` | [PagedRequestOpts](#interface-pagedrequestopts) | Options specifying page information. | +**Returns:** *`Promise`* +The resulting OrderbookResponse that matches the request +___ +### getOrdersAsync +▸ **getOrdersAsync**(`requestOpts?`: `OrdersRequestOpts` & `PagedRequestOpts`): *`Promise`* - +*Defined in [connect/src/http_client.ts:77](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L77)* +Retrieve orders from the API +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`requestOpts?` | `OrdersRequestOpts` & `PagedRequestOpts` | Options specifying orders to retrieve and page information, page information. | +**Returns:** *`Promise`* +The resulting OrdersResponse that match the request +___ +### submitOrderAsync +▸ **submitOrderAsync**(`signedOrder`: `SignedOrder`): *`Promise`* + +*Defined in [connect/src/http_client.ts:155](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/http_client.ts#L155)* + +Submit a signed order to the API + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`signedOrder` | `SignedOrder` | A SignedOrder instance to submit | + +**Returns:** *`Promise`* + +
@@ -322,7 +362,7 @@ ___ • **page**? : *undefined | number* -*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L491)* +*Defined in [types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L491)* ___ @@ -330,7 +370,7 @@ ___ • **perPage**? : *undefined | number* -*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L492)* +*Defined in [types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L492)*
@@ -347,7 +387,7 @@ ___ • **page**: *number* -*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L459)* +*Defined in [types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L459)* ___ @@ -355,7 +395,7 @@ ___ • **perPage**: *number* -*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L460)* +*Defined in [types/src/index.ts:460](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L460)* ___ @@ -363,7 +403,7 @@ ___ • **records**: *`T`[]* -*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L461)* +*Defined in [types/src/index.ts:461](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L461)* ___ @@ -371,7 +411,7 @@ ___ • **total**: *number* -*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L458)* +*Defined in [types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L458)*
@@ -381,6 +421,8 @@ ___ + + # Interface: SignedOrder @@ -392,7 +434,7 @@ ___ *Inherited from [Order](#interface-order).[chainId](#chainid)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L14)* ___ @@ -402,7 +444,7 @@ ___ *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L15)* ___ @@ -412,7 +454,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L24)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L24)* ___ @@ -422,7 +464,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L18)* ___ @@ -432,7 +474,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L16)* ___ @@ -442,7 +484,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L20)* ___ @@ -452,7 +494,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L26)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L26)* ___ @@ -462,7 +504,7 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L22)* ___ @@ -472,7 +514,7 @@ ___ *Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L28)* +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L28)* ___ @@ -482,7 +524,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L25)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L25)* ___ @@ -492,7 +534,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L19)* ___ @@ -500,7 +542,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L33)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L33)* ___ @@ -510,7 +552,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L17)* ___ @@ -520,7 +562,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L21)* ___ @@ -530,7 +572,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L27)* ___ @@ -540,7 +582,7 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L23)* ___ @@ -550,7 +592,7 @@ ___ *Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L29)*
@@ -601,6 +643,10 @@ ___ + +
+ +
@@ -613,13 +659,13 @@ ___ #### ▪ **ordersChannelFactory**: *object* -*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/orders_channel_factory.ts#L7)* +*Defined in [connect/src/orders_channel_factory.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/orders_channel_factory.ts#L7)* #### createWebSocketOrdersChannelAsync ▸ **createWebSocketOrdersChannelAsync**(`url`: string, `handler`: [OrdersChannelHandler](#interface-orderschannelhandler)): *`Promise`* -*Defined in [connect/src/orders_channel_factory.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/connect/src/orders_channel_factory.ts#L15)* +*Defined in [connect/src/orders_channel_factory.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/connect/src/orders_channel_factory.ts#L15)* Instantiates a new WebSocketOrdersChannel instance @@ -636,52 +682,3 @@ An OrdersChannel Promise
- - -
- - - - -## Type aliases - - - - - -### AssetPairsResponse - -Ƭ **AssetPairsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[AssetPairsItem](#interface-assetpairsitem)*›* - -*Defined in [types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L416)* - -___ - - - - - - - -### FeeRecipientsResponse - -Ƭ **FeeRecipientsResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*string*›* - -*Defined in [types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L484)* - -___ - - - - - -### OrdersResponse - -Ƭ **OrdersResponse**: *[PaginatedCollection](#interface-paginatedcollection)‹*[APIOrder](#interface-apiorder)*›* - -*Defined in [types/src/index.ts:404](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L404)* - -___ - - - diff --git a/packages/contract-addresses/CHANGELOG.json b/packages/contract-addresses/CHANGELOG.json index b96a1f59ff..971917b989 100644 --- a/packages/contract-addresses/CHANGELOG.json +++ b/packages/contract-addresses/CHANGELOG.json @@ -10,7 +10,8 @@ "note": "Update ZeroExGovernor address on all testnets", "pr": 2322 } - ] + ], + "timestamp": 1574030254 }, { "version": "3.3.0-beta.2", diff --git a/packages/contract-addresses/CHANGELOG.md b/packages/contract-addresses/CHANGELOG.md index 3da40c1165..fea3f312bc 100644 --- a/packages/contract-addresses/CHANGELOG.md +++ b/packages/contract-addresses/CHANGELOG.md @@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.3.0-beta.3 - _November 17, 2019_ + + * Update all v3 mainnet addresses (#2322) + * Update ZeroExGovernor address on all testnets (#2322) + ## v3.3.0-beta.2 - _November 7, 2019_ * Updated devUtils contract addresses on testnets diff --git a/packages/contract-artifacts/CHANGELOG.json b/packages/contract-artifacts/CHANGELOG.json index 2a4a4f5e1b..a90d3aa7d2 100644 --- a/packages/contract-artifacts/CHANGELOG.json +++ b/packages/contract-artifacts/CHANGELOG.json @@ -14,7 +14,8 @@ "note": "Updated Coordinator + Coordinator Registry artifacts", "pr": 2346 } - ] + ], + "timestamp": 1574030254 }, { "version": "2.3.0-beta.2", diff --git a/packages/contract-artifacts/CHANGELOG.md b/packages/contract-artifacts/CHANGELOG.md index 43c39f8f6c..8278af7d9f 100644 --- a/packages/contract-artifacts/CHANGELOG.md +++ b/packages/contract-artifacts/CHANGELOG.md @@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.3.0-beta.3 - _November 17, 2019_ + + * Replace Staking artifact with TestStaking (#2322) + * Added `ZrxVault` and `ERC20BridgeProxy` artifacts (#2323) + * Updated Coordinator + Coordinator Registry artifacts (#2346) + ## v2.3.0-beta.2 - _November 7, 2019_ * Update DevUtils contract artifacts diff --git a/packages/contract-wrappers/CHANGELOG.json b/packages/contract-wrappers/CHANGELOG.json index 74404c2265..fb2e9ecabd 100644 --- a/packages/contract-wrappers/CHANGELOG.json +++ b/packages/contract-wrappers/CHANGELOG.json @@ -14,7 +14,8 @@ "note": "Export types `ContractFunctionObj` and `ContractTxFunctionObj`", "pr": 2325 } - ] + ], + "timestamp": 1574030254 }, { "version": "12.2.0-beta.1", diff --git a/packages/contract-wrappers/CHANGELOG.md b/packages/contract-wrappers/CHANGELOG.md index 807981dbba..5a785dc555 100644 --- a/packages/contract-wrappers/CHANGELOG.md +++ b/packages/contract-wrappers/CHANGELOG.md @@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v12.2.0-beta.2 - _November 17, 2019_ + + * [Breaking] Remove `erc20Proxy`, `erc721Proxy` and `dutchAuction` wrappers (#2324) + * [Breaking] Big refactor of contract wrapper interface. See https://github.com/0xProject/0x-monorepo/pull/2325 for details (#2325) + * Export types `ContractFunctionObj` and `ContractTxFunctionObj` (#2325) + ## v12.2.0-beta.1 - _November 7, 2019_ * All references to network ID have been removed, and references to chain ID have been introduced instead (#2313) diff --git a/packages/contract-wrappers/docs/reference.mdx b/packages/contract-wrappers/docs/reference.mdx index 91f54d2ca8..f8c14220ac 100644 --- a/packages/contract-wrappers/docs/reference.mdx +++ b/packages/contract-wrappers/docs/reference.mdx @@ -1,15 +1,17 @@ -# Class: CoordinatorContract + + +# Class: CoordinatorRegistryContract ## Constructors -\+ **new CoordinatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[CoordinatorContract](#class-coordinatorcontract)* +\+ **new CoordinatorRegistryContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1112](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1112)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:465](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L465)* **Parameters:** @@ -19,9 +21,9 @@ Name | Type | Default | `supportedProvider` | [SupportedProvider](#supportedprovider) | - | `txDefaults?` | `Partial` | - | `logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | CoordinatorContract.deployedBytecode | +`deployedBytecode` | string \| undefined | CoordinatorRegistryContract.deployedBytecode | -**Returns:** *[CoordinatorContract](#class-coordinatorcontract)* +**Returns:** *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* ## Properties @@ -31,7 +33,7 @@ Name | Type | Default | -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:32 ___ @@ -41,7 +43,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -51,7 +53,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:29 ___ @@ -61,7 +63,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -71,451 +73,288 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:30 ## Methods -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:818](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L818)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI +### getABIDecodedReturnData -___ +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -### `Static` deployAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:208](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L208)* -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* +**Type parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:771](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L771)* +▪ **T** **Parameters:** Name | Type | ------ | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | +`methodName` | string | +`callData` | string | -**Returns:** *`Promise`* +**Returns:** *`T`* ___ -### `Static` deployFrom0xArtifactAsync +### getABIDecodedTransactionData + +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:201](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L201)* + +**Type parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:738](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L738)* +▪ **T** **Parameters:** Name | Type | ------ | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | +`methodName` | string | +`callData` | string | -**Returns:** *`Promise`* +**Returns:** *`T`* ___ -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* +### getCoordinatorEndpoint +▸ **getCoordinatorEndpoint**(`coordinatorOperator`: string): *`ContractFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:227](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L227)* -Defined in base-contract/lib/src/index.d.ts:41 +Gets the endpoint for a Coordinator. **Parameters:** -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### EIP712_COORDINATOR_DOMAIN_HASH +Name | Type | Description | +------ | ------ | ------ | +`coordinatorOperator` | string | Operator of the Coordinator endpoint. | -#### ▪ **EIP712_COORDINATOR_DOMAIN_HASH**: *object* +**Returns:** *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:695](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L695)* +coordinatorEndpoint Endpoint of the Coordinator as a string. -#### callAsync +___ -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### getFunctionSignature -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:701](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L701)* +▸ **getFunctionSignature**(`methodName`: string): *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:195](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L195)* **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | +------ | ------ | +`methodName` | string | -**Returns:** *`Promise`* +**Returns:** *string* ___ -### EIP712_EXCHANGE_DOMAIN_HASH - -#### ▪ **EIP712_EXCHANGE_DOMAIN_HASH**: *object* +### getLogsAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:498](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L498)* +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:449](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L449)* -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +Gets historical logs without creating a subscription -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:504](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L504)* +**Type parameters:** -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. +▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### assertValidCoordinatorApprovals - -#### ▪ **assertValidCoordinatorApprovals**: *object* +`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}` | -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:545](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L545)* +**Returns:** *`Promise>>`* -Validates that the 0x transaction has been approved by all of the feeRecipients -that correspond to each order in the transaction's Exchange calldata. +Array of logs that match the parameters -#### callAsync +___ -▸ **callAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### getSelector -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:560](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L560)* +▸ **getSelector**(`methodName`: string): *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L215)* **Parameters:** -Name | Type | 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) | - | - | +Name | Type | +------ | ------ | +`methodName` | string | -**Returns:** *`Promise`* +**Returns:** *string* ___ -### decodeOrdersFromFillData - -#### ▪ **decodeOrdersFromFillData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:623](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L623)* - -Decodes the orders from Exchange calldata representing any fill method. - -#### callAsync +### setCoordinatorEndpoint -▸ **callAsync**(`data`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* +▸ **setCoordinatorEndpoint**(`coordinatorEndpoint`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:631](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L631)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:283](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L283)* -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. +Called by a Coordinator operator to set the endpoint of their Coordinator. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`data` | string | - | Exchange calldata representing a fill method. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise>`* +Name | Type | Description | +------ | ------ | ------ | +`coordinatorEndpoint` | string | Endpoint of the Coordinator as a string. | -The orders from the Exchange calldata. +**Returns:** *`ContractTxFunctionObj`* ___ -### executeTransaction - -#### ▪ **executeTransaction**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:206](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L206)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:288](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L288)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* +### subscribe -A promise that resolves when the transaction is successful +▸ **subscribe**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:407](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L407)* -▸ **callAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +Subscribe to an event type emitted by the CoordinatorRegistry contract. -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L389)* +**Type parameters:** -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. +▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* **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:337](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L337)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** +`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 | - | - | -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:** *string* -**Returns:** *`Promise`* +Subscription token used later to unsubscribe -The hash of the transaction +___ -#### getABIEncodedTransactionData +### unsubscribe -▸ **getABIEncodedTransactionData**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *string* +▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:463](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L463)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L432)* -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). +Cancel a subscription **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 +`subscriptionToken` | string | Subscription token returned by `subscribe()` | -#### getSelector +**Returns:** *void* -▸ **getSelector**(): *string* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:490](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L490)* +### unsubscribeAll -Returns the 4 byte function selector as a hex string. +▸ **unsubscribeAll**(): *void* -**Returns:** *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:438](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L438)* -#### sendTransactionAsync +Cancels all existing subscriptions -▸ **sendTransactionAsync**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +**Returns:** *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:222](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L222)* +___ -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +### `Static` ABI -**Parameters:** +▸ **ABI**(): *[ContractAbi](#contractabi)* -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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L131)* -**Returns:** *`Promise`* +**Returns:** *[ContractAbi](#contractabi)* -The hash of the transaction +The contract ABI ___ -### getCoordinatorApprovalHash - -#### ▪ **getCoordinatorApprovalHash**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:145](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L145)* - -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`* +### `Static` deployAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:154](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L154)* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:89](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L89)* **Parameters:** -Name | Type | 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`* +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -EIP712 hash of the Coordinator approval message with the domain separator of this contract. +**Returns:** *`Promise`* ___ -### getSignerAddress - -#### ▪ **getSignerAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L44)* - -Recovers the address of a signer given a hash and signature. - -#### callAsync - -▸ **callAsync**(`hash`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### `Static` deployFrom0xArtifactAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L52)* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L58)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`hash` | string | - | Any 32 byte hash. | -`signature` | string | - | Proof that the hash has been signed by signer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ -### getTransactionHash - -#### ▪ **getTransactionHash**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L91)* - -Calculates the EIP712 hash of a 0x transaction using the domain separator of the Exchange contract. +### `Static` strictArgumentEncodingCheck -#### callAsync +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -▸ **callAsync**(`transaction`: object, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:99](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.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. +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`transaction` | object | - | 0x transaction containing salt, signerAddress, and data. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -EIP712 hash of the transaction with the domain separator of this contract. +**Returns:** *string*
-# Class: CoordinatorRegistryContract +# Class: DevUtilsContract ## Constructors -\+ **new CoordinatorRegistryContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* +\+ **new DevUtilsContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DevUtilsContract](#class-devutilscontract)* *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:473](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L473)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3929](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3929)* **Parameters:** @@ -525,19 +364,19 @@ Name | Type | Default | `supportedProvider` | [SupportedProvider](#supportedprovider) | - | `txDefaults?` | `Partial` | - | `logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | CoordinatorRegistryContract.deployedBytecode | +`deployedBytecode` | string \| undefined | DevUtilsContract.deployedBytecode | -**Returns:** *[CoordinatorRegistryContract](#class-coordinatorregistrycontract)* +**Returns:** *[DevUtilsContract](#class-devutilscontract)* ## Properties -#### `Optional` _deployedBytecodeIfExists +### `Optional` _deployedBytecodeIfExists • **_deployedBytecodeIfExists**? : *`Buffer`* -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:32 ___ @@ -547,7 +386,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -557,7 +396,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:29 ___ @@ -567,7 +406,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -577,2078 +416,1925 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:30 ## Methods -### getLogsAsync +### decodeAssetProxyDispatchError -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [CoordinatorRegistryEvents](#enumeration-coordinatorregistryevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* +▸ **decodeAssetProxyDispatchError**(`encoded`: string): *`ContractFunctionObj<[number, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:457](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L457)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1516](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1516)* -Gets historical logs without creating a subscription - -**Type parameters:** - -▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* +Decompose an ABI-encoded AssetProxyDispatchError. **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}` | +`encoded` | string | ABI-encoded revert error. | -**Returns:** *`Promise>>`* +**Returns:** *`ContractFunctionObj<[number, string, string]>`* -Array of logs that match the parameters +errorCode The error code.orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched. ___ -### 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:415](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L415)* +### decodeAssetProxyExistsError -Subscribe to an event type emitted by the CoordinatorRegistry contract. +▸ **decodeAssetProxyExistsError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* -**Type parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1564](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1564)* -▪ **ArgsType**: *[CoordinatorRegistryEventArgs](#coordinatorregistryeventargs)* +Decompose an ABI-encoded AssetProxyExistsError. **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 | - | - | +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -**Returns:** *string* +**Returns:** *`ContractFunctionObj<[string, string]>`* -Subscription token used later to unsubscribe +assetProxyId Id of asset proxy.assetProxyAddress The address of the asset proxy. ___ -### unsubscribe +### decodeAssetProxyId -▸ **unsubscribe**(`subscriptionToken`: string): *void* +▸ **decodeAssetProxyId**(`assetData`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:440](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L440)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1610](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1610)* -Cancel a subscription +Decode AssetProxy identifier **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | - -**Returns:** *void* - -___ +`assetData` | string | AssetProxy-compliant asset data describing an ERC-20, ERC- 721, ERC1155, or MultiAsset asset. | -### unsubscribeAll +**Returns:** *`ContractFunctionObj`* -▸ **unsubscribeAll**(): *void* +The AssetProxy identifier -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:446](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L446)* +___ -Cancels all existing subscriptions +### decodeAssetProxyTransferError -**Returns:** *void* +▸ **decodeAssetProxyTransferError**(`encoded`: string): *`ContractFunctionObj<[string, string, string]>`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1653](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1653)* -### `Static` ABI +Decompose an ABI-encoded AssetProxyTransferError. -▸ **ABI**(): *[ContractAbi](#contractabi)* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L343)* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -**Returns:** *[ContractAbi](#contractabi)* +**Returns:** *`ContractFunctionObj<[string, string, string]>`* -The contract ABI +orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched.errorData ABI-encoded revert data from the asset proxy. ___ -### `Static` deployAsync +### decodeEIP1271SignatureError -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **decodeEIP1271SignatureError**(`encoded`: string): *`ContractFunctionObj<[string, string, string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:301](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L301)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1701](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1701)* + +Decompose an ABI-encoded SignatureValidatorError. **Parameters:** -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj<[string, string, string, string]>`* + +signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. ___ -### `Static` deployFrom0xArtifactAsync +### decodeERC1155AssetData -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **decodeERC1155AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, BigNumber[], BigNumber[], string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1750](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1750)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:270](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L270)* +Decode ERC-1155 asset data from the format described in the AssetProxy contract specification. **Parameters:** -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-1155 set of assets. | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj<[string, string, BigNumber[], BigNumber[], string]>`* -___ +The ERC-1155 AssetProxy identifier, the address of the ERC-1155 contract hosting the assets, an array of the identifiers of the assets to be traded, an array of asset amounts to be traded, and callback data. Each element of the arrays corresponds to the same-indexed element of the other array. Return values specified as `memory` are returned as pointers to locations within the memory of the input parameter `assetData`. -### `Static` strictArgumentEncodingCheck +___ -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* +### decodeERC20AssetData +▸ **decodeERC20AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1802](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1802)* -Defined in base-contract/lib/src/index.d.ts:41 +Decode ERC-20 asset data from the format described in the AssetProxy contract specification. **Parameters:** -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-20 asset. | -**Returns:** *string* +**Returns:** *`ContractFunctionObj<[string, string]>`* -## Object literals +The AssetProxy identifier, and the address of the ERC-20 contract hosting this asset. -### getCoordinatorEndpoint +___ -#### ▪ **getCoordinatorEndpoint**: *object* +### decodeERC721AssetData -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:218](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L218)* +▸ **decodeERC721AssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, BigNumber]>`* -Gets the endpoint for a Coordinator. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1848](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1848)* -#### callAsync +Decode ERC-721 asset data from the format described in the AssetProxy contract specification. -▸ **callAsync**(`coordinatorOperator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:225](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L225)* +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing an ERC-721 asset. | -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. +**Returns:** *`ContractFunctionObj<[string, string, BigNumber]>`* -**Parameters:** +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. -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`coordinatorOperator` | string | - | operator of the Coordinator endpoint. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +___ -**Returns:** *`Promise`* +### decodeExchangeInvalidContextError -___ +▸ **decodeExchangeInvalidContextError**(`encoded`: string): *`ContractFunctionObj<[number, string, string]>`* -### setCoordinatorEndpoint +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1896](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1896)* -#### ▪ **setCoordinatorEndpoint**: *object* +Decompose an ABI-encoded OrderStatusError. -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:56](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L56)* +**Parameters:** -Called by a Coordinator operator to set the endpoint of their Coordinator. +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | + +**Returns:** *`ContractFunctionObj<[number, string, string]>`* + +errorCode Error code that corresponds to invalid maker, taker, or sender.orderHash The order hash.contextAddress The maker, taker, or sender address -#### awaitTransactionSuccessAsync +___ + +### decodeFillError -▸ **awaitTransactionSuccessAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +▸ **decodeFillError**(`encoded`: string): *`ContractFunctionObj<[number, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:99](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L99)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1945](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1945)* -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. +Decompose an ABI-encoded FillError. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`coordinatorEndpoint` | string | - | endpoint of the Coordinator. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -**Returns:** *`PromiseWithTransactionHash`* +**Returns:** *`ContractFunctionObj<[number, string]>`* + +errorCode The error code.orderHash The order hash. -A promise that resolves when the transaction is successful +___ -#### callAsync +### decodeIncompleteFillError -▸ **callAsync**(`coordinatorEndpoint`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **decodeIncompleteFillError**(`encoded`: string): *`ContractFunctionObj<[number, BigNumber, BigNumber]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:150](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L150)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1988](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1988)* -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. +Decompose an ABI-encoded IncompleteFillError. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`coordinatorEndpoint` | string | - | endpoint of the Coordinator. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj<[number, BigNumber, BigNumber]>`* + +orderHash Hash of the order being filled. + +___ -#### estimateGasAsync +### decodeMultiAssetData -▸ **estimateGasAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined): *`Promise`* +▸ **decodeMultiAssetData**(`assetData`: string): *`ContractFunctionObj<[string, BigNumber[], string[]]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:125](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L125)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2036](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2036)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +Decode multi-asset data from the format described in the AssetProxy contract specification. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`coordinatorEndpoint` | string | endpoint of the Coordinator. | -`txData?` | `Partial` \| undefined | Additional data for transaction | +`assetData` | string | AssetProxy-compliant data describing a multi-asset basket. | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj<[string, BigNumber[], string[]]>`* + +The Multi-Asset AssetProxy identifier, an array of the amounts of the assets to be traded, and an array of the AssetProxy-compliant data describing each asset to be traded. Each element of the arrays corresponds to the same-indexed element of the other array. -The hash of the transaction +___ -#### getABIEncodedTransactionData +### decodeNegativeSpreadError -▸ **getABIEncodedTransactionData**(`coordinatorEndpoint`: string): *string* +▸ **decodeNegativeSpreadError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:198](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L198)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2084](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2084)* -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). +Decompose an ABI-encoded NegativeSpreadError. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`coordinatorEndpoint` | string | endpoint of the Coordinator. | +`encoded` | string | ABI-encoded revert error. | -**Returns:** *string* +**Returns:** *`ContractFunctionObj<[string, string]>`* -The ABI encoded transaction data as a string +leftOrderHash Hash of the left order being matched.rightOrderHash Hash of the right order being matched. -#### getSelector +___ -▸ **getSelector**(): *string* +### decodeOrderEpochError -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:209](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L209)* +▸ **decodeOrderEpochError**(`encoded`: string): *`ContractFunctionObj<[string, string, BigNumber]>`* -Returns the 4 byte function selector as a hex string. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2129](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2129)* -**Returns:** *string* +Decompose an ABI-encoded OrderEpochError. -#### sendTransactionAsync +**Parameters:** -▸ **sendTransactionAsync**(`coordinatorEndpoint`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:64](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L64)* +**Returns:** *`ContractFunctionObj<[string, string, BigNumber]>`* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +makerAddress The order maker.orderSenderAddress The order sender.currentEpoch The current epoch for the maker. -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`coordinatorEndpoint` | string | - | endpoint of the Coordinator. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +### decodeOrderStatusError -**Returns:** *`Promise`* +▸ **decodeOrderStatusError**(`encoded`: string): *`ContractFunctionObj<[string, number]>`* -The hash of the transaction +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2177)* -
+Decompose an ABI-encoded OrderStatusError. -# Class: DevUtilsContract +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | +**Returns:** *`ContractFunctionObj<[string, number]>`* -## Constructors +orderHash The order hash.orderStatus The order status. +___ +### decodeSignatureError -\+ **new DevUtilsContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DevUtilsContract](#class-devutilscontract)* +▸ **decodeSignatureError**(`encoded`: string): *`ContractFunctionObj<[number, string, string, string]>`* -*Overrides void* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2222](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2222)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:4076](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L4076)* +Decompose an ABI-encoded SignatureError. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | DevUtilsContract.deployedBytecode | +`encoded` | string | ABI-encoded revert error. | -**Returns:** *[DevUtilsContract](#class-devutilscontract)* +**Returns:** *`ContractFunctionObj<[number, string, string, string]>`* -## Properties +errorCode The error code.signerAddress The expected signer of the hash.signature The full signature. -#### `Optional` _deployedBytecodeIfExists +___ -• **_deployedBytecodeIfExists**? : *`Buffer`* +### decodeSignatureValidatorNotApprovedError +▸ **decodeSignatureValidatorNotApprovedError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2268](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2268)* -Defined in base-contract/lib/src/index.d.ts:31 +Decompose an ABI-encoded SignatureValidatorNotApprovedError. -___ +**Parameters:** -### abi +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -• **abi**: *[ContractAbi](#contractabi)* +**Returns:** *`ContractFunctionObj<[string, string]>`* +signerAddress The expected signer of the hash.validatorAddress The expected validator. +___ -Defined in base-contract/lib/src/index.d.ts:27 +### decodeSignatureWalletError -___ +▸ **decodeSignatureWalletError**(`encoded`: string): *`ContractFunctionObj<[string, string, string, string]>`* -### address +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2316](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2316)* -• **address**: *string* +Decompose an ABI-encoded SignatureWalletError. + +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | +**Returns:** *`ContractFunctionObj<[string, string, string, string]>`* -Defined in base-contract/lib/src/index.d.ts:28 +errorCode The error code.signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. ___ -Args +### decodeStaticCallAssetData -• **constructorArgs**: *any[]* +▸ **decodeStaticCallAssetData**(`assetData`: string): *`ContractFunctionObj<[string, string, string, string]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2365](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2365)* +Decode StaticCall asset data from the format described in the AssetProxy contract specification. -Defined in base-contract/lib/src/index.d.ts:30 +**Parameters:** -___ +Name | Type | Description | +------ | ------ | ------ | +`assetData` | string | AssetProxy-compliant asset data describing a StaticCall asset | -### contractName +**Returns:** *`ContractFunctionObj<[string, string, string, string]>`* -• **contractName**: *string* +The StaticCall AssetProxy identifier, the target address of the StaticCAll, the data to be passed to the target address, and the expected Keccak-256 hash of the static call return data. +___ +### decodeTransactionError -Defined in base-contract/lib/src/index.d.ts:29 +▸ **decodeTransactionError**(`encoded`: string): *`ContractFunctionObj<[number, string]>`* -## Methods +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2413](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2413)* -### `Static` ABI +Decompose an ABI-encoded TransactionError. -▸ **ABI**(): *[ContractAbi](#contractabi)* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2719](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2719)* +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -**Returns:** *[ContractAbi](#contractabi)* +**Returns:** *`ContractFunctionObj<[number, string]>`* -The contract ABI +errorCode The error code.transactionHash Hash of the transaction. ___ -### `Static` deployAsync +### decodeTransactionExecutionError -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* +▸ **decodeTransactionExecutionError**(`encoded`: string): *`ContractFunctionObj<[string, string]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2458)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2672](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2672)* +Decompose an ABI-encoded TransactionExecutionError. **Parameters:** -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | +Name | Type | Description | +------ | ------ | ------ | +`encoded` | string | ABI-encoded revert error. | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj<[string, string]>`* + +transactionHash Hash of the transaction.errorData Error thrown by exeucteTransaction(). ___ -### `Static` deployFrom0xArtifactAsync +### decodeZeroExTransactionData -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* +▸ **decodeZeroExTransactionData**(`transactionData`: string): *`ContractFunctionObj<[string, Array, BigNumber[], string[]]>`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2505](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2505)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2639](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2639)* +Decodes the call data for an Exchange contract method call. **Parameters:** -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | +Name | Type | Description | +------ | ------ | ------ | +`transactionData` | string | ABI-encoded calldata for an Exchange contract method call. | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj<[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. -### `Static` strictArgumentEncodingCheck +___ -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* +### encodeERC1155AssetData +▸ **encodeERC1155AssetData**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string): *`ContractFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2628)* -Defined in base-contract/lib/src/index.d.ts:41 +Encode ERC-1155 asset data into the format described in the AssetProxy contract specification. **Parameters:** -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### decodeAssetProxyDispatchError +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. | -#### ▪ **decodeAssetProxyDispatchError**: *object* +**Returns:** *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L45)* +AssetProxy-compliant asset data describing the set of assets. -Decompose an ABI-encoded AssetProxyDispatchError. +___ -#### callAsync +### encodeERC20AssetData -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string]>`* +▸ **encodeERC20AssetData**(`tokenAddress`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L53)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2686](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2686)* -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. +Encode ERC-20 asset data into the format described in the AssetProxy contract specification. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`tokenAddress` | string | The address of the ERC-20 contract hosting the asset to be traded. | -**Returns:** *`Promise<[number, string, string]>`* +**Returns:** *`ContractFunctionObj`* -errorCode The error code.orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched. +AssetProxy-compliant data describing the asset. ___ -### decodeAssetProxyExistsError +### encodeERC721AssetData -#### ▪ **decodeAssetProxyExistsError**: *object* +▸ **encodeERC721AssetData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L90)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2735](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2735)* -Decompose an ABI-encoded AssetProxyExistsError. +Encode ERC-721 asset data into the format described in the AssetProxy specification. -#### callAsync +**Parameters:** -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* +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. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:98](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L98)* +**Returns:** *`ContractFunctionObj`* -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. +AssetProxy-compliant asset data describing the asset. -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +### encodeMultiAssetData -**Returns:** *`Promise<[string, string]>`* +▸ **encodeMultiAssetData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *`ContractFunctionObj`* -assetProxyId Id of asset proxy.assetProxyAddress The address of the asset proxy. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2787](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2787)* -___ +Encode data for multiple assets, per the AssetProxy contract specification. -### decodeAssetProxyId +**Parameters:** -#### ▪ **decodeAssetProxyId**: *object* +Name | Type | Description | +------ | ------ | ------ | +`amounts` | `BigNumber`[] | The amounts of each asset to be traded. | +`nestedAssetData` | string[] | AssetProxy-compliant data describing each asset to be traded. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L135)* +**Returns:** *`ContractFunctionObj`* -Decode AssetProxy identifier +AssetProxy-compliant data describing the set of assets. -#### callAsync +___ + +### encodeStaticCallAssetData -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **encodeStaticCallAssetData**(`staticCallTargetAddress`: string, `staticCallData`: string, `expectedReturnDataHash`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:144](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L144)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2841](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2841)* -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. +Encode StaticCall asset data into the format described in the AssetProxy contract specification. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-20, ERC- 721, ERC1155, or MultiAsset asset. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`staticCallTargetAddress` | string | Target address of StaticCall. | +`staticCallData` | string | Data that will be passed to staticCallTargetAddress in the StaticCall. | +`expectedReturnDataHash` | string | Expected Keccak-256 hash of the StaticCall return data. | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -The AssetProxy identifier +AssetProxy-compliant asset data describing the set of assets. ___ -### decodeAssetProxyTransferError +### getABIDecodedReturnData -#### ▪ **decodeAssetProxyTransferError**: *object* +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:181](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L181)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1497](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1497)* -Decompose an ABI-encoded AssetProxyTransferError. +**Type parameters:** -#### callAsync +▪ **T** -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string]>`* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:189](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L189)* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -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. +**Returns:** *`T`* -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +### getABIDecodedTransactionData -**Returns:** *`Promise<[string, string, string]>`* +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -orderHash Hash of the order being dispatched.assetData Asset data of the order being dispatched.errorData ABI-encoded revert data from the asset proxy. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1490](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1490)* -___ +**Type parameters:** -### decodeEIP1271SignatureError +▪ **T** + +**Parameters:** -#### ▪ **decodeEIP1271SignatureError**: *object* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:226](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L226)* +**Returns:** *`T`* -Decompose an ABI-encoded SignatureValidatorError. +___ -#### callAsync +### getAssetProxyAllowance -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* +▸ **getAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:234](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L234)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2899](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2899)* -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. +Returns the number of asset(s) (described by assetData) that the corresponding AssetProxy contract is authorized to spend. When the asset data contains multiple assets (eg for Multi-Asset), the return value indicates how many complete "baskets" of those assets may be spent by all of the corresponding AssetProxy contracts. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | -**Returns:** *`Promise<[string, string, string, string]>`* +**Returns:** *`ContractFunctionObj`* -signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. +Number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. ___ -### decodeERC1155AssetData +### getBalance -#### ▪ **decodeERC1155AssetData**: *object* +▸ **getBalance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:271](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L271)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2961](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2961)* -Decode ERC-1155 asset data from the format described in the AssetProxy contract specification. +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 +**Parameters:** -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber[], BigNumber[], string]>`* +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:280](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L280)* +**Returns:** *`ContractFunctionObj`* -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. +Number of assets (or asset baskets) held by owner. -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-1155 set of assets. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +### getBalanceAndAssetProxyAllowance -**Returns:** *`Promise<[string, string, BigNumber[], BigNumber[], string]>`* +▸ **getBalanceAndAssetProxyAllowance**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj<[BigNumber, BigNumber]>`* -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`. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3023](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3023)* -___ +Calls getBalance() and getAllowance() for assetData. -### decodeERC20AssetData +**Parameters:** -#### ▪ **decodeERC20AssetData**: *object* +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Owner of the assets specified by assetData. | +`assetData` | string | Details of asset, encoded per the AssetProxy contract specification. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:319](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L319)* +**Returns:** *`ContractFunctionObj<[BigNumber, BigNumber]>`* -Decode ERC-20 asset data from the format described in the AssetProxy contract specification. +Number of assets (or asset baskets) held by owner, and number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. + +___ -#### callAsync +### getBatchAssetProxyAllowances -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* +▸ **getBatchAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:327](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L327)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3091](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3091)* -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. +Calls getAssetProxyAllowance() for each element of assetData. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-20 asset. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +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:** *`Promise<[string, string]>`* +**Returns:** *`ContractFunctionObj`* -The AssetProxy identifier, and the address of the ERC-20 contract hosting this asset. +An array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. ___ -### decodeERC721AssetData +### getBatchBalances -#### ▪ **decodeERC721AssetData**: *object* +▸ **getBatchBalances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:364](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L364)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3153)* -Decode ERC-721 asset data from the format described in the AssetProxy contract specification. +Calls getBalance() for each element of assetData. -#### callAsync +**Parameters:** -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber]>`* +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. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:373](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L373)* +**Returns:** *`ContractFunctionObj`* -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. +Array of asset balances from getBalance(), with each element corresponding to the same-indexed element in the assetData input. -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing an ERC-721 asset. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +### getBatchBalancesAndAssetProxyAllowances -**Returns:** *`Promise<[string, string, BigNumber]>`* +▸ **getBatchBalancesAndAssetProxyAllowances**(`ownerAddress`: string, `assetData`: string[]): *`ContractFunctionObj<[BigNumber[], 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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3215)* -___ +Calls getBatchBalances() and getBatchAllowances() for each element of assetData. -### decodeExchangeInvalidContextError +**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. | -#### ▪ **decodeExchangeInvalidContextError**: *object* +**Returns:** *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:410](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L410)* +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. -Decompose an ABI-encoded OrderStatusError. +___ -#### callAsync +### getEthBalances -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string]>`* +▸ **getEthBalances**(`addresses`: string[]): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:418](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L418)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3281](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3281)* -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. +Batch fetches ETH balances **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`addresses` | string[] | Array of addresses. | -**Returns:** *`Promise<[number, string, string]>`* +**Returns:** *`ContractFunctionObj`* -errorCode Error code that corresponds to invalid maker, taker, or sender.orderHash The order hash.contextAddress The maker, taker, or sender address +Array of ETH balances. ___ -### decodeFillError - -#### ▪ **decodeFillError**: *object* +### getFunctionSignature -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:455](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L455)* +▸ **getFunctionSignature**(`methodName`: string): *string* -Decompose an ABI-encoded FillError. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1484)* -#### callAsync +**Parameters:** -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string]>`* +Name | Type | +------ | ------ | +`methodName` | string | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:463](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L463)* +**Returns:** *string* -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:** +### getOrderRelevantState -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +▸ **getOrderRelevantState**(`order`: object, `signature`: string): *`ContractFunctionObj<[object, BigNumber, boolean]>`* -**Returns:** *`Promise<[number, string]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3337)* -errorCode The error code.orderHash The order hash. +Fetches all order-relevant information needed to validate if the supplied order is fillable. -___ +**Parameters:** -### decodeIncompleteFillError +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. | -#### ▪ **decodeIncompleteFillError**: *object* +**Returns:** *`ContractFunctionObj<[object, BigNumber, boolean]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:500](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L500)* +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. -Decompose an ABI-encoded IncompleteFillError. +___ -#### callAsync +### getOrderRelevantStates -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, BigNumber, BigNumber]>`* +▸ **getOrderRelevantStates**(`orders`: `Array`, `signatures`: string[]): *`ContractFunctionObj<[Array, BigNumber[], boolean[]]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:508](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L508)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3433)* -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. +Fetches all order-relevant information needed to validate if the supplied orders are fillable. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +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:** *`Promise<[number, BigNumber, BigNumber]>`* +**Returns:** *`ContractFunctionObj<[Array, BigNumber[], boolean[]]>`* -orderHash Hash of the order being filled. +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. ___ -### decodeMultiAssetData - -#### ▪ **decodeMultiAssetData**: *object* +### getSelector -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:545](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L545)* +▸ **getSelector**(`methodName`: string): *string* -Decode multi-asset data from the format described in the AssetProxy contract specification. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1504](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1504)* -#### callAsync +**Parameters:** -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, BigNumber[], string[]]>`* +Name | Type | +------ | ------ | +`methodName` | string | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:553](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L553)* +**Returns:** *string* -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:** +### getSimulatedOrderTransferResults -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant data describing a multi-asset basket. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +▸ **getSimulatedOrderTransferResults**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *`ContractTxFunctionObj`* -**Returns:** *`Promise<[string, BigNumber[], string[]]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3537](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3537)* -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. +Simulates all of the transfers within an order and returns the index of the first failed transfer. -___ +**Parameters:** -### decodeNegativeSpreadError +Name | Type | Description | +------ | ------ | ------ | +`order` | object | The order to simulate transfers for. | +`takerAddress` | string | The address of the taker that will fill the order. | +`takerAssetFillAmount` | `BigNumber` | The amount of takerAsset that the taker wished to fill. | -#### ▪ **decodeNegativeSpreadError**: *object* +**Returns:** *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:590](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L590)* +The index of the first failed transfer (or 4 if all transfers are successful). -Decompose an ABI-encoded NegativeSpreadError. +___ -#### callAsync +### getSimulatedOrdersTransferResults -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* +▸ **getSimulatedOrdersTransferResults**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:598](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L598)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3687](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3687)* -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. +Simulates all of the transfers for each given order and returns the indices of each first failed transfer. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of orders to individually simulate transfers for. | +`takerAddresses` | string[] | Array of addresses of takers that will fill each order. | +`takerAssetFillAmounts` | `BigNumber`[] | Array of amounts of takerAsset that will be filled for each order. | -**Returns:** *`Promise<[string, string]>`* +**Returns:** *`ContractTxFunctionObj`* -leftOrderHash Hash of the left order being matched.rightOrderHash Hash of the right order being matched. +The indices of the first failed transfer (or 4 if all transfers are successful) for each order. ___ -### decodeOrderEpochError +### getTransferableAssetAmount -#### ▪ **decodeOrderEpochError**: *object* +▸ **getTransferableAssetAmount**(`ownerAddress`: string, `assetData`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:635](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L635)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3835](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3835)* -Decompose an ABI-encoded OrderEpochError. +Gets the amount of an asset transferable by the owner. -#### callAsync +**Parameters:** -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, BigNumber]>`* +Name | Type | Description | +------ | ------ | ------ | +`ownerAddress` | string | Address of the owner of the asset. | +`assetData` | string | Description of tokens, per the AssetProxy contract specification. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:643](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L643)* +**Returns:** *`ContractFunctionObj`* -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. +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`. -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +### revertIfInvalidAssetData -**Returns:** *`Promise<[string, string, BigNumber]>`* +▸ **revertIfInvalidAssetData**(`assetData`: string): *`ContractFunctionObj`* -makerAddress The order maker.orderSenderAddress The order sender.currentEpoch The current epoch for the maker. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:3890](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L3890)* + +**Parameters:** + +Name | Type | +------ | ------ | +`assetData` | string | + +**Returns:** *`ContractFunctionObj`* ___ -### decodeOrderStatusError +### `Static` ABI -#### ▪ **decodeOrderStatusError**: *object* +▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:680](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L680)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:125](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L125)* -Decompose an ABI-encoded OrderStatusError. +**Returns:** *[ContractAbi](#contractabi)* -#### callAsync +The contract ABI -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, number]>`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:688](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L688)* +### `Static` deployAsync -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. +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L78)* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +**Parameters:** -**Returns:** *`Promise<[string, number]>`* +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | -orderHash The order hash.orderStatus The order status. +**Returns:** *`Promise`* ___ -### decodeSignatureError +### `Static` deployFrom0xArtifactAsync -#### ▪ **decodeSignatureError**: *object* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:725](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L725)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L45)* -Decompose an ABI-encoded SignatureError. +**Parameters:** + +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | -#### callAsync +**Returns:** *`Promise`* -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string, string, string]>`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:733](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L733)* +### `Static` strictArgumentEncodingCheck -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. +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -**Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise<[number, string, string, string]>`* +Defined in base-contract/lib/src/index.d.ts:42 -errorCode The error code.signerAddress The expected signer of the hash.signature The full signature. +**Parameters:** -___ +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -### decodeSignatureValidatorNotApprovedError +**Returns:** *string* -#### ▪ **decodeSignatureValidatorNotApprovedError**: *object* +
-*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:770](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L770)* +# Class: DummyERC20TokenContract -Decompose an ABI-encoded SignatureValidatorNotApprovedError. -#### callAsync +## Constructors -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:778](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L778)* -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. +\+ **new DummyERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* -**Parameters:** +*Overrides void* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1690)* -**Returns:** *`Promise<[string, string]>`* +**Parameters:** -signerAddress The expected signer of the hash.validatorAddress The expected validator. +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | DummyERC20TokenContract.deployedBytecode | -___ +**Returns:** *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* -### decodeSignatureWalletError +## Properties -#### ▪ **decodeSignatureWalletError**: *object* +### `Optional` _deployedBytecodeIfExists -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:817](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L817)* +• **_deployedBytecodeIfExists**? : *`Buffer`* -Decompose an ABI-encoded SignatureWalletError. -#### callAsync -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* +Defined in base-contract/lib/src/index.d.ts:32 -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:825](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L825)* +___ -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. +### abi -**Parameters:** +• **abi**: *[ContractAbi](#contractabi)* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise<[string, string, string, string]>`* -errorCode The error code.signerAddress The expected signer of the hash.signature The full signature bytes.errorData The revert data thrown by the validator contract. +Defined in base-contract/lib/src/index.d.ts:28 ___ -### decodeStaticCallAssetData - -#### ▪ **decodeStaticCallAssetData**: *object* +### address -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:862](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L862)* +• **address**: *string* -Decode StaticCall asset data from the format described in the AssetProxy contract specification. -#### callAsync -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string, string, string]>`* +Defined in base-contract/lib/src/index.d.ts:29 -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:871](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L871)* +___ -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. +Args -**Parameters:** +• **constructorArgs**: *any[]* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | AssetProxy-compliant asset data describing a StaticCall asset | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | -**Returns:** *`Promise<[string, string, string, string]>`* -The StaticCall AssetProxy identifier, the target address of the StaticCAll, the data to be passed to the target address, and the expected Keccak-256 hash of the static call return data. +Defined in base-contract/lib/src/index.d.ts:31 ___ -### decodeTransactionError - -#### ▪ **decodeTransactionError**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:908](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L908)* +### contractName -Decompose an ABI-encoded TransactionError. +• **contractName**: *string* -#### callAsync -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[number, string]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:916](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L916)* +Defined in base-contract/lib/src/index.d.ts:30 -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. +## Methods -**Parameters:** +### MAX_MINT_AMOUNT -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +▸ **MAX_MINT_AMOUNT**(): *`ContractFunctionObj`* -**Returns:** *`Promise<[number, string]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:503](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L503)* -errorCode The error code.transactionHash Hash of the transaction. +**Returns:** *`ContractFunctionObj`* ___ -### decodeTransactionExecutionError - -#### ▪ **decodeTransactionExecutionError**: *object* +### allowance -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:953](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L953)* +▸ **allowance**(`_owner`: string, `_spender`: string): *`ContractFunctionObj`* -Decompose an ABI-encoded TransactionExecutionError. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:550](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L550)* -#### callAsync +**Parameters:** -▸ **callAsync**(`encoded`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, string]>`* +Name | Type | +------ | ------ | +`_owner` | string | +`_spender` | string | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:961](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L961)* +**Returns:** *`ContractFunctionObj`* -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:** +### approve -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`encoded` | string | - | ABI-encoded revert error. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +▸ **approve**(`_spender`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -**Returns:** *`Promise<[string, string]>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:611](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L611)* -transactionHash Hash of the transaction.errorData Error thrown by exeucteTransaction(). +`msg.sender` approves `_spender` to spend `_value` tokens -___ +**Parameters:** -### decodeZeroExTransactionData +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 | -#### ▪ **decodeZeroExTransactionData**: *object* +**Returns:** *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:998](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L998)* +Always true if the call has enough gas to complete execution -Decodes the call data for an Exchange contract method call. +___ -#### callAsync +### balanceOf -▸ **callAsync**(`transactionData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[string, Array, BigNumber[], string[]]>`* +▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1007](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1007)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:735](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L735)* -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. +Query the balance of owner **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`transactionData` | string | - | ABI-encoded calldata for an Exchange contract method call. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | The address from which the balance will be retrieved | -**Returns:** *`Promise<[string, Array, BigNumber[], string[]]>`* +**Returns:** *`ContractFunctionObj`* -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. +Balance of owner ___ -### encodeERC1155AssetData - -#### ▪ **encodeERC1155AssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1088](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1088)* +### decimals -Encode ERC-1155 asset data into the format described in the AssetProxy contract specification. +▸ **decimals**(): *`ContractFunctionObj`* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:785](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L785)* -▸ **callAsync**(`tokenAddress`: string, `tokenIds`: `BigNumber`[], `tokenValues`: `BigNumber`[], `callbackData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +**Returns:** *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1101](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1101)* +___ -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. +### getABIDecodedReturnData -**Parameters:** +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -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) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:489](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L489)* -**Returns:** *`Promise`* +**Type parameters:** -AssetProxy-compliant asset data describing the set of assets. +▪ **T** -___ +**Parameters:** -### encodeERC20AssetData +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -#### ▪ **encodeERC20AssetData**: *object* +**Returns:** *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1147](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1147)* +___ -Encode ERC-20 asset data into the format described in the AssetProxy contract specification. +### getABIDecodedTransactionData -#### callAsync +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -▸ **callAsync**(`tokenAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:482](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L482)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1156](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1156)* +**Type parameters:** -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. +▪ **T** **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`* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -AssetProxy-compliant data describing the asset. +**Returns:** *`T`* ___ -### encodeERC721AssetData +### getFunctionSignature -#### ▪ **encodeERC721AssetData**: *object* +▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1195](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1195)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:476](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L476)* -Encode ERC-721 asset data into the format described in the AssetProxy specification. +**Parameters:** -#### callAsync +Name | Type | +------ | ------ | +`methodName` | string | -▸ **callAsync**(`tokenAddress`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +**Returns:** *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1205](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1205)* +___ -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. +### getLogsAsync -**Parameters:** +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -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) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1674](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1674)* -**Returns:** *`Promise`* +Gets historical logs without creating a subscription -AssetProxy-compliant asset data describing the asset. +**Type parameters:** -___ +▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)* -### encodeMultiAssetData +**Parameters:** -#### ▪ **encodeMultiAssetData**: *object* +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}` | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1247](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1247)* +**Returns:** *`Promise>>`* -Encode data for multiple assets, per the AssetProxy contract specification. +Array of logs that match the parameters -#### callAsync +___ -▸ **callAsync**(`amounts`: `BigNumber`[], `nestedAssetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### getSelector -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1257](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1257)* +▸ **getSelector**(`methodName`: string): *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:496](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L496)* **Parameters:** -Name | Type | 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`* +Name | Type | +------ | ------ | +`methodName` | string | -AssetProxy-compliant data describing the set of assets. +**Returns:** *string* ___ -### encodeStaticCallAssetData +### mint -#### ▪ **encodeStaticCallAssetData**: *object* +▸ **mint**(`_value`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1299](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1299)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:836](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L836)* -Encode StaticCall asset data into the format described in the AssetProxy contract specification. +Mints new tokens for sender -#### callAsync +**Parameters:** -▸ **callAsync**(`staticCallTargetAddress`: string, `staticCallData`: string, `expectedReturnDataHash`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +Name | Type | Description | +------ | ------ | ------ | +`_value` | `BigNumber` | Amount of tokens to mint | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1311](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1311)* +**Returns:** *`ContractTxFunctionObj`* -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 -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`staticCallTargetAddress` | string | - | Target address of StaticCall. | -`staticCallData` | string | - | Data that will be passed to staticCallTargetAddress in the StaticCall. | -`expectedReturnDataHash` | string | - | Expected Keccak-256 hash of the StaticCall return data. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +▸ **name**(): *`ContractFunctionObj`* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:942](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L942)* -AssetProxy-compliant asset data describing the set of assets. +**Returns:** *`ContractFunctionObj`* ___ -### getAssetProxyAllowance +### owner -#### ▪ **getAssetProxyAllowance**: *object* +▸ **owner**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1356](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1356)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:989](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L989)* -Returns 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. +**Returns:** *`ContractFunctionObj`* + +___ -#### callAsync +### setBalance -▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **setBalance**(`_target`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1366](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1366)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1041](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1041)* -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. +Sets the balance of target address **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`* +Name | Type | Description | +------ | ------ | ------ | +`_target` | string | Address or which balance will be updated | +`_value` | `BigNumber` | New balance of target address | -Number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. +**Returns:** *`ContractTxFunctionObj`* ___ -### getBalance +### subscribe -#### ▪ **getBalance**: *object* +▸ **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/dev_utils.ts:1416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1416)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1632](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1632)* -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. +Subscribe to an event type emitted by the DummyERC20Token contract. -#### callAsync +**Type parameters:** -▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1426](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1426)* - -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. +▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)* **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) | - | - | +`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:** *`Promise`* +**Returns:** *string* -Number of assets (or asset baskets) held by owner. +Subscription token used later to unsubscribe ___ -### getBalanceAndAssetProxyAllowance - -#### ▪ **getBalanceAndAssetProxyAllowance**: *object* +### symbol -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1476](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1476)* +▸ **symbol**(): *`ContractFunctionObj`* -Calls getBalance() and getAllowance() for assetData. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1160](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1160)* -#### callAsync +**Returns:** *`ContractFunctionObj`* -▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber]>`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1486](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1486)* +### totalSupply -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. +▸ **totalSupply**(): *`ContractFunctionObj`* -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1211](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1211)* -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) | - | - | +Query total supply of token -**Returns:** *`Promise<[BigNumber, BigNumber]>`* +**Returns:** *`ContractFunctionObj`* -Number of assets (or asset baskets) held by owner, and number of assets (or asset baskets) that the corresponding AssetProxy is authorized to spend. +Total supply of token ___ -### getBatchAssetProxyAllowances +### transfer -#### ▪ **getBatchAssetProxyAllowances**: *object* +▸ **transfer**(`_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1536](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1536)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1264](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1264)* -Calls getAssetProxyAllowance() for each element of assetData. +send `value` token to `to` from `msg.sender` -#### callAsync +**Parameters:** -▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +Name | Type | Description | +------ | ------ | ------ | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1546](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1546)* +**Returns:** *`ContractTxFunctionObj`* -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. +True if transfer was successful -**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) | - | - | +### transferFrom -**Returns:** *`Promise`* +▸ **transferFrom**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -An array of asset allowances from getAllowance(), with each element corresponding to the same-indexed element in the assetData input. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1390)* -___ +ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. See https://github.com/ethereum/EIPs/issues/717 -### getBatchBalances +**Parameters:** -#### ▪ **getBatchBalances**: *object* +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | Address to transfer from. | +`_to` | string | Address to transfer to. | +`_value` | `BigNumber` | Amount to transfer. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1596](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1596)* +**Returns:** *`ContractTxFunctionObj`* -Calls getBalance() for each element of assetData. +Success of transfer. -#### callAsync +___ -▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### transferOwnership -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1606](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1606)* +▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1514](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1514)* **Parameters:** -Name | Type | 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`* +Name | Type | +------ | ------ | +`newOwner` | string | -Array of asset balances from getBalance(), with each element corresponding to the same-indexed element in the assetData input. +**Returns:** *`ContractTxFunctionObj`* ___ -### getBatchBalancesAndAssetProxyAllowances +### unsubscribe -#### ▪ **getBatchBalancesAndAssetProxyAllowances**: *object* +▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1656](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1656)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1657](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1657)* -Calls getBatchBalances() and getBatchAllowances() for each element of assetData. +Cancel a subscription + +**Parameters:** -#### callAsync +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | -▸ **callAsync**(`ownerAddress`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber[], BigNumber[]]>`* +**Returns:** *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1666](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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. +### unsubscribeAll -**Parameters:** +▸ **unsubscribeAll**(): *void* -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) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1663](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1663)* -**Returns:** *`Promise<[BigNumber[], BigNumber[]]>`* +Cancels all existing subscriptions -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. +**Returns:** *void* ___ -### getEthBalances +### `Static` ABI -#### ▪ **getEthBalances**: *object* +▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1716](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1716)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:155](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L155)* -Batch fetches ETH balances +**Returns:** *[ContractAbi](#contractabi)* -#### callAsync +The contract ABI -▸ **callAsync**(`addresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1724](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1724)* +### `Static` deployAsync -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. +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L105)* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`addresses` | string[] | - | Array of addresses. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +**Parameters:** -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_name` | string | +`_symbol` | string | +`_decimals` | `BigNumber` | +`_totalSupply` | `BigNumber` | -Array of ETH balances. +**Returns:** *`Promise`* ___ -### getOrderRelevantState +### `Static` deployFrom0xArtifactAsync -#### ▪ **getOrderRelevantState**: *object* +▸ **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/dev_utils.ts:1769](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1769)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L66)* -Fetches all order-relevant information needed to validate if the supplied order is fillable. +**Parameters:** -#### callAsync +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_name` | string | +`_symbol` | string | +`_decimals` | `BigNumber` | +`_totalSupply` | `BigNumber` | -▸ **callAsync**(`order`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, BigNumber, boolean]>`* +**Returns:** *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1780](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1780)* +___ -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. +### `Static` strictArgumentEncodingCheck -**Parameters:** +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -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. +Defined in base-contract/lib/src/index.d.ts:42 -___ +**Parameters:** -### getOrderRelevantStates +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | + +**Returns:** *string* -#### ▪ **getOrderRelevantStates**: *object* +
+ +# Class: DummyERC721TokenContract -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1850](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1850)* -Fetches all order-relevant information needed to validate if the supplied orders are fillable. +## Constructors + -#### callAsync -▸ **callAsync**(`orders`: `Array`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[Array, BigNumber[], boolean[]]>`* +\+ **new DummyERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1861](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1861)* +*Overrides void* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1990](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1990)* **Parameters:** -Name | Type | Default | 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) | - | - | +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | DummyERC721TokenContract.deployedBytecode | -**Returns:** *`Promise<[Array, BigNumber[], boolean[]]>`* +**Returns:** *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* -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. +## Properties -___ +### `Optional` _deployedBytecodeIfExists -### getSimulatedOrderTransferResults +• **_deployedBytecodeIfExists**? : *`Buffer`* -#### ▪ **getSimulatedOrderTransferResults**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1940](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1940)* -Simulates all of the transfers within an order and returns the index of the first failed transfer. +Defined in base-contract/lib/src/index.d.ts:32 -#### awaitTransactionSuccessAsync +___ -▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +### abi -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2015](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2015)* +• **abi**: *[ContractAbi](#contractabi)* -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 | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | The order to simulate transfers for. | -`takerAddress` | string | - | The address of the taker that will fill the order. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of takerAsset that the taker wished to fill. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +Defined in base-contract/lib/src/index.d.ts:28 -**Returns:** *`PromiseWithTransactionHash`* +___ -A promise that resolves when the transaction is successful +### address -#### callAsync +• **address**: *string* -▸ **callAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2121](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2121)* -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. +Defined in base-contract/lib/src/index.d.ts:29 -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | The order to simulate transfers for. | -`takerAddress` | string | - | The address of the taker that will fill the order. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of takerAsset that the taker wished to fill. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Args -**Returns:** *`Promise`* +• **constructorArgs**: *any[]* -The index of the first failed transfer (or 4 if all transfers are successful). -#### estimateGasAsync -▸ **estimateGasAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +Defined in base-contract/lib/src/index.d.ts:31 -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2068](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2068)* +___ -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +### contractName -**Parameters:** +• **contractName**: *string* -Name | Type | Description | ------- | ------ | ------ | -`order` | object | The order to simulate transfers for. | -`takerAddress` | string | The address of the taker that will fill the order. | -`takerAssetFillAmount` | `BigNumber` | The amount of takerAsset that the taker wished to fill. | -`txData?` | `Partial` \| undefined | Additional data for transaction | -**Returns:** *`Promise`* -The hash of the transaction +Defined in base-contract/lib/src/index.d.ts:30 + +## Methods -#### getABIEncodedTransactionData +### approve -▸ **getABIEncodedTransactionData**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`): *string* +▸ **approve**(`_approved`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2195](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2195)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:562](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L562)* -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). +The zero address indicates there is no approved address. +Throws unless `msg.sender` is the current NFT owner, or an authorized +operator of the current owner. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`order` | object | The order to simulate transfers for. | -`takerAddress` | string | The address of the taker that will fill the order. | -`takerAssetFillAmount` | `BigNumber` | The amount of takerAsset that the taker wished to fill. | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | -**Returns:** *string* +**Returns:** *`ContractTxFunctionObj`* -The ABI encoded transaction data as a string +___ -#### getSelector +### balanceOf -▸ **getSelector**(): *string* +▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2227](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2227)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:687](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L687)* -Returns the 4 byte function selector as a hex string. +NFTs assigned to the zero address are considered invalid, and this +function throws for queries about the zero address. -**Returns:** *string* +**Parameters:** -#### sendTransactionAsync +Name | Type | Description | +------ | ------ | ------ | +`_owner` | string | An address for whom to query the balance | -▸ **sendTransactionAsync**(`order`: object, `takerAddress`: string, `takerAssetFillAmount`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +**Returns:** *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:1951](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L1951)* +The number of NFTs owned by `_owner`, possibly zero -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +___ -**Parameters:** +### burn -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | The order to simulate transfers for. | -`takerAddress` | string | - | The address of the taker that will fill the order. | -`takerAssetFillAmount` | `BigNumber` | - | The amount of takerAsset that the taker wished to fill. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +▸ **burn**(`_owner`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:743](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L743)* -The hash of the transaction +Function to burn a token +Reverts if the given token ID doesn't exist or not called by contract owner -___ +**Parameters:** -### getSimulatedOrdersTransferResults +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 | -#### ▪ **getSimulatedOrdersTransferResults**: *object* +**Returns:** *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2238](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2238)* +___ -Simulates all of the transfers for each given order and returns the indices of each first failed transfer. +### getABIDecodedReturnData -#### awaitTransactionSuccessAsync +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:541](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L541)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2316](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2316)* +**Type parameters:** -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. +▪ **T** **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of orders to individually simulate transfers for. | -`takerAddresses` | string[] | - | Array of addresses of takers that will fill each order. | -`takerAssetFillAmounts` | `BigNumber`[] | - | Array of amounts of takerAsset that will be filled for each order. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -**Returns:** *`PromiseWithTransactionHash`* +**Returns:** *`T`* + +___ -A promise that resolves when the transaction is successful +### getABIDecodedTransactionData -#### callAsync +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:534](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L534)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2426](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2426)* +**Type parameters:** -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. +▪ **T** **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of orders to individually simulate transfers for. | -`takerAddresses` | string[] | - | Array of addresses of takers that will fill each order. | -`takerAssetFillAmounts` | `BigNumber`[] | - | Array of amounts of takerAsset that will be filled for each order. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -**Returns:** *`Promise`* +**Returns:** *`T`* -The indices of the first failed transfer (or 4 if all transfers are successful) for each order. +___ -#### estimateGasAsync +### getApproved -▸ **estimateGasAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* +▸ **getApproved**(`_tokenId`: `BigNumber`): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2371](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2371)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:867](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L867)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +Throws if `_tokenId` is not a valid NFT. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`orders` | `Array` | Array of orders to individually simulate transfers for. | -`takerAddresses` | string[] | Array of addresses of takers that will fill each order. | -`takerAssetFillAmounts` | `BigNumber`[] | Array of amounts of takerAsset that will be filled for each order. | -`txData?` | `Partial` \| undefined | Additional data for transaction | +`_tokenId` | `BigNumber` | The NFT to find the approved address for | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -The hash of the transaction +The approved address for this NFT, or the zero address if there is none -#### getABIEncodedTransactionData +___ -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[]): *string* +### getFunctionSignature -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2502](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2502)* +▸ **getFunctionSignature**(`methodName`: string): *string* -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). +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:528](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L528)* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`orders` | `Array` | Array of orders to individually simulate transfers for. | -`takerAddresses` | string[] | Array of addresses of takers that will fill each order. | -`takerAssetFillAmounts` | `BigNumber`[] | Array of amounts of takerAsset that will be filled for each order. | +Name | Type | +------ | ------ | +`methodName` | string | **Returns:** *string* -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2535](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2535)* +___ -Returns the 4 byte function selector as a hex string. +### getLogsAsync -**Returns:** *string* +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -#### sendTransactionAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1974](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1974)* -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAddresses`: string[], `takerAssetFillAmounts`: `BigNumber`[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +Gets historical logs without creating a subscription -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2250](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2250)* +**Type parameters:** -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of orders to individually simulate transfers for. | -`takerAddresses` | string[] | - | Array of addresses of takers that will fill each order. | -`takerAssetFillAmounts` | `BigNumber`[] | - | Array of amounts of takerAsset that will be filled for each order. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +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`* +**Returns:** *`Promise>>`* -The hash of the transaction +Array of logs that match the parameters ___ -### getTransferableAssetAmount - -#### ▪ **getTransferableAssetAmount**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2546](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2546)* - -Gets the amount of an asset transferable by the owner. - -#### callAsync - -▸ **callAsync**(`ownerAddress`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### getSelector -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2556](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2556)* +▸ **getSelector**(`methodName`: string): *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:548](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L548)* **Parameters:** -Name | Type | 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`* +Name | Type | +------ | ------ | +`methodName` | string | -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`. +**Returns:** *string* ___ -### revertIfInvalidAssetData - -#### ▪ **revertIfInvalidAssetData**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2603](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2603)* - -#### callAsync - -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### isApprovedForAll -*Defined in [abi-gen-wrappers/src/generated-wrappers/dev_utils.ts:2609](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dev_utils.ts#L2609)* +▸ **isApprovedForAll**(`_owner`: string, `_operator`: string): *`ContractFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:915](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L915)* **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`assetData` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | +------ | ------ | +`_owner` | string | +`_operator` | string | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -
+___ -# Class: DummyERC20TokenContract +### mint +▸ **mint**(`_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -## Constructors +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:976](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L976)* +Function to mint a new token +Reverts if the given token ID already exists +**Parameters:** -\+ **new DummyERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* +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 | -*Overrides void* +**Returns:** *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1985](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1985)* +___ -**Parameters:** +### name -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | DummyERC20TokenContract.deployedBytecode | +▸ **name**(): *`ContractFunctionObj`* -**Returns:** *[DummyERC20TokenContract](#class-dummyerc20tokencontract)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1086](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1086)* -## Properties +**Returns:** *`ContractFunctionObj`* -#### `Optional` _deployedBytecodeIfExists +___ -• **_deployedBytecodeIfExists**? : *`Buffer`* +### owner +▸ **owner**(): *`ContractFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1133)* -Defined in base-contract/lib/src/index.d.ts:31 +**Returns:** *`ContractFunctionObj`* ___ -### abi - -• **abi**: *[ContractAbi](#contractabi)* +### ownerOf +▸ **ownerOf**(`_tokenId`: `BigNumber`): *`ContractFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1186](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1186)* -Defined in base-contract/lib/src/index.d.ts:27 +NFTs assigned to zero address are considered invalid, and queries +about them do throw. -___ +**Parameters:** -### address +Name | Type | Description | +------ | ------ | ------ | +`_tokenId` | `BigNumber` | The identifier for an NFT | -• **address**: *string* +**Returns:** *`ContractFunctionObj`* +The address of the owner of the NFT +___ -Defined in base-contract/lib/src/index.d.ts:28 +### safeTransferFrom1 -___ +▸ **safeTransferFrom1**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -Args +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1241](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1241)* -• **constructorArgs**: *any[]* +This works identically to the other function with an extra data parameter, +except this function just sets data to "". +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | -Defined in base-contract/lib/src/index.d.ts:30 +**Returns:** *`ContractTxFunctionObj`* ___ -### contractName +### safeTransferFrom2 -• **contractName**: *string* +▸ **safeTransferFrom2**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *`ContractTxFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1377](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1377)* +Throws unless `msg.sender` is the current owner, an authorized +operator, or the approved address for this NFT. Throws if `_from` is +not the current owner. Throws if `_to` is the zero address. Throws if +`_tokenId` is not a valid NFT. When transfer is complete, this function +checks if `_to` is a smart contract (code size > 0). If so, it calls +`onERC721Received` on `_to` and throws if the return value is not +`bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`. -Defined in base-contract/lib/src/index.d.ts:29 +**Parameters:** -## Methods +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` | -### getLogsAsync +**Returns:** *`ContractTxFunctionObj`* -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1969](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1969)* +### setApprovalForAll -Gets historical logs without creating a subscription +▸ **setApprovalForAll**(`_operator`: string, `_approved`: boolean): *`ContractTxFunctionObj`* -**Type parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1515](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1515)* -▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)* +Emits the ApprovalForAll event. The contract MUST allow +multiple operators per owner. **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>>`* +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | -Array of logs that match the parameters +**Returns:** *`ContractTxFunctionObj`* ___ ### subscribe -▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* +▸ **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_erc20_token.ts:1927](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1927)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1932](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1932)* -Subscribe to an event type emitted by the DummyERC20Token contract. +Subscribe to an event type emitted by the DummyERC721Token contract. **Type parameters:** -▪ **ArgsType**: *[DummyERC20TokenEventArgs](#dummyerc20tokeneventargs)* +▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`eventName` | [DummyERC20TokenEvents](#enumeration-dummyerc20tokenevents) | - | The DummyERC20Token contract event you would like to subscribe to. | +`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) | @@ -2660,11 +2346,60 @@ Subscription token used later to unsubscribe ___ +### symbol + +▸ **symbol**(): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1634](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1634)* + +**Returns:** *`ContractFunctionObj`* + +___ + +### transferFrom + +▸ **transferFrom**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1690)* + +Throws unless `msg.sender` is the current owner, an authorized +operator, or the approved address for this NFT. Throws if `_from` is +not the current owner. Throws if `_to` is the zero address. Throws if +`_tokenId` is not a valid NFT. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### transferOwnership + +▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1814](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1814)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | + +**Returns:** *`ContractTxFunctionObj`* + +___ + ### unsubscribe ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1952](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1952)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1957](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1957)* Cancel a subscription @@ -2682,7 +2417,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1958](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1958)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1963](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1963)* Cancels all existing subscriptions @@ -2694,7 +2429,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1598](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1598)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:159](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L159)* **Returns:** *[ContractAbi](#contractabi)* @@ -2704,9 +2439,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* +▸ **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_erc20_token.ts:1548](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1548)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L111)* **Parameters:** @@ -2719,18 +2454,16 @@ Name | Type | `logDecodeDependencies` | object | `_name` | string | `_symbol` | string | -`_decimals` | `BigNumber` | -`_totalSupply` | `BigNumber` | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string, `_decimals`: `BigNumber`, `_totalSupply`: `BigNumber`): *`Promise`* +▸ **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_erc20_token.ts:1509](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1509)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:76](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L76)* **Parameters:** @@ -2742,10 +2475,8 @@ Name | Type | `logDecodeDependencies` | object | `_name` | string | `_symbol` | string | -`_decimals` | `BigNumber` | -`_totalSupply` | `BigNumber` | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ @@ -2755,7 +2486,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:41 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -2766,126 +2497,109 @@ Name | Type | **Returns:** *string* -## Object literals +
-### MAX_MINT_AMOUNT +# Class: ERC20TokenContract -#### ▪ **MAX_MINT_AMOUNT**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L61)* +## Constructors + -#### callAsync -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +\+ **new ERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC20TokenContract](#class-erc20tokencontract)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:67](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L67)* +*Overrides void* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:951](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L951)* **Parameters:** Name | Type | Default | ------ | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC20TokenContract.deployedBytecode | -**Returns:** *`Promise`* +**Returns:** *[ERC20TokenContract](#class-erc20tokencontract)* -___ +## Properties -### allowance +### `Optional` _deployedBytecodeIfExists -#### ▪ **allowance**: *object* +• **_deployedBytecodeIfExists**? : *`Buffer`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L104)* -#### callAsync -▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +Defined in base-contract/lib/src/index.d.ts:32 -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:113](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L113)* +___ -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. +### abi -**Parameters:** +• **abi**: *[ContractAbi](#contractabi)* -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 +Defined in base-contract/lib/src/index.d.ts:28 ___ -### approve +### address -#### ▪ **approve**: *object* +• **address**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:163](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L163)* -`msg.sender` approves `_spender` to spend `_value` tokens -#### awaitTransactionSuccessAsync +Defined in base-contract/lib/src/index.d.ts:29 -▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:213](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L213)* +Args -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. +• **constructorArgs**: *any[]* -**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 | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | -**Returns:** *`PromiseWithTransactionHash`* +Defined in base-contract/lib/src/index.d.ts:31 + +___ + +### contractName + +• **contractName**: *string* + -A promise that resolves when the transaction is successful -#### callAsync +Defined in base-contract/lib/src/index.d.ts:30 + +## Methods -▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### allowance -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:277](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L277)* +▸ **allowance**(`_owner`: string, `_spender`: string): *`ContractFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:828](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L828)* **Parameters:** -Name | Type | 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) | - | - | +Name | Type | +------ | ------ | +`_owner` | string | +`_spender` | string | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -Always true if the call has enough gas to complete execution +___ -#### estimateGasAsync +### approve -▸ **estimateGasAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +▸ **approve**(`_spender`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:242](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L242)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:347](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L347)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +`msg.sender` approves `_spender` to spend `_value` tokens **Parameters:** @@ -2893,877 +2607,826 @@ 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`* +**Returns:** *`ContractTxFunctionObj`* -The hash of the transaction +Always true if the call has enough gas to complete execution + +___ -#### getABIEncodedTransactionData +### balanceOf -▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* +▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L331)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:653](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L653)* -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). +Query the balance of owner **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 | +`_owner` | string | The address from which the balance will be retrieved | -**Returns:** *string* +**Returns:** *`ContractFunctionObj`* -The ABI encoded transaction data as a string +Balance of owner -#### getSelector +___ -▸ **getSelector**(): *string* +### getABIDecodedReturnData -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:344](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L344)* +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -Returns the 4 byte function selector as a hex string. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:327](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L327)* -**Returns:** *string* +**Type parameters:** -#### sendTransactionAsync +▪ **T** -▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:172](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L172)* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +**Returns:** *`T`* -**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 | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +### getABIDecodedTransactionData -**Returns:** *`Promise`* +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -The hash of the transaction +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:320](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L320)* -___ +**Type parameters:** -### balanceOf +▪ **T** -#### ▪ **balanceOf**: *object* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:353](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L353)* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -Query the balance of owner +**Returns:** *`T`* -#### callAsync +___ -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### getFunctionSignature -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:361](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L361)* +▸ **getFunctionSignature**(`methodName`: string): *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:314](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L314)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_owner` | string | - | The address from which the balance will be retrieved | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`methodName` | string | -Balance of owner +**Returns:** *string* ___ -### decimals - -#### ▪ **decimals**: *object* +### getLogsAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:403](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L403)* +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:935](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L935)* -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +Gets historical logs without creating a subscription -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:409](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L409)* +**Type parameters:** -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. +▪ **ArgsType**: *[ERC20TokenEventArgs](#erc20tokeneventargs)* **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +`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>>`* -**Returns:** *`Promise`* +Array of logs that match the parameters ___ -### mint +### getSelector -#### ▪ **mint**: *object* +▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:449](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L449)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:334](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L334)* -Mints new tokens for sender +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | + +**Returns:** *string* + +___ + +### subscribe + +▸ **subscribe**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -#### awaitTransactionSuccessAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:893](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L893)* -▸ **awaitTransactionSuccessAsync**(`_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +Subscribe to an event type emitted by the ERC20Token contract. -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:492](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L492)* +**Type parameters:** -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. +▪ **ArgsType**: *[ERC20TokenEventArgs](#erc20tokeneventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`_value` | `BigNumber` | - | Amount of tokens to mint | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +`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:** *`PromiseWithTransactionHash`* +**Returns:** *string* -A promise that resolves when the transaction is successful +Subscription token used later to unsubscribe -#### callAsync +___ -▸ **callAsync**(`_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### totalSupply -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:543](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L543)* +▸ **totalSupply**(): *`ContractFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:470](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L470)* -**Parameters:** +Query total supply of token -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_value` | `BigNumber` | - | Amount of tokens to mint | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +**Returns:** *`ContractFunctionObj`* -**Returns:** *`Promise`* +Total supply of token + +___ -#### estimateGasAsync +### transfer -▸ **estimateGasAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +▸ **transfer**(`_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:518](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L518)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L709)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +send `value` token to `to` from `msg.sender` **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_value` | `BigNumber` | Amount of tokens to mint | -`txData?` | `Partial` \| undefined | Additional data for transaction | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* + +True if transfer was successful -The hash of the transaction +___ -#### getABIEncodedTransactionData +### transferFrom -▸ **getABIEncodedTransactionData**(`_value`: `BigNumber`): *string* +▸ **transferFrom**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:587](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L587)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:524](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L524)* -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). +send `value` token to `to` from `from` on the condition it is approved by `from` **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_value` | `BigNumber` | Amount of tokens to mint | - -**Returns:** *string* +`_from` | string | The address of the sender | +`_to` | string | The address of the recipient | +`_value` | `BigNumber` | The amount of token to be transferred | -The ABI encoded transaction data as a string +**Returns:** *`ContractTxFunctionObj`* -#### getSelector +True if transfer was successful -▸ **getSelector**(): *string* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:596](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L596)* +### unsubscribe -Returns the 4 byte function selector as a hex string. +▸ **unsubscribe**(`subscriptionToken`: string): *void* -**Returns:** *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:918](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L918)* -#### sendTransactionAsync +Cancel a subscription -▸ **sendTransactionAsync**(`_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:457](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L457)* +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +**Returns:** *void* -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_value` | `BigNumber` | - | Amount of tokens to mint | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +### unsubscribeAll -**Returns:** *`Promise`* +▸ **unsubscribeAll**(): *void* -The hash of the transaction +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:924](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L924)* -___ +Cancels all existing subscriptions -### name +**Returns:** *void* -#### ▪ **name**: *object* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:602](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L602)* +### `Static` ABI -#### callAsync +▸ **ABI**(): *[ContractAbi](#contractabi)* -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L133)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:608](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L608)* +**Returns:** *[ContractAbi](#contractabi)* -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. +The contract ABI -**Parameters:** +___ -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +### `Static` deployAsync -**Returns:** *`Promise`* +▸ **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:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L91)* -### owner +**Parameters:** -#### ▪ **owner**: *object* +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:645](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L645)* +**Returns:** *`Promise`* -#### callAsync +___ -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### `Static` deployFrom0xArtifactAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:651](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L651)* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L66)* **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ -### setBalance - -#### ▪ **setBalance**: *object* +### `Static` strictArgumentEncodingCheck -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:691](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L691)* +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -Sets the balance of target address -#### awaitTransactionSuccessAsync -▸ **awaitTransactionSuccessAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +Defined in base-contract/lib/src/index.d.ts:42 -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:741](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L741)* +**Parameters:** -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. +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -**Parameters:** +**Returns:** *string* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_target` | string | - | Address or which balance will be updated | -`_value` | `BigNumber` | - | New balance of target address | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +
-**Returns:** *`PromiseWithTransactionHash`* +# Class: ERC721TokenContract -A promise that resolves when the transaction is successful -#### callAsync +## Constructors -▸ **callAsync**(`_target`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:804](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L804)* -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. +\+ **new ERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC721TokenContract](#class-erc721tokencontract)* -**Parameters:** +*Overrides void* -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) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1376](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1376)* -**Returns:** *`Promise`* +**Parameters:** -#### estimateGasAsync +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ERC721TokenContract.deployedBytecode | -▸ **estimateGasAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +**Returns:** *[ERC721TokenContract](#class-erc721tokencontract)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:770](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L770)* +## Properties -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +### `Optional` _deployedBytecodeIfExists -**Parameters:** +• **_deployedBytecodeIfExists**? : *`Buffer`* -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 +Defined in base-contract/lib/src/index.d.ts:32 -#### getABIEncodedTransactionData +___ -▸ **getABIEncodedTransactionData**(`_target`: string, `_value`: `BigNumber`): *string* +### abi -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:858](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L858)* +• **abi**: *[ContractAbi](#contractabi)* -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 | +Defined in base-contract/lib/src/index.d.ts:28 -**Returns:** *string* +___ -The ABI encoded transaction data as a string +### address -#### getSelector +• **address**: *string* -▸ **getSelector**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:871](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L871)* -Returns the 4 byte function selector as a hex string. +Defined in base-contract/lib/src/index.d.ts:29 -**Returns:** *string* +___ -#### sendTransactionAsync +Args -▸ **sendTransactionAsync**(`_target`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +• **constructorArgs**: *any[]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:700](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L700)* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. -**Parameters:** +Defined in base-contract/lib/src/index.d.ts:31 -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_target` | string | - | Address or which balance will be updated | -`_value` | `BigNumber` | - | New balance of target address | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +___ -**Returns:** *`Promise`* +### contractName -The hash of the transaction +• **contractName**: *string* -___ -### symbol -#### ▪ **symbol**: *object* +Defined in base-contract/lib/src/index.d.ts:30 -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:877](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L877)* +## Methods -#### callAsync +### approve -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **approve**(`_approved`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:883](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L883)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:438](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L438)* -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. +The zero address indicates there is no approved address. +Throws unless `msg.sender` is the current NFT owner, or an authorized +operator of the current owner. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +`_approved` | string | The new approved NFT controller | +`_tokenId` | `BigNumber` | The NFT to approve | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* ___ -### totalSupply - -#### ▪ **totalSupply**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:923](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L923)* - -Query total supply of token - -#### callAsync +### balanceOf -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **balanceOf**(`_owner`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:930](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L930)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:563](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L563)* -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. +NFTs assigned to the zero address are considered invalid, and this +function throws for queries about the zero address. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +`_owner` | string | An address for whom to query the balance | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -Total supply of token +The number of NFTs owned by `_owner`, possibly zero ___ -### transfer +### getABIDecodedReturnData -#### ▪ **transfer**: *object* +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:970](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L970)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L417)* -send `value` token to `to` from `msg.sender` +**Type parameters:** -#### awaitTransactionSuccessAsync +▪ **T** -▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1017](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1017)* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -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. +**Returns:** *`T`* -**Parameters:** - -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | The address of the recipient | -`_value` | `BigNumber` | - | The amount of token to be transferred | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* +___ -A promise that resolves when the transaction is successful +### getABIDecodedTransactionData -#### callAsync +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:410](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L410)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1074](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1074)* +**Type parameters:** -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. +▪ **T** **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) | - | - | +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -**Returns:** *`Promise`* +**Returns:** *`T`* -True if transfer was successful +___ -#### estimateGasAsync +### getApproved -▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +▸ **getApproved**(`_tokenId`: `BigNumber`): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1046](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1046)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L618)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +Throws if `_tokenId` is not a valid NFT. **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 | +`_tokenId` | `BigNumber` | The NFT to find the approved address for | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -The hash of the transaction +The approved address for this NFT, or the zero address if there is none -#### getABIEncodedTransactionData +___ -▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* +### getFunctionSignature -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1125](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1125)* +▸ **getFunctionSignature**(`methodName`: string): *string* -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). +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:404](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L404)* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | The address of the recipient | -`_value` | `BigNumber` | The amount of token to be transferred | +Name | Type | +------ | ------ | +`methodName` | string | **Returns:** *string* -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1138](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1138)* +___ -Returns the 4 byte function selector as a hex string. +### getLogsAsync -**Returns:** *string* +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -#### sendTransactionAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1360](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1360)* -▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +Gets historical logs without creating a subscription -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:979](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L979)* +**Type parameters:** -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | The address of the recipient | -`_value` | `BigNumber` | - | The amount of token to be transferred | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +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`* +**Returns:** *`Promise>>`* -The hash of the transaction +Array of logs that match the parameters ___ -### transferFrom +### getSelector -#### ▪ **transferFrom**: *object* +▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1147](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1147)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:424](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L424)* -ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. See https://github.com/ethereum/EIPs/issues/717 +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | -#### awaitTransactionSuccessAsync +**Returns:** *string* + +___ -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +### isApprovedForAll -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1202](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1202)* +▸ **isApprovedForAll**(`_owner`: string, `_operator`: string): *`ContractFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:666](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L666)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_from` | string | - | Address to transfer from. | -`_to` | string | - | Address to transfer to. | -`_value` | `BigNumber` | - | Amount to transfer. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +Name | Type | +------ | ------ | +`_owner` | string | +`_operator` | string | -**Returns:** *`PromiseWithTransactionHash`* +**Returns:** *`ContractFunctionObj`* -A promise that resolves when the transaction is successful +___ -#### callAsync +### ownerOf -▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **ownerOf**(`_tokenId`: `BigNumber`): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1279](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1279)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:727](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L727)* -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. +NFTs assigned to zero address are considered invalid, and queries +about them do throw. **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) | - | - | +Name | Type | Description | +------ | ------ | ------ | +`_tokenId` | `BigNumber` | The identifier for an NFT | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -Success of transfer. +The address of the owner of the NFT + +___ -#### estimateGasAsync +### safeTransferFrom1 -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +▸ **safeTransferFrom1**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1240](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1240)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:782](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L782)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +This works identically to the other function with an extra data parameter, +except this function just sets data to "". **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | -`txData?` | `Partial` \| undefined | Additional data for transaction | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* -The hash of the transaction +___ -#### getABIEncodedTransactionData +### safeTransferFrom2 -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* +▸ **safeTransferFrom2**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1337](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1337)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:918](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L918)* -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). +Throws unless `msg.sender` is the current owner, an authorized +operator, or the approved address for this NFT. Throws if `_from` is +not the current owner. Throws if `_to` is the zero address. Throws if +`_tokenId` is not a valid NFT. When transfer is complete, this function +checks if `_to` is a smart contract (code size > 0). If so, it calls +`onERC721Received` on `_to` and throws if the return value is not +`bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | +`_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* +**Returns:** *`ContractTxFunctionObj`* -The ABI encoded transaction data as a string +___ -#### getSelector +### setApprovalForAll -▸ **getSelector**(): *string* +▸ **setApprovalForAll**(`_operator`: string, `_approved`: boolean): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1352](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1352)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1056](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1056)* -Returns the 4 byte function selector as a hex string. +Emits the ApprovalForAll event. The contract MUST allow +multiple operators per owner. -**Returns:** *string* +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`_operator` | string | Address to add to the set of authorized operators | +`_approved` | boolean | True if the operator is approved, false to revoke approval | + +**Returns:** *`ContractTxFunctionObj`* + +___ + +### subscribe + +▸ **subscribe**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -#### sendTransactionAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1318](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1318)* -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +Subscribe to an event type emitted by the ERC721Token contract. -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1157](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1157)* +**Type parameters:** -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +▪ **ArgsType**: *[ERC721TokenEventArgs](#erc721tokeneventargs)* **Parameters:** Name | Type | Default | 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 | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +`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:** *`Promise`* +**Returns:** *string* -The hash of the transaction +Subscription token used later to unsubscribe ___ -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1358](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1358)* - -#### awaitTransactionSuccessAsync +### transferFrom -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +▸ **transferFrom**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1399](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1399)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1184](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1184)* -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. +Throws unless `msg.sender` is the current owner, an authorized +operator, or the approved address for this NFT. Throws if `_from` is +not the current owner. Throws if `_to` is the zero address. Throws if +`_tokenId` is not a valid NFT. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +Name | Type | Description | +------ | ------ | ------ | +`_from` | string | The current owner of the NFT | +`_to` | string | The new owner | +`_tokenId` | `BigNumber` | The NFT to transfer | -**Returns:** *`PromiseWithTransactionHash`* +**Returns:** *`ContractTxFunctionObj`* -A promise that resolves when the transaction is successful +___ -#### callAsync +### unsubscribe -▸ **callAsync**(`newOwner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1448](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1448)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1343)* -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. +Cancel a subscription **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`newOwner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | -**Returns:** *`Promise`* +**Returns:** *void* -#### estimateGasAsync +___ -▸ **estimateGasAsync**(`newOwner`: string, `txData?`: `Partial` | undefined): *`Promise`* +### unsubscribeAll -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1424](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1424)* +▸ **unsubscribeAll**(): *void* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1349](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1349)* -**Parameters:** +Cancels all existing subscriptions -Name | Type | Description | ------- | ------ | ------ | -`newOwner` | string | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | +**Returns:** *void* -**Returns:** *`Promise`* +___ + +### `Static` ABI + +▸ **ABI**(): *[ContractAbi](#contractabi)* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:143](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L143)* + +**Returns:** *[ContractAbi](#contractabi)* -The hash of the transaction +The contract ABI -#### getABIEncodedTransactionData +___ -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* +### `Static` deployAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1491](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1491)* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -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). +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:101](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L101)* **Parameters:** Name | Type | ------ | ------ | -`newOwner` | string | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -**Returns:** *string* +**Returns:** *`Promise`* -The ABI encoded transaction data as a string +___ + +### `Static` deployFrom0xArtifactAsync -#### getSelector +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -▸ **getSelector**(): *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:76](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L76)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1502](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1502)* +**Parameters:** -Returns the 4 byte function selector as a hex string. +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -**Returns:** *string* +**Returns:** *`Promise`* -#### sendTransactionAsync +___ -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +### `Static` strictArgumentEncodingCheck -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:1365](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L1365)* +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +Defined in base-contract/lib/src/index.d.ts:42 -**Returns:** *`Promise`* +**Parameters:** + +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -The hash of the transaction +**Returns:** *string*
-# Class: DummyERC721TokenContract +# Class: ExchangeContract ## Constructors -\+ **new DummyERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* +\+ **new ExchangeContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ExchangeContract](#class-exchangecontract)* *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2500](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2500)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8066](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8066)* **Parameters:** @@ -3773,19 +3436,19 @@ Name | Type | Default | `supportedProvider` | [SupportedProvider](#supportedprovider) | - | `txDefaults?` | `Partial` | - | `logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | DummyERC721TokenContract.deployedBytecode | +`deployedBytecode` | string \| undefined | ExchangeContract.deployedBytecode | -**Returns:** *[DummyERC721TokenContract](#class-dummyerc721tokencontract)* +**Returns:** *[ExchangeContract](#class-exchangecontract)* ## Properties -#### `Optional` _deployedBytecodeIfExists +### `Optional` _deployedBytecodeIfExists • **_deployedBytecodeIfExists**? : *`Buffer`* -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:32 ___ @@ -3795,7 +3458,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -3805,7 +3468,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:29 ___ @@ -3815,7 +3478,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -3825,11954 +3488,893 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:30 ## Methods -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* +### EIP1271_MAGIC_VALUE -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2484](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2484)* +▸ **EIP1271_MAGIC_VALUE**(): *`ContractFunctionObj`* -Gets historical logs without creating a subscription +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3106)* -**Type parameters:** +**Returns:** *`ContractFunctionObj`* -▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)* +___ -**Parameters:** +### EIP712_EXCHANGE_DOMAIN_HASH -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}` | +▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj`* -**Returns:** *`Promise>>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3153)* -Array of logs that match the parameters +**Returns:** *`ContractFunctionObj`* ___ -### subscribe +### allowedValidators -▸ **subscribe**<**ArgsType**>(`eventName`: [DummyERC721TokenEvents](#enumeration-dummyerc721tokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* +▸ **allowedValidators**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2442](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2442)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3200](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3200)* -Subscribe to an event type emitted by the DummyERC721Token contract. +**Parameters:** -**Type parameters:** +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | -▪ **ArgsType**: *[DummyERC721TokenEventArgs](#dummyerc721tokeneventargs)* +**Returns:** *`ContractFunctionObj`* -**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 +### batchCancelOrders -▸ **unsubscribe**(`subscriptionToken`: string): *void* +▸ **batchCancelOrders**(`orders`: `Array`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2467](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2467)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3259](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3259)* -Cancel a subscription +Executes multiple calls of cancelOrder. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | +`orders` | `Array` | Array of order specifications. | -**Returns:** *void* +**Returns:** *`ContractTxFunctionObj`* ___ -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2473](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2473)* - -Cancels all existing subscriptions +### batchExecuteTransactions -**Returns:** *void* +▸ **batchExecuteTransactions**(`transactions`: `Array`, `signatures`: string[]): *`ContractTxFunctionObj`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3403](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3403)* -### `Static` ABI +Executes a batch of Exchange method calls in the context of signer(s). -▸ **ABI**(): *[ContractAbi](#contractabi)* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2065](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2065)* +Name | Type | Description | +------ | ------ | ------ | +`transactions` | `Array` | Array of 0x transaction structures. | +`signatures` | string[] | Array of proofs that transactions have been signed by signer(s). | -**Returns:** *[ContractAbi](#contractabi)* +**Returns:** *`ContractTxFunctionObj`* -The contract ABI +Array containing ABI encoded return data for each of the underlying Exchange function calls. ___ -### `Static` deployAsync +### batchFillOrKillOrders -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* +▸ **batchFillOrKillOrders**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:2017](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L2017)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3541](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3541)* + +Executes multiple calls of fillOrKillOrder. **Parameters:** -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | +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:** *`Promise`* +**Returns:** *`ContractTxFunctionObj>`* + +Array of amounts filled and fees paid by makers and taker. ___ -### `Static` deployFrom0xArtifactAsync +### batchFillOrders -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_name`: string, `_symbol`: string): *`Promise`* +▸ **batchFillOrders**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1982](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1982)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3717](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3717)* + +Executes multiple calls of fillOrder. **Parameters:** -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_name` | string | -`_symbol` | string | +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:** *`Promise`* +**Returns:** *`ContractTxFunctionObj>`* -___ +Array of amounts filled and fees paid by makers and taker. -### `Static` strictArgumentEncodingCheck +___ -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* +### batchFillOrdersNoThrow +▸ **batchFillOrdersNoThrow**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *`ContractTxFunctionObj>`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3893](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3893)* -Defined in base-contract/lib/src/index.d.ts:41 +Executes multiple calls of fillOrder. If any fill reverts, the error is caught and ignored. **Parameters:** -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | +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* +**Returns:** *`ContractTxFunctionObj>`* -## Object literals +Array of amounts filled and fees paid by makers and taker. -### approve +___ -#### ▪ **approve**: *object* +### batchMatchOrders -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:76](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L76)* +▸ **batchMatchOrders**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *`ContractTxFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4073](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4073)* -#### awaitTransactionSuccessAsync +Match complementary orders that have a profitable spread. +Each order is filled at their respective price point, and +the matcher receives a profit denominated in the left maker asset. -▸ **awaitTransactionSuccessAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:126](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L126)* +Name | Type | Description | +------ | ------ | ------ | +`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | +`rightOrders` | `Array` | Set of orders to match against `leftOrders` | +`leftSignatures` | string[] | Proof that left orders were created by the left makers. | +`rightSignatures` | string[] | Proof that right orders were created by the right makers. | -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. +**Returns:** *`ContractTxFunctionObj`* -**Parameters:** +batchMatchedFillResults Amounts filled and profit generated. -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_approved` | string | - | The new approved NFT controller | -`_tokenId` | `BigNumber` | - | The NFT to approve | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +___ -**Returns:** *`PromiseWithTransactionHash`* +### batchMatchOrdersWithMaximalFill -A promise that resolves when the transaction is successful +▸ **batchMatchOrdersWithMaximalFill**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *`ContractTxFunctionObj`* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4298](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4298)* -▸ **callAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +Match complementary orders that have a profitable spread. +Each order is maximally filled at their respective price point, and +the matcher receives a profit denominated in either the left maker asset, +right maker asset, or a combination of both. -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:189](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L189)* +**Parameters:** -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. +Name | Type | Description | +------ | ------ | ------ | +`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | +`rightOrders` | `Array` | Set of orders to match against `leftOrders` | +`leftSignatures` | string[] | Proof that left orders were created by the left makers. | +`rightSignatures` | string[] | Proof that right orders were created by the right makers. | -**Parameters:** +**Returns:** *`ContractTxFunctionObj`* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_approved` | string | - | The new approved NFT controller | -`_tokenId` | `BigNumber` | - | The NFT to approve | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +batchMatchedFillResults Amounts filled and profit generated. -**Returns:** *`Promise`* +___ -#### estimateGasAsync +### cancelOrder -▸ **estimateGasAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +▸ **cancelOrder**(`order`: object): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:155](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L155)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4514](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4514)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +After calling, the order can not be filled anymore. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_approved` | string | The new approved NFT controller | -`_tokenId` | `BigNumber` | The NFT to approve | -`txData?` | `Partial` \| undefined | Additional data for transaction | +`order` | object | Order struct containing order specifications. | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* -The hash of the transaction +___ -#### getABIEncodedTransactionData +### cancelOrdersUpTo -▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* +▸ **cancelOrdersUpTo**(`targetOrderEpoch`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:243](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L243)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4654](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4654)* -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). +Cancels all orders created by makerAddress with a salt less than or equal to the targetOrderEpoch +and senderAddress equal to msg.sender (or null address if msg.sender == makerAddress). **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_approved` | string | The new approved NFT controller | -`_tokenId` | `BigNumber` | The NFT to approve | - -**Returns:** *string* - -The ABI encoded transaction data as a string +`targetOrderEpoch` | `BigNumber` | Orders created with a salt less or equal to this value will be cancelled. | -#### getSelector +**Returns:** *`ContractTxFunctionObj`* -▸ **getSelector**(): *string* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:256](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L256)* +### cancelled -Returns the 4 byte function selector as a hex string. +▸ **cancelled**(`index_0`: string): *`ContractFunctionObj`* -**Returns:** *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4762](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4762)* -#### sendTransactionAsync +**Parameters:** -▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +Name | Type | +------ | ------ | +`index_0` | string | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L85)* +**Returns:** *`ContractFunctionObj`* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +___ -**Parameters:** +### currentContextAddress -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_approved` | string | - | The new approved NFT controller | -`_tokenId` | `BigNumber` | - | The NFT to approve | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +▸ **currentContextAddress**(): *`ContractFunctionObj`* -**Returns:** *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4810](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4810)* -The hash of the transaction +**Returns:** *`ContractFunctionObj`* ___ -### balanceOf +### executeTransaction -#### ▪ **balanceOf**: *object* +▸ **executeTransaction**(`transaction`: object, `signature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:266](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L266)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4863](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4863)* -NFTs assigned to the zero address are considered invalid, and this -function throws for queries about the zero address. +Executes an Exchange method call in the context of signer. -#### callAsync +**Parameters:** -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction structure. | +`signature` | string | Proof that transaction has been signed by signer. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:274](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L274)* +**Returns:** *`ContractTxFunctionObj`* -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. +ABI encoded return data of the underlying Exchange function call. -**Parameters:** +___ -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_owner` | string | - | An address for whom to query the balance | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +### fillOrKillOrder -**Returns:** *`Promise`* +▸ **fillOrKillOrder**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *`ContractTxFunctionObj`* -The number of NFTs owned by `_owner`, possibly zero +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4999](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4999)* -___ +Fills the input order. Reverts if exact takerAssetFillAmount not filled. -### burn +**Parameters:** -#### ▪ **burn**: *object* +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. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:320](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L320)* +**Returns:** *`ContractTxFunctionObj`* -Function to burn a token -Reverts if the given token ID doesn't exist or not called by contract owner +___ -#### awaitTransactionSuccessAsync +### fillOrder -▸ **awaitTransactionSuccessAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +▸ **fillOrder**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:367](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L367)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5168](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5168)* -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. +Fills the input order. **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 | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +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:** *`PromiseWithTransactionHash`* +**Returns:** *`ContractTxFunctionObj`* -A promise that resolves when the transaction is successful +Amounts filled and fees paid by maker and taker. -#### callAsync +___ -▸ **callAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### filled -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:427](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L427)* +▸ **filled**(`index_0`: string): *`ContractFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5330)* **Parameters:** -Name | Type | 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 +Name | Type | +------ | ------ | +`index_0` | string | -▸ **estimateGasAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +**Returns:** *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:396](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L396)* +___ -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +### getABIDecodedReturnData -**Parameters:** +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -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 | +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3092](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3092)* -**Returns:** *`Promise`* +**Type parameters:** -The hash of the transaction +▪ **T** -#### getABIEncodedTransactionData +**Parameters:** -▸ **getABIEncodedTransactionData**(`_owner`: string, `_tokenId`: `BigNumber`): *string* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:478](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L478)* +**Returns:** *`T`* -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:** +### getABIDecodedTransactionData -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 | +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -**Returns:** *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3085](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3085)* -The ABI encoded transaction data as a string +**Type parameters:** -#### getSelector +▪ **T** -▸ **getSelector**(): *string* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:491](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L491)* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -Returns the 4 byte function selector as a hex string. +**Returns:** *`T`* -**Returns:** *string* +___ -#### sendTransactionAsync +### getAssetProxy -▸ **sendTransactionAsync**(`_owner`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +▸ **getAssetProxy**(`assetProxyId`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L329)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5383](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5383)* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +Gets an asset proxy. **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 | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +Name | Type | Description | +------ | ------ | ------ | +`assetProxyId` | string | Id of the asset proxy. | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -The hash of the transaction +The asset proxy registered to assetProxyId. Returns 0x0 if no proxy is registered. ___ -### getApproved +### getFunctionSignature -#### ▪ **getApproved**: *object* +▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:500](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L500)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3079](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3079)* -Throws if `_tokenId` is not a valid NFT. +**Parameters:** -#### callAsync +Name | Type | +------ | ------ | +`methodName` | string | -▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +**Returns:** *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:508](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L508)* +___ -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. +### getLogsAsync -**Parameters:** +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_tokenId` | `BigNumber` | - | The NFT to find the approved address for | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8050](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8050)* -**Returns:** *`Promise`* +Gets historical logs without creating a subscription -The approved address for this NFT, or the zero address if there is none +**Type parameters:** -___ - -### isApprovedForAll - -#### ▪ **isApprovedForAll**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:550](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L550)* - -#### callAsync - -▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:559](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L559)* - -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 - -___ - -### mint - -#### ▪ **mint**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:610](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L610)* - -Function to mint a new token -Reverts if the given token ID already exists - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:657](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L657)* - -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 | 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 | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:717](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L717)* - -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:686](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L686)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:768](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L768)* - -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). +▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)* **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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:781](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L781)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:619](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L619)* - -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 | 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 | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +`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`* +**Returns:** *`Promise>>`* -The hash of the transaction +Array of logs that match the parameters ___ -### name - -#### ▪ **name**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:787](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L787)* - -#### callAsync +### getOrderInfo -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **getOrderInfo**(`order`: object): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:793](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L793)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5436)* -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. +Gets information about an order: status, hash, and amount filled. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### owner - -#### ▪ **owner**: *object* +`order` | object | Order to gather information on. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:830](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L830)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:836](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_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 | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +**Returns:** *`ContractFunctionObj`* -**Returns:** *`Promise`* +OrderInfo Information about the order and its state. See LibOrder.OrderInfo for a complete description. ___ -### ownerOf - -#### ▪ **ownerOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:877](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L877)* - -NFTs assigned to zero address are considered invalid, and queries -about them do throw. - -#### callAsync +### getSelector -▸ **callAsync**(`_tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **getSelector**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:885](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L885)* - -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3099](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3099)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_tokenId` | `BigNumber` | - | The identifier for an NFT | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`methodName` | string | -The address of the owner of the NFT +**Returns:** *string* ___ -### safeTransferFrom1 - -#### ▪ **safeTransferFrom1**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:931](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L931)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:986](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L986)* - -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 | Default | 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 | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1062](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1062)* - -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 +### isValidHashSignature -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +▸ **isValidHashSignature**(`hash`: string, `signerAddress`: string, `signature`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1024](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1024)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5520](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5520)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +Verifies that a hash has been signed by the given signer. **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 | +`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:** *`Promise`* +**Returns:** *`ContractFunctionObj`* + +isValid `true` if the signature is valid for the given hash and signer. -The hash of the transaction +___ -#### getABIEncodedTransactionData +### isValidOrderSignature -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* +▸ **isValidOrderSignature**(`order`: object, `signature`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1120)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5583](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5583)* -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). +Verifies that a signature for an order is valid. **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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1135)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:941](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L941)* - -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. - -**Parameters:** +`order` | object | The order. | +`signature` | string | Proof that the order has been signed by signer. | -Name | Type | Default | 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 | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* -The hash of the transaction +isValid `true` if the signature is valid for the given order and signer. ___ -### safeTransferFrom2 - -#### ▪ **safeTransferFrom2**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1150](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1150)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1210](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1210)* - -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 | 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` | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1294](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1294)* - -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 +### isValidTransactionSignature -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined): *`Promise`* +▸ **isValidTransactionSignature**(`transaction`: object, `signature`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1252](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1252)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5664](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5664)* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +Verifies that a signature for a transaction is valid. **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 | +`transaction` | object | The transaction. | +`signature` | string | Proof that the order has been signed by signer. | -**Returns:** *`Promise`* +**Returns:** *`ContractFunctionObj`* + +isValid `true` if the signature is valid for the given transaction and signer. -The hash of the transaction +___ -#### getABIEncodedTransactionData +### marketBuyOrdersFillOrKill -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* +▸ **marketBuyOrdersFillOrKill**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1356](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1356)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5738](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5738)* -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). +Calls marketBuyOrdersNoThrow then reverts if < makerAssetFillAmount has been bought. +NOTE: This function does not enforce that the makerAsset is the same for each order. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`_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 - -#### getSelector +`orders` | `Array` | Array of order specifications. | +`makerAssetFillAmount` | `BigNumber` | Minimum amount of makerAsset to buy. | +`signatures` | string[] | Proofs that orders have been signed by makers. | -▸ **getSelector**(): *string* +**Returns:** *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1371](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1371)* +Amounts filled and fees paid by makers and taker. -Returns the 4 byte function selector as a hex string. +___ -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1161](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1161)* - -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 | 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` | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### setApprovalForAll - -#### ▪ **setApprovalForAll**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1381](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1381)* - -Emits the ApprovalForAll event. The contract MUST allow -multiple operators per owner. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1431)* - -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 | 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 | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1499](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1499)* - -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:1465](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1465)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1553](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1553)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1566](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1566)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1390](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1390)* - -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 | 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 | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### symbol - -#### ▪ **symbol**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1572](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1572)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1578](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1578)* - -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`* - -___ - -### transferFrom - -#### ▪ **transferFrom**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1621](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1621)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1676](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1676)* - -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 | Default | 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 | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1752](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1752)* - -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:1714](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1714)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1810](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1810)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1825](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1825)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1631](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1631)* - -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 | Default | 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 | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1831](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1831)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1872](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1872)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1921](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1921)* - -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:1897](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1897)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1964](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1964)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1975](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1975)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:1838](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L1838)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: DutchAuctionContract - - -## Constructors - - - -\+ **new DutchAuctionContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[DutchAuctionContract](#class-dutchauctioncontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:1073](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L1073)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | DutchAuctionContract.deployedBytecode | - -**Returns:** *[DutchAuctionContract](#class-dutchauctioncontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:781](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L781)* - -**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:734](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L734)* - -**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:701](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L701)* - -**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:41 - -**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:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L44)* - -Calculates the Auction Details for the given order - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:102](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L102)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | The sell order | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:184](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L184)* - -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:140](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L140)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:263](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L263)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:287](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L287)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L52)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | The sell order | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### matchOrders - -#### ▪ **matchOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:312](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L312)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L398)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:533](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L533)* - -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:466](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L466)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:649](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L649)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:693](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L693)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`buyOrder`: object, `sellOrder`: object, `buySignature`: string, `sellSignature`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts:325](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dutch_auction.ts#L325)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: ERC1155ProxyContract - - -## Constructors - - - -\+ **new ERC1155ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC1155ProxyContract](#class-erc1155proxycontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1529](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1529)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ERC1155ProxyContract.deployedBytecode | - -**Returns:** *[ERC1155ProxyContract](#class-erc1155proxycontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC1155ProxyEvents](#enumeration-erc1155proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1513](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1513)* - -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:1471](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1471)* - -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:1496](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1496)* - -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:1502](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1502)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1255](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1255)* - -**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:1213](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1213)* - -**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:1188](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1188)* - -**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:41 - -**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:65](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L65)* - -Authorizes an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:108](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L108)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to authorize. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:159](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L159)* - -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:134](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L134)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:203](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L203)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:214](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L214)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L73)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to authorize. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### authorities - -#### ▪ **authorities**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:220](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L220)* - -#### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:226](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L226)* - -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`* - -___ - -### authorized - -#### ▪ **authorized**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:268](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L268)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:274](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.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 | ------- | ------ | ------ | -`index_0` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### getAuthorizedAddresses - -#### ▪ **getAuthorizedAddresses**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:319](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L319)* - -Gets all authorized addresses. - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:326](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L326)* - -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. - -___ - -### getProxyId - -#### ▪ **getProxyId**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:366](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L366)* - -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:373](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L373)* - -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. - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:402](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L402)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:408](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L408)* - -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`* - -___ - -### removeAuthorizedAddress - -#### ▪ **removeAuthorizedAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:448](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L448)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:491](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L491)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:542](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L542)* - -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:517](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L517)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:586](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L586)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:597](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L597)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:456](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L456)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### removeAuthorizedAddressAtIndex - -#### ▪ **removeAuthorizedAddressAtIndex**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:606](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L606)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:656](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L656)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`index` | `BigNumber` | - | Index of target in authorities array. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:724](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L724)* - -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:690](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L690)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:778](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.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 | ------- | ------ | ------ | -`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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:791](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L791)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:615](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L615)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`index` | `BigNumber` | - | Index of target in authorities array. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### transferFrom - -#### ▪ **transferFrom**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:800](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L800)* - -Transfers batch of ERC1155 assets. Either succeeds or throws. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:864](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L864)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:952](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L952)* - -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:908](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L908)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1016](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1016)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1031](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1031)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`assetData`: string, `from`: string, `to`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:813](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L813)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1037](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1037)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1078](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1078)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1127](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1127)* - -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:1103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1103)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1170](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1170)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1181](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1181)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:1044](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L1044)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: ERC20ProxyContract - - -## Constructors - - - -\+ **new ERC20ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC20ProxyContract](#class-erc20proxycontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1270](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1270)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ERC20ProxyContract.deployedBytecode | - -**Returns:** *[ERC20ProxyContract](#class-erc20proxycontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20ProxyEvents](#enumeration-erc20proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1254](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1254)* - -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:1212](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1212)* - -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:1237](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1237)* - -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:1243](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1243)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:1015](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L1015)* - -**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:973](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L973)* - -**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:948](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L948)* - -**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:41 - -**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:65](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L65)* - -Authorizes an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:108](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L108)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to authorize. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:159](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L159)* - -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:134](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L134)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:203](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L203)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:214](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L214)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L73)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to authorize. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### authorities - -#### ▪ **authorities**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:220](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L220)* - -#### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:226](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L226)* - -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`* - -___ - -### authorized - -#### ▪ **authorized**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:702](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L702)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:708](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L708)* - -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`* - -___ - -### getAuthorizedAddresses - -#### ▪ **getAuthorizedAddresses**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:753](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L753)* - -Gets all authorized addresses. - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:760](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L760)* - -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. - -___ - -### getProxyId - -#### ▪ **getProxyId**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:666](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L666)* - -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:673](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L673)* - -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. - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:426](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L426)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L432)* - -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`* - -___ - -### removeAuthorizedAddress - -#### ▪ **removeAuthorizedAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:271](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L271)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:314](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L314)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:365](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L365)* - -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:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L340)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:409](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L409)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:420](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L420)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:279](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L279)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### removeAuthorizedAddressAtIndex - -#### ▪ **removeAuthorizedAddressAtIndex**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:472](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L472)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:522](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L522)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`index` | `BigNumber` | - | Index of target in authorities array. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:590](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L590)* - -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:556](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L556)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:644](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L644)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:657](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L657)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:481](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L481)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`index` | `BigNumber` | - | Index of target in authorities array. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:797](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L797)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:838](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L838)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:887](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L887)* - -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:863](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L863)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:930](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L930)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:941](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L941)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:804](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L804)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: ERC20TokenContract - - -## Constructors - - - -\+ **new ERC20TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC20TokenContract](#class-erc20tokencontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1113](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1113)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ERC20TokenContract.deployedBytecode | - -**Returns:** *[ERC20TokenContract](#class-erc20tokencontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC20TokenEvents](#enumeration-erc20tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:1097](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1097)* - -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:1055](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1055)* - -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:1080](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1080)* - -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:1086](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L1086)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:866](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L866)* - -**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:824](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L824)* - -**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:799](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L799)* - -**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:41 - -**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:742](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L742)* - -#### callAsync - -▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:751](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L751)* - -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 - -___ - -### approve - -#### ▪ **approve**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:64](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L64)* - -`msg.sender` approves `_spender` to spend `_value` tokens - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:114](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L114)* - -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 | 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 | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:178](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L178)* - -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:143](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L143)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:232](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L232)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:245](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L245)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L73)* - -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 | 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 | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### balanceOf - -#### ▪ **balanceOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:515](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L515)* - -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:523](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L523)* - -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 - -___ - -### totalSupply - -#### ▪ **totalSupply**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:254](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L254)* - -Query total supply of token - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:261](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L261)* - -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 - -___ - -### transfer - -#### ▪ **transfer**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:568](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L568)* - -send `value` token to `to` from `msg.sender` - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:615](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L615)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | The address of the recipient | -`_value` | `BigNumber` | - | The amount of token to be transferred | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:672](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L672)* - -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:644](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L644)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:723](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L723)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:736](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L736)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:577](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L577)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | The address of the recipient | -`_value` | `BigNumber` | - | The amount of token to be transferred | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### transferFrom - -#### ▪ **transferFrom**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:301](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L301)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:356](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L356)* - -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 | 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 | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L433)* - -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:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L394)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:491](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L491)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:506](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L506)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:311](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L311)* - -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 | 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 | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: ERC721ProxyContract - - -## Constructors - - - -\+ **new ERC721ProxyContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC721ProxyContract](#class-erc721proxycontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1270](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1270)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ERC721ProxyContract.deployedBytecode | - -**Returns:** *[ERC721ProxyContract](#class-erc721proxycontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721ProxyEvents](#enumeration-erc721proxyevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1254](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1254)* - -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:1212](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1212)* - -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:1237](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1237)* - -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:1243](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1243)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:1015](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L1015)* - -**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:973](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L973)* - -**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:948](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L948)* - -**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:41 - -**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:65](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L65)* - -Authorizes an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:108](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L108)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to authorize. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:159](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L159)* - -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:134](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L134)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:203](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L203)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:214](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L214)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L73)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to authorize. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### authorities - -#### ▪ **authorities**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:220](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L220)* - -#### callAsync - -▸ **callAsync**(`index_0`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:226](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L226)* - -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`* - -___ - -### authorized - -#### ▪ **authorized**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:702](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L702)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:708](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L708)* - -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`* - -___ - -### getAuthorizedAddresses - -#### ▪ **getAuthorizedAddresses**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:753](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L753)* - -Gets all authorized addresses. - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:760](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L760)* - -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. - -___ - -### getProxyId - -#### ▪ **getProxyId**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:666](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L666)* - -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:673](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L673)* - -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. - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:426](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L426)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L432)* - -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`* - -___ - -### removeAuthorizedAddress - -#### ▪ **removeAuthorizedAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:271](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L271)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:314](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L314)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:365](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L365)* - -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:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L340)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:409](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L409)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:420](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L420)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:279](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L279)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### removeAuthorizedAddressAtIndex - -#### ▪ **removeAuthorizedAddressAtIndex**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:472](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L472)* - -Removes authorizion of an address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:522](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L522)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`index` | `BigNumber` | - | Index of target in authorities array. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:590](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L590)* - -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:556](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L556)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`target`: string, `index`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:644](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L644)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:657](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L657)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`target`: string, `index`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:481](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L481)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`target` | string | - | Address to remove authorization from. | -`index` | `BigNumber` | - | Index of target in authorities array. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:797](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L797)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:838](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L838)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:887](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L887)* - -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:863](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L863)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:930](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L930)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:941](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L941)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts:804](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L804)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: ERC721TokenContract - - -## Constructors - - - -\+ **new ERC721TokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ERC721TokenContract](#class-erc721tokencontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1735](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1735)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ERC721TokenContract.deployedBytecode | - -**Returns:** *[ERC721TokenContract](#class-erc721tokencontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ERC721TokenEvents](#enumeration-erc721tokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1719](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1719)* - -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:1677](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1677)* - -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:1702](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1702)* - -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:1708](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1708)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1408](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1408)* - -**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:1366](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1366)* - -**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:1341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1341)* - -**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:41 - -**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:76](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L76)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:126](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L126)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`_approved` | string | - | The new approved NFT controller | -`_tokenId` | `BigNumber` | - | The NFT to approve | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:189](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L189)* - -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:155](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L155)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_approved`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:243](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L243)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:256](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L256)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_approved`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L85)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`_approved` | string | - | The new approved NFT controller | -`_tokenId` | `BigNumber` | - | The NFT to approve | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### balanceOf - -#### ▪ **balanceOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:266](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L266)* - -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:274](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_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 | 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 - -___ - -### getApproved - -#### ▪ **getApproved**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:319](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L319)* - -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:327](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L327)* - -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 - -___ - -### isApprovedForAll - -#### ▪ **isApprovedForAll**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:369](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L369)* - -#### callAsync - -▸ **callAsync**(`_owner`: string, `_operator`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:378](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L378)* - -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 - -___ - -### ownerOf - -#### ▪ **ownerOf**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L429)* - -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:437](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L437)* - -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 - -___ - -### safeTransferFrom1 - -#### ▪ **safeTransferFrom1**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:483](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L483)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:538](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L538)* - -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 | Default | 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 | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:614](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L614)* - -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:576](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L576)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:672](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L672)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:687](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L687)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:493](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L493)* - -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 | Default | 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 | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### safeTransferFrom2 - -#### ▪ **safeTransferFrom2**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:702](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L702)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:762](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L762)* - -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 | 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` | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:846](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L846)* - -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:804](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L804)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:908](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L908)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:923](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L923)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `_data`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:713](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L713)* - -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 | 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` | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### setApprovalForAll - -#### ▪ **setApprovalForAll**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:933](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L933)* - -Emits the ApprovalForAll event. The contract MUST allow -multiple operators per owner. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:983](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L983)* - -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 | 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 | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1051](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1051)* - -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:1017](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1017)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_operator`: string, `_approved`: boolean): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1105)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1118](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1118)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_operator`: string, `_approved`: boolean, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:942](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L942)* - -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 | 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 | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### transferFrom - -#### ▪ **transferFrom**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1130)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1185](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1185)* - -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 | Default | 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 | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1261](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1261)* - -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:1223](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1223)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1319](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1319)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1334](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1334)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_tokenId`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:1140](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L1140)* - -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 | Default | 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 | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: ExchangeContract - - -## Constructors - - - -\+ **new ExchangeContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ExchangeContract](#class-exchangecontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10951](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10951)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ExchangeContract.deployedBytecode | - -**Returns:** *[ExchangeContract](#class-exchangecontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ExchangeEvents](#enumeration-exchangeevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:10935](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10935)* - -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:10893](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10893)* - -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:10918](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10918)* - -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:10924](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L10924)* - -Cancels all existing subscriptions - -**Returns:** *void* - -___ - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8004](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8004)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7957](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7957)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`chainId` | `BigNumber` | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7931](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7931)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`chainId` | `BigNumber` | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:41 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### EIP1271_MAGIC_VALUE - -#### ▪ **EIP1271_MAGIC_VALUE**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L120)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:126](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L126)* - -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`* - -___ - -### EIP712_EXCHANGE_DOMAIN_HASH - -#### ▪ **EIP712_EXCHANGE_DOMAIN_HASH**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:163](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L163)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:169](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L169)* - -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`* - -___ - -### allowedValidators - -#### ▪ **allowedValidators**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:206](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L206)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:212](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.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 | ------- | ------ | ------ | -`index_0` | string | - | -`index_1` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### batchCancelOrders - -#### ▪ **batchCancelOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:262](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L262)* - -Executes multiple calls of cancelOrder. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:323](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L323)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:410](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L410)* - -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:364](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L364)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:478](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L478)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:507](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L507)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:270](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L270)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchExecuteTransactions - -#### ▪ **batchExecuteTransactions**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:518](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L518)* - -Executes a batch of Exchange method calls in the context of signer(s). - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:576](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L576)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`transactions` | `Array` | - | Array of 0x transaction structures. | -`signatures` | string[] | - | Array of proofs that transactions have been signed by signer(s). | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`transactions`: `Array`, `signatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:659](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L659)* - -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 | ------- | ------ | ------ | ------ | -`transactions` | `Array` | - | Array of 0x transaction structures. | -`signatures` | string[] | - | Array of proofs that transactions have been signed by signer(s). | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -Array containing ABI encoded return data for each of the underlying Exchange function calls. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:617](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L617)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transactions` | `Array` | Array of 0x transaction structures. | -`signatures` | string[] | Array of proofs that transactions have been signed by signer(s). | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transactions`: `Array`, `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:722](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L722)* - -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 | ------- | ------ | ------ | -`transactions` | `Array` | Array of 0x transaction structures. | -`signatures` | string[] | Array of proofs that transactions have been signed by signer(s). | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:744](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L744)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`transactions`: `Array`, `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:528](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L528)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`transactions` | `Array` | - | Array of 0x transaction structures. | -`signatures` | string[] | - | Array of proofs that transactions have been signed by signer(s). | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchFillOrKillOrders - -#### ▪ **batchFillOrKillOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:755](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L755)* - -Executes multiple calls of fillOrKillOrder. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:831](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L831)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:939](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L939)* - -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>`* - -Array of amounts filled and fees paid by makers and taker. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:885](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L885)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1030](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1030)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1063](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1063)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:766](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L766)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchFillOrders - -#### ▪ **batchFillOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1074](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1074)* - -Executes multiple calls of fillOrder. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1145](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1145)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1253](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.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 | 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>`* - -Array of amounts filled and fees paid by makers and taker. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1199](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1199)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1344](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1344)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1377](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1377)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1085](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1085)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchFillOrdersNoThrow - -#### ▪ **batchFillOrdersNoThrow**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1388](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1388)* - -Executes multiple calls of fillOrder. If any fill reverts, the error is caught and ignored. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1464](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1464)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1572](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1572)* - -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>`* - -Array of amounts filled and fees paid by makers and taker. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1518](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1518)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1663](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1663)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1696](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1696)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmounts`: `BigNumber`[], `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1399](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1399)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchMatchOrders - -#### ▪ **batchMatchOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1709](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1709)* - -Match complementary orders that have a profitable spread. -Each order is filled at their respective price point, and -the matcher receives a profit denominated in the left maker asset. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1807](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1807)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1954](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1954)* - -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 | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -batchMatchedFillResults Amounts filled and profit generated. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1881](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1881)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | Proof that right orders were created by the right makers. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2082](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2082)* - -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 | ------- | ------ | ------ | -`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | Proof that right orders were created by the right makers. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2132](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2132)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:1722](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L1722)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### batchMatchOrdersWithMaximalFill - -#### ▪ **batchMatchOrdersWithMaximalFill**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2146](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2146)* - -Match complementary orders that have a profitable spread. -Each order is maximally filled at their respective price point, and -the matcher receives a profit denominated in either the left maker asset, -right maker asset, or a combination of both. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2244](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2244)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2391)* - -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 | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -batchMatchedFillResults Amounts filled and profit generated. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2318](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2318)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | Proof that right orders were created by the right makers. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2519](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2519)* - -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 | ------- | ------ | ------ | -`leftOrders` | `Array` | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | Proof that right orders were created by the right makers. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2569](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2569)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`leftOrders`: `Array`, `rightOrders`: `Array`, `leftSignatures`: string[], `rightSignatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2159](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2159)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`leftOrders` | `Array` | - | Set of orders with the same maker / taker asset. | -`rightOrders` | `Array` | - | Set of orders to match against `leftOrders` | -`leftSignatures` | string[] | - | Proof that left orders were created by the left makers. | -`rightSignatures` | string[] | - | Proof that right orders were created by the right makers. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### cancelOrder - -#### ▪ **cancelOrder**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2580](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2580)* - -After calling, the order can not be filled anymore. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`order`: object, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2640](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2640)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | Order struct containing order specifications. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:2725](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2725)* - -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. | -`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:2680](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2680)* - -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. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2792](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2792)* - -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. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2818](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2818)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`order`: object, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2588](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2588)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`order` | object | - | Order struct containing order specifications. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### cancelOrdersUpTo - -#### ▪ **cancelOrdersUpTo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2830](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2830)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2875](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2875)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`targetOrderEpoch` | `BigNumber` | - | Orders created with a salt less or equal to this value will be cancelled. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:2928](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2928)* - -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:2902](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2902)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`targetOrderEpoch`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2977](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2977)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2988](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2988)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`targetOrderEpoch`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2839](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2839)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`targetOrderEpoch` | `BigNumber` | - | Orders created with a salt less or equal to this value will be cancelled. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### cancelled - -#### ▪ **cancelled**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:2994](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L2994)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3000](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3000)* - -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`* - -___ - -### currentContextAddress - -#### ▪ **currentContextAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3042](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3042)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3048](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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 | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ - -### executeTransaction - -#### ▪ **executeTransaction**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3088](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3088)* - -Executes an Exchange method call in the context of signer. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3143](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3143)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`transaction` | object | - | 0x transaction structure. | -`signature` | string | - | Proof that transaction has been signed by signer. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`transaction`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3217](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3217)* - -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 structure. | -`signature` | string | - | Proof that transaction has been signed by signer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -ABI encoded return data of the underlying Exchange function call. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3177)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`transaction` | object | 0x transaction structure. | -`signature` | string | Proof that transaction has been signed by signer. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`transaction`: object, `signature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3278](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3278)* - -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 structure. | -`signature` | string | Proof that transaction has been signed by signer. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3299](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3299)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`transaction`: object, `signature`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3097](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3097)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`transaction` | object | - | 0x transaction structure. | -`signature` | string | - | Proof that transaction has been signed by signer. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### fillOrKillOrder - -#### ▪ **fillOrKillOrder**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3310](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3310)* - -Fills the input order. Reverts if exact takerAssetFillAmount not filled. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3378](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3378)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:3481](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3481)* - -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:3430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3430)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3566](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3566)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3598](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3598)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3320](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3320)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### fillOrder - -#### ▪ **fillOrder**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3609](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3609)* - -Fills the input order. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3677](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3677)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:3781](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3781)* - -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:3729](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3729)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3866](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3866)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3898](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3898)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`order`: object, `takerAssetFillAmount`: `BigNumber`, `signature`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3619](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3619)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### filled - -#### ▪ **filled**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3906](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3906)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3912](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3912)* - -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`* - -___ - -### getAssetProxy - -#### ▪ **getAssetProxy**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3957](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3957)* - -Gets an asset proxy. - -#### callAsync - -▸ **callAsync**(`assetProxyId`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:3965](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L3965)* - -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. - -___ - -### getOrderInfo - -#### ▪ **getOrderInfo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4010](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4010)* - -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:4018](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4018)* - -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. - -___ - -### isValidHashSignature - -#### ▪ **isValidHashSignature**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4086](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4086)* - -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:4096](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4096)* - -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`* - -isValid `true` if the signature is valid for the given hash and signer. - -___ - -### isValidOrderSignature - -#### ▪ **isValidOrderSignature**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4149](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4149)* - -Verifies that a signature for an order is valid. - -#### callAsync - -▸ **callAsync**(`order`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4158](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4158)* - -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. | -`signature` | string | - | Proof that the order has been signed by signer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -isValid `true` if the signature is valid for the given order and signer. - -___ - -### isValidTransactionSignature - -#### ▪ **isValidTransactionSignature**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4224](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4224)* - -Verifies that a signature for a transaction is valid. - -#### callAsync - -▸ **callAsync**(`transaction`: object, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4233](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4233)* - -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 | - | The transaction. | -`signature` | string | - | Proof that the order has been signed by signer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -isValid `true` if the signature is valid for the given transaction and signer. - -___ - -### marketBuyOrdersFillOrKill - -#### ▪ **marketBuyOrdersFillOrKill**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4291](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4291)* - -Calls marketBuyOrdersNoThrow then reverts if < makerAssetFillAmount has been bought. -NOTE: This function does not enforce that the makerAsset is the same for each order. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4365](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4365)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`makerAssetFillAmount` | `BigNumber` | - | Minimum amount of makerAsset to buy. | -`signatures` | string[] | - | Proofs that orders have been signed by makers. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:4471](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4471)* - -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` | - | Minimum 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:4418](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4418)* - -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` | Minimum 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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4557](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4557)* - -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` | Minimum 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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4590](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4590)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4301](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4301)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`makerAssetFillAmount` | `BigNumber` | - | Minimum amount of makerAsset to buy. | -`signatures` | string[] | - | Proofs that orders have been signed by makers. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### marketBuyOrdersNoThrow - -#### ▪ **marketBuyOrdersNoThrow**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4603](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4603)* - -Executes multiple calls of fillOrder until total amount of makerAsset is bought by taker. -If any fill reverts, the error is caught and ignored. -NOTE: This function does not enforce that the makerAsset is the same for each order. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4677](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4677)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:4783](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4783)* - -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:4730](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4730)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4869](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4869)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4902](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4902)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4613](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4613)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### marketSellOrdersFillOrKill - -#### ▪ **marketSellOrdersFillOrKill**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4914](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4914)* - -Calls marketSellOrdersNoThrow then reverts if < takerAssetFillAmount has been sold. -NOTE: This function does not enforce that the takerAsset is the same for each order. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4988](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4988)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`takerAssetFillAmount` | `BigNumber` | - | Minimum amount of takerAsset to sell. | -`signatures` | string[] | - | Proofs that orders have been signed by makers. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:5094](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5094)* - -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` | - | Minimum 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:5041](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5041)* - -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` | Minimum 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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5180](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5180)* - -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` | Minimum 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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5213](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5213)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:4924](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L4924)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications. | -`takerAssetFillAmount` | `BigNumber` | - | Minimum amount of takerAsset to sell. | -`signatures` | string[] | - | Proofs that orders have been signed by makers. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### marketSellOrdersNoThrow - -#### ▪ **marketSellOrdersNoThrow**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5226](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5226)* - -Executes multiple calls of fillOrder until total amount of takerAsset is sold by taker. -If any fill reverts, the error is caught and ignored. -NOTE: This function does not enforce that the takerAsset is the same for each order. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5300](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5300)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:5406](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5406)* - -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:5353](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5353)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5492](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5492)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5525](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5525)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5236](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5236)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### matchOrders - -#### ▪ **matchOrders**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5539](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5539)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5631](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5631)* - -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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:5770](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5770)* - -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:5701](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5701)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5894](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5894)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5942](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5942)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5550](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5550)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### matchOrdersWithMaximalFill - -#### ▪ **matchOrdersWithMaximalFill**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5956](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5956)* - -Match two complementary orders that have a profitable spread. -Each order is maximally filled at their respective price point, and -the matcher receives a profit denominated in either the left maker asset, -right maker asset, or a combination of both. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6048](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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 | 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. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:6187](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6187)* - -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 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:6118](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6118)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6311](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6311)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6359](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6359)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5967](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5967)* - -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 | 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. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### orderEpoch - -#### ▪ **orderEpoch**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6367](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6367)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6373](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6373)* - -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`* - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6420](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6420)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6426](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6426)* - -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`* - -___ - -### preSign - -#### ▪ **preSign**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6467](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6467)* - -Approves a hash on-chain. -After presigning a hash, the preSign signature type will become valid for that hash and signer. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`hash`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6510](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6510)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`hash` | string | - | Any 32-byte hash. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`hash`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6561](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6561)* - -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. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`hash`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6536](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6536)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`hash` | string | Any 32-byte hash. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`hash`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6605](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6605)* - -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. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6614](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6614)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`hash`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6475](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6475)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`hash` | string | - | Any 32-byte hash. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### preSigned - -#### ▪ **preSigned**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6620](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6620)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6626](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6626)* - -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`* - -___ - -### protocolFeeCollector - -#### ▪ **protocolFeeCollector**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6673](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6673)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6679](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6679)* - -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`* - -___ - -### protocolFeeMultiplier - -#### ▪ **protocolFeeMultiplier**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6716](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6716)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6722](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6722)* - -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`* - -___ - -### registerAssetProxy - -#### ▪ **registerAssetProxy**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6763](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6763)* - -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`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6806](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6806)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`assetProxy` | string | - | Address of new asset proxy to register. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:6857](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6857)* - -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:6832](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6832)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetProxy`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6905](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6905)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6916](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6916)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`assetProxy`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6771](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6771)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`assetProxy` | string | - | Address of new asset proxy to register. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### setProtocolFeeCollectorAddress - -#### ▪ **setProtocolFeeCollectorAddress**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6925](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6925)* - -Allows the owner to update the protocolFeeCollector address. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6972](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6972)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`updatedProtocolFeeCollector` | string | - | The updated protocolFeeCollector contract address. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`updatedProtocolFeeCollector`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7034](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7034)* - -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 | ------- | ------ | ------ | ------ | -`updatedProtocolFeeCollector` | string | - | The updated protocolFeeCollector contract address. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7003](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7003)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`updatedProtocolFeeCollector`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7085](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7085)* - -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 | ------- | ------ | ------ | -`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7096](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7096)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`updatedProtocolFeeCollector`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6934](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6934)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`updatedProtocolFeeCollector` | string | - | The updated protocolFeeCollector contract address. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### setProtocolFeeMultiplier - -#### ▪ **setProtocolFeeMultiplier**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7105)* - -Allows the owner to update the protocol fee multiplier. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7150](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7150)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`updatedProtocolFeeMultiplier` | `BigNumber` | - | The updated protocol fee multiplier. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7210](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7210)* - -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 | ------- | ------ | ------ | ------ | -`updatedProtocolFeeMultiplier` | `BigNumber` | - | The updated protocol fee multiplier. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7180](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7180)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`updatedProtocolFeeMultiplier`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7260](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7260)* - -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 | ------- | ------ | ------ | -`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7271](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7271)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`updatedProtocolFeeMultiplier`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7113](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7113)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`updatedProtocolFeeMultiplier` | `BigNumber` | - | The updated protocol fee multiplier. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### setSignatureValidatorApproval - -#### ▪ **setSignatureValidatorApproval**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7281](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7281)* - -Approves/unnapproves a Validator contract to verify signatures on signer's behalf -using the `Validator` signature type. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7331)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`validatorAddress` | string | - | Address of Validator contract. | -`approval` | boolean | - | Approval or disapproval of Validator contract. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:7399](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7399)* - -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:7365](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7365)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`validatorAddress`: string, `approval`: boolean): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7453](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7453)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7466](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7466)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`validatorAddress`: string, `approval`: boolean, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7290](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7290)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`validatorAddress` | string | - | Address of Validator contract. | -`approval` | boolean | - | Approval or disapproval of Validator contract. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### simulateDispatchTransferFromCalls - -#### ▪ **simulateDispatchTransferFromCalls**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7475](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7475)* - -This function may be used to simulate any amount of transfers As they would occur through the Exchange contract. Note that this function will always revert, even if all transfers are successful. However, it may be used with eth_call or with a try/catch pattern in order to simulate the results of the transfers. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7547](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7547)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | -`fromAddresses` | string[] | - | Array containing the `from` addresses that correspond with each transfer. | -`toAddresses` | string[] | - | Array containing the `to` addresses that correspond with each transfer. | -`amounts` | `BigNumber`[] | - | Array containing the amounts that correspond to each transfer. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7638](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7638)* - -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[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | -`fromAddresses` | string[] | - | Array containing the `from` addresses that correspond with each transfer. | -`toAddresses` | string[] | - | Array containing the `to` addresses that correspond with each transfer. | -`amounts` | `BigNumber`[] | - | Array containing the amounts that correspond to each transfer. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -This function does not return a value. However, it will always revert with `Error("TRANSFERS_SUCCESSFUL")` if all of the transfers were successful. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7593](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7593)* - -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | -`fromAddresses` | string[] | Array containing the `from` addresses that correspond with each transfer. | -`toAddresses` | string[] | Array containing the `to` addresses that correspond with each transfer. | -`amounts` | `BigNumber`[] | Array containing the amounts that correspond to each transfer. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[]): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7704](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7704)* - -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[] | Array of asset details, each encoded per the AssetProxy contract specification. | -`fromAddresses` | string[] | Array containing the `from` addresses that correspond with each transfer. | -`toAddresses` | string[] | Array containing the `to` addresses that correspond with each transfer. | -`amounts` | `BigNumber`[] | Array containing the amounts that correspond to each transfer. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7724](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7724)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[], `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7490](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7490)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string[] | - | Array of asset details, each encoded per the AssetProxy contract specification. | -`fromAddresses` | string[] | - | Array containing the `from` addresses that correspond with each transfer. | -`toAddresses` | string[] | - | Array containing the `to` addresses that correspond with each transfer. | -`amounts` | `BigNumber`[] | - | Array containing the amounts that correspond to each transfer. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### transactionsExecuted - -#### ▪ **transactionsExecuted**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7732](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7732)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7738](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7738)* - -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`* - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7780](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7780)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7821](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7821)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:7870](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7870)* - -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:7846](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7846)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7913](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7913)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7924](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7924)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7787](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7787)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: ForwarderContract - - -## Constructors - - - -\+ **new ForwarderContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ForwarderContract](#class-forwardercontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1615](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1615)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ForwarderContract.deployedBytecode | - -**Returns:** *[ForwarderContract](#class-forwardercontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1330)* - -**Returns:** *[ContractAbi](#contractabi)* - -The contract ABI - -___ - -### `Static` deployAsync - -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_wethAssetData`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1282](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1282)* - -**Parameters:** - -Name | Type | ------- | ------ | -`bytecode` | string | -`abi` | [ContractAbi](#contractabi) | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | -`_wethAssetData` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` deployFrom0xArtifactAsync - -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_wethAssetData`: string): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1247](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1247)* - -**Parameters:** - -Name | Type | ------- | ------ | -`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | -`supportedProvider` | [SupportedProvider](#supportedprovider) | -`txDefaults` | `Partial` | -`logDecodeDependencies` | object | -`_exchange` | string | -`_wethAssetData` | string | - -**Returns:** *`Promise`* - -___ - -### `Static` strictArgumentEncodingCheck - -▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* - - - -Defined in base-contract/lib/src/index.d.ts:41 - -**Parameters:** - -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals - -### approveMakerAssetProxy - -#### ▪ **approveMakerAssetProxy**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L48)* - -Approves the respective proxy for a given asset to transfer tokens on the Forwarder contract's behalf. -This is necessary because an order fee denominated in the maker asset (i.e. a percentage fee) is sent by the -Forwarder contract to the fee recipient. -This method needs to be called before forwarding orders of a maker asset that hasn't -previously been approved. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`assetData`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L91)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | Byte array encoded for the respective asset proxy. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:142](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L142)* - -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. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync - -▸ **estimateGasAsync**(`assetData`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:117](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L117)* - -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. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetData`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:186](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L186)* - -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. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:195](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L195)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`assetData`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:56](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L56)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`assetData` | string | - | Byte array encoded for the respective asset proxy. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### marketBuyOrdersWithEth - -#### ▪ **marketBuyOrdersWithEth**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:207](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L207)* - -Attempt to buy makerAssetBuyAmount of makerAsset by selling ETH provided with transaction. -The Forwarder may *fill* more than makerAssetBuyAmount of the makerAsset so that it can -pay takerFees where takerFeeAssetData == makerAssetData (i.e. percentage fees). -Any ETH not spent will be refunded to sender. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:295](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L295)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`makerAssetBuyAmount` | `BigNumber` | - | Desired amount of makerAsset to purchase. | -`signatures` | string[] | - | Proofs that orders have been created by makers. | -`feePercentage` | `BigNumber` | - | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | - | Address that will receive ETH when orders are filled. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber, BigNumber]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:419](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L419)* - -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. | -`makerAssetBuyAmount` | `BigNumber` | - | Desired amount of makerAsset to purchase. | -`signatures` | string[] | - | Proofs that orders have been created by makers. | -`feePercentage` | `BigNumber` | - | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | - | Address that will receive ETH when orders are filled. | -`callData` | `Partial` | {} | - | -`defaultBlock?` | [BlockParam](#blockparam) | - | - | - -**Returns:** *`Promise<[BigNumber, BigNumber, BigNumber]>`* - -wethSpentAmount Amount of WETH spent on the given set of orders.makerAssetAcquiredAmount Amount of maker asset acquired from the given set of orders.ethFeePaid Amount of ETH spent on the given forwarder fee. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`orders`: `Array`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:358](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L358)* - -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. | -`makerAssetBuyAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:501](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L501)* - -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. | -`makerAssetBuyAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:538](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L538)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:221](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L221)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `Array` | - | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`makerAssetBuyAmount` | `BigNumber` | - | Desired amount of makerAsset to purchase. | -`signatures` | string[] | - | Proofs that orders have been created by makers. | -`feePercentage` | `BigNumber` | - | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | - | Address that will receive ETH when orders are filled. | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### marketSellOrdersWithEth - -#### ▪ **marketSellOrdersWithEth**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:550](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L550)* - -Purchases as much of orders' makerAssets as possible by selling as much of the ETH value sent -as possible, accounting for order and forwarder fees. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`orders`: `Array`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:633](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L633)* - -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 | 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. | -`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 | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber, BigNumber]>`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:750](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.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 | 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. | -`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<[BigNumber, BigNumber, BigNumber]>`* - -wethSpentAmount Amount of WETH spent on the given set of orders.makerAssetAcquiredAmount Amount of maker asset acquired from the given set of orders.ethFeePaid Amount of ETH spent on the given forwarder fee. - -#### estimateGasAsync - -▸ **estimateGasAsync**(`orders`: `Array`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:692](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L692)* - -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. | -`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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`orders`: `Array`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:829](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.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 | ------- | ------ | ------ | -`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | -`signatures` | string[] | Proofs that orders have been created by makers. | -`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | -`feeRecipient` | string | Address that will receive ETH when orders are filled. | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:864](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L864)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`orders`: `Array`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:563](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L563)* - -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 | 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. | -`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 | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### owner - -#### ▪ **owner**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:872](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L872)* - -#### callAsync - -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:878](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L878)* - -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`* - -___ - -### transferOwnership - -#### ▪ **transferOwnership**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:915](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L915)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`newOwner`: string, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:956](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L956)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1005](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.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 | ------- | ------ | ------ | -`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:981](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L981)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`newOwner`: string): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1048](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.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). - -**Parameters:** - -Name | Type | ------- | ------ | -`newOwner` | string | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1059](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1059)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`newOwner`: string, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:922](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L922)* - -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 | Default | Description | ------- | ------ | ------ | ------ | -`newOwner` | string | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -___ - -### withdrawAsset - -#### ▪ **withdrawAsset**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1070](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1070)* - -Withdraws assets from this contract. The contract formerly required a ZRX balance in order -to function optimally, and this function allows the ZRX to be withdrawn by owner. -It may also be used to withdraw assets that were accidentally sent to this contract. - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1117](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1117)* - -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 | Default | 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 | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**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:1177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1177)* - -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:1146](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1146)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`assetData`: string, `amount`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1228](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1228)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1241](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1241)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync - -▸ **sendTransactionAsync**(`assetData`: string, `amount`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1079](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1079)* - -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 | Default | 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 | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction - -
- -# Class: IValidatorContract - - -## Constructors - - - -\+ **new IValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IValidatorContract](#class-ivalidatorcontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:202](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L202)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | IValidatorContract.deployedBytecode | - -**Returns:** *[IValidatorContract](#class-ivalidatorcontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:171](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L171)* - -**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:129](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L129)* - -**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:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L104)* - -**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:41 - -**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:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L44)* - -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:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L54)* - -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)")) - -
- -# Class: IWalletContract - - -## Constructors - - - -\+ **new IWalletContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IWalletContract](#class-iwalletcontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:191](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L191)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | IWalletContract.deployedBytecode | - -**Returns:** *[IWalletContract](#class-iwalletcontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:164](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L164)* - -**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:122](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L122)* - -**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:97](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L97)* - -**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:41 - -**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:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L44)* - -Validates a hash with the `Wallet` signature type. - -#### callAsync - -▸ **callAsync**(`hash`: string, `signature`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L53)* - -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`* - -magicValue `bytes4(0xb0671381)` if the signature check succeeds. - -
- -# Class: OrderValidatorContract - - -## Constructors - - - -\+ **new OrderValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[OrderValidatorContract](#class-ordervalidatorcontract)* - -*Overrides void* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1210](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1210)* - -**Parameters:** - -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | OrderValidatorContract.deployedBytecode | - -**Returns:** *[OrderValidatorContract](#class-ordervalidatorcontract)* - -## Properties - -#### `Optional` _deployedBytecodeIfExists - -• **_deployedBytecodeIfExists**? : *`Buffer`* - - - -Defined in base-contract/lib/src/index.d.ts:31 - -___ - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - - - -Defined in base-contract/lib/src/index.d.ts:27 - -___ - -### address - -• **address**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:28 - -___ - -Args - -• **constructorArgs**: *any[]* - - - -Defined in base-contract/lib/src/index.d.ts:30 - -___ - -### contractName - -• **contractName**: *string* - - - -Defined in base-contract/lib/src/index.d.ts:29 - -## Methods - -### `Static` ABI - -▸ **ABI**(): *[ContractAbi](#contractabi)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:649](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L649)* - -**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:601](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L601)* - -**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:566](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L566)* - -**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* +### marketBuyOrdersNoThrow +▸ **marketBuyOrdersNoThrow**(`orders`: `Array`, `makerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:5909](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L5909)* -Defined in base-contract/lib/src/index.d.ts:41 +Executes multiple calls of fillOrder until total amount of makerAsset is bought by taker. +If any fill reverts, the error is caught and ignored. +NOTE: This function does not enforce that the makerAsset is the same for each order. **Parameters:** -Name | Type | ------- | ------ | -`inputAbi` | `DataItem`[] | -`args` | any[] | - -**Returns:** *string* - -## Object literals +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. | -### getBalanceAndAllowance +**Returns:** *`ContractTxFunctionObj`* -#### ▪ **getBalanceAndAllowance**: *object* +Amounts filled and fees paid by makers and taker. -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L136)* +___ -#### callAsync +### marketSellOrdersFillOrKill -▸ **callAsync**(`target`: string, `assetData`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber, BigNumber]>`* +▸ **marketSellOrdersFillOrKill**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:142](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L142)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6079](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6079)* -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. +Calls marketSellOrdersNoThrow then reverts if < takerAssetFillAmount has been sold. +NOTE: This function does not enforce that the takerAsset is the same for each order. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`target` | string | - | -`assetData` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise<[BigNumber, BigNumber]>`* - -___ +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Minimum amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | -### getBalancesAndAllowances +**Returns:** *`ContractTxFunctionObj`* -#### ▪ **getBalancesAndAllowances**: *object* +Amounts filled and fees paid by makers and taker. -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:428](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L428)* +___ -#### callAsync +### marketSellOrdersNoThrow -▸ **callAsync**(`target`: string, `assetData`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[BigNumber[], BigNumber[]]>`* +▸ **marketSellOrdersNoThrow**(`orders`: `Array`, `takerAssetFillAmount`: `BigNumber`, `signatures`: string[]): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L434)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6250](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6250)* -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. +Executes multiple calls of fillOrder until total amount of takerAsset is sold by taker. +If any fill reverts, the error is caught and ignored. +NOTE: This function does not enforce that the takerAsset is the same for each order. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`target` | string | - | -`assetData` | string[] | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise<[BigNumber[], BigNumber[]]>`* - -___ +`orders` | `Array` | Array of order specifications. | +`takerAssetFillAmount` | `BigNumber` | Desired amount of takerAsset to sell. | +`signatures` | string[] | Proofs that orders have been signed by makers. | -### getERC721TokenOwner +**Returns:** *`ContractTxFunctionObj`* -#### ▪ **getERC721TokenOwner**: *object* +Amounts filled and fees paid by makers and taker. -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:375](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L375)* +___ -#### callAsync +### matchOrders -▸ **callAsync**(`token`: string, `tokenId`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **matchOrders**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:381](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L381)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6423](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6423)* -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. +Match two complementary orders that have a profitable spread. +Each order is filled at their respective price point. However, the calculations are +carried out as though the orders are both being filled at the right order's price point. +The profit made by the left order goes to the taker (who matched the two orders). **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`token` | string | - | -`tokenId` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -___ +`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. | -### getOrderAndTraderInfo +**Returns:** *`ContractTxFunctionObj`* -#### ▪ **getOrderAndTraderInfo**: *object* +matchedFillResults Amounts filled and fees paid by maker and taker of matched orders. -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L41)* +___ -#### callAsync +### matchOrdersWithMaximalFill -▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[object, object]>`* +▸ **matchOrdersWithMaximalFill**(`leftOrder`: object, `rightOrder`: object, `leftSignature`: string, `rightSignature`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L47)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6645](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6645)* -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. +Match two complementary orders that have a profitable spread. +Each order is maximally filled at their respective price point, and +the matcher receives a profit denominated in either the left maker asset, +right maker asset, or a combination of both. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`order` | object | - | -`takerAddress` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise<[object, object]>`* - -___ - -### getOrdersAndTradersInfo +`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. | -#### ▪ **getOrdersAndTradersInfo**: *object* +**Returns:** *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:189](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L189)* +matchedFillResults Amounts filled by maker and taker of matched orders. -#### callAsync +___ -▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise<[Array, Array]>`* +### orderEpoch -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:195](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L195)* +▸ **orderEpoch**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6856](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6856)* **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`orders` | `Array` | - | -`takerAddresses` | string[] | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | -**Returns:** *`Promise<[Array, Array]>`* +**Returns:** *`ContractFunctionObj`* ___ -### getTraderInfo +### owner + +▸ **owner**(): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6911](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6911)* -#### ▪ **getTraderInfo**: *object* +**Returns:** *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:481](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L481)* +___ -#### callAsync +### preSign -▸ **callAsync**(`order`: object, `takerAddress`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **preSign**(`hash`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:487](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L487)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:6963](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L6963)* -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. +Approves a hash on-chain. +After presigning a hash, the preSign signature type will become valid for that hash and signer. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`order` | object | - | -`takerAddress` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +`hash` | string | Any 32-byte hash. | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* ___ -### getTradersInfo - -#### ▪ **getTradersInfo**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:285](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L285)* - -#### callAsync - -▸ **callAsync**(`orders`: `Array`, `takerAddresses`: string[], `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise>`* +### preSigned -*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:291](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L291)* +▸ **preSigned**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7069](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7069)* **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`orders` | `Array` | - | -`takerAddresses` | string[] | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | -**Returns:** *`Promise>`* +**Returns:** *`ContractFunctionObj`* -
+___ -# Class: WETH9Contract +### protocolFeeCollector +▸ **protocolFeeCollector**(): *`ContractFunctionObj`* -## Constructors +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7124](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7124)* +**Returns:** *`ContractFunctionObj`* +___ -\+ **new WETH9Contract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[WETH9Contract](#class-weth9contract)* +### protocolFeeMultiplier -*Overrides void* +▸ **protocolFeeMultiplier**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1583](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1583)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7171](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7171)* -**Parameters:** +**Returns:** *`ContractFunctionObj`* -Name | Type | Default | ------- | ------ | ------ | -`address` | string | - | -`supportedProvider` | [SupportedProvider](#supportedprovider) | - | -`txDefaults?` | `Partial` | - | -`logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | WETH9Contract.deployedBytecode | +___ -**Returns:** *[WETH9Contract](#class-weth9contract)* +### registerAssetProxy -## Properties +▸ **registerAssetProxy**(`assetProxy`: string): *`ContractTxFunctionObj`* -#### `Optional` _deployedBytecodeIfExists +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7223](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7223)* -• **_deployedBytecodeIfExists**? : *`Buffer`* +Registers an asset proxy to its asset proxy id. +Once an asset proxy is registered, it cannot be unregistered. +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`assetProxy` | string | Address of new asset proxy to register. | -Defined in base-contract/lib/src/index.d.ts:31 +**Returns:** *`ContractTxFunctionObj`* ___ -### abi - -• **abi**: *[ContractAbi](#contractabi)* - +### setProtocolFeeCollectorAddress +▸ **setProtocolFeeCollectorAddress**(`updatedProtocolFeeCollector`: string): *`ContractTxFunctionObj`* -Defined in base-contract/lib/src/index.d.ts:27 +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7342)* -___ +Allows the owner to update the protocolFeeCollector address. -### address +**Parameters:** -• **address**: *string* +Name | Type | Description | +------ | ------ | ------ | +`updatedProtocolFeeCollector` | string | The updated protocolFeeCollector contract address. | +**Returns:** *`ContractTxFunctionObj`* +___ -Defined in base-contract/lib/src/index.d.ts:28 +### setProtocolFeeMultiplier -___ +▸ **setProtocolFeeMultiplier**(`updatedProtocolFeeMultiplier`: `BigNumber`): *`ContractTxFunctionObj`* -Args +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7461](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7461)* -• **constructorArgs**: *any[]* +Allows the owner to update the protocol fee multiplier. +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`updatedProtocolFeeMultiplier` | `BigNumber` | The updated protocol fee multiplier. | -Defined in base-contract/lib/src/index.d.ts:30 +**Returns:** *`ContractTxFunctionObj`* ___ -### contractName +### setSignatureValidatorApproval -• **contractName**: *string* +▸ **setSignatureValidatorApproval**(`validatorAddress`: string, `approval`: boolean): *`ContractTxFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7581](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7581)* +Approves/unnapproves a Validator contract to verify signatures on signer's behalf +using the `Validator` signature type. -Defined in base-contract/lib/src/index.d.ts:29 +**Parameters:** -## Methods +Name | Type | Description | +------ | ------ | ------ | +`validatorAddress` | string | Address of Validator contract. | +`approval` | boolean | Approval or disapproval of Validator contract. | -### getLogsAsync +**Returns:** *`ContractTxFunctionObj`* -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1567](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1567)* +### simulateDispatchTransferFromCalls -Gets historical logs without creating a subscription +▸ **simulateDispatchTransferFromCalls**(`assetData`: string[], `fromAddresses`: string[], `toAddresses`: string[], `amounts`: `BigNumber`[]): *`ContractTxFunctionObj`* -**Type parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7712](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7712)* -▪ **ArgsType**: *[WETH9EventArgs](#weth9eventargs)* +This function may be used to simulate any amount of transfers As they would occur through the Exchange contract. Note that this function will always revert, even if all transfers are successful. However, it may be used with eth_call or with a try/catch pattern in order to simulate the results of the transfers. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`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}` | +`assetData` | string[] | Array of asset details, each encoded per the AssetProxy contract specification. | +`fromAddresses` | string[] | Array containing the `from` addresses that correspond with each transfer. | +`toAddresses` | string[] | Array containing the `to` addresses that correspond with each transfer. | +`amounts` | `BigNumber`[] | Array containing the amounts that correspond to each transfer. | -**Returns:** *`Promise>>`* +**Returns:** *`ContractTxFunctionObj`* -Array of logs that match the parameters +This function does not return a value. However, it will always revert with `Error("TRANSFERS_SUCCESSFUL")` if all of the transfers were successful. ___ ### subscribe -▸ **subscribe**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* +▸ **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/weth9.ts:1525](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1525)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8008](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8008)* -Subscribe to an event type emitted by the WETH9 contract. +Subscribe to an event type emitted by the Exchange contract. **Type parameters:** -▪ **ArgsType**: *[WETH9EventArgs](#weth9eventargs)* +▪ **ArgsType**: *[ExchangeEventArgs](#exchangeeventargs)* **Parameters:** Name | Type | Default | Description | ------ | ------ | ------ | ------ | -`eventName` | [WETH9Events](#enumeration-weth9events) | - | The WETH9 contract event you would like to subscribe to. | +`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) | @@ -15784,11 +4386,43 @@ Subscription token used later to unsubscribe ___ +### transactionsExecuted + +▸ **transactionsExecuted**(`index_0`: string): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7840](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7840)* + +**Parameters:** + +Name | Type | +------ | ------ | +`index_0` | string | + +**Returns:** *`ContractFunctionObj`* + +___ + +### transferOwnership + +▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:7890](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L7890)* + +**Parameters:** + +Name | Type | +------ | ------ | +`newOwner` | string | + +**Returns:** *`ContractTxFunctionObj`* + +___ + ### unsubscribe ▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1550](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1550)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8033](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8033)* Cancel a subscription @@ -15806,7 +4440,7 @@ ___ ▸ **unsubscribeAll**(): *void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1556](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1556)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:8039](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L8039)* Cancels all existing subscriptions @@ -15818,7 +4452,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1228](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1228)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:198](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L198)* **Returns:** *[ContractAbi](#contractabi)* @@ -15828,9 +4462,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1186](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1186)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:151](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L151)* **Parameters:** @@ -15841,16 +4475,17 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | +`chainId` | `BigNumber` | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `chainId`: `BigNumber`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1161](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1161)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:125](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L125)* **Parameters:** @@ -15860,8 +4495,9 @@ Name | Type | `supportedProvider` | [SupportedProvider](#supportedprovider) | `txDefaults` | `Partial` | `logDecodeDependencies` | object | +`chainId` | `BigNumber` | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ @@ -15871,7 +4507,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:41 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -15882,790 +4518,608 @@ Name | Type | **Returns:** *string* -## Object literals - -### allowance - -#### ▪ **allowance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1107](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1107)* - -#### callAsync - -▸ **callAsync**(`index_0`: string, `index_1`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1113](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1113)* - -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`* - -___ - -### approve - -#### ▪ **approve**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L120)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:163](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L163)* - -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:** +# Class: ForwarderContract -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`guy` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | -**Returns:** *`PromiseWithTransactionHash`* +## Constructors -A promise that resolves when the transaction is successful -#### callAsync -▸ **callAsync**(`guy`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +\+ **new ForwarderContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ForwarderContract](#class-forwardercontract)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:215](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L215)* +*Overrides void* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1147](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1147)* **Parameters:** Name | Type | Default | ------ | ------ | ------ | -`guy` | string | - | -`wad` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | - -**Returns:** *`Promise`* - -#### estimateGasAsync +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | ForwarderContract.deployedBytecode | -▸ **estimateGasAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +**Returns:** *[ForwarderContract](#class-forwardercontract)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:190](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L190)* +## Properties -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +### `Optional` _deployedBytecodeIfExists -**Parameters:** +• **_deployedBytecodeIfExists**? : *`Buffer`* -Name | Type | Description | ------- | ------ | ------ | -`guy` | string | - | -`wad` | `BigNumber` | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | -**Returns:** *`Promise`* -The hash of the transaction +Defined in base-contract/lib/src/index.d.ts:32 -#### getABIEncodedTransactionData +___ -▸ **getABIEncodedTransactionData**(`guy`: string, `wad`: `BigNumber`): *string* +### abi -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:264](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L264)* +• **abi**: *[ContractAbi](#contractabi)* -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` | +Defined in base-contract/lib/src/index.d.ts:28 -**Returns:** *string* +___ -The ABI encoded transaction data as a string +### address -#### getSelector +• **address**: *string* -▸ **getSelector**(): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:277](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L277)* -Returns the 4 byte function selector as a hex string. +Defined in base-contract/lib/src/index.d.ts:29 -**Returns:** *string* +___ -#### sendTransactionAsync +Args -▸ **sendTransactionAsync**(`guy`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +• **constructorArgs**: *any[]* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:127](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L127)* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. -**Parameters:** +Defined in base-contract/lib/src/index.d.ts:31 -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`guy` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +___ -**Returns:** *`Promise`* +### contractName -The hash of the transaction +• **contractName**: *string* -___ -### balanceOf -#### ▪ **balanceOf**: *object* +Defined in base-contract/lib/src/index.d.ts:30 -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:712](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L712)* +## Methods -#### callAsync +### approveMakerAssetProxy -▸ **callAsync**(`index_0`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **approveMakerAssetProxy**(`assetData`: string): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:718](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L718)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:449](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L449)* -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. +Approves the respective proxy for a given asset to transfer tokens on the Forwarder contract's behalf. +This is necessary because an order fee denominated in the maker asset (i.e. a percentage fee) is sent by the +Forwarder contract to the fee recipient. +This method needs to be called before forwarding orders of a maker asset that hasn't +previously been approved. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`index_0` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +`assetData` | string | Byte array encoded for the respective asset proxy. | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* ___ -### decimals - -#### ▪ **decimals**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:669](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L669)* +### getABIDecodedReturnData -#### callAsync +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:427](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L427)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:675](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L675)* +**Type parameters:** -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. +▪ **T** **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -**Returns:** *`Promise`* +**Returns:** *`T`* ___ -### deposit - -#### ▪ **deposit**: *object* +### getABIDecodedTransactionData -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:966](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L966)* +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -#### awaitTransactionSuccessAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:420](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L420)* -▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1005](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1005)* +**Type parameters:** -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. +▪ **T** **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -A promise that resolves when the transaction is successful +**Returns:** *`T`* -#### callAsync +___ -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### getFunctionSignature -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1051](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1051)* +▸ **getFunctionSignature**(`methodName`: string): *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:414](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L414)* **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | +------ | ------ | +`methodName` | string | -**Returns:** *`Promise`* +**Returns:** *string* -#### estimateGasAsync +___ -▸ **estimateGasAsync**(`txData?`: `Partial` | undefined): *`Promise`* +### getSelector -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1028](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1028)* +▸ **getSelector**(`methodName`: string): *string* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L434)* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* - -The hash of the transaction +Name | Type | +------ | ------ | +`methodName` | string | -#### getABIEncodedTransactionData +**Returns:** *string* -▸ **getABIEncodedTransactionData**(): *string* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1093](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1093)* +### marketBuyOrdersWithEth -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). +▸ **marketBuyOrdersWithEth**(`orders`: `Array`, `makerAssetBuyAmount`: `BigNumber`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`* -**Returns:** *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:571](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L571)* -The ABI encoded transaction data as a string +Attempt to buy makerAssetBuyAmount of makerAsset by selling ETH provided with transaction. +The Forwarder may *fill* more than makerAssetBuyAmount of the makerAsset so that it can +pay takerFees where takerFeeAssetData == makerAssetData (i.e. percentage fees). +Any ETH not spent will be refunded to sender. -#### getSelector +**Parameters:** -▸ **getSelector**(): *string* +Name | Type | Description | +------ | ------ | ------ | +`orders` | `Array` | Array of order specifications used containing desired makerAsset and WETH as takerAsset. | +`makerAssetBuyAmount` | `BigNumber` | Desired amount of makerAsset to purchase. | +`signatures` | string[] | Proofs that orders have been created by makers. | +`feePercentage` | `BigNumber` | Percentage of WETH sold that will payed as fee to forwarding contract feeRecipient. | +`feeRecipient` | string | Address that will receive ETH when orders are filled. | -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1101](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1101)* +**Returns:** *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`* -Returns the 4 byte function selector as a hex string. +wethSpentAmount Amount of WETH spent on the given set of orders.makerAssetAcquiredAmount Amount of maker asset acquired from the given set of orders.ethFeePaid Amount of ETH spent on the given forwarder fee. -**Returns:** *string* +___ -#### sendTransactionAsync +### marketSellOrdersWithEth -▸ **sendTransactionAsync**(`txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +▸ **marketSellOrdersWithEth**(`orders`: `Array`, `signatures`: string[], `feePercentage`: `BigNumber`, `feeRecipient`: string): *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:973](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L973)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:730](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L730)* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +Purchases as much of orders' makerAssets as possible by selling as much of the ETH value sent +as possible, accounting for order and forwarder fees. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | +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. | +`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:** *`Promise`* +**Returns:** *`ContractTxFunctionObj<[BigNumber, BigNumber, BigNumber]>`* -The hash of the transaction +wethSpentAmount Amount of WETH spent on the given set of orders.makerAssetAcquiredAmount Amount of maker asset acquired from the given set of orders.ethFeePaid Amount of ETH spent on the given forwarder fee. ___ -### name +### owner -#### ▪ **name**: *object* +▸ **owner**(): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:77](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L77)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:876](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L876)* -#### callAsync +**Returns:** *`ContractFunctionObj`* + +___ -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### transferOwnership -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:83](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L83)* +▸ **transferOwnership**(`newOwner`: string): *`ContractTxFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:923](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L923)* **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | +------ | ------ | +`newOwner` | string | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* ___ -### symbol - -#### ▪ **symbol**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:760](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L760)* - -#### callAsync +### withdrawAsset -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +▸ **withdrawAsset**(`assetData`: string, `amount`: `BigNumber`): *`ContractTxFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:766](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L766)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:1038](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L1038)* -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. +Withdraws assets from this contract. The contract formerly required a ZRX balance in order +to function optimally, and this function allows the ZRX to be withdrawn by owner. +It may also be used to withdraw assets that were accidentally sent to this contract. **Parameters:** -Name | Type | Default | +Name | Type | Description | ------ | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +`assetData` | string | Byte array encoded for the respective asset proxy. | +`amount` | `BigNumber` | Amount of ERC20 token to withdraw. | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* ___ -### totalSupply - -#### ▪ **totalSupply**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:283](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L283)* +### `Static` ABI -#### callAsync +▸ **ABI**(): *[ContractAbi](#contractabi)* -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:127](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L127)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:289](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L289)* +**Returns:** *[ContractAbi](#contractabi)* -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. +The contract ABI -**Parameters:** +___ -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +### `Static` deployAsync -**Returns:** *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_wethAssetData`: string): *`Promise`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L79)* -### transfer +**Parameters:** -#### ▪ **transfer**: *object* +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_wethAssetData` | string | -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:803](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L803)* +**Returns:** *`Promise`* -#### awaitTransactionSuccessAsync +___ -▸ **awaitTransactionSuccessAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +### `Static` deployFrom0xArtifactAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:846](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L846)* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_wethAssetData`: string): *`Promise`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/forwarder.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/forwarder.ts#L44)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`dst` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* - -A promise that resolves when the transaction is successful +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_wethAssetData` | string | -#### callAsync +**Returns:** *`Promise`* -▸ **callAsync**(`dst`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:898](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L898)* +### `Static` strictArgumentEncodingCheck -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. +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -**Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`dst` | string | - | -`wad` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | -**Returns:** *`Promise`* +Defined in base-contract/lib/src/index.d.ts:42 -#### estimateGasAsync +**Parameters:** -▸ **estimateGasAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:873](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L873)* +**Returns:** *string* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +
-**Parameters:** +# Class: IValidatorContract -Name | Type | Description | ------- | ------ | ------ | -`dst` | string | - | -`wad` | `BigNumber` | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | -**Returns:** *`Promise`* +## Constructors -The hash of the transaction -#### getABIEncodedTransactionData -▸ **getABIEncodedTransactionData**(`dst`: string, `wad`: `BigNumber`): *string* +\+ **new IValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IValidatorContract](#class-ivalidatorcontract)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:947](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L947)* +*Overrides void* -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). +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:234](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L234)* **Parameters:** -Name | Type | ------- | ------ | -`dst` | string | -`wad` | `BigNumber` | - -**Returns:** *string* - -The ABI encoded transaction data as a string +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | IValidatorContract.deployedBytecode | -#### getSelector +**Returns:** *[IValidatorContract](#class-ivalidatorcontract)* -▸ **getSelector**(): *string* +## Properties -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:960](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L960)* +### `Optional` _deployedBytecodeIfExists -Returns the 4 byte function selector as a hex string. +• **_deployedBytecodeIfExists**? : *`Buffer`* -**Returns:** *string* -#### sendTransactionAsync -▸ **sendTransactionAsync**(`dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +Defined in base-contract/lib/src/index.d.ts:32 -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:810](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L810)* +___ -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +### abi -**Parameters:** +• **abi**: *[ContractAbi](#contractabi)* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`dst` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | -**Returns:** *`Promise`* -The hash of the transaction +Defined in base-contract/lib/src/index.d.ts:28 ___ -### transferFrom +### address + +• **address**: *string* -#### ▪ **transferFrom**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:326](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L326)* -#### awaitTransactionSuccessAsync +Defined in base-contract/lib/src/index.d.ts:29 -▸ **awaitTransactionSuccessAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:375](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L375)* +Args -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. +• **constructorArgs**: *any[]* -**Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`src` | string | - | - | -`dst` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | -**Returns:** *`PromiseWithTransactionHash`* +Defined in base-contract/lib/src/index.d.ts:31 -A promise that resolves when the transaction is successful +___ -#### callAsync +### contractName -▸ **callAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +• **contractName**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:445](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L445)* -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:** +Defined in base-contract/lib/src/index.d.ts:30 -Name | Type | Default | ------- | ------ | ------ | -`src` | string | - | -`dst` | string | - | -`wad` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +## Methods -**Returns:** *`Promise`* +### getABIDecodedReturnData -#### estimateGasAsync +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -▸ **estimateGasAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:157](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L157)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:410](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L410)* +**Type parameters:** -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +▪ **T** **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`src` | string | - | -`dst` | string | - | -`wad` | `BigNumber` | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -**Returns:** *`Promise`* +**Returns:** *`T`* + +___ -The hash of the transaction +### getABIDecodedTransactionData -#### getABIEncodedTransactionData +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -▸ **getABIEncodedTransactionData**(`src`: string, `dst`: string, `wad`: `BigNumber`): *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:150](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L150)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:500](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L500)* +**Type parameters:** -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). +▪ **T** **Parameters:** Name | Type | ------ | ------ | -`src` | string | -`dst` | string | -`wad` | `BigNumber` | +`methodName` | string | +`callData` | string | -**Returns:** *string* +**Returns:** *`T`* -The ABI encoded transaction data as a string +___ + +### getFunctionSignature -#### getSelector +▸ **getFunctionSignature**(`methodName`: string): *string* -▸ **getSelector**(): *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:144](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L144)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:515](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L515)* +**Parameters:** -Returns the 4 byte function selector as a hex string. +Name | Type | +------ | ------ | +`methodName` | string | **Returns:** *string* -#### sendTransactionAsync +___ -▸ **sendTransactionAsync**(`src`: string, `dst`: string, `wad`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +### getSelector -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:333](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L333)* +▸ **getSelector**(`methodName`: string): *string* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:164](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L164)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`src` | string | - | - | -`dst` | string | - | - | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`methodName` | string | -The hash of the transaction +**Returns:** *string* ___ -### withdraw - -#### ▪ **withdraw**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:521](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L521)* - -#### awaitTransactionSuccessAsync +### isValidSignature -▸ **awaitTransactionSuccessAsync**(`wad`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +▸ **isValidSignature**(`hash`: string, `signerAddress`: string, `signature`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:562](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L562)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:178](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L178)* -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. +Verifies that a signature is valid. **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* +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. | -A promise that resolves when the transaction is successful +**Returns:** *`ContractFunctionObj`* -#### callAsync +Magic bytes4 value if the signature is valid. Magic value is bytes4(keccak256("isValidValidatorSignature(address,bytes32,address,bytes)")) -▸ **callAsync**(`wad`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:611](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L611)* +### `Static` ABI -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. +▸ **ABI**(): *[ContractAbi](#contractabi)* -**Parameters:** +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L111)* -Name | Type | Default | ------- | ------ | ------ | -`wad` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +**Returns:** *[ContractAbi](#contractabi)* -**Returns:** *`Promise`* +The contract ABI -#### estimateGasAsync +___ -▸ **estimateGasAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +### `Static` deployAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:587](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L587)* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L69)* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`wad` | `BigNumber` | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -The hash of the transaction +**Returns:** *`Promise`* -#### getABIEncodedTransactionData +___ -▸ **getABIEncodedTransactionData**(`wad`: `BigNumber`): *string* +### `Static` deployFrom0xArtifactAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:654](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L654)* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -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). +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_validator.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_validator.ts#L44)* **Parameters:** Name | Type | ------ | ------ | -`wad` | `BigNumber` | - -**Returns:** *string* - -The ABI encoded transaction data as a string - -#### getSelector - -▸ **getSelector**(): *string* +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:663](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L663)* +**Returns:** *`Promise`* -Returns the 4 byte function selector as a hex string. +___ -**Returns:** *string* +### `Static` strictArgumentEncodingCheck -#### sendTransactionAsync +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -▸ **sendTransactionAsync**(`wad`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:528](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L528)* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`wad` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -The hash of the transaction +**Returns:** *string*
-# Class: ZRXTokenContract +# Class: IWalletContract ## Constructors -\+ **new ZRXTokenContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[ZRXTokenContract](#class-zrxtokencontract)* +\+ **new IWalletContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[IWalletContract](#class-iwalletcontract)* *Overrides void* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1241](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1241)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:224](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L224)* **Parameters:** @@ -16675,19 +5129,19 @@ Name | Type | Default | `supportedProvider` | [SupportedProvider](#supportedprovider) | - | `txDefaults?` | `Partial` | - | `logDecodeDependencies?` | undefined \| object | - | -`deployedBytecode` | string \| undefined | ZRXTokenContract.deployedBytecode | +`deployedBytecode` | string \| undefined | IWalletContract.deployedBytecode | -**Returns:** *[ZRXTokenContract](#class-zrxtokencontract)* +**Returns:** *[IWalletContract](#class-iwalletcontract)* ## Properties -#### `Optional` _deployedBytecodeIfExists +### `Optional` _deployedBytecodeIfExists • **_deployedBytecodeIfExists**? : *`Buffer`* -Defined in base-contract/lib/src/index.d.ts:31 +Defined in base-contract/lib/src/index.d.ts:32 ___ @@ -16697,7 +5151,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:27 +Defined in base-contract/lib/src/index.d.ts:28 ___ @@ -16707,7 +5161,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:28 +Defined in base-contract/lib/src/index.d.ts:29 ___ @@ -16717,7 +5171,7 @@ Args -Defined in base-contract/lib/src/index.d.ts:30 +Defined in base-contract/lib/src/index.d.ts:31 ___ @@ -16727,91 +5181,102 @@ ___ -Defined in base-contract/lib/src/index.d.ts:29 +Defined in base-contract/lib/src/index.d.ts:30 ## Methods -### getLogsAsync - -▸ **getLogsAsync**<**ArgsType**>(`eventName`: [ZRXTokenEvents](#enumeration-zrxtokenevents), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* +### getABIDecodedReturnData -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1225](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1225)* +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -Gets historical logs without creating a subscription +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L153)* **Type parameters:** -▪ **ArgsType**: *[ZRXTokenEventArgs](#zrxtokeneventargs)* +▪ **T** **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>>`* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -Array of logs that match the parameters +**Returns:** *`T`* ___ -### subscribe - -▸ **subscribe**<**ArgsType**>(`eventName`: [ZRXTokenEvents](#enumeration-zrxtokenevents), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* +### getABIDecodedTransactionData -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1183](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1183)* +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -Subscribe to an event type emitted by the ZRXToken contract. +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:146](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L146)* **Type parameters:** -▪ **ArgsType**: *[ZRXTokenEventArgs](#zrxtokeneventargs)* +▪ **T** **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* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -Subscription token used later to unsubscribe +**Returns:** *`T`* ___ -### unsubscribe +### getFunctionSignature -▸ **unsubscribe**(`subscriptionToken`: string): *void* +▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1208](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1208)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:140](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L140)* -Cancel a subscription +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | + +**Returns:** *string* + +___ + +### getSelector + +▸ **getSelector**(`methodName`: string): *string* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:160](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L160)* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`subscriptionToken` | string | Subscription token returned by `subscribe()` | +Name | Type | +------ | ------ | +`methodName` | string | -**Returns:** *void* +**Returns:** *string* ___ -### unsubscribeAll +### isValidSignature -▸ **unsubscribeAll**(): *void* +▸ **isValidSignature**(`hash`: string, `signature`: string): *`ContractFunctionObj`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:1214](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L1214)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:173](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L173)* -Cancels all existing subscriptions +Validates a hash with the `Wallet` signature type. -**Returns:** *void* +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Message hash that is signed. | +`signature` | string | Proof of signing. | + +**Returns:** *`ContractFunctionObj`* + +magicValue `bytes4(0xb0671381)` if the signature check succeeds. ___ @@ -16819,7 +5284,7 @@ ___ ▸ **ABI**(): *[ContractAbi](#contractabi)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:955](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L955)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L111)* **Returns:** *[ContractAbi](#contractabi)* @@ -16829,9 +5294,9 @@ ___ ### `Static` deployAsync -▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **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:913](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L913)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L69)* **Parameters:** @@ -16843,15 +5308,15 @@ Name | Type | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ ### `Static` deployFrom0xArtifactAsync -▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:888](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L888)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/i_wallet.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/i_wallet.ts#L44)* **Parameters:** @@ -16862,7 +5327,7 @@ Name | Type | `txDefaults` | `Partial` | `logDecodeDependencies` | object | -**Returns:** *`Promise`* +**Returns:** *`Promise`* ___ @@ -16872,7 +5337,7 @@ ___ -Defined in base-contract/lib/src/index.d.ts:41 +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** @@ -16883,1116 +5348,944 @@ Name | Type | **Returns:** *string* -## Object literals - -### allowance - -#### ▪ **allowance**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:834](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L834)* - -#### callAsync - -▸ **callAsync**(`_owner`: string, `_spender`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:840](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L840)* - -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`* - -___ - -### approve - -#### ▪ **approve**: *object* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L104)* - -#### awaitTransactionSuccessAsync - -▸ **awaitTransactionSuccessAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:150](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L150)* - -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:** +# Class: OrderValidatorContract -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_spender` | string | - | - | -`_value` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | -**Returns:** *`PromiseWithTransactionHash`* +## Constructors -A promise that resolves when the transaction is successful -#### callAsync -▸ **callAsync**(`_spender`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +\+ **new OrderValidatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[OrderValidatorContract](#class-ordervalidatorcontract)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:209](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L209)* +*Overrides void* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1338](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1338)* **Parameters:** Name | Type | Default | ------ | ------ | ------ | -`_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:177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L177)* - -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 - -#### getABIEncodedTransactionData - -▸ **getABIEncodedTransactionData**(`_spender`: string, `_value`: `BigNumber`): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:261](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L261)* - -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 - -#### getSelector - -▸ **getSelector**(): *string* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:274](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L274)* - -Returns the 4 byte function selector as a hex string. - -**Returns:** *string* - -#### sendTransactionAsync +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | OrderValidatorContract.deployedBytecode | -▸ **sendTransactionAsync**(`_spender`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +**Returns:** *[OrderValidatorContract](#class-ordervalidatorcontract)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:111](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L111)* +## Properties -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +### `Optional` _deployedBytecodeIfExists -**Parameters:** +• **_deployedBytecodeIfExists**? : *`Buffer`* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_spender` | string | - | - | -`_value` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | -**Returns:** *`Promise`* -The hash of the transaction +Defined in base-contract/lib/src/index.d.ts:32 ___ -### balanceOf +### abi + +• **abi**: *[ContractAbi](#contractabi)* -#### ▪ **balanceOf**: *object* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:580](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L580)* -#### callAsync +Defined in base-contract/lib/src/index.d.ts:28 -▸ **callAsync**(`_owner`: string, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +___ -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:586](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L586)* +### address -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. +• **address**: *string* -**Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`_owner` | string | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | -**Returns:** *`Promise`* +Defined in base-contract/lib/src/index.d.ts:29 ___ -### decimals - -#### ▪ **decimals**: *object* +Args -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:537](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L537)* +• **constructorArgs**: *any[]* -#### callAsync -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:543](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L543)* +Defined in base-contract/lib/src/index.d.ts:31 -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:** +### contractName -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +• **contractName**: *string* -**Returns:** *`Promise`* -___ -### name +Defined in base-contract/lib/src/index.d.ts:30 -#### ▪ **name**: *object* +## Methods -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L61)* +### getABIDecodedReturnData -#### callAsync +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:703](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L703)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:67](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L67)* +**Type parameters:** -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. +▪ **T** **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -**Returns:** *`Promise`* +**Returns:** *`T`* ___ -### symbol - -#### ▪ **symbol**: *object* +### getABIDecodedTransactionData -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:628](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L628)* +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:696](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L696)* -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:634](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L634)* +**Type parameters:** -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. +▪ **T** **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -**Returns:** *`Promise`* +**Returns:** *`T`* ___ -### totalSupply - -#### ▪ **totalSupply**: *object* +### getBalanceAndAllowance -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:280](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L280)* +▸ **getBalanceAndAllowance**(`target`: string, `assetData`: string): *`ContractFunctionObj<[BigNumber, BigNumber]>`* -#### callAsync +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:835](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L835)* -▸ **callAsync**(`callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +**Parameters:** -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:286](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L286)* +Name | Type | +------ | ------ | +`target` | string | +`assetData` | string | -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. +**Returns:** *`ContractFunctionObj<[BigNumber, BigNumber]>`* -**Parameters:** +___ -Name | Type | Default | ------- | ------ | ------ | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +### getBalancesAndAllowances -**Returns:** *`Promise`* +▸ **getBalancesAndAllowances**(`target`: string, `assetData`: string[]): *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1175](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1175)* -### transfer +**Parameters:** -#### ▪ **transfer**: *object* +Name | Type | +------ | ------ | +`target` | string | +`assetData` | string[] | -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:671](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L671)* +**Returns:** *`ContractFunctionObj<[BigNumber[], BigNumber[]]>`* -#### awaitTransactionSuccessAsync +___ -▸ **awaitTransactionSuccessAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +### getERC721TokenOwner -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:714](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L714)* +▸ **getERC721TokenOwner**(`token`: string, `tokenId`: `BigNumber`): *`ContractFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1120)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | - | -`_value` | `BigNumber` | - | - | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | - -**Returns:** *`PromiseWithTransactionHash`* +Name | Type | +------ | ------ | +`token` | string | +`tokenId` | `BigNumber` | -A promise that resolves when the transaction is successful +**Returns:** *`ContractFunctionObj`* -#### callAsync +___ -▸ **callAsync**(`_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### getFunctionSignature -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:766](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L766)* +▸ **getFunctionSignature**(`methodName`: string): *string* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L690)* **Parameters:** -Name | Type | Default | ------- | ------ | ------ | -`_to` | string | - | -`_value` | `BigNumber` | - | -`callData` | `Partial` | {} | -`defaultBlock?` | [BlockParam](#blockparam) | - | +Name | Type | +------ | ------ | +`methodName` | string | -**Returns:** *`Promise`* +**Returns:** *string* -#### estimateGasAsync +___ -▸ **estimateGasAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +### getOrderAndTraderInfo -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:741](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L741)* +▸ **getOrderAndTraderInfo**(`order`: object, `takerAddress`: string): *`ContractFunctionObj<[object, object]>`* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:717](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L717)* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`_to` | string | - | -`_value` | `BigNumber` | - | -`txData?` | `Partial` \| undefined | Additional data for transaction | - -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`order` | object | +`takerAddress` | string | -The hash of the transaction +**Returns:** *`ContractFunctionObj<[object, object]>`* -#### getABIEncodedTransactionData +___ -▸ **getABIEncodedTransactionData**(`_to`: string, `_value`: `BigNumber`): *string* +### getOrdersAndTradersInfo -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:815](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L815)* +▸ **getOrdersAndTradersInfo**(`orders`: `Array`, `takerAddresses`: string[]): *`ContractFunctionObj<[Array, Array]>`* -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). +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:893](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L893)* **Parameters:** Name | Type | ------ | ------ | -`_to` | string | -`_value` | `BigNumber` | +`orders` | `Array` | +`takerAddresses` | string[] | -**Returns:** *string* +**Returns:** *`ContractFunctionObj<[Array, Array]>`* -The ABI encoded transaction data as a string +___ + +### getSelector -#### getSelector +▸ **getSelector**(`methodName`: string): *string* -▸ **getSelector**(): *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:710](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L710)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:828](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L828)* +**Parameters:** -Returns the 4 byte function selector as a hex string. +Name | Type | +------ | ------ | +`methodName` | string | **Returns:** *string* -#### sendTransactionAsync +___ -▸ **sendTransactionAsync**(`_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +### getTraderInfo -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:678](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L678)* +▸ **getTraderInfo**(`order`: object, `takerAddress`: string): *`ContractFunctionObj`* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1236](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1236)* **Parameters:** -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_to` | string | - | - | -`_value` | `BigNumber` | - | - | -`txData?` | `Partial` \| undefined | - | Additional data for transaction | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`order` | object | +`takerAddress` | string | -The hash of the transaction +**Returns:** *`ContractFunctionObj`* ___ -### transferFrom +### getTradersInfo -#### ▪ **transferFrom**: *object* +▸ **getTradersInfo**(`orders`: `Array`, `takerAddresses`: string[]): *`ContractFunctionObj>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:326](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L326)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:1011](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L1011)* -ERC20 transferFrom, modified such that an allowance of MAX_UINT represents an unlimited allowance. +**Parameters:** -#### awaitTransactionSuccessAsync +Name | Type | +------ | ------ | +`orders` | `Array` | +`takerAddresses` | string[] | -▸ **awaitTransactionSuccessAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial`, `opts`: `AwaitTransactionSuccessOpts`): *`PromiseWithTransactionHash`* +**Returns:** *`ContractFunctionObj>`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:381](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L381)* +___ -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. +### `Static` ABI -**Parameters:** +▸ **ABI**(): *[ContractAbi](#contractabi)* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`_from` | string | - | Address to transfer from. | -`_to` | string | - | Address to transfer to. | -`_value` | `BigNumber` | - | Amount to transfer. | -`txData?` | `Partial` | - | Additional data for transaction | -`opts` | `AwaitTransactionSuccessOpts` | { shouldValidate: true } | - | +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:127](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L127)* -**Returns:** *`PromiseWithTransactionHash`* +**Returns:** *[ContractAbi](#contractabi)* -A promise that resolves when the transaction is successful +The contract ABI -#### callAsync +___ -▸ **callAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `callData`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* +### `Static` deployAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:458](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L458)* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L79)* **Parameters:** -Name | Type | 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`* +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_zrxAssetData` | string | -Success of transfer. +**Returns:** *`Promise`* -#### estimateGasAsync +___ -▸ **estimateGasAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined): *`Promise`* +### `Static` deployFrom0xArtifactAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:419](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L419)* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `_exchange`: string, `_zrxAssetData`: string): *`Promise`* -Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments. +*Defined in [abi-gen-wrappers/src/generated-wrappers/order_validator.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/order_validator.ts#L44)* **Parameters:** -Name | Type | 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 | +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`_exchange` | string | +`_zrxAssetData` | string | -**Returns:** *`Promise`* +**Returns:** *`Promise`* + +___ -The hash of the transaction +### `Static` strictArgumentEncodingCheck -#### getABIEncodedTransactionData +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -▸ **getABIEncodedTransactionData**(`_from`: string, `_to`: string, `_value`: `BigNumber`): *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:516](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L516)* -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). +Defined in base-contract/lib/src/index.d.ts:42 **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`_from` | string | Address to transfer from. | -`_to` | string | Address to transfer to. | -`_value` | `BigNumber` | Amount to transfer. | +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | **Returns:** *string* -The ABI encoded transaction data as a string - -#### getSelector +
-▸ **getSelector**(): *string* +# Class: WETH9Contract -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:531](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L531)* -Returns the 4 byte function selector as a hex string. +## Constructors -**Returns:** *string* -#### sendTransactionAsync -▸ **sendTransactionAsync**(`_from`: string, `_to`: string, `_value`: `BigNumber`, `txData?`: `Partial` | undefined, `opts`: `SendTransactionOpts`): *`Promise`* +\+ **new WETH9Contract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[WETH9Contract](#class-weth9contract)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L336)* +*Overrides void* -Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write -Ethereum operation and will cost gas. +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1381](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1381)* **Parameters:** -Name | Type | Default | 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 | -`opts` | `SendTransactionOpts` | { shouldValidate: true } | - | - -**Returns:** *`Promise`* - -The hash of the transaction +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | WETH9Contract.deployedBytecode | -
+**Returns:** *[WETH9Contract](#class-weth9contract)* -# Class: ContractWrappers +## Properties -The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol. +### `Optional` _deployedBytecodeIfExists +• **_deployedBytecodeIfExists**? : *`Buffer`* -## Constructors +Defined in base-contract/lib/src/index.d.ts:32 -\+ **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/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L84)* +### abi -Instantiates a new ContractWrappers instance. +• **abi**: *[ContractAbi](#contractabi)* -**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)* +Defined in base-contract/lib/src/index.d.ts:28 -An instance of the ContractWrappers class. +___ -## Properties +### address -#### contractAddresses +• **address**: *string* -• **contractAddresses**: *`ContractAddresses`* -*Defined in [contract-wrappers/src/contract_wrappers.ts:43](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L43)* -An index of the default contract addresses for this chain. +Defined in base-contract/lib/src/index.d.ts:29 ___ -### coordinator +Args + +• **constructorArgs**: *any[]* -• **coordinator**: *[CoordinatorWrapper](#class-coordinatorwrapper)* -*Defined in [contract-wrappers/src/contract_wrappers.ts:82](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L82)* -An instance of the CoordinatorWrapper class containing methods for interacting with the Coordinator extension contract. +Defined in base-contract/lib/src/index.d.ts:31 ___ -### devUtils +### contractName -• **devUtils**: *`DevUtilsContract`* +• **contractName**: *string* -*Defined in [contract-wrappers/src/contract_wrappers.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L78)* -An instance of the DevUtilsContract class containing methods for interacting with the DevUtils smart contract. -___ +Defined in base-contract/lib/src/index.d.ts:30 -### dutchAuction +## Methods -• **dutchAuction**: *`DutchAuctionContract`* +### allowance + +▸ **allowance**(`index_0`: string, `index_1`: string): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1258](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1258)* + +**Parameters:** -*Defined in [contract-wrappers/src/contract_wrappers.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L74)* +Name | Type | +------ | ------ | +`index_0` | string | +`index_1` | string | -An instance of the DutchAuctionContract class containing methods for interacting with any DutchAuction smart contract. +**Returns:** *`ContractFunctionObj`* ___ -### erc20Proxy +### approve + +▸ **approve**(`guy`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj`* -• **erc20Proxy**: *`ERC20ProxyContract`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:512](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L512)* + +**Parameters:** -*Defined in [contract-wrappers/src/contract_wrappers.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L52)* +Name | Type | +------ | ------ | +`guy` | string | +`wad` | `BigNumber` | -An instance of the ERC20ProxyContract class containing methods for interacting with the -erc20Proxy smart contract. +**Returns:** *`ContractTxFunctionObj`* ___ -### erc721Proxy +### balanceOf + +▸ **balanceOf**(`index_0`: string): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:946](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L946)* -• **erc721Proxy**: *`ERC721ProxyContract`* +**Parameters:** -*Defined in [contract-wrappers/src/contract_wrappers.ts:57](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L57)* +Name | Type | +------ | ------ | +`index_0` | string | -An instance of the ERC721ProxyContract class containing methods for interacting with the -erc721Proxy smart contract. +**Returns:** *`ContractFunctionObj`* ___ -### exchange +### decimals -• **exchange**: *`ExchangeContract`* +▸ **decimals**(): *`ContractFunctionObj`* -*Defined in [contract-wrappers/src/contract_wrappers.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L47)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:899](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L899)* -An instance of the ExchangeContract class containing methods for interacting with the 0x Exchange smart contract. +**Returns:** *`ContractFunctionObj`* ___ -### forwarder +### deposit -• **forwarder**: *`ForwarderContract`* +▸ **deposit**(): *`ContractTxFunctionObj`* -*Defined in [contract-wrappers/src/contract_wrappers.ts:66](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L66)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1153)* -An instance of the ForwarderContract class containing methods for interacting with any Forwarder smart contract. +**Returns:** *`ContractTxFunctionObj`* ___ -### orderValidator +### getABIDecodedReturnData -• **orderValidator**: *`OrderValidatorContract`* +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [contract-wrappers/src/contract_wrappers.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L70)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:451](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L451)* -An instance of the OrderValidatorContract class containing methods for interacting with any OrderValidator smart contract. +**Type parameters:** -___ +▪ **T** -### weth9 +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -• **weth9**: *`WETH9Contract`* +**Returns:** *`T`* -*Defined in [contract-wrappers/src/contract_wrappers.ts:62](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L62)* +___ -An instance of the WETH9Contract class containing methods for interacting with the -WETH9 smart contract. +### getABIDecodedTransactionData -## Methods +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -### getAbiDecoder +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:444](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L444)* -▸ **getAbiDecoder**(): *`AbiDecoder`* +**Type parameters:** -*Defined in [contract-wrappers/src/contract_wrappers.ts:155](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L155)* +▪ **T** -Get the abi decoder instance currently used by contract-wrappers +**Parameters:** -**Returns:** *`AbiDecoder`* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -AbiDecoder instance +**Returns:** *`T`* ___ -### getProvider +### getFunctionSignature -▸ **getProvider**(): *[SupportedProvider](#supportedprovider)* +▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [contract-wrappers/src/contract_wrappers.ts:148](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L148)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:438](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L438)* -Get the provider instance currently used by contract-wrappers +**Parameters:** -**Returns:** *[SupportedProvider](#supportedprovider)* +Name | Type | +------ | ------ | +`methodName` | string | -Web3 provider instance +**Returns:** *string* ___ -### unsubscribeAll - -▸ **unsubscribeAll**(): *void* +### getLogsAsync -*Defined in [contract-wrappers/src/contract_wrappers.ts:138](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/contract_wrappers.ts#L138)* +▸ **getLogsAsync**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `blockRange`: `BlockRange`, `indexFilterValues`: `IndexedFilterValues`): *`Promise>>`* -Unsubscribes from all subscriptions for all contracts. +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1365](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1365)* -**Returns:** *void* +Gets historical logs without creating a subscription -
+**Type parameters:** -# Class: CoordinatorWrapper +▪ **ArgsType**: *[WETH9EventArgs](#weth9eventargs)* -This class includes all the functionality related to filling or cancelling orders through -the 0x V2 Coordinator extension contract. +**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}` | -## Constructors +**Returns:** *`Promise>>`* +Array of logs that match the parameters +___ -\+ **new CoordinatorWrapper**(`provider`: [SupportedProvider](#supportedprovider), `chainId`: number, `address?`: undefined | string, `exchangeAddress?`: undefined | string, `registryAddress?`: undefined | string): *[CoordinatorWrapper](#class-coordinatorwrapper)* +### getSelector -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:43](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L43)* +▸ **getSelector**(`methodName`: string): *string* -Instantiate CoordinatorWrapper +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L458)* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`provider` | [SupportedProvider](#supportedprovider) | - | -`chainId` | number | Desired chainId. | -`address?` | undefined \| string | The address of the Coordinator contract. If undefined, will default to the known address corresponding to the chainId. | -`exchangeAddress?` | undefined \| string | The address of the Exchange contract. If undefined, will default to the known address corresponding to the chainId. | -`registryAddress?` | undefined \| string | The address of the CoordinatorRegistry contract. If undefined, will default to the known address corresponding to the chainId. | +Name | Type | +------ | ------ | +`methodName` | string | -**Returns:** *[CoordinatorWrapper](#class-coordinatorwrapper)* +**Returns:** *string* -## Properties +___ -### abi +### name -• **abi**: *[ContractAbi](#contractabi)* = Coordinator.compilerOutput.abi +▸ **name**(): *`ContractFunctionObj`* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:465](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L465)* + +**Returns:** *`ContractFunctionObj`* ___ -### address +### subscribe -• **address**: *string* +▸ **subscribe**<**ArgsType**>(`eventName`: [WETH9Events](#enumeration-weth9events), `indexFilterValues`: `IndexedFilterValues`, `callback`: [EventCallback](#eventcallback)‹*`ArgsType`*›, `isVerbose`: boolean, `blockPollingIntervalMs?`: undefined | number): *string* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:36](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L36)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1323](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1323)* -___ +Subscribe to an event type emitted by the WETH9 contract. -### chainId +**Type parameters:** -• **chainId**: *number* +▪ **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* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L35)* +Subscription token used later to unsubscribe ___ -### exchangeAddress +### symbol + +▸ **symbol**(): *`ContractFunctionObj`* -• **exchangeAddress**: *string* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:996](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L996)* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L37)* +**Returns:** *`ContractFunctionObj`* ___ -### registryAddress +### totalSupply -• **registryAddress**: *string* +▸ **totalSupply**(): *`ContractFunctionObj`* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:38](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L38)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:622](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L622)* -## Methods +**Returns:** *`ContractFunctionObj`* -### assertValidCoordinatorApprovalsOrThrowAsync +___ -▸ **assertValidCoordinatorApprovalsOrThrowAsync**(`transaction`: `ZeroExTransaction`, `txOrigin`: string, `transactionSignature`: string, `approvalExpirationTimeSeconds`: `BigNumber`[], `approvalSignatures`: string[]): *`Promise`* +### transfer -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:529](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L529)* +▸ **transfer**(`dst`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj`* -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. +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1043](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1043)* **Parameters:** -Name | Type | 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. | +Name | Type | +------ | ------ | +`dst` | string | +`wad` | `BigNumber` | -**Returns:** *`Promise`* +**Returns:** *`ContractTxFunctionObj`* ___ -### batchFillOrKillOrdersAsync - -▸ **batchFillOrKillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +### transferFrom -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:241](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L241)* +▸ **transferFrom**(`src`: string, `dst`: string, `wad`: `BigNumber`): *`ContractTxFunctionObj`* -Batch version of fillOrKillOrderAsync. Executes multiple fills atomically in a single transaction. +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:669](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L669)* **Parameters:** -Name | Type | 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`* +Name | Type | +------ | ------ | +`src` | string | +`dst` | string | +`wad` | `BigNumber` | -Transaction hash. +**Returns:** *`ContractTxFunctionObj`* ___ -### batchFillOrdersAsync +### unsubscribe -▸ **batchFillOrdersAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +▸ **unsubscribe**(`subscriptionToken`: string): *void* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:171](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L171)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1348](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1348)* -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. +Cancel a subscription **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`* +Name | Type | Description | +------ | ------ | ------ | +`subscriptionToken` | string | Subscription token returned by `subscribe()` | -Transaction hash. +**Returns:** *void* ___ -### batchFillOrdersNoThrowAsync +### unsubscribeAll -▸ **batchFillOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmounts`: `BigNumber`[], `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +▸ **unsubscribeAll**(): *void* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:206](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L206)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:1354](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L1354)* -No throw version of batchFillOrdersAsync +Cancels all existing subscriptions -**Parameters:** +**Returns:** *void* -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`* +### withdraw -Transaction hash. +▸ **withdraw**(`wad`: `BigNumber`): *`ContractTxFunctionObj`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:793](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L793)* -### batchHardCancelOrdersAsync +**Parameters:** + +Name | Type | +------ | ------ | +`wad` | `BigNumber` | -▸ **batchHardCancelOrdersAsync**(`orders`: `SignedOrder`[], `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +**Returns:** *`ContractTxFunctionObj`* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:460](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L460)* +___ -Batch version of hardCancelOrderAsync. Cancels orders on-chain by submitting an Ethereum transaction. -Executes multiple cancels atomically in a single transaction. +### `Static` ABI -**Parameters:** +▸ **ABI**(): *[ContractAbi](#contractabi)* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`orders` | `SignedOrder`[] | - | An array of orders to cancel. | -`orderTransactionOpts` | [OrderTransactionOpts](#interface-ordertransactionopts) | { shouldValidate: true } | Optional arguments this method accepts. | +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:149](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L149)* -**Returns:** *`Promise`* +**Returns:** *[ContractAbi](#contractabi)* -Transaction hash. +The contract ABI ___ -### batchSoftCancelOrdersAsync - -▸ **batchSoftCancelOrdersAsync**(`orders`: `SignedOrder`[]): *`Promise`* +### `Static` deployAsync -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:374](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L374)* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -Batch version of softCancelOrderAsync. Requests multiple soft cancels +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:107](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L107)* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`orders` | `SignedOrder`[] | An array of orders to cancel. | - -**Returns:** *`Promise`* +Name | Type | +------ | ------ | +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -CoordinatorServerCancellationResponse. See [Cancellation Response](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#response). +**Returns:** *`Promise`* ___ -### fillOrKillOrderAsync - -▸ **fillOrKillOrderAsync**(`signedOrder`: `SignedOrder`, `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +### `Static` deployFrom0xArtifactAsync -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:134](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L134)* +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object): *`Promise`* -Attempts to fill a specific amount of an order. If the entire amount specified cannot be filled, -the fill order is abandoned. +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L82)* **Parameters:** -Name | Type | 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`* +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | -Transaction hash. +**Returns:** *`Promise`* ___ -### fillOrderAsync +### `Static` strictArgumentEncodingCheck + +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -▸ **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/c93b02d55/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. +Defined in base-contract/lib/src/index.d.ts:42 **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. | +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -**Returns:** *`Promise`* +**Returns:** *string* -Transaction hash. +
-___ +# Class: ContractWrappers + +The ContractWrappers class contains smart contract wrappers helpful when building on 0x protocol. -### getSignerAddressAsync -▸ **getSignerAddressAsync**(`hash`: string, `signature`: string): *`Promise`* +## Constructors -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:561](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L561)* -Recovers the address of a signer given a hash and signature. + +\+ **new ContractWrappers**(`supportedProvider`: [SupportedProvider](#supportedprovider), `config`: [ContractWrappersConfig](#interface-contractwrappersconfig)): *[ContractWrappers](#class-contractwrappers)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L66)* + +Instantiates a new ContractWrappers instance. **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`hash` | string | Any 32 byte hash. | -`signature` | string | Proof that the hash has been signed by signer. | +`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:** *`Promise`* +**Returns:** *[ContractWrappers](#class-contractwrappers)* + +An instance of the ContractWrappers class. -Signer address. +## Properties -___ +### contractAddresses -### hardCancelOrderAsync +• **contractAddresses**: *`ContractAddresses`* -▸ **hardCancelOrderAsync**(`order`: `Order` | `SignedOrder`, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +*Defined in [contract-wrappers/src/contract_wrappers.ts:38](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L38)* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:428](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L428)* +An index of the default contract addresses for this chain. -Cancels an order on-chain by submitting an Ethereum transaction. +___ -**Parameters:** +### coordinator -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. | +• **coordinator**: *`CoordinatorContract`* -**Returns:** *`Promise`* +*Defined in [contract-wrappers/src/contract_wrappers.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L64)* -Transaction hash. +An instance of the CoordinatorContract class containing methods for interacting with the Coordinator extension contract. ___ -### hardCancelOrdersUpToAsync +### devUtils + +• **devUtils**: *`DevUtilsContract`* -▸ **hardCancelOrdersUpToAsync**(`targetOrderEpoch`: `BigNumber`, `senderAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +*Defined in [contract-wrappers/src/contract_wrappers.ts:60](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L60)* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:495](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L495)* +An instance of the DevUtilsContract class containing methods for interacting with the DevUtils smart contract. -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:** +### exchange -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. | +• **exchange**: *`ExchangeContract`* -**Returns:** *`Promise`* +*Defined in [contract-wrappers/src/contract_wrappers.ts:42](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L42)* -Transaction hash. +An instance of the ExchangeContract class containing methods for interacting with the 0x Exchange smart contract. ___ -### marketBuyOrdersNoThrowAsync +### forwarder -▸ **marketBuyOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `makerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +• **forwarder**: *`ForwarderContract`* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:276](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L276)* +*Defined in [contract-wrappers/src/contract_wrappers.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L51)* -No throw version of marketBuyOrdersAsync +An instance of the ForwarderContract class containing methods for interacting with any Forwarder smart contract. -**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. | +### orderValidator -**Returns:** *`Promise`* +• **orderValidator**: *`OrderValidatorContract`* -Transaction hash. +*Defined in [contract-wrappers/src/contract_wrappers.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L56)* + +An instance of the OrderValidatorContract class containing methods for interacting with any OrderValidator smart contract. ___ -### marketSellOrdersNoThrowAsync +### weth9 -▸ **marketSellOrdersNoThrowAsync**(`signedOrders`: `SignedOrder`[], `takerAssetFillAmount`: `BigNumber`, `takerAddress`: string, `orderTransactionOpts`: [OrderTransactionOpts](#interface-ordertransactionopts)): *`Promise`* +• **weth9**: *`WETH9Contract`* -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:309](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L309)* +*Defined in [contract-wrappers/src/contract_wrappers.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L47)* -No throw version of marketSellOrdersAsync +An instance of the WETH9Contract class containing methods for interacting with the +WETH9 smart contract. -**Parameters:** +## Methods -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. | +### getAbiDecoder -**Returns:** *`Promise`* +▸ **getAbiDecoder**(): *`AbiDecoder`* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:124](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L124)* + +Get the abi decoder instance currently used by contract-wrappers + +**Returns:** *`AbiDecoder`* -Transaction hash. +AbiDecoder instance ___ -### softCancelOrderAsync +### getProvider + +▸ **getProvider**(): *[SupportedProvider](#supportedprovider)* + +*Defined in [contract-wrappers/src/contract_wrappers.ts:117](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L117)* + +Get the provider instance currently used by contract-wrappers + +**Returns:** *[SupportedProvider](#supportedprovider)* -▸ **softCancelOrderAsync**(`order`: `Order` | `SignedOrder`): *`Promise`* +Web3 provider instance -*Defined in [contract-wrappers/src/coordinator_wrapper.ts:339](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/coordinator_wrapper.ts#L339)* +___ -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). +### unsubscribeAll -**Parameters:** +▸ **unsubscribeAll**(): *void* -Name | Type | Description | ------- | ------ | ------ | -`order` | `Order` \| `SignedOrder` | An object that conforms to the Order or SignedOrder interface. The order you would like to cancel. | +*Defined in [contract-wrappers/src/contract_wrappers.ts:109](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/contract_wrappers.ts#L109)* -**Returns:** *`Promise`* +Unsubscribes from all subscriptions for all contracts. -CoordinatorServerCancellationResponse. See [Cancellation Response](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/coordinator-specification.md#response). +**Returns:** *void*
@@ -18008,7 +6301,7 @@ signature from the ABI and attempts to decode the logs using it. \+ **new AbiDecoder**(`abiArrays`: [AbiDefinition](#abidefinition)[][]): *[AbiDecoder](#class-abidecoder)* -*Defined in [utils/src/abi_decoder.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/utils/src/abi_decoder.ts#L42)* +*Defined in [utils/src/abi_decoder.ts:42](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L42)* Instantiate an AbiDecoder @@ -18028,7 +6321,7 @@ AbiDecoder instance ▸ **addABI**(`abiArray`: [AbiDefinition](#abidefinition)[], `contractName?`: undefined | string): *void* -*Defined in [utils/src/abi_decoder.ts:158](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/utils/src/abi_decoder.ts#L158)* +*Defined in [utils/src/abi_decoder.ts:158](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L158)* Adds a set of ABI definitions, after which calldata and logs targeting these ABI's can be decoded. Additional properties can be included to disambiguate similar ABI's. For example, if two functions @@ -18050,7 +6343,7 @@ ___ ▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`* -*Defined in [utils/src/abi_decoder.ts:118](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/utils/src/abi_decoder.ts#L118)* +*Defined in [utils/src/abi_decoder.ts:118](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L118)* Decodes calldata for a known ABI. @@ -18071,7 +6364,7 @@ ___ ▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs` | [RawLog](#rawlog)* -*Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/utils/src/abi_decoder.ts#L58)* +*Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L58)* Attempt to decode a log given the ABI's the AbiDecoder knows about. @@ -18100,7 +6393,7 @@ The decoded log if the requisite ABI was available. Otherwise the log unaltered. • **CoordinatorEndpointSet**: = "CoordinatorEndpointSet" -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L37)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L40)*
@@ -18113,7 +6406,7 @@ The decoded log if the requisite ABI was available. Otherwise the log unaltered. • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L37)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L40)* ___ @@ -18121,7 +6414,7 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L38)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L41)*
@@ -18134,7 +6427,7 @@ ___ • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L40)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L43)* ___ @@ -18142,7 +6435,7 @@ ___ • **ApprovalForAll**: = "ApprovalForAll" -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L41)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L44)* ___ @@ -18150,49 +6443,7 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L42)* - -
- -# 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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L40)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L45)*
@@ -18205,7 +6456,7 @@ ___ • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:38](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L38)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L41)* ___ @@ -18213,28 +6464,7 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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/c93b02d55/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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L40)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L40)*
@@ -18247,7 +6477,7 @@ ___ • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L40)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L43)* ___ @@ -18255,7 +6485,7 @@ ___ • **ApprovalForAll**: = "ApprovalForAll" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L41)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L44)* ___ @@ -18263,7 +6493,7 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L42)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L45)*
@@ -18276,7 +6506,7 @@ ___ • **AssetProxyRegistered**: = "AssetProxyRegistered" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L45)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:48](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L48)* ___ @@ -18284,7 +6514,7 @@ ___ • **Cancel**: = "Cancel" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L46)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L49)* ___ @@ -18292,7 +6522,7 @@ ___ • **CancelUpTo**: = "CancelUpTo" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L47)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)* ___ @@ -18300,7 +6530,7 @@ ___ • **Fill**: = "Fill" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L48)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)* ___ @@ -18308,7 +6538,7 @@ ___ • **ProtocolFeeCollectorAddress**: = "ProtocolFeeCollectorAddress" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L49)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L52)* ___ @@ -18316,7 +6546,7 @@ ___ • **ProtocolFeeMultiplier**: = "ProtocolFeeMultiplier" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L50)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L53)* ___ @@ -18324,7 +6554,7 @@ ___ • **SignatureValidatorApproval**: = "SignatureValidatorApproval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:51](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L51)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L54)* ___ @@ -18332,7 +6562,7 @@ ___ • **TransactionExecution**: = "TransactionExecution" -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L52)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L55)*
@@ -18345,7 +6575,7 @@ ___ • **Approval**: = "Approval" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L41)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)* ___ @@ -18353,7 +6583,7 @@ ___ • **Deposit**: = "Deposit" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:43](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L43)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L46)* ___ @@ -18361,7 +6591,7 @@ ___ • **Transfer**: = "Transfer" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L42)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L45)* ___ @@ -18369,30 +6599,11 @@ ___ • **Withdrawal**: = "Withdrawal" -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L44)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L47)*
-# 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/c93b02d55/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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L37)* -
@@ -18405,7 +6616,7 @@ ___ • **ContractNotDeployedOnChain**: = "CONTRACT_NOT_DEPLOYED_ON_CHAIN" -*Defined in [contract-wrappers/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L16)* +*Defined in [contract-wrappers/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L16)* ___ @@ -18413,7 +6624,7 @@ ___ • **ERC721NoApproval**: = "ERC_721_NO_APPROVAL" -*Defined in [contract-wrappers/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L26)* +*Defined in [contract-wrappers/src/types.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L26)* ___ @@ -18421,7 +6632,7 @@ ___ • **ERC721OwnerNotFound**: = "ERC_721_OWNER_NOT_FOUND" -*Defined in [contract-wrappers/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L25)* +*Defined in [contract-wrappers/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L25)* ___ @@ -18429,7 +6640,7 @@ ___ • **InsufficientAllowanceForTransfer**: = "INSUFFICIENT_ALLOWANCE_FOR_TRANSFER" -*Defined in [contract-wrappers/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L17)* +*Defined in [contract-wrappers/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L17)* ___ @@ -18437,7 +6648,7 @@ ___ • **InsufficientBalanceForTransfer**: = "INSUFFICIENT_BALANCE_FOR_TRANSFER" -*Defined in [contract-wrappers/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L18)* +*Defined in [contract-wrappers/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L18)* ___ @@ -18445,7 +6656,7 @@ ___ • **InsufficientEthBalanceForDeposit**: = "INSUFFICIENT_ETH_BALANCE_FOR_DEPOSIT" -*Defined in [contract-wrappers/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L19)* +*Defined in [contract-wrappers/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L19)* ___ @@ -18453,7 +6664,7 @@ ___ • **InsufficientWEthBalanceForWithdrawal**: = "INSUFFICIENT_WETH_BALANCE_FOR_WITHDRAWAL" -*Defined in [contract-wrappers/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L20)* +*Defined in [contract-wrappers/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L20)* ___ @@ -18461,7 +6672,7 @@ ___ • **InvalidJump**: = "INVALID_JUMP" -*Defined in [contract-wrappers/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L21)* +*Defined in [contract-wrappers/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L21)* ___ @@ -18469,7 +6680,7 @@ ___ • **OutOfGas**: = "OUT_OF_GAS" -*Defined in [contract-wrappers/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L22)* +*Defined in [contract-wrappers/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L22)* ___ @@ -18477,7 +6688,7 @@ ___ • **SignatureRequestDenied**: = "SIGNATURE_REQUEST_DENIED" -*Defined in [contract-wrappers/src/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L27)* +*Defined in [contract-wrappers/src/types.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L27)* ___ @@ -18485,7 +6696,7 @@ ___ • **SubscriptionAlreadyPresent**: = "SUBSCRIPTION_ALREADY_PRESENT" -*Defined in [contract-wrappers/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L24)* +*Defined in [contract-wrappers/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L24)* ___ @@ -18493,7 +6704,7 @@ ___ • **SubscriptionNotFound**: = "SUBSCRIPTION_NOT_FOUND" -*Defined in [contract-wrappers/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L23)* +*Defined in [contract-wrappers/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L23)*
@@ -18506,7 +6717,7 @@ ___ • **CompleteFillFailed**: = "COMPLETE_FILL_FAILED" -*Defined in [contract-wrappers/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L12)* +*Defined in [contract-wrappers/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L12)*
@@ -18523,7 +6734,7 @@ ___ • **Earliest**: = "earliest" -*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L478)* +*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L479)* ___ @@ -18531,7 +6742,7 @@ ___ • **Latest**: = "latest" -*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L479)* +*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L480)* ___ @@ -18539,7 +6750,7 @@ ___ • **Pending**: = "pending" -*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L480)* +*Defined in [ethereum-types/src/index.ts:481](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L481)*
@@ -18570,6 +6781,10 @@ ___ + + + +
# Interface: CoordinatorRegistryCoordinatorEndpointSetEventArgs @@ -18587,7 +6802,7 @@ ___ • **coordinatorEndpoint**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L42)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L45)* ___ @@ -18595,7 +6810,7 @@ ___ • **coordinatorOperator**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L41)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L44)*
@@ -18616,7 +6831,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L42)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L45)* ___ @@ -18624,7 +6839,7 @@ ___ • **_spender**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L43)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L46)* ___ @@ -18632,7 +6847,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L44)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L47)*
@@ -18653,7 +6868,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L48)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L51)* ___ @@ -18661,7 +6876,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L49)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L52)* ___ @@ -18669,7 +6884,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L50)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L53)*
@@ -18690,7 +6905,7 @@ ___ • **_approved**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L47)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L50)* ___ @@ -18698,7 +6913,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L46)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L49)* ___ @@ -18706,7 +6921,7 @@ ___ • **_tokenId**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L48)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L51)*
@@ -18727,7 +6942,7 @@ ___ • **_approved**: *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L54)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L57)* ___ @@ -18735,7 +6950,7 @@ ___ • **_operator**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L53)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L56)* ___ @@ -18743,7 +6958,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L52)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L55)*
@@ -18764,7 +6979,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L58)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L61)* ___ @@ -18772,7 +6987,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L59)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L62)* ___ @@ -18780,119 +6995,7 @@ ___ • **_tokenId**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L60)* - -
- -# 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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L49)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L63)*
@@ -18913,7 +7016,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L48)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L51)* ___ @@ -18921,7 +7024,7 @@ ___ • **_spender**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L49)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L52)* ___ @@ -18929,7 +7032,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L50)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L53)*
@@ -18950,7 +7053,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L42)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L45)* ___ @@ -18958,7 +7061,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L43)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L46)* ___ @@ -18966,63 +7069,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L49)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L47)*
@@ -19043,7 +7090,7 @@ ___ • **_approved**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L47)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L50)* ___ @@ -19051,7 +7098,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L46)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L49)* ___ @@ -19059,7 +7106,7 @@ ___ • **_tokenId**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L48)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L51)*
@@ -19080,7 +7127,7 @@ ___ • **_approved**: *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L54)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L57)* ___ @@ -19088,7 +7135,7 @@ ___ • **_operator**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L53)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L56)* ___ @@ -19096,7 +7143,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L52)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L55)*
@@ -19117,7 +7164,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:58](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L58)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L61)* ___ @@ -19125,7 +7172,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:59](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L59)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L62)* ___ @@ -19133,7 +7180,7 @@ ___ • **_tokenId**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:60](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L60)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L63)*
@@ -19153,7 +7200,7 @@ ___ • **assetProxy**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:57](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L57)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:60](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L60)* ___ @@ -19161,7 +7208,7 @@ ___ • **id**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:56](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L56)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L59)*
@@ -19185,7 +7232,7 @@ ___ • **feeRecipientAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:62](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L62)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)* ___ @@ -19193,7 +7240,7 @@ ___ • **makerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L61)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)* ___ @@ -19201,7 +7248,7 @@ ___ • **makerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L63)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)* ___ @@ -19209,7 +7256,7 @@ ___ • **orderHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:66](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L66)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L69)* ___ @@ -19217,7 +7264,7 @@ ___ • **senderAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:65](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L65)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L68)* ___ @@ -19225,7 +7272,7 @@ ___ • **takerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:64](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L64)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:67](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L67)*
@@ -19246,7 +7293,7 @@ ___ • **makerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L70)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L73)* ___ @@ -19254,7 +7301,7 @@ ___ • **orderEpoch**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:72](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L72)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L75)* ___ @@ -19262,7 +7309,7 @@ ___ • **orderSenderAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:71](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L71)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L74)*
@@ -19294,7 +7341,7 @@ ___ • **feeRecipientAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:77](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L77)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)* ___ @@ -19302,7 +7349,7 @@ ___ • **makerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:76](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L76)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)* ___ @@ -19310,7 +7357,7 @@ ___ • **makerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L78)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)* ___ @@ -19318,7 +7365,7 @@ ___ • **makerAssetFilledAmount**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L85)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:88](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L88)* ___ @@ -19326,7 +7373,7 @@ ___ • **makerFeeAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:80](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L80)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:83](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L83)* ___ @@ -19334,7 +7381,7 @@ ___ • **makerFeePaid**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:87](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L87)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L90)* ___ @@ -19342,7 +7389,7 @@ ___ • **orderHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:82](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L82)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L85)* ___ @@ -19350,7 +7397,7 @@ ___ • **protocolFeePaid**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:89](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L89)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L92)* ___ @@ -19358,7 +7405,7 @@ ___ • **senderAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L84)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:87](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L87)* ___ @@ -19366,7 +7413,7 @@ ___ • **takerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:83](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L83)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L86)* ___ @@ -19374,7 +7421,7 @@ ___ • **takerAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:79](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L79)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L82)* ___ @@ -19382,7 +7429,7 @@ ___ • **takerAssetFilledAmount**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:86](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L86)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:89](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L89)* ___ @@ -19390,7 +7437,7 @@ ___ • **takerFeeAssetData**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:81](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L81)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L84)* ___ @@ -19398,7 +7445,7 @@ ___ • **takerFeePaid**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:88](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L88)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L91)*
@@ -19418,7 +7465,7 @@ ___ • **oldProtocolFeeCollector**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:93](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L93)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L96)* ___ @@ -19426,7 +7473,7 @@ ___ • **updatedProtocolFeeCollector**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:94](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L94)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:97](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L97)*
@@ -19446,7 +7493,7 @@ ___ • **oldProtocolFeeMultiplier**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:98](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L98)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:101](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L101)* ___ @@ -19454,7 +7501,7 @@ ___ • **updatedProtocolFeeMultiplier**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:99](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L99)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L102)*
@@ -19475,7 +7522,7 @@ ___ • **isApproved**: *boolean* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L105)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:108](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L108)* ___ @@ -19483,7 +7530,7 @@ ___ • **signerAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L103)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L106)* ___ @@ -19491,7 +7538,7 @@ ___ • **validatorAddress**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L104)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:107](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L107)*
@@ -19510,7 +7557,7 @@ ___ • **transactionHash**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:109](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L109)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L112)*
@@ -19531,7 +7578,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L48)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L51)* ___ @@ -19539,7 +7586,7 @@ ___ • **_spender**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L49)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L52)* ___ @@ -19547,7 +7594,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L50)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L53)*
@@ -19567,7 +7614,7 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:60](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L60)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L63)* ___ @@ -19575,7 +7622,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L61)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L64)*
@@ -19596,7 +7643,7 @@ ___ • **_from**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L54)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L57)* ___ @@ -19604,7 +7651,7 @@ ___ • **_to**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L55)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L58)* ___ @@ -19612,7 +7659,7 @@ ___ • **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:56](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L56)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L59)*
@@ -19632,92 +7679,183 @@ ___ • **_owner**: *string* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:65](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L65)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L68)* + +___ + +### _value + +• **_value**: *`BigNumber`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L69)* + +
+ +# Interface: AwaitTransactionSuccessOpts + +Used with `awaitTransactionSuccessAsync` +* pollingIntervalMs: Determine polling intervals in milliseconds +* timeoutMs: Determines timeout in milliseconds + + +## Properties + +### `Optional` pollingIntervalMs + +• **pollingIntervalMs**? : *undefined | number* + +*Defined in [base-contract/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L39)* + +___ + +### `Optional` shouldValidate + +• **shouldValidate**? : *undefined | false | true* + +*Inherited from [SendTransactionOpts](#interface-sendtransactionopts).[shouldValidate](#optional-shouldvalidate)* + +*Defined in [base-contract/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L30)* + +___ + +### `Optional` timeoutMs + +• **timeoutMs**? : *undefined | number* + +*Defined in [base-contract/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L40)* + +
+ + + +# Interface: ContractFunctionObj <**T**> + +## Type parameters + +▪ **T** + + +## Methods + +### callAsync + +▸ **callAsync**(`callData?`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* + +*Defined in [base-contract/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L44)* + +**Parameters:** + +Name | Type | +------ | ------ | +`callData?` | `Partial` | +`defaultBlock?` | [BlockParam](#blockparam) | + +**Returns:** *`Promise`* ___ -### _value +### getABIEncodedTransactionData + +▸ **getABIEncodedTransactionData**(): *string* + +*Defined in [base-contract/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L45)* + +**Returns:** *string* + +
+ +# Interface: ContractTxFunctionObj <**T**> + +## Type parameters + +▪ **T** -• **_value**: *`BigNumber`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:66](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L66)* +## Methods -
+### awaitTransactionSuccessAsync -# Interface: ZRXTokenApprovalEventArgs +▸ **awaitTransactionSuccessAsync**(`txData?`: `Partial`, `opts?`: [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts)): *`PromiseWithTransactionHash`* +*Defined in [base-contract/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L50)* -## Index +**Parameters:** -### Properties +Name | Type | +------ | ------ | +`txData?` | `Partial` | +`opts?` | [AwaitTransactionSuccessOpts](#class-awaittransactionsuccessopts) | -* [_owner](#_owner) -* [_spender](#_spender) -* [_value](#_value) +**Returns:** *`PromiseWithTransactionHash`* -## Properties +___ -### _owner +### callAsync -• **_owner**: *string* +▸ **callAsync**(`callData?`: `Partial`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L48)* +*Inherited from [ContractFunctionObj](#interface-contractfunctionobj).[callAsync](#callasync)* -___ +*Defined in [base-contract/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L44)* -### _spender +**Parameters:** -• **_spender**: *string* +Name | Type | +------ | ------ | +`callData?` | `Partial` | +`defaultBlock?` | [BlockParam](#blockparam) | -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L49)* +**Returns:** *`Promise`* ___ -### _value - -• **_value**: *`BigNumber`* +### estimateGasAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L50)* +▸ **estimateGasAsync**(`txData?`: `Partial`): *`Promise`* -
+*Defined in [base-contract/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L54)* -# Interface: ZRXTokenTransferEventArgs +**Parameters:** +Name | Type | +------ | ------ | +`txData?` | `Partial` | -## Index +**Returns:** *`Promise`* -### Properties +___ -* [_from](#_from) -* [_to](#_to) -* [_value](#_value) +### getABIEncodedTransactionData -## Properties +▸ **getABIEncodedTransactionData**(): *string* -### _from +*Inherited from [ContractFunctionObj](#interface-contractfunctionobj).[getABIEncodedTransactionData](#getabiencodedtransactiondata)* -• **_from**: *string* +*Defined in [base-contract/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L45)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L42)* +**Returns:** *string* ___ -### _to - -• **_to**: *string* +### sendTransactionAsync -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:43](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L43)* +▸ **sendTransactionAsync**(`txData?`: `Partial`, `opts?`: [SendTransactionOpts](#class-sendtransactionopts)): *`Promise`* -___ +*Defined in [base-contract/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/base-contract/src/types.ts#L49)* -### _value +**Parameters:** -• **_value**: *`BigNumber`* +Name | Type | +------ | ------ | +`txData?` | `Partial` | +`opts?` | [SendTransactionOpts](#class-sendtransactionopts) | -*Defined in [abi-gen-wrappers/src/generated-wrappers/zrx_token.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L44)* +**Returns:** *`Promise`*
+ + # Interface: ContractAddresses @@ -19727,7 +7865,7 @@ ___ • **assetProxyOwner**: *string* -*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L12)* +*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L12)* ___ @@ -19735,7 +7873,7 @@ ___ • **coordinator**: *string* -*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L18)* +*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L18)* ___ @@ -19743,7 +7881,7 @@ ___ • **coordinatorRegistry**: *string* -*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L17)* +*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L17)* ___ @@ -19751,7 +7889,7 @@ ___ • **devUtils**: *string* -*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L22)* +*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L22)* ___ @@ -19759,7 +7897,7 @@ ___ • **dutchAuction**: *string* -*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L16)* +*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L16)* ___ @@ -19767,7 +7905,7 @@ ___ • **erc1155Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L21)* +*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L21)* ___ @@ -19775,7 +7913,7 @@ ___ • **erc20BridgeProxy**: *string* -*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L26)* +*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L26)* ___ @@ -19783,7 +7921,7 @@ ___ • **erc20Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L6)* +*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L6)* ___ @@ -19791,7 +7929,7 @@ ___ • **erc721Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L7)* +*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L7)* ___ @@ -19799,7 +7937,7 @@ ___ • **etherToken**: *string* -*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L9)* +*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L9)* ___ @@ -19807,7 +7945,7 @@ ___ • **exchange**: *string* -*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L11)* +*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L11)* ___ @@ -19815,7 +7953,7 @@ ___ • **exchangeV2**: *string* -*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L10)* +*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L10)* ___ @@ -19823,7 +7961,7 @@ ___ • **forwarder**: *string* -*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L14)* +*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L14)* ___ @@ -19831,7 +7969,7 @@ ___ • **multiAssetProxy**: *string* -*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L19)* +*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L19)* ___ @@ -19839,7 +7977,7 @@ ___ • **orderValidator**: *string* -*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L15)* +*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L15)* ___ @@ -19847,7 +7985,7 @@ ___ • **staking**: *string* -*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L24)* +*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L24)* ___ @@ -19855,7 +7993,7 @@ ___ • **stakingProxy**: *string* -*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L25)* +*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L25)* ___ @@ -19863,7 +8001,7 @@ ___ • **staticCallProxy**: *string* -*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L20)* +*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L20)* ___ @@ -19871,7 +8009,7 @@ ___ • **zeroExGovernor**: *string* -*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L13)* +*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L13)* ___ @@ -19879,7 +8017,7 @@ ___ • **zrxToken**: *string* -*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L8)* +*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L8)* ___ @@ -19887,7 +8025,7 @@ ___ • **zrxVault**: *string* -*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L23)* +*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L23)*
@@ -19905,7 +8043,7 @@ blockPollingIntervalMs: The interval to use for block polling in event watching • **blockPollingIntervalMs**? : *undefined | number* -*Defined in [contract-wrappers/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L40)* +*Defined in [contract-wrappers/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L40)* ___ @@ -19913,7 +8051,7 @@ ___ • **chainId**: *number* -*Defined in [contract-wrappers/src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L37)* +*Defined in [contract-wrappers/src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L37)* ___ @@ -19921,7 +8059,7 @@ ___ • **contractAddresses**? : *[ContractAddresses](#class-contractaddresses)* -*Defined in [contract-wrappers/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L39)* +*Defined in [contract-wrappers/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L39)* ___ @@ -19929,7 +8067,7 @@ ___ • **gasPrice**? : *`BigNumber`* -*Defined in [contract-wrappers/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L38)* +*Defined in [contract-wrappers/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-wrappers/src/types.ts#L38)*
@@ -19939,51 +8077,7 @@ ___ -# 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:51](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L51)* - -___ - -### `Optional` gasPrice - -• **gasPrice**? : *`BigNumber`* - -*Inherited from [TransactionOpts](#interface-transactionopts).[gasPrice](#optional-gasprice)* - -*Defined in [contract-wrappers/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L50)* - -___ - -### `Optional` nonce - -• **nonce**? : *undefined | number* - -*Inherited from [TransactionOpts](#interface-transactionopts).[nonce](#optional-nonce)* - -*Defined in [contract-wrappers/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L52)* - -___ - -### `Optional` shouldValidate - -• **shouldValidate**? : *undefined | false | true* - -*Defined in [contract-wrappers/src/types.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-wrappers/src/types.ts#L61)* -
@@ -20002,7 +8096,7 @@ ___ • **fromBlock**: *[BlockParam](#blockparam)* -*Defined in [ethereum-types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L740)* +*Defined in [ethereum-types/src/index.ts:743](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L743)* ___ @@ -20010,7 +8104,7 @@ ___ • **toBlock**: *[BlockParam](#blockparam)* -*Defined in [ethereum-types/src/index.ts:741](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L741)* +*Defined in [ethereum-types/src/index.ts:744](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L744)*
@@ -20029,7 +8123,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ @@ -20037,7 +8131,7 @@ ___ • **from**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L402)* +*Defined in [ethereum-types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L403)* ___ @@ -20047,7 +8141,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* ___ @@ -20057,7 +8151,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ @@ -20067,7 +8161,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ @@ -20077,7 +8171,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ @@ -20087,7 +8181,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)*
@@ -20104,7 +8198,7 @@ ___ • **name**: *"solc"* -*Defined in [ethereum-types/src/index.ts:655](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L655)* +*Defined in [ethereum-types/src/index.ts:656](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L656)* ___ @@ -20112,7 +8206,7 @@ ___ • **settings**: *[CompilerSettings](#class-compilersettings)* -*Defined in [ethereum-types/src/index.ts:657](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L657)* +*Defined in [ethereum-types/src/index.ts:658](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L658)* ___ @@ -20120,7 +8214,7 @@ ___ • **version**: *string* -*Defined in [ethereum-types/src/index.ts:656](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L656)* +*Defined in [ethereum-types/src/index.ts:657](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L657)*
@@ -20133,7 +8227,7 @@ ___ • **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"* -*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L689)* +*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L690)* ___ @@ -20141,7 +8235,7 @@ ___ • **libraries**? : *undefined | object* -*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L691)* +*Defined in [ethereum-types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L692)* ___ @@ -20149,7 +8243,7 @@ ___ • **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* -*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L690)* +*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L691)* ___ @@ -20157,7 +8251,7 @@ ___ • **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* -*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L688)* +*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L689)* ___ @@ -20165,7 +8259,7 @@ ___ • **outputSelection**: *object* -*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L696)* +*Defined in [ethereum-types/src/index.ts:697](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L697)* #### Type declaration: @@ -20179,7 +8273,7 @@ ___ • **remappings**? : *string[]* -*Defined in [ethereum-types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L687)* +*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L688)*
@@ -20192,7 +8286,7 @@ ___ • **useLiteralContent**: *true* -*Defined in [ethereum-types/src/index.ts:704](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L704)* +*Defined in [ethereum-types/src/index.ts:705](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L705)*
@@ -20205,7 +8299,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L103)* +*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L103)* ___ @@ -20213,7 +8307,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L104)* +*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L104)* ___ @@ -20221,7 +8315,7 @@ ___ • **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L105)* +*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L105)* ___ @@ -20229,7 +8323,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L102)* +*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L102)*
@@ -20254,7 +8348,7 @@ If any of the sources change, the hash would change notifying us that a re-compi • **chains**: *[ContractChains](#class-contractchains)* -*Defined in [ethereum-types/src/index.ts:676](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L676)* +*Defined in [ethereum-types/src/index.ts:677](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L677)* ___ @@ -20264,7 +8358,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)* -*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L641)* +*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L642)* ___ @@ -20274,7 +8368,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* -*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L651)* +*Defined in [ethereum-types/src/index.ts:652](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L652)* ___ @@ -20282,7 +8376,7 @@ ___ • **contractName**: *string* -*Defined in [ethereum-types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L675)* +*Defined in [ethereum-types/src/index.ts:676](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L676)* ___ @@ -20290,7 +8384,7 @@ ___ • **schemaVersion**: *string* -*Defined in [ethereum-types/src/index.ts:674](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L674)* +*Defined in [ethereum-types/src/index.ts:675](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L675)* ___ @@ -20300,7 +8394,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* -*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L647)* +*Defined in [ethereum-types/src/index.ts:648](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L648)* #### Type declaration: @@ -20314,7 +8408,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* -*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L650)* +*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L651)* ___ @@ -20324,7 +8418,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* -*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L642)* +*Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L643)* #### Type declaration: @@ -20341,7 +8435,7 @@ ___ • **address**: *string* -*Defined in [ethereum-types/src/index.ts:554](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L554)* +*Defined in [ethereum-types/src/index.ts:555](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L555)* ___ @@ -20349,7 +8443,7 @@ Args • **constructorArgs**: *string* -*Defined in [ethereum-types/src/index.ts:558](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L558)* +*Defined in [ethereum-types/src/index.ts:559](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L559)* ___ @@ -20357,7 +8451,7 @@ ___ • **links**: *object* -*Defined in [ethereum-types/src/index.ts:555](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L555)* +*Defined in [ethereum-types/src/index.ts:556](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L556)* #### Type declaration: @@ -20381,7 +8475,7 @@ ___ • **compiler**: *[CompilerOpts](#class-compileropts)* -*Defined in [ethereum-types/src/index.ts:641](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L641)* +*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L642)* ___ @@ -20389,7 +8483,7 @@ ___ • **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* -*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L651)* +*Defined in [ethereum-types/src/index.ts:652](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L652)* ___ @@ -20397,7 +8491,7 @@ ___ • **sourceCodes**: *object* -*Defined in [ethereum-types/src/index.ts:647](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L647)* +*Defined in [ethereum-types/src/index.ts:648](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L648)* #### Type declaration: @@ -20409,7 +8503,7 @@ ___ • **sourceTreeHashHex**: *string* -*Defined in [ethereum-types/src/index.ts:650](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L650)* +*Defined in [ethereum-types/src/index.ts:651](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L651)* ___ @@ -20417,7 +8511,7 @@ ___ • **sources**: *object* -*Defined in [ethereum-types/src/index.ts:642](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L642)* +*Defined in [ethereum-types/src/index.ts:643](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L643)* #### Type declaration: @@ -20434,7 +8528,15 @@ ___ • **components**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)* + +___ + +### `Optional` internalType + +• **internalType**? : *undefined | string* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -20442,7 +8544,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -20450,7 +8552,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -20470,7 +8572,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -20478,7 +8580,7 @@ ___ • **args**: *`A`* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* ___ @@ -20488,7 +8590,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -20498,7 +8600,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -20508,7 +8610,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -20516,7 +8618,7 @@ ___ • **event**: *string* -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L416)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* ___ @@ -20526,7 +8628,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -20536,7 +8638,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -20546,7 +8648,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -20556,7 +8658,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -20575,7 +8677,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -20585,7 +8687,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* ___ @@ -20595,7 +8697,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -20605,7 +8707,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -20615,7 +8717,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -20625,7 +8727,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L416)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* ___ @@ -20635,7 +8737,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -20643,7 +8745,7 @@ ___ • **removed**: *boolean* -*Defined in [ethereum-types/src/index.ts:421](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L421)* +*Defined in [ethereum-types/src/index.ts:422](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L422)* ___ @@ -20653,7 +8755,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -20663,7 +8765,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -20673,7 +8775,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -20686,7 +8788,7 @@ ___ • **author**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L628)* +*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L629)* ___ @@ -20694,7 +8796,7 @@ ___ • **methods**: *object* -*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L629)* +*Defined in [ethereum-types/src/index.ts:630](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L630)* #### Type declaration: @@ -20706,7 +8808,7 @@ ___ • **title**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L627)* +*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L628)*
@@ -20719,7 +8821,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -20727,7 +8829,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -20751,7 +8853,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -20777,7 +8879,7 @@ Name | Type | • **object**: *string* -*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L622)* +*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L623)* ___ @@ -20785,7 +8887,7 @@ ___ • **sourceMap**: *string* -*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L623)* +*Defined in [ethereum-types/src/index.ts:624](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L624)*
@@ -20798,7 +8900,7 @@ ___ • **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L617)* +*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L618)* ___ @@ -20806,7 +8908,7 @@ ___ • **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L618)* +*Defined in [ethereum-types/src/index.ts:619](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L619)*
@@ -20819,7 +8921,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L112)* +*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L112)* ___ @@ -20827,7 +8929,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L111)* +*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L111)*
@@ -20842,7 +8944,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L14)* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -20866,7 +8968,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* ___ @@ -20874,7 +8976,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* ___ @@ -20882,7 +8984,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* ___ @@ -20890,7 +8992,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
@@ -20903,7 +9005,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* ___ @@ -20911,7 +9013,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
@@ -20924,7 +9026,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* ___ @@ -20932,7 +9034,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* ___ @@ -20940,7 +9042,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* ___ @@ -20948,7 +9050,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
@@ -20961,7 +9063,7 @@ ___ • **address**: *string* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -20969,7 +9071,7 @@ ___ • **blockHash**: *string | null* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -20977,7 +9079,7 @@ ___ • **blockNumber**: *number | null* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -20985,7 +9087,7 @@ ___ • **data**: *string* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -20993,7 +9095,7 @@ ___ • **logIndex**: *number | null* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -21001,7 +9103,7 @@ ___ • **topics**: *string[]* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -21009,7 +9111,7 @@ ___ • **transactionHash**: *string* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -21017,7 +9119,7 @@ ___ • **transactionIndex**: *number | null* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -21032,7 +9134,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -21042,7 +9144,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -21052,7 +9154,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -21062,7 +9164,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -21072,7 +9174,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -21080,7 +9182,7 @@ ___ • **removed**: *boolean* -*Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L425)* +*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L426)* ___ @@ -21090,7 +9192,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -21100,7 +9202,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -21110,7 +9212,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -21129,7 +9231,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -21139,7 +9241,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* ___ @@ -21149,7 +9251,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -21159,7 +9261,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -21169,7 +9271,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -21179,7 +9281,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L416)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* ___ @@ -21189,7 +9291,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -21199,7 +9301,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -21209,7 +9311,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -21219,7 +9321,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -21232,7 +9334,7 @@ ___ • **constant**: *boolean* -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L94)* +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L94)* ___ @@ -21240,7 +9342,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L92)* +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L92)* ___ @@ -21248,7 +9350,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L91)* +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L91)* ___ @@ -21256,7 +9358,7 @@ ___ • **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L93)* +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L93)* ___ @@ -21264,7 +9366,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L96)* +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L96)* ___ @@ -21272,7 +9374,7 @@ ___ • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L95)* +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L95)* ___ @@ -21280,7 +9382,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L90)* +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L90)*
@@ -21293,7 +9395,7 @@ ___ • **enabled**: *boolean* -*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L708)* +*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L709)* ___ @@ -21301,7 +9403,7 @@ ___ • **runs**? : *undefined | number* -*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L709)* +*Defined in [ethereum-types/src/index.ts:710](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L710)*
@@ -21318,7 +9420,7 @@ ___ • **arguments**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L122)* +*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L122)* ___ @@ -21326,7 +9428,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L121)* +*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L121)* ___ @@ -21334,403 +9436,421 @@ ___ • **type**: *"error"* -*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L120)* +*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L120)*
+# Class: CoordinatorContract +## Constructors +\+ **new CoordinatorContract**(`address`: string, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults?`: `Partial`, `logDecodeDependencies?`: undefined | object, `deployedBytecode`: string | undefined): *[CoordinatorContract](#class-coordinatorcontract)* -# Interface: StandardContractOutput - - -## Properties - -### abi - -• **abi**: *[ContractAbi](#contractabi)* - -*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L564)* - -___ - -### `Optional` devdoc +*Overrides void* -• **devdoc**? : *[DevdocOutput](#class-devdocoutput)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1163](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1163)* -*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L566)* +**Parameters:** -___ +Name | Type | Default | +------ | ------ | ------ | +`address` | string | - | +`supportedProvider` | [SupportedProvider](#supportedprovider) | - | +`txDefaults?` | `Partial` | - | +`logDecodeDependencies?` | undefined \| object | - | +`deployedBytecode` | string \| undefined | CoordinatorContract.deployedBytecode | -### evm +**Returns:** *[CoordinatorContract](#class-coordinatorcontract)* -• **evm**: *[EvmOutput](#class-evmoutput)* +## Properties -*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L565)* +### `Optional` _deployedBytecodeIfExists -
+• **_deployedBytecodeIfExists**? : *`Buffer`* +Defined in base-contract/lib/src/index.d.ts:32 +___ +### abi +• **abi**: *[ContractAbi](#contractabi)* +Defined in base-contract/lib/src/index.d.ts:28 +___ +### address +• **address**: *string* -# Interface: TupleDataItem +Defined in base-contract/lib/src/index.d.ts:29 +___ -## Properties +Args -### components +• **constructorArgs**: *any[]* -• **components**: *[DataItem](#class-dataitem)[]* -*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L141)* +Defined in base-contract/lib/src/index.d.ts:31 ___ -### name - -• **name**: *string* - -*Inherited from [DataItem](#interface-dataitem).[name](#name)* +### contractName -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +• **contractName**: *string* -___ -### type -• **type**: *string* +Defined in base-contract/lib/src/index.d.ts:30 -*Inherited from [DataItem](#interface-dataitem).[type](#type)* +## Methods -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +### EIP712_COORDINATOR_APPROVAL_SCHEMA_HASH -
+▸ **EIP712_COORDINATOR_APPROVAL_SCHEMA_HASH**(): *`ContractFunctionObj`* -# Interface: TxData +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:483](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L483)* +**Returns:** *`ContractFunctionObj`* -## Properties +___ -### `Optional` data +### EIP712_COORDINATOR_DOMAIN_HASH -• **data**? : *undefined | string* +▸ **EIP712_COORDINATOR_DOMAIN_HASH**(): *`ContractFunctionObj`* -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:533](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L533)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +**Returns:** *`ContractFunctionObj`* ___ -### from +### EIP712_COORDINATOR_DOMAIN_NAME -• **from**: *string* +▸ **EIP712_COORDINATOR_DOMAIN_NAME**(): *`ContractFunctionObj`* + +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:580](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L580)* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L398)* +**Returns:** *`ContractFunctionObj`* ___ -### `Optional` gas +### EIP712_COORDINATOR_DOMAIN_VERSION -• **gas**? : *number | string | `BigNumber`* +▸ **EIP712_COORDINATOR_DOMAIN_VERSION**(): *`ContractFunctionObj`* -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:627](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L627)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +**Returns:** *`ContractFunctionObj`* ___ -### `Optional` gasPrice +### EIP712_EXCHANGE_DOMAIN_HASH -• **gasPrice**? : *number | string | `BigNumber`* +▸ **EIP712_EXCHANGE_DOMAIN_HASH**(): *`ContractFunctionObj`* -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:677](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L677)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +**Returns:** *`ContractFunctionObj`* ___ -### `Optional` nonce - -• **nonce**? : *undefined | number* - -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* +### assertValidCoordinatorApprovals -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +▸ **assertValidCoordinatorApprovals**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalSignatures`: string[]): *`ContractFunctionObj`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:736](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L736)* -### `Optional` to +Validates that the 0x transaction has been approved by all of the feeRecipients +that correspond to each order in the transaction's Exchange calldata. -• **to**? : *undefined | string* +**Parameters:** -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction containing salt, signerAddress, and data. | +`txOrigin` | string | Required signer of Ethereum transaction calling this function. | +`transactionSignature` | string | Proof that the transaction has been signed by the signer. | +`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +**Returns:** *`ContractFunctionObj`* ___ -### `Optional` value - -• **value**? : *number | string | `BigNumber`* +### decodeOrdersFromFillData -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* +▸ **decodeOrdersFromFillData**(`data`: string): *`ContractFunctionObj>`* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L390)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:811](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L811)* -
+Decodes the orders from Exchange calldata representing any fill method. -# Interface: TxDataPayable +**Parameters:** +Name | Type | Description | +------ | ------ | ------ | +`data` | string | Exchange calldata representing a fill method. | -## Properties +**Returns:** *`ContractFunctionObj>`* -### `Optional` data +orders The orders from the Exchange calldata. -• **data**? : *undefined | string* +___ -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* +### executeTransaction -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +▸ **executeTransaction**(`transaction`: object, `txOrigin`: string, `transactionSignature`: string, `approvalSignatures`: string[]): *`ContractTxFunctionObj`* -___ +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:919](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L919)* -### from +Executes a 0x transaction that has been signed by the feeRecipients that correspond to +each order in the transaction's Exchange calldata. -• **from**: *string* +**Parameters:** -*Inherited from [TxData](#interface-txdata).[from](#from)* +Name | Type | Description | +------ | ------ | ------ | +`transaction` | object | 0x transaction containing salt, signerAddress, and data. | +`txOrigin` | string | Required signer of Ethereum transaction calling this function. | +`transactionSignature` | string | Proof that the transaction has been signed by the signer. | +`approvalSignatures` | string[] | Array of signatures that correspond to the feeRecipients of each order in the transaction's Exchange calldata. | -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L398)* +**Returns:** *`ContractTxFunctionObj`* ___ -### `Optional` gas - -• **gas**? : *number | string | `BigNumber`* +### getABIDecodedReturnData -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* +▸ **getABIDecodedReturnData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:469](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L469)* -___ +**Type parameters:** -### `Optional` gasPrice +▪ **T** -• **gasPrice**? : *number | string | `BigNumber`* +**Parameters:** -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +**Returns:** *`T`* ___ -### `Optional` nonce - -• **nonce**? : *undefined | number* +### getABIDecodedTransactionData -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* +▸ **getABIDecodedTransactionData**<**T**>(`methodName`: string, `callData`: string): *`T`* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:462](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L462)* -___ +**Type parameters:** -### `Optional` to +▪ **T** -• **to**? : *undefined | string* +**Parameters:** -*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* +Name | Type | +------ | ------ | +`methodName` | string | +`callData` | string | -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +**Returns:** *`T`* ___ -### `Optional` value +### getCoordinatorApprovalHash -• **value**? : *`BigNumber`* +▸ **getCoordinatorApprovalHash**(`approval`: object): *`ContractFunctionObj`* -*Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1060](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1060)* -*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L442)* +Calculates the EIP712 hash of the Coordinator approval mesasage using the domain +separator of this contract. -
+**Parameters:** -# Interface: Web3JsV1Provider +Name | Type | Description | +------ | ------ | ------ | +`approval` | object | Coordinator approval message containing the transaction hash, and transaction signature. | -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. +**Returns:** *`ContractFunctionObj`* +approvalHash EIP712 hash of the Coordinator approval message with the domain separator of this contract. -## Methods +___ -### send +### getFunctionSignature -▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* +▸ **getFunctionSignature**(`methodName`: string): *string* -*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L45)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:456](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L456)* **Parameters:** Name | Type | ------ | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`methodName` | string | -**Returns:** *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* +**Returns:** *string* ___ -### sendAsync +### getSelector -▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* +▸ **getSelector**(`methodName`: string): *string* -*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L44)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:476](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L476)* **Parameters:** Name | Type | ------ | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | +`methodName` | string | -**Returns:** *void* +**Returns:** *string* -
+___ -# Interface: Web3JsV2Provider +### getSignerAddress -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 +▸ **getSignerAddress**(`hash`: string, `signature`: string): *`ContractFunctionObj`* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:1122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L1122)* -## Methods +Recovers the address of a signer given a hash and signature. -### send +**Parameters:** -▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* +Name | Type | Description | +------ | ------ | ------ | +`hash` | string | Any 32 byte hash. | +`signature` | string | Proof that the hash has been signed by signer. | -*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L54)* +**Returns:** *`ContractFunctionObj`* -**Parameters:** +signerAddress Address of the signer. -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | +___ -**Returns:** *void* +### `Static` ABI -
+▸ **ABI**(): *[ContractAbi](#contractabi)* -# Interface: Web3JsV3Provider +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:128](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L128)* -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. +**Returns:** *[ContractAbi](#contractabi)* +The contract ABI -## Methods +___ -### send +### `Static` deployAsync -▸ **send**(`method`: string, `params?`: any[]): *`Promise`* +▸ **deployAsync**(`bytecode`: string, `abi`: [ContractAbi](#contractabi), `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise`* -*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L63)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L80)* **Parameters:** Name | Type | ------ | ------ | -`method` | string | -`params?` | any[] | - -**Returns:** *`Promise`* +`bytecode` | string | +`abi` | [ContractAbi](#contractabi) | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`exchange` | string | +`chainId` | `BigNumber` | -
+**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 +### `Static` deployFrom0xArtifactAsync +▸ **deployFrom0xArtifactAsync**(`artifact`: `ContractArtifact` | `SimpleContractArtifact`, `supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `Partial`, `logDecodeDependencies`: object, `exchange`: string, `chainId`: `BigNumber`): *`Promise`* -## Properties +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts#L45)* -### `Optional` isMetaMask +**Parameters:** -• **isMetaMask**? : *undefined | false | true* +Name | Type | +------ | ------ | +`artifact` | `ContractArtifact` \| `SimpleContractArtifact` | +`supportedProvider` | [SupportedProvider](#supportedprovider) | +`txDefaults` | `Partial` | +`logDecodeDependencies` | object | +`exchange` | string | +`chainId` | `BigNumber` | -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L31)* +**Returns:** *`Promise`* ___ -### `Optional` isParity +### `Static` strictArgumentEncodingCheck -• **isParity**? : *undefined | false | true* +▸ **strictArgumentEncodingCheck**(`inputAbi`: `DataItem`[], `args`: any[]): *string* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L32)* -___ -### `Optional` isZeroExProvider +Defined in base-contract/lib/src/index.d.ts:42 -• **isZeroExProvider**? : *undefined | false | true* +**Parameters:** -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L30)* +Name | Type | +------ | ------ | +`inputAbi` | `DataItem`[] | +`args` | any[] | -## Methods +**Returns:** *string* -### `Optional` enable +
-▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L34)* -**Returns:** *`Promise`* -___ -### sendAsync +# Interface: StandardContractOutput -▸ **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/c93b02d55/packages/ethereum-types/src/index.ts#L35)* +## Properties -**Parameters:** +### abi -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | +• **abi**: *[ContractAbi](#contractabi)* -**Returns:** *void* +*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L565)* ___ -### `Optional` stop +### `Optional` devdoc -▸ **stop**(): *void* +• **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:567](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L567)* -**Returns:** *void* +___ + +### evm + +• **evm**: *[EvmOutput](#class-evmoutput)* + +*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L566)*
@@ -21744,513 +9864,529 @@ ___ -# Interface: AwaitTransactionSuccessOpts -Used with `awaitTransactionSuccessAsync` -* pollingIntervalMs: Determine polling intervals in milliseconds -* timeoutMs: Determines timeout in milliseconds + + + +# Interface: TupleDataItem ## Properties -### `Optional` pollingIntervalMs +### components -• **pollingIntervalMs**? : *undefined | number* +• **components**: *[DataItem](#class-dataitem)[]* -*Overrides [SendTransactionOpts](_types_src_index_.sendtransactionopts.md).[pollingIntervalMs](#optional-pollingintervalms)* +*Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* -*Defined in [types/src/index.ts:877](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L877)* +*Defined in [ethereum-types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L142)* ___ -### `Optional` shouldValidate +### `Optional` internalType -• **shouldValidate**? : *undefined | false | true* +• **internalType**? : *undefined | string* -*Inherited from [SendTransactionOpts](#interface-sendtransactionopts).[shouldValidate](#optional-shouldvalidate)* +*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)* -*Overrides [SendTransactionOpts](_types_src_index_.sendtransactionopts.md).[shouldValidate](#optional-shouldvalidate)* +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* + +___ + +### name + +• **name**: *string* + +*Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L680)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ -### `Optional` timeoutMs +### type -• **timeoutMs**? : *undefined | number* +• **type**: *string* -*Overrides [SendTransactionOpts](_types_src_index_.sendtransactionopts.md).[timeoutMs](#optional-timeoutms)* +*Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [types/src/index.ts:878](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L878)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
+# Interface: TxData +## Properties +### `Optional` data +• **data**? : *undefined | string* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* +___ +### from +• **from**: *string* -# Interface: DecodedLogEvent <**ArgsType**> +*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* -## Type parameters +___ -▪ **ArgsType**: *`DecodedLogArgs`* +### `Optional` gas +• **gas**? : *number | string | `BigNumber`* -## Properties +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -### isRemoved +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* -• **isRemoved**: *boolean* +___ -*Defined in [types/src/index.ts:844](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L844)* +### `Optional` gasPrice + +• **gasPrice**? : *number | string | `BigNumber`* + +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* + +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ -### log +### `Optional` nonce -• **log**: *`LogWithDecodedArgs`* +• **nonce**? : *undefined | number* -*Defined in [types/src/index.ts:845](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L845)* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -
+*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* +___ +### `Optional` to +• **to**? : *undefined | string* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* +___ +### `Optional` value +• **value**? : *number | string | `BigNumber`* -# Interface: EIP712DomainWithDefaultSchema +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)* -## Properties +
-### chainId +# Interface: TxDataPayable -• **chainId**: *number* -*Defined in [types/src/index.ts:793](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L793)* +## Properties -___ +### `Optional` data -### `Optional` name +• **data**? : *undefined | string* -• **name**? : *undefined | string* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [types/src/index.ts:791](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L791)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ -### verifyingContract +### from + +• **from**: *string* -• **verifyingContract**: *string* +*Inherited from [TxData](#interface-txdata).[from](#from)* -*Defined in [types/src/index.ts:794](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L794)* +*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* ___ -### `Optional` version - -• **version**? : *undefined | string* +### `Optional` gas -*Defined in [types/src/index.ts:792](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L792)* +• **gas**? : *number | string | `BigNumber`* -
+*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* +___ +### `Optional` gasPrice +• **gasPrice**? : *number | string | `BigNumber`* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* +___ +### `Optional` nonce +• **nonce**? : *undefined | number* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* +___ +### `Optional` to +• **to**? : *undefined | string* +*Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* +___ +### `Optional` value - +• **value**? : *`BigNumber`* +*Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)* +*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L443)* +
+# Interface: Web3JsV1Provider -# Interface: IndexedFilterValues +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. -## Hierarchy +## Methods -* **IndexSignature** +### send +▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* -## Properties +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L45)* -### keyName +**Parameters:** -• **keyName**: *string* +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -*Defined in [types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L691)* +**Returns:** *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* ___ -### keyType - -• **keyType**: *[Type](#class-type)* +### sendAsync -*Defined in [types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L692)* +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -___ +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L44)* -### valueName +**Parameters:** -• **valueName**: *string* +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | -*Defined in [types/src/index.ts:693](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L693)* +**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/34538f2ce/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/34538f2ce/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/34538f2ce/packages/ethereum-types/src/index.ts#L31)* +___ +### `Optional` isParity +• **isParity**? : *undefined | false | true* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L32)* +___ +### `Optional` isZeroExProvider +• **isZeroExProvider**? : *undefined | false | true* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L30)* +## Methods +### `Optional` enable +▸ **enable**(): *`Promise`* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L34)* +**Returns:** *`Promise`* +___ +### sendAsync -# Interface: SendTransactionOpts +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -* 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. -* pollingIntervalMs: Used with `awaitTransactionSuccessAsync` to determine polling interval in milliseconds -* timeoutMs: Used with `awaitTransactionSuccessAsync` to determine timeout in milliseconds -Used with `sendTransactionAsync` -* 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. +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L35)* +**Parameters:** -## Properties +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | -### `Optional` pollingIntervalMs +**Returns:** *void* -• **pollingIntervalMs**? : *undefined | number* +___ -*Defined in [types/src/index.ts:681](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L681)* +### `Optional` stop -___ +▸ **stop**(): *void* -### `Optional` shouldValidate +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L33)* -• **shouldValidate**? : *undefined | false | true* +**Returns:** *void* -*Defined in [types/src/index.ts:680](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L680)* +
-*Defined in [types/src/index.ts:868](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L868)* -___ -### `Optional` timeoutMs -• **timeoutMs**? : *undefined | number* -*Defined in [types/src/index.ts:682](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L682)* -
-# Interface: SignedOrder -## Properties -### chainId -• **chainId**: *number* -*Inherited from [Order](#interface-order).[chainId](#chainid)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L14)* -___ -### exchangeAddress -• **exchangeAddress**: *string* -*Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L15)* -___ -### expirationTimeSeconds -• **expirationTimeSeconds**: *`BigNumber`* +# Interface: DecodedLogEvent <**ArgsType**> -*Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* +## Type parameters -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L24)* +▪ **ArgsType**: *`DecodedLogArgs`* -___ -### feeRecipientAddress +## Properties -• **feeRecipientAddress**: *string* +### isRemoved -*Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* +• **isRemoved**: *boolean* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:844](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L844)* ___ -### makerAddress +### log -• **makerAddress**: *string* +• **log**: *`LogWithDecodedArgs`* -*Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* +*Defined in [types/src/index.ts:845](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L845)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L16)* +
-___ -### makerAssetAmount -• **makerAssetAmount**: *`BigNumber`* -*Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L20)* -___ -### makerAssetData -• **makerAssetData**: *string* -*Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L26)* -___ -### makerFee -• **makerFee**: *`BigNumber`* -*Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L22)* -___ -### makerFeeAssetData -• **makerFeeAssetData**: *string* -*Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L28)* -___ -### salt -• **salt**: *`BigNumber`* -*Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L25)* -___ -### senderAddress -• **senderAddress**: *string* -*Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* + -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L19)* -___ -### signature -• **signature**: *string* -*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L33)* +# Interface: IndexedFilterValues -___ -### takerAddress +## Hierarchy -• **takerAddress**: *string* +* **IndexSignature** -*Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L17)* +## Properties -___ +### keyName -### takerAssetAmount +• **keyName**: *string* + +*Defined in [types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L691)* + +___ -• **takerAssetAmount**: *`BigNumber`* +### keyType -*Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* +• **keyType**: *[Type](#class-type)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L692)* ___ -### takerAssetData +### valueName -• **takerAssetData**: *string* +• **valueName**: *string* + +*Defined in [types/src/index.ts:693](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L693)* + +
-*Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L27)* -___ -### takerFee -• **takerFee**: *`BigNumber`* -*Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L23)* -___ -### takerFeeAssetData -• **takerFeeAssetData**: *string* -*Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L29)* -
-# Interface: SignedZeroExTransaction -## Properties -### data -• **data**: *string* -*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[data](#data)* -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L49)* -___ -### domain -• **domain**: *[EIP712DomainWithDefaultSchema](#class-eip712domainwithdefaultschema)* -*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[domain](#domain)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L50)* -___ -### expirationTimeSeconds -• **expirationTimeSeconds**: *`BigNumber`* -*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L46)* -___ -### gasPrice -• **gasPrice**: *`BigNumber`* -*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[gasPrice](#gasprice)* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L47)* -___ -### salt -• **salt**: *`BigNumber`* -*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[salt](#salt)* -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L45)* -___ -### signature -• **signature**: *string* -*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L54)* -___ -### signerAddress -• **signerAddress**: *string* -*Inherited from [ZeroExTransaction](#interface-zeroextransaction).[signerAddress](#signeraddress)* -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L48)* -
# Interface: SimpleContractArtifact @@ -22261,7 +10397,7 @@ ___ • **chains**: *`ContractChains`* -*Defined in [types/src/index.ts:885](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L885)* +*Defined in [types/src/index.ts:861](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L861)* ___ @@ -22269,7 +10405,7 @@ ___ • **compilerOutput**: *[SimpleStandardContractOutput](#class-simplestandardcontractoutput)* -*Defined in [types/src/index.ts:884](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L884)* +*Defined in [types/src/index.ts:860](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L860)* ___ @@ -22277,7 +10413,7 @@ ___ • **contractName**: *string* -*Defined in [types/src/index.ts:883](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L883)* +*Defined in [types/src/index.ts:859](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L859)* ___ @@ -22285,7 +10421,7 @@ ___ • **schemaVersion**: *string* -*Defined in [types/src/index.ts:882](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L882)* +*Defined in [types/src/index.ts:858](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L858)*
@@ -22298,7 +10434,7 @@ ___ • **object**: *string* -*Defined in [types/src/index.ts:899](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L899)* +*Defined in [types/src/index.ts:875](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L875)*
@@ -22311,7 +10447,7 @@ ___ • **bytecode**: *[SimpleEvmBytecodeOutput](#class-simpleevmbytecodeoutput)* -*Defined in [types/src/index.ts:895](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L895)* +*Defined in [types/src/index.ts:871](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L871)*
@@ -22324,7 +10460,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [types/src/index.ts:889](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L889)* +*Defined in [types/src/index.ts:865](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L865)* ___ @@ -22332,7 +10468,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [types/src/index.ts:891](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L891)* +*Defined in [types/src/index.ts:867](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L867)* ___ @@ -22340,7 +10476,7 @@ ___ • **evm**: *[SimpleEvmOutput](#class-simpleevmoutput)* -*Defined in [types/src/index.ts:890](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L890)* +*Defined in [types/src/index.ts:866](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L866)*
@@ -22378,77 +10514,51 @@ ___ -# Interface: ZeroExTransaction -ZeroExTransaction for use with 0x Exchange executeTransaction -## Properties -### data -• **data**: *string* +## Type aliases -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L49)* -___ -### domain -• **domain**: *[EIP712DomainWithDefaultSchema](#class-eip712domainwithdefaultschema)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L50)* -___ -### expirationTimeSeconds -• **expirationTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L46)* -___ -### gasPrice +### EventCallback -• **gasPrice**: *`BigNumber`* +Ƭ **EventCallback**: *function* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L47)* +*Defined in [types/src/index.ts:848](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L848)* -___ +#### Type declaration: -### salt +▸ (`err`: null | `Error`, `log?`: [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*›): *void* -• **salt**: *`BigNumber`* +**Parameters:** -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L45)* +Name | Type | +------ | ------ | +`err` | null \| `Error` | +`log?` | [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*› | ___ -### signerAddress - -• **signerAddress**: *string* - -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L48)* - -
- -
- -## 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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L34)* -
@@ -22459,24 +10569,11 @@ ___ ## Type aliases -### DummyERC20TokenEventArgs - -Ƭ **DummyERC20TokenEventArgs**: *[DummyERC20TokenApprovalEventArgs](#interface-dummyerc20tokenapprovaleventargs) | [DummyERC20TokenTransferEventArgs](#interface-dummyerc20tokentransfereventargs)* - -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L34)* - -
- - - - -## Type aliases - -### DummyERC721TokenEventArgs +### CoordinatorRegistryEventArgs -Ƭ **DummyERC721TokenEventArgs**: *[DummyERC721TokenApprovalEventArgs](#interface-dummyerc721tokenapprovaleventargs) | [DummyERC721TokenApprovalForAllEventArgs](#interface-dummyerc721tokenapprovalforalleventargs) | [DummyERC721TokenTransferEventArgs](#interface-dummyerc721tokentransfereventargs)* +Ƭ **CoordinatorRegistryEventArgs**: *[CoordinatorRegistryCoordinatorEndpointSetEventArgs](#interface-coordinatorregistrycoordinatorendpointseteventargs)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts#L37)*
@@ -22489,11 +10586,11 @@ ___ ## Type aliases -### ERC1155ProxyEventArgs +### DummyERC20TokenEventArgs -Ƭ **ERC1155ProxyEventArgs**: *[ERC1155ProxyAuthorizedAddressAddedEventArgs](#interface-erc1155proxyauthorizedaddressaddedeventargs) | [ERC1155ProxyAuthorizedAddressRemovedEventArgs](#interface-erc1155proxyauthorizedaddressremovedeventargs)* +Ƭ **DummyERC20TokenEventArgs**: *[DummyERC20TokenApprovalEventArgs](#interface-dummyerc20tokenapprovaleventargs) | [DummyERC20TokenTransferEventArgs](#interface-dummyerc20tokentransfereventargs)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc1155_proxy.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc20_token.ts#L37)*
@@ -22502,11 +10599,11 @@ ___ ## Type aliases -### ERC20ProxyEventArgs +### DummyERC721TokenEventArgs -Ƭ **ERC20ProxyEventArgs**: *[ERC20ProxyAuthorizedAddressAddedEventArgs](#interface-erc20proxyauthorizedaddressaddedeventargs) | [ERC20ProxyAuthorizedAddressRemovedEventArgs](#interface-erc20proxyauthorizedaddressremovedeventargs)* +Ƭ **DummyERC721TokenEventArgs**: *[DummyERC721TokenApprovalEventArgs](#interface-dummyerc721tokenapprovaleventargs) | [DummyERC721TokenApprovalForAllEventArgs](#interface-dummyerc721tokenapprovalforalleventargs) | [DummyERC721TokenTransferEventArgs](#interface-dummyerc721tokentransfereventargs)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc20_proxy.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/dummy_erc721_token.ts#L37)*
@@ -22519,20 +10616,7 @@ ___ Ƭ **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/c93b02d55/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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_proxy.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc20_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc20_token.ts#L37)*
@@ -22545,7 +10629,7 @@ ___ Ƭ **ERC721TokenEventArgs**: *[ERC721TokenApprovalEventArgs](#interface-erc721tokenapprovaleventargs) | [ERC721TokenApprovalForAllEventArgs](#interface-erc721tokenapprovalforalleventargs) | [ERC721TokenTransferEventArgs](#interface-erc721tokentransfereventargs)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/erc721_token.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/erc721_token.ts#L37)*
@@ -22558,7 +10642,7 @@ ___ Ƭ **ExchangeEventArgs**: *[ExchangeAssetProxyRegisteredEventArgs](#interface-exchangeassetproxyregisteredeventargs) | [ExchangeCancelEventArgs](#interface-exchangecanceleventargs) | [ExchangeCancelUpToEventArgs](#interface-exchangecanceluptoeventargs) | [ExchangeFillEventArgs](#interface-exchangefilleventargs) | [ExchangeProtocolFeeCollectorAddressEventArgs](#interface-exchangeprotocolfeecollectoraddresseventargs) | [ExchangeProtocolFeeMultiplierEventArgs](#interface-exchangeprotocolfeemultipliereventargs) | [ExchangeSignatureValidatorApprovalEventArgs](#interface-exchangesignaturevalidatorapprovaleventargs) | [ExchangeTransactionExecutionEventArgs](#interface-exchangetransactionexecutioneventargs)* -*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/exchange.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/exchange.ts#L37)*
@@ -22587,7 +10671,7 @@ ___ Ƭ **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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L34)* +*Defined in [abi-gen-wrappers/src/generated-wrappers/weth9.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/abi-gen-wrappers/src/generated-wrappers/weth9.ts#L37)*
@@ -22596,13 +10680,7 @@ ___ ## 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/c93b02d55/packages/abi-gen-wrappers/src/generated-wrappers/zrx_token.ts#L34)* -
@@ -22613,7 +10691,7 @@ ___ ▸ **getContractAddressesForChainOrThrow**(`chainId`: [ChainId](#enumeration-chainid)): *[ContractAddresses](#interface-contractaddresses)* -*Defined in [contract-addresses/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L45)* +*Defined in [contract-addresses/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L45)* Used to get addresses of contracts that have been deployed to either the Ethereum mainnet or a supported testnet. Throws if there are no known @@ -22642,10 +10720,6 @@ given chainId. -
- - - ## Type aliases @@ -22653,7 +10727,7 @@ given chainId. Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)* -*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L80)* +*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L80)* ___ @@ -22661,7 +10735,7 @@ ___ Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* -*Defined in [ethereum-types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L483)* +*Defined in [ethereum-types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L484)* ___ @@ -22669,7 +10743,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L84)* ___ @@ -22677,7 +10751,7 @@ ___ Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* -*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L78)* +*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L78)* ___ @@ -22685,7 +10759,7 @@ ___ Ƭ **ContractEventArg**: *any* -*Defined in [ethereum-types/src/index.ts:468](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L468)* +*Defined in [ethereum-types/src/index.ts:469](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L469)* ___ @@ -22695,7 +10769,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L70)* Interface for providers that conform to EIP 1193 Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md @@ -22710,7 +10784,7 @@ ___ Ƭ **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/c93b02d55/packages/ethereum-types/src/index.ts#L82)* +*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L82)* ___ @@ -22718,7 +10792,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -22739,7 +10813,7 @@ ___ Ƭ **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:525](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L525)* +*Defined in [ethereum-types/src/index.ts:526](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L526)* ___ @@ -22747,7 +10821,7 @@ ___ Ƭ **ParamDescription**: *string* -*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L561)* +*Defined in [ethereum-types/src/index.ts:562](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L562)* ___ @@ -22755,7 +10829,7 @@ ___ Ƭ **RawLog**: *[LogEntry](#interface-logentry)* -*Defined in [ethereum-types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L475)* +*Defined in [ethereum-types/src/index.ts:476](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L476)* ___ @@ -22763,7 +10837,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L85)* ___ @@ -22771,7 +10845,7 @@ ___ Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)* -*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L9)* Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library Read more about Providers in the guides section of the 0x docs. @@ -22786,55 +10860,7 @@ ___ Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)* -*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L11)*
- - - -## Type aliases - - - - - - - - - - - -### EventCallback - -Ƭ **EventCallback**: *function* - -*Defined in [types/src/index.ts:848](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L848)* - -#### Type declaration: - -▸ (`err`: null | `Error`, `log?`: [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*›): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`err` | null \| `Error` | -`log?` | [DecodedLogEvent](#interface-decodedlogevent)‹*`ArgsType`*› | - -___ - - - - - - - - - - - - - -
- diff --git a/packages/contracts-gen/CHANGELOG.json b/packages/contracts-gen/CHANGELOG.json index c734ffad8a..638a1af7b4 100644 --- a/packages/contracts-gen/CHANGELOG.json +++ b/packages/contracts-gen/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "1.1.0-beta.1", diff --git a/packages/contracts-gen/CHANGELOG.md b/packages/contracts-gen/CHANGELOG.md index 29cc8ae18f..cb93be6ca7 100644 --- a/packages/contracts-gen/CHANGELOG.md +++ b/packages/contracts-gen/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v1.1.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v1.1.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/dev-utils/CHANGELOG.json b/packages/dev-utils/CHANGELOG.json index 4c9d136a0f..c29b59d099 100644 --- a/packages/dev-utils/CHANGELOG.json +++ b/packages/dev-utils/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "2.4.0-beta.1", diff --git a/packages/dev-utils/CHANGELOG.md b/packages/dev-utils/CHANGELOG.md index ab966e86bb..85934ae0d2 100644 --- a/packages/dev-utils/CHANGELOG.md +++ b/packages/dev-utils/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.4.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v2.4.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/ethereum-types/CHANGELOG.json b/packages/ethereum-types/CHANGELOG.json index e6bac820b6..e6a9a273d4 100644 --- a/packages/ethereum-types/CHANGELOG.json +++ b/packages/ethereum-types/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "2.2.0-beta.1", diff --git a/packages/ethereum-types/CHANGELOG.md b/packages/ethereum-types/CHANGELOG.md index ca95fcd7c5..be9557930d 100644 --- a/packages/ethereum-types/CHANGELOG.md +++ b/packages/ethereum-types/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.2.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v2.2.0-beta.1 - _November 7, 2019_ * All references to network ID have been removed, and references to chain ID have been introduced instead (#2313) diff --git a/packages/ethereum-types/docs/reference.mdx b/packages/ethereum-types/docs/reference.mdx index 55d6545035..618e639969 100644 --- a/packages/ethereum-types/docs/reference.mdx +++ b/packages/ethereum-types/docs/reference.mdx @@ -1,37 +1,22 @@ -# Enumeration: AbiType - - -## Enumeration members - -### Constructor - -• **Constructor**: = "constructor" - -*Defined in [index.ts:463](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L463)* - -___ - -### Event - -• **Event**: = "event" +# Interface: GanacheProvider -*Defined in [index.ts:464](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L464)* -___ - -### Fallback +## Methods -• **Fallback**: = "fallback" +### sendAsync -*Defined in [index.ts:465](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L465)* +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -___ +*Defined in [index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L14)* -### Function +**Parameters:** -• **Function**: = "function" +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | -*Defined in [index.ts:462](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L462)* +**Returns:** *void*
@@ -44,7 +29,7 @@ ___ • **Earliest**: = "earliest" -*Defined in [index.ts:478](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L478)* +*Defined in [index.ts:479](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L479)* ___ @@ -52,7 +37,7 @@ ___ • **Latest**: = "latest" -*Defined in [index.ts:479](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L479)* +*Defined in [index.ts:480](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L480)* ___ @@ -60,7 +45,7 @@ ___ • **Pending**: = "pending" -*Defined in [index.ts:480](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L480)* +*Defined in [index.ts:481](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L481)*
@@ -73,7 +58,7 @@ ___ • **Add**: = "ADD" -*Defined in [index.ts:147](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L147)* +*Defined in [index.ts:148](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L148)* ___ @@ -81,7 +66,7 @@ ___ • **AddMod**: = "ADDMOD" -*Defined in [index.ts:154](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L154)* +*Defined in [index.ts:155](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L155)* ___ @@ -89,7 +74,7 @@ ___ • **Address**: = "ADDRESS" -*Defined in [index.ts:173](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L173)* +*Defined in [index.ts:174](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L174)* ___ @@ -97,7 +82,7 @@ ___ • **And**: = "AND" -*Defined in [index.ts:165](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L165)* +*Defined in [index.ts:166](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L166)* ___ @@ -105,7 +90,7 @@ ___ • **Balance**: = "BALANCE" -*Defined in [index.ts:174](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L174)* +*Defined in [index.ts:175](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L175)* ___ @@ -113,7 +98,7 @@ ___ • **BlockHash**: = "BLOCKHASH" -*Defined in [index.ts:189](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L189)* +*Defined in [index.ts:190](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L190)* ___ @@ -121,7 +106,7 @@ ___ • **Byte**: = "BYTE" -*Defined in [index.ts:169](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L169)* +*Defined in [index.ts:170](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L170)* ___ @@ -129,7 +114,7 @@ ___ • **Call**: = "CALL" -*Defined in [index.ts:282](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L282)* +*Defined in [index.ts:283](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L283)* ___ @@ -137,7 +122,7 @@ ___ • **CallCode**: = "CALLCODE" -*Defined in [index.ts:283](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L283)* +*Defined in [index.ts:284](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L284)* ___ @@ -145,7 +130,7 @@ ___ • **CallDataCopy**: = "CALLDATACOPY" -*Defined in [index.ts:180](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L180)* +*Defined in [index.ts:181](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L181)* ___ @@ -153,7 +138,7 @@ ___ • **CallDataLoad**: = "CALLDATALOAD" -*Defined in [index.ts:178](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L178)* +*Defined in [index.ts:179](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L179)* ___ @@ -161,7 +146,7 @@ ___ • **CallDataSize**: = "CALLDATASIZE" -*Defined in [index.ts:179](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L179)* +*Defined in [index.ts:180](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L180)* ___ @@ -169,7 +154,7 @@ ___ • **CallValue**: = "CALLVALUE" -*Defined in [index.ts:177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L177)* +*Defined in [index.ts:178](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L178)* ___ @@ -177,7 +162,7 @@ ___ • **Caller**: = "CALLER" -*Defined in [index.ts:176](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L176)* +*Defined in [index.ts:177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L177)* ___ @@ -185,7 +170,7 @@ ___ • **CodeCopy**: = "CODECOPY" -*Defined in [index.ts:182](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L182)* +*Defined in [index.ts:183](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L183)* ___ @@ -193,7 +178,7 @@ ___ • **CodeSize**: = "CODESIZE" -*Defined in [index.ts:181](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L181)* +*Defined in [index.ts:182](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L182)* ___ @@ -201,7 +186,7 @@ ___ • **Coinbase**: = "COINBASE" -*Defined in [index.ts:190](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L190)* +*Defined in [index.ts:191](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L191)* ___ @@ -209,7 +194,7 @@ ___ • **Create**: = "CREATE" -*Defined in [index.ts:281](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L281)* +*Defined in [index.ts:282](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L282)* ___ @@ -217,7 +202,7 @@ ___ • **DelegateCall**: = "DELEGATECALL" -*Defined in [index.ts:285](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L285)* +*Defined in [index.ts:286](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L286)* ___ @@ -225,7 +210,7 @@ ___ • **Difficulty**: = "DIFFICULTY" -*Defined in [index.ts:193](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L193)* +*Defined in [index.ts:194](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L194)* ___ @@ -233,7 +218,7 @@ ___ • **Div**: = "DIV" -*Defined in [index.ts:150](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L150)* +*Defined in [index.ts:151](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L151)* ___ @@ -241,7 +226,7 @@ ___ • **Dup1**: = "DUP1" -*Defined in [index.ts:242](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L242)* +*Defined in [index.ts:243](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L243)* ___ @@ -249,7 +234,7 @@ ___ • **Dup10**: = "DUP10" -*Defined in [index.ts:251](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L251)* +*Defined in [index.ts:252](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L252)* ___ @@ -257,7 +242,7 @@ ___ • **Dup11**: = "DUP11" -*Defined in [index.ts:252](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L252)* +*Defined in [index.ts:253](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L253)* ___ @@ -265,7 +250,7 @@ ___ • **Dup12**: = "DUP12" -*Defined in [index.ts:253](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L253)* +*Defined in [index.ts:254](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L254)* ___ @@ -273,7 +258,7 @@ ___ • **Dup13**: = "DUP13" -*Defined in [index.ts:254](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L254)* +*Defined in [index.ts:255](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L255)* ___ @@ -281,7 +266,7 @@ ___ • **Dup14**: = "DUP14" -*Defined in [index.ts:255](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L255)* +*Defined in [index.ts:256](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L256)* ___ @@ -289,7 +274,7 @@ ___ • **Dup15**: = "DUP15" -*Defined in [index.ts:256](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L256)* +*Defined in [index.ts:257](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L257)* ___ @@ -297,7 +282,7 @@ ___ • **Dup16**: = "DUP16" -*Defined in [index.ts:257](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L257)* +*Defined in [index.ts:258](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L258)* ___ @@ -305,7 +290,7 @@ ___ • **Dup2**: = "DUP2" -*Defined in [index.ts:243](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L243)* +*Defined in [index.ts:244](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L244)* ___ @@ -313,7 +298,7 @@ ___ • **Dup3**: = "DUP3" -*Defined in [index.ts:244](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L244)* +*Defined in [index.ts:245](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L245)* ___ @@ -321,7 +306,7 @@ ___ • **Dup4**: = "DUP4" -*Defined in [index.ts:245](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L245)* +*Defined in [index.ts:246](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L246)* ___ @@ -329,7 +314,7 @@ ___ • **Dup5**: = "DUP5" -*Defined in [index.ts:246](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L246)* +*Defined in [index.ts:247](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L247)* ___ @@ -337,7 +322,7 @@ ___ • **Dup6**: = "DUP6" -*Defined in [index.ts:247](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L247)* +*Defined in [index.ts:248](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L248)* ___ @@ -345,7 +330,7 @@ ___ • **Dup7**: = "DUP7" -*Defined in [index.ts:248](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L248)* +*Defined in [index.ts:249](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L249)* ___ @@ -353,7 +338,7 @@ ___ • **Dup8**: = "DUP8" -*Defined in [index.ts:249](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L249)* +*Defined in [index.ts:250](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L250)* ___ @@ -361,7 +346,7 @@ ___ • **Dup9**: = "DUP9" -*Defined in [index.ts:250](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L250)* +*Defined in [index.ts:251](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L251)* ___ @@ -369,7 +354,7 @@ ___ • **Eq**: = "EQ" -*Defined in [index.ts:163](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L163)* +*Defined in [index.ts:164](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L164)* ___ @@ -377,7 +362,7 @@ ___ • **Exp**: = "EXP" -*Defined in [index.ts:156](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L156)* +*Defined in [index.ts:157](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L157)* ___ @@ -385,7 +370,7 @@ ___ • **ExtCodeCopy**: = "EXTCODECOPY" -*Defined in [index.ts:185](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L185)* +*Defined in [index.ts:186](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L186)* ___ @@ -393,7 +378,7 @@ ___ • **ExtCodeSize**: = "EXTCODESIZE" -*Defined in [index.ts:184](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L184)* +*Defined in [index.ts:185](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L185)* ___ @@ -401,7 +386,7 @@ ___ • **Gas**: = "GAS" -*Defined in [index.ts:206](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L206)* +*Defined in [index.ts:207](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L207)* ___ @@ -409,7 +394,7 @@ ___ • **GasPrice**: = "GASPRICE" -*Defined in [index.ts:183](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L183)* +*Defined in [index.ts:184](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L184)* ___ @@ -417,7 +402,7 @@ ___ • **Gaslimit**: = "GASLIMIT" -*Defined in [index.ts:194](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L194)* +*Defined in [index.ts:195](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L195)* ___ @@ -425,7 +410,7 @@ ___ • **Gt**: = "GT" -*Defined in [index.ts:160](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L160)* +*Defined in [index.ts:161](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L161)* ___ @@ -433,7 +418,7 @@ ___ • **Invalid**: = "INVALID" -*Defined in [index.ts:288](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L288)* +*Defined in [index.ts:289](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L289)* ___ @@ -441,7 +426,7 @@ ___ • **IsZero**: = "ISZERO" -*Defined in [index.ts:164](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L164)* +*Defined in [index.ts:165](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L165)* ___ @@ -449,7 +434,7 @@ ___ • **Jump**: = "JUMP" -*Defined in [index.ts:202](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L202)* +*Defined in [index.ts:203](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L203)* ___ @@ -457,7 +442,7 @@ ___ • **JumpDest**: = "JUMPDEST" -*Defined in [index.ts:207](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L207)* +*Defined in [index.ts:208](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L208)* ___ @@ -465,7 +450,7 @@ ___ • **Jumpi**: = "JUMPI" -*Defined in [index.ts:203](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L203)* +*Defined in [index.ts:204](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L204)* ___ @@ -473,7 +458,7 @@ ___ • **Log1**: = "LOG1" -*Defined in [index.ts:276](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L276)* +*Defined in [index.ts:277](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L277)* ___ @@ -481,7 +466,7 @@ ___ • **Log2**: = "LOG2" -*Defined in [index.ts:277](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L277)* +*Defined in [index.ts:278](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L278)* ___ @@ -489,7 +474,7 @@ ___ • **Log3**: = "LOG3" -*Defined in [index.ts:278](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L278)* +*Defined in [index.ts:279](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L279)* ___ @@ -497,7 +482,7 @@ ___ • **Log4**: = "LOG4" -*Defined in [index.ts:279](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L279)* +*Defined in [index.ts:280](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L280)* ___ @@ -505,7 +490,7 @@ ___ • **Lt**: = "LT" -*Defined in [index.ts:159](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L159)* +*Defined in [index.ts:160](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L160)* ___ @@ -513,7 +498,7 @@ ___ • **MLoad**: = "MLOAD" -*Defined in [index.ts:197](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L197)* +*Defined in [index.ts:198](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L198)* ___ @@ -521,7 +506,7 @@ ___ • **MSize**: = "MSIZE" -*Defined in [index.ts:205](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L205)* +*Defined in [index.ts:206](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L206)* ___ @@ -529,7 +514,7 @@ ___ • **MStore**: = "MSTORE" -*Defined in [index.ts:198](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L198)* +*Defined in [index.ts:199](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L199)* ___ @@ -537,7 +522,7 @@ ___ • **MStore8**: = "MSTORE8" -*Defined in [index.ts:199](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L199)* +*Defined in [index.ts:200](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L200)* ___ @@ -545,7 +530,7 @@ ___ • **Mod**: = "MOD" -*Defined in [index.ts:152](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L152)* +*Defined in [index.ts:153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L153)* ___ @@ -553,7 +538,7 @@ ___ • **Mul**: = "MUL" -*Defined in [index.ts:148](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L148)* +*Defined in [index.ts:149](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L149)* ___ @@ -561,7 +546,7 @@ ___ • **MulMod**: = "MULMOD" -*Defined in [index.ts:155](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L155)* +*Defined in [index.ts:156](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L156)* ___ @@ -569,7 +554,7 @@ ___ • **Not**: = "NOT" -*Defined in [index.ts:168](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L168)* +*Defined in [index.ts:169](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L169)* ___ @@ -577,7 +562,7 @@ ___ • **Number**: = "NUMBER" -*Defined in [index.ts:192](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L192)* +*Defined in [index.ts:193](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L193)* ___ @@ -585,7 +570,7 @@ ___ • **Or**: = "OR" -*Defined in [index.ts:166](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L166)* +*Defined in [index.ts:167](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L167)* ___ @@ -593,7 +578,7 @@ ___ • **Origin**: = "ORIGIN" -*Defined in [index.ts:175](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L175)* +*Defined in [index.ts:176](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L176)* ___ @@ -601,7 +586,7 @@ ___ • **Pc**: = "PC" -*Defined in [index.ts:204](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L204)* +*Defined in [index.ts:205](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L205)* ___ @@ -609,7 +594,7 @@ ___ • **Pop**: = "POP" -*Defined in [index.ts:196](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L196)* +*Defined in [index.ts:197](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L197)* ___ @@ -617,7 +602,7 @@ ___ • **Push1**: = "PUSH1" -*Defined in [index.ts:209](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L209)* +*Defined in [index.ts:210](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L210)* ___ @@ -625,7 +610,7 @@ ___ • **Push10**: = "PUSH10" -*Defined in [index.ts:218](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L218)* +*Defined in [index.ts:219](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L219)* ___ @@ -633,7 +618,7 @@ ___ • **Push11**: = "PUSH11" -*Defined in [index.ts:219](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L219)* +*Defined in [index.ts:220](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L220)* ___ @@ -641,7 +626,7 @@ ___ • **Push12**: = "PUSH12" -*Defined in [index.ts:220](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L220)* +*Defined in [index.ts:221](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L221)* ___ @@ -649,7 +634,7 @@ ___ • **Push13**: = "PUSH13" -*Defined in [index.ts:221](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L221)* +*Defined in [index.ts:222](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L222)* ___ @@ -657,7 +642,7 @@ ___ • **Push14**: = "PUSH14" -*Defined in [index.ts:222](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L222)* +*Defined in [index.ts:223](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L223)* ___ @@ -665,7 +650,7 @@ ___ • **Push15**: = "PUSH15" -*Defined in [index.ts:223](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L223)* +*Defined in [index.ts:224](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L224)* ___ @@ -673,7 +658,7 @@ ___ • **Push16**: = "PUSH16" -*Defined in [index.ts:224](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L224)* +*Defined in [index.ts:225](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L225)* ___ @@ -681,7 +666,7 @@ ___ • **Push17**: = "PUSH17" -*Defined in [index.ts:225](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L225)* +*Defined in [index.ts:226](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L226)* ___ @@ -689,7 +674,7 @@ ___ • **Push18**: = "PUSH18" -*Defined in [index.ts:226](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L226)* +*Defined in [index.ts:227](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L227)* ___ @@ -697,7 +682,7 @@ ___ • **Push19**: = "PUSH19" -*Defined in [index.ts:227](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L227)* +*Defined in [index.ts:228](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L228)* ___ @@ -705,7 +690,7 @@ ___ • **Push2**: = "PUSH2" -*Defined in [index.ts:210](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L210)* +*Defined in [index.ts:211](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L211)* ___ @@ -713,7 +698,7 @@ ___ • **Push20**: = "PUSH20" -*Defined in [index.ts:228](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L228)* +*Defined in [index.ts:229](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L229)* ___ @@ -721,7 +706,7 @@ ___ • **Push21**: = "PUSH21" -*Defined in [index.ts:229](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L229)* +*Defined in [index.ts:230](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L230)* ___ @@ -729,7 +714,7 @@ ___ • **Push22**: = "PUSH22" -*Defined in [index.ts:230](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L230)* +*Defined in [index.ts:231](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L231)* ___ @@ -737,7 +722,7 @@ ___ • **Push23**: = "PUSH23" -*Defined in [index.ts:231](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L231)* +*Defined in [index.ts:232](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L232)* ___ @@ -745,7 +730,7 @@ ___ • **Push24**: = "PUSH24" -*Defined in [index.ts:232](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L232)* +*Defined in [index.ts:233](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L233)* ___ @@ -753,7 +738,7 @@ ___ • **Push25**: = "PUSH25" -*Defined in [index.ts:233](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L233)* +*Defined in [index.ts:234](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L234)* ___ @@ -761,7 +746,7 @@ ___ • **Push26**: = "PUSH26" -*Defined in [index.ts:234](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L234)* +*Defined in [index.ts:235](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L235)* ___ @@ -769,7 +754,7 @@ ___ • **Push27**: = "PUSH27" -*Defined in [index.ts:235](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L235)* +*Defined in [index.ts:236](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L236)* ___ @@ -777,7 +762,7 @@ ___ • **Push28**: = "PUSH28" -*Defined in [index.ts:236](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L236)* +*Defined in [index.ts:237](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L237)* ___ @@ -785,7 +770,7 @@ ___ • **Push29**: = "PUSH29" -*Defined in [index.ts:237](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L237)* +*Defined in [index.ts:238](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L238)* ___ @@ -793,7 +778,7 @@ ___ • **Push3**: = "PUSH3" -*Defined in [index.ts:211](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L211)* +*Defined in [index.ts:212](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L212)* ___ @@ -801,7 +786,7 @@ ___ • **Push30**: = "PUSH30" -*Defined in [index.ts:238](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L238)* +*Defined in [index.ts:239](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L239)* ___ @@ -809,7 +794,7 @@ ___ • **Push31**: = "PUSH31" -*Defined in [index.ts:239](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L239)* +*Defined in [index.ts:240](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L240)* ___ @@ -817,7 +802,7 @@ ___ • **Push32**: = "PUSH32" -*Defined in [index.ts:240](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L240)* +*Defined in [index.ts:241](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L241)* ___ @@ -825,7 +810,7 @@ ___ • **Push4**: = "PUSH4" -*Defined in [index.ts:212](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L212)* +*Defined in [index.ts:213](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L213)* ___ @@ -833,7 +818,7 @@ ___ • **Push5**: = "PUSH5" -*Defined in [index.ts:213](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L213)* +*Defined in [index.ts:214](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L214)* ___ @@ -841,7 +826,7 @@ ___ • **Push6**: = "PUSH6" -*Defined in [index.ts:214](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L214)* +*Defined in [index.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L215)* ___ @@ -849,7 +834,7 @@ ___ • **Push7**: = "PUSH7" -*Defined in [index.ts:215](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L215)* +*Defined in [index.ts:216](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L216)* ___ @@ -857,7 +842,7 @@ ___ • **Push8**: = "PUSH8" -*Defined in [index.ts:216](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L216)* +*Defined in [index.ts:217](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L217)* ___ @@ -865,7 +850,7 @@ ___ • **Push9**: = "PUSH9" -*Defined in [index.ts:217](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L217)* +*Defined in [index.ts:218](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L218)* ___ @@ -873,7 +858,7 @@ ___ • **Return**: = "RETURN" -*Defined in [index.ts:284](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L284)* +*Defined in [index.ts:285](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L285)* ___ @@ -881,7 +866,7 @@ ___ • **ReturnDataCopy**: = "RETURNDATACOPY" -*Defined in [index.ts:187](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L187)* +*Defined in [index.ts:188](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L188)* ___ @@ -889,7 +874,7 @@ ___ • **ReturnDataSize**: = "RETURNDATASIZE" -*Defined in [index.ts:186](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L186)* +*Defined in [index.ts:187](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L187)* ___ @@ -897,7 +882,7 @@ ___ • **Revert**: = "REVERT" -*Defined in [index.ts:287](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L287)* +*Defined in [index.ts:288](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L288)* ___ @@ -905,7 +890,7 @@ ___ • **SDiv**: = "SDIV" -*Defined in [index.ts:151](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L151)* +*Defined in [index.ts:152](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L152)* ___ @@ -913,7 +898,7 @@ ___ • **SGt**: = "SGT" -*Defined in [index.ts:162](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L162)* +*Defined in [index.ts:163](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L163)* ___ @@ -921,7 +906,7 @@ ___ • **SLoad**: = "SLOAD" -*Defined in [index.ts:200](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L200)* +*Defined in [index.ts:201](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L201)* ___ @@ -929,7 +914,7 @@ ___ • **SLt**: = "SLT" -*Defined in [index.ts:161](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L161)* +*Defined in [index.ts:162](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L162)* ___ @@ -937,7 +922,7 @@ ___ • **SMod**: = "SMOD" -*Defined in [index.ts:153](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L153)* +*Defined in [index.ts:154](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L154)* ___ @@ -945,7 +930,7 @@ ___ • **SStore**: = "SSTORE" -*Defined in [index.ts:201](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L201)* +*Defined in [index.ts:202](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L202)* ___ @@ -953,7 +938,7 @@ ___ • **SelfDestruct**: = "SELFDESTRUCT" -*Defined in [index.ts:289](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L289)* +*Defined in [index.ts:290](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L290)* ___ @@ -961,7 +946,7 @@ ___ • **Sha3**: = "SHA3" -*Defined in [index.ts:171](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L171)* +*Defined in [index.ts:172](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L172)* ___ @@ -969,7 +954,7 @@ ___ • **SignExtend**: = "SIGNEXTEND" -*Defined in [index.ts:157](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L157)* +*Defined in [index.ts:158](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L158)* ___ @@ -977,7 +962,7 @@ ___ • **StaticCall**: = "STATICCALL" -*Defined in [index.ts:286](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L286)* +*Defined in [index.ts:287](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L287)* ___ @@ -985,7 +970,7 @@ ___ • **Stop**: = "STOP" -*Defined in [index.ts:146](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L146)* +*Defined in [index.ts:147](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L147)* ___ @@ -993,7 +978,7 @@ ___ • **Sub**: = "SUB" -*Defined in [index.ts:149](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L149)* +*Defined in [index.ts:150](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L150)* ___ @@ -1001,7 +986,7 @@ ___ • **Swap1**: = "SWAP1" -*Defined in [index.ts:259](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L259)* +*Defined in [index.ts:260](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L260)* ___ @@ -1009,7 +994,7 @@ ___ • **Swap10**: = "SWAP10" -*Defined in [index.ts:268](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L268)* +*Defined in [index.ts:269](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L269)* ___ @@ -1017,7 +1002,7 @@ ___ • **Swap11**: = "SWAP11" -*Defined in [index.ts:269](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L269)* +*Defined in [index.ts:270](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L270)* ___ @@ -1025,7 +1010,7 @@ ___ • **Swap12**: = "SWAP12" -*Defined in [index.ts:270](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L270)* +*Defined in [index.ts:271](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L271)* ___ @@ -1033,7 +1018,7 @@ ___ • **Swap13**: = "SWAP13" -*Defined in [index.ts:271](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L271)* +*Defined in [index.ts:272](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L272)* ___ @@ -1041,7 +1026,7 @@ ___ • **Swap14**: = "SWAP14" -*Defined in [index.ts:272](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L272)* +*Defined in [index.ts:273](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L273)* ___ @@ -1049,7 +1034,7 @@ ___ • **Swap15**: = "SWAP15" -*Defined in [index.ts:273](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L273)* +*Defined in [index.ts:274](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L274)* ___ @@ -1057,7 +1042,7 @@ ___ • **Swap16**: = "SWAP16" -*Defined in [index.ts:274](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L274)* +*Defined in [index.ts:275](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L275)* ___ @@ -1065,7 +1050,7 @@ ___ • **Swap2**: = "SWAP2" -*Defined in [index.ts:260](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L260)* +*Defined in [index.ts:261](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L261)* ___ @@ -1073,7 +1058,7 @@ ___ • **Swap3**: = "SWAP3" -*Defined in [index.ts:261](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L261)* +*Defined in [index.ts:262](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L262)* ___ @@ -1081,7 +1066,7 @@ ___ • **Swap4**: = "SWAP4" -*Defined in [index.ts:262](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L262)* +*Defined in [index.ts:263](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L263)* ___ @@ -1089,7 +1074,7 @@ ___ • **Swap5**: = "SWAP5" -*Defined in [index.ts:263](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L263)* +*Defined in [index.ts:264](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L264)* ___ @@ -1097,7 +1082,7 @@ ___ • **Swap6**: = "SWAP6" -*Defined in [index.ts:264](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L264)* +*Defined in [index.ts:265](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L265)* ___ @@ -1105,7 +1090,7 @@ ___ • **Swap7**: = "SWAP7" -*Defined in [index.ts:265](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L265)* +*Defined in [index.ts:266](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L266)* ___ @@ -1113,7 +1098,7 @@ ___ • **Swap8**: = "SWAP8" -*Defined in [index.ts:266](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L266)* +*Defined in [index.ts:267](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L267)* ___ @@ -1121,7 +1106,7 @@ ___ • **Swap9**: = "SWAP9" -*Defined in [index.ts:267](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L267)* +*Defined in [index.ts:268](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L268)* ___ @@ -1129,7 +1114,7 @@ ___ • **TimeStamp**: = "TimeStamp" -*Defined in [index.ts:191](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L191)* +*Defined in [index.ts:192](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L192)* ___ @@ -1137,7 +1122,7 @@ ___ • **Xor**: = "XOR" -*Defined in [index.ts:167](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L167)* +*Defined in [index.ts:168](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L168)*
@@ -1150,7 +1135,7 @@ ___ • **Address**: = "address" -*Defined in [index.ts:497](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L497)* +*Defined in [index.ts:498](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L498)* ___ @@ -1158,7 +1143,7 @@ ___ • **Bool**: = "bool" -*Defined in [index.ts:498](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L498)* +*Defined in [index.ts:499](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L499)* ___ @@ -1166,7 +1151,7 @@ ___ • **Bytes**: = "bytes" -*Defined in [index.ts:499](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L499)* +*Defined in [index.ts:500](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L500)* ___ @@ -1174,7 +1159,7 @@ ___ • **Int**: = "int" -*Defined in [index.ts:500](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L500)* +*Defined in [index.ts:501](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L501)* ___ @@ -1182,7 +1167,7 @@ ___ • **String**: = "string" -*Defined in [index.ts:501](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L501)* +*Defined in [index.ts:502](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L502)* ___ @@ -1190,7 +1175,7 @@ ___ • **Tuple**: = "tuple" -*Defined in [index.ts:502](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L502)* +*Defined in [index.ts:503](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L503)* ___ @@ -1198,7 +1183,7 @@ ___ • **Uint**: = "uint" -*Defined in [index.ts:505](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L505)* +*Defined in [index.ts:506](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L506)* ___ @@ -1206,7 +1191,7 @@ ___ • **Uint256**: = "uint256" -*Defined in [index.ts:503](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L503)* +*Defined in [index.ts:504](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L504)* ___ @@ -1214,7 +1199,7 @@ ___ • **Uint8**: = "uint8" -*Defined in [index.ts:504](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L504)* +*Defined in [index.ts:505](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L505)*
@@ -1227,7 +1212,7 @@ ___ • **difficulty**: *`BigNumber`* -*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L357)* ___ @@ -1235,7 +1220,7 @@ ___ • **extraData**: *string* -*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L358)* +*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L359)* ___ @@ -1243,7 +1228,7 @@ ___ • **gasLimit**: *number* -*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L360)* +*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L361)* ___ @@ -1251,7 +1236,7 @@ ___ • **gasUsed**: *number* -*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L361)* +*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L362)* ___ @@ -1259,7 +1244,7 @@ ___ • **hash**: *string | null* -*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L349)* ___ @@ -1267,7 +1252,7 @@ ___ • **logsBloom**: *string | null* -*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L353)* ___ @@ -1275,7 +1260,7 @@ ___ • **miner**: *string* -*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L356)* ___ @@ -1283,7 +1268,7 @@ ___ • **nonce**: *string | null* -*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L351)* ___ @@ -1291,7 +1276,7 @@ ___ • **number**: *number | null* -*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L348)* ___ @@ -1299,7 +1284,7 @@ ___ • **parentHash**: *string* -*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L350)* ___ @@ -1307,7 +1292,7 @@ ___ • **sha3Uncles**: *string* -*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L352)* ___ @@ -1315,7 +1300,7 @@ ___ • **size**: *number* -*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L359)* +*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L360)* ___ @@ -1323,7 +1308,7 @@ ___ • **stateRoot**: *string* -*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L355)* ___ @@ -1331,7 +1316,7 @@ ___ • **timestamp**: *number* -*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L362)* +*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L363)* ___ @@ -1339,7 +1324,7 @@ ___ • **totalDifficulty**: *`BigNumber`* -*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L358)* ___ @@ -1347,7 +1332,7 @@ ___ • **transactionsRoot**: *string* -*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L354)* ___ @@ -1355,7 +1340,7 @@ ___ • **uncles**: *string[]* -*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L363)* +*Defined in [index.ts:364](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L364)*
@@ -1368,7 +1353,7 @@ ___ • **fromBlock**: *[BlockParam](#blockparam)* -*Defined in [index.ts:740](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L740)* +*Defined in [index.ts:743](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L743)* ___ @@ -1376,7 +1361,7 @@ ___ • **toBlock**: *[BlockParam](#blockparam)* -*Defined in [index.ts:741](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L741)* +*Defined in [index.ts:744](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L744)*
@@ -1391,7 +1376,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[difficulty](#difficulty)* -*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L357)* ___ @@ -1401,7 +1386,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[extraData](#extradata)* -*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L358)* +*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L359)* ___ @@ -1411,7 +1396,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasLimit](#gaslimit)* -*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L360)* +*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L361)* ___ @@ -1421,7 +1406,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasUsed](#gasused)* -*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L361)* +*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L362)* ___ @@ -1431,7 +1416,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[hash](#hash)* -*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L349)* ___ @@ -1441,7 +1426,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[logsBloom](#logsbloom)* -*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L353)* ___ @@ -1451,7 +1436,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[miner](#miner)* -*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L356)* ___ @@ -1461,7 +1446,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[nonce](#nonce)* -*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L351)* ___ @@ -1471,7 +1456,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[number](#number)* -*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L348)* ___ @@ -1481,7 +1466,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[parentHash](#parenthash)* -*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L350)* ___ @@ -1491,7 +1476,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[sha3Uncles](#sha3uncles)* -*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L352)* ___ @@ -1501,7 +1486,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[size](#size)* -*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L359)* +*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L360)* ___ @@ -1511,7 +1496,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[stateRoot](#stateroot)* -*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L355)* ___ @@ -1521,7 +1506,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[timestamp](#timestamp)* -*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L362)* +*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L363)* ___ @@ -1531,7 +1516,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[totalDifficulty](#totaldifficulty)* -*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L358)* ___ @@ -1539,7 +1524,7 @@ ___ • **transactions**: *string[]* -*Defined in [index.ts:367](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L367)* +*Defined in [index.ts:368](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L368)* ___ @@ -1549,7 +1534,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[transactionsRoot](#transactionsroot)* -*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L354)* ___ @@ -1559,7 +1544,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[uncles](#uncles)* -*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L363)* +*Defined in [index.ts:364](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L364)*
@@ -1574,7 +1559,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[difficulty](#difficulty)* -*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L356)* +*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L357)* ___ @@ -1584,7 +1569,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[extraData](#extradata)* -*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L358)* +*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L359)* ___ @@ -1594,7 +1579,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasLimit](#gaslimit)* -*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L360)* +*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L361)* ___ @@ -1604,7 +1589,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasUsed](#gasused)* -*Defined in [index.ts:361](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L361)* +*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L362)* ___ @@ -1614,7 +1599,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[hash](#hash)* -*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L348)* +*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L349)* ___ @@ -1624,7 +1609,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[logsBloom](#logsbloom)* -*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L352)* +*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L353)* ___ @@ -1634,7 +1619,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[miner](#miner)* -*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L355)* +*Defined in [index.ts:356](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L356)* ___ @@ -1644,7 +1629,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[nonce](#nonce)* -*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L350)* +*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L351)* ___ @@ -1654,7 +1639,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[number](#number)* -*Defined in [index.ts:347](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L347)* +*Defined in [index.ts:348](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L348)* ___ @@ -1664,7 +1649,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[parentHash](#parenthash)* -*Defined in [index.ts:349](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L349)* +*Defined in [index.ts:350](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L350)* ___ @@ -1674,7 +1659,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[sha3Uncles](#sha3uncles)* -*Defined in [index.ts:351](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L351)* +*Defined in [index.ts:352](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L352)* ___ @@ -1684,7 +1669,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[size](#size)* -*Defined in [index.ts:359](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L359)* +*Defined in [index.ts:360](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L360)* ___ @@ -1694,7 +1679,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[stateRoot](#stateroot)* -*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L354)* +*Defined in [index.ts:355](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L355)* ___ @@ -1704,7 +1689,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[timestamp](#timestamp)* -*Defined in [index.ts:362](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L362)* +*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L363)* ___ @@ -1714,7 +1699,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[totalDifficulty](#totaldifficulty)* -*Defined in [index.ts:357](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L357)* +*Defined in [index.ts:358](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L358)* ___ @@ -1722,7 +1707,7 @@ ___ • **transactions**: *[Transaction](#class-transaction)[]* -*Defined in [index.ts:371](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L371)* +*Defined in [index.ts:372](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L372)* ___ @@ -1732,7 +1717,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[transactionsRoot](#transactionsroot)* -*Defined in [index.ts:353](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L353)* +*Defined in [index.ts:354](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L354)* ___ @@ -1742,7 +1727,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[uncles](#uncles)* -*Defined in [index.ts:363](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L363)* +*Defined in [index.ts:364](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L364)*
@@ -1757,7 +1742,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ @@ -1765,7 +1750,7 @@ ___ • **from**? : *undefined | string* -*Defined in [index.ts:402](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L402)* +*Defined in [index.ts:403](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L403)* ___ @@ -1775,7 +1760,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* ___ @@ -1785,7 +1770,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ @@ -1795,7 +1780,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +*Defined in [index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ @@ -1805,7 +1790,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ @@ -1815,7 +1800,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L390)* +*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)*
@@ -1828,7 +1813,7 @@ ___ • **data**? : *undefined | string* -*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ @@ -1836,7 +1821,7 @@ ___ • **gas**? : *number | string | `BigNumber`* -*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* ___ @@ -1844,7 +1829,7 @@ ___ • **gasPrice**? : *number | string | `BigNumber`* -*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ @@ -1852,7 +1837,7 @@ ___ • **nonce**? : *undefined | number* -*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +*Defined in [index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ @@ -1860,7 +1845,7 @@ ___ • **to**? : *undefined | string* -*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ @@ -1868,7 +1853,7 @@ ___ • **value**? : *number | string | `BigNumber`* -*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L390)* +*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)*
@@ -1885,6 +1870,7 @@ useDockerisedSolc: If set to true - sol-compiler will try calling a dockerized i isOfflineMode: If set to true - sol-compiler will not fetch the list of solc releases from github. It will use the hardcoded list. Defaults to false. solcVersion: If you don't want to compile each contract with the Solidity version specified in-file, you can force all contracts to compile with the the version specified here. +shouldSaveStandardInput: Write the standard JSON input in ${contractsDir}/${contractName}.input.json ## Properties @@ -1893,7 +1879,7 @@ contracts to compile with the the version specified here. • **artifactsDir**? : *undefined | string* -*Defined in [index.ts:731](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L731)* +*Defined in [index.ts:733](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L733)* ___ @@ -1901,7 +1887,7 @@ ___ • **compilerSettings**? : *[CompilerSettings](#class-compilersettings)* -*Defined in [index.ts:732](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L732)* +*Defined in [index.ts:734](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L734)* ___ @@ -1909,7 +1895,7 @@ ___ • **contracts**? : *string[] | "*"* -*Defined in [index.ts:733](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L733)* +*Defined in [index.ts:735](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L735)* ___ @@ -1917,7 +1903,7 @@ ___ • **contractsDir**? : *undefined | string* -*Defined in [index.ts:730](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L730)* +*Defined in [index.ts:732](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L732)* ___ @@ -1925,7 +1911,15 @@ ___ • **isOfflineMode**? : *undefined | false | true* -*Defined in [index.ts:735](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L735)* +*Defined in [index.ts:737](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L737)* + +___ + +### `Optional` shouldSaveStandardInput + +• **shouldSaveStandardInput**? : *undefined | false | true* + +*Defined in [index.ts:739](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L739)* ___ @@ -1933,7 +1927,7 @@ ___ • **solcVersion**? : *undefined | string* -*Defined in [index.ts:736](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L736)* +*Defined in [index.ts:738](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L738)* ___ @@ -1941,7 +1935,7 @@ ___ • **useDockerisedSolc**? : *undefined | false | true* -*Defined in [index.ts:734](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L734)* +*Defined in [index.ts:736](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L736)*
@@ -1954,7 +1948,7 @@ ___ • **name**: *"solc"* -*Defined in [index.ts:655](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L655)* +*Defined in [index.ts:656](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L656)* ___ @@ -1962,7 +1956,7 @@ ___ • **settings**: *[CompilerSettings](#class-compilersettings)* -*Defined in [index.ts:657](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L657)* +*Defined in [index.ts:658](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L658)* ___ @@ -1970,7 +1964,7 @@ ___ • **version**: *string* -*Defined in [index.ts:656](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L656)* +*Defined in [index.ts:657](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L657)*
@@ -1983,7 +1977,7 @@ ___ • **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"* -*Defined in [index.ts:689](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L689)* +*Defined in [index.ts:690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L690)* ___ @@ -1991,7 +1985,7 @@ ___ • **libraries**? : *undefined | object* -*Defined in [index.ts:691](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L691)* +*Defined in [index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L692)* ___ @@ -1999,7 +1993,7 @@ ___ • **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* -*Defined in [index.ts:690](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L690)* +*Defined in [index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L691)* ___ @@ -2007,7 +2001,7 @@ ___ • **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* -*Defined in [index.ts:688](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L688)* +*Defined in [index.ts:689](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L689)* ___ @@ -2015,7 +2009,7 @@ ___ • **outputSelection**: *object* -*Defined in [index.ts:696](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L696)* +*Defined in [index.ts:697](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L697)* #### Type declaration: @@ -2029,7 +2023,7 @@ ___ • **remappings**? : *string[]* -*Defined in [index.ts:687](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L687)* +*Defined in [index.ts:688](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L688)*
@@ -2042,7 +2036,7 @@ ___ • **useLiteralContent**: *true* -*Defined in [index.ts:704](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L704)* +*Defined in [index.ts:705](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L705)*
@@ -2055,7 +2049,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L103)* +*Defined in [index.ts:103](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L103)* ___ @@ -2063,7 +2057,7 @@ ___ • **payable**: *boolean* -*Defined in [index.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L104)* +*Defined in [index.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L104)* ___ @@ -2071,7 +2065,7 @@ ___ • **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -*Defined in [index.ts:105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L105)* +*Defined in [index.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L105)* ___ @@ -2079,7 +2073,7 @@ ___ • **type**: *string* -*Defined in [index.ts:102](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L102)* +*Defined in [index.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L102)*
@@ -2104,7 +2098,7 @@ If any of the sources change, the hash would change notifying us that a re-compi • **chains**: *[ContractChains](#class-contractchains)* -*Defined in [index.ts:676](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L676)* +*Defined in [index.ts:677](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L677)* ___ @@ -2114,7 +2108,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[compiler](#compiler)* -*Defined in [index.ts:641](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L641)* +*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L642)* ___ @@ -2124,7 +2118,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[compilerOutput](#compileroutput)* -*Defined in [index.ts:651](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L651)* +*Defined in [index.ts:652](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L652)* ___ @@ -2132,7 +2126,7 @@ ___ • **contractName**: *string* -*Defined in [index.ts:675](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L675)* +*Defined in [index.ts:676](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L676)* ___ @@ -2140,7 +2134,7 @@ ___ • **schemaVersion**: *string* -*Defined in [index.ts:674](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L674)* +*Defined in [index.ts:675](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L675)* ___ @@ -2150,7 +2144,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceCodes](#sourcecodes)* -*Defined in [index.ts:647](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L647)* +*Defined in [index.ts:648](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L648)* #### Type declaration: @@ -2164,7 +2158,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sourceTreeHashHex](#sourcetreehashhex)* -*Defined in [index.ts:650](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L650)* +*Defined in [index.ts:651](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L651)* ___ @@ -2174,7 +2168,7 @@ ___ *Inherited from [ContractVersionData](#interface-contractversiondata).[sources](#sources)* -*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L642)* +*Defined in [index.ts:643](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L643)* #### Type declaration: @@ -2191,7 +2185,7 @@ ___ • **address**: *string* -*Defined in [index.ts:554](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L554)* +*Defined in [index.ts:555](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L555)* ___ @@ -2199,7 +2193,7 @@ Args • **constructorArgs**: *string* -*Defined in [index.ts:558](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L558)* +*Defined in [index.ts:559](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L559)* ___ @@ -2207,7 +2201,7 @@ ___ • **links**: *object* -*Defined in [index.ts:555](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L555)* +*Defined in [index.ts:556](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L556)* #### Type declaration: @@ -2231,7 +2225,7 @@ ___ • **compiler**: *[CompilerOpts](#class-compileropts)* -*Defined in [index.ts:641](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L641)* +*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L642)* ___ @@ -2239,7 +2233,7 @@ ___ • **compilerOutput**: *[StandardContractOutput](#class-standardcontractoutput)* -*Defined in [index.ts:651](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L651)* +*Defined in [index.ts:652](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L652)* ___ @@ -2247,7 +2241,7 @@ ___ • **sourceCodes**: *object* -*Defined in [index.ts:647](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L647)* +*Defined in [index.ts:648](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L648)* #### Type declaration: @@ -2259,7 +2253,7 @@ ___ • **sourceTreeHashHex**: *string* -*Defined in [index.ts:650](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L650)* +*Defined in [index.ts:651](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L651)* ___ @@ -2267,7 +2261,7 @@ ___ • **sources**: *object* -*Defined in [index.ts:642](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L642)* +*Defined in [index.ts:643](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L643)* #### Type declaration: @@ -2284,7 +2278,15 @@ ___ • **components**? : *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L137)* +*Defined in [index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)* + +___ + +### `Optional` internalType + +• **internalType**? : *undefined | string* + +*Defined in [index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -2292,7 +2294,7 @@ ___ • **name**: *string* -*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -2300,7 +2302,7 @@ ___ • **type**: *string* -*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -2320,7 +2322,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -2328,7 +2330,7 @@ ___ • **args**: *`A`* -*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L417)* +*Defined in [index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* ___ @@ -2338,7 +2340,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -2348,7 +2350,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -2358,7 +2360,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -2366,7 +2368,7 @@ ___ • **event**: *string* -*Defined in [index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L416)* +*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* ___ @@ -2376,7 +2378,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -2386,7 +2388,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -2396,7 +2398,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -2406,7 +2408,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -2425,7 +2427,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -2435,7 +2437,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L417)* +*Defined in [index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* ___ @@ -2445,7 +2447,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -2455,7 +2457,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -2465,7 +2467,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -2475,7 +2477,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L416)* +*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* ___ @@ -2485,7 +2487,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -2493,7 +2495,7 @@ ___ • **removed**: *boolean* -*Defined in [index.ts:421](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L421)* +*Defined in [index.ts:422](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L422)* ___ @@ -2503,7 +2505,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -2513,7 +2515,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -2523,7 +2525,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -2536,7 +2538,7 @@ ___ • **author**? : *undefined | string* -*Defined in [index.ts:628](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L628)* +*Defined in [index.ts:629](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L629)* ___ @@ -2544,7 +2546,7 @@ ___ • **methods**: *object* -*Defined in [index.ts:629](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L629)* +*Defined in [index.ts:630](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L630)* #### Type declaration: @@ -2556,7 +2558,7 @@ ___ • **title**? : *undefined | string* -*Defined in [index.ts:627](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L627)* +*Defined in [index.ts:628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L628)*
@@ -2569,7 +2571,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [index.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L73)* +*Defined in [index.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -2577,7 +2579,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [index.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L75)* +*Defined in [index.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -2601,7 +2603,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [index.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L74)* +*Defined in [index.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -2623,7 +2625,7 @@ Name | Type | • **anonymous**: *boolean* -*Defined in [index.ts:131](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L131)* +*Defined in [index.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L131)* ___ @@ -2631,7 +2633,7 @@ ___ • **inputs**: *[EventParameter](#class-eventparameter)[]* -*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L130)* +*Defined in [index.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L130)* ___ @@ -2639,7 +2641,7 @@ ___ • **name**: *string* -*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L129)* +*Defined in [index.ts:129](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L129)* ___ @@ -2647,7 +2649,7 @@ ___ • **type**: *string* -*Defined in [index.ts:128](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L128)* +*Defined in [index.ts:128](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L128)*
@@ -2662,7 +2664,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[components](#optional-components)* -*Defined in [index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L137)* +*Defined in [index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)* ___ @@ -2670,7 +2672,17 @@ ___ • **indexed**: *boolean* -*Defined in [index.ts:116](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L116)* +*Defined in [index.ts:116](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L116)* + +___ + +### `Optional` internalType + +• **internalType**? : *undefined | string* + +*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)* + +*Defined in [index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -2680,7 +2692,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -2690,7 +2702,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -2703,7 +2715,7 @@ ___ • **object**: *string* -*Defined in [index.ts:622](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L622)* +*Defined in [index.ts:623](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L623)* ___ @@ -2711,7 +2723,7 @@ ___ • **sourceMap**: *string* -*Defined in [index.ts:623](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L623)* +*Defined in [index.ts:624](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L624)*
@@ -2724,7 +2736,7 @@ ___ • **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [index.ts:617](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L617)* +*Defined in [index.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L618)* ___ @@ -2732,7 +2744,7 @@ ___ • **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [index.ts:618](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L618)* +*Defined in [index.ts:619](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L619)*
@@ -2745,7 +2757,7 @@ ___ • **payable**: *boolean* -*Defined in [index.ts:112](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L112)* +*Defined in [index.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L112)* ___ @@ -2753,7 +2765,7 @@ ___ • **type**: *string* -*Defined in [index.ts:111](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L111)* +*Defined in [index.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L111)*
@@ -2766,7 +2778,7 @@ ___ • **address**? : *undefined | string* -*Defined in [index.ts:409](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L409)* +*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L410)* ___ @@ -2774,7 +2786,7 @@ ___ • **blockHash**? : *undefined | string* -*Defined in [index.ts:408](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L408)* +*Defined in [index.ts:409](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L409)* ___ @@ -2782,7 +2794,7 @@ ___ • **fromBlock**? : *number | string* -*Defined in [index.ts:406](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L406)* +*Defined in [index.ts:407](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L407)* ___ @@ -2790,7 +2802,7 @@ ___ • **toBlock**? : *number | string* -*Defined in [index.ts:407](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L407)* +*Defined in [index.ts:408](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L408)* ___ @@ -2798,29 +2810,44 @@ ___ • **topics**? : *[LogTopic](#logtopic)[]* -*Defined in [index.ts:410](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L410)* +*Defined in [index.ts:411](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L411)*
-# Interface: GanacheProvider +# Enumeration: AbiType -## Methods +## Enumeration members -### sendAsync +### Constructor -▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* +• **Constructor**: = "constructor" -*Defined in [index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L14)* +*Defined in [index.ts:464](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L464)* -**Parameters:** +___ -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | +### Event -**Returns:** *void* +• **Event**: = "event" + +*Defined in [index.ts:465](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L465)* + +___ + +### Fallback + +• **Fallback**: = "fallback" + +*Defined in [index.ts:466](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L466)* + +___ + +### Function + +• **Function**: = "function" + +*Defined in [index.ts:463](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L463)*
@@ -2833,7 +2860,7 @@ Name | Type | • **name**: *"solc"* -*Defined in [index.ts:680](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L680)* +*Defined in [index.ts:681](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L681)* ___ @@ -2841,7 +2868,7 @@ ___ • **settings**: *[CompilerSettings](#class-compilersettings)* -*Defined in [index.ts:682](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L682)* +*Defined in [index.ts:683](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L683)* ___ @@ -2849,7 +2876,7 @@ ___ • **version**: *string* -*Defined in [index.ts:681](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L681)* +*Defined in [index.ts:682](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L682)*
@@ -2862,7 +2889,7 @@ ___ • **id**: *number* -*Defined in [index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)* +*Defined in [index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* ___ @@ -2870,7 +2897,7 @@ ___ • **jsonrpc**: *string* -*Defined in [index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)* +*Defined in [index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* ___ @@ -2878,7 +2905,7 @@ ___ • **method**: *string* -*Defined in [index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)* +*Defined in [index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* ___ @@ -2886,7 +2913,7 @@ ___ • **params**: *any[]* -*Defined in [index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)* +*Defined in [index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
@@ -2899,7 +2926,7 @@ ___ • **code**: *number* -*Defined in [index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)* +*Defined in [index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* ___ @@ -2907,7 +2934,7 @@ ___ • **message**: *string* -*Defined in [index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)* +*Defined in [index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
@@ -2920,7 +2947,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)* +*Defined in [index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* ___ @@ -2928,7 +2955,7 @@ ___ • **id**: *number* -*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)* +*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* ___ @@ -2936,7 +2963,7 @@ ___ • **jsonrpc**: *string* -*Defined in [index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)* +*Defined in [index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* ___ @@ -2944,7 +2971,7 @@ ___ • **result**: *any* -*Defined in [index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)* +*Defined in [index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
@@ -2957,7 +2984,7 @@ ___ • **address**: *string* -*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -2965,7 +2992,7 @@ ___ • **blockHash**: *string | null* -*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -2973,7 +3000,7 @@ ___ • **blockNumber**: *number | null* -*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -2981,7 +3008,7 @@ ___ • **data**: *string* -*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -2989,7 +3016,7 @@ ___ • **logIndex**: *number | null* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -2997,7 +3024,7 @@ ___ • **topics**: *string[]* -*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -3005,7 +3032,7 @@ ___ • **transactionHash**: *string* -*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -3013,7 +3040,7 @@ ___ • **transactionIndex**: *number | null* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -3028,7 +3055,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -3038,7 +3065,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -3048,7 +3075,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -3058,7 +3085,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -3068,7 +3095,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -3076,7 +3103,7 @@ ___ • **removed**: *boolean* -*Defined in [index.ts:425](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L425)* +*Defined in [index.ts:426](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L426)* ___ @@ -3086,7 +3113,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -3096,7 +3123,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -3106,7 +3133,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -3125,7 +3152,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -3135,7 +3162,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L417)* +*Defined in [index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* ___ @@ -3145,7 +3172,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -3155,7 +3182,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -3165,7 +3192,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -3175,7 +3202,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L416)* +*Defined in [index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* ___ @@ -3185,7 +3212,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -3195,7 +3222,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -3205,7 +3232,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -3215,7 +3242,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -3228,7 +3255,7 @@ ___ • **constant**: *boolean* -*Defined in [index.ts:94](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L94)* +*Defined in [index.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L94)* ___ @@ -3236,7 +3263,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:92](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L92)* +*Defined in [index.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L92)* ___ @@ -3244,7 +3271,7 @@ ___ • **name**: *string* -*Defined in [index.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L91)* +*Defined in [index.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L91)* ___ @@ -3252,7 +3279,7 @@ ___ • **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:93](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L93)* +*Defined in [index.ts:93](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L93)* ___ @@ -3260,7 +3287,7 @@ ___ • **payable**: *boolean* -*Defined in [index.ts:96](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L96)* +*Defined in [index.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L96)* ___ @@ -3268,7 +3295,7 @@ ___ • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [index.ts:95](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L95)* +*Defined in [index.ts:95](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L95)* ___ @@ -3276,7 +3303,7 @@ ___ • **type**: *string* -*Defined in [index.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L90)* +*Defined in [index.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L90)*
@@ -3289,7 +3316,7 @@ ___ • **enabled**: *boolean* -*Defined in [index.ts:708](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L708)* +*Defined in [index.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L709)* ___ @@ -3297,7 +3324,7 @@ ___ • **runs**? : *undefined | number* -*Defined in [index.ts:709](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L709)* +*Defined in [index.ts:710](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L710)*
@@ -3310,7 +3337,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L20)* +*Defined in [index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L20)* **Parameters:** @@ -3332,7 +3359,7 @@ Name | Type | • **address**: *string* -*Defined in [index.ts:491](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L491)* +*Defined in [index.ts:492](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L492)* ___ @@ -3340,7 +3367,7 @@ ___ • **blockHash**: *string | null* -*Defined in [index.ts:489](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L489)* +*Defined in [index.ts:490](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L490)* ___ @@ -3348,7 +3375,7 @@ ___ • **blockNumber**: *string | null* -*Defined in [index.ts:490](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L490)* +*Defined in [index.ts:491](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L491)* ___ @@ -3356,7 +3383,7 @@ ___ • **data**: *string* -*Defined in [index.ts:492](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L492)* +*Defined in [index.ts:493](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L493)* ___ @@ -3364,7 +3391,7 @@ ___ • **logIndex**: *string | null* -*Defined in [index.ts:486](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L486)* +*Defined in [index.ts:487](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L487)* ___ @@ -3372,7 +3399,7 @@ ___ • **topics**: *string[]* -*Defined in [index.ts:493](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L493)* +*Defined in [index.ts:494](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L494)* ___ @@ -3380,7 +3407,7 @@ ___ • **transactionHash**: *string* -*Defined in [index.ts:488](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L488)* +*Defined in [index.ts:489](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L489)* ___ @@ -3388,7 +3415,7 @@ ___ • **transactionIndex**: *string | null* -*Defined in [index.ts:487](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L487)* +*Defined in [index.ts:488](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L488)*
@@ -3401,7 +3428,7 @@ ___ • **arguments**? : *[DataItem](#class-dataitem)[]* -*Defined in [index.ts:122](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L122)* +*Defined in [index.ts:122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L122)* ___ @@ -3409,7 +3436,7 @@ ___ • **name**: *string* -*Defined in [index.ts:121](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L121)* +*Defined in [index.ts:121](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L121)* ___ @@ -3417,7 +3444,7 @@ ___ • **type**: *"error"* -*Defined in [index.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L120)* +*Defined in [index.ts:120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L120)*
@@ -3430,7 +3457,7 @@ ___ • **component**: *"general" | "ewasm"* -*Defined in [index.ts:604](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L604)* +*Defined in [index.ts:605](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L605)* ___ @@ -3438,7 +3465,7 @@ ___ • **formattedMessage**? : *undefined | string* -*Defined in [index.ts:607](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L607)* +*Defined in [index.ts:608](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L608)* ___ @@ -3446,7 +3473,7 @@ ___ • **message**: *string* -*Defined in [index.ts:606](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L606)* +*Defined in [index.ts:607](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L607)* ___ @@ -3454,7 +3481,7 @@ ___ • **severity**: *[ErrorSeverity](#errorseverity)* -*Defined in [index.ts:605](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L605)* +*Defined in [index.ts:606](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L606)* ___ @@ -3462,7 +3489,7 @@ ___ • **sourceLocation**? : *[SourceLocation](#class-sourcelocation)* -*Defined in [index.ts:602](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L602)* +*Defined in [index.ts:603](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L603)* ___ @@ -3470,7 +3497,7 @@ ___ • **type**: *[ErrorType](#errortype)* -*Defined in [index.ts:603](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L603)* +*Defined in [index.ts:604](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L604)*
@@ -3483,7 +3510,7 @@ ___ • **id**: *number* -*Defined in [index.ts:713](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L713)* +*Defined in [index.ts:714](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L714)*
@@ -3496,7 +3523,7 @@ ___ • **end**: *number* -*Defined in [index.ts:613](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L613)* +*Defined in [index.ts:614](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L614)* ___ @@ -3504,7 +3531,7 @@ ___ • **file**: *string* -*Defined in [index.ts:611](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L611)* +*Defined in [index.ts:612](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L612)* ___ @@ -3512,7 +3539,7 @@ ___ • **start**: *number* -*Defined in [index.ts:612](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L612)* +*Defined in [index.ts:613](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L613)*
@@ -3525,7 +3552,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [index.ts:564](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L564)* +*Defined in [index.ts:565](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L565)* ___ @@ -3533,7 +3560,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [index.ts:566](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L566)* +*Defined in [index.ts:567](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L567)* ___ @@ -3541,7 +3568,7 @@ ___ • **evm**: *[EvmOutput](#class-evmoutput)* -*Defined in [index.ts:565](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L565)* +*Defined in [index.ts:566](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L566)*
@@ -3554,7 +3581,7 @@ ___ • **contracts**: *object* -*Defined in [index.ts:578](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L578)* +*Defined in [index.ts:579](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L579)* #### Type declaration: @@ -3568,7 +3595,7 @@ ___ • **errors**: *[SolcError](#class-solcerror)[]* -*Defined in [index.ts:570](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L570)* +*Defined in [index.ts:571](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L571)* ___ @@ -3576,7 +3603,7 @@ ___ • **sources**: *object* -*Defined in [index.ts:571](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L571)* +*Defined in [index.ts:572](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L572)* #### Type declaration: @@ -3593,7 +3620,7 @@ ___ • **depth**: *number* -*Defined in [index.ts:293](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L293)* +*Defined in [index.ts:294](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L294)* ___ @@ -3601,7 +3628,7 @@ ___ • **error**: *string* -*Defined in [index.ts:294](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L294)* +*Defined in [index.ts:295](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L295)* ___ @@ -3609,7 +3636,7 @@ ___ • **gas**: *number* -*Defined in [index.ts:295](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L295)* +*Defined in [index.ts:296](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L296)* ___ @@ -3617,7 +3644,7 @@ ___ • **gasCost**: *number* -*Defined in [index.ts:296](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L296)* +*Defined in [index.ts:297](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L297)* ___ @@ -3625,7 +3652,7 @@ ___ • **memory**: *string[]* -*Defined in [index.ts:297](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L297)* +*Defined in [index.ts:298](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L298)* ___ @@ -3633,7 +3660,7 @@ ___ • **op**: *[OpCode](#enumeration-opcode)* -*Defined in [index.ts:298](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L298)* +*Defined in [index.ts:299](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L299)* ___ @@ -3641,7 +3668,7 @@ ___ • **pc**: *number* -*Defined in [index.ts:299](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L299)* +*Defined in [index.ts:300](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L300)* ___ @@ -3649,7 +3676,7 @@ ___ • **stack**: *string[]* -*Defined in [index.ts:300](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L300)* +*Defined in [index.ts:301](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L301)* ___ @@ -3657,7 +3684,7 @@ ___ • **storage**: *object* -*Defined in [index.ts:301](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L301)* +*Defined in [index.ts:302](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L302)* #### Type declaration: @@ -3674,7 +3701,7 @@ ___ • **disableMemory**? : *undefined | false | true* -*Defined in [index.ts:518](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L518)* +*Defined in [index.ts:519](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L519)* ___ @@ -3682,7 +3709,7 @@ ___ • **disableStack**? : *undefined | false | true* -*Defined in [index.ts:519](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L519)* +*Defined in [index.ts:520](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L520)* ___ @@ -3690,7 +3717,7 @@ ___ • **disableStorage**? : *undefined | false | true* -*Defined in [index.ts:520](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L520)* +*Defined in [index.ts:521](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L521)* ___ @@ -3698,7 +3725,7 @@ ___ • **timeout**? : *undefined | string* -*Defined in [index.ts:522](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L522)* +*Defined in [index.ts:523](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L523)* ___ @@ -3706,7 +3733,7 @@ ___ • **tracer**? : *undefined | string* -*Defined in [index.ts:521](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L521)* +*Defined in [index.ts:522](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L522)*
@@ -3719,7 +3746,7 @@ ___ • **blockHash**: *string | null* -*Defined in [index.ts:377](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L377)* +*Defined in [index.ts:378](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L378)* ___ @@ -3727,7 +3754,7 @@ ___ • **blockNumber**: *number | null* -*Defined in [index.ts:378](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L378)* +*Defined in [index.ts:379](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L379)* ___ @@ -3735,7 +3762,7 @@ ___ • **from**: *string* -*Defined in [index.ts:380](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L380)* +*Defined in [index.ts:381](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L381)* ___ @@ -3743,7 +3770,7 @@ ___ • **gas**: *number* -*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L384)* +*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L385)* ___ @@ -3751,7 +3778,7 @@ ___ • **gasPrice**: *`BigNumber`* -*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L383)* +*Defined in [index.ts:384](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L384)* ___ @@ -3759,7 +3786,7 @@ ___ • **hash**: *string* -*Defined in [index.ts:375](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L375)* +*Defined in [index.ts:376](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L376)* ___ @@ -3767,7 +3794,7 @@ ___ • **input**: *string* -*Defined in [index.ts:385](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L385)* +*Defined in [index.ts:386](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L386)* ___ @@ -3775,7 +3802,7 @@ ___ • **nonce**: *number* -*Defined in [index.ts:376](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L376)* +*Defined in [index.ts:377](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L377)* ___ @@ -3783,7 +3810,7 @@ ___ • **to**: *string | null* -*Defined in [index.ts:381](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L381)* +*Defined in [index.ts:382](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L382)* ___ @@ -3791,7 +3818,7 @@ ___ • **transactionIndex**: *number | null* -*Defined in [index.ts:379](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L379)* +*Defined in [index.ts:380](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L380)* ___ @@ -3799,7 +3826,7 @@ ___ • **value**: *`BigNumber`* -*Defined in [index.ts:382](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L382)* +*Defined in [index.ts:383](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L383)*
@@ -3812,7 +3839,7 @@ ___ • **blockHash**: *string* -*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L448)* +*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L449)* ___ @@ -3820,7 +3847,7 @@ ___ • **blockNumber**: *number* -*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L449)* +*Defined in [index.ts:450](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L450)* ___ @@ -3828,7 +3855,7 @@ ___ • **contractAddress**: *string | null* -*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L457)* +*Defined in [index.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L458)* ___ @@ -3836,7 +3863,7 @@ ___ • **cumulativeGasUsed**: *number* -*Defined in [index.ts:455](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L455)* +*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L456)* ___ @@ -3844,7 +3871,7 @@ ___ • **from**: *string* -*Defined in [index.ts:452](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L452)* +*Defined in [index.ts:453](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L453)* ___ @@ -3852,7 +3879,7 @@ ___ • **gasUsed**: *number* -*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L456)* +*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L457)* ___ @@ -3860,7 +3887,7 @@ ___ • **logs**: *[LogEntry](#class-logentry)[]* -*Defined in [index.ts:458](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L458)* +*Defined in [index.ts:459](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L459)* ___ @@ -3868,7 +3895,7 @@ ___ • **status**: *[TransactionReceiptStatus](#transactionreceiptstatus)* -*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L454)* +*Defined in [index.ts:455](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L455)* ___ @@ -3876,7 +3903,7 @@ ___ • **to**: *string* -*Defined in [index.ts:453](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L453)* +*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L454)* ___ @@ -3884,7 +3911,7 @@ ___ • **transactionHash**: *string* -*Defined in [index.ts:450](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L450)* +*Defined in [index.ts:451](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L451)* ___ @@ -3892,7 +3919,7 @@ ___ • **transactionIndex**: *number* -*Defined in [index.ts:451](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L451)* +*Defined in [index.ts:452](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L452)*
@@ -3911,7 +3938,7 @@ otherwise we don't. *Inherited from [TransactionReceipt](#interface-transactionreceipt).[blockHash](#blockhash)* -*Defined in [index.ts:448](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L448)* +*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L449)* ___ @@ -3921,7 +3948,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[blockNumber](#blocknumber)* -*Defined in [index.ts:449](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L449)* +*Defined in [index.ts:450](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L450)* ___ @@ -3931,7 +3958,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[contractAddress](#contractaddress)* -*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L457)* +*Defined in [index.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L458)* ___ @@ -3941,7 +3968,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[cumulativeGasUsed](#cumulativegasused)* -*Defined in [index.ts:455](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L455)* +*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L456)* ___ @@ -3951,7 +3978,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[from](#from)* -*Defined in [index.ts:452](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L452)* +*Defined in [index.ts:453](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L453)* ___ @@ -3961,7 +3988,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[gasUsed](#gasused)* -*Defined in [index.ts:456](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L456)* +*Defined in [index.ts:457](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L457)* ___ @@ -3971,7 +3998,7 @@ ___ *Overrides [TransactionReceipt](_index_.transactionreceipt.md).[logs](#logs)* -*Defined in [index.ts:514](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L514)* +*Defined in [index.ts:515](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L515)* ___ @@ -3981,7 +4008,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[status](#status)* -*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L454)* +*Defined in [index.ts:455](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L455)* ___ @@ -3991,7 +4018,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[to](#to)* -*Defined in [index.ts:453](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L453)* +*Defined in [index.ts:454](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L454)* ___ @@ -4001,7 +4028,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[transactionHash](#transactionhash)* -*Defined in [index.ts:450](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L450)* +*Defined in [index.ts:451](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L451)* ___ @@ -4011,7 +4038,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[transactionIndex](#transactionindex)* -*Defined in [index.ts:451](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L451)* +*Defined in [index.ts:452](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L452)*
@@ -4024,7 +4051,7 @@ ___ • **gas**: *number* -*Defined in [index.ts:305](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L305)* +*Defined in [index.ts:306](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L306)* ___ @@ -4032,7 +4059,7 @@ ___ • **returnValue**: *any* -*Defined in [index.ts:306](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L306)* +*Defined in [index.ts:307](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L307)* ___ @@ -4040,7 +4067,7 @@ ___ • **structLogs**: *[StructLog](#class-structlog)[]* -*Defined in [index.ts:307](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L307)* +*Defined in [index.ts:308](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L308)*
@@ -4055,7 +4082,17 @@ ___ *Overrides [DataItem](_index_.dataitem.md).[components](#optional-components)* -*Defined in [index.ts:141](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L141)* +*Defined in [index.ts:142](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L142)* + +___ + +### `Optional` internalType + +• **internalType**? : *undefined | string* + +*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)* + +*Defined in [index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -4065,7 +4102,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +*Defined in [index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -4075,7 +4112,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +*Defined in [index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -4090,7 +4127,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ @@ -4098,7 +4135,7 @@ ___ • **from**: *string* -*Defined in [index.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L398)* +*Defined in [index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* ___ @@ -4108,7 +4145,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* ___ @@ -4118,7 +4155,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ @@ -4128,7 +4165,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +*Defined in [index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ @@ -4138,7 +4175,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ @@ -4148,7 +4185,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L390)* +*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)*
@@ -4163,7 +4200,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ @@ -4173,7 +4210,7 @@ ___ *Inherited from [TxData](#interface-txdata).[from](#from)* -*Defined in [index.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L398)* +*Defined in [index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* ___ @@ -4183,7 +4220,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* ___ @@ -4193,7 +4230,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ @@ -4203,7 +4240,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +*Defined in [index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ @@ -4213,7 +4250,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +*Defined in [index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ @@ -4223,7 +4260,7 @@ ___ *Overrides [CallTxDataBase](_index_.calltxdatabase.md).[value](#optional-value)* -*Defined in [index.ts:442](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L442)* +*Defined in [index.ts:443](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L443)*
@@ -4240,7 +4277,7 @@ This interface allowed sending synchonous requests, support for which was later ▸ **send**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* -*Defined in [index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L45)* +*Defined in [index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -4256,7 +4293,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L44)* +*Defined in [index.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -4282,7 +4319,7 @@ before the first attempts to conform to EIP1193 ▸ **send**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L54)* +*Defined in [index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -4308,7 +4345,7 @@ however it does not conform entirely. ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [index.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L63)* +*Defined in [index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -4334,7 +4371,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [index.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L31)* +*Defined in [index.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L31)* ___ @@ -4342,7 +4379,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [index.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L32)* +*Defined in [index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L32)* ___ @@ -4350,7 +4387,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [index.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L30)* +*Defined in [index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -4358,7 +4395,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [index.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L34)* +*Defined in [index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -4368,7 +4405,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [index.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L35)* +*Defined in [index.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -4385,7 +4422,7 @@ ___ ▸ **stop**(): *void* -*Defined in [index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L33)* +*Defined in [index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -4400,7 +4437,7 @@ ___ Ƭ **AbiDefinition**: *[FunctionAbi](_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)* -*Defined in [index.ts:80](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L80)* +*Defined in [index.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L80)* ___ @@ -4408,7 +4445,7 @@ ___ Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* -*Defined in [index.ts:483](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L483)* +*Defined in [index.ts:484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L484)* ___ @@ -4416,7 +4453,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [index.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L84)* +*Defined in [index.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L84)* ___ @@ -4424,7 +4461,7 @@ ___ Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* -*Defined in [index.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L78)* +*Defined in [index.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L78)* ___ @@ -4432,7 +4469,7 @@ ___ Ƭ **ContractEventArg**: *any* -*Defined in [index.ts:468](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L468)* +*Defined in [index.ts:469](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L469)* ___ @@ -4440,7 +4477,7 @@ ___ Ƭ **DecodedLogs**: *`Array>`* -*Defined in [index.ts:439](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L439)* +*Defined in [index.ts:440](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L440)* ___ @@ -4448,7 +4485,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [index.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L70)* +*Defined in [index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L70)* Interface for providers that conform to EIP 1193 Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md @@ -4459,7 +4496,7 @@ ___ Ƭ **ErrorSeverity**: *"error" | "warning"* -*Defined in [index.ts:599](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L599)* +*Defined in [index.ts:600](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L600)* ___ @@ -4467,7 +4504,7 @@ ___ Ƭ **ErrorType**: *"JSONError" | "IOError" | "ParserError" | "DocstringParsingError" | "SyntaxError" | "DeclarationError" | "TypeError" | "UnimplementedFeatureError" | "InternalCompilerError" | "Exception" | "CompilerError" | "FatalError" | "Warning"* -*Defined in [index.ts:585](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L585)* +*Defined in [index.ts:586](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L586)* ___ @@ -4475,7 +4512,7 @@ ___ Ƭ **FunctionAbi**: *[MethodAbi](#interface-methodabi) | [ConstructorAbi](#interface-constructorabi) | [FallbackAbi](#interface-fallbackabi)* -*Defined in [index.ts:82](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L82)* +*Defined in [index.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L82)* ___ @@ -4483,7 +4520,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [index.ts:3](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L3)* +*Defined in [index.ts:3](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -4502,7 +4539,7 @@ ___ Ƭ **LogTopic**: *null | string | string[]* -*Defined in [index.ts:413](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L413)* +*Defined in [index.ts:414](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L414)* ___ @@ -4510,7 +4547,7 @@ ___ Ƭ **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 [index.ts:525](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L525)* +*Defined in [index.ts:526](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L526)* ___ @@ -4518,7 +4555,7 @@ ___ Ƭ **ParamDescription**: *string* -*Defined in [index.ts:561](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L561)* +*Defined in [index.ts:562](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L562)* ___ @@ -4526,7 +4563,7 @@ ___ Ƭ **RawLog**: *[LogEntry](#interface-logentry)* -*Defined in [index.ts:475](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L475)* +*Defined in [index.ts:476](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L476)* ___ @@ -4534,7 +4571,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [index.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L85)* +*Defined in [index.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L85)* ___ @@ -4542,7 +4579,7 @@ ___ Ƭ **SupportedProvider**: *[Web3JsProvider](_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)* -*Defined in [index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L9)* +*Defined in [index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L9)* Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library Read more about Providers in the guides section of the 0x docs. @@ -4553,7 +4590,7 @@ ___ Ƭ **TransactionReceiptStatus**: *null | string | `0` | `1`* -*Defined in [index.ts:445](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L445)* +*Defined in [index.ts:446](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L446)* ___ @@ -4561,7 +4598,7 @@ ___ Ƭ **Unit**: *"kwei" | "ada" | "mwei" | "babbage" | "gwei" | "shannon" | "szabo" | "finney" | "ether" | "kether" | "grand" | "einstein" | "mether" | "gether" | "tether"* -*Defined in [index.ts:310](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L310)* +*Defined in [index.ts:311](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L311)* ___ @@ -4569,7 +4606,7 @@ ___ Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)* -*Defined in [index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L11)* +*Defined in [index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L11)*
diff --git a/packages/json-schemas/CHANGELOG.json b/packages/json-schemas/CHANGELOG.json index 7b1ef964bb..9b19e69f74 100644 --- a/packages/json-schemas/CHANGELOG.json +++ b/packages/json-schemas/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "4.1.0-beta.1", diff --git a/packages/json-schemas/CHANGELOG.md b/packages/json-schemas/CHANGELOG.md index 3e9379ad27..5f527e86c8 100644 --- a/packages/json-schemas/CHANGELOG.md +++ b/packages/json-schemas/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v4.1.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v4.1.0-beta.1 - _November 7, 2019_ * All references to network ID have been removed, and references to chain ID have been introduced instead (#2313) diff --git a/packages/json-schemas/docs/reference.mdx b/packages/json-schemas/docs/reference.mdx index e39a830ec7..4edbcbe0d0 100644 --- a/packages/json-schemas/docs/reference.mdx +++ b/packages/json-schemas/docs/reference.mdx @@ -9,7 +9,7 @@ A validator for [JSON-schemas](http://json-schema.org/) \+ **new SchemaValidator**(): *[SchemaValidator](#class-schemavalidator)* -*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/json-schemas/src/schema_validator.ts#L15)* +*Defined in [schema_validator.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/json-schemas/src/schema_validator.ts#L15)* Instantiates a SchemaValidator instance @@ -21,7 +21,7 @@ Instantiates a SchemaValidator instance ▸ **addSchema**(`schema`: `Schema`): *void* -*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/json-schemas/src/schema_validator.ts#L32)* +*Defined in [schema_validator.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/json-schemas/src/schema_validator.ts#L32)* Add a schema to the validator. All schemas and sub-schemas must be added to the validator before the `validate` and `isValid` methods can be called with @@ -41,7 +41,7 @@ ___ ▸ **isValid**(`instance`: any, `schema`: `Schema`): *boolean* -*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/json-schemas/src/schema_validator.ts#L57)* +*Defined in [schema_validator.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/json-schemas/src/schema_validator.ts#L57)* Check whether an instance properly adheres to a JSON schema @@ -62,7 +62,7 @@ ___ ▸ **validate**(`instance`: any, `schema`: `Schema`): *`ValidatorResult`* -*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/json-schemas/src/schema_validator.ts#L46)* +*Defined in [schema_validator.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/json-schemas/src/schema_validator.ts#L46)* Validate the JS object conforms to a specific JSON schema diff --git a/packages/migrations/CHANGELOG.json b/packages/migrations/CHANGELOG.json index 7d7d084f30..b4277a6a22 100644 --- a/packages/migrations/CHANGELOG.json +++ b/packages/migrations/CHANGELOG.json @@ -10,7 +10,8 @@ "note": "Added `Staking` and `ERC20BridgeProxy` contracts", "pr": 2323 } - ] + ], + "timestamp": 1574030254 }, { "version": "4.4.0-beta.1", diff --git a/packages/migrations/CHANGELOG.md b/packages/migrations/CHANGELOG.md index 0dca6758c8..f785876d0c 100644 --- a/packages/migrations/CHANGELOG.md +++ b/packages/migrations/CHANGELOG.md @@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v4.4.0-beta.2 - _November 17, 2019_ + + * Migrations script no longer deploys DutchAuction since it is not yet upgraded for V3 of the protocol (#2324) + * Added `Staking` and `ERC20BridgeProxy` contracts (#2323) + ## v4.4.0-beta.1 - _November 7, 2019_ * Update all contract deployments to pass the actual chain ID (rather than the network ID) via the newly modified @0x/utils/provider_utils (#2270) diff --git a/packages/migrations/docs/reference.mdx b/packages/migrations/docs/reference.mdx index 48d3543654..7a8cda8408 100644 --- a/packages/migrations/docs/reference.mdx +++ b/packages/migrations/docs/reference.mdx @@ -1,4 +1,24 @@ +# Interface: GanacheProvider + + +## Methods + +### sendAsync + +▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* + +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L14)* + +**Parameters:** + +Name | Type | +------ | ------ | +`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | +`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | + +**Returns:** *void* +
@@ -17,7 +37,7 @@ • **assetProxyOwner**: *string* -*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L12)* +*Defined in [contract-addresses/src/index.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L12)* ___ @@ -25,7 +45,7 @@ ___ • **coordinator**: *string* -*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L18)* +*Defined in [contract-addresses/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L18)* ___ @@ -33,7 +53,7 @@ ___ • **coordinatorRegistry**: *string* -*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L17)* +*Defined in [contract-addresses/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L17)* ___ @@ -41,7 +61,7 @@ ___ • **devUtils**: *string* -*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L22)* +*Defined in [contract-addresses/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L22)* ___ @@ -49,7 +69,7 @@ ___ • **dutchAuction**: *string* -*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L16)* +*Defined in [contract-addresses/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L16)* ___ @@ -57,7 +77,7 @@ ___ • **erc1155Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L21)* +*Defined in [contract-addresses/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L21)* ___ @@ -65,7 +85,7 @@ ___ • **erc20BridgeProxy**: *string* -*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L26)* +*Defined in [contract-addresses/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L26)* ___ @@ -73,7 +93,7 @@ ___ • **erc20Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L6)* +*Defined in [contract-addresses/src/index.ts:6](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L6)* ___ @@ -81,7 +101,7 @@ ___ • **erc721Proxy**: *string* -*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L7)* +*Defined in [contract-addresses/src/index.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L7)* ___ @@ -89,7 +109,7 @@ ___ • **etherToken**: *string* -*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L9)* +*Defined in [contract-addresses/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L9)* ___ @@ -97,7 +117,7 @@ ___ • **exchange**: *string* -*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L11)* +*Defined in [contract-addresses/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L11)* ___ @@ -105,7 +125,7 @@ ___ • **exchangeV2**: *string* -*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L10)* +*Defined in [contract-addresses/src/index.ts:10](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L10)* ___ @@ -113,7 +133,7 @@ ___ • **forwarder**: *string* -*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L14)* +*Defined in [contract-addresses/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L14)* ___ @@ -121,7 +141,7 @@ ___ • **multiAssetProxy**: *string* -*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L19)* +*Defined in [contract-addresses/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L19)* ___ @@ -129,7 +149,7 @@ ___ • **orderValidator**: *string* -*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L15)* +*Defined in [contract-addresses/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L15)* ___ @@ -137,7 +157,7 @@ ___ • **staking**: *string* -*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L24)* +*Defined in [contract-addresses/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L24)* ___ @@ -145,7 +165,7 @@ ___ • **stakingProxy**: *string* -*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L25)* +*Defined in [contract-addresses/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L25)* ___ @@ -153,7 +173,7 @@ ___ • **staticCallProxy**: *string* -*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L20)* +*Defined in [contract-addresses/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L20)* ___ @@ -161,7 +181,7 @@ ___ • **zeroExGovernor**: *string* -*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L13)* +*Defined in [contract-addresses/src/index.ts:13](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L13)* ___ @@ -169,7 +189,7 @@ ___ • **zrxToken**: *string* -*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L8)* +*Defined in [contract-addresses/src/index.ts:8](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L8)* ___ @@ -177,7 +197,7 @@ ___ • **zrxVault**: *string* -*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L23)* +*Defined in [contract-addresses/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L23)*
@@ -226,7 +246,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -234,7 +254,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -258,7 +278,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -283,28 +303,8 @@ Name | Type | -# 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/c93b02d55/packages/ethereum-types/src/index.ts#L14)* - -**Parameters:** - -Name | Type | ------- | ------ | -`payload` | [JSONRPCRequestPayload](#class-jsonrpcrequestpayload) | -`callback` | [JSONRPCErrorCallback](#jsonrpcerrorcallback) | - -**Returns:** *void* - -
- # Interface: JSONRPCRequestPayload @@ -316,7 +316,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* ___ @@ -324,7 +324,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* ___ @@ -332,7 +332,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* ___ @@ -340,7 +340,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
@@ -353,7 +353,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* ___ @@ -361,7 +361,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
@@ -374,7 +374,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* ___ @@ -382,7 +382,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* ___ @@ -390,7 +390,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* ___ @@ -398,7 +398,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
@@ -453,7 +453,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ @@ -461,7 +461,7 @@ ___ • **from**: *string* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L398)* +*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* ___ @@ -471,7 +471,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* ___ @@ -481,7 +481,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ @@ -491,7 +491,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ @@ -501,7 +501,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ @@ -511,7 +511,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)*
@@ -526,7 +526,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ @@ -536,7 +536,7 @@ ___ *Inherited from [TxData](#interface-txdata).[from](#from)* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L398)* +*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* ___ @@ -546,7 +546,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* ___ @@ -556,7 +556,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ @@ -566,7 +566,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ @@ -576,7 +576,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ @@ -586,7 +586,7 @@ ___ *Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L442)* +*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L443)*
@@ -603,7 +603,7 @@ This interface allowed sending synchonous requests, support for which was later ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* -*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -619,7 +619,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -645,7 +645,7 @@ before the first attempts to conform to EIP1193 ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -671,7 +671,7 @@ however it does not conform entirely. ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -697,7 +697,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L31)* ___ @@ -705,7 +705,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L32)* ___ @@ -713,7 +713,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -721,7 +721,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -731,7 +731,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -748,7 +748,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -757,13 +757,63 @@ ___ +## Functions + +### runMigrationsAsync + +▸ **runMigrationsAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `TxData`): *`Promise`* + +*Defined in [migrations/src/migration.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/migrations/src/migration.ts#L63)* + +Creates and deploys all the contracts that are required for the latest +version of the 0x protocol. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider instance. Your provider instance should connect to the testnet you want to deploy to. | +`txDefaults` | `TxData` | Default transaction values to use when deploying contracts (e.g., specify the desired contract creator with the `from` parameter). | + +**Returns:** *`Promise`* + +The addresses of the contracts that were deployed. + +___ + +### runMigrationsOnceAsync + +▸ **runMigrationsOnceAsync**(`provider`: `Web3ProviderEngine`, `txDefaults`: `TxData`): *`Promise`* + +*Defined in [migrations/src/migration.ts:321](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/migrations/src/migration.ts#L321)* + +Exactly like runMigrationsAsync but will only run the migrations the first +time it is called. Any subsequent calls will return the cached contract +addresses. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`provider` | `Web3ProviderEngine` | Web3 provider instance. Your provider instance should connect to the testnet you want to deploy to. | +`txDefaults` | `TxData` | Default transaction values to use when deploying contracts (e.g., specify the desired contract creator with the `from` parameter). | + +**Returns:** *`Promise`* + +The addresses of the contracts that were deployed. + +
+ + + + ## Functions ### getContractAddressesForChainOrThrow ▸ **getContractAddressesForChainOrThrow**(`chainId`: [ChainId](#enumeration-chainid)): *[ContractAddresses](#interface-contractaddresses)* -*Defined in [contract-addresses/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/contract-addresses/src/index.ts#L45)* +*Defined in [contract-addresses/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/contract-addresses/src/index.ts#L45)* Used to get addresses of contracts that have been deployed to either the Ethereum mainnet or a supported testnet. Throws if there are no known @@ -803,7 +853,7 @@ given chainId. Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L70)* Interface for providers that conform to EIP 1193 Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md @@ -820,7 +870,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -849,7 +899,7 @@ ___ Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)* -*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L9)* Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library Read more about Providers in the guides section of the 0x docs. @@ -864,57 +914,7 @@ ___ Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)* -*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L11)* - -
- - - - -## Functions - -### runMigrationsAsync - -▸ **runMigrationsAsync**(`supportedProvider`: [SupportedProvider](#supportedprovider), `txDefaults`: `TxData`): *`Promise`* - -*Defined in [migrations/src/migration.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/migrations/src/migration.ts#L49)* - -Creates and deploys all the contracts that are required for the latest -version of the 0x protocol. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider instance. Your provider instance should connect to the testnet you want to deploy to. | -`txDefaults` | `TxData` | Default transaction values to use when deploying contracts (e.g., specify the desired contract creator with the `from` parameter). | - -**Returns:** *`Promise`* - -The addresses of the contracts that were deployed. - -___ - -### runMigrationsOnceAsync - -▸ **runMigrationsOnceAsync**(`provider`: `Web3ProviderEngine`, `txDefaults`: `TxData`): *`Promise`* - -*Defined in [migrations/src/migration.ts:317](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/migrations/src/migration.ts#L317)* - -Exactly like runMigrationsAsync but will only run the migrations the first -time it is called. Any subsequent calls will return the cached contract -addresses. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`provider` | `Web3ProviderEngine` | Web3 provider instance. Your provider instance should connect to the testnet you want to deploy to. | -`txDefaults` | `TxData` | Default transaction values to use when deploying contracts (e.g., specify the desired contract creator with the `from` parameter). | - -**Returns:** *`Promise`* - -The addresses of the contracts that were deployed. +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L11)*
diff --git a/packages/order-utils/CHANGELOG.json b/packages/order-utils/CHANGELOG.json index d3985d5d77..2070a57573 100644 --- a/packages/order-utils/CHANGELOG.json +++ b/packages/order-utils/CHANGELOG.json @@ -18,7 +18,8 @@ "note": "Removed function isValidOrderHash from export orderHashUtils", "pr": 2321 } - ] + ], + "timestamp": 1574030254 }, { "version": "8.5.0-beta.1", diff --git a/packages/order-utils/CHANGELOG.md b/packages/order-utils/CHANGELOG.md index 9ca24c981b..7369784514 100644 --- a/packages/order-utils/CHANGELOG.md +++ b/packages/order-utils/CHANGELOG.md @@ -5,6 +5,13 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v8.5.0-beta.2 - _November 17, 2019_ + + * [Breaking] Removed `OrderStateUtils`, `OrderValidationUtils`, `ExchangeTransferSimulator` and all abstract and store classes. For order validation, please use the `DevUtils` contract wrapper method `getOrderRelevantState`|`getOrderRelevantStates` (#2324) + * Removed exports CoordinatorRevertErrors, ExchangeRevertErrors, ForwarderRevertErrors, LibMathRevertErrors, orderHashUtils, orderParsingUtils, StakingRevertErrors and transactionHashUtils (#2321) + * Removed many functions from export signatureUtils (#2321) + * Removed function isValidOrderHash from export orderHashUtils (#2321) + ## v8.5.0-beta.1 - _November 7, 2019_ * Remove `TransferFailedError` from `ForwarderRevertErrors`. (#2309) diff --git a/packages/order-utils/docs/reference.mdx b/packages/order-utils/docs/reference.mdx index 543fe662a9..38b7866881 100644 --- a/packages/order-utils/docs/reference.mdx +++ b/packages/order-utils/docs/reference.mdx @@ -1,1100 +1,10 @@ -# Class: AbstractBalanceAndProxyAllowanceFetcher -An abstract class to be implemented in order to use OrderStateUtils. The class that -implements this interface must be capable of fetching the balance and proxyAllowance -for an Ethereum address and assetData -## Methods - -### `Abstract` getBalanceAsync - -▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L15)* - -Get balance of assetData for userAddress - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData for which to fetch the balance | -`userAddress` | string | Ethereum address for which to fetch the balance | - -**Returns:** *`Promise`* - -Balance amount in base units - -___ - -### `Abstract` getProxyAllowanceAsync - -▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_fetcher.ts#L22)* - -Get the 0x asset proxy allowance of assetData for userAddress - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData for which to fetch the allowance | -`userAddress` | string | Ethereum address for which to fetch the allowance | - -**Returns:** *`Promise`* - -Allowance amount in base units - -
- -# Class: AbstractBalanceAndProxyAllowanceLazyStore - - -## Implemented by - -* [BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore) - - -## Methods - -### `Abstract` deleteAll - -▸ **deleteAll**(): *void* - -*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L10)* - -**Returns:** *void* - -___ - -### `Abstract` deleteBalance - -▸ **deleteBalance**(`assetData`: string, `userAddress`: string): *void* - -*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L7)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | - -**Returns:** *void* - -___ - -### `Abstract` deleteProxyAllowance - -▸ **deleteProxyAllowance**(`assetData`: string, `userAddress`: string): *void* - -*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L9)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | - -**Returns:** *void* - -___ - -### `Abstract` getBalanceAsync - -▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:4](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L4)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` getProxyAllowanceAsync - -▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L5)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` setBalance - -▸ **setBalance**(`assetData`: string, `userAddress`: string, `balance`: `BigNumber`): *void* - -*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L6)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | -`balance` | `BigNumber` | - -**Returns:** *void* - -___ - -### `Abstract` setProxyAllowance - -▸ **setProxyAllowance**(`assetData`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void* - -*Defined in [order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_balance_and_proxy_allowance_lazy_store.ts#L8)* - -**Parameters:** - -Name | Type | ------- | ------ | -`assetData` | string | -`userAddress` | string | -`proxyAllowance` | `BigNumber` | - -**Returns:** *void* - -
- -# Class: AbstractOrderFilledCancelledFetcher - -An abstract class to be implemented in order to use OrderStateUtils. The class that -implements this interface must be capable of fetching the amount filled of an order -and whether it's been cancelled. - - -## Methods - -### `Abstract` getFilledTakerAmountAsync - -▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* - -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L15)* - -Get the amount of the order's takerToken amount already filled - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash of order we are interested in | - -**Returns:** *`Promise`* - -FilledTakerAmount - -___ - -### `Abstract` isOrderCancelledAsync - -▸ **isOrderCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* - -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts#L21)* - -Whether an order is cancelled - -**Parameters:** - -Name | Type | ------- | ------ | -`signedOrder` | `SignedOrder` | - -**Returns:** *`Promise`* - -Whether or not the order is cancelled - -
- -# Class: AbstractOrderFilledCancelledLazyStore - - -## Implemented by - -* [OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore) - - -## Methods - -### `Abstract` deleteAll - -▸ **deleteAll**(): *void* - -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L11)* - -**Returns:** *void* - -___ - -### `Abstract` deleteFilledTakerAmount - -▸ **deleteFilledTakerAmount**(`orderHash`: string): *void* - -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:8](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L8)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | - -**Returns:** *void* - -___ - -### `Abstract` deleteIsCancelled - -▸ **deleteIsCancelled**(`orderHash`: string): *void* - -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:10](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L10)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | - -**Returns:** *void* - -___ - -### `Abstract` getFilledTakerAmountAsync - -▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* - -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:5](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L5)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | - -**Returns:** *`Promise`* - -___ - -### `Abstract` getIsCancelledAsync - -▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* - -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:6](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L6)* - -**Parameters:** - -Name | Type | ------- | ------ | -`signedOrder` | `SignedOrder` | - -**Returns:** *`Promise`* - -___ - -### `Abstract` setFilledTakerAmount - -▸ **setFilledTakerAmount**(`orderHash`: string, `balance`: `BigNumber`): *void* - -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L7)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | -`balance` | `BigNumber` | - -**Returns:** *void* - -___ - -### `Abstract` setIsCancelled - -▸ **setIsCancelled**(`orderHash`: string, `isCancelled`: boolean): *void* - -*Defined in [order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/abstract/abstract_order_filled_cancelled_lazy_store.ts#L9)* - -**Parameters:** - -Name | Type | ------- | ------ | -`orderHash` | string | -`isCancelled` | boolean | - -**Returns:** *void* - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -# Class: ExchangeTransferSimulator - -An exchange transfer simulator which simulates asset transfers exactly how the -0x exchange contract would do them. - - -## Constructors - - - -\+ **new ExchangeTransferSimulator**(`store`: [AbstractBalanceAndProxyAllowanceLazyStore](_order_utils_src_abstract_abstract_balance_and_proxy_allowance_lazy_store_.abstractbalanceandproxyallowancelazystore.md)): *[ExchangeTransferSimulator](#class-exchangetransfersimulator)* - -*Defined in [order-utils/src/exchange_transfer_simulator.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/exchange_transfer_simulator.ts#L50)* - -Instantiate a ExchangeTransferSimulator - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`store` | [AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) | A class that implements AbstractBalanceAndProxyAllowanceLazyStore | - -**Returns:** *[ExchangeTransferSimulator](#class-exchangetransfersimulator)* - -an instance of ExchangeTransferSimulator - -## Methods - -### transferFromAsync - -▸ **transferFromAsync**(`assetData`: string, `from`: string, `to`: string, `amountInBaseUnits`: `BigNumber`, `tradeSide`: [TradeSide](#enumeration-tradeside), `transferType`: [TransferType](#enumeration-transfertype)): *`Promise`* - -*Defined in [order-utils/src/exchange_transfer_simulator.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/exchange_transfer_simulator.ts#L70)* - -Simulates transferFrom call performed by a proxy - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | Data of the asset being transferred. Includes it's identifying information and assetType, e.g address for ERC20, address & tokenId for ERC721 | -`from` | string | Owner of the transferred tokens | -`to` | string | Recipient of the transferred tokens | -`amountInBaseUnits` | `BigNumber` | The amount of tokens being transferred | -`tradeSide` | [TradeSide](#enumeration-tradeside) | Is Maker/Taker transferring | -`transferType` | [TransferType](#enumeration-transfertype) | Is it a fee payment or a value transfer | - -**Returns:** *`Promise`* - -
- - - - - - - - - - - - - - - - - - - - - - - - - -# Class: OrderStateUtils - - -## Constructors - - - -\+ **new OrderStateUtils**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](_order_utils_src_abstract_abstract_balance_and_proxy_allowance_fetcher_.abstractbalanceandproxyallowancefetcher.md), `orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_order_utils_src_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md)): *[OrderStateUtils](#class-orderstateutils)* - -*Defined in [order-utils/src/order_state_utils.ts:103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_state_utils.ts#L103)* - -Instantiate OrderStateUtils - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`balanceAndProxyAllowanceFetcher` | [AbstractBalanceAndProxyAllowanceFetcher](#class-abstractbalanceandproxyallowancefetcher) | A class that is capable of fetching balances and proxyAllowances for Ethereum addresses. It must implement AbstractBalanceAndProxyAllowanceFetcher | -`orderFilledCancelledFetcher` | [AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) | A class that is capable of fetching whether an order is cancelled and how much of it has been filled. It must implement AbstractOrderFilledCancelledFetcher | - -**Returns:** *[OrderStateUtils](#class-orderstateutils)* - -Instance of OrderStateUtils - -## Methods - -### getMaxFillableTakerAssetAmountAsync - -▸ **getMaxFillableTakerAssetAmountAsync**(`signedOrder`: `SignedOrder`, `takerAddress`: string): *`Promise`* - -*Defined in [order-utils/src/order_state_utils.ts:197](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_state_utils.ts#L197)* - -Get the max amount of the supplied order's takerAmount that could still be filled - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrder` | `SignedOrder` | Order of interest | -`takerAddress` | string | Hypothetical taker of the order | - -**Returns:** *`Promise`* - -fillableTakerAssetAmount - -___ - -### getOpenOrderRelevantStateAsync - -▸ **getOpenOrderRelevantStateAsync**(`signedOrder`: `SignedOrder`): *`Promise`* - -*Defined in [order-utils/src/order_state_utils.ts:167](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_state_utils.ts#L167)* - -Get state relevant to an order (i.e makerBalance, makerAllowance, filledTakerAssetAmount, etc... - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrder` | `SignedOrder` | Order of interest | - -**Returns:** *`Promise`* - -An instance of OrderRelevantState - -___ - -### getOpenOrderStateAsync - -▸ **getOpenOrderStateAsync**(`signedOrder`: `SignedOrder`, `transactionHash?`: undefined | string): *`Promise`* - -*Defined in [order-utils/src/order_state_utils.ts:127](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_state_utils.ts#L127)* - -Get the orderState for an "open" order (i.e where takerAddress=NULL_ADDRESS) -This method will only check the maker's balance/allowance to calculate the -OrderState. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`signedOrder` | `SignedOrder` | The order of interest | -`transactionHash?` | undefined \| string | - | - -**Returns:** *`Promise`* - -State relevant to the signedOrder, as well as whether the signedOrder is "valid". -Validity is defined as a non-zero amount of the order can still be filled. - -
- -# Class: OrderValidationUtils - -A utility class for validating orders - - -## Constructors - - - -\+ **new OrderValidationUtils**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_order_utils_src_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md), `supportedProvider`: [SupportedProvider](#supportedprovider)): *[OrderValidationUtils](#class-ordervalidationutils)* - -*Defined in [order-utils/src/order_validation_utils.ts:113](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_validation_utils.ts#L113)* - -Instantiate OrderValidationUtils - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderFilledCancelledFetcher` | [AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) | A module that implements the AbstractOrderFilledCancelledFetcher | -`supportedProvider` | [SupportedProvider](#supportedprovider) | Web3 provider to use for JSON RPC calls | - -**Returns:** *[OrderValidationUtils](#class-ordervalidationutils)* - -An instance of OrderValidationUtils - -## Methods - -### validateFillOrderThrowIfInvalidAsync - -▸ **validateFillOrderThrowIfInvalidAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `takerAddress`: string): *`Promise`* - -*Defined in [order-utils/src/order_validation_utils.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_validation_utils.ts#L135)* - -Validate a call to FillOrder and throw if it wouldn't succeed - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`exchangeTradeEmulator` | [ExchangeTransferSimulator](#class-exchangetransfersimulator) | ExchangeTradeEmulator to use | -`signedOrder` | `SignedOrder` | SignedOrder of interest | -`fillTakerAssetAmount` | `BigNumber` | Amount we'd like to fill the order for | -`takerAddress` | string | The taker of the order | - -**Returns:** *`Promise`* - -___ - -### `Static` isRoundingErrorFloor - -▸ **isRoundingErrorFloor**(`numerator`: `BigNumber`, `denominator`: `BigNumber`, `target`: `BigNumber`): *boolean* - -*Defined in [order-utils/src/order_validation_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_validation_utils.ts#L27)* - -A TypeScript implementation mirroring the implementation of isRoundingError in the -Exchange smart contract - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`numerator` | `BigNumber` | Numerator value. When used to check an order, pass in `takerAssetFilledAmount` | -`denominator` | `BigNumber` | Denominator value. When used to check an order, pass in `order.takerAssetAmount` | -`target` | `BigNumber` | Target value. When used to check an order, pass in `order.makerAssetAmount` | - -**Returns:** *boolean* - -___ - -### `Static` validateFillOrderBalancesAllowancesThrowIfInvalidAsync - -▸ **validateFillOrderBalancesAllowancesThrowIfInvalidAsync**(`exchangeTradeEmulator`: [ExchangeTransferSimulator](#class-exchangetransfersimulator), `signedOrder`: `SignedOrder`, `fillTakerAssetAmount`: `BigNumber`, `senderAddress`: string): *`Promise`* - -*Defined in [order-utils/src/order_validation_utils.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_validation_utils.ts#L53)* - -Validate that the maker & taker have sufficient balances/allowances -to fill the supplied order to the fillTakerAssetAmount amount - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`exchangeTradeEmulator` | [ExchangeTransferSimulator](#class-exchangetransfersimulator) | ExchangeTradeEmulator to use | -`signedOrder` | `SignedOrder` | SignedOrder to test | -`fillTakerAssetAmount` | `BigNumber` | Amount of takerAsset to fill the signedOrder | -`senderAddress` | string | Sender of the fillOrder tx | - -**Returns:** *`Promise`* - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -# Class: BalanceAndProxyAllowanceLazyStore - -Copy on read store for balances/proxyAllowances of tokens/accounts - - -## Implements - -* [AbstractBalanceAndProxyAllowanceLazyStore](#class-abstractbalanceandproxyallowancelazystore) - - -## Constructors - - - -\+ **new BalanceAndProxyAllowanceLazyStore**(`balanceAndProxyAllowanceFetcher`: [AbstractBalanceAndProxyAllowanceFetcher](_order_utils_src_abstract_abstract_balance_and_proxy_allowance_fetcher_.abstractbalanceandproxyallowancefetcher.md)): *[BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore)* - -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L21)* - -Instantiates a BalanceAndProxyAllowanceLazyStore - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`balanceAndProxyAllowanceFetcher` | [AbstractBalanceAndProxyAllowanceFetcher](#class-abstractbalanceandproxyallowancefetcher) | Class the implements the AbstractBalanceAndProxyAllowanceFetcher | - -**Returns:** *[BalanceAndProxyAllowanceLazyStore](#class-balanceandproxyallowancelazystore)* - -Instance of BalanceAndProxyAllowanceLazyStore - -## Methods - -### deleteAll - -▸ **deleteAll**(): *void* - -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:115](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L115)* - -Delete all balances & allowances - -**Returns:** *void* - -___ - -### deleteBalance - -▸ **deleteBalance**(`assetData`: string, `userAddress`: string): *void* - -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L61)* - -Clear the balance of an asset for a user - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | - -**Returns:** *void* - -___ - -### deleteProxyAllowance - -▸ **deleteProxyAllowance**(`assetData`: string, `userAddress`: string): *void* - -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L104)* - -Clear the 0x asset proxy allowance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | - -**Returns:** *void* - -___ - -### getBalanceAsync - -▸ **getBalanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L37)* - -Get a users balance of an asset - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | - -**Returns:** *`Promise`* - -___ - -### getProxyAllowanceAsync - -▸ **getProxyAllowanceAsync**(`assetData`: string, `userAddress`: string): *`Promise`* - -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L74)* - -Get the 0x asset proxy allowance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | - -**Returns:** *`Promise`* - -___ - -### setBalance - -▸ **setBalance**(`assetData`: string, `userAddress`: string, `balance`: `BigNumber`): *void* - -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L50)* - -Set the balance of an asset for a user - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | -`balance` | `BigNumber` | - | - -**Returns:** *void* - -___ - -### setProxyAllowance - -▸ **setProxyAllowance**(`assetData`: string, `userAddress`: string, `proxyAllowance`: `BigNumber`): *void* - -*Defined in [order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts:93](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/balance_and_proxy_allowance_lazy_store.ts#L93)* - -Set the 0x asset proxy allowance - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`assetData` | string | AssetData of interest | -`userAddress` | string | Ethereum address of interest | -`proxyAllowance` | `BigNumber` | - | - -**Returns:** *void* - -
- -# Class: OrderFilledCancelledLazyStore - -Copy on read store for balances/proxyAllowances of tokens/accounts - - -## Implements - -* [AbstractOrderFilledCancelledLazyStore](#class-abstractorderfilledcancelledlazystore) - - -## Constructors - - - -\+ **new OrderFilledCancelledLazyStore**(`orderFilledCancelledFetcher`: [AbstractOrderFilledCancelledFetcher](_order_utils_src_abstract_abstract_order_filled_cancelled_fetcher_.abstractorderfilledcancelledfetcher.md)): *[OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore)* - -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L19)* - -Instantiate a OrderFilledCancelledLazyStore - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderFilledCancelledFetcher` | [AbstractOrderFilledCancelledFetcher](#class-abstractorderfilledcancelledfetcher) | Class instance that implements the AbstractOrderFilledCancelledFetcher | - -**Returns:** *[OrderFilledCancelledLazyStore](#class-orderfilledcancelledlazystore)* - -An instance of OrderFilledCancelledLazyStore - -## Methods - -### deleteAll - -▸ **deleteAll**(): *void* - -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L90)* - -Clear all filled/cancelled state - -**Returns:** *void* - -___ - -### deleteAllFilled - -▸ **deleteAllFilled**(): *void* - -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L103)* - -Clear all filled state - -**Returns:** *void* - -___ - -### deleteAllIsCancelled - -▸ **deleteAllIsCancelled**(): *void* - -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:97](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L97)* - -Clear all cancelled state - -**Returns:** *void* - -___ - -### deleteFilledTakerAmount -▸ **deleteFilledTakerAmount**(`orderHash`: string): *void* -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L55)* -Clear the filledTakerAssetAmount of an order -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash from order of interest | - -**Returns:** *void* - -___ - -### deleteIsCancelled - -▸ **deleteIsCancelled**(`orderHash`: string): *void* - -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L84)* - -Clear whether the order has been cancelled if already set - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash from order of interest | - -**Returns:** *void* - -___ - -### getFilledTakerAmountAsync - -▸ **getFilledTakerAmountAsync**(`orderHash`: string): *`Promise`* - -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L35)* - -Get the filledTakerAssetAmount of an order - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash from order of interest | - -**Returns:** *`Promise`* - -filledTakerAssetAmount - -___ - -### getIsCancelledAsync - -▸ **getIsCancelledAsync**(`signedOrder`: `SignedOrder`): *`Promise`* - -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L63)* - -Check if an order has been cancelled - -**Parameters:** - -Name | Type | ------- | ------ | -`signedOrder` | `SignedOrder` | - -**Returns:** *`Promise`* - -Whether the order has been cancelled - -___ - -### setFilledTakerAmount - -▸ **setFilledTakerAmount**(`orderHash`: string, `filledTakerAmount`: `BigNumber`): *void* - -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L48)* - -Set the filledTakerAssetAmount of an order - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash from order of interest | -`filledTakerAmount` | `BigNumber` | Desired filledTakerAssetAmount | - -**Returns:** *void* - -___ - -### setIsCancelled - -▸ **setIsCancelled**(`orderHash`: string, `isCancelled`: boolean): *void* - -*Defined in [order-utils/src/store/order_filled_cancelled_lazy_store.ts:77](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/store/order_filled_cancelled_lazy_store.ts#L77)* - -Set whether an order has been cancelled or not - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`orderHash` | string | OrderHash from order of interest | -`isCancelled` | boolean | Whether this order should be cancelled or not | - -**Returns:** *void* - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -# Enumeration: TradeSide - - -## Enumeration members - -### Maker - -• **Maker**: = "maker" - -*Defined in [order-utils/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L9)* - -___ - -### Taker - -• **Taker**: = "taker" - -*Defined in [order-utils/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L10)* - -
- -# Enumeration: TransferType - - -## Enumeration members - -### Fee - -• **Fee**: = "fee" - -*Defined in [order-utils/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L15)* - -___ - -### Trade - -• **Trade**: = "trade" - -*Defined in [order-utils/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L14)* - -
# Enumeration: TypedDataError @@ -1105,7 +15,7 @@ ___ • **InvalidMetamaskSigner**: = "MetaMask provider must be wrapped in a MetamaskSubprovider (from the '@0x/subproviders' package) in order to work with this method." -*Defined in [order-utils/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L5)* +*Defined in [order-utils/src/types.ts:5](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L5)* ___ @@ -1113,7 +23,7 @@ ___ • **InvalidSignature**: = "INVALID_SIGNATURE" -*Defined in [order-utils/src/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L4)* +*Defined in [order-utils/src/types.ts:4](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L4)*
@@ -1124,224 +34,49 @@ ___ ### ERC1155 -• **ERC1155**: = "0xa7cb5fb7" - -*Defined in [types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L166)* - -___ - -### ERC20 - -• **ERC20**: = "0xf47261b0" - -*Defined in [types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L163)* - -___ - -### ERC20Bridge - -• **ERC20Bridge**: = "0xdc1600f3" - -*Defined in [types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L168)* - -___ - -### ERC721 - -• **ERC721**: = "0x02571792" - -*Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L164)* - -___ - -### MultiAsset - -• **MultiAsset**: = "0x94cfcdd7" - -*Defined in [types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L165)* - -___ - -### StaticCall - -• **StaticCall**: = "0xc339d10a" - -*Defined in [types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L167)* - -
- -# Enumeration: ExchangeContractErrs - -Errors originating from the 0x exchange contract - - -## Enumeration members - -### BatchOrdersMustHaveAtLeastOneItem - -• **BatchOrdersMustHaveAtLeastOneItem**: = "BATCH_ORDERS_MUST_HAVE_AT_LEAST_ONE_ITEM" - -*Defined in [types/src/index.ts:98](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L98)* - -___ - -### BatchOrdersMustHaveSameExchangeAddress - -• **BatchOrdersMustHaveSameExchangeAddress**: = "BATCH_ORDERS_MUST_HAVE_SAME_EXCHANGE_ADDRESS" - -*Defined in [types/src/index.ts:97](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L97)* - -___ - -### FillBalanceAllowanceError - -• **FillBalanceAllowanceError**: = "FILL_BALANCE_ALLOWANCE_ERROR" - -*Defined in [types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L84)* - -___ - -### InsufficientMakerAllowance - -• **InsufficientMakerAllowance**: = "INSUFFICIENT_MAKER_ALLOWANCE" - -*Defined in [types/src/index.ts:88](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L88)* - -___ - -### InsufficientMakerBalance - -• **InsufficientMakerBalance**: = "INSUFFICIENT_MAKER_BALANCE" - -*Defined in [types/src/index.ts:87](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L87)* - -___ - -### InsufficientMakerFeeAllowance - -• **InsufficientMakerFeeAllowance**: = "INSUFFICIENT_MAKER_FEE_ALLOWANCE" - -*Defined in [types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L92)* - -___ - -### InsufficientMakerFeeBalance - -• **InsufficientMakerFeeBalance**: = "INSUFFICIENT_MAKER_FEE_BALANCE" - -*Defined in [types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L91)* - -___ - -### InsufficientRemainingFillAmount - -• **InsufficientRemainingFillAmount**: = "INSUFFICIENT_REMAINING_FILL_AMOUNT" - -*Defined in [types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L95)* - -___ - -### InsufficientTakerAllowance - -• **InsufficientTakerAllowance**: = "INSUFFICIENT_TAKER_ALLOWANCE" - -*Defined in [types/src/index.ts:86](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L86)* - -___ - -### InsufficientTakerBalance - -• **InsufficientTakerBalance**: = "INSUFFICIENT_TAKER_BALANCE" - -*Defined in [types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L85)* - -___ - -### InsufficientTakerFeeAllowance - -• **InsufficientTakerFeeAllowance**: = "INSUFFICIENT_TAKER_FEE_ALLOWANCE" - -*Defined in [types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L90)* - -___ - -### InsufficientTakerFeeBalance - -• **InsufficientTakerFeeBalance**: = "INSUFFICIENT_TAKER_FEE_BALANCE" - -*Defined in [types/src/index.ts:89](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L89)* - -___ - -### MultipleMakersInSingleCancelBatchDisallowed - -• **MultipleMakersInSingleCancelBatchDisallowed**: = "MULTIPLE_MAKERS_IN_SINGLE_CANCEL_BATCH_DISALLOWED" - -*Defined in [types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L94)* - -___ - -### MultipleTakerTokensInFillUpToDisallowed - -• **MultipleTakerTokensInFillUpToDisallowed**: = "MULTIPLE_TAKER_TOKENS_IN_FILL_UP_TO_DISALLOWED" - -*Defined in [types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L96)* - -___ - -### OrderCancelExpired - -• **OrderCancelExpired**: = "ORDER_CANCEL_EXPIRED" - -*Defined in [types/src/index.ts:79](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L79)* - -___ - -### OrderCancelled - -• **OrderCancelled**: = "ORDER_CANCELLED" +• **ERC1155**: = "0xa7cb5fb7" -*Defined in [types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L80)* +*Defined in [types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L166)* ___ -### OrderFillAmountZero +### ERC20 -• **OrderFillAmountZero**: = "ORDER_FILL_AMOUNT_ZERO" +• **ERC20**: = "0xf47261b0" -*Defined in [types/src/index.ts:81](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L81)* +*Defined in [types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L163)* ___ -### OrderFillExpired +### ERC20Bridge -• **OrderFillExpired**: = "ORDER_FILL_EXPIRED" +• **ERC20Bridge**: = "0xdc1600f3" -*Defined in [types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L78)* +*Defined in [types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L168)* ___ -### OrderFillRoundingError +### ERC721 -• **OrderFillRoundingError**: = "ORDER_FILL_ROUNDING_ERROR" +• **ERC721**: = "0x02571792" -*Defined in [types/src/index.ts:83](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L83)* +*Defined in [types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L164)* ___ -### OrderRemainingFillAmountZero +### MultiAsset -• **OrderRemainingFillAmountZero**: = "ORDER_REMAINING_FILL_AMOUNT_ZERO" +• **MultiAsset**: = "0x94cfcdd7" -*Defined in [types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L82)* +*Defined in [types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L165)* ___ -### TransactionSenderIsNotFillOrderTaker +### StaticCall -• **TransactionSenderIsNotFillOrderTaker**: = "TRANSACTION_SENDER_IS_NOT_FILL_ORDER_TAKER" +• **StaticCall**: = "0xc339d10a" -*Defined in [types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L93)* +*Defined in [types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L167)*
@@ -1355,6 +90,8 @@ ___ + + # Enumeration: SignatureType @@ -1364,7 +101,7 @@ ___ • **EIP1271Wallet**: -*Defined in [types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L158)* +*Defined in [types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L158)* ___ @@ -1372,7 +109,7 @@ ___ • **EIP712**: -*Defined in [types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L153)* +*Defined in [types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L153)* ___ @@ -1380,7 +117,7 @@ ___ • **EthSign**: -*Defined in [types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L154)* +*Defined in [types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L154)* ___ @@ -1388,7 +125,7 @@ ___ • **Illegal**: -*Defined in [types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L151)* +*Defined in [types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L151)* ___ @@ -1396,7 +133,7 @@ ___ • **Invalid**: -*Defined in [types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L152)* +*Defined in [types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L152)* ___ @@ -1404,7 +141,7 @@ ___ • **NSignatureTypes**: -*Defined in [types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L159)* +*Defined in [types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L159)* ___ @@ -1412,7 +149,7 @@ ___ • **PreSigned**: -*Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L157)* +*Defined in [types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L157)* ___ @@ -1420,7 +157,7 @@ ___ • **Validator**: -*Defined in [types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L156)* +*Defined in [types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L156)* ___ @@ -1428,7 +165,7 @@ ___ • **Wallet**: -*Defined in [types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L155)* +*Defined in [types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L155)*
@@ -1485,7 +222,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -1493,7 +230,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -1517,7 +254,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -1551,7 +288,7 @@ Name | Type | ▸ **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/c93b02d55/packages/ethereum-types/src/index.ts#L14)* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -1575,7 +312,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* ___ @@ -1583,7 +320,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* ___ @@ -1591,7 +328,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* ___ @@ -1599,7 +336,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
@@ -1612,7 +349,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* ___ @@ -1620,7 +357,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
@@ -1633,7 +370,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* ___ @@ -1641,7 +378,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* ___ @@ -1649,7 +386,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* ___ @@ -1657,7 +394,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
@@ -1718,7 +455,7 @@ This interface allowed sending synchonous requests, support for which was later ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* -*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -1734,7 +471,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -1760,7 +497,7 @@ before the first attempts to conform to EIP1193 ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -1786,7 +523,7 @@ however it does not conform entirely. ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -1812,7 +549,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L31)* ___ @@ -1820,7 +557,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L32)* ___ @@ -1828,7 +565,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -1836,7 +573,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -1846,7 +583,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -1863,7 +600,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -1884,7 +621,7 @@ ___ • **feeOrdersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L78)* +*Defined in [order-utils/src/types.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L68)* ___ @@ -1892,7 +629,7 @@ ___ • **remainingFeeAmount**: *`BigNumber`* -*Defined in [order-utils/src/types.ts:79](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L79)* +*Defined in [order-utils/src/types.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L69)* ___ @@ -1900,7 +637,7 @@ ___ • **resultFeeOrders**: *`T`[]* -*Defined in [order-utils/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L77)* +*Defined in [order-utils/src/types.ts:67](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L67)*
@@ -1922,7 +659,7 @@ Defaults to 0 • **remainingFillableFeeAmounts**? : *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L72)* +*Defined in [order-utils/src/types.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L62)* ___ @@ -1930,7 +667,7 @@ ___ • **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:71](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L71)* +*Defined in [order-utils/src/types.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L61)* ___ @@ -1938,7 +675,7 @@ ___ • **slippageBufferAmount**? : *`BigNumber`* -*Defined in [order-utils/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L73)* +*Defined in [order-utils/src/types.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L63)*
@@ -1957,7 +694,7 @@ Defaults to 0 • **remainingFillableMakerAssetAmounts**? : *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L44)* +*Defined in [order-utils/src/types.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L34)* ___ @@ -1965,7 +702,7 @@ ___ • **slippageBufferAmount**? : *`BigNumber`* -*Defined in [order-utils/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L45)* +*Defined in [order-utils/src/types.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L35)*
@@ -1984,7 +721,7 @@ Defaults to 0 • **remainingFillableTakerAssetAmounts**? : *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L56)* +*Defined in [order-utils/src/types.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L46)* ___ @@ -1992,7 +729,7 @@ ___ • **slippageBufferAmount**? : *`BigNumber`* -*Defined in [order-utils/src/types.ts:57](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L57)* +*Defined in [order-utils/src/types.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L47)*
@@ -2009,7 +746,7 @@ ___ • **ordersRemainingFillableMakerAssetAmounts**: *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L84)* +*Defined in [order-utils/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L74)* ___ @@ -2017,7 +754,7 @@ ___ • **remainingFillAmount**: *`BigNumber`* -*Defined in [order-utils/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L85)* +*Defined in [order-utils/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L75)* ___ @@ -2025,7 +762,7 @@ ___ • **resultOrders**: *`T`[]* -*Defined in [order-utils/src/types.ts:83](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L83)* +*Defined in [order-utils/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L73)*
@@ -2042,7 +779,7 @@ ___ • **ordersRemainingFillableTakerAssetAmounts**: *`BigNumber`[]* -*Defined in [order-utils/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L90)* +*Defined in [order-utils/src/types.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L80)* ___ @@ -2050,7 +787,7 @@ ___ • **remainingFillAmount**: *`BigNumber`* -*Defined in [order-utils/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L91)* +*Defined in [order-utils/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L81)* ___ @@ -2058,7 +795,7 @@ ___ • **resultOrders**: *`T`[]* -*Defined in [order-utils/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/types.ts#L89)* +*Defined in [order-utils/src/types.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/types.ts#L79)*
@@ -2085,8 +822,6 @@ ___ - - @@ -2099,7 +834,7 @@ ___ • **assetData**: *[AssetData](#assetdata)* -*Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L219)* +*Defined in [types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L219)* ___ @@ -2107,7 +842,7 @@ ___ • **beginAmount**: *`BigNumber`* -*Defined in [types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L221)* +*Defined in [types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L221)* ___ @@ -2115,7 +850,7 @@ ___ • **beginTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L220)* +*Defined in [types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L220)*
@@ -2132,7 +867,7 @@ Elliptic Curve signature • **r**: *string* -*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L62)* +*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L62)* ___ @@ -2140,7 +875,7 @@ ___ • **s**: *string* -*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L63)* +*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L63)* ___ @@ -2148,7 +883,7 @@ ___ • **v**: *number* -*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L61)* +*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L61)*
@@ -2161,7 +896,7 @@ ___ • **chainId**: *number* -*Defined in [types/src/index.ts:793](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L793)* +*Defined in [types/src/index.ts:793](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L793)* ___ @@ -2169,7 +904,7 @@ ___ • **name**? : *undefined | string* -*Defined in [types/src/index.ts:791](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L791)* +*Defined in [types/src/index.ts:791](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L791)* ___ @@ -2177,7 +912,7 @@ ___ • **verifyingContract**: *string* -*Defined in [types/src/index.ts:794](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L794)* +*Defined in [types/src/index.ts:794](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L794)* ___ @@ -2185,7 +920,7 @@ ___ • **version**? : *undefined | string* -*Defined in [types/src/index.ts:792](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L792)* +*Defined in [types/src/index.ts:792](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L792)*
@@ -2203,7 +938,7 @@ ___ • **name**: *string* -*Defined in [types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L732)* +*Defined in [types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L732)* ___ @@ -2211,7 +946,7 @@ ___ • **type**: *string* -*Defined in [types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L733)* +*Defined in [types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L733)*
@@ -2224,7 +959,7 @@ ___ • **domain**: *[EIP712Object](#class-eip712object)* -*Defined in [types/src/index.ts:748](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L748)* +*Defined in [types/src/index.ts:748](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L748)* ___ @@ -2232,7 +967,7 @@ ___ • **message**: *[EIP712Object](#class-eip712object)* -*Defined in [types/src/index.ts:749](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L749)* +*Defined in [types/src/index.ts:749](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L749)* ___ @@ -2240,7 +975,7 @@ ___ • **primaryType**: *string* -*Defined in [types/src/index.ts:750](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L750)* +*Defined in [types/src/index.ts:750](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L750)* ___ @@ -2248,7 +983,7 @@ ___ • **types**: *[EIP712Types](#class-eip712types)* -*Defined in [types/src/index.ts:747](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L747)* +*Defined in [types/src/index.ts:747](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L747)*
@@ -2266,7 +1001,7 @@ ___ • **name**: *string* -*Defined in [types/src/index.ts:686](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L686)* +*Defined in [types/src/index.ts:686](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L686)* ___ @@ -2274,489 +1009,202 @@ ___ • **typeDocType**: *[TypeDocTypes](#enumeration-typedoctypes)* -*Defined in [types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L687)* - -
- -# Interface: ERC1155AssetData - - -## Properties - -### assetProxyId - -• **assetProxyId**: *string* - -*Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L183)* - -___ - -### callbackData - -• **callbackData**: *string* - -*Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L187)* - -___ - -### tokenAddress - -• **tokenAddress**: *string* - -*Defined in [types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L184)* - -___ - -### tokenIds - -• **tokenIds**: *`BigNumber`[]* - -*Defined in [types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L185)* - -___ - -### tokenValues - -• **tokenValues**: *`BigNumber`[]* - -*Defined in [types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L186)* - -
- - - -# Interface: ERC20AssetData - - -## Properties - -### assetProxyId - -• **assetProxyId**: *string* - -*Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L172)* - -___ - -### tokenAddress - -• **tokenAddress**: *string* - -*Defined in [types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L173)* - -
- -# Interface: ERC721AssetData - - -## Properties - -### assetProxyId - -• **assetProxyId**: *string* - -*Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L177)* - -___ - -### tokenAddress - -• **tokenAddress**: *string* - -*Defined in [types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L178)* - -___ - -### tokenId - -• **tokenId**: *`BigNumber`* - -*Defined in [types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L179)* - -
- - - - - - - - - - - - - - - - - -# Interface: MultiAssetData - - -## Properties - -### amounts - -• **amounts**: *`BigNumber`[]* - -*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L208)* - -___ - -### assetProxyId - -• **assetProxyId**: *string* - -*Defined in [types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L207)* - -___ - -### nestedAssetData - -• **nestedAssetData**: *string[]* - -*Defined in [types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L209)* - -
- -# Interface: MultiAssetDataWithRecursiveDecoding - - -## Properties - -### amounts - -• **amounts**: *`BigNumber`[]* - -*Defined in [types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L214)* - -___ - -### assetProxyId - -• **assetProxyId**: *string* - -*Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L213)* - -___ - -### nestedAssetData - -• **nestedAssetData**: *[SingleAssetData](#singleassetdata)[]* - -*Defined in [types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L215)* +*Defined in [types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L687)*
-# Interface: ObjectMap <**T**> - -## Type parameters - -▪ **T** - - -## Hierarchy - -* **Order** - - * [SignedOrder](#class-signedorder) - - -## Properties - -### chainId - -• **chainId**: *number* - -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L14)* - -___ - -### exchangeAddress - -• **exchangeAddress**: *string* - -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L15)* - -___ - -### expirationTimeSeconds - -• **expirationTimeSeconds**: *`BigNumber`* - -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L24)* - -___ - -### feeRecipientAddress - -• **feeRecipientAddress**: *string* - -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L18)* - -___ - -### makerAddress - -• **makerAddress**: *string* - -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L16)* - -___ - -### makerAssetAmount - -• **makerAssetAmount**: *`BigNumber`* - -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L20)* - -___ - -### makerAssetData - -• **makerAssetData**: *string* - -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L26)* - -___ - -### makerFee - -• **makerFee**: *`BigNumber`* - -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L22)* - -___ - -### makerFeeAssetData - -• **makerFeeAssetData**: *string* - -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L28)* - -___ - -### salt - -• **salt**: *`BigNumber`* - -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L25)* - -___ - -### senderAddress - -• **senderAddress**: *string* +# Interface: ERC1155AssetData -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L19)* -___ +## Properties -### takerAddress +### assetProxyId -• **takerAddress**: *string* +• **assetProxyId**: *string* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L183)* ___ -### takerAssetAmount +### callbackData -• **takerAssetAmount**: *`BigNumber`* +• **callbackData**: *string* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L187)* ___ -### takerAssetData +### tokenAddress -• **takerAssetData**: *string* +• **tokenAddress**: *string* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L184)* ___ -### takerFee +### tokenIds -• **takerFee**: *`BigNumber`* +• **tokenIds**: *`BigNumber`[]* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L185)* ___ -### takerFeeAssetData +### tokenValues -• **takerFeeAssetData**: *string* +• **tokenValues**: *`BigNumber`[]* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L186)*
+# Interface: ERC20AssetData + + +## Properties + +### assetProxyId +• **assetProxyId**: *string* +*Defined in [types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L172)* +___ +### tokenAddress +• **tokenAddress**: *string* +*Defined in [types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L173)* +
-# Interface: OrderRelevantState +# Interface: ERC721AssetData ## Properties -### filledTakerAssetAmount +### assetProxyId -• **filledTakerAssetAmount**: *`BigNumber`* +• **assetProxyId**: *string* -*Defined in [types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L122)* +*Defined in [types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L177)* ___ -### makerBalance +### tokenAddress -• **makerBalance**: *`BigNumber`* +• **tokenAddress**: *string* -*Defined in [types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L116)* +*Defined in [types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L178)* ___ -### makerFeeBalance +### tokenId -• **makerFeeBalance**: *`BigNumber`* +• **tokenId**: *`BigNumber`* -*Defined in [types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L120)* +*Defined in [types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L179)* -___ +
-### makerFeeProxyAllowance -• **makerFeeProxyAllowance**: *`BigNumber`* -*Defined in [types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L121)* -___ -### makerIndividualBalances + -• **makerIndividualBalances**: *[ObjectMap](#class-objectmap)‹*`BigNumber`*›* -*Defined in [types/src/index.ts:117](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L117)* -___ -### makerIndividualProxyAllowances -• **makerIndividualProxyAllowances**: *[ObjectMap](#class-objectmap)‹*`BigNumber`*›* -*Defined in [types/src/index.ts:119](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L119)* -___ -### makerProxyAllowance -• **makerProxyAllowance**: *`BigNumber`* -*Defined in [types/src/index.ts:118](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L118)* -___ +# Interface: MultiAssetData + + +## Properties -### remainingFillableMakerAssetAmount +### amounts -• **remainingFillableMakerAssetAmount**: *`BigNumber`* +• **amounts**: *`BigNumber`[]* -*Defined in [types/src/index.ts:123](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L123)* +*Defined in [types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L208)* ___ -### remainingFillableTakerAssetAmount +### assetProxyId -• **remainingFillableTakerAssetAmount**: *`BigNumber`* +• **assetProxyId**: *string* -*Defined in [types/src/index.ts:124](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L124)* +*Defined in [types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L207)* -
+___ +### nestedAssetData +• **nestedAssetData**: *string[]* +*Defined in [types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L209)* +
-# Interface: OrderStateInvalid +# Interface: MultiAssetDataWithRecursiveDecoding ## Properties -### error +### amounts -• **error**: *[ExchangeContractErrs](#enumeration-exchangecontracterrs)* +• **amounts**: *`BigNumber`[]* -*Defined in [types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L137)* +*Defined in [types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L214)* ___ -### isValid +### assetProxyId -• **isValid**: *false* +• **assetProxyId**: *string* -*Defined in [types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L135)* +*Defined in [types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L213)* ___ -### orderHash - -• **orderHash**: *string* +### nestedAssetData -*Defined in [types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L136)* +• **nestedAssetData**: *[SingleAssetData](#singleassetdata)[]* -___ +*Defined in [types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L215)* -### `Optional` transactionHash +
-• **transactionHash**? : *undefined | string* -*Defined in [types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L138)* -
-# Interface: OrderStateValid -## Properties -### isValid -• **isValid**: *true* -*Defined in [types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L128)* -___ -### orderHash -• **orderHash**: *string* -*Defined in [types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L129)* -___ -### orderRelevantState -• **orderRelevantState**: *[OrderRelevantState](#class-orderrelevantstate)* -*Defined in [types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L130)* -___ -### `Optional` transactionHash -• **transactionHash**? : *undefined | string* -*Defined in [types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L131)* -
@@ -2785,7 +1233,7 @@ ___ *Inherited from [Order](#interface-order).[chainId](#chainid)* -*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L14)* +*Defined in [types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L14)* ___ @@ -2795,7 +1243,7 @@ ___ *Inherited from [Order](#interface-order).[exchangeAddress](#exchangeaddress)* -*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L15)* +*Defined in [types/src/index.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L15)* ___ @@ -2805,7 +1253,7 @@ ___ *Inherited from [Order](#interface-order).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L24)* +*Defined in [types/src/index.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L24)* ___ @@ -2815,7 +1263,7 @@ ___ *Inherited from [Order](#interface-order).[feeRecipientAddress](#feerecipientaddress)* -*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L18)* +*Defined in [types/src/index.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L18)* ___ @@ -2825,7 +1273,7 @@ ___ *Inherited from [Order](#interface-order).[makerAddress](#makeraddress)* -*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L16)* +*Defined in [types/src/index.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L16)* ___ @@ -2835,7 +1283,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetAmount](#makerassetamount)* -*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L20)* +*Defined in [types/src/index.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L20)* ___ @@ -2845,7 +1293,7 @@ ___ *Inherited from [Order](#interface-order).[makerAssetData](#makerassetdata)* -*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L26)* +*Defined in [types/src/index.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L26)* ___ @@ -2855,7 +1303,7 @@ ___ *Inherited from [Order](#interface-order).[makerFee](#makerfee)* -*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L22)* +*Defined in [types/src/index.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L22)* ___ @@ -2865,7 +1313,7 @@ ___ *Inherited from [Order](#interface-order).[makerFeeAssetData](#makerfeeassetdata)* -*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L28)* +*Defined in [types/src/index.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L28)* ___ @@ -2875,7 +1323,7 @@ ___ *Inherited from [Order](#interface-order).[salt](#salt)* -*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L25)* +*Defined in [types/src/index.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L25)* ___ @@ -2885,7 +1333,7 @@ ___ *Inherited from [Order](#interface-order).[senderAddress](#senderaddress)* -*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L19)* +*Defined in [types/src/index.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L19)* ___ @@ -2893,7 +1341,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L33)* +*Defined in [types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L33)* ___ @@ -2903,7 +1351,7 @@ ___ *Inherited from [Order](#interface-order).[takerAddress](#takeraddress)* -*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L17)* +*Defined in [types/src/index.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L17)* ___ @@ -2913,7 +1361,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetAmount](#takerassetamount)* -*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L21)* +*Defined in [types/src/index.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L21)* ___ @@ -2923,7 +1371,7 @@ ___ *Inherited from [Order](#interface-order).[takerAssetData](#takerassetdata)* -*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L27)* +*Defined in [types/src/index.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L27)* ___ @@ -2933,7 +1381,7 @@ ___ *Inherited from [Order](#interface-order).[takerFee](#takerfee)* -*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L23)* +*Defined in [types/src/index.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L23)* ___ @@ -2943,7 +1391,7 @@ ___ *Inherited from [Order](#interface-order).[takerFeeAssetData](#takerfeeassetdata)* -*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L29)* +*Defined in [types/src/index.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L29)*
@@ -2958,7 +1406,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[data](#data)* -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L49)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L49)* ___ @@ -2968,7 +1416,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[domain](#domain)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L50)* +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L50)* ___ @@ -2978,7 +1426,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[expirationTimeSeconds](#expirationtimeseconds)* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L46)* +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L46)* ___ @@ -2988,7 +1436,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[gasPrice](#gasprice)* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L47)* +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L47)* ___ @@ -2998,7 +1446,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[salt](#salt)* -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L45)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L45)* ___ @@ -3006,7 +1454,7 @@ ___ • **signature**: *string* -*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L54)* +*Defined in [types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L54)* ___ @@ -3016,7 +1464,7 @@ ___ *Inherited from [ZeroExTransaction](#interface-zeroextransaction).[signerAddress](#signeraddress)* -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L48)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L48)*
@@ -3041,7 +1489,7 @@ ___ • **assetProxyId**: *string* -*Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L191)* +*Defined in [types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L191)* ___ @@ -3049,7 +1497,7 @@ ___ • **callResultHash**: *string* -*Defined in [types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L194)* +*Defined in [types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L194)* ___ @@ -3057,7 +1505,7 @@ ___ • **callTarget**: *string* -*Defined in [types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L192)* +*Defined in [types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L192)* ___ @@ -3065,7 +1513,7 @@ ___ • **staticCallData**: *string* -*Defined in [types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L193)* +*Defined in [types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L193)*
@@ -3106,7 +1554,7 @@ Validator signature components • **signature**: *string* -*Defined in [types/src/index.ts:71](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L71)* +*Defined in [types/src/index.ts:71](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L71)* ___ @@ -3114,7 +1562,7 @@ ___ • **validatorAddress**: *string* -*Defined in [types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L70)* +*Defined in [types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L70)*
@@ -3129,7 +1577,7 @@ ZeroExTransaction for use with 0x Exchange executeTransaction • **data**: *string* -*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L49)* +*Defined in [types/src/index.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L49)* ___ @@ -3137,7 +1585,7 @@ ___ • **domain**: *[EIP712DomainWithDefaultSchema](#class-eip712domainwithdefaultschema)* -*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L50)* +*Defined in [types/src/index.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L50)* ___ @@ -3145,7 +1593,7 @@ ___ • **expirationTimeSeconds**: *`BigNumber`* -*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L46)* +*Defined in [types/src/index.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L46)* ___ @@ -3153,7 +1601,7 @@ ___ • **gasPrice**: *`BigNumber`* -*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L47)* +*Defined in [types/src/index.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L47)* ___ @@ -3161,7 +1609,7 @@ ___ • **salt**: *`BigNumber`* -*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L45)* +*Defined in [types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L45)* ___ @@ -3169,7 +1617,52 @@ ___ • **signerAddress**: *string* -*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L48)* +*Defined in [types/src/index.ts:48](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L48)* + +
+ + + + +## Type aliases + + + +### AssetData + +Ƭ **AssetData**: *[SingleAssetData](_types_src_index_.md#singleassetdata) | [MultiAssetData](#interface-multiassetdata) | [MultiAssetDataWithRecursiveDecoding](#interface-multiassetdatawithrecursivedecoding)* + +*Defined in [types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L224)* + +___ + + + + + +### EIP712ObjectValue + +Ƭ **EIP712ObjectValue**: *string | number | [EIP712Object](#interface-eip712object)* + +*Defined in [types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L740)* + +___ + + + + + + + + + + + +### SingleAssetData + +Ƭ **SingleAssetData**: *[ERC20AssetData](#interface-erc20assetdata) | [ERC721AssetData](#interface-erc721assetdata) | [ERC1155AssetData](#interface-erc1155assetdata) | [StaticCallAssetData](#interface-staticcallassetdata)* + +*Defined in [types/src/index.ts:204](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L204)*
@@ -3194,7 +1687,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L70)* Interface for providers that conform to EIP 1193 Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md @@ -3211,7 +1704,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -3240,7 +1733,7 @@ ___ Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)* -*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L9)* Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library Read more about Providers in the guides section of the 0x docs. @@ -3255,28 +1748,12 @@ ___ Ƭ **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/c93b02d55/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L11)*
-
- - - -
- - - -
- - - -
- - - ## Object literals @@ -3284,13 +1761,13 @@ ___ #### ▪ **assetDataUtils**: *object* -*Defined in [order-utils/src/asset_data_utils.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L23)* +*Defined in [order-utils/src/asset_data_utils.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L397)* +*Defined in [order-utils/src/asset_data_utils.ts:397](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L397)* Throws if the assetData is not ERC1155. @@ -3306,7 +1783,7 @@ Name | Type | Description | ▸ **assertIsERC20AssetData**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:353](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L353)* +*Defined in [order-utils/src/asset_data_utils.ts:353](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L353)* Throws if the length or assetProxyId are invalid for the ERC20Proxy. @@ -3322,7 +1799,7 @@ Name | Type | Description | ▸ **assertIsERC721AssetData**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:375](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L375)* +*Defined in [order-utils/src/asset_data_utils.ts:375](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L375)* Throws if the length or assetProxyId are invalid for the ERC721Proxy. @@ -3338,7 +1815,7 @@ Name | Type | Description | ▸ **assertIsMultiAssetData**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:419](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L419)* +*Defined in [order-utils/src/asset_data_utils.ts:419](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L419)* Throws if the length or assetProxyId are invalid for the MultiAssetProxy. @@ -3354,7 +1831,7 @@ Name | Type | Description | ▸ **assertIsStaticCallAssetData**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:441](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L441)* +*Defined in [order-utils/src/asset_data_utils.ts:441](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L441)* Throws if the assetData is not StaticCallData. @@ -3370,7 +1847,7 @@ Name | Type | Description | ▸ **assertWordAlignedAssetData**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:463](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L463)* +*Defined in [order-utils/src/asset_data_utils.ts:463](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L463)* Throws if the assetData is not padded to 32 bytes. @@ -3386,7 +1863,7 @@ Name | Type | Description | ▸ **decodeAssetDataOrThrow**(`assetData`: string): *[SingleAssetData](#singleassetdata) | `MultiAssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:502](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L502)* +*Defined in [order-utils/src/asset_data_utils.ts:502](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L502)* Decode any assetData into its corresponding assetData object @@ -3404,7 +1881,7 @@ Either a ERC20, ERC721, ERC1155, or MultiAsset assetData object ▸ **decodeAssetProxyId**(`assetData`: string): *`AssetProxyId`* -*Defined in [order-utils/src/asset_data_utils.ts:294](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L294)* +*Defined in [order-utils/src/asset_data_utils.ts:294](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L294)* Decode and return the assetProxyId from the assetData @@ -3422,7 +1899,7 @@ The assetProxyId ▸ **decodeDutchAuctionData**(`dutchAuctionData`: string): *`DutchAuctionData`* -*Defined in [order-utils/src/asset_data_utils.ts:263](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L263)* +*Defined in [order-utils/src/asset_data_utils.ts:263](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -3442,7 +1919,7 @@ An object containing the auction asset, auction begin time and auction begin amo ▸ **decodeERC1155AssetData**(`assetData`: string): *`ERC1155AssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:107](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L107)* +*Defined in [order-utils/src/asset_data_utils.ts:107](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L107)* Decodes an ERC1155 assetData hex string into its corresponding ERC1155 components. @@ -3460,7 +1937,7 @@ An object containing the decoded tokenAddress, tokenIds, tokenValues, callbackDa ▸ **decodeERC20AssetData**(`assetData`: string): *`ERC20AssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L41)* +*Defined in [order-utils/src/asset_data_utils.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L41)* Decodes an ERC20 assetData hex string into its corresponding ERC20 tokenAddress & assetProxyId @@ -3478,7 +1955,7 @@ An object containing the decoded tokenAddress & assetProxyId ▸ **decodeERC721AssetData**(`assetData`: string): *`ERC721AssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L70)* +*Defined in [order-utils/src/asset_data_utils.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L70)* Decodes an ERC721 assetData hex string into its corresponding ERC721 tokenAddress, tokenId & assetProxyId @@ -3496,7 +1973,7 @@ An object containing the decoded tokenAddress, tokenId & assetProxyId ▸ **decodeMultiAssetData**(`assetData`: string): *`MultiAssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:149](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L149)* +*Defined in [order-utils/src/asset_data_utils.ts:149](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L149)* Decodes a MultiAsset assetData hex string into its corresponding amounts and nestedAssetData @@ -3514,7 +1991,7 @@ An object containing the decoded amounts and nestedAssetData ▸ **decodeMultiAssetDataRecursively**(`assetData`: string): *`MultiAssetDataWithRecursiveDecoding`* -*Defined in [order-utils/src/asset_data_utils.ts:175](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L175)* +*Defined in [order-utils/src/asset_data_utils.ts:175](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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) @@ -3532,7 +2009,7 @@ An object containing the decoded amounts and nestedAssetData ▸ **decodeStaticCallAssetData**(`assetData`: string): *`StaticCallAssetData`* -*Defined in [order-utils/src/asset_data_utils.ts:225](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L225)* +*Defined in [order-utils/src/asset_data_utils.ts:225](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L225)* Decoded StaticCall assetData into its corresponding callTarget, staticCallData, and expected callResultHash @@ -3550,7 +2027,7 @@ An object containing the decoded callTarget, staticCallData, and expected callRe ▸ **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/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L245)* +*Defined in [order-utils/src/asset_data_utils.ts:245](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -3572,7 +2049,7 @@ The hex encoded assetData string. ▸ **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/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L91)* +*Defined in [order-utils/src/asset_data_utils.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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. @@ -3594,7 +2071,7 @@ The hex encoded assetData string ▸ **encodeERC20AssetData**(`tokenAddress`: string): *string* -*Defined in [order-utils/src/asset_data_utils.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L30)* +*Defined in [order-utils/src/asset_data_utils.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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. @@ -3613,7 +2090,7 @@ The hex encoded assetData string ▸ **encodeERC721AssetData**(`tokenAddress`: string, `tokenId`: `BigNumber`): *string* -*Defined in [order-utils/src/asset_data_utils.ts:59](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L59)* +*Defined in [order-utils/src/asset_data_utils.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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. @@ -3633,7 +2110,7 @@ The hex encoded assetData string ▸ **encodeMultiAssetData**(`amounts`: `BigNumber`[], `nestedAssetData`: string[]): *string* -*Defined in [order-utils/src/asset_data_utils.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L130)* +*Defined in [order-utils/src/asset_data_utils.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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. @@ -3653,7 +2130,7 @@ The hex encoded assetData string ▸ **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/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L214)* +*Defined in [order-utils/src/asset_data_utils.ts:214](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L214)* Encodes StaticCallProxy data into an assetData hex string @@ -3673,7 +2150,7 @@ The hex encoded assetData string ▸ **isERC1155AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* -*Defined in [order-utils/src/asset_data_utils.ts:332](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L332)* +*Defined in [order-utils/src/asset_data_utils.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L332)* Checks if the decoded asset data is valid ERC1155 data @@ -3689,7 +2166,7 @@ Name | Type | Description | ▸ **isERC20AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* -*Defined in [order-utils/src/asset_data_utils.ts:318](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L318)* +*Defined in [order-utils/src/asset_data_utils.ts:318](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L318)* Checks if the decoded asset data is valid ERC20 data @@ -3705,7 +2182,7 @@ Name | Type | Description | ▸ **isERC721AssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* -*Defined in [order-utils/src/asset_data_utils.ts:325](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L325)* +*Defined in [order-utils/src/asset_data_utils.ts:325](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L325)* Checks if the decoded asset data is valid ERC721 data @@ -3721,7 +2198,7 @@ Name | Type | Description | ▸ **isMultiAssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* -*Defined in [order-utils/src/asset_data_utils.ts:339](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L339)* +*Defined in [order-utils/src/asset_data_utils.ts:339](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L339)* Checks if the decoded asset data is valid MultiAsset data @@ -3737,7 +2214,7 @@ Name | Type | Description | ▸ **isStaticCallAssetData**(`decodedAssetData`: [SingleAssetData](#singleassetdata) | `MultiAssetData`): *boolean* -*Defined in [order-utils/src/asset_data_utils.ts:346](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L346)* +*Defined in [order-utils/src/asset_data_utils.ts:346](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L346)* Checks if the decoded asset data is valid StaticCall data @@ -3753,7 +2230,7 @@ Name | Type | Description | ▸ **validateAssetDataOrThrow**(`assetData`: string): *void* -*Defined in [order-utils/src/asset_data_utils.ts:475](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/asset_data_utils.ts#L475)* +*Defined in [order-utils/src/asset_data_utils.ts:475](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/asset_data_utils.ts#L475)* Throws if the length or assetProxyId are invalid for the corresponding AssetProxy. @@ -3769,10 +2246,6 @@ Name | Type | Description | -
- - - ## Object literals @@ -3780,13 +2253,13 @@ Name | Type | Description | #### ▪ **eip712Utils**: *object* -*Defined in [order-utils/src/eip712_utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/eip712_utils.ts#L17)* +*Defined in [order-utils/src/eip712_utils.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/eip712_utils.ts#L18)* -#### createCoordinatorApprovalTypedData +#### createCoordinatorApprovalTypedDataAsync -▸ **createCoordinatorApprovalTypedData**(`transaction`: `SignedZeroExTransaction`, `verifyingContract`: string, `txOrigin`: string): *`EIP712TypedData`* +▸ **createCoordinatorApprovalTypedDataAsync**(`transaction`: `SignedZeroExTransaction`, `verifyingContract`: string, `txOrigin`: string): *`Promise`* -*Defined in [order-utils/src/eip712_utils.ts:103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/eip712_utils.ts#L103)* +*Defined in [order-utils/src/eip712_utils.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/eip712_utils.ts#L104)* Creates an Coordinator typedData EIP712TypedData object for use with the Coordinator extension contract @@ -3798,7 +2271,7 @@ Name | Type | Description | `verifyingContract` | string | The coordinator extension contract address that will be verifying the typedData | `txOrigin` | string | The desired `tx.origin` that should be able to submit an Ethereum txn involving this 0x transaction | -**Returns:** *`EIP712TypedData`* +**Returns:** *`Promise`* A typed data object @@ -3806,7 +2279,7 @@ A typed data object ▸ **createOrderTypedData**(`order`: `Order`): *`EIP712TypedData`* -*Defined in [order-utils/src/eip712_utils.ts:56](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/eip712_utils.ts#L56)* +*Defined in [order-utils/src/eip712_utils.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/eip712_utils.ts#L57)* Creates an Order EIP712TypedData object for use with signTypedData. @@ -3824,7 +2297,7 @@ A typed data object ▸ **createTypedData**(`primaryType`: string, `types`: `EIP712Types`, `message`: `EIP712Object`, `domain`: `EIP712DomainWithDefaultSchema`): *`EIP712TypedData`* -*Defined in [order-utils/src/eip712_utils.ts:26](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/eip712_utils.ts#L26)* +*Defined in [order-utils/src/eip712_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/eip712_utils.ts#L27)* Creates a EIP712TypedData object specific to the 0x protocol for use with signTypedData. @@ -3845,7 +2318,7 @@ A typed data object ▸ **createZeroExTransactionTypedData**(`zeroExTransaction`: `ZeroExTransaction`): *`EIP712TypedData`* -*Defined in [order-utils/src/eip712_utils.ts:81](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/eip712_utils.ts#L81)* +*Defined in [order-utils/src/eip712_utils.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/eip712_utils.ts#L82)* Creates an ExecuteTransaction EIP712TypedData object for use with signTypedData and 0x Exchange executeTransaction. @@ -3864,22 +2337,6 @@ A typed data object -
- - - -
- - - -
- - - -
- - - ## Object literals @@ -3887,13 +2344,13 @@ A typed data object #### ▪ **marketUtils**: *object* -*Defined in [order-utils/src/market_utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/market_utils.ts#L17)* +*Defined in [order-utils/src/market_utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/market_utils.ts#L17)* #### findFeeOrdersThatCoverFeesForTargetOrders ▸ **findFeeOrdersThatCoverFeesForTargetOrders**<**T**>(`orders`: `T`[], `feeOrders`: `T`[], `opts?`: [FindFeeOrdersThatCoverFeesForTargetOrdersOpts](#interface-findfeeordersthatcoverfeesfortargetordersopts)): *[FeeOrdersAndRemainingFeeAmount](#interface-feeordersandremainingfeeamount)‹*`T`*›* -*Defined in [order-utils/src/market_utils.ts:64](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/market_utils.ts#L64)* +*Defined in [order-utils/src/market_utils.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/market_utils.ts#L64)* Takes an array of orders and an array of feeOrders. Returns a subset of the feeOrders that has enough ZRX in order to fill the takerFees required by orders plus a slippageBufferAmount. @@ -3920,7 +2377,7 @@ Resulting orders and remaining fee amount that could not be covered by the input ▸ **findOrdersThatCoverMakerAssetFillAmount**<**T**>(`orders`: `T`[], `makerAssetFillAmount`: `BigNumber`, `opts?`: [FindOrdersThatCoverMakerAssetFillAmountOpts](#interface-findordersthatcovermakerassetfillamountopts)): *[OrdersAndRemainingMakerFillAmount](#interface-ordersandremainingmakerfillamount)‹*`T`*›* -*Defined in [order-utils/src/market_utils.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/market_utils.ts#L40)* +*Defined in [order-utils/src/market_utils.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/market_utils.ts#L40)* Takes an array of orders and returns a subset of those orders that has enough makerAssetAmount in order to fill the input makerAssetFillAmount plus slippageBufferAmount. Iterates from first order to last order. @@ -3946,7 +2403,7 @@ Resulting orders and remaining fill amount that could not be covered by the inpu ▸ **findOrdersThatCoverTakerAssetFillAmount**<**T**>(`orders`: `T`[], `takerAssetFillAmount`: `BigNumber`, `opts?`: [FindOrdersThatCoverTakerAssetFillAmountOpts](#interface-findordersthatcovertakerassetfillamountopts)): *[OrdersAndRemainingTakerFillAmount](#interface-ordersandremainingtakerfillamount)‹*`T`*›* -*Defined in [order-utils/src/market_utils.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/market_utils.ts#L18)* +*Defined in [order-utils/src/market_utils.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/market_utils.ts#L18)* **Type parameters:** @@ -3973,13 +2430,13 @@ Name | Type | #### ▪ **orderCalculationUtils**: *object* -*Defined in [order-utils/src/order_calculation_utils.ts:6](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_calculation_utils.ts#L6)* +*Defined in [order-utils/src/order_calculation_utils.ts:6](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/order_calculation_utils.ts#L6)* #### getMakerFeeAmount ▸ **getMakerFeeAmount**(`order`: `Order`, `makerFillAmount`: `BigNumber`): *`BigNumber`* -*Defined in [order-utils/src/order_calculation_utils.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_calculation_utils.ts#L75)* +*Defined in [order-utils/src/order_calculation_utils.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/order_calculation_utils.ts#L75)* Given an amount of maker asset, calculate the fee amount required for the maker @@ -3996,7 +2453,7 @@ Name | Type | Description | ▸ **getMakerFillAmount**(`order`: `Order`, `takerFillAmount`: `BigNumber`): *`BigNumber`* -*Defined in [order-utils/src/order_calculation_utils.ts:36](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_calculation_utils.ts#L36)* +*Defined in [order-utils/src/order_calculation_utils.ts:36](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/order_calculation_utils.ts#L36)* Given an amount of taker asset, calculate the the amount of maker asset @@ -4013,7 +2470,7 @@ Name | Type | Description | ▸ **getTakerFeeAmount**(`order`: `Order`, `takerFillAmount`: `BigNumber`): *`BigNumber`* -*Defined in [order-utils/src/order_calculation_utils.ts:62](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_calculation_utils.ts#L62)* +*Defined in [order-utils/src/order_calculation_utils.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/order_calculation_utils.ts#L62)* Given an amount of taker asset, calculate the fee amount required for the taker @@ -4030,7 +2487,7 @@ Name | Type | Description | ▸ **getTakerFillAmount**(`order`: `Order`, `makerFillAmount`: `BigNumber`): *`BigNumber`* -*Defined in [order-utils/src/order_calculation_utils.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_calculation_utils.ts#L49)* +*Defined in [order-utils/src/order_calculation_utils.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/order_calculation_utils.ts#L49)* Given an amount of maker asset, calculate the equivalent amount in taker asset @@ -4047,7 +2504,7 @@ Name | Type | Description | ▸ **getTakerFillAmountForFeeOrder**(`order`: `Order`, `makerFillAmount`: `BigNumber`): *[`BigNumber`, `BigNumber`]* -*Defined in [order-utils/src/order_calculation_utils.ts:89](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_calculation_utils.ts#L89)* +*Defined in [order-utils/src/order_calculation_utils.ts:89](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/order_calculation_utils.ts#L89)* Given a desired amount of ZRX from a fee order, calculate the amount of taker asset required to fill. Also calculate how much ZRX needs to be purchased in order to fill the desired amount plus the taker fee amount @@ -4059,175 +2516,56 @@ Name | Type | Description | `order` | `Order` | The order | `makerFillAmount` | `BigNumber` | the amount of maker asset | -**Returns:** *[`BigNumber`, `BigNumber`]* - -#### isOpenOrder - -▸ **isOpenOrder**(`order`: `Order`): *boolean* - -*Defined in [order-utils/src/order_calculation_utils.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_calculation_utils.ts#L28)* - -Determines if the order is open and fillable by any taker. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | `Order` | The order | - -**Returns:** *boolean* - -#### isOrderExpired - -▸ **isOrderExpired**(`order`: `Order`): *boolean* - -*Defined in [order-utils/src/order_calculation_utils.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_calculation_utils.ts#L11)* - -Determines if the order is expired given the current time - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | `Order` | The order for expiry calculation | - -**Returns:** *boolean* - -#### willOrderExpire - -▸ **willOrderExpire**(`order`: `Order`, `secondsFromNow`: number): *boolean* - -*Defined in [order-utils/src/order_calculation_utils.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/order_calculation_utils.ts#L19)* - -Calculates if the order will expire in the future. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`order` | `Order` | The order for expiry calculation | -`secondsFromNow` | number | The amount of seconds from current time | - -**Returns:** *boolean* - -
- - - - -## Object literals - -#### `Const` orderHashUtils - -#### ▪ **orderHashUtils**: *object* - -*Defined in [order-utils/src/order_hash.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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. - -
- - - -
- - +**Returns:** *[`BigNumber`, `BigNumber`]* -
+#### isOpenOrder +▸ **isOpenOrder**(`order`: `Order`): *boolean* +*Defined in [order-utils/src/order_calculation_utils.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/order_calculation_utils.ts#L28)* +Determines if the order is open and fillable by any taker. -## Object literals +**Parameters:** -#### `Const` orderParsingUtils +Name | Type | Description | +------ | ------ | ------ | +`order` | `Order` | The order | -#### ▪ **orderParsingUtils**: *object* +**Returns:** *boolean* -*Defined in [order-utils/src/parsing_utils.ts:4](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/parsing_utils.ts#L4)* +#### isOrderExpired -#### convertOrderStringFieldsToBigNumber +▸ **isOrderExpired**(`order`: `Order`): *boolean* -▸ **convertOrderStringFieldsToBigNumber**(`order`: any): *any* +*Defined in [order-utils/src/order_calculation_utils.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/order_calculation_utils.ts#L11)* -*Defined in [order-utils/src/parsing_utils.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/parsing_utils.ts#L17)* +Determines if the order is expired given the current time **Parameters:** -Name | Type | ------- | ------ | -`order` | any | +Name | Type | Description | +------ | ------ | ------ | +`order` | `Order` | The order for expiry calculation | + +**Returns:** *boolean* -**Returns:** *any* +#### willOrderExpire -#### convertStringsFieldsToBigNumbers +▸ **willOrderExpire**(`order`: `Order`, `secondsFromNow`: number): *boolean* -▸ **convertStringsFieldsToBigNumbers**(`obj`: any, `fields`: string[]): *any* +*Defined in [order-utils/src/order_calculation_utils.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/order_calculation_utils.ts#L19)* -*Defined in [order-utils/src/parsing_utils.ts:5](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/parsing_utils.ts#L5)* +Calculates if the order will expire in the future. **Parameters:** -Name | Type | ------- | ------ | -`obj` | any | -`fields` | string[] | +Name | Type | Description | +------ | ------ | ------ | +`order` | `Order` | The order for expiry calculation | +`secondsFromNow` | number | The amount of seconds from current time | -**Returns:** *any* +**Returns:** *boolean*
@@ -4240,13 +2578,13 @@ Name | Type | #### ▪ **rateUtils**: *object* -*Defined in [order-utils/src/rate_utils.ts:8](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/rate_utils.ts#L8)* +*Defined in [order-utils/src/rate_utils.ts:8](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/rate_utils.ts#L8)* #### getFeeAdjustedRateOfFeeOrder ▸ **getFeeAdjustedRateOfFeeOrder**(`feeOrder`: `Order`): *`BigNumber`* -*Defined in [order-utils/src/rate_utils.ts:36](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/rate_utils.ts#L36)* +*Defined in [order-utils/src/rate_utils.ts:36](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/rate_utils.ts#L36)* Takes a fee order (makerAssetData corresponds to ZRX and takerAssetData corresponds to WETH) and calculates the fee adjusted rate (WETH/ZRX) by dividing the takerAssetAmount by the makerAmount minus the takerFee @@ -4265,7 +2603,7 @@ The rate (WETH/ZRX) of the fee order adjusted for fees ▸ **getFeeAdjustedRateOfOrder**(`order`: `Order`, `feeRate`: `BigNumber`): *`BigNumber`* -*Defined in [order-utils/src/rate_utils.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/rate_utils.ts#L18)* +*Defined in [order-utils/src/rate_utils.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/rate_utils.ts#L18)* Takes an order and calculates the fee adjusted rate (takerAsset/makerAsset) by calculating how much takerAsset is required to cover the fees (feeRate * takerFee), adding the takerAssetAmount and dividing by makerAssetAmount @@ -4292,7 +2630,7 @@ The rate (takerAsset/makerAsset) of the order adjusted for fees ▸ **generatePseudoRandomSalt**(): *`BigNumber`* -*Defined in [order-utils/src/salt.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/salt.ts#L9)* +*Defined in [order-utils/src/salt.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -4307,19 +2645,60 @@ A pseudo-random 256-bit number that can be used as a salt. -## Object literals +## Functions + +#### isValidECSignature + +▸ **isValidECSignature**(`data`: string, `signature`: `ECSignature`, `signerAddress`: string): *boolean* + +*Defined in [order-utils/src/signature_utils.ts:353](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L353)* + +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. + +___ + +### parseSignatureHexAsVRS + +▸ **parseSignatureHexAsVRS**(`signatureHex`: string): *`ECSignature`* + +*Defined in [order-utils/src/signature_utils.ts:311](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L311)* + +Parses a signature hex string, which is assumed to be in the VRS format. + +**Parameters:** + +Name | Type | +------ | ------ | +`signatureHex` | string | -#### `Const` signatureUtils +**Returns:** *`ECSignature`* + +## Object literals + +### `Const` signatureUtils #### ▪ **signatureUtils**: *object* -*Defined in [order-utils/src/signature_utils.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/signature_utils.ts#L27)* +*Defined in [order-utils/src/signature_utils.ts:26](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L26)* #### addSignedMessagePrefix ▸ **addSignedMessagePrefix**(`message`: string): *string* -*Defined in [order-utils/src/signature_utils.ts:500](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/signature_utils.ts#L500)* +*Defined in [order-utils/src/signature_utils.ts:284](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L284)* Adds the relevant prefix to the message being signed. @@ -4337,7 +2716,7 @@ Prefixed message ▸ **convertECSignatureToSignatureHex**(`ecSignature`: `ECSignature`): *string* -*Defined in [order-utils/src/signature_utils.ts:474](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/signature_utils.ts#L474)* +*Defined in [order-utils/src/signature_utils.ts:258](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L258)* Combines ECSignature with V,R,S and the EthSign signature type for use in 0x protocol @@ -4355,7 +2734,7 @@ Hex encoded string of signature (v,r,s) with Signature Type ▸ **convertToSignatureWithType**(`signature`: string, `signatureType`: `SignatureType`): *string* -*Defined in [order-utils/src/signature_utils.ts:490](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/signature_utils.ts#L490)* +*Defined in [order-utils/src/signature_utils.ts:274](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L274)* Combines the signature proof and the Signature Type. @@ -4374,7 +2753,7 @@ Hex encoded string of signature proof with Signature Type ▸ **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/c93b02d55/packages/order-utils/src/signature_utils.ts#L417)* +*Defined in [order-utils/src/signature_utils.ts:209](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L209)* Signs a hash using `eth_sign` and returns its elliptic curve signature and signature type. @@ -4394,7 +2773,7 @@ A hex encoded string containing the Elliptic curve signature generated by signin ▸ **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/c93b02d55/packages/order-utils/src/signature_utils.ts#L252)* +*Defined in [order-utils/src/signature_utils.ts:36](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L36)* 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. @@ -4415,7 +2794,7 @@ A SignedOrder containing the order and Elliptic curve signature with Signature T ▸ **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/c93b02d55/packages/order-utils/src/signature_utils.ts#L331)* +*Defined in [order-utils/src/signature_utils.ts:117](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L117)* 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. @@ -4436,7 +2815,7 @@ A SignedTransaction containing the order and Elliptic curve signature with Signa ▸ **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/c93b02d55/packages/order-utils/src/signature_utils.ts#L287)* +*Defined in [order-utils/src/signature_utils.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L73)* Signs an order using `eth_signTypedData` and returns a SignedOrder. @@ -4456,7 +2835,7 @@ A SignedOrder containing the order and Elliptic curve signature with Signature T ▸ **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/c93b02d55/packages/order-utils/src/signature_utils.ts#L374)* +*Defined in [order-utils/src/signature_utils.ts:166](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L166)* Signs a ZeroExTransaction using `eth_signTypedData` and returns a SignedZeroExTransaction. @@ -4472,136 +2851,11 @@ Name | Type | Description | 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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/packages/order-utils/src/signature_utils.ts#L529)* +*Defined in [order-utils/src/signature_utils.ts:296](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/signature_utils.ts#L296)* Parse a hex-encoded Validator signature into validator address and signature components @@ -4626,13 +2880,13 @@ A ValidatorSignature with validatorAddress and signature parameters #### ▪ **sortingUtils**: *object* -*Defined in [order-utils/src/sorting_utils.ts:10](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/sorting_utils.ts#L10)* +*Defined in [order-utils/src/sorting_utils.ts:10](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/sorting_utils.ts#L10)* #### sortFeeOrdersByFeeAdjustedRate ▸ **sortFeeOrdersByFeeAdjustedRate**<**T**>(`feeOrders`: `T`[]): *`T`[]* -*Defined in [order-utils/src/sorting_utils.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/sorting_utils.ts#L35)* +*Defined in [order-utils/src/sorting_utils.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/sorting_utils.ts#L35)* Takes an array of fee orders (makerAssetData corresponds to ZRX and takerAssetData corresponds to WETH) and sorts them by rate in ascending order (best rate first). Adjusts the rate according to the takerFee. @@ -4655,7 +2909,7 @@ The input orders sorted by rate in ascending order ▸ **sortOrdersByFeeAdjustedRate**<**T**>(`orders`: `T`[], `feeRate`: `BigNumber`): *`T`[]* -*Defined in [order-utils/src/sorting_utils.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/order-utils/src/sorting_utils.ts#L21)* +*Defined in [order-utils/src/sorting_utils.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/order-utils/src/sorting_utils.ts#L21)* Takes an array of orders and sorts them by takerAsset/makerAsset rate in ascending order (best rate first). Adjusts the rate of each order according to the feeRate and takerFee for that order. @@ -4681,135 +2935,3 @@ The input orders sorted by rate in ascending order
- - -
- - - -
- - - - -## Object literals - -#### `Const` transactionHashUtils - -#### ▪ **transactionHashUtils**: *object* - -*Defined in [order-utils/src/transaction_hash.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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/c93b02d55/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/c93b02d55/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/c93b02d55/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 - - - -### AssetData - -Ƭ **AssetData**: *[SingleAssetData](_types_src_index_.md#singleassetdata) | [MultiAssetData](#interface-multiassetdata) | [MultiAssetDataWithRecursiveDecoding](#interface-multiassetdatawithrecursivedecoding)* - -*Defined in [types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L224)* - -___ - - - - - -### EIP712ObjectValue - -Ƭ **EIP712ObjectValue**: *string | number | [EIP712Object](#interface-eip712object)* - -*Defined in [types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L740)* - -___ - - - - - -### OrderState - -Ƭ **OrderState**: *[OrderStateValid](#interface-orderstatevalid) | [OrderStateInvalid](#interface-orderstateinvalid)* - -*Defined in [types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L141)* - -___ - - - - - -### SingleAssetData - -Ƭ **SingleAssetData**: *[ERC20AssetData](#interface-erc20assetdata) | [ERC721AssetData](#interface-erc721assetdata) | [ERC1155AssetData](#interface-erc1155assetdata) | [StaticCallAssetData](#interface-staticcallassetdata)* - -*Defined in [types/src/index.ts:204](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L204)* - -
- diff --git a/packages/orderbook/CHANGELOG.json b/packages/orderbook/CHANGELOG.json index 5312ffda33..f9ce0191b2 100644 --- a/packages/orderbook/CHANGELOG.json +++ b/packages/orderbook/CHANGELOG.json @@ -10,7 +10,8 @@ "note": "Update Mesh RPC logic to v6.0.1-beta", "pr": 2325 } - ] + ], + "timestamp": 1574030254 }, { "version": "0.1.0-beta.1", diff --git a/packages/orderbook/CHANGELOG.md b/packages/orderbook/CHANGELOG.md index 460d9ca387..8024d6b07a 100644 --- a/packages/orderbook/CHANGELOG.md +++ b/packages/orderbook/CHANGELOG.md @@ -5,6 +5,11 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v0.1.0-beta.2 - _November 17, 2019_ + + * Added dependency on @0x/contracts-dev-utils (#2321) + * Update Mesh RPC logic to v6.0.1-beta (#2325) + ## v0.1.0-beta.1 - _November 7, 2019_ * All references to network ID have been removed, and references to chain ID have been introduced instead (#2313) diff --git a/packages/sol-compiler/CHANGELOG.json b/packages/sol-compiler/CHANGELOG.json index fa0caa14b7..dff2eecf40 100644 --- a/packages/sol-compiler/CHANGELOG.json +++ b/packages/sol-compiler/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Add `shouldSaveStandardInput` config", "pr": 2322 } - ] + ], + "timestamp": 1574030254 }, { "version": "3.2.0-beta.1", diff --git a/packages/sol-compiler/CHANGELOG.md b/packages/sol-compiler/CHANGELOG.md index 31bcc8e965..8de5b76321 100644 --- a/packages/sol-compiler/CHANGELOG.md +++ b/packages/sol-compiler/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.2.0-beta.2 - _November 17, 2019_ + + * Add `shouldSaveStandardInput` config (#2322) + ## v3.2.0-beta.1 - _November 7, 2019_ * Output artifacts now include a 'chains' attribute rather than 'networks' (#2313) diff --git a/packages/sol-compiler/docs/reference.mdx b/packages/sol-compiler/docs/reference.mdx index dfeab02abd..e8a35867b9 100644 --- a/packages/sol-compiler/docs/reference.mdx +++ b/packages/sol-compiler/docs/reference.mdx @@ -1,81 +1,7 @@ -# Class: Compiler - -The Compiler facilitates compiling Solidity smart contracts and saves the results -to artifact files. - - -## Constructors - - - -\+ **new Compiler**(`opts?`: [CompilerOptions](#interface-compileroptions)): *[Compiler](#class-compiler)* - -*Defined in [sol-compiler/src/compiler.ts:97](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-compiler/src/compiler.ts#L97)* - -Instantiates a new instance of the Compiler class. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`opts?` | [CompilerOptions](#interface-compileroptions) | Optional compiler options | - -**Returns:** *[Compiler](#class-compiler)* - -An instance of the Compiler class. - -## Methods - -### compileAsync - -▸ **compileAsync**(): *`Promise`* - -*Defined in [sol-compiler/src/compiler.ts:138](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-compiler/src/compiler.ts#L138)* - -Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`. - -**Returns:** *`Promise`* - -___ - -### getCompilerOutputsAsync - -▸ **getCompilerOutputsAsync**(): *`Promise`* - -*Defined in [sol-compiler/src/compiler.ts:151](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-compiler/src/compiler.ts#L151)* -Compiles Solidity files specified during instantiation, and returns the -compiler output given by solc. Return value is an array of outputs: -Solidity modules are batched together by version required, and each -element of the returned array corresponds to a compiler version, and -each element contains the output for all of the modules compiled with -that version. - -**Returns:** *`Promise`* - -___ - -### getContractNamesToCompile - -▸ **getContractNamesToCompile**(): *string[]* - -*Defined in [sol-compiler/src/compiler.ts:192](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-compiler/src/compiler.ts#L192)* - -Gets a list of contracts to compile. - -**Returns:** *string[]* - -___ -### watchAsync - -▸ **watchAsync**(): *`Promise`* -*Defined in [sol-compiler/src/compiler.ts:155](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-compiler/src/compiler.ts#L155)* -**Returns:** *`Promise`* - -
@@ -84,6 +10,7 @@ ___ +
@@ -110,6 +37,7 @@ useDockerisedSolc: If set to true - sol-compiler will try calling a dockerized i isOfflineMode: If set to true - sol-compiler will not fetch the list of solc releases from github. It will use the hardcoded list. Defaults to false. solcVersion: If you don't want to compile each contract with the Solidity version specified in-file, you can force all contracts to compile with the the version specified here. +shouldSaveStandardInput: Write the standard JSON input in ${contractsDir}/${contractName}.input.json ## Properties @@ -118,7 +46,7 @@ contracts to compile with the the version specified here. • **artifactsDir**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:731](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L731)* +*Defined in [ethereum-types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L733)* ___ @@ -126,7 +54,7 @@ ___ • **compilerSettings**? : *[CompilerSettings](#class-compilersettings)* -*Defined in [ethereum-types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L732)* +*Defined in [ethereum-types/src/index.ts:734](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L734)* ___ @@ -134,7 +62,7 @@ ___ • **contracts**? : *string[] | "*"* -*Defined in [ethereum-types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L733)* +*Defined in [ethereum-types/src/index.ts:735](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L735)* ___ @@ -142,7 +70,7 @@ ___ • **contractsDir**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:730](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L730)* +*Defined in [ethereum-types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L732)* ___ @@ -150,7 +78,15 @@ ___ • **isOfflineMode**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:735](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L735)* +*Defined in [ethereum-types/src/index.ts:737](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L737)* + +___ + +### `Optional` shouldSaveStandardInput + +• **shouldSaveStandardInput**? : *undefined | false | true* + +*Defined in [ethereum-types/src/index.ts:739](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L739)* ___ @@ -158,7 +94,7 @@ ___ • **solcVersion**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:736](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L736)* +*Defined in [ethereum-types/src/index.ts:738](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L738)* ___ @@ -166,7 +102,7 @@ ___ • **useDockerisedSolc**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:734](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L734)* +*Defined in [ethereum-types/src/index.ts:736](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L736)*
@@ -181,7 +117,7 @@ ___ • **evmVersion**? : *"homestead" | "tangerineWhistle" | "spuriousDragon" | "byzantium" | "constantinople"* -*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L689)* +*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L690)* ___ @@ -189,7 +125,7 @@ ___ • **libraries**? : *undefined | object* -*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L691)* +*Defined in [ethereum-types/src/index.ts:692](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L692)* ___ @@ -197,7 +133,7 @@ ___ • **metadata**? : *[CompilerSettingsMetadata](#class-compilersettingsmetadata)* -*Defined in [ethereum-types/src/index.ts:690](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L690)* +*Defined in [ethereum-types/src/index.ts:691](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L691)* ___ @@ -205,7 +141,7 @@ ___ • **optimizer**? : *[OptimizerSettings](#class-optimizersettings)* -*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L688)* +*Defined in [ethereum-types/src/index.ts:689](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L689)* ___ @@ -213,7 +149,7 @@ ___ • **outputSelection**: *object* -*Defined in [ethereum-types/src/index.ts:696](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L696)* +*Defined in [ethereum-types/src/index.ts:697](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L697)* #### Type declaration: @@ -227,7 +163,7 @@ ___ • **remappings**? : *string[]* -*Defined in [ethereum-types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L687)* +*Defined in [ethereum-types/src/index.ts:688](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L688)*
@@ -240,7 +176,7 @@ ___ • **useLiteralContent**: *true* -*Defined in [ethereum-types/src/index.ts:704](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L704)* +*Defined in [ethereum-types/src/index.ts:705](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L705)*
@@ -253,7 +189,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L103)* +*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L103)* ___ @@ -261,7 +197,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L104)* +*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L104)* ___ @@ -269,7 +205,7 @@ ___ • **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L105)* +*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L105)* ___ @@ -277,7 +213,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L102)* +*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L102)*
@@ -296,7 +232,15 @@ ___ • **components**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)* + +___ + +### `Optional` internalType + +• **internalType**? : *undefined | string* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -304,7 +248,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -312,7 +256,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -329,7 +273,7 @@ ___ • **author**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L628)* +*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L629)* ___ @@ -337,7 +281,7 @@ ___ • **methods**: *object* -*Defined in [ethereum-types/src/index.ts:629](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L629)* +*Defined in [ethereum-types/src/index.ts:630](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L630)* #### Type declaration: @@ -349,7 +293,7 @@ ___ • **title**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:627](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L627)* +*Defined in [ethereum-types/src/index.ts:628](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L628)*
@@ -364,7 +308,7 @@ ___ • **anonymous**: *boolean* -*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L131)* +*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L131)* ___ @@ -372,7 +316,7 @@ ___ • **inputs**: *[EventParameter](#class-eventparameter)[]* -*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L130)* +*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L130)* ___ @@ -380,7 +324,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L129)* +*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L129)* ___ @@ -388,7 +332,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L128)* +*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L128)*
@@ -403,7 +347,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)* ___ @@ -411,7 +355,17 @@ ___ • **indexed**: *boolean* -*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L116)* +*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L116)* + +___ + +### `Optional` internalType + +• **internalType**? : *undefined | string* + +*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -421,7 +375,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -431,7 +385,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -444,7 +398,7 @@ ___ • **object**: *string* -*Defined in [ethereum-types/src/index.ts:622](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L622)* +*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L623)* ___ @@ -452,7 +406,7 @@ ___ • **sourceMap**: *string* -*Defined in [ethereum-types/src/index.ts:623](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L623)* +*Defined in [ethereum-types/src/index.ts:624](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L624)*
@@ -465,7 +419,7 @@ ___ • **bytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [ethereum-types/src/index.ts:617](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L617)* +*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L618)* ___ @@ -473,7 +427,7 @@ ___ • **deployedBytecode**: *[EvmBytecodeOutput](#class-evmbytecodeoutput)* -*Defined in [ethereum-types/src/index.ts:618](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L618)* +*Defined in [ethereum-types/src/index.ts:619](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L619)*
@@ -486,7 +440,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L112)* +*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L112)* ___ @@ -494,13 +448,90 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L111)* +*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L111)*
+# Class: Compiler + +The Compiler facilitates compiling Solidity smart contracts and saves the results +to artifact files. + + +## Constructors + + + +\+ **new Compiler**(`opts?`: [CompilerOptions](#interface-compileroptions)): *[Compiler](#class-compiler)* + +*Defined in [sol-compiler/src/compiler.ts:100](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L100)* + +Instantiates a new instance of the Compiler class. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`opts?` | [CompilerOptions](#interface-compileroptions) | Optional compiler options | + +**Returns:** *[Compiler](#class-compiler)* + +An instance of the Compiler class. + +## Methods + +### compileAsync + +▸ **compileAsync**(): *`Promise`* + +*Defined in [sol-compiler/src/compiler.ts:143](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L143)* + +Compiles selected Solidity files found in `contractsDir` and writes JSON artifacts to `artifactsDir`. + +**Returns:** *`Promise`* + +___ + +### getCompilerOutputsAsync + +▸ **getCompilerOutputsAsync**(): *`Promise`* + +*Defined in [sol-compiler/src/compiler.ts:156](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L156)* + +Compiles Solidity files specified during instantiation, and returns the +compiler output given by solc. Return value is an array of outputs: +Solidity modules are batched together by version required, and each +element of the returned array corresponds to a compiler version, and +each element contains the output for all of the modules compiled with +that version. + +**Returns:** *`Promise`* + +___ + +### getContractNamesToCompile + +▸ **getContractNamesToCompile**(): *string[]* + +*Defined in [sol-compiler/src/compiler.ts:197](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L197)* + +Gets a list of contracts to compile. + +**Returns:** *string[]* + +___ + +### watchAsync +▸ **watchAsync**(): *`Promise`* + +*Defined in [sol-compiler/src/compiler.ts:160](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-compiler/src/compiler.ts#L160)* + +**Returns:** *`Promise`* + +
@@ -525,7 +556,7 @@ ___ • **constant**: *boolean* -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L94)* +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L94)* ___ @@ -533,7 +564,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L92)* +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L92)* ___ @@ -541,7 +572,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L91)* +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L91)* ___ @@ -549,7 +580,7 @@ ___ • **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L93)* +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L93)* ___ @@ -557,7 +588,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L96)* +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L96)* ___ @@ -565,7 +596,7 @@ ___ • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L95)* +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L95)* ___ @@ -573,7 +604,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L90)* +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L90)*
@@ -586,7 +617,7 @@ ___ • **enabled**: *boolean* -*Defined in [ethereum-types/src/index.ts:708](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L708)* +*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L709)* ___ @@ -594,7 +625,7 @@ ___ • **runs**? : *undefined | number* -*Defined in [ethereum-types/src/index.ts:709](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L709)* +*Defined in [ethereum-types/src/index.ts:710](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L710)*
@@ -611,7 +642,7 @@ ___ • **arguments**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L122)* +*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L122)* ___ @@ -619,7 +650,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L121)* +*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L121)* ___ @@ -627,7 +658,7 @@ ___ • **type**: *"error"* -*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L120)* +*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L120)*
@@ -640,7 +671,7 @@ ___ • **component**: *"general" | "ewasm"* -*Defined in [ethereum-types/src/index.ts:604](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L604)* +*Defined in [ethereum-types/src/index.ts:605](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L605)* ___ @@ -648,7 +679,7 @@ ___ • **formattedMessage**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:607](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L607)* +*Defined in [ethereum-types/src/index.ts:608](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L608)* ___ @@ -656,7 +687,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:606](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L606)* +*Defined in [ethereum-types/src/index.ts:607](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L607)* ___ @@ -664,7 +695,7 @@ ___ • **severity**: *[ErrorSeverity](#errorseverity)* -*Defined in [ethereum-types/src/index.ts:605](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L605)* +*Defined in [ethereum-types/src/index.ts:606](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L606)* ___ @@ -672,7 +703,7 @@ ___ • **sourceLocation**? : *[SourceLocation](#class-sourcelocation)* -*Defined in [ethereum-types/src/index.ts:602](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L602)* +*Defined in [ethereum-types/src/index.ts:603](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L603)* ___ @@ -680,7 +711,7 @@ ___ • **type**: *[ErrorType](#errortype)* -*Defined in [ethereum-types/src/index.ts:603](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L603)* +*Defined in [ethereum-types/src/index.ts:604](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L604)*
@@ -697,7 +728,7 @@ ___ • **abi**: *[ContractAbi](#contractabi)* -*Defined in [ethereum-types/src/index.ts:564](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L564)* +*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L565)* ___ @@ -705,7 +736,7 @@ ___ • **devdoc**? : *[DevdocOutput](#class-devdocoutput)* -*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L566)* +*Defined in [ethereum-types/src/index.ts:567](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L567)* ___ @@ -713,7 +744,7 @@ ___ • **evm**: *[EvmOutput](#class-evmoutput)* -*Defined in [ethereum-types/src/index.ts:565](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L565)* +*Defined in [ethereum-types/src/index.ts:566](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L566)*
@@ -726,7 +757,7 @@ ___ • **contracts**: *object* -*Defined in [ethereum-types/src/index.ts:578](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L578)* +*Defined in [ethereum-types/src/index.ts:579](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L579)* #### Type declaration: @@ -740,7 +771,7 @@ ___ • **errors**: *[SolcError](#class-solcerror)[]* -*Defined in [ethereum-types/src/index.ts:570](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L570)* +*Defined in [ethereum-types/src/index.ts:571](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L571)* ___ @@ -748,7 +779,7 @@ ___ • **sources**: *object* -*Defined in [ethereum-types/src/index.ts:571](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L571)* +*Defined in [ethereum-types/src/index.ts:572](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L572)* #### Type declaration: @@ -779,7 +810,17 @@ ___ *Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L141)* +*Defined in [ethereum-types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L142)* + +___ + +### `Optional` internalType + +• **internalType**? : *undefined | string* + +*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -789,7 +830,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -799,7 +840,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -824,7 +865,7 @@ ___ Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)* -*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L80)* +*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L80)* ___ @@ -834,7 +875,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L84)* ___ @@ -842,7 +883,7 @@ ___ Ƭ **ContractAbi**: *[AbiDefinition](#abidefinition)[]* -*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L78)* +*Defined in [ethereum-types/src/index.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L78)* ___ @@ -856,7 +897,7 @@ ___ Ƭ **ErrorSeverity**: *"error" | "warning"* -*Defined in [ethereum-types/src/index.ts:599](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L599)* +*Defined in [ethereum-types/src/index.ts:600](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L600)* ___ @@ -864,7 +905,7 @@ ___ Ƭ **ErrorType**: *"JSONError" | "IOError" | "ParserError" | "DocstringParsingError" | "SyntaxError" | "DeclarationError" | "TypeError" | "UnimplementedFeatureError" | "InternalCompilerError" | "Exception" | "CompilerError" | "FatalError" | "Warning"* -*Defined in [ethereum-types/src/index.ts:585](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L585)* +*Defined in [ethereum-types/src/index.ts:586](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L586)* ___ @@ -872,7 +913,7 @@ ___ Ƭ **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/c93b02d55/packages/ethereum-types/src/index.ts#L82)* +*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L82)* ___ @@ -884,7 +925,7 @@ ___ Ƭ **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:525](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L525)* +*Defined in [ethereum-types/src/index.ts:526](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L526)* ___ @@ -892,7 +933,7 @@ ___ Ƭ **ParamDescription**: *string* -*Defined in [ethereum-types/src/index.ts:561](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L561)* +*Defined in [ethereum-types/src/index.ts:562](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L562)* ___ @@ -902,7 +943,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L85)* ___ @@ -914,7 +955,3 @@ ___ - - -
- diff --git a/packages/sol-coverage/CHANGELOG.json b/packages/sol-coverage/CHANGELOG.json index c78ee9bafa..95cb749f9c 100644 --- a/packages/sol-coverage/CHANGELOG.json +++ b/packages/sol-coverage/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "3.1.0-beta.1", diff --git a/packages/sol-coverage/CHANGELOG.md b/packages/sol-coverage/CHANGELOG.md index 53a691d8bd..7fd7ecfc2a 100644 --- a/packages/sol-coverage/CHANGELOG.md +++ b/packages/sol-coverage/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.1.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v3.1.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/sol-coverage/docs/reference.mdx b/packages/sol-coverage/docs/reference.mdx index a0b9c1e7fe..a1c4d94dbd 100644 --- a/packages/sol-coverage/docs/reference.mdx +++ b/packages/sol-coverage/docs/reference.mdx @@ -1,249 +1,185 @@ -# Class: CoverageSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It's used to compute your code coverage while running solidity tests. -## Constructors +# Class: AbstractArtifactAdapter +## Methods -\+ **new CoverageSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `partialConfig`: [CoverageSubproviderPartialConfig](#coveragesubproviderpartialconfig)): *[CoverageSubprovider](#class-coveragesubprovider)* +### `Abstract` collectContractsDataAsync -*Overrides void* +▸ **collectContractsDataAsync**(): *`Promise`* -*Defined in [sol-coverage/src/coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L44)* +*Defined in [sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts:4](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)* -Instantiates a CoverageSubprovider instance +**Returns:** *`Promise`* -**Parameters:** +
-Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) | -`defaultFromAddress` | string | - | default from address to use when sending transactions | -`partialConfig` | [CoverageSubproviderPartialConfig](#coveragesubproviderpartialconfig) | {} | Partial configuration object | +# Class: SolCompilerArtifactAdapter -**Returns:** *[CoverageSubprovider](#class-coveragesubprovider)* -## Methods +## Constructors -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* +\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* -Defined in subproviders/lib/src/subproviders/subprovider.d.ts:25 +*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)* -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. +Instantiates a SolCompilerArtifactAdapter **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [NextCallback](#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise`* +`artifactsPath?` | undefined \| string | Path to your artifacts directory | +`sourcesPath?` | undefined \| string | Path to your contract sources directory | +**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* +## Methods -*Overrides void* +### collectContractsDataAsync -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 +▸ **collectContractsDataAsync**(): *`Promise`* -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. +*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* -**Parameters:** +*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [NextCallback](#nextcallback) | 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`* -**Returns:** *`Promise`* +
-___ +# Class: TruffleArtifactAdapter -### setEngine -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* +## Constructors -*Overrides void* +\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)* -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 +*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* -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. +Instantiates a TruffleArtifactAdapter **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -___ - -### start - -▸ **start**(): *void* - - - -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 - -Starts trace collection - -**Returns:** *void* - -___ - -### stop - -▸ **stop**(): *void* - - - -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 - -Stops trace collection +`projectRoot` | string | Path to the truffle project's root directory | +`solcVersion` | string | Solidity version with which to compile all the contracts | -**Returns:** *void* +**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)* -___ +## Methods -### writeCoverageAsync +### collectContractsDataAsync -▸ **writeCoverageAsync**(): *`Promise`* +▸ **collectContractsDataAsync**(): *`Promise`* -*Defined in [sol-coverage/src/coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L78)* +*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* -Write the test coverage results to a file in Istanbul format. +*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* -**Returns:** *`Promise`* +**Returns:** *`Promise`*
-# Class: AbstractArtifactAdapter -## Methods -### `Abstract` collectContractsDataAsync -▸ **collectContractsDataAsync**(): *`Promise`* -*Defined in [sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts:4](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)* -**Returns:** *`Promise`* -
-# Class: SolCompilerArtifactAdapter -## Constructors -\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* -*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)* -Instantiates a SolCompilerArtifactAdapter -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`artifactsPath?` | undefined \| string | Path to your artifacts directory | -`sourcesPath?` | undefined \| string | Path to your contract sources directory | - -**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* -## Methods -### collectContractsDataAsync +## Type aliases -▸ **collectContractsDataAsync**(): *`Promise`* +### Callback -*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* +Ƭ **Callback**: *function* -*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* +*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L131)* -**Returns:** *`Promise`* +#### Type declaration: -
+▸ (): *void* -# Class: TruffleArtifactAdapter +___ -## Constructors +### ErrorCallback +Ƭ **ErrorCallback**: *function* -\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)* +*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L130)* -*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* +#### Type declaration: -Instantiates a TruffleArtifactAdapter +▸ (`err`: `Error` | null, `data?`: any): *void* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`projectRoot` | string | Path to the truffle project's root directory | -`solcVersion` | string | Solidity version with which to compile all the contracts | - -**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)* - -## Methods - -### collectContractsDataAsync - -▸ **collectContractsDataAsync**(): *`Promise`* - -*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* +Name | Type | +------ | ------ | +`err` | `Error` \| null | +`data?` | any | -*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* +___ -**Returns:** *`Promise`* -
+### NextCallback +Ƭ **NextCallback**: *function* +*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L133)* +#### Type declaration: +▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void* +**Parameters:** +Name | Type | +------ | ------ | +`callback?` | [OnNextCompleted](#onnextcompleted) | +___ +### OnNextCompleted +Ƭ **OnNextCompleted**: *function* +*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L132)* +#### Type declaration: +▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void* +**Parameters:** +Name | Type | +------ | ------ | +`err` | `Error` \| null | +`result` | any | +`cb` | [Callback](#callback) | +
@@ -308,7 +244,7 @@ Name | Type | Description | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* ___ @@ -316,7 +252,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* ___ @@ -324,7 +260,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* ___ @@ -332,7 +268,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
@@ -345,7 +281,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* ___ @@ -353,7 +289,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
@@ -366,7 +302,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* ___ @@ -374,7 +310,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* ___ @@ -382,7 +318,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* ___ @@ -390,7 +326,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
@@ -425,111 +361,169 @@ ___ + +# Class: CoverageSubprovider + +This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. +It's used to compute your code coverage while running solidity tests. + + +## Constructors +\+ **new CoverageSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `partialConfig`: [CoverageSubproviderPartialConfig](#coveragesubproviderpartialconfig)): *[CoverageSubprovider](#class-coveragesubprovider)* +*Overrides void* +*Defined in [sol-coverage/src/coverage_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L44)* +Instantiates a CoverageSubprovider instance +**Parameters:** +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) | +`defaultFromAddress` | string | - | default from address to use when sending transactions | +`partialConfig` | [CoverageSubproviderPartialConfig](#coveragesubproviderpartialconfig) | {} | Partial configuration object | +**Returns:** *[CoverageSubprovider](#class-coveragesubprovider)* +## Methods +### emitPayloadAsync +▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* +Defined in subproviders/lib/src/subproviders/subprovider.d.ts:25 +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`: [NextCallback](#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise`* +*Overrides void* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 +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` | [NextCallback](#nextcallback) | 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* - +*Overrides void* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 +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* +___ +### start +▸ **start**(): *void* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 +Starts trace collection +**Returns:** *void* +___ +### stop +▸ **stop**(): *void* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 -# Interface: JSONRPCRequestPayloadWithMethod +Stops trace collection +**Returns:** *void* -## Properties +___ -### id +### writeCoverageAsync -• **id**: *number* +▸ **writeCoverageAsync**(): *`Promise`* +*Defined in [sol-coverage/src/coverage_subprovider.ts:78](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L78)* +Write the test coverage results to a file in Istanbul format. + +**Returns:** *`Promise`* + +
-Defined in ethereum-types/lib/index.d.ts:267 -___ -### jsonrpc -• **jsonrpc**: *string* -Defined in ethereum-types/lib/index.d.ts:268 -___ -### method -• **method**: *string* -*Overrides void* -*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L136)* -___ -### params -• **params**: *any[]* -Defined in ethereum-types/lib/index.d.ts:265 -
@@ -538,11 +532,15 @@ Defined in ethereum-types/lib/index.d.ts:265 + + + + @@ -550,6 +548,7 @@ Defined in ethereum-types/lib/index.d.ts:265 + @@ -564,33 +563,51 @@ Defined in ethereum-types/lib/index.d.ts:265 -## Type aliases +# Interface: JSONRPCRequestPayloadWithMethod +## Properties +### id +• **id**: *number* +Defined in ethereum-types/lib/index.d.ts:268 +___ +### jsonrpc +• **jsonrpc**: *string* +Defined in ethereum-types/lib/index.d.ts:269 +___ +### method +• **method**: *string* +*Overrides void* +*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L136)* +___ +### params +• **params**: *any[]* +Defined in ethereum-types/lib/index.d.ts:266 +
@@ -609,47 +626,31 @@ Defined in ethereum-types/lib/index.d.ts:265 -## Type aliases -### CoverageSubproviderPartialConfig -Ƭ **CoverageSubproviderPartialConfig**: *`Partial`* -*Defined in [sol-coverage/src/coverage_subprovider.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L31)* -## Object literals -### `Const` DEFAULT_COVERAGE_SUBPROVIDER_CONFIG -#### ▪ **DEFAULT_COVERAGE_SUBPROVIDER_CONFIG**: *object* -*Defined in [sol-coverage/src/coverage_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L33)* -#### ignoreFilesGlobs -• **ignoreFilesGlobs**: *never[]* = [] -*Defined in [sol-coverage/src/coverage_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L35)* -#### isVerbose -• **isVerbose**: *boolean* = true -*Defined in [sol-coverage/src/coverage_subprovider.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-coverage/src/coverage_subprovider.ts#L34)* -
+ +## Type aliases -
-
-
@@ -667,78 +668,77 @@ Defined in ethereum-types/lib/index.d.ts:265 -## Type aliases -### Callback -Ƭ **Callback**: *function* -*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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/c93b02d55/packages/subproviders/src/types.ts#L130)* -#### Type declaration: -▸ (`err`: `Error` | null, `data?`: any): *void* -**Parameters:** -Name | Type | ------- | ------ | -`err` | `Error` \| null | -`data?` | any | -___ -### NextCallback -Ƭ **NextCallback**: *function* -*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L133)* -#### Type declaration: -▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void* -**Parameters:** -Name | Type | ------- | ------ | -`callback?` | [OnNextCompleted](#onnextcompleted) | -___ -### OnNextCompleted -Ƭ **OnNextCompleted**: *function* -*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L132)* -#### Type declaration: -▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void* -**Parameters:** +## Type aliases -Name | Type | ------- | ------ | -`err` | `Error` \| null | -`result` | any | -`cb` | [Callback](#callback) | +### CoverageSubproviderPartialConfig + +Ƭ **CoverageSubproviderPartialConfig**: *`Partial`* + +*Defined in [sol-coverage/src/coverage_subprovider.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L31)* + +## Object literals + +### `Const` DEFAULT_COVERAGE_SUBPROVIDER_CONFIG + +#### ▪ **DEFAULT_COVERAGE_SUBPROVIDER_CONFIG**: *object* + +*Defined in [sol-coverage/src/coverage_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L33)* + +#### ignoreFilesGlobs + +• **ignoreFilesGlobs**: *never[]* = [] + +*Defined in [sol-coverage/src/coverage_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L35)* + +#### isVerbose + +• **isVerbose**: *boolean* = true + +*Defined in [sol-coverage/src/coverage_subprovider.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-coverage/src/coverage_subprovider.ts#L34)*
+ + +
+ + + +
+ + + +
+ diff --git a/packages/sol-doc/CHANGELOG.json b/packages/sol-doc/CHANGELOG.json index c7d97e79a7..c4ca69fd41 100644 --- a/packages/sol-doc/CHANGELOG.json +++ b/packages/sol-doc/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "2.1.0-beta.1", diff --git a/packages/sol-doc/CHANGELOG.md b/packages/sol-doc/CHANGELOG.md index f516deb0d4..c0094a0c68 100644 --- a/packages/sol-doc/CHANGELOG.md +++ b/packages/sol-doc/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.1.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v2.1.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/sol-profiler/CHANGELOG.json b/packages/sol-profiler/CHANGELOG.json index 9085a8b102..be197ac3ec 100644 --- a/packages/sol-profiler/CHANGELOG.json +++ b/packages/sol-profiler/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "3.2.0-beta.1", diff --git a/packages/sol-profiler/CHANGELOG.md b/packages/sol-profiler/CHANGELOG.md index 8d1dc7b1d0..9828bc4e85 100644 --- a/packages/sol-profiler/CHANGELOG.md +++ b/packages/sol-profiler/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.2.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v3.2.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/sol-profiler/docs/reference.mdx b/packages/sol-profiler/docs/reference.mdx index 71ed536334..5b60272a3b 100644 --- a/packages/sol-profiler/docs/reference.mdx +++ b/packages/sol-profiler/docs/reference.mdx @@ -1,249 +1,185 @@ -# Class: ProfilerSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -ProfilerSubprovider is used to profile Solidity code while running tests. -## Constructors +# Class: AbstractArtifactAdapter +## Methods -\+ **new ProfilerSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[ProfilerSubprovider](#class-profilersubprovider)* +### `Abstract` collectContractsDataAsync -*Overrides void* +▸ **collectContractsDataAsync**(): *`Promise`* -*Defined in [sol-profiler/src/profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-profiler/src/profiler_subprovider.ts#L30)* +*Defined in [sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts:4](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)* -Instantiates a ProfilerSubprovider instance +**Returns:** *`Promise`* -**Parameters:** +
-Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) | -`defaultFromAddress` | string | - | default from address to use when sending transactions | -`isVerbose` | boolean | true | If true, we will log any unknown transactions. Otherwise we will ignore them | +# Class: SolCompilerArtifactAdapter -**Returns:** *[ProfilerSubprovider](#class-profilersubprovider)* -## Methods +## Constructors -### emitPayloadAsync - -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* +\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* -Defined in subproviders/lib/src/subproviders/subprovider.d.ts:25 +*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)* -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. +Instantiates a SolCompilerArtifactAdapter **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [NextCallback](#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise`* +`artifactsPath?` | undefined \| string | Path to your artifacts directory | +`sourcesPath?` | undefined \| string | Path to your contract sources directory | +**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* +## Methods -*Overrides void* +### collectContractsDataAsync -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 +▸ **collectContractsDataAsync**(): *`Promise`* -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. +*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* -**Parameters:** +*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [NextCallback](#nextcallback) | 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`* -**Returns:** *`Promise`* +
-___ +# Class: TruffleArtifactAdapter -### setEngine -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* +## Constructors -*Overrides void* +\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)* -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 +*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* -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. +Instantiates a TruffleArtifactAdapter **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -___ - -### start - -▸ **start**(): *void* - - - -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 - -Starts trace collection - -**Returns:** *void* - -___ - -### stop - -▸ **stop**(): *void* - - - -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 - -Stops trace collection +`projectRoot` | string | Path to the truffle project's root directory | +`solcVersion` | string | Solidity version with which to compile all the contracts | -**Returns:** *void* +**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)* -___ +## Methods -### writeProfilerOutputAsync +### collectContractsDataAsync -▸ **writeProfilerOutputAsync**(): *`Promise`* +▸ **collectContractsDataAsync**(): *`Promise`* -*Defined in [sol-profiler/src/profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-profiler/src/profiler_subprovider.ts#L104)* +*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* -Write the test profiler results to a file in Istanbul format. +*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* -**Returns:** *`Promise`* +**Returns:** *`Promise`*
-# Class: AbstractArtifactAdapter -## Methods -### `Abstract` collectContractsDataAsync -▸ **collectContractsDataAsync**(): *`Promise`* -*Defined in [sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts:4](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)* -**Returns:** *`Promise`* -
-# Class: SolCompilerArtifactAdapter -## Constructors -\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* -*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)* -Instantiates a SolCompilerArtifactAdapter -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`artifactsPath?` | undefined \| string | Path to your artifacts directory | -`sourcesPath?` | undefined \| string | Path to your contract sources directory | -**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* -## Methods +## Type aliases -### collectContractsDataAsync +### Callback -▸ **collectContractsDataAsync**(): *`Promise`* +Ƭ **Callback**: *function* -*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* +*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L131)* -*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* +#### Type declaration: -**Returns:** *`Promise`* +▸ (): *void* -
+___ -# Class: TruffleArtifactAdapter -## Constructors +### ErrorCallback +Ƭ **ErrorCallback**: *function* +*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L130)* -\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)* - -*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* +#### Type declaration: -Instantiates a TruffleArtifactAdapter +▸ (`err`: `Error` | null, `data?`: any): *void* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`projectRoot` | string | Path to the truffle project's root directory | -`solcVersion` | string | Solidity version with which to compile all the contracts | - -**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)* - -## Methods - -### collectContractsDataAsync - -▸ **collectContractsDataAsync**(): *`Promise`* - -*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* +Name | Type | +------ | ------ | +`err` | `Error` \| null | +`data?` | any | -*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* +___ -**Returns:** *`Promise`* -
+### NextCallback +Ƭ **NextCallback**: *function* +*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L133)* +#### Type declaration: +▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void* +**Parameters:** +Name | Type | +------ | ------ | +`callback?` | [OnNextCompleted](#onnextcompleted) | +___ +### OnNextCompleted +Ƭ **OnNextCompleted**: *function* +*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L132)* +#### Type declaration: +▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void* +**Parameters:** +Name | Type | +------ | ------ | +`err` | `Error` \| null | +`result` | any | +`cb` | [Callback](#callback) | +
@@ -308,7 +244,7 @@ Name | Type | Description | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* ___ @@ -316,7 +252,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* ___ @@ -324,7 +260,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* ___ @@ -332,7 +268,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
@@ -345,7 +281,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* ___ @@ -353,7 +289,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
@@ -366,7 +302,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* ___ @@ -374,7 +310,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* ___ @@ -382,7 +318,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* ___ @@ -390,7 +326,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
@@ -426,108 +362,160 @@ ___ +# Class: ProfilerSubprovider +This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. +ProfilerSubprovider is used to profile Solidity code while running tests. +## Constructors +\+ **new ProfilerSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[ProfilerSubprovider](#class-profilersubprovider)* +*Overrides void* +*Defined in [sol-profiler/src/profiler_subprovider.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-profiler/src/profiler_subprovider.ts#L30)* +Instantiates a ProfilerSubprovider instance +**Parameters:** +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) | +`defaultFromAddress` | string | - | default from address to use when sending transactions | +`isVerbose` | boolean | true | If true, we will log any unknown transactions. Otherwise we will ignore them | +**Returns:** *[ProfilerSubprovider](#class-profilersubprovider)* +## Methods +### emitPayloadAsync +▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* +Defined in subproviders/lib/src/subproviders/subprovider.d.ts:25 +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`: [NextCallback](#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise`* +*Overrides void* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 - +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` | [NextCallback](#nextcallback) | 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* - +*Overrides void* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 +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* +___ +### start +▸ **start**(): *void* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 +Starts trace collection +**Returns:** *void* -# Interface: JSONRPCRequestPayloadWithMethod +___ +### stop -## Properties +▸ **stop**(): *void* -### id -• **id**: *number* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 +Stops trace collection -Defined in ethereum-types/lib/index.d.ts:267 +**Returns:** *void* ___ -### jsonrpc +### writeProfilerOutputAsync -• **jsonrpc**: *string* +▸ **writeProfilerOutputAsync**(): *`Promise`* +*Defined in [sol-profiler/src/profiler_subprovider.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-profiler/src/profiler_subprovider.ts#L104)* +Write the test profiler results to a file in Istanbul format. -Defined in ethereum-types/lib/index.d.ts:268 +**Returns:** *`Promise`* -___ +
-### method -• **method**: *string* -*Overrides void* -*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L136)* -___ -### params -• **params**: *any[]* -Defined in ethereum-types/lib/index.d.ts:265 -
@@ -542,12 +530,15 @@ Defined in ethereum-types/lib/index.d.ts:265 + + + @@ -555,6 +546,7 @@ Defined in ethereum-types/lib/index.d.ts:265 + @@ -562,7 +554,6 @@ Defined in ethereum-types/lib/index.d.ts:265 -## Type aliases @@ -571,30 +562,50 @@ Defined in ethereum-types/lib/index.d.ts:265 +# Interface: JSONRPCRequestPayloadWithMethod +## Properties +### id +• **id**: *number* +Defined in ethereum-types/lib/index.d.ts:268 +___ +### jsonrpc +• **jsonrpc**: *string* +Defined in ethereum-types/lib/index.d.ts:269 +___ +### method +• **method**: *string* +*Overrides void* +*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L136)* +___ +### params +• **params**: *any[]* +Defined in ethereum-types/lib/index.d.ts:266 + +
@@ -607,43 +618,24 @@ Defined in ethereum-types/lib/index.d.ts:265 -## Functions -### `Const` profilerHandler -▸ **profilerHandler**(`contractData`: `ContractData`, `subtrace`: [Subtrace](#subtrace), `pcToSourceRange`: object, `fileIndex`: number): *`Coverage`* -*Defined in [sol-profiler/src/profiler_subprovider.ts:118](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-profiler/src/profiler_subprovider.ts#L118)* -Computed partial coverage for a single file & subtrace for the purposes of -gas profiling. -**Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`contractData` | `ContractData` | Contract metadata (source, srcMap, bytecode) | -`subtrace` | [Subtrace](#subtrace) | A subset of a transcation/call trace that was executed within that contract | -`pcToSourceRange` | object | A mapping from program counters to source ranges | -`fileIndex` | number | Index of a file to compute coverage for | -**Returns:** *`Coverage`* -Partial istanbul coverage for that file & subtrace -
-
-
-
@@ -663,76 +655,84 @@ Partial istanbul coverage for that file & subtrace ## Type aliases -### Callback -Ƭ **Callback**: *function* -*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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/c93b02d55/packages/subproviders/src/types.ts#L130)* -#### Type declaration: -▸ (`err`: `Error` | null, `data?`: any): *void* -**Parameters:** -Name | Type | ------- | ------ | -`err` | `Error` \| null | -`data?` | any | -___ -### NextCallback -Ƭ **NextCallback**: *function* -*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L133)* -#### Type declaration: -▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void* -**Parameters:** -Name | Type | ------- | ------ | -`callback?` | [OnNextCompleted](#onnextcompleted) | -___ -### OnNextCompleted -Ƭ **OnNextCompleted**: *function* -*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L132)* -#### Type declaration: -▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void* + + + + + + + + + + + + + +## Functions + +### `Const` profilerHandler + +▸ **profilerHandler**(`contractData`: `ContractData`, `subtrace`: [Subtrace](#subtrace), `pcToSourceRange`: object, `fileIndex`: number): *`Coverage`* + +*Defined in [sol-profiler/src/profiler_subprovider.ts:118](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-profiler/src/profiler_subprovider.ts#L118)* + +Computed partial coverage for a single file & subtrace for the purposes of +gas profiling. **Parameters:** -Name | Type | ------- | ------ | -`err` | `Error` \| null | -`result` | any | -`cb` | [Callback](#callback) | +Name | Type | Description | +------ | ------ | ------ | +`contractData` | `ContractData` | Contract metadata (source, srcMap, bytecode) | +`subtrace` | [Subtrace](#subtrace) | A subset of a transcation/call trace that was executed within that contract | +`pcToSourceRange` | object | A mapping from program counters to source ranges | +`fileIndex` | number | Index of a file to compute coverage for | + +**Returns:** *`Coverage`* + +Partial istanbul coverage for that file & subtrace
+ + +
+ + + +
+ + + +
+ diff --git a/packages/sol-resolver/CHANGELOG.json b/packages/sol-resolver/CHANGELOG.json index 574b4ea406..f1cb70c5a5 100644 --- a/packages/sol-resolver/CHANGELOG.json +++ b/packages/sol-resolver/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "2.1.0-beta.1", diff --git a/packages/sol-resolver/CHANGELOG.md b/packages/sol-resolver/CHANGELOG.md index 932e42455a..5c473e11b8 100644 --- a/packages/sol-resolver/CHANGELOG.md +++ b/packages/sol-resolver/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.1.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v2.1.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/sol-trace/CHANGELOG.json b/packages/sol-trace/CHANGELOG.json index 9a831ec2be..dbddb8e2c8 100644 --- a/packages/sol-trace/CHANGELOG.json +++ b/packages/sol-trace/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "2.1.0-beta.1", diff --git a/packages/sol-trace/CHANGELOG.md b/packages/sol-trace/CHANGELOG.md index 696eb0bd2f..0eba2f38c3 100644 --- a/packages/sol-trace/CHANGELOG.md +++ b/packages/sol-trace/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.1.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v2.1.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/sol-trace/docs/reference.mdx b/packages/sol-trace/docs/reference.mdx index b26e96a745..1ff8930b3b 100644 --- a/packages/sol-trace/docs/reference.mdx +++ b/packages/sol-trace/docs/reference.mdx @@ -1,237 +1,185 @@ -# Class: RevertTraceSubprovider - -This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. -It is used to report call stack traces whenever a revert occurs. -## Constructors +# Class: AbstractArtifactAdapter +## Methods -\+ **new RevertTraceSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[RevertTraceSubprovider](#class-reverttracesubprovider)* +### `Abstract` collectContractsDataAsync -*Overrides void* +▸ **collectContractsDataAsync**(): *`Promise`* -*Defined in [sol-trace/src/revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-trace/src/revert_trace_subprovider.ts#L27)* +*Defined in [sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts:4](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)* -Instantiates a RevertTraceSubprovider instance - -**Parameters:** +**Returns:** *`Promise`* -Name | Type | Default | Description | ------- | ------ | ------ | ------ | -`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) | -`defaultFromAddress` | string | - | default from address to use when sending transactions | -`isVerbose` | boolean | true | If true, we will log any unknown transactions. Otherwise we will ignore them | +
-**Returns:** *[RevertTraceSubprovider](#class-reverttracesubprovider)* +# Class: SolCompilerArtifactAdapter -## Methods -### emitPayloadAsync +## Constructors -▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* +\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* -Defined in subproviders/lib/src/subproviders/subprovider.d.ts:25 +*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)* -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. +Instantiates a SolCompilerArtifactAdapter **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`payload` | `Partial` | JSON RPC payload | - -**Returns:** *`Promise`* - -JSON RPC response payload - -___ - -### handleRequest - -▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [NextCallback](#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise`* +`artifactsPath?` | undefined \| string | Path to your artifacts directory | +`sourcesPath?` | undefined \| string | Path to your contract sources directory | +**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* +## Methods -*Overrides void* +### collectContractsDataAsync -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 +▸ **collectContractsDataAsync**(): *`Promise`* -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. +*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* -**Parameters:** +*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* -Name | Type | Description | ------- | ------ | ------ | -`payload` | `JSONRPCRequestPayload` | JSON RPC payload | -`next` | [NextCallback](#nextcallback) | 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`* -**Returns:** *`Promise`* +
-___ +# Class: TruffleArtifactAdapter -### setEngine -▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* +## Constructors -*Overrides void* +\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)* -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 +*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* -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. +Instantiates a TruffleArtifactAdapter **Parameters:** Name | Type | Description | ------ | ------ | ------ | -`engine` | `Web3ProviderEngine` | The ProviderEngine this subprovider is added to | - -**Returns:** *void* - -___ - -### start - -▸ **start**(): *void* - - - -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 - -Starts trace collection - -**Returns:** *void* - -___ +`projectRoot` | string | Path to the truffle project's root directory | +`solcVersion` | string | Solidity version with which to compile all the contracts | -### stop +**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)* -▸ **stop**(): *void* +## Methods +### collectContractsDataAsync +▸ **collectContractsDataAsync**(): *`Promise`* -Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 +*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* -Stops trace collection +*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* -**Returns:** *void* +**Returns:** *`Promise`*
-# Class: AbstractArtifactAdapter -## Methods -### `Abstract` collectContractsDataAsync -▸ **collectContractsDataAsync**(): *`Promise`* -*Defined in [sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts:4](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/abstract_artifact_adapter.ts#L4)* -**Returns:** *`Promise`* -
-# Class: SolCompilerArtifactAdapter -## Constructors -\+ **new SolCompilerArtifactAdapter**(`artifactsPath?`: undefined | string, `sourcesPath?`: undefined | string): *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* -*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L18)* -Instantiates a SolCompilerArtifactAdapter -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`artifactsPath?` | undefined \| string | Path to your artifacts directory | -`sourcesPath?` | undefined \| string | Path to your contract sources directory | -**Returns:** *[SolCompilerArtifactAdapter](#class-solcompilerartifactadapter)* -## Methods -### collectContractsDataAsync +## Type aliases -▸ **collectContractsDataAsync**(): *`Promise`* +### Callback -*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* +Ƭ **Callback**: *function* -*Defined in [sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts#L44)* +*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L131)* -**Returns:** *`Promise`* +#### Type declaration: -
+▸ (): *void* -# Class: TruffleArtifactAdapter +___ -## Constructors +### ErrorCallback +Ƭ **ErrorCallback**: *function* -\+ **new TruffleArtifactAdapter**(`projectRoot`: string, `solcVersion`: string): *[TruffleArtifactAdapter](#class-truffleartifactadapter)* +*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L130)* -*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L29)* +#### Type declaration: -Instantiates a TruffleArtifactAdapter +▸ (`err`: `Error` | null, `data?`: any): *void* **Parameters:** -Name | Type | Description | ------- | ------ | ------ | -`projectRoot` | string | Path to the truffle project's root directory | -`solcVersion` | string | Solidity version with which to compile all the contracts | - -**Returns:** *[TruffleArtifactAdapter](#class-truffleartifactadapter)* - -## Methods - -### collectContractsDataAsync - -▸ **collectContractsDataAsync**(): *`Promise`* - -*Overrides [AbstractArtifactAdapter](_sol_tracing_utils_src_artifact_adapters_abstract_artifact_adapter_.abstractartifactadapter.md).[collectContractsDataAsync](#abstract-collectcontractsdataasync)* +Name | Type | +------ | ------ | +`err` | `Error` \| null | +`data?` | any | -*Defined in [sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/sol-tracing-utils/src/artifact_adapters/truffle_artifact_adapter.ts#L40)* +___ -**Returns:** *`Promise`* -
+### NextCallback +Ƭ **NextCallback**: *function* +*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L133)* +#### Type declaration: +▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void* +**Parameters:** +Name | Type | +------ | ------ | +`callback?` | [OnNextCompleted](#onnextcompleted) | +___ +### OnNextCompleted +Ƭ **OnNextCompleted**: *function* +*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L132)* +#### Type declaration: +▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void* +**Parameters:** +Name | Type | +------ | ------ | +`err` | `Error` \| null | +`result` | any | +`cb` | [Callback](#callback) | +
@@ -296,7 +244,7 @@ Name | Type | Description | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* ___ @@ -304,7 +252,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* ___ @@ -312,7 +260,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* ___ @@ -320,7 +268,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
@@ -333,7 +281,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* ___ @@ -341,7 +289,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
@@ -354,7 +302,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* ___ @@ -362,7 +310,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* ___ @@ -370,7 +318,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* ___ @@ -378,7 +326,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
@@ -414,108 +362,154 @@ ___ +# Class: RevertTraceSubprovider +This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. +It is used to report call stack traces whenever a revert occurs. +## Constructors +\+ **new RevertTraceSubprovider**(`artifactAdapter`: `AbstractArtifactAdapter`, `defaultFromAddress`: string, `isVerbose`: boolean): *[RevertTraceSubprovider](#class-reverttracesubprovider)* +*Overrides void* +*Defined in [sol-trace/src/revert_trace_subprovider.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/sol-trace/src/revert_trace_subprovider.ts#L27)* +Instantiates a RevertTraceSubprovider instance +**Parameters:** +Name | Type | Default | Description | +------ | ------ | ------ | ------ | +`artifactAdapter` | `AbstractArtifactAdapter` | - | Adapter for used artifacts format (0x, truffle, giveth, etc.) | +`defaultFromAddress` | string | - | default from address to use when sending transactions | +`isVerbose` | boolean | true | If true, we will log any unknown transactions. Otherwise we will ignore them | +**Returns:** *[RevertTraceSubprovider](#class-reverttracesubprovider)* +## Methods +### emitPayloadAsync +▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* +Defined in subproviders/lib/src/subproviders/subprovider.d.ts:25 +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`: [NextCallback](#nextcallback), `_end`: [ErrorCallback](#errorcallback)): *`Promise`* +*Overrides void* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:42 - +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` | [NextCallback](#nextcallback) | 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* - +*Overrides void* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:49 +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* +___ +### start +▸ **start**(): *void* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:29 +Starts trace collection +**Returns:** *void* -# Interface: JSONRPCRequestPayloadWithMethod +___ +### stop -## Properties +▸ **stop**(): *void* -### id -• **id**: *number* +Defined in sol-tracing-utils/lib/src/trace_collection_subprovider.d.ts:33 +Stops trace collection -Defined in ethereum-types/lib/index.d.ts:267 +**Returns:** *void* -___ +
-### jsonrpc -• **jsonrpc**: *string* -Defined in ethereum-types/lib/index.d.ts:268 -___ -### method -• **method**: *string* -*Overrides void* -*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L136)* -___ -### params -• **params**: *any[]* -Defined in ethereum-types/lib/index.d.ts:265 -
@@ -524,12 +518,15 @@ Defined in ethereum-types/lib/index.d.ts:265 + + + @@ -537,6 +534,7 @@ Defined in ethereum-types/lib/index.d.ts:265 + @@ -550,29 +548,52 @@ Defined in ethereum-types/lib/index.d.ts:265 -## Type aliases +# Interface: JSONRPCRequestPayloadWithMethod +## Properties +### id +• **id**: *number* +Defined in ethereum-types/lib/index.d.ts:268 +___ +### jsonrpc +• **jsonrpc**: *string* +Defined in ethereum-types/lib/index.d.ts:269 +___ +### method +• **method**: *string* +*Overrides void* +*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L136)* +___ +### params + +• **params**: *any[]* + + + +Defined in ethereum-types/lib/index.d.ts:266 + +
@@ -594,19 +615,15 @@ Defined in ethereum-types/lib/index.d.ts:265 -
-
-
-
@@ -626,76 +643,59 @@ Defined in ethereum-types/lib/index.d.ts:265 ## Type aliases -### Callback -Ƭ **Callback**: *function* -*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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/c93b02d55/packages/subproviders/src/types.ts#L130)* -#### Type declaration: -▸ (`err`: `Error` | null, `data?`: any): *void* -**Parameters:** -Name | Type | ------- | ------ | -`err` | `Error` \| null | -`data?` | any | -___ -### NextCallback -Ƭ **NextCallback**: *function* -*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L133)* -#### Type declaration: -▸ (`callback?`: [OnNextCompleted](#onnextcompleted)): *void* -**Parameters:** -Name | Type | ------- | ------ | -`callback?` | [OnNextCompleted](#onnextcompleted) | -___ -### OnNextCompleted -Ƭ **OnNextCompleted**: *function* -*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L132)* -#### Type declaration: -▸ (`err`: `Error` | null, `result`: any, `cb`: [Callback](#callback)): *void* -**Parameters:** -Name | Type | ------- | ------ | -`err` | `Error` \| null | -`result` | any | -`cb` | [Callback](#callback) | -
+ + + + + + + + + +
+ + + +
+ + + +
+ + + +
diff --git a/packages/sol-tracing-utils/CHANGELOG.json b/packages/sol-tracing-utils/CHANGELOG.json index a4585d5402..87348a8b81 100644 --- a/packages/sol-tracing-utils/CHANGELOG.json +++ b/packages/sol-tracing-utils/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "6.1.0-beta.1", diff --git a/packages/sol-tracing-utils/CHANGELOG.md b/packages/sol-tracing-utils/CHANGELOG.md index fdc0f6adf1..3e54091fe1 100644 --- a/packages/sol-tracing-utils/CHANGELOG.md +++ b/packages/sol-tracing-utils/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v6.1.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v6.1.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/sra-spec/CHANGELOG.json b/packages/sra-spec/CHANGELOG.json index 10901af07b..a02c8dfbce 100644 --- a/packages/sra-spec/CHANGELOG.json +++ b/packages/sra-spec/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "2.1.0-beta.1", diff --git a/packages/sra-spec/CHANGELOG.md b/packages/sra-spec/CHANGELOG.md index 3fd349a5c2..e148568059 100644 --- a/packages/sra-spec/CHANGELOG.md +++ b/packages/sra-spec/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.1.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v2.1.0-beta.1 - _November 7, 2019_ * All references to network ID have been removed, and references to chain ID have been introduced instead (#2313) diff --git a/packages/subproviders/CHANGELOG.json b/packages/subproviders/CHANGELOG.json index 6d4e234332..0e6c3dbb8e 100644 --- a/packages/subproviders/CHANGELOG.json +++ b/packages/subproviders/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Adds DebugSubprovider", "pr": 2329 } - ] + ], + "timestamp": 1574030254 }, { "version": "5.1.0-beta.1", diff --git a/packages/subproviders/CHANGELOG.md b/packages/subproviders/CHANGELOG.md index 7206635c5b..d973bb14ac 100644 --- a/packages/subproviders/CHANGELOG.md +++ b/packages/subproviders/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v5.1.0-beta.2 - _November 17, 2019_ + + * Adds DebugSubprovider (#2329) + ## v5.1.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/subproviders/docs/reference.mdx b/packages/subproviders/docs/reference.mdx index 694a9c3ddf..e34aa73ced 100644 --- a/packages/subproviders/docs/reference.mdx +++ b/packages/subproviders/docs/reference.mdx @@ -1,3 +1,5 @@ + + # Class: EmptyWalletSubprovider This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. @@ -12,7 +14,7 @@ It intercepts the `eth_accounts` JSON RPC requests and never returns any address *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -36,7 +38,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/empty_wallet_subprovider.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/empty_wallet_subprovider.ts#L21)* +*Defined in [subproviders/src/subproviders/empty_wallet_subprovider.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/empty_wallet_subprovider.ts#L21)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -60,7 +62,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -88,7 +90,7 @@ It intercepts the `eth_estimateGas` JSON RPC call and always returns a constant \+ **new FakeGasEstimateSubprovider**(`constantGasAmount`: number): *[FakeGasEstimateSubprovider](#class-fakegasestimatesubprovider)* -*Defined in [subproviders/src/subproviders/fake_gas_estimate_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L17)* +*Defined in [subproviders/src/subproviders/fake_gas_estimate_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L17)* Instantiates an instance of the FakeGasEstimateSubprovider @@ -108,7 +110,7 @@ Name | Type | Description | *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -132,7 +134,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/fake_gas_estimate_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L35)* +*Defined in [subproviders/src/subproviders/fake_gas_estimate_subprovider.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/fake_gas_estimate_subprovider.ts#L35)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -156,7 +158,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -184,7 +186,7 @@ It intercepts all JSON RPC requests and relays them to an in-process ganache ins \+ **new GanacheSubprovider**(`opts`: `GanacheOpts`): *[GanacheSubprovider](#class-ganachesubprovider)* -*Defined in [subproviders/src/subproviders/ganache.ts:13](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/ganache.ts#L13)* +*Defined in [subproviders/src/subproviders/ganache.ts:13](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/ganache.ts#L13)* Instantiates a GanacheSubprovider @@ -204,7 +206,7 @@ Name | Type | Description | *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -228,7 +230,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/ganache.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/ganache.ts#L31)* +*Defined in [subproviders/src/subproviders/ganache.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/ganache.ts#L31)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -252,7 +254,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -281,7 +283,7 @@ re-routes them to a Ledger device plugged into the users computer. \+ **new LedgerSubprovider**(`config`: [LedgerSubproviderConfigs](#interface-ledgersubproviderconfigs)): *[LedgerSubprovider](#class-ledgersubprovider)* -*Defined in [subproviders/src/subproviders/ledger.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/ledger.ts#L41)* +*Defined in [subproviders/src/subproviders/ledger.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/ledger.ts#L41)* Instantiates a LedgerSubprovider. Defaults to derivationPath set to `44'/60'/0'`. TestRPC/Ganache defaults to `m/44'/60'/0'/0`, so set this in the configs if desired. @@ -304,7 +306,7 @@ LedgerSubprovider instance *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -328,7 +330,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/ledger.ts:87](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/ledger.ts#L87)* +*Defined in [subproviders/src/subproviders/ledger.ts:87](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/ledger.ts#L87)* Retrieve a users Ledger accounts. The accounts are derived from the derivationPath, master public key and chain code. Because of this, you can request as many accounts @@ -352,7 +354,7 @@ ___ ▸ **getPath**(): *string* -*Defined in [subproviders/src/subproviders/ledger.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/ledger.ts#L68)* +*Defined in [subproviders/src/subproviders/ledger.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/ledger.ts#L68)* Retrieve the set derivation path @@ -370,7 +372,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/src/subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -394,7 +396,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -414,7 +416,7 @@ ___ ▸ **setPath**(`basDerivationPath`: string): *void* -*Defined in [subproviders/src/subproviders/ledger.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/ledger.ts#L75)* +*Defined in [subproviders/src/subproviders/ledger.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/ledger.ts#L75)* Set a desired derivation path when computing the available user addresses @@ -434,7 +436,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/ledger.ts:158](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/ledger.ts#L158)* +*Defined in [subproviders/src/subproviders/ledger.ts:158](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/ledger.ts#L158)* Sign a personal Ethereum signed message. The signing account will be the account associated with the provided address. @@ -462,7 +464,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/ledger.ts:101](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/ledger.ts#L101)* +*Defined in [subproviders/src/subproviders/ledger.ts:101](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/ledger.ts#L101)* Signs a transaction on the Ledger with the account specificed by the `from` field in txParams. If you've added the LedgerSubprovider to your app's provider, you can simply send an `eth_sendTransaction` @@ -487,7 +489,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/ledger.ts:196](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/ledger.ts#L196)* +*Defined in [subproviders/src/subproviders/ledger.ts:196](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/ledger.ts#L196)* eth_signTypedData is currently not supported on Ledger devices. @@ -520,7 +522,7 @@ are passed onwards for subsequent subproviders to handle. \+ **new MetamaskSubprovider**(`supportedProvider`: [SupportedProvider](#supportedprovider)): *[MetamaskSubprovider](#class-metamasksubprovider)* -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/metamask_subprovider.ts#L19)* +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/metamask_subprovider.ts#L19)* Instantiates a new MetamaskSubprovider @@ -540,7 +542,7 @@ Name | Type | Description | *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -564,7 +566,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:39](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/metamask_subprovider.ts#L39)* +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -586,7 +588,7 @@ ___ ▸ **sendAsync**(`payload`: `JSONRPCRequestPayload`, `callback`: [ErrorCallback](#errorcallback)): *void* -*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/metamask_subprovider.ts#L117)* +*Defined in [subproviders/src/subproviders/metamask_subprovider.ts:117](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -611,7 +613,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -640,7 +642,7 @@ all requests with accounts derived from the supplied mnemonic. \+ **new MnemonicWalletSubprovider**(`config`: [MnemonicWalletSubproviderConfigs](#interface-mnemonicwalletsubproviderconfigs)): *[MnemonicWalletSubprovider](#class-mnemonicwalletsubprovider)* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:27](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L27)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:27](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L27)* Instantiates a MnemonicWalletSubprovider. Defaults to baseDerivationPath set to `44'/60'/0'/0`. This is the default in TestRPC/Ganache, it can be overridden if desired. @@ -663,7 +665,7 @@ MnemonicWalletSubprovider instance *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -687,7 +689,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L70)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L70)* Retrieve the accounts associated with the mnemonic. This method is implicitly called when issuing a `eth_accounts` JSON RPC request @@ -709,7 +711,7 @@ ___ ▸ **getPath**(): *string* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L52)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L52)* Retrieve the set derivation path @@ -727,7 +729,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/src/subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -751,7 +753,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -771,7 +773,7 @@ ___ ▸ **setPath**(`baseDerivationPath`: string): *void* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:59](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L59)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L59)* Set a desired derivation path when computing the available user addresses @@ -791,7 +793,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:102](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L102)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L102)* Sign a personal Ethereum signed message. The signing account will be the account associated with the provided address. If you've added the MnemonicWalletSubprovider to @@ -818,7 +820,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L84)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L84)* Signs a transaction with the account specificed by the `from` field in txParams. If you've added this Subprovider to your app's provider, you can simply send @@ -843,7 +845,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:122](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L122)* +*Defined in [subproviders/src/subproviders/mnemonic_wallet.ts:122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/mnemonic_wallet.ts#L122)* Sign an EIP712 Typed Data message. The signing account will be the account associated with the provided address. If you've added this MnemonicWalletSubprovider to @@ -879,7 +881,7 @@ We added the additional feature of clearing the cached nonce value when a `nonce *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -903,7 +905,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/nonce_tracker.ts:57](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/nonce_tracker.ts#L57)* +*Defined in [subproviders/src/subproviders/nonce_tracker.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/nonce_tracker.ts#L57)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -927,7 +929,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -956,7 +958,7 @@ all requests with the supplied Ethereum private key. \+ **new PrivateKeyWalletSubprovider**(`privateKey`: string): *[PrivateKeyWalletSubprovider](#class-privatekeywalletsubprovider)* -*Defined in [subproviders/src/subproviders/private_key_wallet.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/private_key_wallet.ts#L19)* +*Defined in [subproviders/src/subproviders/private_key_wallet.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/private_key_wallet.ts#L19)* Instantiates a PrivateKeyWalletSubprovider. @@ -978,7 +980,7 @@ PrivateKeyWalletSubprovider instance *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1002,7 +1004,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/private_key_wallet.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/private_key_wallet.ts#L37)* +*Defined in [subproviders/src/subproviders/private_key_wallet.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/private_key_wallet.ts#L37)* Retrieve the account associated with the supplied private key. This method is implicitly called when issuing a `eth_accounts` JSON RPC request @@ -1022,7 +1024,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/src/subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -1046,7 +1048,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1068,7 +1070,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/private_key_wallet.ts:72](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/private_key_wallet.ts#L72)* +*Defined in [subproviders/src/subproviders/private_key_wallet.ts:72](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/private_key_wallet.ts#L72)* Sign a personal Ethereum signed message. The signing address will be calculated from the private key. The address must be provided it must match the address calculated from the private key. @@ -1095,7 +1097,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/private_key_wallet.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/private_key_wallet.ts#L48)* +*Defined in [subproviders/src/subproviders/private_key_wallet.ts:48](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/private_key_wallet.ts#L48)* Sign a transaction with the private key. If you've added this Subprovider to your app's provider, you can simply send an `eth_sendTransaction` JSON RPC request, and @@ -1120,7 +1122,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/private_key_wallet.ts:99](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/private_key_wallet.ts#L99)* +*Defined in [subproviders/src/subproviders/private_key_wallet.ts:99](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/private_key_wallet.ts#L99)* Sign an EIP712 Typed Data message. The signing address will be calculated from the private key. The address must be provided it must match the address calculated from the private key. @@ -1154,7 +1156,7 @@ set of JSON RPC endpoints. \+ **new RedundantSubprovider**(`subproviders`: [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md)[]): *[RedundantSubprovider](#class-redundantsubprovider)* -*Defined in [subproviders/src/subproviders/redundant_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/redundant_subprovider.ts#L33)* +*Defined in [subproviders/src/subproviders/redundant_subprovider.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/redundant_subprovider.ts#L33)* Instantiates a new RedundantSubprovider @@ -1174,7 +1176,7 @@ Name | Type | Description | *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1198,7 +1200,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/redundant_subprovider.ts:51](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/redundant_subprovider.ts#L51)* +*Defined in [subproviders/src/subproviders/redundant_subprovider.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/redundant_subprovider.ts#L51)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -1237,7 +1239,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1265,7 +1267,7 @@ It forwards on JSON RPC requests to the supplied `rpcUrl` endpoint \+ **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/c93b02d55/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* +*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/rpc_subprovider.ts#L17)* **Parameters:** @@ -1284,7 +1286,7 @@ Name | Type | Default | Description | *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1308,7 +1310,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/rpc_subprovider.ts#L38)* +*Defined in [subproviders/src/subproviders/rpc_subprovider.ts:38](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1332,7 +1334,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1362,7 +1364,7 @@ are passed onwards for subsequent subproviders to handle. \+ **new SignerSubprovider**(`supportedProvider`: [SupportedProvider](#supportedprovider)): *[SignerSubprovider](#class-signersubprovider)* -*Defined in [subproviders/src/subproviders/signer.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/signer.ts#L15)* +*Defined in [subproviders/src/subproviders/signer.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/signer.ts#L15)* Instantiates a new SignerSubprovider. @@ -1382,7 +1384,7 @@ Name | Type | Description | *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1406,7 +1408,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/signer.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/signer.ts#L33)* +*Defined in [subproviders/src/subproviders/signer.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/signer.ts#L33)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -1430,7 +1432,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1458,7 +1460,7 @@ This one has an async/await `emitPayloadAsync` and also defined types. ▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1480,7 +1482,7 @@ ___ ▸ **handleRequest**(`payload`: `JSONRPCRequestPayload`, `next`: [Callback](#callback), `end`: [ErrorCallback](#errorcallback)): *`Promise`* -*Defined in [subproviders/src/subproviders/subprovider.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L42)* +*Defined in [subproviders/src/subproviders/subprovider.ts:42](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/subprovider.ts#L42)* **Parameters:** @@ -1498,7 +1500,7 @@ ___ ▸ **setEngine**(`engine`: `Web3ProviderEngine`): *void* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1523,7 +1525,7 @@ Name | Type | Description | \+ **new TrezorSubprovider**(`config`: [TrezorSubproviderConfig](#interface-trezorsubproviderconfig)): *[TrezorSubprovider](#class-trezorsubprovider)* -*Defined in [subproviders/src/subproviders/trezor.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/trezor.ts#L32)* +*Defined in [subproviders/src/subproviders/trezor.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/trezor.ts#L32)* Instantiates a TrezorSubprovider. Defaults to private key path set to `44'/60'/0'/0/`. Must be initialized with trezor-connect API module https://github.com/trezor/connect. @@ -1546,7 +1548,7 @@ TrezorSubprovider instance *Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* -*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L55)* +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1570,7 +1572,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/trezor.ts:56](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/trezor.ts#L56)* +*Defined in [subproviders/src/subproviders/trezor.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/trezor.ts#L56)* Retrieve a users Trezor account. This method is automatically called when issuing a `eth_accounts` JSON RPC request via your providerEngine @@ -1596,7 +1598,7 @@ ___ *Overrides [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* -*Defined in [subproviders/src/subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* +*Defined in [subproviders/src/subproviders/base_wallet_subprovider.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/base_wallet_subprovider.ts#L37)* This method conforms to the web3-provider-engine interface. It is called internally by the ProviderEngine when it is this subproviders @@ -1620,7 +1622,7 @@ ___ *Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* -*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/subprovider.ts#L68)* +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 @@ -1642,7 +1644,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/trezor.ts:129](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/trezor.ts#L129)* +*Defined in [subproviders/src/subproviders/trezor.ts:129](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/trezor.ts#L129)* Sign a personal Ethereum signed message. The signing account will be the account associated with the provided address. If you've added the TrezorSubprovider to @@ -1669,7 +1671,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/trezor.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/trezor.ts#L70)* +*Defined in [subproviders/src/subproviders/trezor.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/trezor.ts#L70)* Signs a transaction on the Trezor with the account specificed by the `from` field in txParams. If you've added the TrezorSubprovider to your app's provider, you can simply send an `eth_sendTransaction` @@ -1694,7 +1696,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/subproviders/trezor.ts:161](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/subproviders/trezor.ts#L161)* +*Defined in [subproviders/src/subproviders/trezor.ts:161](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/trezor.ts#L161)* TODO:: eth_signTypedData is currently not supported on Trezor devices. @@ -1730,7 +1732,7 @@ Signature hex string (order: rsv) • **CannotDetermineAddressFromPayload**: = "CANNOT_DETERMINE_ADDRESS_FROM_PAYLOAD" -*Defined in [subproviders/src/types.ts:121](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L121)* +*Defined in [subproviders/src/types.ts:121](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L121)* ___ @@ -1738,7 +1740,7 @@ ___ • **EmptyParametersFound**: = "EMPTY_PARAMETERS_FOUND" -*Defined in [subproviders/src/types.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L120)* +*Defined in [subproviders/src/types.ts:120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L120)*
@@ -1771,6 +1773,39 @@ ___ +## Type aliases + + + + + + + + + +### EIP712ObjectValue + +Ƭ **EIP712ObjectValue**: *string | number | [EIP712Object](#interface-eip712object)* + +*Defined in [types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L740)* + +___ + + + + + + + + + + + + + + + + @@ -1813,7 +1848,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -1821,7 +1856,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -1845,7 +1880,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -1879,7 +1914,7 @@ Name | Type | ▸ **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/c93b02d55/packages/ethereum-types/src/index.ts#L14)* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -1903,7 +1938,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* ___ @@ -1911,7 +1946,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* ___ @@ -1919,7 +1954,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* ___ @@ -1927,7 +1962,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
@@ -1940,7 +1975,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* ___ @@ -1948,7 +1983,7 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
@@ -1961,7 +1996,7 @@ ___ • **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)* +*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* ___ @@ -1969,7 +2004,7 @@ ___ • **id**: *number* -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)* +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* ___ @@ -1977,7 +2012,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* ___ @@ -1985,7 +2020,7 @@ ___ • **result**: *any* -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)* +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
@@ -2046,7 +2081,7 @@ This interface allowed sending synchonous requests, support for which was later ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* -*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -2062,7 +2097,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -2088,7 +2123,7 @@ before the first attempts to conform to EIP1193 ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -2114,7 +2149,7 @@ however it does not conform entirely. ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -2140,7 +2175,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L31)* ___ @@ -2148,7 +2183,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L32)* ___ @@ -2156,7 +2191,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -2164,7 +2199,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -2174,7 +2209,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -2191,12 +2226,110 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void*
+# Interface: DebugPayload + + +## Properties + +### id + +• **id**: *number* + + + +Defined in ethereum-types/lib/index.d.ts:268 + +___ + +### jsonrpc + +• **jsonrpc**: *string* + + + +Defined in ethereum-types/lib/index.d.ts:269 + +___ + +### method + +• **method**: *string* + + + +Defined in ethereum-types/lib/index.d.ts:267 + +___ + +### params + +• **params**: *any[]* + + + +Defined in ethereum-types/lib/index.d.ts:266 + +___ + +### `Optional` rawTransactionAttributes + +• **rawTransactionAttributes**? : *[DebugPayloadRawTransactionAttributes](#class-debugpayloadrawtransactionattributes)* + +*Defined in [subproviders/src/subproviders/debug_subprovider.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/debug_subprovider.ts#L19)* + +
+ +# Interface: DebugPayloadRawTransactionAttributes + + +## Properties + +### gasLimit + +• **gasLimit**: *string* + +*Defined in [subproviders/src/subproviders/debug_subprovider.ts:13](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/debug_subprovider.ts#L13)* + +___ + +### gasPrice + +• **gasPrice**: *string* + +*Defined in [subproviders/src/subproviders/debug_subprovider.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/debug_subprovider.ts#L12)* + +___ + +### nonce + +• **nonce**: *string* + +*Defined in [subproviders/src/subproviders/debug_subprovider.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/debug_subprovider.ts#L14)* + +___ + +### to + +• **to**: *string* + +*Defined in [subproviders/src/subproviders/debug_subprovider.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/debug_subprovider.ts#L16)* + +___ + +### value + +• **value**: *string* + +*Defined in [subproviders/src/subproviders/debug_subprovider.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/debug_subprovider.ts#L15)* + +
+ # Interface: AccountFetchingConfigs addressSearchLimit: The maximum number of addresses to search through, defaults to 1000 @@ -2211,7 +2344,7 @@ shouldAskForOnDeviceConfirmation: Whether you wish to prompt the user on their L • **addressSearchLimit**? : *undefined | number* -*Defined in [subproviders/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L55)* +*Defined in [subproviders/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L55)* ___ @@ -2219,7 +2352,7 @@ ___ • **numAddressesToReturn**? : *undefined | number* -*Defined in [subproviders/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L56)* +*Defined in [subproviders/src/types.ts:56](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L56)* ___ @@ -2227,7 +2360,7 @@ ___ • **shouldAskForOnDeviceConfirmation**? : *undefined | false | true* -*Defined in [subproviders/src/types.ts:57](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L57)* +*Defined in [subproviders/src/types.ts:57](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L57)*
@@ -2242,7 +2375,7 @@ ___ • **r**: *string* -*Defined in [subproviders/src/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L29)* +*Defined in [subproviders/src/types.ts:29](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L29)* ___ @@ -2250,7 +2383,7 @@ ___ • **s**: *string* -*Defined in [subproviders/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L30)* +*Defined in [subproviders/src/types.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L30)* ___ @@ -2258,7 +2391,7 @@ ___ • **v**: *string* -*Defined in [subproviders/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L28)* +*Defined in [subproviders/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L28)*
@@ -2273,7 +2406,7 @@ ___ -Defined in ethereum-types/lib/index.d.ts:267 +Defined in ethereum-types/lib/index.d.ts:268 ___ @@ -2283,7 +2416,7 @@ ___ -Defined in ethereum-types/lib/index.d.ts:268 +Defined in ethereum-types/lib/index.d.ts:269 ___ @@ -2293,7 +2426,7 @@ ___ *Overrides void* -*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L136)* +*Defined in [subproviders/src/types.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L136)* ___ @@ -2303,7 +2436,7 @@ ___ -Defined in ethereum-types/lib/index.d.ts:265 +Defined in ethereum-types/lib/index.d.ts:266
@@ -2325,7 +2458,7 @@ NodeJs and Browser communication are supported. • **getAddress**: *function* -*Defined in [subproviders/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L17)* +*Defined in [subproviders/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L17)* #### Type declaration: @@ -2345,7 +2478,7 @@ ___ • **signPersonalMessage**: *function* -*Defined in [subproviders/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L23)* +*Defined in [subproviders/src/types.ts:23](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L23)* #### Type declaration: @@ -2364,7 +2497,7 @@ ___ • **signTransaction**: *function* -*Defined in [subproviders/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L22)* +*Defined in [subproviders/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L22)* #### Type declaration: @@ -2383,7 +2516,7 @@ ___ • **transport**: *[LedgerCommunicationClient](#class-ledgercommunicationclient)* -*Defined in [subproviders/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L24)* +*Defined in [subproviders/src/types.ts:24](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L24)*
@@ -2396,7 +2529,7 @@ ___ • **address**: *string* -*Defined in [subproviders/src/types.ts:79](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L79)* +*Defined in [subproviders/src/types.ts:79](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L79)* ___ @@ -2404,7 +2537,7 @@ ___ • **chainCode**: *string* -*Defined in [subproviders/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L81)* +*Defined in [subproviders/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L81)* ___ @@ -2412,7 +2545,7 @@ ___ • **publicKey**: *string* -*Defined in [subproviders/src/types.ts:80](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L80)* +*Defined in [subproviders/src/types.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L80)*
@@ -2430,7 +2563,7 @@ accountFetchingConfigs: configs related to fetching accounts from a Ledger • **accountFetchingConfigs**? : *[AccountFetchingConfigs](#class-accountfetchingconfigs)* -*Defined in [subproviders/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L45)* +*Defined in [subproviders/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L45)* ___ @@ -2438,7 +2571,7 @@ ___ • **baseDerivationPath**? : *undefined | string* -*Defined in [subproviders/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L44)* +*Defined in [subproviders/src/types.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L44)* ___ @@ -2446,7 +2579,7 @@ ___ • **ledgerEthereumClientFactoryAsync**: *[LedgerEthereumClientFactoryAsync](#ledgerethereumclientfactoryasync)* -*Defined in [subproviders/src/types.ts:43](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L43)* +*Defined in [subproviders/src/types.ts:43](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L43)* ___ @@ -2454,7 +2587,7 @@ ___ • **networkId**: *number* -*Defined in [subproviders/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L42)* +*Defined in [subproviders/src/types.ts:42](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L42)*
@@ -2471,7 +2604,7 @@ baseDerivationPath: The base derivation path (e.g 44'/60'/0'/0) • **addressSearchLimit**? : *undefined | number* -*Defined in [subproviders/src/types.ts:67](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L67)* +*Defined in [subproviders/src/types.ts:67](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L67)* ___ @@ -2479,7 +2612,7 @@ ___ • **baseDerivationPath**? : *undefined | string* -*Defined in [subproviders/src/types.ts:68](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L68)* +*Defined in [subproviders/src/types.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L68)* ___ @@ -2487,7 +2620,7 @@ ___ • **mnemonic**: *string* -*Defined in [subproviders/src/types.ts:66](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L66)* +*Defined in [subproviders/src/types.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L66)*
@@ -2500,7 +2633,7 @@ ___ • **chainId**: *number* -*Defined in [subproviders/src/types.ts:92](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L92)* +*Defined in [subproviders/src/types.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L92)* ___ @@ -2508,7 +2641,7 @@ ___ • **data**? : *undefined | string* -*Defined in [subproviders/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L91)* +*Defined in [subproviders/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L91)* ___ @@ -2516,7 +2649,7 @@ ___ • **from**: *string* -*Defined in [subproviders/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L89)* +*Defined in [subproviders/src/types.ts:89](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L89)* ___ @@ -2524,7 +2657,7 @@ ___ • **gas**: *string* -*Defined in [subproviders/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L87)* +*Defined in [subproviders/src/types.ts:87](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L87)* ___ @@ -2532,7 +2665,7 @@ ___ • **gasPrice**? : *undefined | string* -*Defined in [subproviders/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L86)* +*Defined in [subproviders/src/types.ts:86](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L86)* ___ @@ -2540,7 +2673,7 @@ ___ • **nonce**: *string* -*Defined in [subproviders/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L85)* +*Defined in [subproviders/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L85)* ___ @@ -2548,7 +2681,7 @@ ___ • **to**: *string* -*Defined in [subproviders/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L88)* +*Defined in [subproviders/src/types.ts:88](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L88)* ___ @@ -2556,7 +2689,7 @@ ___ • **value**? : *undefined | string* -*Defined in [subproviders/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L90)* +*Defined in [subproviders/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L90)*
@@ -2566,7 +2699,100 @@ ___ +# Class: DebugSubprovider + +This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. +For every request, a object for debugging will be sent to the function specified in the constructor +Useful for debugging RPC requests which are not expecting as you expect. + + +## Constructors + + + +\+ **new DebugSubprovider**(`debugCallback`: [WithDebugPayload](#withdebugpayload)): *[DebugSubprovider](#class-debugsubprovider)* + +*Defined in [subproviders/src/subproviders/debug_subprovider.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/debug_subprovider.ts#L44)* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`debugCallback` | [WithDebugPayload](#withdebugpayload) | defaultDebugCallback | + +**Returns:** *[DebugSubprovider](#class-debugsubprovider)* + +## Methods + +### emitPayloadAsync + +▸ **emitPayloadAsync**(`payload`: `Partial`): *`Promise`* + +*Inherited from [Subprovider](#interface-subprovider).[emitPayloadAsync](#emitpayloadasync)* + +*Defined in [subproviders/src/subproviders/subprovider.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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 [Subprovider](_subproviders_src_subproviders_subprovider_.subprovider.md).[handleRequest](#abstract-handlerequest)* + +*Defined in [subproviders/src/subproviders/debug_subprovider.ts:60](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/debug_subprovider.ts#L60)* + +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* + +*Inherited from [Subprovider](#interface-subprovider).[setEngine](#setengine)* + +*Defined in [subproviders/src/subproviders/subprovider.ts:68](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/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* + +
@@ -2583,7 +2809,7 @@ ___ • **accountFetchingConfigs**: *[AccountFetchingConfigs](#class-accountfetchingconfigs)* -*Defined in [subproviders/src/types.ts:140](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L140)* +*Defined in [subproviders/src/types.ts:140](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L140)* ___ @@ -2591,7 +2817,7 @@ ___ • **networkId**: *number* -*Defined in [subproviders/src/types.ts:142](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L142)* +*Defined in [subproviders/src/types.ts:142](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L142)* ___ @@ -2599,7 +2825,7 @@ ___ • **trezorConnectClientApi**: *any* -*Defined in [subproviders/src/types.ts:141](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L141)* +*Defined in [subproviders/src/types.ts:141](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L141)*
@@ -2628,8 +2854,6 @@ ___ - - @@ -2644,7 +2868,7 @@ Elliptic Curve signature • **r**: *string* -*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L62)* +*Defined in [types/src/index.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L62)* ___ @@ -2652,7 +2876,7 @@ ___ • **s**: *string* -*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L63)* +*Defined in [types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L63)* ___ @@ -2660,7 +2884,7 @@ ___ • **v**: *number* -*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L61)* +*Defined in [types/src/index.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L61)*
@@ -2680,7 +2904,7 @@ ___ • **name**: *string* -*Defined in [types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L732)* +*Defined in [types/src/index.ts:732](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L732)* ___ @@ -2688,7 +2912,7 @@ ___ • **type**: *string* -*Defined in [types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L733)* +*Defined in [types/src/index.ts:733](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L733)*
@@ -2701,7 +2925,7 @@ ___ • **domain**: *[EIP712Object](#class-eip712object)* -*Defined in [types/src/index.ts:748](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L748)* +*Defined in [types/src/index.ts:748](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L748)* ___ @@ -2709,7 +2933,7 @@ ___ • **message**: *[EIP712Object](#class-eip712object)* -*Defined in [types/src/index.ts:749](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L749)* +*Defined in [types/src/index.ts:749](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L749)* ___ @@ -2717,7 +2941,7 @@ ___ • **primaryType**: *string* -*Defined in [types/src/index.ts:750](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L750)* +*Defined in [types/src/index.ts:750](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L750)* ___ @@ -2725,7 +2949,7 @@ ___ • **types**: *[EIP712Types](#class-eip712types)* -*Defined in [types/src/index.ts:747](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L747)* +*Defined in [types/src/index.ts:747](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L747)*
@@ -2743,7 +2967,7 @@ ___ • **name**: *string* -*Defined in [types/src/index.ts:686](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L686)* +*Defined in [types/src/index.ts:686](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L686)* ___ @@ -2751,7 +2975,7 @@ ___ • **typeDocType**: *[TypeDocTypes](#enumeration-typedoctypes)* -*Defined in [types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L687)* +*Defined in [types/src/index.ts:687](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/types/src/index.ts#L687)*
@@ -2868,6 +3092,30 @@ ___ + + + + +## Functions + +### prependSubprovider + +▸ **prependSubprovider**(`provider`: `Web3ProviderEngine`, `subprovider`: [Subprovider](#class-subprovider)): *void* + +*Defined in [subproviders/src/utils/subprovider_utils.ts:10](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/utils/subprovider_utils.ts#L10)* + +Prepends a subprovider to a provider + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`provider` | `Web3ProviderEngine` | Given provider | +`subprovider` | [Subprovider](#class-subprovider) | Subprovider to prepend | + +**Returns:** *void* + +
@@ -2890,7 +3138,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L70)* Interface for providers that conform to EIP 1193 Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md @@ -2907,7 +3155,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -2936,7 +3184,7 @@ ___ Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)* -*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L9)* Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library Read more about Providers in the guides section of the 0x docs. @@ -2951,7 +3199,7 @@ ___ Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)* -*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L11)*
@@ -2964,7 +3212,7 @@ ___ ▸ **ledgerEthereumBrowserClientFactoryAsync**(): *`Promise`* -*Defined in [subproviders/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/index.ts#L11)* +*Defined in [subproviders/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/index.ts#L11)* A factory method for creating a LedgerEthereumClient usable in a browser context. @@ -2976,6 +3224,29 @@ LedgerEthereumClient A browser client for the LedgerSubprovider + +## Type aliases + +### WithDebugPayload + +Ƭ **WithDebugPayload**: *function* + +*Defined in [subproviders/src/subproviders/debug_subprovider.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/subproviders/debug_subprovider.ts#L22)* + +#### Type declaration: + +▸ (`debugPayload`: [DebugPayload](#interface-debugpayload)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`debugPayload` | [DebugPayload](#interface-debugpayload) | + +
+ + +
@@ -3035,7 +3306,7 @@ LedgerEthereumClient A browser client for the LedgerSubprovider Ƭ **Callback**: *function* -*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L131)* +*Defined in [subproviders/src/types.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L131)* #### Type declaration: @@ -3049,7 +3320,7 @@ ___ Ƭ **ErrorCallback**: *function* -*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L130)* +*Defined in [subproviders/src/types.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L130)* #### Type declaration: @@ -3068,7 +3339,7 @@ ___ Ƭ **LedgerEthereumClientFactoryAsync**: *function* -*Defined in [subproviders/src/types.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L33)* +*Defined in [subproviders/src/types.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L33)* #### Type declaration: @@ -3080,7 +3351,7 @@ ___ Ƭ **NextCallback**: *function* -*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L133)* +*Defined in [subproviders/src/types.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L133)* #### Type declaration: @@ -3098,7 +3369,7 @@ ___ Ƭ **OnNextCompleted**: *function* -*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/types.ts#L132)* +*Defined in [subproviders/src/types.ts:132](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/subproviders/src/types.ts#L132)* #### Type declaration: @@ -3114,60 +3385,3 @@ Name | Type |
- - - -## Functions - -### prependSubprovider - -▸ **prependSubprovider**(`provider`: `Web3ProviderEngine`, `subprovider`: [Subprovider](#class-subprovider)): *void* - -*Defined in [subproviders/src/utils/subprovider_utils.ts:10](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/subproviders/src/utils/subprovider_utils.ts#L10)* - -Prepends a subprovider to a provider - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`provider` | `Web3ProviderEngine` | Given provider | -`subprovider` | [Subprovider](#class-subprovider) | Subprovider to prepend | - -**Returns:** *void* - -
- - - - -## Type aliases - - - - - - - - - -### EIP712ObjectValue - -Ƭ **EIP712ObjectValue**: *string | number | [EIP712Object](#interface-eip712object)* - -*Defined in [types/src/index.ts:740](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/types/src/index.ts#L740)* - -___ - - - - - - - - - - - - - diff --git a/packages/tslint-config/CHANGELOG.json b/packages/tslint-config/CHANGELOG.json index 0e1e7aa829..6359729414 100644 --- a/packages/tslint-config/CHANGELOG.json +++ b/packages/tslint-config/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "3.1.0-beta.1", diff --git a/packages/tslint-config/CHANGELOG.md b/packages/tslint-config/CHANGELOG.md index ade36111d8..3b1e3b3af5 100644 --- a/packages/tslint-config/CHANGELOG.md +++ b/packages/tslint-config/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v3.1.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v3.1.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/types/CHANGELOG.json b/packages/types/CHANGELOG.json index 162bec3510..f54e9ad394 100644 --- a/packages/types/CHANGELOG.json +++ b/packages/types/CHANGELOG.json @@ -6,7 +6,8 @@ "note": "Remove `SendTransactionOpts` and `AwaitTransactionSuccessOpts` types and move them to @0x/base-contracts", "pr": 2325 } - ] + ], + "timestamp": 1574030254 }, { "version": "2.5.0-beta.1", diff --git a/packages/types/CHANGELOG.md b/packages/types/CHANGELOG.md index 2a66e963ca..88e31cf17e 100644 --- a/packages/types/CHANGELOG.md +++ b/packages/types/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v2.5.0-beta.2 - _November 17, 2019_ + + * Remove `SendTransactionOpts` and `AwaitTransactionSuccessOpts` types and move them to @0x/base-contracts (#2325) + ## v2.5.0-beta.1 - _November 7, 2019_ * Add `SendTransactionOpts` and `AwaitTransactionSuccessOpts` types for contract wrappers (#2243) diff --git a/packages/typescript-typings/CHANGELOG.json b/packages/typescript-typings/CHANGELOG.json index 752c69e647..a61da2628f 100644 --- a/packages/typescript-typings/CHANGELOG.json +++ b/packages/typescript-typings/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "4.4.0-beta.1", diff --git a/packages/typescript-typings/CHANGELOG.md b/packages/typescript-typings/CHANGELOG.md index c3b4cc0936..16540ac750 100644 --- a/packages/typescript-typings/CHANGELOG.md +++ b/packages/typescript-typings/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v4.4.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v4.4.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/utils/CHANGELOG.json b/packages/utils/CHANGELOG.json index 7e9b3addc9..e0994b4fdb 100644 --- a/packages/utils/CHANGELOG.json +++ b/packages/utils/CHANGELOG.json @@ -14,7 +14,8 @@ "note": "Update BigNumber version to ~9.0.0", "pr": 2342 } - ] + ], + "timestamp": 1574030254 }, { "version": "4.6.0-beta.1", diff --git a/packages/utils/CHANGELOG.md b/packages/utils/CHANGELOG.md index 510dfc61d9..60bc78a989 100644 --- a/packages/utils/CHANGELOG.md +++ b/packages/utils/CHANGELOG.md @@ -5,6 +5,12 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v4.6.0-beta.2 - _November 17, 2019_ + + * Removed exports AuthorizableRevertErrors, LibAddressArrayRevertErrors, LibBytesRevertErrors, OwnableRevertErrors, ReentrancyGuardRevertErrors and SafeMathRevertErrors (#2321) + * Decode `Parity` revert errors (#2341) + * Update BigNumber version to ~9.0.0 (#2342) + ## v4.6.0-beta.1 - _November 7, 2019_ * Consolidated FixedMathRevertErrors (#2255) diff --git a/packages/web3-wrapper/CHANGELOG.json b/packages/web3-wrapper/CHANGELOG.json index c6609c9a05..69c7756919 100644 --- a/packages/web3-wrapper/CHANGELOG.json +++ b/packages/web3-wrapper/CHANGELOG.json @@ -5,7 +5,8 @@ { "note": "Dependencies updated" } - ] + ], + "timestamp": 1574030254 }, { "version": "6.1.0-beta.1", diff --git a/packages/web3-wrapper/CHANGELOG.md b/packages/web3-wrapper/CHANGELOG.md index cd813e53a0..a741d51039 100644 --- a/packages/web3-wrapper/CHANGELOG.md +++ b/packages/web3-wrapper/CHANGELOG.md @@ -5,6 +5,10 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v6.1.0-beta.2 - _November 17, 2019_ + + * Dependencies updated + ## v6.1.0-beta.1 - _November 7, 2019_ * Dependencies updated diff --git a/packages/web3-wrapper/docs/reference.mdx b/packages/web3-wrapper/docs/reference.mdx index 825b07a3b7..781c71af3a 100644 --- a/packages/web3-wrapper/docs/reference.mdx +++ b/packages/web3-wrapper/docs/reference.mdx @@ -1,95 +1,37 @@ -# 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/c93b02d55/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* +# Interface: JSONRPCResponsePayload -*Defined in [utils/src/abi_decoder.ts:158](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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. +## Properties -**Parameters:** +### `Optional` error -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. | +• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -**Returns:** *void* +*Defined in [ethereum-types/src/index.ts:344](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L344)* ___ -### decodeCalldataOrThrow - -▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`* - -*Defined in [utils/src/abi_decoder.ts:118](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/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). | +### id -**Returns:** *`DecodedCalldata`* +• **id**: *number* -Decoded calldata. Includes: function name and signature, along with the decoded arguments. +*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L342)* ___ -### tryToDecodeLogOrNoop - -▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs` | [RawLog](#rawlog)* - -*Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/utils/src/abi_decoder.ts#L58)* - -Attempt to decode a log given the ABI's the AbiDecoder knows about. +### jsonrpc -**Type parameters:** +• **jsonrpc**: *string* -▪ **ArgsType**: *`DecodedLogArgs`* +*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L343)* -**Parameters:** +___ -Name | Type | Description | ------- | ------ | ------ | -`log` | `LogEntry` | The log to attempt to decode | +### result -**Returns:** *`LogWithDecodedArgs` | [RawLog](#rawlog)* +• **result**: *any* -The decoded log if the requisite ABI was available. Otherwise the log unaltered. +*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L341)*
@@ -104,7 +46,7 @@ An alternative to the Web3.js library that provides a consistent, clean, promise \+ **new Web3Wrapper**(`supportedProvider`: [SupportedProvider](#supportedprovider), `callAndTxnDefaults`: `Partial`): *[Web3Wrapper](#class-web3wrapper)* -*Defined in [web3-wrapper/src/web3_wrapper.ts:144](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L144)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:144](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L144)* Instantiates a new Web3Wrapper. @@ -125,7 +67,7 @@ An instance of the Web3Wrapper class. • **abiDecoder**: *`AbiDecoder`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L54)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L54)* ___ @@ -133,7 +75,7 @@ ___ • **isZeroExWeb3Wrapper**: *boolean* = true -*Defined in [web3-wrapper/src/web3_wrapper.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L53)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L53)* Flag to check if this instance is of type Web3Wrapper @@ -143,7 +85,7 @@ Flag to check if this instance is of type Web3Wrapper ▸ **awaitTransactionMinedAsync**(`txHash`: string, `pollingIntervalMs`: number, `timeoutMs?`: undefined | number): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:576](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L576)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:576](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L576)* Waits for a transaction to be mined and returns the transaction receipt. Note that just because a transaction was mined does not mean it was @@ -169,7 +111,7 @@ ___ ▸ **awaitTransactionSuccessAsync**(`txHash`: string, `pollingIntervalMs`: number, `timeoutMs?`: undefined | number): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:651](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L651)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:651](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L651)* Waits for a transaction to be mined and returns the transaction receipt. Unlike awaitTransactionMinedAsync, it will throw if the receipt has a @@ -195,7 +137,7 @@ ___ ▸ **callAsync**(`callData`: `CallData`, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:533](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L533)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:533](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L533)* Call a smart contract method at a given block height @@ -216,7 +158,7 @@ ___ ▸ **doesContractExistAtAddressAsync**(`address`: string): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:281](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L281)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:281](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L281)* Check if a contract exists at a given address @@ -236,7 +178,7 @@ ___ ▸ **estimateGasAsync**(`txData`: `Partial`): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:516](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L516)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:516](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L516)* Calculate the estimated gas cost for a given transaction @@ -256,7 +198,7 @@ ___ ▸ **getAvailableAddressesAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L429)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:429](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L429)* Retrieve the user addresses available through the backing provider @@ -270,7 +212,7 @@ ___ ▸ **getBalanceInWeiAsync**(`owner`: string, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:262](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L262)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:262](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L262)* Retrieves an accounts Ether balance in wei @@ -291,7 +233,7 @@ ___ ▸ **getBlockIfExistsAsync**(`blockParam`: string | [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:369](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L369)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:369](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L369)* Fetch a specific Ethereum block without transaction data @@ -312,7 +254,7 @@ ___ ▸ **getBlockNumberAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:355](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L355)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:355](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L355)* Fetches the latest block number @@ -326,7 +268,7 @@ ___ ▸ **getBlockTimestampAsync**(`blockParam`: string | [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L417)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L417)* Fetch a block's timestamp @@ -346,7 +288,7 @@ ___ ▸ **getBlockWithTransactionDataAsync**(`blockParam`: string | [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:395](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L395)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L395)* Fetch a specific Ethereum block with transaction data @@ -366,7 +308,7 @@ ___ ▸ **getChainIdAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:215](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L215)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L215)* Fetches the chainId of the backing Ethereum node @@ -380,7 +322,7 @@ ___ ▸ **getContractCodeAsync**(`address`: string, `defaultBlock?`: [BlockParam](#blockparam)): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:294](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L294)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:294](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L294)* Gets the contract code by address @@ -401,7 +343,7 @@ ___ ▸ **getContractDefaults**(): *`Partial` | undefined* -*Defined in [web3-wrapper/src/web3_wrapper.ts:163](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L163)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:163](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L163)* Get the contract defaults set to the Web3Wrapper instance @@ -415,7 +357,7 @@ ___ ▸ **getLogsAsync**(`filter`: `FilterObject`): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:483](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L483)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:483](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L483)* Retrieve smart contract logs for a given filter @@ -435,7 +377,7 @@ ___ ▸ **getNetworkIdAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:206](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L206)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:206](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L206)* Fetches the networkId of the backing Ethereum node @@ -449,7 +391,7 @@ ___ ▸ **getNodeTypeAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:698](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L698)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:698](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L698)* Returns either NodeType.Geth or NodeType.Ganache depending on the type of the backing Ethereum node. Throws for any other type of node. @@ -462,7 +404,7 @@ ___ ▸ **getNodeVersionAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:198](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L198)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:198](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L198)* Fetch the backing Ethereum node's version string (e.g `MetaMask/v4.2.0`) @@ -476,7 +418,7 @@ ___ ▸ **getProvider**(): *[SupportedProvider](#supportedprovider)* -*Defined in [web3-wrapper/src/web3_wrapper.ts:170](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L170)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:170](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L170)* Retrieve the Web3 provider @@ -490,7 +432,7 @@ ___ ▸ **getTransactionByHashAsync**(`txHash`: string): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:247](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L247)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:247](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L247)* Retrieves the transaction data for a given transaction @@ -510,7 +452,7 @@ ___ ▸ **getTransactionReceiptIfExistsAsync**(`txHash`: string): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:225](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L225)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:225](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L225)* Retrieves the transaction receipt for a given transaction hash if found @@ -530,7 +472,7 @@ ___ ▸ **getTransactionTraceAsync**(`txHash`: string, `traceParams`: `TraceParams`): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:313](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L313)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:313](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L313)* Gets the debug trace of a transaction @@ -551,7 +493,7 @@ ___ ▸ **increaseTimeAsync**(`timeDelta`: number): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:466](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L466)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:466](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L466)* Increase the next blocks timestamp on TestRPC/Ganache or Geth local node. Will throw if provider is neither TestRPC/Ganache or Geth. @@ -570,7 +512,7 @@ ___ ▸ **isSenderAddressAvailableAsync**(`senderAddress`: string): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:188](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L188)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:188](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L188)* Check whether an address is available through the backing provider. This can be useful if you want to know whether a user can sign messages or transactions from @@ -592,7 +534,7 @@ ___ ▸ **mineBlockAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:458](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L458)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L458)* Mine a block on a TestRPC/Ganache local node @@ -604,7 +546,7 @@ ___ ▸ **revertSnapshotAsync**(`snapshotId`: number): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:450](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L450)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:450](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L450)* Revert the blockchain state to a previous snapshot state on TestRPC/Ganache local node @@ -624,7 +566,7 @@ ___ ▸ **sendRawPayloadAsync**<**A**>(`payload`: `Partial`): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:679](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L679)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:679](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L679)* Sends a raw Ethereum JSON RPC payload and returns the response's `result` key @@ -648,7 +590,7 @@ ___ ▸ **sendTransactionAsync**(`txData`: `TxData`): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:555](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L555)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:555](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L555)* Send a transaction @@ -668,7 +610,7 @@ ___ ▸ **setHeadAsync**(`blockNumber`: number): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:670](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L670)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:670](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L670)* Calls the 'debug_setHead' JSON RPC method, which sets the current head of the local chain by block number. Note, this is a destructive action and @@ -690,7 +632,7 @@ ___ ▸ **setProvider**(`supportedProvider`: [SupportedProvider](#supportedprovider)): *void* -*Defined in [web3-wrapper/src/web3_wrapper.ts:177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L177)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L177)* Update the used Web3 provider @@ -708,7 +650,7 @@ ___ ▸ **signMessageAsync**(`address`: string, `message`: string): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:327](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L327)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:327](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L327)* Sign a message with a specific address's private key (`eth_sign`) @@ -729,7 +671,7 @@ ___ ▸ **signTypedDataAsync**(`address`: string, `typedData`: any): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L342)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:342](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L342)* Sign an EIP712 typed data message with a specific address's private key (`eth_signTypedData`) @@ -750,7 +692,7 @@ ___ ▸ **takeSnapshotAsync**(): *`Promise`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:441](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L441)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:441](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L441)* Take a snapshot of the blockchain state on a TestRPC/Ganache local node @@ -764,7 +706,7 @@ ___ ▸ **isAddress**(`address`: string): *boolean* -*Defined in [web3-wrapper/src/web3_wrapper.ts:65](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L65)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:65](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L65)* Check if an address is a valid Ethereum address @@ -784,7 +726,7 @@ ___ ▸ **toBaseUnitAmount**(`amount`: `BigNumber` | number, `decimals`: number): *`BigNumber`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L91)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L91)* A baseUnit is defined as the smallest denomination of a token. An amount expressed in baseUnits is the amount expressed in the smallest denomination. @@ -807,7 +749,7 @@ ___ ▸ **toUnitAmount**(`amount`: `BigNumber`, `decimals`: number): *`BigNumber`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:76](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L76)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:76](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L76)* A unit amount is defined as the amount of a token above the specified decimal places (integer part). E.g: If a currency has 18 decimal places, 1e18 or one quintillion of the currency is equivalent @@ -830,7 +772,7 @@ ___ ▸ **toWei**(`ethAmount`: `BigNumber`): *`BigNumber`* -*Defined in [web3-wrapper/src/web3_wrapper.ts:106](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/web3_wrapper.ts#L106)* +*Defined in [web3-wrapper/src/web3_wrapper.ts:106](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/web3_wrapper.ts#L106)* Convert an Ether amount from ETH to Wei @@ -857,7 +799,7 @@ Amount in wei • **Earliest**: = "earliest" -*Defined in [ethereum-types/src/index.ts:478](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L478)* +*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L479)* ___ @@ -865,7 +807,7 @@ ___ • **Latest**: = "latest" -*Defined in [ethereum-types/src/index.ts:479](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L479)* +*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L480)* ___ @@ -873,7 +815,7 @@ ___ • **Pending**: = "pending" -*Defined in [ethereum-types/src/index.ts:480](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L480)* +*Defined in [ethereum-types/src/index.ts:481](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L481)*
@@ -886,7 +828,7 @@ ___ • **Add**: = "ADD" -*Defined in [ethereum-types/src/index.ts:147](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L147)* +*Defined in [ethereum-types/src/index.ts:148](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L148)* ___ @@ -894,7 +836,7 @@ ___ • **AddMod**: = "ADDMOD" -*Defined in [ethereum-types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L154)* +*Defined in [ethereum-types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L155)* ___ @@ -902,7 +844,7 @@ ___ • **Address**: = "ADDRESS" -*Defined in [ethereum-types/src/index.ts:173](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L173)* +*Defined in [ethereum-types/src/index.ts:174](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L174)* ___ @@ -910,7 +852,7 @@ ___ • **And**: = "AND" -*Defined in [ethereum-types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L165)* +*Defined in [ethereum-types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L166)* ___ @@ -918,7 +860,7 @@ ___ • **Balance**: = "BALANCE" -*Defined in [ethereum-types/src/index.ts:174](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L174)* +*Defined in [ethereum-types/src/index.ts:175](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L175)* ___ @@ -926,7 +868,7 @@ ___ • **BlockHash**: = "BLOCKHASH" -*Defined in [ethereum-types/src/index.ts:189](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L189)* +*Defined in [ethereum-types/src/index.ts:190](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L190)* ___ @@ -934,7 +876,7 @@ ___ • **Byte**: = "BYTE" -*Defined in [ethereum-types/src/index.ts:169](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L169)* +*Defined in [ethereum-types/src/index.ts:170](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L170)* ___ @@ -942,7 +884,7 @@ ___ • **Call**: = "CALL" -*Defined in [ethereum-types/src/index.ts:282](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L282)* +*Defined in [ethereum-types/src/index.ts:283](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L283)* ___ @@ -950,7 +892,7 @@ ___ • **CallCode**: = "CALLCODE" -*Defined in [ethereum-types/src/index.ts:283](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L283)* +*Defined in [ethereum-types/src/index.ts:284](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L284)* ___ @@ -958,7 +900,7 @@ ___ • **CallDataCopy**: = "CALLDATACOPY" -*Defined in [ethereum-types/src/index.ts:180](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L180)* +*Defined in [ethereum-types/src/index.ts:181](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L181)* ___ @@ -966,7 +908,7 @@ ___ • **CallDataLoad**: = "CALLDATALOAD" -*Defined in [ethereum-types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L178)* +*Defined in [ethereum-types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L179)* ___ @@ -974,7 +916,7 @@ ___ • **CallDataSize**: = "CALLDATASIZE" -*Defined in [ethereum-types/src/index.ts:179](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L179)* +*Defined in [ethereum-types/src/index.ts:180](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L180)* ___ @@ -982,7 +924,7 @@ ___ • **CallValue**: = "CALLVALUE" -*Defined in [ethereum-types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L177)* +*Defined in [ethereum-types/src/index.ts:178](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L178)* ___ @@ -990,7 +932,7 @@ ___ • **Caller**: = "CALLER" -*Defined in [ethereum-types/src/index.ts:176](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L176)* +*Defined in [ethereum-types/src/index.ts:177](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L177)* ___ @@ -998,7 +940,7 @@ ___ • **CodeCopy**: = "CODECOPY" -*Defined in [ethereum-types/src/index.ts:182](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L182)* +*Defined in [ethereum-types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L183)* ___ @@ -1006,7 +948,7 @@ ___ • **CodeSize**: = "CODESIZE" -*Defined in [ethereum-types/src/index.ts:181](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L181)* +*Defined in [ethereum-types/src/index.ts:182](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L182)* ___ @@ -1014,7 +956,7 @@ ___ • **Coinbase**: = "COINBASE" -*Defined in [ethereum-types/src/index.ts:190](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L190)* +*Defined in [ethereum-types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L191)* ___ @@ -1022,7 +964,7 @@ ___ • **Create**: = "CREATE" -*Defined in [ethereum-types/src/index.ts:281](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L281)* +*Defined in [ethereum-types/src/index.ts:282](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L282)* ___ @@ -1030,7 +972,7 @@ ___ • **DelegateCall**: = "DELEGATECALL" -*Defined in [ethereum-types/src/index.ts:285](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L285)* +*Defined in [ethereum-types/src/index.ts:286](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L286)* ___ @@ -1038,7 +980,7 @@ ___ • **Difficulty**: = "DIFFICULTY" -*Defined in [ethereum-types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L193)* +*Defined in [ethereum-types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L194)* ___ @@ -1046,7 +988,7 @@ ___ • **Div**: = "DIV" -*Defined in [ethereum-types/src/index.ts:150](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L150)* +*Defined in [ethereum-types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L151)* ___ @@ -1054,7 +996,7 @@ ___ • **Dup1**: = "DUP1" -*Defined in [ethereum-types/src/index.ts:242](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L242)* +*Defined in [ethereum-types/src/index.ts:243](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L243)* ___ @@ -1062,7 +1004,7 @@ ___ • **Dup10**: = "DUP10" -*Defined in [ethereum-types/src/index.ts:251](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L251)* +*Defined in [ethereum-types/src/index.ts:252](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L252)* ___ @@ -1070,7 +1012,7 @@ ___ • **Dup11**: = "DUP11" -*Defined in [ethereum-types/src/index.ts:252](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L252)* +*Defined in [ethereum-types/src/index.ts:253](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L253)* ___ @@ -1078,7 +1020,7 @@ ___ • **Dup12**: = "DUP12" -*Defined in [ethereum-types/src/index.ts:253](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L253)* +*Defined in [ethereum-types/src/index.ts:254](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L254)* ___ @@ -1086,7 +1028,7 @@ ___ • **Dup13**: = "DUP13" -*Defined in [ethereum-types/src/index.ts:254](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L254)* +*Defined in [ethereum-types/src/index.ts:255](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L255)* ___ @@ -1094,7 +1036,7 @@ ___ • **Dup14**: = "DUP14" -*Defined in [ethereum-types/src/index.ts:255](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L255)* +*Defined in [ethereum-types/src/index.ts:256](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L256)* ___ @@ -1102,7 +1044,7 @@ ___ • **Dup15**: = "DUP15" -*Defined in [ethereum-types/src/index.ts:256](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L256)* +*Defined in [ethereum-types/src/index.ts:257](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L257)* ___ @@ -1110,7 +1052,7 @@ ___ • **Dup16**: = "DUP16" -*Defined in [ethereum-types/src/index.ts:257](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L257)* +*Defined in [ethereum-types/src/index.ts:258](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L258)* ___ @@ -1118,7 +1060,7 @@ ___ • **Dup2**: = "DUP2" -*Defined in [ethereum-types/src/index.ts:243](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L243)* +*Defined in [ethereum-types/src/index.ts:244](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L244)* ___ @@ -1126,7 +1068,7 @@ ___ • **Dup3**: = "DUP3" -*Defined in [ethereum-types/src/index.ts:244](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L244)* +*Defined in [ethereum-types/src/index.ts:245](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L245)* ___ @@ -1134,7 +1076,7 @@ ___ • **Dup4**: = "DUP4" -*Defined in [ethereum-types/src/index.ts:245](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L245)* +*Defined in [ethereum-types/src/index.ts:246](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L246)* ___ @@ -1142,7 +1084,7 @@ ___ • **Dup5**: = "DUP5" -*Defined in [ethereum-types/src/index.ts:246](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L246)* +*Defined in [ethereum-types/src/index.ts:247](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L247)* ___ @@ -1150,7 +1092,7 @@ ___ • **Dup6**: = "DUP6" -*Defined in [ethereum-types/src/index.ts:247](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L247)* +*Defined in [ethereum-types/src/index.ts:248](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L248)* ___ @@ -1158,7 +1100,7 @@ ___ • **Dup7**: = "DUP7" -*Defined in [ethereum-types/src/index.ts:248](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L248)* +*Defined in [ethereum-types/src/index.ts:249](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L249)* ___ @@ -1166,7 +1108,7 @@ ___ • **Dup8**: = "DUP8" -*Defined in [ethereum-types/src/index.ts:249](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L249)* +*Defined in [ethereum-types/src/index.ts:250](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L250)* ___ @@ -1174,7 +1116,7 @@ ___ • **Dup9**: = "DUP9" -*Defined in [ethereum-types/src/index.ts:250](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L250)* +*Defined in [ethereum-types/src/index.ts:251](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L251)* ___ @@ -1182,7 +1124,7 @@ ___ • **Eq**: = "EQ" -*Defined in [ethereum-types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L163)* +*Defined in [ethereum-types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L164)* ___ @@ -1190,7 +1132,7 @@ ___ • **Exp**: = "EXP" -*Defined in [ethereum-types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L156)* +*Defined in [ethereum-types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L157)* ___ @@ -1198,7 +1140,7 @@ ___ • **ExtCodeCopy**: = "EXTCODECOPY" -*Defined in [ethereum-types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L185)* +*Defined in [ethereum-types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L186)* ___ @@ -1206,7 +1148,7 @@ ___ • **ExtCodeSize**: = "EXTCODESIZE" -*Defined in [ethereum-types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L184)* +*Defined in [ethereum-types/src/index.ts:185](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L185)* ___ @@ -1214,7 +1156,7 @@ ___ • **Gas**: = "GAS" -*Defined in [ethereum-types/src/index.ts:206](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L206)* +*Defined in [ethereum-types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L207)* ___ @@ -1222,7 +1164,7 @@ ___ • **GasPrice**: = "GASPRICE" -*Defined in [ethereum-types/src/index.ts:183](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L183)* +*Defined in [ethereum-types/src/index.ts:184](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L184)* ___ @@ -1230,7 +1172,7 @@ ___ • **Gaslimit**: = "GASLIMIT" -*Defined in [ethereum-types/src/index.ts:194](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L194)* +*Defined in [ethereum-types/src/index.ts:195](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L195)* ___ @@ -1238,7 +1180,7 @@ ___ • **Gt**: = "GT" -*Defined in [ethereum-types/src/index.ts:160](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L160)* +*Defined in [ethereum-types/src/index.ts:161](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L161)* ___ @@ -1246,7 +1188,7 @@ ___ • **Invalid**: = "INVALID" -*Defined in [ethereum-types/src/index.ts:288](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L288)* +*Defined in [ethereum-types/src/index.ts:289](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L289)* ___ @@ -1254,7 +1196,7 @@ ___ • **IsZero**: = "ISZERO" -*Defined in [ethereum-types/src/index.ts:164](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L164)* +*Defined in [ethereum-types/src/index.ts:165](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L165)* ___ @@ -1262,7 +1204,7 @@ ___ • **Jump**: = "JUMP" -*Defined in [ethereum-types/src/index.ts:202](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L202)* +*Defined in [ethereum-types/src/index.ts:203](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L203)* ___ @@ -1270,7 +1212,7 @@ ___ • **JumpDest**: = "JUMPDEST" -*Defined in [ethereum-types/src/index.ts:207](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L207)* +*Defined in [ethereum-types/src/index.ts:208](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L208)* ___ @@ -1278,7 +1220,7 @@ ___ • **Jumpi**: = "JUMPI" -*Defined in [ethereum-types/src/index.ts:203](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L203)* +*Defined in [ethereum-types/src/index.ts:204](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L204)* ___ @@ -1286,7 +1228,7 @@ ___ • **Log1**: = "LOG1" -*Defined in [ethereum-types/src/index.ts:276](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L276)* +*Defined in [ethereum-types/src/index.ts:277](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L277)* ___ @@ -1294,7 +1236,7 @@ ___ • **Log2**: = "LOG2" -*Defined in [ethereum-types/src/index.ts:277](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L277)* +*Defined in [ethereum-types/src/index.ts:278](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L278)* ___ @@ -1302,7 +1244,7 @@ ___ • **Log3**: = "LOG3" -*Defined in [ethereum-types/src/index.ts:278](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L278)* +*Defined in [ethereum-types/src/index.ts:279](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L279)* ___ @@ -1310,7 +1252,7 @@ ___ • **Log4**: = "LOG4" -*Defined in [ethereum-types/src/index.ts:279](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L279)* +*Defined in [ethereum-types/src/index.ts:280](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L280)* ___ @@ -1318,7 +1260,7 @@ ___ • **Lt**: = "LT" -*Defined in [ethereum-types/src/index.ts:159](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L159)* +*Defined in [ethereum-types/src/index.ts:160](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L160)* ___ @@ -1326,7 +1268,7 @@ ___ • **MLoad**: = "MLOAD" -*Defined in [ethereum-types/src/index.ts:197](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L197)* +*Defined in [ethereum-types/src/index.ts:198](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L198)* ___ @@ -1334,7 +1276,7 @@ ___ • **MSize**: = "MSIZE" -*Defined in [ethereum-types/src/index.ts:205](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L205)* +*Defined in [ethereum-types/src/index.ts:206](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L206)* ___ @@ -1342,7 +1284,7 @@ ___ • **MStore**: = "MSTORE" -*Defined in [ethereum-types/src/index.ts:198](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L198)* +*Defined in [ethereum-types/src/index.ts:199](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L199)* ___ @@ -1350,7 +1292,7 @@ ___ • **MStore8**: = "MSTORE8" -*Defined in [ethereum-types/src/index.ts:199](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L199)* +*Defined in [ethereum-types/src/index.ts:200](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L200)* ___ @@ -1358,7 +1300,7 @@ ___ • **Mod**: = "MOD" -*Defined in [ethereum-types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L152)* +*Defined in [ethereum-types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L153)* ___ @@ -1366,7 +1308,7 @@ ___ • **Mul**: = "MUL" -*Defined in [ethereum-types/src/index.ts:148](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L148)* +*Defined in [ethereum-types/src/index.ts:149](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L149)* ___ @@ -1374,7 +1316,7 @@ ___ • **MulMod**: = "MULMOD" -*Defined in [ethereum-types/src/index.ts:155](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L155)* +*Defined in [ethereum-types/src/index.ts:156](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L156)* ___ @@ -1382,7 +1324,7 @@ ___ • **Not**: = "NOT" -*Defined in [ethereum-types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L168)* +*Defined in [ethereum-types/src/index.ts:169](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L169)* ___ @@ -1390,7 +1332,7 @@ ___ • **Number**: = "NUMBER" -*Defined in [ethereum-types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L192)* +*Defined in [ethereum-types/src/index.ts:193](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L193)* ___ @@ -1398,7 +1340,7 @@ ___ • **Or**: = "OR" -*Defined in [ethereum-types/src/index.ts:166](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L166)* +*Defined in [ethereum-types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L167)* ___ @@ -1406,7 +1348,7 @@ ___ • **Origin**: = "ORIGIN" -*Defined in [ethereum-types/src/index.ts:175](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L175)* +*Defined in [ethereum-types/src/index.ts:176](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L176)* ___ @@ -1414,7 +1356,7 @@ ___ • **Pc**: = "PC" -*Defined in [ethereum-types/src/index.ts:204](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L204)* +*Defined in [ethereum-types/src/index.ts:205](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L205)* ___ @@ -1422,7 +1364,7 @@ ___ • **Pop**: = "POP" -*Defined in [ethereum-types/src/index.ts:196](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L196)* +*Defined in [ethereum-types/src/index.ts:197](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L197)* ___ @@ -1430,7 +1372,7 @@ ___ • **Push1**: = "PUSH1" -*Defined in [ethereum-types/src/index.ts:209](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L209)* +*Defined in [ethereum-types/src/index.ts:210](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L210)* ___ @@ -1438,7 +1380,7 @@ ___ • **Push10**: = "PUSH10" -*Defined in [ethereum-types/src/index.ts:218](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L218)* +*Defined in [ethereum-types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L219)* ___ @@ -1446,7 +1388,7 @@ ___ • **Push11**: = "PUSH11" -*Defined in [ethereum-types/src/index.ts:219](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L219)* +*Defined in [ethereum-types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L220)* ___ @@ -1454,7 +1396,7 @@ ___ • **Push12**: = "PUSH12" -*Defined in [ethereum-types/src/index.ts:220](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L220)* +*Defined in [ethereum-types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L221)* ___ @@ -1462,7 +1404,7 @@ ___ • **Push13**: = "PUSH13" -*Defined in [ethereum-types/src/index.ts:221](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L221)* +*Defined in [ethereum-types/src/index.ts:222](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L222)* ___ @@ -1470,7 +1412,7 @@ ___ • **Push14**: = "PUSH14" -*Defined in [ethereum-types/src/index.ts:222](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L222)* +*Defined in [ethereum-types/src/index.ts:223](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L223)* ___ @@ -1478,7 +1420,7 @@ ___ • **Push15**: = "PUSH15" -*Defined in [ethereum-types/src/index.ts:223](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L223)* +*Defined in [ethereum-types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L224)* ___ @@ -1486,7 +1428,7 @@ ___ • **Push16**: = "PUSH16" -*Defined in [ethereum-types/src/index.ts:224](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L224)* +*Defined in [ethereum-types/src/index.ts:225](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L225)* ___ @@ -1494,7 +1436,7 @@ ___ • **Push17**: = "PUSH17" -*Defined in [ethereum-types/src/index.ts:225](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L225)* +*Defined in [ethereum-types/src/index.ts:226](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L226)* ___ @@ -1502,7 +1444,7 @@ ___ • **Push18**: = "PUSH18" -*Defined in [ethereum-types/src/index.ts:226](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L226)* +*Defined in [ethereum-types/src/index.ts:227](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L227)* ___ @@ -1510,7 +1452,7 @@ ___ • **Push19**: = "PUSH19" -*Defined in [ethereum-types/src/index.ts:227](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L227)* +*Defined in [ethereum-types/src/index.ts:228](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L228)* ___ @@ -1518,7 +1460,7 @@ ___ • **Push2**: = "PUSH2" -*Defined in [ethereum-types/src/index.ts:210](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L210)* +*Defined in [ethereum-types/src/index.ts:211](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L211)* ___ @@ -1526,7 +1468,7 @@ ___ • **Push20**: = "PUSH20" -*Defined in [ethereum-types/src/index.ts:228](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L228)* +*Defined in [ethereum-types/src/index.ts:229](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L229)* ___ @@ -1534,7 +1476,7 @@ ___ • **Push21**: = "PUSH21" -*Defined in [ethereum-types/src/index.ts:229](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L229)* +*Defined in [ethereum-types/src/index.ts:230](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L230)* ___ @@ -1542,7 +1484,7 @@ ___ • **Push22**: = "PUSH22" -*Defined in [ethereum-types/src/index.ts:230](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L230)* +*Defined in [ethereum-types/src/index.ts:231](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L231)* ___ @@ -1550,7 +1492,7 @@ ___ • **Push23**: = "PUSH23" -*Defined in [ethereum-types/src/index.ts:231](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L231)* +*Defined in [ethereum-types/src/index.ts:232](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L232)* ___ @@ -1558,7 +1500,7 @@ ___ • **Push24**: = "PUSH24" -*Defined in [ethereum-types/src/index.ts:232](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L232)* +*Defined in [ethereum-types/src/index.ts:233](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L233)* ___ @@ -1566,7 +1508,7 @@ ___ • **Push25**: = "PUSH25" -*Defined in [ethereum-types/src/index.ts:233](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L233)* +*Defined in [ethereum-types/src/index.ts:234](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L234)* ___ @@ -1574,7 +1516,7 @@ ___ • **Push26**: = "PUSH26" -*Defined in [ethereum-types/src/index.ts:234](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L234)* +*Defined in [ethereum-types/src/index.ts:235](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L235)* ___ @@ -1582,7 +1524,7 @@ ___ • **Push27**: = "PUSH27" -*Defined in [ethereum-types/src/index.ts:235](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L235)* +*Defined in [ethereum-types/src/index.ts:236](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L236)* ___ @@ -1590,7 +1532,7 @@ ___ • **Push28**: = "PUSH28" -*Defined in [ethereum-types/src/index.ts:236](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L236)* +*Defined in [ethereum-types/src/index.ts:237](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L237)* ___ @@ -1598,7 +1540,7 @@ ___ • **Push29**: = "PUSH29" -*Defined in [ethereum-types/src/index.ts:237](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L237)* +*Defined in [ethereum-types/src/index.ts:238](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L238)* ___ @@ -1606,7 +1548,7 @@ ___ • **Push3**: = "PUSH3" -*Defined in [ethereum-types/src/index.ts:211](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L211)* +*Defined in [ethereum-types/src/index.ts:212](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L212)* ___ @@ -1614,7 +1556,7 @@ ___ • **Push30**: = "PUSH30" -*Defined in [ethereum-types/src/index.ts:238](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L238)* +*Defined in [ethereum-types/src/index.ts:239](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L239)* ___ @@ -1622,7 +1564,7 @@ ___ • **Push31**: = "PUSH31" -*Defined in [ethereum-types/src/index.ts:239](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L239)* +*Defined in [ethereum-types/src/index.ts:240](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L240)* ___ @@ -1630,7 +1572,7 @@ ___ • **Push32**: = "PUSH32" -*Defined in [ethereum-types/src/index.ts:240](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L240)* +*Defined in [ethereum-types/src/index.ts:241](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L241)* ___ @@ -1638,7 +1580,7 @@ ___ • **Push4**: = "PUSH4" -*Defined in [ethereum-types/src/index.ts:212](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L212)* +*Defined in [ethereum-types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L213)* ___ @@ -1646,7 +1588,7 @@ ___ • **Push5**: = "PUSH5" -*Defined in [ethereum-types/src/index.ts:213](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L213)* +*Defined in [ethereum-types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L214)* ___ @@ -1654,7 +1596,7 @@ ___ • **Push6**: = "PUSH6" -*Defined in [ethereum-types/src/index.ts:214](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L214)* +*Defined in [ethereum-types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L215)* ___ @@ -1662,7 +1604,7 @@ ___ • **Push7**: = "PUSH7" -*Defined in [ethereum-types/src/index.ts:215](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L215)* +*Defined in [ethereum-types/src/index.ts:216](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L216)* ___ @@ -1670,7 +1612,7 @@ ___ • **Push8**: = "PUSH8" -*Defined in [ethereum-types/src/index.ts:216](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L216)* +*Defined in [ethereum-types/src/index.ts:217](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L217)* ___ @@ -1678,7 +1620,7 @@ ___ • **Push9**: = "PUSH9" -*Defined in [ethereum-types/src/index.ts:217](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L217)* +*Defined in [ethereum-types/src/index.ts:218](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L218)* ___ @@ -1686,7 +1628,7 @@ ___ • **Return**: = "RETURN" -*Defined in [ethereum-types/src/index.ts:284](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L284)* +*Defined in [ethereum-types/src/index.ts:285](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L285)* ___ @@ -1694,7 +1636,7 @@ ___ • **ReturnDataCopy**: = "RETURNDATACOPY" -*Defined in [ethereum-types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L187)* +*Defined in [ethereum-types/src/index.ts:188](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L188)* ___ @@ -1702,7 +1644,7 @@ ___ • **ReturnDataSize**: = "RETURNDATASIZE" -*Defined in [ethereum-types/src/index.ts:186](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L186)* +*Defined in [ethereum-types/src/index.ts:187](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L187)* ___ @@ -1710,7 +1652,7 @@ ___ • **Revert**: = "REVERT" -*Defined in [ethereum-types/src/index.ts:287](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L287)* +*Defined in [ethereum-types/src/index.ts:288](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L288)* ___ @@ -1718,7 +1660,7 @@ ___ • **SDiv**: = "SDIV" -*Defined in [ethereum-types/src/index.ts:151](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L151)* +*Defined in [ethereum-types/src/index.ts:152](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L152)* ___ @@ -1726,7 +1668,7 @@ ___ • **SGt**: = "SGT" -*Defined in [ethereum-types/src/index.ts:162](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L162)* +*Defined in [ethereum-types/src/index.ts:163](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L163)* ___ @@ -1734,7 +1676,7 @@ ___ • **SLoad**: = "SLOAD" -*Defined in [ethereum-types/src/index.ts:200](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L200)* +*Defined in [ethereum-types/src/index.ts:201](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L201)* ___ @@ -1742,7 +1684,7 @@ ___ • **SLt**: = "SLT" -*Defined in [ethereum-types/src/index.ts:161](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L161)* +*Defined in [ethereum-types/src/index.ts:162](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L162)* ___ @@ -1750,7 +1692,7 @@ ___ • **SMod**: = "SMOD" -*Defined in [ethereum-types/src/index.ts:153](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L153)* +*Defined in [ethereum-types/src/index.ts:154](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L154)* ___ @@ -1758,7 +1700,7 @@ ___ • **SStore**: = "SSTORE" -*Defined in [ethereum-types/src/index.ts:201](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L201)* +*Defined in [ethereum-types/src/index.ts:202](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L202)* ___ @@ -1766,7 +1708,7 @@ ___ • **SelfDestruct**: = "SELFDESTRUCT" -*Defined in [ethereum-types/src/index.ts:289](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L289)* +*Defined in [ethereum-types/src/index.ts:290](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L290)* ___ @@ -1774,7 +1716,7 @@ ___ • **Sha3**: = "SHA3" -*Defined in [ethereum-types/src/index.ts:171](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L171)* +*Defined in [ethereum-types/src/index.ts:172](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L172)* ___ @@ -1782,7 +1724,7 @@ ___ • **SignExtend**: = "SIGNEXTEND" -*Defined in [ethereum-types/src/index.ts:157](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L157)* +*Defined in [ethereum-types/src/index.ts:158](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L158)* ___ @@ -1790,7 +1732,7 @@ ___ • **StaticCall**: = "STATICCALL" -*Defined in [ethereum-types/src/index.ts:286](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L286)* +*Defined in [ethereum-types/src/index.ts:287](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L287)* ___ @@ -1798,7 +1740,7 @@ ___ • **Stop**: = "STOP" -*Defined in [ethereum-types/src/index.ts:146](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L146)* +*Defined in [ethereum-types/src/index.ts:147](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L147)* ___ @@ -1806,7 +1748,7 @@ ___ • **Sub**: = "SUB" -*Defined in [ethereum-types/src/index.ts:149](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L149)* +*Defined in [ethereum-types/src/index.ts:150](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L150)* ___ @@ -1814,7 +1756,7 @@ ___ • **Swap1**: = "SWAP1" -*Defined in [ethereum-types/src/index.ts:259](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L259)* +*Defined in [ethereum-types/src/index.ts:260](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L260)* ___ @@ -1822,7 +1764,7 @@ ___ • **Swap10**: = "SWAP10" -*Defined in [ethereum-types/src/index.ts:268](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L268)* +*Defined in [ethereum-types/src/index.ts:269](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L269)* ___ @@ -1830,7 +1772,7 @@ ___ • **Swap11**: = "SWAP11" -*Defined in [ethereum-types/src/index.ts:269](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L269)* +*Defined in [ethereum-types/src/index.ts:270](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L270)* ___ @@ -1838,7 +1780,7 @@ ___ • **Swap12**: = "SWAP12" -*Defined in [ethereum-types/src/index.ts:270](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L270)* +*Defined in [ethereum-types/src/index.ts:271](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L271)* ___ @@ -1846,7 +1788,7 @@ ___ • **Swap13**: = "SWAP13" -*Defined in [ethereum-types/src/index.ts:271](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L271)* +*Defined in [ethereum-types/src/index.ts:272](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L272)* ___ @@ -1854,7 +1796,7 @@ ___ • **Swap14**: = "SWAP14" -*Defined in [ethereum-types/src/index.ts:272](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L272)* +*Defined in [ethereum-types/src/index.ts:273](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L273)* ___ @@ -1862,7 +1804,7 @@ ___ • **Swap15**: = "SWAP15" -*Defined in [ethereum-types/src/index.ts:273](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L273)* +*Defined in [ethereum-types/src/index.ts:274](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L274)* ___ @@ -1870,7 +1812,7 @@ ___ • **Swap16**: = "SWAP16" -*Defined in [ethereum-types/src/index.ts:274](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L274)* +*Defined in [ethereum-types/src/index.ts:275](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L275)* ___ @@ -1878,7 +1820,7 @@ ___ • **Swap2**: = "SWAP2" -*Defined in [ethereum-types/src/index.ts:260](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L260)* +*Defined in [ethereum-types/src/index.ts:261](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L261)* ___ @@ -1886,7 +1828,7 @@ ___ • **Swap3**: = "SWAP3" -*Defined in [ethereum-types/src/index.ts:261](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L261)* +*Defined in [ethereum-types/src/index.ts:262](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L262)* ___ @@ -1894,7 +1836,7 @@ ___ • **Swap4**: = "SWAP4" -*Defined in [ethereum-types/src/index.ts:262](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L262)* +*Defined in [ethereum-types/src/index.ts:263](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L263)* ___ @@ -1902,7 +1844,7 @@ ___ • **Swap5**: = "SWAP5" -*Defined in [ethereum-types/src/index.ts:263](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L263)* +*Defined in [ethereum-types/src/index.ts:264](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L264)* ___ @@ -1910,7 +1852,7 @@ ___ • **Swap6**: = "SWAP6" -*Defined in [ethereum-types/src/index.ts:264](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L264)* +*Defined in [ethereum-types/src/index.ts:265](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L265)* ___ @@ -1918,7 +1860,7 @@ ___ • **Swap7**: = "SWAP7" -*Defined in [ethereum-types/src/index.ts:265](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L265)* +*Defined in [ethereum-types/src/index.ts:266](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L266)* ___ @@ -1926,7 +1868,7 @@ ___ • **Swap8**: = "SWAP8" -*Defined in [ethereum-types/src/index.ts:266](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L266)* +*Defined in [ethereum-types/src/index.ts:267](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L267)* ___ @@ -1934,7 +1876,7 @@ ___ • **Swap9**: = "SWAP9" -*Defined in [ethereum-types/src/index.ts:267](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L267)* +*Defined in [ethereum-types/src/index.ts:268](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L268)* ___ @@ -1942,7 +1884,7 @@ ___ • **TimeStamp**: = "TimeStamp" -*Defined in [ethereum-types/src/index.ts:191](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L191)* +*Defined in [ethereum-types/src/index.ts:192](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L192)* ___ @@ -1950,7 +1892,7 @@ ___ • **Xor**: = "XOR" -*Defined in [ethereum-types/src/index.ts:167](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L167)* +*Defined in [ethereum-types/src/index.ts:168](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L168)*
@@ -1965,7 +1907,7 @@ ___ • **Ganache**: = "GANACHE" -*Defined in [web3-wrapper/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L91)* +*Defined in [web3-wrapper/src/types.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L91)* ___ @@ -1973,7 +1915,7 @@ ___ • **Geth**: = "GETH" -*Defined in [web3-wrapper/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L90)* +*Defined in [web3-wrapper/src/types.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L90)*
@@ -1986,12 +1928,16 @@ ___ • **TransactionMiningTimeout**: = "TRANSACTION_MINING_TIMEOUT" -*Defined in [web3-wrapper/src/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L2)* +*Defined in [web3-wrapper/src/types.ts:2](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L2)*
+
+ + + # Interface: BlockWithoutTransactionData @@ -2005,7 +1951,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[difficulty](#difficulty)* -*Defined in [ethereum-types/src/index.ts:356](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L356)* +*Defined in [ethereum-types/src/index.ts:357](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L357)* ___ @@ -2015,7 +1961,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[extraData](#extradata)* -*Defined in [ethereum-types/src/index.ts:358](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L358)* +*Defined in [ethereum-types/src/index.ts:359](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L359)* ___ @@ -2025,7 +1971,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasLimit](#gaslimit)* -*Defined in [ethereum-types/src/index.ts:360](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L360)* +*Defined in [ethereum-types/src/index.ts:361](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L361)* ___ @@ -2035,7 +1981,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasUsed](#gasused)* -*Defined in [ethereum-types/src/index.ts:361](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L361)* +*Defined in [ethereum-types/src/index.ts:362](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L362)* ___ @@ -2045,7 +1991,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[hash](#hash)* -*Defined in [ethereum-types/src/index.ts:348](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L348)* +*Defined in [ethereum-types/src/index.ts:349](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L349)* ___ @@ -2055,7 +2001,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[logsBloom](#logsbloom)* -*Defined in [ethereum-types/src/index.ts:352](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L352)* +*Defined in [ethereum-types/src/index.ts:353](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L353)* ___ @@ -2065,7 +2011,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[miner](#miner)* -*Defined in [ethereum-types/src/index.ts:355](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L355)* +*Defined in [ethereum-types/src/index.ts:356](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L356)* ___ @@ -2075,7 +2021,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[nonce](#nonce)* -*Defined in [ethereum-types/src/index.ts:350](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L350)* +*Defined in [ethereum-types/src/index.ts:351](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L351)* ___ @@ -2085,7 +2031,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[number](#number)* -*Defined in [ethereum-types/src/index.ts:347](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L347)* +*Defined in [ethereum-types/src/index.ts:348](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L348)* ___ @@ -2095,7 +2041,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[parentHash](#parenthash)* -*Defined in [ethereum-types/src/index.ts:349](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L349)* +*Defined in [ethereum-types/src/index.ts:350](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L350)* ___ @@ -2105,7 +2051,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[sha3Uncles](#sha3uncles)* -*Defined in [ethereum-types/src/index.ts:351](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L351)* +*Defined in [ethereum-types/src/index.ts:352](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L352)* ___ @@ -2115,7 +2061,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[size](#size)* -*Defined in [ethereum-types/src/index.ts:359](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L359)* +*Defined in [ethereum-types/src/index.ts:360](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L360)* ___ @@ -2125,7 +2071,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[stateRoot](#stateroot)* -*Defined in [ethereum-types/src/index.ts:354](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L354)* +*Defined in [ethereum-types/src/index.ts:355](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L355)* ___ @@ -2135,7 +2081,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[timestamp](#timestamp)* -*Defined in [ethereum-types/src/index.ts:362](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L362)* +*Defined in [ethereum-types/src/index.ts:363](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L363)* ___ @@ -2145,7 +2091,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[totalDifficulty](#totaldifficulty)* -*Defined in [ethereum-types/src/index.ts:357](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L357)* +*Defined in [ethereum-types/src/index.ts:358](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L358)* ___ @@ -2153,7 +2099,7 @@ ___ • **transactions**: *string[]* -*Defined in [ethereum-types/src/index.ts:367](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L367)* +*Defined in [ethereum-types/src/index.ts:368](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L368)* ___ @@ -2163,7 +2109,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[transactionsRoot](#transactionsroot)* -*Defined in [ethereum-types/src/index.ts:353](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L353)* +*Defined in [ethereum-types/src/index.ts:354](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L354)* ___ @@ -2173,7 +2119,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[uncles](#uncles)* -*Defined in [ethereum-types/src/index.ts:363](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L363)* +*Defined in [ethereum-types/src/index.ts:364](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L364)*
@@ -2188,7 +2134,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[difficulty](#difficulty)* -*Defined in [ethereum-types/src/index.ts:356](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L356)* +*Defined in [ethereum-types/src/index.ts:357](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L357)* ___ @@ -2198,7 +2144,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[extraData](#extradata)* -*Defined in [ethereum-types/src/index.ts:358](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L358)* +*Defined in [ethereum-types/src/index.ts:359](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L359)* ___ @@ -2208,7 +2154,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasLimit](#gaslimit)* -*Defined in [ethereum-types/src/index.ts:360](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L360)* +*Defined in [ethereum-types/src/index.ts:361](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L361)* ___ @@ -2218,7 +2164,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[gasUsed](#gasused)* -*Defined in [ethereum-types/src/index.ts:361](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L361)* +*Defined in [ethereum-types/src/index.ts:362](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L362)* ___ @@ -2228,7 +2174,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[hash](#hash)* -*Defined in [ethereum-types/src/index.ts:348](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L348)* +*Defined in [ethereum-types/src/index.ts:349](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L349)* ___ @@ -2238,7 +2184,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[logsBloom](#logsbloom)* -*Defined in [ethereum-types/src/index.ts:352](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L352)* +*Defined in [ethereum-types/src/index.ts:353](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L353)* ___ @@ -2248,7 +2194,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[miner](#miner)* -*Defined in [ethereum-types/src/index.ts:355](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L355)* +*Defined in [ethereum-types/src/index.ts:356](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L356)* ___ @@ -2258,7 +2204,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[nonce](#nonce)* -*Defined in [ethereum-types/src/index.ts:350](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L350)* +*Defined in [ethereum-types/src/index.ts:351](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L351)* ___ @@ -2268,7 +2214,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[number](#number)* -*Defined in [ethereum-types/src/index.ts:347](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L347)* +*Defined in [ethereum-types/src/index.ts:348](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L348)* ___ @@ -2278,7 +2224,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[parentHash](#parenthash)* -*Defined in [ethereum-types/src/index.ts:349](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L349)* +*Defined in [ethereum-types/src/index.ts:350](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L350)* ___ @@ -2288,7 +2234,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[sha3Uncles](#sha3uncles)* -*Defined in [ethereum-types/src/index.ts:351](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L351)* +*Defined in [ethereum-types/src/index.ts:352](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L352)* ___ @@ -2298,7 +2244,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[size](#size)* -*Defined in [ethereum-types/src/index.ts:359](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L359)* +*Defined in [ethereum-types/src/index.ts:360](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L360)* ___ @@ -2308,7 +2254,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[stateRoot](#stateroot)* -*Defined in [ethereum-types/src/index.ts:354](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L354)* +*Defined in [ethereum-types/src/index.ts:355](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L355)* ___ @@ -2318,7 +2264,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[timestamp](#timestamp)* -*Defined in [ethereum-types/src/index.ts:362](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L362)* +*Defined in [ethereum-types/src/index.ts:363](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L363)* ___ @@ -2328,7 +2274,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[totalDifficulty](#totaldifficulty)* -*Defined in [ethereum-types/src/index.ts:357](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L357)* +*Defined in [ethereum-types/src/index.ts:358](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L358)* ___ @@ -2336,7 +2282,7 @@ ___ • **transactions**: *[Transaction](#class-transaction)[]* -*Defined in [ethereum-types/src/index.ts:371](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L371)* +*Defined in [ethereum-types/src/index.ts:372](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L372)* ___ @@ -2346,7 +2292,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[transactionsRoot](#transactionsroot)* -*Defined in [ethereum-types/src/index.ts:353](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L353)* +*Defined in [ethereum-types/src/index.ts:354](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L354)* ___ @@ -2356,7 +2302,7 @@ ___ *Inherited from [AbstractBlock](#interface-abstractblock).[uncles](#uncles)* -*Defined in [ethereum-types/src/index.ts:363](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L363)* +*Defined in [ethereum-types/src/index.ts:364](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L364)*
@@ -2371,7 +2317,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ @@ -2379,7 +2325,7 @@ ___ • **from**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:402](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L402)* +*Defined in [ethereum-types/src/index.ts:403](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L403)* ___ @@ -2389,7 +2335,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* ___ @@ -2399,7 +2345,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ @@ -2409,7 +2355,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ @@ -2419,7 +2365,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ @@ -2429,7 +2375,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)*
@@ -2452,7 +2398,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L103)* +*Defined in [ethereum-types/src/index.ts:103](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L103)* ___ @@ -2460,7 +2406,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L104)* +*Defined in [ethereum-types/src/index.ts:104](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L104)* ___ @@ -2468,7 +2414,7 @@ ___ • **stateMutability**: *[ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L105)* +*Defined in [ethereum-types/src/index.ts:105](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L105)* ___ @@ -2476,7 +2422,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L102)* +*Defined in [ethereum-types/src/index.ts:102](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L102)*
@@ -2495,7 +2441,15 @@ ___ • **components**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)* + +___ + +### `Optional` internalType + +• **internalType**? : *undefined | string* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -2503,7 +2457,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -2511,7 +2465,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -2531,7 +2485,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -2539,7 +2493,7 @@ ___ • **args**: *`A`* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* ___ @@ -2549,7 +2503,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -2559,7 +2513,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -2569,7 +2523,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -2577,7 +2531,7 @@ ___ • **event**: *string* -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L416)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* ___ @@ -2587,7 +2541,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -2597,7 +2551,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -2607,7 +2561,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -2617,7 +2571,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -2636,7 +2590,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -2646,7 +2600,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* ___ @@ -2656,7 +2610,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -2666,7 +2620,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -2676,7 +2630,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -2686,7 +2640,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L416)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* ___ @@ -2696,7 +2650,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -2704,7 +2658,7 @@ ___ • **removed**: *boolean* -*Defined in [ethereum-types/src/index.ts:421](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L421)* +*Defined in [ethereum-types/src/index.ts:422](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L422)* ___ @@ -2714,7 +2668,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -2724,7 +2678,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -2734,7 +2688,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -2749,7 +2703,7 @@ ___ • **isEIP1193**: *boolean* -*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L73)* +*Defined in [ethereum-types/src/index.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L73)* ## Methods @@ -2757,7 +2711,7 @@ ___ ▸ **on**(`event`: [EIP1193Event](#eip1193event), `listener`: function): *this* -*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L75)* +*Defined in [ethereum-types/src/index.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L75)* **Parameters:** @@ -2781,7 +2735,7 @@ ___ ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L74)* +*Defined in [ethereum-types/src/index.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L74)* **Parameters:** @@ -2803,7 +2757,7 @@ Name | Type | • **anonymous**: *boolean* -*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L131)* +*Defined in [ethereum-types/src/index.ts:131](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L131)* ___ @@ -2811,7 +2765,7 @@ ___ • **inputs**: *[EventParameter](#class-eventparameter)[]* -*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L130)* +*Defined in [ethereum-types/src/index.ts:130](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L130)* ___ @@ -2819,7 +2773,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L129)* +*Defined in [ethereum-types/src/index.ts:129](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L129)* ___ @@ -2827,7 +2781,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L128)* +*Defined in [ethereum-types/src/index.ts:128](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L128)*
@@ -2842,7 +2796,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L137)* +*Defined in [ethereum-types/src/index.ts:138](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L138)* ___ @@ -2850,7 +2804,17 @@ ___ • **indexed**: *boolean* -*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L116)* +*Defined in [ethereum-types/src/index.ts:116](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L116)* + +___ + +### `Optional` internalType + +• **internalType**? : *undefined | string* + +*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -2860,7 +2824,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -2870,7 +2834,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -2887,7 +2851,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L112)* +*Defined in [ethereum-types/src/index.ts:112](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L112)* ___ @@ -2895,7 +2859,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L111)* +*Defined in [ethereum-types/src/index.ts:111](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L111)*
@@ -2908,7 +2872,7 @@ ___ • **address**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:409](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L409)* +*Defined in [ethereum-types/src/index.ts:410](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L410)* ___ @@ -2916,7 +2880,7 @@ ___ • **blockHash**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L408)* +*Defined in [ethereum-types/src/index.ts:409](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L409)* ___ @@ -2924,7 +2888,7 @@ ___ • **fromBlock**? : *number | string* -*Defined in [ethereum-types/src/index.ts:406](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L406)* +*Defined in [ethereum-types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L407)* ___ @@ -2932,7 +2896,7 @@ ___ • **toBlock**? : *number | string* -*Defined in [ethereum-types/src/index.ts:407](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L407)* +*Defined in [ethereum-types/src/index.ts:408](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L408)* ___ @@ -2940,7 +2904,7 @@ ___ • **topics**? : *[LogTopic](#logtopic)[]* -*Defined in [ethereum-types/src/index.ts:410](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L410)* +*Defined in [ethereum-types/src/index.ts:411](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L411)*
@@ -2953,7 +2917,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L14)* +*Defined in [ethereum-types/src/index.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L14)* **Parameters:** @@ -2977,7 +2941,7 @@ Name | Type | • **id**: *number* -*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L330)* +*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L331)* ___ @@ -2985,7 +2949,7 @@ ___ • **jsonrpc**: *string* -*Defined in [ethereum-types/src/index.ts:331](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L331)* +*Defined in [ethereum-types/src/index.ts:332](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L332)* ___ @@ -2993,7 +2957,7 @@ ___ • **method**: *string* -*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L329)* +*Defined in [ethereum-types/src/index.ts:330](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L330)* ___ @@ -3001,7 +2965,7 @@ ___ • **params**: *any[]* -*Defined in [ethereum-types/src/index.ts:328](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L328)* +*Defined in [ethereum-types/src/index.ts:329](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L329)*
@@ -3014,7 +2978,7 @@ ___ • **code**: *number* -*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L336)* +*Defined in [ethereum-types/src/index.ts:337](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L337)* ___ @@ -3022,44 +2986,102 @@ ___ • **message**: *string* -*Defined in [ethereum-types/src/index.ts:335](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L335)* +*Defined in [ethereum-types/src/index.ts:336](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L336)*
-# Interface: JSONRPCResponsePayload +# 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. -## Properties -### `Optional` error +## Constructors -• **error**? : *[JSONRPCResponseError](#class-jsonrpcresponseerror)* -*Defined in [ethereum-types/src/index.ts:343](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L343)* -___ +\+ **new AbiDecoder**(`abiArrays`: [AbiDefinition](#abidefinition)[][]): *[AbiDecoder](#class-abidecoder)* -### id +*Defined in [utils/src/abi_decoder.ts:42](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L42)* -• **id**: *number* +Instantiate an AbiDecoder + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`abiArrays` | [AbiDefinition](#abidefinition)[][] | An array of contract ABI's | + +**Returns:** *[AbiDecoder](#class-abidecoder)* + +AbiDecoder instance + +## Methods + +### addABI + +▸ **addABI**(`abiArray`: [AbiDefinition](#abidefinition)[], `contractName?`: undefined | string): *void* + +*Defined in [utils/src/abi_decoder.ts:158](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L158)* + +Adds a set of ABI definitions, after which calldata and logs targeting these ABI's can be decoded. +Additional properties can be included to disambiguate similar ABI's. For example, if two functions +have the same signature but different parameter names, then their ABI definitions can be disambiguated +by specifying a contract name. -*Defined in [ethereum-types/src/index.ts:341](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L341)* +**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* ___ -### jsonrpc +### decodeCalldataOrThrow -• **jsonrpc**: *string* +▸ **decodeCalldataOrThrow**(`calldata`: string, `contractName?`: undefined | string): *`DecodedCalldata`* + +*Defined in [utils/src/abi_decoder.ts:118](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L118)* -*Defined in [ethereum-types/src/index.ts:342](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L342)* +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. ___ -### result +### tryToDecodeLogOrNoop -• **result**: *any* +▸ **tryToDecodeLogOrNoop**<**ArgsType**>(`log`: `LogEntry`): *`LogWithDecodedArgs` | [RawLog](#rawlog)* + +*Defined in [utils/src/abi_decoder.ts:58](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/utils/src/abi_decoder.ts#L58)* + +Attempt to decode a log given the ABI's the AbiDecoder knows about. + +**Type parameters:** + +▪ **ArgsType**: *`DecodedLogArgs`* + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`log` | `LogEntry` | The log to attempt to decode | -*Defined in [ethereum-types/src/index.ts:340](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L340)* +**Returns:** *`LogWithDecodedArgs` | [RawLog](#rawlog)* + +The decoded log if the requisite ABI was available. Otherwise the log unaltered.
@@ -3072,7 +3094,7 @@ ___ • **address**: *string* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -3080,7 +3102,7 @@ ___ • **blockHash**: *string | null* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -3088,7 +3110,7 @@ ___ • **blockNumber**: *number | null* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -3096,7 +3118,7 @@ ___ • **data**: *string* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -3104,7 +3126,7 @@ ___ • **logIndex**: *number | null* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -3112,7 +3134,7 @@ ___ • **topics**: *string[]* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -3120,7 +3142,7 @@ ___ • **transactionHash**: *string* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -3128,7 +3150,7 @@ ___ • **transactionIndex**: *number | null* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -3143,7 +3165,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -3153,7 +3175,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -3163,7 +3185,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -3173,7 +3195,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -3183,7 +3205,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -3191,7 +3213,7 @@ ___ • **removed**: *boolean* -*Defined in [ethereum-types/src/index.ts:425](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L425)* +*Defined in [ethereum-types/src/index.ts:426](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L426)* ___ @@ -3201,7 +3223,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -3211,7 +3233,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -3221,7 +3243,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -3240,7 +3262,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[address](#address)* -*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L434)* +*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L435)* ___ @@ -3250,7 +3272,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[args](#args)* -*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L417)* +*Defined in [ethereum-types/src/index.ts:418](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L418)* ___ @@ -3260,7 +3282,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L432)* +*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L433)* ___ @@ -3270,7 +3292,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:433](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L433)* +*Defined in [ethereum-types/src/index.ts:434](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L434)* ___ @@ -3280,7 +3302,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[data](#data)* -*Defined in [ethereum-types/src/index.ts:435](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L435)* +*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L436)* ___ @@ -3290,7 +3312,7 @@ ___ *Inherited from [DecodedLogEntry](#interface-decodedlogentry).[event](#event)* -*Defined in [ethereum-types/src/index.ts:416](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L416)* +*Defined in [ethereum-types/src/index.ts:417](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L417)* ___ @@ -3300,7 +3322,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[logIndex](#logindex)* -*Defined in [ethereum-types/src/index.ts:429](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L429)* +*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L430)* ___ @@ -3310,7 +3332,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[topics](#topics)* -*Defined in [ethereum-types/src/index.ts:436](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L436)* +*Defined in [ethereum-types/src/index.ts:437](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L437)* ___ @@ -3320,7 +3342,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L431)* +*Defined in [ethereum-types/src/index.ts:432](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L432)* ___ @@ -3330,7 +3352,7 @@ ___ *Inherited from [LogEntry](#interface-logentry).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:430](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L430)* +*Defined in [ethereum-types/src/index.ts:431](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L431)*
@@ -3343,7 +3365,7 @@ ___ • **constant**: *boolean* -*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L94)* +*Defined in [ethereum-types/src/index.ts:94](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L94)* ___ @@ -3351,7 +3373,7 @@ ___ • **inputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L92)* +*Defined in [ethereum-types/src/index.ts:92](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L92)* ___ @@ -3359,7 +3381,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L91)* +*Defined in [ethereum-types/src/index.ts:91](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L91)* ___ @@ -3367,7 +3389,7 @@ ___ • **outputs**: *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L93)* +*Defined in [ethereum-types/src/index.ts:93](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L93)* ___ @@ -3375,7 +3397,7 @@ ___ • **payable**: *boolean* -*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L96)* +*Defined in [ethereum-types/src/index.ts:96](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L96)* ___ @@ -3383,7 +3405,7 @@ ___ • **stateMutability**: *[StateMutability](#statemutability)* -*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L95)* +*Defined in [ethereum-types/src/index.ts:95](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L95)* ___ @@ -3391,7 +3413,7 @@ ___ • **type**: *string* -*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L90)* +*Defined in [ethereum-types/src/index.ts:90](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L90)*
@@ -3408,7 +3430,7 @@ ___ • **address**: *string* -*Defined in [ethereum-types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L491)* +*Defined in [ethereum-types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L492)* ___ @@ -3416,7 +3438,7 @@ ___ • **blockHash**: *string | null* -*Defined in [ethereum-types/src/index.ts:489](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L489)* +*Defined in [ethereum-types/src/index.ts:490](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L490)* ___ @@ -3424,7 +3446,7 @@ ___ • **blockNumber**: *string | null* -*Defined in [ethereum-types/src/index.ts:490](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L490)* +*Defined in [ethereum-types/src/index.ts:491](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L491)* ___ @@ -3432,7 +3454,7 @@ ___ • **data**: *string* -*Defined in [ethereum-types/src/index.ts:492](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L492)* +*Defined in [ethereum-types/src/index.ts:493](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L493)* ___ @@ -3440,7 +3462,7 @@ ___ • **logIndex**: *string | null* -*Defined in [ethereum-types/src/index.ts:486](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L486)* +*Defined in [ethereum-types/src/index.ts:487](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L487)* ___ @@ -3448,7 +3470,7 @@ ___ • **topics**: *string[]* -*Defined in [ethereum-types/src/index.ts:493](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L493)* +*Defined in [ethereum-types/src/index.ts:494](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L494)* ___ @@ -3456,7 +3478,7 @@ ___ • **transactionHash**: *string* -*Defined in [ethereum-types/src/index.ts:488](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L488)* +*Defined in [ethereum-types/src/index.ts:489](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L489)* ___ @@ -3464,7 +3486,7 @@ ___ • **transactionIndex**: *string | null* -*Defined in [ethereum-types/src/index.ts:487](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L487)* +*Defined in [ethereum-types/src/index.ts:488](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L488)*
@@ -3477,7 +3499,7 @@ ___ • **arguments**? : *[DataItem](#class-dataitem)[]* -*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L122)* +*Defined in [ethereum-types/src/index.ts:122](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L122)* ___ @@ -3485,7 +3507,7 @@ ___ • **name**: *string* -*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L121)* +*Defined in [ethereum-types/src/index.ts:121](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L121)* ___ @@ -3493,7 +3515,7 @@ ___ • **type**: *"error"* -*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L120)* +*Defined in [ethereum-types/src/index.ts:120](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L120)*
@@ -3516,7 +3538,7 @@ ___ • **depth**: *number* -*Defined in [ethereum-types/src/index.ts:293](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L293)* +*Defined in [ethereum-types/src/index.ts:294](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L294)* ___ @@ -3524,7 +3546,7 @@ ___ • **error**: *string* -*Defined in [ethereum-types/src/index.ts:294](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L294)* +*Defined in [ethereum-types/src/index.ts:295](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L295)* ___ @@ -3532,7 +3554,7 @@ ___ • **gas**: *number* -*Defined in [ethereum-types/src/index.ts:295](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L295)* +*Defined in [ethereum-types/src/index.ts:296](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L296)* ___ @@ -3540,7 +3562,7 @@ ___ • **gasCost**: *number* -*Defined in [ethereum-types/src/index.ts:296](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L296)* +*Defined in [ethereum-types/src/index.ts:297](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L297)* ___ @@ -3548,7 +3570,7 @@ ___ • **memory**: *string[]* -*Defined in [ethereum-types/src/index.ts:297](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L297)* +*Defined in [ethereum-types/src/index.ts:298](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L298)* ___ @@ -3556,7 +3578,7 @@ ___ • **op**: *[OpCode](#enumeration-opcode)* -*Defined in [ethereum-types/src/index.ts:298](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L298)* +*Defined in [ethereum-types/src/index.ts:299](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L299)* ___ @@ -3564,7 +3586,7 @@ ___ • **pc**: *number* -*Defined in [ethereum-types/src/index.ts:299](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L299)* +*Defined in [ethereum-types/src/index.ts:300](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L300)* ___ @@ -3572,7 +3594,7 @@ ___ • **stack**: *string[]* -*Defined in [ethereum-types/src/index.ts:300](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L300)* +*Defined in [ethereum-types/src/index.ts:301](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L301)* ___ @@ -3580,7 +3602,7 @@ ___ • **storage**: *object* -*Defined in [ethereum-types/src/index.ts:301](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L301)* +*Defined in [ethereum-types/src/index.ts:302](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L302)* #### Type declaration: @@ -3597,7 +3619,7 @@ ___ • **disableMemory**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:518](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L518)* +*Defined in [ethereum-types/src/index.ts:519](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L519)* ___ @@ -3605,7 +3627,7 @@ ___ • **disableStack**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:519](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L519)* +*Defined in [ethereum-types/src/index.ts:520](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L520)* ___ @@ -3613,7 +3635,7 @@ ___ • **disableStorage**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:520](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L520)* +*Defined in [ethereum-types/src/index.ts:521](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L521)* ___ @@ -3621,7 +3643,7 @@ ___ • **timeout**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:522](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L522)* +*Defined in [ethereum-types/src/index.ts:523](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L523)* ___ @@ -3629,7 +3651,7 @@ ___ • **tracer**? : *undefined | string* -*Defined in [ethereum-types/src/index.ts:521](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L521)* +*Defined in [ethereum-types/src/index.ts:522](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L522)*
@@ -3642,7 +3664,7 @@ ___ • **blockHash**: *string | null* -*Defined in [ethereum-types/src/index.ts:377](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L377)* +*Defined in [ethereum-types/src/index.ts:378](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L378)* ___ @@ -3650,7 +3672,7 @@ ___ • **blockNumber**: *number | null* -*Defined in [ethereum-types/src/index.ts:378](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L378)* +*Defined in [ethereum-types/src/index.ts:379](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L379)* ___ @@ -3658,7 +3680,7 @@ ___ • **from**: *string* -*Defined in [ethereum-types/src/index.ts:380](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L380)* +*Defined in [ethereum-types/src/index.ts:381](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L381)* ___ @@ -3666,7 +3688,7 @@ ___ • **gas**: *number* -*Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L384)* +*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L385)* ___ @@ -3674,7 +3696,7 @@ ___ • **gasPrice**: *`BigNumber`* -*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L383)* +*Defined in [ethereum-types/src/index.ts:384](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L384)* ___ @@ -3682,7 +3704,7 @@ ___ • **hash**: *string* -*Defined in [ethereum-types/src/index.ts:375](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L375)* +*Defined in [ethereum-types/src/index.ts:376](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L376)* ___ @@ -3690,7 +3712,7 @@ ___ • **input**: *string* -*Defined in [ethereum-types/src/index.ts:385](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L385)* +*Defined in [ethereum-types/src/index.ts:386](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L386)* ___ @@ -3698,7 +3720,7 @@ ___ • **nonce**: *number* -*Defined in [ethereum-types/src/index.ts:376](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L376)* +*Defined in [ethereum-types/src/index.ts:377](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L377)* ___ @@ -3706,7 +3728,7 @@ ___ • **to**: *string | null* -*Defined in [ethereum-types/src/index.ts:381](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L381)* +*Defined in [ethereum-types/src/index.ts:382](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L382)* ___ @@ -3714,7 +3736,7 @@ ___ • **transactionIndex**: *number | null* -*Defined in [ethereum-types/src/index.ts:379](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L379)* +*Defined in [ethereum-types/src/index.ts:380](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L380)* ___ @@ -3722,7 +3744,7 @@ ___ • **value**: *`BigNumber`* -*Defined in [ethereum-types/src/index.ts:382](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L382)* +*Defined in [ethereum-types/src/index.ts:383](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L383)*
@@ -3735,7 +3757,7 @@ ___ • **blockHash**: *string* -*Defined in [ethereum-types/src/index.ts:448](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L448)* +*Defined in [ethereum-types/src/index.ts:449](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L449)* ___ @@ -3743,7 +3765,7 @@ ___ • **blockNumber**: *number* -*Defined in [ethereum-types/src/index.ts:449](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L449)* +*Defined in [ethereum-types/src/index.ts:450](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L450)* ___ @@ -3751,7 +3773,7 @@ ___ • **contractAddress**: *string | null* -*Defined in [ethereum-types/src/index.ts:457](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L457)* +*Defined in [ethereum-types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L458)* ___ @@ -3759,7 +3781,7 @@ ___ • **cumulativeGasUsed**: *number* -*Defined in [ethereum-types/src/index.ts:455](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L455)* +*Defined in [ethereum-types/src/index.ts:456](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L456)* ___ @@ -3767,7 +3789,7 @@ ___ • **from**: *string* -*Defined in [ethereum-types/src/index.ts:452](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L452)* +*Defined in [ethereum-types/src/index.ts:453](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L453)* ___ @@ -3775,7 +3797,7 @@ ___ • **gasUsed**: *number* -*Defined in [ethereum-types/src/index.ts:456](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L456)* +*Defined in [ethereum-types/src/index.ts:457](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L457)* ___ @@ -3783,7 +3805,7 @@ ___ • **logs**: *[LogEntry](#class-logentry)[]* -*Defined in [ethereum-types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L458)* +*Defined in [ethereum-types/src/index.ts:459](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L459)* ___ @@ -3791,7 +3813,7 @@ ___ • **status**: *[TransactionReceiptStatus](#transactionreceiptstatus)* -*Defined in [ethereum-types/src/index.ts:454](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L454)* +*Defined in [ethereum-types/src/index.ts:455](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L455)* ___ @@ -3799,7 +3821,7 @@ ___ • **to**: *string* -*Defined in [ethereum-types/src/index.ts:453](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L453)* +*Defined in [ethereum-types/src/index.ts:454](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L454)* ___ @@ -3807,7 +3829,7 @@ ___ • **transactionHash**: *string* -*Defined in [ethereum-types/src/index.ts:450](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L450)* +*Defined in [ethereum-types/src/index.ts:451](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L451)* ___ @@ -3815,7 +3837,7 @@ ___ • **transactionIndex**: *number* -*Defined in [ethereum-types/src/index.ts:451](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L451)* +*Defined in [ethereum-types/src/index.ts:452](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L452)*
@@ -3834,7 +3856,7 @@ otherwise we don't. *Inherited from [TransactionReceipt](#interface-transactionreceipt).[blockHash](#blockhash)* -*Defined in [ethereum-types/src/index.ts:448](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L448)* +*Defined in [ethereum-types/src/index.ts:449](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L449)* ___ @@ -3844,7 +3866,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[blockNumber](#blocknumber)* -*Defined in [ethereum-types/src/index.ts:449](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L449)* +*Defined in [ethereum-types/src/index.ts:450](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L450)* ___ @@ -3854,7 +3876,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[contractAddress](#contractaddress)* -*Defined in [ethereum-types/src/index.ts:457](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L457)* +*Defined in [ethereum-types/src/index.ts:458](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L458)* ___ @@ -3864,7 +3886,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[cumulativeGasUsed](#cumulativegasused)* -*Defined in [ethereum-types/src/index.ts:455](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L455)* +*Defined in [ethereum-types/src/index.ts:456](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L456)* ___ @@ -3874,7 +3896,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[from](#from)* -*Defined in [ethereum-types/src/index.ts:452](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L452)* +*Defined in [ethereum-types/src/index.ts:453](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L453)* ___ @@ -3884,7 +3906,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[gasUsed](#gasused)* -*Defined in [ethereum-types/src/index.ts:456](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L456)* +*Defined in [ethereum-types/src/index.ts:457](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L457)* ___ @@ -3894,7 +3916,7 @@ ___ *Overrides [TransactionReceipt](_ethereum_types_src_index_.transactionreceipt.md).[logs](#logs)* -*Defined in [ethereum-types/src/index.ts:514](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L514)* +*Defined in [ethereum-types/src/index.ts:515](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L515)* ___ @@ -3904,7 +3926,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[status](#status)* -*Defined in [ethereum-types/src/index.ts:454](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L454)* +*Defined in [ethereum-types/src/index.ts:455](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L455)* ___ @@ -3914,7 +3936,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[to](#to)* -*Defined in [ethereum-types/src/index.ts:453](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L453)* +*Defined in [ethereum-types/src/index.ts:454](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L454)* ___ @@ -3924,7 +3946,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[transactionHash](#transactionhash)* -*Defined in [ethereum-types/src/index.ts:450](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L450)* +*Defined in [ethereum-types/src/index.ts:451](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L451)* ___ @@ -3934,7 +3956,7 @@ ___ *Inherited from [TransactionReceipt](#interface-transactionreceipt).[transactionIndex](#transactionindex)* -*Defined in [ethereum-types/src/index.ts:451](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L451)* +*Defined in [ethereum-types/src/index.ts:452](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L452)*
@@ -3947,7 +3969,7 @@ ___ • **gas**: *number* -*Defined in [ethereum-types/src/index.ts:305](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L305)* +*Defined in [ethereum-types/src/index.ts:306](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L306)* ___ @@ -3955,7 +3977,7 @@ ___ • **returnValue**: *any* -*Defined in [ethereum-types/src/index.ts:306](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L306)* +*Defined in [ethereum-types/src/index.ts:307](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L307)* ___ @@ -3963,7 +3985,7 @@ ___ • **structLogs**: *[StructLog](#class-structlog)[]* -*Defined in [ethereum-types/src/index.ts:307](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L307)* +*Defined in [ethereum-types/src/index.ts:308](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L308)*
@@ -3978,7 +4000,17 @@ ___ *Overrides [DataItem](_ethereum_types_src_index_.dataitem.md).[components](#optional-components)* -*Defined in [ethereum-types/src/index.ts:141](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L141)* +*Defined in [ethereum-types/src/index.ts:142](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L142)* + +___ + +### `Optional` internalType + +• **internalType**? : *undefined | string* + +*Inherited from [DataItem](#interface-dataitem).[internalType](#optional-internaltype)* + +*Defined in [ethereum-types/src/index.ts:137](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L137)* ___ @@ -3988,7 +4020,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[name](#name)* -*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L135)* +*Defined in [ethereum-types/src/index.ts:135](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L135)* ___ @@ -3998,7 +4030,7 @@ ___ *Inherited from [DataItem](#interface-dataitem).[type](#type)* -*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L136)* +*Defined in [ethereum-types/src/index.ts:136](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L136)*
@@ -4013,7 +4045,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ @@ -4021,7 +4053,7 @@ ___ • **from**: *string* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L398)* +*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* ___ @@ -4031,7 +4063,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* ___ @@ -4041,7 +4073,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ @@ -4051,7 +4083,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ @@ -4061,7 +4093,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ @@ -4071,7 +4103,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L390)* +*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L391)*
@@ -4086,7 +4118,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[data](#optional-data)* -*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L393)* +*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L394)* ___ @@ -4096,7 +4128,7 @@ ___ *Inherited from [TxData](#interface-txdata).[from](#from)* -*Defined in [ethereum-types/src/index.ts:398](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L398)* +*Defined in [ethereum-types/src/index.ts:399](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L399)* ___ @@ -4106,7 +4138,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gas](#optional-gas)* -*Defined in [ethereum-types/src/index.ts:391](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L391)* +*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L392)* ___ @@ -4116,7 +4148,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[gasPrice](#optional-gasprice)* -*Defined in [ethereum-types/src/index.ts:392](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L392)* +*Defined in [ethereum-types/src/index.ts:393](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L393)* ___ @@ -4126,7 +4158,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[nonce](#optional-nonce)* -*Defined in [ethereum-types/src/index.ts:394](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L394)* +*Defined in [ethereum-types/src/index.ts:395](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L395)* ___ @@ -4136,7 +4168,7 @@ ___ *Inherited from [CallTxDataBase](#interface-calltxdatabase).[to](#optional-to)* -*Defined in [ethereum-types/src/index.ts:389](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L389)* +*Defined in [ethereum-types/src/index.ts:390](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L390)* ___ @@ -4146,7 +4178,7 @@ ___ *Overrides [CallTxDataBase](_ethereum_types_src_index_.calltxdatabase.md).[value](#optional-value)* -*Defined in [ethereum-types/src/index.ts:442](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L442)* +*Defined in [ethereum-types/src/index.ts:443](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L443)*
@@ -4163,7 +4195,7 @@ This interface allowed sending synchonous requests, support for which was later ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md)): *[JSONRPCResponsePayload](#class-jsonrpcresponsepayload)* -*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L45)* +*Defined in [ethereum-types/src/index.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L45)* **Parameters:** @@ -4179,7 +4211,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L44)* +*Defined in [ethereum-types/src/index.ts:44](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L44)* **Parameters:** @@ -4205,7 +4237,7 @@ before the first attempts to conform to EIP1193 ▸ **send**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L54)* +*Defined in [ethereum-types/src/index.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L54)* **Parameters:** @@ -4231,7 +4263,7 @@ however it does not conform entirely. ▸ **send**(`method`: string, `params?`: any[]): *`Promise`* -*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L63)* +*Defined in [ethereum-types/src/index.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L63)* **Parameters:** @@ -4257,7 +4289,7 @@ add here • **isMetaMask**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L31)* +*Defined in [ethereum-types/src/index.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L31)* ___ @@ -4265,7 +4297,7 @@ ___ • **isParity**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L32)* +*Defined in [ethereum-types/src/index.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L32)* ___ @@ -4273,7 +4305,7 @@ ___ • **isZeroExProvider**? : *undefined | false | true* -*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L30)* +*Defined in [ethereum-types/src/index.ts:30](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L30)* ## Methods @@ -4281,7 +4313,7 @@ ___ ▸ **enable**(): *`Promise`* -*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L34)* +*Defined in [ethereum-types/src/index.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L34)* **Returns:** *`Promise`* @@ -4291,7 +4323,7 @@ ___ ▸ **sendAsync**(`payload`: [JSONRPCRequestPayload](_ethereum_types_src_index_.jsonrpcrequestpayload.md), `callback`: [JSONRPCErrorCallback](#jsonrpcerrorcallback)): *void* -*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L35)* +*Defined in [ethereum-types/src/index.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L35)* **Parameters:** @@ -4308,7 +4340,7 @@ ___ ▸ **stop**(): *void* -*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L33)* +*Defined in [ethereum-types/src/index.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L33)* **Returns:** *void* @@ -4327,7 +4359,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[difficulty](#difficulty)* -*Defined in [web3-wrapper/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L15)* +*Defined in [web3-wrapper/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L15)* ___ @@ -4337,7 +4369,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[extraData](#extradata)* -*Defined in [web3-wrapper/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L17)* +*Defined in [web3-wrapper/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L17)* ___ @@ -4347,7 +4379,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[gasLimit](#gaslimit)* -*Defined in [web3-wrapper/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L19)* +*Defined in [web3-wrapper/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L19)* ___ @@ -4357,7 +4389,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[gasUsed](#gasused)* -*Defined in [web3-wrapper/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L20)* +*Defined in [web3-wrapper/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L20)* ___ @@ -4367,7 +4399,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[hash](#hash)* -*Defined in [web3-wrapper/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L7)* +*Defined in [web3-wrapper/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L7)* ___ @@ -4377,7 +4409,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[logsBloom](#logsbloom)* -*Defined in [web3-wrapper/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L11)* +*Defined in [web3-wrapper/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L11)* ___ @@ -4387,7 +4419,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[miner](#miner)* -*Defined in [web3-wrapper/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L14)* +*Defined in [web3-wrapper/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L14)* ___ @@ -4397,7 +4429,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[nonce](#nonce)* -*Defined in [web3-wrapper/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L9)* +*Defined in [web3-wrapper/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L9)* ___ @@ -4407,7 +4439,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[number](#number)* -*Defined in [web3-wrapper/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L6)* +*Defined in [web3-wrapper/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L6)* ___ @@ -4417,7 +4449,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[parentHash](#parenthash)* -*Defined in [web3-wrapper/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L8)* +*Defined in [web3-wrapper/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L8)* ___ @@ -4427,7 +4459,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[sha3Uncles](#sha3uncles)* -*Defined in [web3-wrapper/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L10)* +*Defined in [web3-wrapper/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L10)* ___ @@ -4437,7 +4469,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[size](#size)* -*Defined in [web3-wrapper/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L18)* +*Defined in [web3-wrapper/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L18)* ___ @@ -4447,7 +4479,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[stateRoot](#stateroot)* -*Defined in [web3-wrapper/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L13)* +*Defined in [web3-wrapper/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L13)* ___ @@ -4457,7 +4489,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[timestamp](#timestamp)* -*Defined in [web3-wrapper/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L21)* +*Defined in [web3-wrapper/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L21)* ___ @@ -4467,7 +4499,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[totalDifficulty](#totaldifficulty)* -*Defined in [web3-wrapper/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L16)* +*Defined in [web3-wrapper/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L16)* ___ @@ -4475,7 +4507,7 @@ ___ • **transactions**: *string[]* -*Defined in [web3-wrapper/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L25)* +*Defined in [web3-wrapper/src/types.ts:25](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L25)* ___ @@ -4485,7 +4517,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[transactionsRoot](#transactionsroot)* -*Defined in [web3-wrapper/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L12)* +*Defined in [web3-wrapper/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L12)* ___ @@ -4495,7 +4527,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[uncles](#uncles)* -*Defined in [web3-wrapper/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L22)* +*Defined in [web3-wrapper/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L22)*
@@ -4510,7 +4542,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[difficulty](#difficulty)* -*Defined in [web3-wrapper/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L15)* +*Defined in [web3-wrapper/src/types.ts:15](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L15)* ___ @@ -4520,7 +4552,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[extraData](#extradata)* -*Defined in [web3-wrapper/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L17)* +*Defined in [web3-wrapper/src/types.ts:17](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L17)* ___ @@ -4530,7 +4562,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[gasLimit](#gaslimit)* -*Defined in [web3-wrapper/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L19)* +*Defined in [web3-wrapper/src/types.ts:19](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L19)* ___ @@ -4540,7 +4572,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[gasUsed](#gasused)* -*Defined in [web3-wrapper/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L20)* +*Defined in [web3-wrapper/src/types.ts:20](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L20)* ___ @@ -4550,7 +4582,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[hash](#hash)* -*Defined in [web3-wrapper/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L7)* +*Defined in [web3-wrapper/src/types.ts:7](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L7)* ___ @@ -4560,7 +4592,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[logsBloom](#logsbloom)* -*Defined in [web3-wrapper/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L11)* +*Defined in [web3-wrapper/src/types.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L11)* ___ @@ -4570,7 +4602,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[miner](#miner)* -*Defined in [web3-wrapper/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L14)* +*Defined in [web3-wrapper/src/types.ts:14](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L14)* ___ @@ -4580,7 +4612,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[nonce](#nonce)* -*Defined in [web3-wrapper/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L9)* +*Defined in [web3-wrapper/src/types.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L9)* ___ @@ -4590,7 +4622,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[number](#number)* -*Defined in [web3-wrapper/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L6)* +*Defined in [web3-wrapper/src/types.ts:6](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L6)* ___ @@ -4600,7 +4632,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[parentHash](#parenthash)* -*Defined in [web3-wrapper/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L8)* +*Defined in [web3-wrapper/src/types.ts:8](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L8)* ___ @@ -4610,7 +4642,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[sha3Uncles](#sha3uncles)* -*Defined in [web3-wrapper/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L10)* +*Defined in [web3-wrapper/src/types.ts:10](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L10)* ___ @@ -4620,7 +4652,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[size](#size)* -*Defined in [web3-wrapper/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L18)* +*Defined in [web3-wrapper/src/types.ts:18](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L18)* ___ @@ -4630,7 +4662,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[stateRoot](#stateroot)* -*Defined in [web3-wrapper/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L13)* +*Defined in [web3-wrapper/src/types.ts:13](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L13)* ___ @@ -4640,7 +4672,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[timestamp](#timestamp)* -*Defined in [web3-wrapper/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L21)* +*Defined in [web3-wrapper/src/types.ts:21](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L21)* ___ @@ -4650,7 +4682,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[totalDifficulty](#totaldifficulty)* -*Defined in [web3-wrapper/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L16)* +*Defined in [web3-wrapper/src/types.ts:16](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L16)* ___ @@ -4658,7 +4690,7 @@ ___ • **transactions**: *[TransactionRPC](#class-transactionrpc)[]* -*Defined in [web3-wrapper/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L28)* +*Defined in [web3-wrapper/src/types.ts:28](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L28)* ___ @@ -4668,7 +4700,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[transactionsRoot](#transactionsroot)* -*Defined in [web3-wrapper/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L12)* +*Defined in [web3-wrapper/src/types.ts:12](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L12)* ___ @@ -4678,7 +4710,7 @@ ___ *Inherited from [AbstractBlockRPC](#interface-abstractblockrpc).[uncles](#uncles)* -*Defined in [web3-wrapper/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L22)* +*Defined in [web3-wrapper/src/types.ts:22](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L22)*
@@ -4693,7 +4725,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[data](#optional-data)* -*Defined in [web3-wrapper/src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L76)* +*Defined in [web3-wrapper/src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L76)* ___ @@ -4701,7 +4733,7 @@ ___ • **from**? : *undefined | string* -*Defined in [web3-wrapper/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L85)* +*Defined in [web3-wrapper/src/types.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L85)* ___ @@ -4711,7 +4743,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[gas](#optional-gas)* -*Defined in [web3-wrapper/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L74)* +*Defined in [web3-wrapper/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L74)* ___ @@ -4721,7 +4753,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[gasPrice](#optional-gasprice)* -*Defined in [web3-wrapper/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L75)* +*Defined in [web3-wrapper/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L75)* ___ @@ -4731,7 +4763,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[nonce](#optional-nonce)* -*Defined in [web3-wrapper/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L77)* +*Defined in [web3-wrapper/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L77)* ___ @@ -4741,7 +4773,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[to](#optional-to)* -*Defined in [web3-wrapper/src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L72)* +*Defined in [web3-wrapper/src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L72)* ___ @@ -4751,7 +4783,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[value](#optional-value)* -*Defined in [web3-wrapper/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L73)* +*Defined in [web3-wrapper/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L73)*
@@ -4766,7 +4798,7 @@ ___ • **address**: *string* -*Defined in [web3-wrapper/src/types.ts:64](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L64)* +*Defined in [web3-wrapper/src/types.ts:64](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L64)* ___ @@ -4774,7 +4806,7 @@ ___ • **blockHash**: *string | null* -*Defined in [web3-wrapper/src/types.ts:62](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L62)* +*Defined in [web3-wrapper/src/types.ts:62](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L62)* ___ @@ -4782,7 +4814,7 @@ ___ • **blockNumber**: *string | null* -*Defined in [web3-wrapper/src/types.ts:63](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L63)* +*Defined in [web3-wrapper/src/types.ts:63](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L63)* ___ @@ -4790,7 +4822,7 @@ ___ • **data**: *string* -*Defined in [web3-wrapper/src/types.ts:65](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L65)* +*Defined in [web3-wrapper/src/types.ts:65](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L65)* ___ @@ -4798,7 +4830,7 @@ ___ • **logIndex**: *string | null* -*Defined in [web3-wrapper/src/types.ts:59](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L59)* +*Defined in [web3-wrapper/src/types.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L59)* ___ @@ -4806,7 +4838,7 @@ ___ • **topics**: *string[]* -*Defined in [web3-wrapper/src/types.ts:66](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L66)* +*Defined in [web3-wrapper/src/types.ts:66](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L66)* ___ @@ -4814,7 +4846,7 @@ ___ • **transactionHash**: *string* -*Defined in [web3-wrapper/src/types.ts:61](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L61)* +*Defined in [web3-wrapper/src/types.ts:61](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L61)* ___ @@ -4822,7 +4854,7 @@ ___ • **transactionIndex**: *string | null* -*Defined in [web3-wrapper/src/types.ts:60](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L60)* +*Defined in [web3-wrapper/src/types.ts:60](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L60)*
@@ -4835,7 +4867,7 @@ ___ • **blockHash**: *string* -*Defined in [web3-wrapper/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L45)* +*Defined in [web3-wrapper/src/types.ts:45](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L45)* ___ @@ -4843,7 +4875,7 @@ ___ • **blockNumber**: *string* -*Defined in [web3-wrapper/src/types.ts:46](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L46)* +*Defined in [web3-wrapper/src/types.ts:46](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L46)* ___ @@ -4851,7 +4883,7 @@ ___ • **contractAddress**: *string | null* -*Defined in [web3-wrapper/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L54)* +*Defined in [web3-wrapper/src/types.ts:54](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L54)* ___ @@ -4859,7 +4891,7 @@ ___ • **cumulativeGasUsed**: *string* -*Defined in [web3-wrapper/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L52)* +*Defined in [web3-wrapper/src/types.ts:52](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L52)* ___ @@ -4867,7 +4899,7 @@ ___ • **from**: *string* -*Defined in [web3-wrapper/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L49)* +*Defined in [web3-wrapper/src/types.ts:49](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L49)* ___ @@ -4875,7 +4907,7 @@ ___ • **gasUsed**: *string* -*Defined in [web3-wrapper/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L53)* +*Defined in [web3-wrapper/src/types.ts:53](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L53)* ___ @@ -4883,7 +4915,7 @@ ___ • **logs**: *[LogEntryRPC](#class-logentryrpc)[]* -*Defined in [web3-wrapper/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L55)* +*Defined in [web3-wrapper/src/types.ts:55](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L55)* ___ @@ -4891,7 +4923,7 @@ ___ • **status**: *[TransactionReceiptStatusRPC](#transactionreceiptstatusrpc)* -*Defined in [web3-wrapper/src/types.ts:51](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L51)* +*Defined in [web3-wrapper/src/types.ts:51](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L51)* ___ @@ -4899,7 +4931,7 @@ ___ • **to**: *string* -*Defined in [web3-wrapper/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L50)* +*Defined in [web3-wrapper/src/types.ts:50](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L50)* ___ @@ -4907,7 +4939,7 @@ ___ • **transactionHash**: *string* -*Defined in [web3-wrapper/src/types.ts:47](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L47)* +*Defined in [web3-wrapper/src/types.ts:47](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L47)* ___ @@ -4915,7 +4947,7 @@ ___ • **transactionIndex**: *string* -*Defined in [web3-wrapper/src/types.ts:48](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L48)* +*Defined in [web3-wrapper/src/types.ts:48](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L48)*
@@ -4928,7 +4960,7 @@ ___ • **blockHash**: *string | null* -*Defined in [web3-wrapper/src/types.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L33)* +*Defined in [web3-wrapper/src/types.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L33)* ___ @@ -4936,7 +4968,7 @@ ___ • **blockNumber**: *string | null* -*Defined in [web3-wrapper/src/types.ts:34](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L34)* +*Defined in [web3-wrapper/src/types.ts:34](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L34)* ___ @@ -4944,7 +4976,7 @@ ___ • **from**: *string* -*Defined in [web3-wrapper/src/types.ts:36](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L36)* +*Defined in [web3-wrapper/src/types.ts:36](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L36)* ___ @@ -4952,7 +4984,7 @@ ___ • **gas**: *string* -*Defined in [web3-wrapper/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L40)* +*Defined in [web3-wrapper/src/types.ts:40](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L40)* ___ @@ -4960,7 +4992,7 @@ ___ • **gasPrice**: *string* -*Defined in [web3-wrapper/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L39)* +*Defined in [web3-wrapper/src/types.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L39)* ___ @@ -4968,7 +5000,7 @@ ___ • **hash**: *string* -*Defined in [web3-wrapper/src/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L31)* +*Defined in [web3-wrapper/src/types.ts:31](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L31)* ___ @@ -4976,7 +5008,7 @@ ___ • **input**: *string* -*Defined in [web3-wrapper/src/types.ts:41](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L41)* +*Defined in [web3-wrapper/src/types.ts:41](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L41)* ___ @@ -4984,7 +5016,7 @@ ___ • **nonce**: *string* -*Defined in [web3-wrapper/src/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L32)* +*Defined in [web3-wrapper/src/types.ts:32](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L32)* ___ @@ -4992,7 +5024,7 @@ ___ • **to**: *string | null* -*Defined in [web3-wrapper/src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L37)* +*Defined in [web3-wrapper/src/types.ts:37](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L37)* ___ @@ -5000,7 +5032,7 @@ ___ • **transactionIndex**: *string | null* -*Defined in [web3-wrapper/src/types.ts:35](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L35)* +*Defined in [web3-wrapper/src/types.ts:35](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L35)* ___ @@ -5008,7 +5040,7 @@ ___ • **value**: *string* -*Defined in [web3-wrapper/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L38)* +*Defined in [web3-wrapper/src/types.ts:38](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L38)*
@@ -5023,7 +5055,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[data](#optional-data)* -*Defined in [web3-wrapper/src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L76)* +*Defined in [web3-wrapper/src/types.ts:76](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L76)* ___ @@ -5031,7 +5063,7 @@ ___ • **from**: *string* -*Defined in [web3-wrapper/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L81)* +*Defined in [web3-wrapper/src/types.ts:81](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L81)* ___ @@ -5041,7 +5073,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[gas](#optional-gas)* -*Defined in [web3-wrapper/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L74)* +*Defined in [web3-wrapper/src/types.ts:74](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L74)* ___ @@ -5051,7 +5083,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[gasPrice](#optional-gasprice)* -*Defined in [web3-wrapper/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L75)* +*Defined in [web3-wrapper/src/types.ts:75](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L75)* ___ @@ -5061,7 +5093,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[nonce](#optional-nonce)* -*Defined in [web3-wrapper/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L77)* +*Defined in [web3-wrapper/src/types.ts:77](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L77)* ___ @@ -5071,7 +5103,7 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[to](#optional-to)* -*Defined in [web3-wrapper/src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L72)* +*Defined in [web3-wrapper/src/types.ts:72](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L72)* ___ @@ -5081,7 +5113,20 @@ ___ *Inherited from [CallTxDataBaseRPC](#interface-calltxdatabaserpc).[value](#optional-value)* -*Defined in [web3-wrapper/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L73)* +*Defined in [web3-wrapper/src/types.ts:73](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L73)* + +
+ + + + +## Type aliases + +### TransactionReceiptStatusRPC + +Ƭ **TransactionReceiptStatusRPC**: *null | string | `0` | `1`* + +*Defined in [web3-wrapper/src/types.ts:69](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/types.ts#L69)*
@@ -5094,7 +5139,7 @@ ___ Ƭ **AbiDefinition**: *[FunctionAbi](_ethereum_types_src_index_.md#functionabi) | [EventAbi](#interface-eventabi) | [RevertErrorAbi](#interface-reverterrorabi)* -*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L80)* +*Defined in [ethereum-types/src/index.ts:80](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L80)* ___ @@ -5102,7 +5147,7 @@ ___ Ƭ **BlockParam**: *[BlockParamLiteral](#enumeration-blockparamliteral) | number* -*Defined in [ethereum-types/src/index.ts:483](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L483)* +*Defined in [ethereum-types/src/index.ts:484](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L484)* ___ @@ -5110,7 +5155,7 @@ ___ Ƭ **ConstructorStateMutability**: *"nonpayable" | "payable"* -*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L84)* +*Defined in [ethereum-types/src/index.ts:84](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L84)* ___ @@ -5120,7 +5165,7 @@ ___ Ƭ **ContractEventArg**: *any* -*Defined in [ethereum-types/src/index.ts:468](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L468)* +*Defined in [ethereum-types/src/index.ts:469](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L469)* ___ @@ -5130,7 +5175,7 @@ ___ Ƭ **EIP1193Event**: *"accountsChanged" | "networkChanged" | "close" | "connect" | "notification"* -*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L70)* +*Defined in [ethereum-types/src/index.ts:70](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L70)* Interface for providers that conform to EIP 1193 Source: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md @@ -5145,7 +5190,7 @@ ___ Ƭ **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/c93b02d55/packages/ethereum-types/src/index.ts#L82)* +*Defined in [ethereum-types/src/index.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L82)* ___ @@ -5153,7 +5198,7 @@ ___ Ƭ **JSONRPCErrorCallback**: *function* -*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L3)* +*Defined in [ethereum-types/src/index.ts:3](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L3)* #### Type declaration: @@ -5172,7 +5217,7 @@ ___ Ƭ **LogTopic**: *null | string | string[]* -*Defined in [ethereum-types/src/index.ts:413](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L413)* +*Defined in [ethereum-types/src/index.ts:414](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L414)* ___ @@ -5184,7 +5229,7 @@ ___ Ƭ **RawLog**: *[LogEntry](#interface-logentry)* -*Defined in [ethereum-types/src/index.ts:475](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L475)* +*Defined in [ethereum-types/src/index.ts:476](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L476)* ___ @@ -5192,7 +5237,7 @@ ___ Ƭ **StateMutability**: *"pure" | "view" | [ConstructorStateMutability](#constructorstatemutability)* -*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L85)* +*Defined in [ethereum-types/src/index.ts:85](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L85)* ___ @@ -5200,7 +5245,7 @@ ___ Ƭ **SupportedProvider**: *[Web3JsProvider](_ethereum_types_src_index_.md#web3jsprovider) | [GanacheProvider](#interface-ganacheprovider) | [EIP1193Provider](#interface-eip1193provider) | [ZeroExProvider](#interface-zeroexprovider)* -*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L9)* +*Defined in [ethereum-types/src/index.ts:9](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L9)* Do not create your own provider. Use an existing provider from a Web3 or ProviderEngine library Read more about Providers in the guides section of the 0x docs. @@ -5211,7 +5256,7 @@ ___ Ƭ **TransactionReceiptStatus**: *null | string | `0` | `1`* -*Defined in [ethereum-types/src/index.ts:445](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L445)* +*Defined in [ethereum-types/src/index.ts:446](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L446)* ___ @@ -5221,7 +5266,7 @@ ___ Ƭ **Web3JsProvider**: *[Web3JsV1Provider](#interface-web3jsv1provider) | [Web3JsV2Provider](#interface-web3jsv2provider) | [Web3JsV3Provider](#interface-web3jsv3provider)* -*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/ethereum-types/src/index.ts#L11)* +*Defined in [ethereum-types/src/index.ts:11](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/ethereum-types/src/index.ts#L11)*
@@ -5238,7 +5283,7 @@ ___ #### ▪ **marshaller**: *object* -*Defined in [web3-wrapper/src/marshaller.ts:33](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L33)* +*Defined in [web3-wrapper/src/marshaller.ts:33](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L33)* Utils to convert ethereum structures from user-space format to RPC format. (marshall/unmarshall) @@ -5246,7 +5291,7 @@ Utils to convert ethereum structures from user-space format to RPC format. (mars ▸ **_marshalCallTxDataBase**(`callTxDataBase`: `Partial`): *`Partial`* -*Defined in [web3-wrapper/src/marshaller.ts:208](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L208)* +*Defined in [web3-wrapper/src/marshaller.ts:208](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L208)* **Parameters:** @@ -5260,7 +5305,7 @@ Name | Type | ▸ **marshalAddress**(`address`: string): *string* -*Defined in [web3-wrapper/src/marshaller.ts:176](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L176)* +*Defined in [web3-wrapper/src/marshaller.ts:176](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L176)* Marshall address @@ -5278,7 +5323,7 @@ marshalled address ▸ **marshalBlockParam**(`blockParam`: [BlockParam](#blockparam) | string | number | undefined): *string | undefined* -*Defined in [web3-wrapper/src/marshaller.ts:187](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L187)* +*Defined in [web3-wrapper/src/marshaller.ts:187](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L187)* Marshall block param @@ -5296,7 +5341,7 @@ marshalled block param ▸ **marshalCallData**(`callData`: `Partial`): *`Partial`* -*Defined in [web3-wrapper/src/marshaller.ts:159](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L159)* +*Defined in [web3-wrapper/src/marshaller.ts:159](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L159)* Marshall call data @@ -5314,7 +5359,7 @@ marshalled call data ▸ **marshalTxData**(`txData`: `Partial`): *`Partial`* -*Defined in [web3-wrapper/src/marshaller.ts:133](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L133)* +*Defined in [web3-wrapper/src/marshaller.ts:133](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L133)* Marshall transaction data @@ -5332,7 +5377,7 @@ marshalled transaction data ▸ **unmarshalIntoBlockWithTransactionData**(`blockWithHexValues`: [BlockWithTransactionDataRPC](#interface-blockwithtransactiondatarpc)): *`BlockWithTransactionData`* -*Defined in [web3-wrapper/src/marshaller.ts:59](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L59)* +*Defined in [web3-wrapper/src/marshaller.ts:59](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L59)* Unmarshall block with transaction data @@ -5350,7 +5395,7 @@ unmarshalled block with transaction data ▸ **unmarshalIntoBlockWithoutTransactionData**(`blockWithHexValues`: [BlockWithoutTransactionDataRPC](#interface-blockwithouttransactiondatarpc)): *`BlockWithoutTransactionData`* -*Defined in [web3-wrapper/src/marshaller.ts:39](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L39)* +*Defined in [web3-wrapper/src/marshaller.ts:39](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L39)* Unmarshall block without transaction data @@ -5368,7 +5413,7 @@ unmarshalled block without transaction data ▸ **unmarshalLog**(`rawLog`: `RawLogEntry`): *`LogEntry`* -*Defined in [web3-wrapper/src/marshaller.ts:199](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L199)* +*Defined in [web3-wrapper/src/marshaller.ts:199](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L199)* Unmarshall log @@ -5386,7 +5431,7 @@ unmarshalled log ▸ **unmarshalTransaction**(`txRpc`: [TransactionRPC](#interface-transactionrpc)): *`Transaction`* -*Defined in [web3-wrapper/src/marshaller.ts:82](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L82)* +*Defined in [web3-wrapper/src/marshaller.ts:82](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L82)* Unmarshall transaction @@ -5404,7 +5449,7 @@ unmarshalled transaction ▸ **unmarshalTransactionReceipt**(`txReceiptRpc`: [TransactionReceiptRPC](#interface-transactionreceiptrpc)): *`TransactionReceipt`* -*Defined in [web3-wrapper/src/marshaller.ts:99](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L99)* +*Defined in [web3-wrapper/src/marshaller.ts:99](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L99)* Unmarshall transaction receipt @@ -5422,7 +5467,7 @@ unmarshalled transaction receipt ▸ **unmarshalTxData**(`txDataRpc`: [TxDataRPC](#interface-txdatarpc)): *`TxData`* -*Defined in [web3-wrapper/src/marshaller.ts:115](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/marshaller.ts#L115)* +*Defined in [web3-wrapper/src/marshaller.ts:115](https://github.com/0xProject/0x-monorepo/blob/34538f2ce/packages/web3-wrapper/src/marshaller.ts#L115)* Unmarshall transaction data @@ -5438,20 +5483,3 @@ unmarshalled transaction data
- - - -## Type aliases - -#### TransactionReceiptStatusRPC - -Ƭ **TransactionReceiptStatusRPC**: *null | string | `0` | `1`* - -*Defined in [web3-wrapper/src/types.ts:69](https://github.com/0xProject/0x-monorepo/blob/c93b02d55/packages/web3-wrapper/src/types.ts#L69)* - -
- - - -
-